Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Exposure Management Inventory API

7 actions 7 updates phrasing extends openapi/tenable-inventory-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/assets/search'].post
$.paths['/api/v1/t1/inventory/findings/search'].post
$.paths['/api/v1/t1/inventory/software/search'].post
$.paths['/api/v1/t1/inventory/assets/properties'].get
$.paths['/api/v1/t1/inventory/findings/properties'].get
$.paths['/api/v1/t1/inventory/software/properties'].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 API
  version: 1.0.0
extends: openapi/tenable-inventory-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/assets/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search the asset inventory
      effect: read
      questions:
      - Which assets in my organization match a given set of criteria?
      - Can I search the Tenable One asset inventory with filters and sorting?
      instructions:
      - text: Search inventory assets for {query}.
        slots:
          query: requestBody.query
      - text: Find assets matching filters {filters}, sorted by {sort}, limit {limit}.
        slots:
          filters: requestBody.filters
          sort: query.sort
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/t1/inventory/findings/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search security findings
      effect: read
      questions:
      - What findings across my organization match certain criteria?
      - Can I search findings and page through the results?
      instructions:
      - text: Search findings for {query}.
        slots:
          query: requestBody.query
      - text: Find findings matching filters {filters}, {limit} per page from offset {offset}.
        slots:
          filters: requestBody.filters
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/t1/inventory/software/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search installed software
      effect: read
      questions:
      - Which software is installed across my assets?
      - Where is a particular application installed in my environment?
      instructions:
      - text: Search installed software for {query}.
        slots:
          query: requestBody.query
      - text: Find software matching filters {filters}, sorted by {sort}.
        slots:
          filters: requestBody.filters
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/t1/inventory/assets/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: List filterable asset properties
      effect: read
      questions:
      - Which asset properties can I use as filters in an asset search?
      - Can I limit the asset property list to certain asset classes?
      instructions:
      - text: List the asset properties I can filter on.
      - text: List asset properties for asset classes {asset_classes}.
        slots:
          asset_classes: query.asset_classes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/t1/inventory/findings/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: List filterable finding properties
      effect: read
      questions:
      - What finding properties are available as search filters?
      - Which fields can I use to filter findings?
      instructions:
      - text: List the finding properties usable as filters.
      - text: Show me every filterable property on findings.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/t1/inventory/software/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: List filterable software properties
      effect: read
      questions:
      - Which software properties can I filter a software search by?
      - What fields describe installed software for filtering?
      instructions:
      - text: List the software properties usable as filters.
      - text: Show me the filterable fields for installed software.
      method: generated
      generated: '2026-10-01'