Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Vulnerability Management Exports (Compliance Data) API

6 actions 6 updates phrasing extends openapi/tenable-exports-compliance-data-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 6

$.info

$.paths['/compliance/export'].post

$.paths['/compliance/export/{export_uuid}/status'].get

$.paths['/compliance/export/status'].get

$.paths['/compliance/export/{export_uuid}/chunks/{chunk_id}'].get

$.paths['/compliance/export/{export_uuid}/cancel'].post

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 Exports (Compliance Data) API
  version: 1.0.0
extends: openapi/tenable-exports-compliance-data-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: 5
- target: $.paths['/compliance/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a compliance data export
      effect: write
      questions:
      - How do I export compliance audit results for all my assets?
      - Can I limit a compliance export to certain assets or filters?
      instructions:
      - text: Start a compliance export with filters {filters}.
        slots:
          filters: requestBody.filters
      - text: Export compliance findings for assets {asset}, {num_findings} findings per chunk.
        slots:
          asset: requestBody.asset
          num_findings: requestBody.num_findings
      method: generated
      generated: '2026-10-01'
- target: $.paths['/compliance/export/{export_uuid}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a compliance export's status
      effect: read
      questions:
      - Is my compliance export finished, and which chunks are ready?
      - What status is a given compliance export job in?
      instructions:
      - text: Get the status of compliance export {export_uuid}.
        slots:
          export_uuid: path.export_uuid
      - text: Tell me which chunks of compliance export {export_uuid} are ready.
        slots:
          export_uuid: path.export_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/compliance/export/status'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent compliance export jobs
      effect: read
      questions:
      - Which compliance exports have been requested recently?
      - Can I see the status of my last thousand compliance exports?
      instructions:
      - text: List my recent compliance export jobs.
      - text: Show the statuses of all compliance exports.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/compliance/export/{export_uuid}/chunks/{chunk_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a compliance export chunk
      effect: read
      questions:
      - How do I download one chunk of a finished compliance export?
      - How long do compliance export chunks stay available?
      instructions:
      - text: Download chunk {chunk_id} of compliance export {export_uuid}.
        slots:
          chunk_id: path.chunk_id
          export_uuid: path.export_uuid
      - text: Fetch compliance data chunk {chunk_id} from export {export_uuid}.
        slots:
          chunk_id: path.chunk_id
          export_uuid: path.export_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/compliance/export/{export_uuid}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a compliance export
      effect: destructive
      questions:
      - Can I stop a compliance export that is still processing?
      - What happens to chunks already processed when an export is cancelled?
      instructions:
      - text: Cancel compliance export {export_uuid}.
        slots:
          export_uuid: path.export_uuid
      - text: Stop the running compliance export job {export_uuid}.
        slots:
          export_uuid: path.export_uuid
      method: generated
      generated: '2026-10-01'