Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tenable Platform & Settings Access Groups v1 API

8 actions 8 updates phrasing extends openapi/tenable-access-groups-v1-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['/access-groups'].get

$.paths['/access-groups'].post

$.paths['/access-groups/{id}'].get

$.paths['/access-groups/{id}'].put

$.paths['/access-groups/{id}'].delete

$.paths['/access-groups/filters'].get

$.paths['/access-groups/rules/filters'].get

OpenAPI Overlay

# 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 Access Groups v1 API
  version: 1.0.0
extends: openapi/tenable-access-groups-v1-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['/access-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List legacy access groups
      effect: read
      questions:
      - Which legacy access groups still exist in my container?
      - Can I search the deprecated access groups by name?
      instructions:
      - text: List all my legacy access groups.
      - text: List deprecated access groups matching {w}.
        slots:
          w: query.w
      method: generated
      generated: '2026-10-01'
- target: $.paths['/access-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a legacy access group
      effect: write
      questions:
      - Can I still create an access group even though they are deprecated?
      - What asset rules does a legacy access group need?
      instructions:
      - text: Create legacy access group {name} with asset rules {rules}.
        slots:
          name: requestBody.name
          rules: requestBody.rules
      - text: Create deprecated access group {name} with rules {rules} for users {principals}.
        slots:
          name: requestBody.name
          rules: requestBody.rules
          principals: requestBody.principals
      method: generated
      generated: '2026-10-01'
- target: $.paths['/access-groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a legacy access group's details
      effect: read
      questions:
      - What rules and users are in a particular legacy access group?
      - Can I look up one deprecated access group by ID?
      instructions:
      - text: Get the details of legacy access group {id}.
        slots:
          id: path.id
      - text: Show the rules and principals of deprecated access group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/access-groups/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Overwrite a legacy access group
      effect: write
      questions:
      - Does editing a legacy access group overwrite all of its existing data?
      - Can I change the asset rules on an old access group?
      instructions:
      - text: Rename legacy access group {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Replace the asset rules on deprecated access group {id} with {rules}.
        slots:
          id: path.id
          rules: requestBody.rules
      method: generated
      generated: '2026-10-01'
- target: $.paths['/access-groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a legacy access group
      effect: destructive
      questions:
      - Can I delete a legacy access group after migrating to access control?
      - Which call removes a deprecated access group?
      instructions:
      - text: Delete legacy access group {id}.
        slots:
          id: path.id
      - text: Remove deprecated access group {id} from my container.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/access-groups/filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List filters for searching access groups
      effect: read
      questions:
      - What filters can I use when listing legacy access groups?
      - Which fields are filterable on the access group list?
      instructions:
      - text: List the filters available for querying legacy access groups.
      - text: Show me the access group list filters.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/access-groups/rules/filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List filters for access group asset rules
      effect: read
      questions:
      - What asset attributes can a legacy access group rule match on?
      - Which operators are allowed in access group asset rules?
      instructions:
      - text: List the filters I can use inside legacy access group asset rules.
      - text: Show the asset rule filters for deprecated access groups.
      method: generated
      generated: '2026-10-01'