Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Vulnerability Management Scan Exports API

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

$.info
$.paths['/scans/{scan_id}/export'].post
$.paths['/scans/exports'].get
$.paths['/scans/{scan_id}/export/{file_id}/status'].get
$.paths['/scans/{scan_id}/export/{file_id}/download'].get

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 Vulnerability Management Scan Exports API
  version: 1.0.0
extends: openapi/tenable-scan-exports-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: 4
- target: $.paths['/scans/{scan_id}/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export a scan's results to a file
      effect: write
      questions:
      - How do I export a scan's results as a PDF, CSV or Nessus file?
      - Can I export results from an earlier run of a scan?
      - Can I password-protect a scan export?
      instructions:
      - text: Export scan {scan_id} as {format}.
        slots:
          scan_id: path.scan_id
          format: requestBody.format
      - text: Export run {history_id} of scan {scan_id} as {format} with chapters {chapters}.
        slots:
          history_id: query.history_id
          scan_id: path.scan_id
          format: requestBody.format
          chapters: requestBody.chapters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scans/exports'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent scan exports
      effect: read
      questions:
      - Which scan exports have been generated in the past 30 days?
      - Can I see why a scan export failed?
      instructions:
      - text: List my recent scan exports.
      - text: List {limit} scan exports sorted by {sort}.
        slots:
          limit: query.limit
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scans/{scan_id}/export/{file_id}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a scan export's status
      effect: read
      questions:
      - Is my exported scan file ready to download?
      - What do I poll while waiting for a scan export to finish?
      instructions:
      - text: Check status of export {file_id} for scan {scan_id}.
        slots:
          file_id: path.file_id
          scan_id: path.scan_id
      - text: Tell me if scan {scan_id} export file {file_id} is ready.
        slots:
          scan_id: path.scan_id
          file_id: path.file_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scans/{scan_id}/export/{file_id}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a scan export file
      effect: read
      questions:
      - How do I download an exported scan file?
      - What permission do I need to download a scan export?
      instructions:
      - text: Download export {file_id} of scan {scan_id}.
        slots:
          file_id: path.file_id
          scan_id: path.scan_id
      - text: Save scan {scan_id} export file {file_id}.
        slots:
          scan_id: path.scan_id
          file_id: path.file_id
      method: generated
      generated: '2026-10-01'