Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Exposure Management Inventory Exports API

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

$.info
$.paths['/api/v1/t1/inventory/export/assets'].post
$.paths['/api/v1/t1/inventory/export/findings'].post
$.paths['/api/v1/t1/inventory/export/assets/status'].get
$.paths['/api/v1/t1/inventory/export/findings/status'].get
$.paths['/api/v1/t1/inventory/export/{export_id}/status'].get
$.paths['/api/v1/t1/inventory/export/{export_id}/download/{chunk_id}'].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 Exposure Management Inventory Exports API
  version: 1.0.0
extends: openapi/tenable-inventory-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: 6
- target: $.paths['/api/v1/t1/inventory/export/assets'].post
  update:
    x-apievangelist-phrasing:
      intent: Export inventory assets
      effect: write
      questions:
      - How do I export my Tenable One asset inventory to CSV or JSON?
      - Can I filter which assets go into an inventory export?
      - Is the inventory asset export still in beta?
      instructions:
      - text: Export inventory assets as {file_format}.
        slots:
          file_format: query.file_format
      - text: Export assets matching {filters} with properties {properties}.
        slots:
          filters: requestBody.filters
          properties: query.properties
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/t1/inventory/export/findings'].post
  update:
    x-apievangelist-phrasing:
      intent: Export inventory findings
      effect: write
      questions:
      - Can I export findings from the inventory that match a search?
      - What file formats can an inventory findings export use?
      instructions:
      - text: Export inventory findings as {file_format}.
        slots:
          file_format: query.file_format
      - text: Export findings matching {filters}, compressed {compress}.
        slots:
          filters: requestBody.filters
          compress: query.compress
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/t1/inventory/export/assets/status'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent asset export jobs
      effect: read
      questions:
      - Which inventory asset exports have I run in the last few days?
      - Can I list only asset export jobs that have finished?
      instructions:
      - text: List my recent inventory asset export jobs.
      - text: List asset export jobs with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/t1/inventory/export/findings/status'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent findings export jobs
      effect: read
      questions:
      - Which inventory findings exports were submitted recently?
      - Can I filter findings export jobs by status?
      instructions:
      - text: List my recent inventory findings export jobs.
      - text: Show up to {limit} findings export jobs with status {status}.
        slots:
          limit: query.limit
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/t1/inventory/export/{export_id}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an inventory export's status
      effect: read
      questions:
      - Is my inventory export finished and which chunks are ready?
      - How do I know when an inventory export can be downloaded?
      instructions:
      - text: Get the status of inventory export {export_id}.
        slots:
          export_id: path.export_id
      - text: Check whether inventory export {export_id} is done.
        slots:
          export_id: path.export_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/t1/inventory/export/{export_id}/download/{chunk_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an inventory export chunk
      effect: read
      questions:
      - How do I download one chunk of an inventory export?
      - Do inventory export chunks come back as JSON or CSV?
      instructions:
      - text: Download chunk {chunk_id} of inventory export {export_id}.
        slots:
          chunk_id: path.chunk_id
          export_id: path.export_id
      - text: Fetch inventory export {export_id} part {chunk_id}.
        slots:
          export_id: path.export_id
          chunk_id: path.chunk_id
      method: generated
      generated: '2026-10-01'