Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tenable Platform & Settings Agent Groups API

8 actions 8 updates phrasing extends openapi/tenable-agent-groups-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Tenable's API. It is a proposal applied on top of the contract, not a document Tenable publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/scanners/null/agent-groups'].get
$.paths['/scanners/null/agent-groups'].post
$.paths['/scanners/null/agent-groups/{group_id}'].get
$.paths['/scanners/null/agent-groups/{group_id}'].put
$.paths['/scanners/null/agent-groups/{group_id}'].delete
$.paths['/scanners/null/agent-groups/{group_id}/agents/{agent_id}'].put
$.paths['/scanners/null/agent-groups/{group_id}/agents/{agent_id}'].delete

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Tenable Platform & Settings Agent Groups API
  version: 1.0.0
extends: openapi/tenable-agent-groups-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/scanners/null/agent-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List agent groups
      effect: read
      questions:
      - Which agent groups have been set up?
      - What groups are my Nessus agents organized into?
      instructions:
      - text: List all agent groups.
      - text: Show me every agent group in the workspace.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/null/agent-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an agent group
      effect: write
      questions:
      - How do I create a new group to organize agents?
      - What do I need to provide to make an agent group?
      instructions:
      - text: Create an agent group named {name}.
        slots:
          name: requestBody.name
      - text: Make a new agent group called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/null/agent-groups/{group_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an agent group with its agents
      effect: read
      questions:
      - What are the details of an agent group, including its member agents?
      - Can I filter and page the agent records shown inside a group's details?
      instructions:
      - text: Show details for agent group {group_id}.
        slots:
          group_id: path.group_id
      - text: Get agent group {group_id} details with members filtered by {f}, limit {limit}.
        slots:
          group_id: path.group_id
          f: query.f
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/null/agent-groups/{group_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename an agent group
      effect: write
      questions:
      - How do I rename an agent group?
      - Can I change only the name of an agent group?
      instructions:
      - text: Rename agent group {group_id} to {name}.
        slots:
          group_id: path.group_id
          name: requestBody.name
      - text: Change the name of agent group {group_id} to {name}.
        slots:
          group_id: path.group_id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/null/agent-groups/{group_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an agent group
      effect: destructive
      questions:
      - How do I delete an agent group?
      - What privilege is needed to remove an agent group?
      instructions:
      - text: Delete agent group {group_id}.
        slots:
          group_id: path.group_id
      - text: Remove the agent group {group_id} entirely.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/null/agent-groups/{group_id}/agents/{agent_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add an agent to a group
      effect: write
      questions:
      - How do I put a single agent into an agent group?
      - Can I assign one agent to a group by its ID?
      instructions:
      - text: Add agent {agent_id} to agent group {group_id}.
        slots:
          agent_id: path.agent_id
          group_id: path.group_id
      - text: Assign agent {agent_id} to the group {group_id}.
        slots:
          agent_id: path.agent_id
          group_id: path.group_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/null/agent-groups/{group_id}/agents/{agent_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an agent from a group
      effect: destructive
      questions:
      - How do I take an agent out of a group without unlinking it?
      - Can I remove one agent from an agent group?
      instructions:
      - text: Remove agent {agent_id} from agent group {group_id}.
        slots:
          agent_id: path.agent_id
          group_id: path.group_id
      - text: Take agent {agent_id} out of group {group_id}.
        slots:
          agent_id: path.agent_id
          group_id: path.group_id
      method: generated
      generated: '2026-10-01'