Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Vulnerability Management Reports API

4 actions 4 updates phrasing extends openapi/tenable-reports-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['/reports/export'].post
$.paths['/reports/export/{report_uuid}/status'].get
$.paths['/reports/export/{report_uuid}/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 Reports API
  version: 1.0.0
extends: openapi/tenable-reports-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['/reports/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a PDF report
      effect: write
      questions:
      - How do I generate a PDF vulnerability report from a template?
      - How many findings can one generated report contain?
      instructions:
      - text: Create a PDF report from template {template_name}.
        slots:
          template_name: requestBody.template_name
      - text: Create report {name} from template {template_name} filtered by {filters}.
        slots:
          name: requestBody.name
          template_name: requestBody.template_name
          filters: requestBody.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/export/{report_uuid}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a report's generation status
      effect: read
      questions:
      - Is my PDF report finished generating?
      - What status is a report export request in?
      instructions:
      - text: Check the status of report {report_uuid}.
        slots:
          report_uuid: path.report_uuid
      - text: Tell me whether report {report_uuid} is ready.
        slots:
          report_uuid: path.report_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/export/{report_uuid}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a generated PDF report
      effect: read
      questions:
      - Can I download the PDF once my report is ready?
      - Where do I get the file for a finished report?
      instructions:
      - text: Download report {report_uuid}.
        slots:
          report_uuid: path.report_uuid
      - text: Save the PDF for finished report {report_uuid}.
        slots:
          report_uuid: path.report_uuid
      method: generated
      generated: '2026-10-01'