Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Vulnerability Management Editor API

6 actions 6 updates phrasing extends openapi/tenable-editor-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['/editor/{type}/{id}'].get

$.paths['/editor/{type}/templates'].get

$.paths['/editor/{type}/templates/{wizard_uuid}'].get

$.paths['/editor/policy/{policy_id}/families/{family_id}/plugins/{plugin_id}'].get

$.paths['/editor/{type}/{object_id}/audits/{file_id}'].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 Vulnerability Management Editor API
  version: 1.0.0
extends: openapi/tenable-editor-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['/editor/{type}/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scan or policy's editor configuration
      effect: read
      questions:
      - How can I see the full editable configuration of a scan or policy?
      - Do the returned configuration fields depend on the template used?
      instructions:
      - text: Get the {type} configuration for {id}.
        slots:
          type: path.type
          id: path.id
      - text: Show editor settings of scan {id} with type {type}.
        slots:
          id: path.id
          type: path.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/editor/{type}/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List Tenable scan or policy templates
      effect: read
      questions:
      - Which Tenable-provided scan templates can I create a scan from?
      - What policy templates are available?
      instructions:
      - text: List the {type} templates.
        slots:
          type: path.type
      - text: Show available scan templates of type {type}.
        slots:
          type: path.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/editor/{type}/templates/{wizard_uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a scan template
      effect: read
      questions:
      - What options does a particular scan template expose?
      - Where can I see the fields of a template by its wizard UUID?
      instructions:
      - text: Get {type} template {wizard_uuid}.
        slots:
          type: path.type
          wizard_uuid: path.wizard_uuid
      - text: Show the settings in template {wizard_uuid} for type {type}.
        slots:
          wizard_uuid: path.wizard_uuid
          type: path.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/editor/policy/{policy_id}/families/{family_id}/plugins/{plugin_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a plugin's details within a policy
      effect: read
      questions:
      - What does a plugin enabled in my scan policy actually do?
      - Can I read a plugin's description from inside a policy family?
      instructions:
      - text: Get plugin {plugin_id} in family {family_id} of policy {policy_id}.
        slots:
          plugin_id: path.plugin_id
          family_id: path.family_id
          policy_id: path.policy_id
      - text: Describe policy {policy_id} plugin {plugin_id} from family {family_id}.
        slots:
          policy_id: path.policy_id
          plugin_id: path.plugin_id
          family_id: path.family_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/editor/{type}/{object_id}/audits/{file_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a custom audit file
      effect: read
      questions:
      - How do I download the custom audit file attached to a scan or policy?
      - Where do I find the file ID for a scan's audit file?
      instructions:
      - text: Download audit file {file_id} from {type} {object_id}.
        slots:
          file_id: path.file_id
          type: path.type
          object_id: path.object_id
      - text: Get the custom audit {file_id} attached to {type} {object_id}.
        slots:
          file_id: path.file_id
          type: path.type
          object_id: path.object_id
      method: generated
      generated: '2026-10-01'