Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Vulnerability Management Scan Results API

4 actions 4 updates phrasing extends openapi/tenable-scan-results-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 4

$.info

$.paths['/scans/{scan_uuid}/hosts/{host_id}'].get

$.paths['/scans/{scan_uuid}/hosts/{host_id}/plugins/{plugin_id}'].get

$.paths['/scans/{scan_id}/attachments/{attachment_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 Scan Results API
  version: 1.0.0
extends: openapi/tenable-scan-results-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: 3
- target: $.paths['/scans/{scan_uuid}/hosts/{host_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a host's results from a scan
      effect: read
      questions:
      - What vulnerabilities did a scan find on a specific host?
      - How far back can I pull host-level scan results?
      instructions:
      - text: Get host {host_id} results from scan {scan_uuid}.
        slots:
          host_id: path.host_id
          scan_uuid: path.scan_uuid
      - text: Show host {host_id} details from scan {scan_uuid} history {history_id}.
        slots:
          host_id: path.host_id
          scan_uuid: path.scan_uuid
          history_id: query.history_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scans/{scan_uuid}/hosts/{host_id}/plugins/{plugin_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a plugin's output on a host (deprecated)
      effect: read
      questions:
      - Can I see the raw output a specific plugin produced on a host in a scan?
      - Is the per-host plugin output endpoint deprecated?
      instructions:
      - text: Get plugin {plugin_id} output for host {host_id} in scan {scan_uuid}.
        slots:
          plugin_id: path.plugin_id
          host_id: path.host_id
          scan_uuid: path.scan_uuid
      - text: Show what plugin {plugin_id} reported on host {host_id} for scan {scan_uuid} run {history_id}.
        slots:
          plugin_id: path.plugin_id
          host_id: path.host_id
          scan_uuid: path.scan_uuid
          history_id: query.history_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scans/{scan_id}/attachments/{attachment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a scan attachment file
      effect: read
      questions:
      - Can I download a file attached to a scan result?
      - How old can scan results be and still have attachments available?
      instructions:
      - text: Download attachment {attachment_id} from scan {scan_id} as {accept}.
        slots:
          attachment_id: path.attachment_id
          scan_id: path.scan_id
          accept: header.accept
      - text: Get scan {scan_id} attachment {attachment_id} using key {key}, accepting {accept}.
        slots:
          scan_id: path.scan_id
          attachment_id: path.attachment_id
          key: query.key
          accept: header.accept
      method: generated
      generated: '2026-10-01'