Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tenable Filters API

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

$.info
$.paths['/filters/mssp/accounts'].get
$.paths['/filters/scans/agents'].get
$.paths['/filters/workbenches/assets'].get
$.paths['/filters/workbenches/assets'].post
$.paths['/filters/credentials'].get
$.paths['/filters/reports/export'].get
$.paths['/filters/scans/reports'].get
$.paths['/filters/scans/reports/history'].get
$.paths['/filters/workbenches/vulnerabilities'].get
$.paths['/filters/workbenches/vulnerabilities'].post
$.paths['/was/v2/configs/filters'].get
$.paths['/was/v2/configs/{config_id}/scans/filters'].get
$.paths['/was/v2/user-templates/filters'].get
$.paths['/was/v2/vulnerabilities/filters'].get
$.paths['/was/v2/scans/{scan_id}/vulnerabilities/filters'].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 Tenable Filters API
  version: 1.0.0
extends: openapi/tenable-filters-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: 15
- target: $.paths['/filters/mssp/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List filters for MSSP customer accounts
      effect: read
      questions:
      - Which fields can I filter MSSP customer account lists by?
      - What filtering options exist for the managed-service account endpoints?
      instructions:
      - text: List the filters available for MSSP account endpoints.
      - text: Show me how I can filter my managed customer accounts.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/filters/scans/agents'].get
  update:
    x-apievangelist-phrasing:
      intent: List filters for agent records
      effect: read
      questions:
      - What fields can I filter and sort Nessus agents by?
      - Which operators are supported when filtering the agent list?
      instructions:
      - text: List the filter, sort and paging options for agent records.
      - text: Show me which agent fields support filtering.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/filters/workbenches/assets'].get
  update:
    x-apievangelist-phrasing:
      intent: List asset workbench filters
      effect: read
      questions:
      - Which filters can I apply in the assets workbench?
      - What asset fields are filterable without narrowing by tags?
      instructions:
      - text: List all filters available for the assets workbench.
      - text: Show me the sortable and filterable asset workbench fields.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/filters/workbenches/assets'].post
  update:
    x-apievangelist-phrasing:
      intent: List asset workbench filters scoped to tags
      effect: read
      questions:
      - Can I get the asset workbench filters that apply to assets with specific tags?
      - Which asset filters are available once I scope by tag UUIDs?
      instructions:
      - text: List asset workbench filters for assets tagged {tag_uuids}.
        slots:
          tag_uuids: requestBody.tag_uuids
      - text: Use the v2 asset filters call to get filters for tags {tag_uuids}.
        slots:
          tag_uuids: requestBody.tag_uuids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/filters/credentials'].get
  update:
    x-apievangelist-phrasing:
      intent: List filters for scan credentials
      effect: read
      questions:
      - What can I filter my stored scan credentials by?
      - Which sort and paging options do credential lists support?
      instructions:
      - text: List the filtering capabilities for scan credentials.
      - text: Show me which credential fields I can filter on.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/filters/reports/export'].get
  update:
    x-apievangelist-phrasing:
      intent: List filters for report exports
      effect: read
      questions:
      - Which filters and allowed values can I use when exporting a report?
      - What operators and data types do the report export filters support?
      instructions:
      - text: List the filters supported by the report export endpoint.
      - text: Show the allowed values for each report export filter.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/filters/scans/reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List filters for vulnerability scan records
      effect: read
      questions:
      - What fields can I filter my vulnerability management scan results by?
      - Which sort options exist for scan report records?
      instructions:
      - text: List the filters available for vulnerability management scan reports.
      - text: Show the filterable fields on scan report records.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/filters/scans/reports/history'].get
  update:
    x-apievangelist-phrasing:
      intent: List filters for scan history records
      effect: read
      questions:
      - Can I filter a scan's past runs, and by which fields?
      - What paging and sort options apply to scan history?
      instructions:
      - text: List the filters available for scan history records.
      - text: Show me how scan run history can be filtered and sorted.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/filters/workbenches/vulnerabilities'].get
  update:
    x-apievangelist-phrasing:
      intent: List vulnerability workbench filters
      effect: read
      questions:
      - Which filters does the Vulnerabilities Workbench support?
      - What vulnerability fields can I filter on in the workbench?
      instructions:
      - text: List the Vulnerabilities Workbench filters.
      - text: Show me every filter I can apply to the vulnerability workbench.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/filters/workbenches/vulnerabilities'].post
  update:
    x-apievangelist-phrasing:
      intent: List vulnerability workbench filters by tag (deprecated)
      effect: read
      questions:
      - Can I get vulnerability workbench filters scoped to assets with certain tags?
      - Is the tag-scoped vulnerability filters endpoint still supported?
      instructions:
      - text: List vulnerability workbench filters for tags {tag_uuids} using the deprecated v2 call.
        slots:
          tag_uuids: requestBody.tag_uuids
      - text: Get the vulnerability filters that apply to tag UUIDs {tag_uuids}.
        slots:
          tag_uuids: requestBody.tag_uuids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v2/configs/filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List web app scan configuration filters
      effect: read
      questions:
      - Which fields can I filter my web application scan configurations by?
      - What filters are available for Web App Scanning configs?
      instructions:
      - text: List the filters for web app scan configurations.
      - text: Show me how WAS scan configs can be filtered.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v2/configs/{config_id}/scans/filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List web app scan filters for a config
      effect: read
      questions:
      - What filters can I use on the web app scans run from one scan configuration?
      - Which fields are filterable for WAS scans under a given config?
      instructions:
      - text: List the web app scan filters for scan configuration {config_id}.
        slots:
          config_id: path.config_id
      - text: Show the filterable fields for WAS scans of config {config_id}.
        slots:
          config_id: path.config_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v2/user-templates/filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List filters for user-defined web app templates
      effect: read
      questions:
      - How can I filter my user-defined Web App Scanning templates?
      - Which template fields support filtering for custom WAS templates?
      instructions:
      - text: List the filters for user-defined web app scanning templates.
      - text: Show me the filterable fields on my custom WAS templates.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v2/vulnerabilities/filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List web app vulnerability finding filters
      effect: read
      questions:
      - Which filters can I apply to web application vulnerability findings?
      - What fields are filterable for WAS findings across all scans?
      instructions:
      - text: List the filters available for web app vulnerability findings.
      - text: Show me the WAS vulnerability finding filters.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v2/scans/{scan_id}/vulnerabilities/filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List vulnerability filters for one web app scan
      effect: read
      questions:
      - What filters can I use on the findings of a single web app scan?
      - Which vulnerability fields are filterable within one WAS scan's results?
      instructions:
      - text: List the vulnerability filters for web app scan {scan_id}.
        slots:
          scan_id: path.scan_id
      - text: Show the finding filters I can apply to WAS scan {scan_id}.
        slots:
          scan_id: path.scan_id
      method: generated
      generated: '2026-10-01'