Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Vulnerability Management Scan History API

4 actions 4 updates phrasing extends openapi/tenable-scan-history-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}/history'].get

$.paths['/scans/{scan_id}/history/{history_uuid}'].get

$.paths['/scans/{scan_id}/history/{history_uuid}'].delete

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 History API
  version: 1.0.0
extends: openapi/tenable-scan-history-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}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: List a scan's run history
      effect: read
      questions:
      - How many times has a scan run and when?
      - Can I exclude rollover runs from a scan's history?
      - Why does a triggered agent scan have no history?
      instructions:
      - text: List the run history of scan {scan_id} excluding rollovers {exclude_rollover}.
        slots:
          scan_id: path.scan_id
          exclude_rollover: query.exclude_rollover
      - text: Show the last {limit} runs of scan {scan_id} with exclude_rollover {exclude_rollover}.
        slots:
          limit: query.limit
          scan_id: path.scan_id
          exclude_rollover: query.exclude_rollover
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scans/{scan_id}/history/{history_uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a past scan run
      effect: read
      questions:
      - What did a specific past run of my scan find?
      - When and where did an earlier scan run execute?
      instructions:
      - text: Get run {history_uuid} of scan {scan_id}.
        slots:
          history_uuid: path.history_uuid
          scan_id: path.scan_id
      - text: Show details for historical run {history_uuid} of scan {scan_id}.
        slots:
          history_uuid: path.history_uuid
          scan_id: path.scan_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scans/{scan_id}/history/{history_uuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a past scan run
      effect: destructive
      questions:
      - Can I delete the results of one old scan run?
      - Does deleting a scan run also delete its rollover data?
      instructions:
      - text: Delete run {history_uuid} of scan {scan_id}.
        slots:
          history_uuid: path.history_uuid
          scan_id: path.scan_id
      - text: Remove historical run {history_uuid} from scan {scan_id} with delete_rollovers {delete_rollovers}.
        slots:
          history_uuid: path.history_uuid
          scan_id: path.scan_id
          delete_rollovers: query.delete_rollovers
      method: generated
      generated: '2026-10-01'