Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Vulnerability Management Scan Status API

4 actions 4 updates phrasing extends openapi/tenable-scan-status-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_id}/latest-status'].get
$.paths['/scans/{scan_id}/status'].put
$.paths['/scans/{scan_id}/progress'].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 Status API
  version: 1.0.0
extends: openapi/tenable-scan-status-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_id}/latest-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scan's latest status
      effect: read
      questions:
      - Is my scan still running, completed or aborted?
      - What is the most recent status of a particular scan?
      instructions:
      - text: Get the latest status of scan {scan_id}.
        slots:
          scan_id: path.scan_id
      - text: Tell me whether scan {scan_id} has finished.
        slots:
          scan_id: path.scan_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scans/{scan_id}/status'].put
  update:
    x-apievangelist-phrasing:
      intent: Mark a scan as read or unread
      effect: write
      questions:
      - Can I mark a scan's results as read so it stops showing as new?
      - How do I flag a scan back to unread?
      instructions:
      - text: Mark scan {scan_id} as read.
        slots:
          scan_id: path.scan_id
      - text: Set the read flag on scan {scan_id} to {read}.
        slots:
          scan_id: path.scan_id
          read: requestBody.read
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scans/{scan_id}/progress'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scan's progress
      effect: read
      questions:
      - How far along is a running scan, as a percentage?
      - Can I check the progress of an earlier run of a scan, not just the latest?
      instructions:
      - text: Show the progress of scan {scan_id}.
        slots:
          scan_id: path.scan_id
      - text: Get the progress of scan {scan_id} for history run {history_id}.
        slots:
          scan_id: path.scan_id
          history_id: query.history_id
      method: generated
      generated: '2026-10-01'