Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Web Application Scanning v2 Exports API

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

$.info
$.paths['/was/v1/export/vulns'].post
$.paths['/was/v1/export/vulns/{export_uuid}/status'].get
$.paths['/was/v1/export/vulns/status'].get
$.paths['/was/v1/export/vulns/{export_uuid}/chunks/{chunk_id}'].get
$.paths['/was/v1/export/vulns/{export_uuid}/cancel'].post

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 Web Application Scanning v2 Exports API
  version: 1.0.0
extends: openapi/tenable-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: 5
- target: $.paths['/was/v1/export/vulns'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a web app findings export
      effect: write
      questions:
      - How do I export my Web App Scanning findings in bulk?
      - Can I include findings from unlicensed web app assets in the export?
      instructions:
      - text: Export web app scanning findings matching {filters}.
        slots:
          filters: requestBody.filters
      - text: Start a WAS findings export with {num_assets} assets per chunk.
        slots:
          num_assets: requestBody.num_assets
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v1/export/vulns/{export_uuid}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a web app findings export's status
      effect: read
      questions:
      - Is my web app findings export ready to download?
      - Which chunks of a WAS findings export have finished?
      instructions:
      - text: Check the status of WAS findings export {export_uuid}.
        slots:
          export_uuid: path.export_uuid
      - text: List finished chunks of web app findings export {export_uuid}.
        slots:
          export_uuid: path.export_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v1/export/vulns/status'].get
  update:
    x-apievangelist-phrasing:
      intent: List web app findings export jobs
      effect: read
      questions:
      - What web app findings exports have been run recently?
      - Are completed WAS export jobs shown in the jobs list?
      instructions:
      - text: List my recent web app findings export jobs.
      - text: Show all WAS findings export jobs and their statuses.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v1/export/vulns/{export_uuid}/chunks/{chunk_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a chunk of web app findings
      effect: read
      questions:
      - Can I download one chunk of my web app findings export as JSON?
      - How long do WAS findings export chunks stay available?
      instructions:
      - text: Download chunk {chunk_id} of WAS findings export {export_uuid}.
        slots:
          chunk_id: path.chunk_id
          export_uuid: path.export_uuid
      - text: Fetch the web app findings in chunk {chunk_id} of {export_uuid}.
        slots:
          chunk_id: path.chunk_id
          export_uuid: path.export_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v1/export/vulns/{export_uuid}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a web app findings export
      effect: destructive
      questions:
      - Can I cancel a web app findings export I started by mistake?
      - What happens to in-progress chunks when a WAS export is cancelled?
      instructions:
      - text: Cancel WAS findings export {export_uuid}.
        slots:
          export_uuid: path.export_uuid
      - text: Stop the web app findings export job {export_uuid}.
        slots:
          export_uuid: path.export_uuid
      method: generated
      generated: '2026-10-01'