Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Vulnerability Management Exports (Assets) API

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

$.info
$.paths['/assets/export'].post
$.paths['/assets/v2/export'].post
$.paths['/assets/export/{export_uuid}/status'].get
$.paths['/assets/export/status'].get
$.paths['/assets/export/{export_uuid}/chunks/{chunk_id}'].get
$.paths['/assets/export/{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 Vulnerability Management Exports (Assets) API
  version: 1.0.0
extends: openapi/tenable-exports-assets-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: 6
- target: $.paths['/assets/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an asset export (v1)
      effect: write
      questions:
      - Can I still bulk export assets with the original v1 export endpoint?
      - Does the v1 asset export include open ports if I ask for them?
      instructions:
      - text: Start a v1 asset export with chunks of {chunk_size} assets.
        slots:
          chunk_size: requestBody.chunk_size
      - text: Run the legacy v1 asset export, {chunk_size} per chunk, filtered by {filters}.
        slots:
          chunk_size: requestBody.chunk_size
          filters: requestBody.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/assets/v2/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an asset export including web apps (v2)
      effect: write
      questions:
      - How do I export all my assets including Web App Scanning assets?
      - Can I include resource tags in a bulk asset export?
      instructions:
      - text: Start a v2 asset export with chunk size {chunk_size}.
        slots:
          chunk_size: requestBody.chunk_size
      - text: Export assets with the v2 endpoint, {chunk_size} per chunk, matching {filters}, resource tags {include_resource_tags}.
        slots:
          chunk_size: requestBody.chunk_size
          filters: requestBody.filters
          include_resource_tags: requestBody.include_resource_tags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/assets/export/{export_uuid}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an asset export's status
      effect: read
      questions:
      - Which chunks of my asset export are ready to download?
      - Is my asset export job finished yet?
      instructions:
      - text: Check the status of asset export {export_uuid}.
        slots:
          export_uuid: path.export_uuid
      - text: List the available chunks for asset export {export_uuid}.
        slots:
          export_uuid: path.export_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/assets/export/status'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent asset export jobs
      effect: read
      questions:
      - What asset export jobs have been run recently?
      - How many past asset export jobs can I see?
      instructions:
      - text: List my recent asset export jobs.
      - text: Show the status of all asset exports from the last runs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/assets/export/{export_uuid}/chunks/{chunk_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download one chunk of an asset export
      effect: read
      questions:
      - How long are exported asset chunks available to download?
      - Can I fetch a single chunk of an asset export?
      instructions:
      - text: Download chunk {chunk_id} of asset export {export_uuid}.
        slots:
          chunk_id: path.chunk_id
          export_uuid: path.export_uuid
      - text: Fetch the asset data in 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['/assets/export/{export_uuid}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an asset export
      effect: destructive
      questions:
      - Can I stop an asset export that's taking too long?
      - What happens to chunks already processed when I cancel an asset export?
      instructions:
      - text: Cancel asset export {export_uuid}.
        slots:
          export_uuid: path.export_uuid
      - text: Stop processing the asset export job {export_uuid}.
        slots:
          export_uuid: path.export_uuid
      method: generated
      generated: '2026-10-01'