# 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 (Vulnerabilities) API
  version: 1.0.0
extends: openapi/tenable-exports-vulnerabilities-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['/vulns/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a bulk vulnerability export
      effect: write
      questions:
      - How do I export all my vulnerability data in bulk?
      - Can I include software vulnerabilities and unlicensed assets in the export?
      - Can I control how many assets go into each export chunk?
      instructions:
      - text: Export vulnerabilities matching {filters}.
        slots:
          filters: requestBody.filters
      - text: Start a vulnerability export with {num_assets} assets per chunk.
        slots:
          num_assets: requestBody.num_assets
      method: generated
      generated: '2026-10-01'
- target: $.paths['/vulns/export/{export_uuid}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a vulnerability export's status
      effect: read
      questions:
      - Which chunks of my vulnerability export are ready?
      - Why might export chunks finish out of order?
      instructions:
      - text: Get the status of vulnerability export {export_uuid}.
        slots:
          export_uuid: path.export_uuid
      - text: List finished chunks for vuln export {export_uuid}.
        slots:
          export_uuid: path.export_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/vulns/export/status'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent vulnerability export jobs
      effect: read
      questions:
      - What vulnerability export jobs have run recently?
      - Does the export job list include completed jobs older than three days?
      instructions:
      - text: List my recent vulnerability export jobs.
      - text: Show the status of all recent vuln exports.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/vulns/export/{export_uuid}/chunks/{chunk_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a vulnerability export chunk
      effect: read
      questions:
      - How do I download a chunk of a vulnerability export?
      - How long are export chunks available before they expire?
      instructions:
      - text: Download chunk {chunk_id} of vulnerability export {export_uuid}.
        slots:
          chunk_id: path.chunk_id
          export_uuid: path.export_uuid
      - text: Fetch vuln export {export_uuid} chunk {chunk_id}.
        slots:
          export_uuid: path.export_uuid
          chunk_id: path.chunk_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/vulns/export/{export_uuid}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a vulnerability export
      effect: destructive
      questions:
      - Can I cancel a vulnerability export that's taking too long?
      - What happens to chunks already processing when I cancel an export?
      instructions:
      - text: Cancel vulnerability export {export_uuid}.
        slots:
          export_uuid: path.export_uuid
      - text: Stop vuln export job {export_uuid}.
        slots:
          export_uuid: path.export_uuid
      method: generated
      generated: '2026-10-01'