Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Exposure Management Attack Path Exports API

6 actions 6 updates phrasing extends openapi/tenable-attack-path-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['/api/v1/export/attack-path'].post
$.paths['/api/v1/export/attack-technique'].post
$.paths['/api/v1/export/mitre-heatmap'].post
$.paths['/api/v1/export/{export_id}/status'].get
$.paths['/api/v1/export/{export_id}/download'].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 Attack Path Exports API
  version: 1.0.0
extends: openapi/tenable-attack-path-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['/api/v1/export/attack-path'].post
  update:
    x-apievangelist-phrasing:
      intent: Export top attack paths
      effect: write
      questions:
      - How do I export the top attack paths to a file?
      - Can I export only specific attack path vectors?
      instructions:
      - text: Export top attack paths as {file_format}.
        slots:
          file_format: requestBody.file_format
      - text: Export attack paths {vector_ids} as {file_format} named {file_name}.
        slots:
          vector_ids: requestBody.vector_ids
          file_format: requestBody.file_format
          file_name: requestBody.file_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/export/attack-technique'].post
  update:
    x-apievangelist-phrasing:
      intent: Export attack techniques
      effect: write
      questions:
      - Can I export the attack techniques found in my environment?
      - Which columns can I include in an attack technique export?
      instructions:
      - text: Export attack techniques as {file_format}.
        slots:
          file_format: requestBody.file_format
      - text: Export techniques {attack_technique_ids} as {file_format} with columns {columns}.
        slots:
          attack_technique_ids: requestBody.attack_technique_ids
          file_format: requestBody.file_format
          columns: requestBody.columns
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/export/mitre-heatmap'].post
  update:
    x-apievangelist-phrasing:
      intent: Export a MITRE ATT&CK heatmap
      effect: write
      questions:
      - Can I export a MITRE ATT&CK heatmap that I can load into ATT&CK Navigator?
      - What format does the heatmap export use for Navigator layers?
      instructions:
      - text: Export the MITRE ATT&CK heatmap as {file_format}.
        slots:
          file_format: requestBody.file_format
      - text: Export a heatmap filtered by {filter} as {file_format}.
        slots:
          filter: requestBody.filter
          file_format: requestBody.file_format
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/export/{export_id}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an attack path export's status
      effect: read
      questions:
      - Is my attack path or heatmap export ready?
      - How do I track an attack technique export request?
      instructions:
      - text: Check the status of attack path export {export_id}.
        slots:
          export_id: path.export_id
      - text: Tell me if heatmap export {export_id} has finished.
        slots:
          export_id: path.export_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/export/{export_id}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an attack path export
      effect: read
      questions:
      - How do I download a completed attack path export?
      - What format will my downloaded heatmap file be in?
      instructions:
      - text: Download attack path export {export_id}.
        slots:
          export_id: path.export_id
      - text: Save the results of finished export {export_id}.
        slots:
          export_id: path.export_id
      method: generated
      generated: '2026-10-01'