Tenable · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/tenable-target-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 6

$.info
$.paths['/target-groups'].post
$.paths['/target-groups/{no_members}'].get
$.paths['/target-groups/{group_id}'].get
$.paths['/target-groups/{group_id}'].put
$.paths['/target-groups/{group_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 Target Groups API
  version: 1.0.0
extends: openapi/tenable-target-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: 5
- target: $.paths['/target-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a target group (deprecated)
      effect: write
      questions:
      - Can I still create a target group of hosts to scan, even though they are deprecated?
      - What members and ACLs does a new target group take?
      instructions:
      - text: Create a target group {name} containing {members}.
        slots:
          name: requestBody.name
          members: requestBody.members
      - text: Create target group {name} with members {members} and access list {acls}.
        slots:
          name: requestBody.name
          members: requestBody.members
          acls: requestBody.acls
      method: generated
      generated: '2026-10-01'
- target: $.paths['/target-groups/{no_members}'].get
  update:
    x-apievangelist-phrasing:
      intent: List target groups (deprecated)
      effect: read
      questions:
      - Which legacy target groups do I still have before migrating to tags?
      - Can I list target groups without their member and ACL details?
      instructions:
      - text: List my target groups with no_members set to {no_members}.
        slots:
          no_members: path.no_members
      - text: List all legacy target groups, excluding members ({no_members}).
        slots:
          no_members: path.no_members
      method: generated
      generated: '2026-10-01'
- target: $.paths['/target-groups/{group_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a target group's details (deprecated)
      effect: read
      questions:
      - Which hosts are in a specific legacy target group?
      - What access controls are set on one target group?
      instructions:
      - text: Show target group {group_id}.
        slots:
          group_id: path.group_id
      - text: List the members of target group {group_id}.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/target-groups/{group_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a target group (deprecated)
      effect: write
      questions:
      - How do I change the hosts in an existing target group?
      - Can I rename a legacy target group?
      instructions:
      - text: Set the members of target group {group_id} to {members}.
        slots:
          group_id: path.group_id
          members: requestBody.members
      - text: Rename target group {group_id} to {name}.
        slots:
          group_id: path.group_id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/target-groups/{group_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a target group (deprecated)
      effect: destructive
      questions:
      - How do I delete an old target group after moving to tags?
      - Can I remove a legacy target group permanently?
      instructions:
      - text: Delete target group {group_id}.
        slots:
          group_id: path.group_id
      - text: Remove the legacy target group {group_id}.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-10-01'