Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tenable Plugins API

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

$.info
$.paths['/plugins/plugin'].get
$.paths['/plugins/plugin/{id}'].get
$.paths['/plugins/families'].get
$.paths['/plugins/families/{id}'].get
$.paths['/plugins/families/_byName'].post
$.paths['/was/v2/plugins'].get
$.paths['/was/v2/plugins/{plugin_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 Tenable Plugins API
  version: 1.0.0
extends: openapi/tenable-plugins-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: 7
- target: $.paths['/plugins/plugin'].get
  update:
    x-apievangelist-phrasing:
      intent: List vulnerability management plugins
      effect: read
      questions:
      - How do I get the full list of Tenable plugins with their details?
      - Can I list only plugins updated after a certain date?
      - Does the plugin last_updated filter account for VPR changes?
      instructions:
      - text: List plugins updated since {last_updated}.
        slots:
          last_updated: query.last_updated
      - text: Get page {page} of plugins with {size} per page.
        slots:
          page: query.page
          size: query.size
      method: generated
      generated: '2026-10-01'
- target: $.paths['/plugins/plugin/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a vulnerability management plugin
      effect: read
      questions:
      - What does a specific Nessus plugin check for?
      - Where can I read the attributes of one vulnerability plugin by ID?
      instructions:
      - text: Get details for plugin {id}.
        slots:
          id: path.id
      - text: Show what Nessus plugin {id} detects.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/plugins/families'].get
  update:
    x-apievangelist-phrasing:
      intent: List plugin families
      effect: read
      questions:
      - What plugin families are available?
      - Can I include every plugin family, not just the default ones?
      instructions:
      - text: List the plugin families.
      - text: List plugin families with all set to {all}.
        slots:
          all: query.all
      method: generated
      generated: '2026-10-01'
- target: $.paths['/plugins/families/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List plugins in a family by ID
      effect: read
      questions:
      - Which plugins belong to a plugin family when I have its ID?
      - Can I see every plugin in one family?
      instructions:
      - text: List the plugins in family {id}.
        slots:
          id: path.id
      - text: Show plugins for plugin family ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/plugins/families/_byName'].post
  update:
    x-apievangelist-phrasing:
      intent: List plugins in a family by name
      effect: read
      questions:
      - Can I look up the plugins in a family using the family name instead of its ID?
      - Which plugins are in the family called something like Web Servers?
      instructions:
      - text: List plugins in the family named {name}.
        slots:
          name: requestBody.name
      - text: Show every plugin in plugin family {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v2/plugins'].get
  update:
    x-apievangelist-phrasing:
      intent: List web app scanning plugins
      effect: read
      questions:
      - Which plugins does Web App Scanning use?
      - Can I page through the web application scanning plugins?
      instructions:
      - text: List web app scanning plugins.
      - text: List {limit} WAS plugins sorted by {sort}.
        slots:
          limit: query.limit
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v2/plugins/{plugin_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a web app scanning plugin
      effect: read
      questions:
      - What does a particular web application scanning plugin detect?
      - Where are the details for one WAS plugin?
      instructions:
      - text: Get web app scanning plugin {plugin_id}.
        slots:
          plugin_id: path.plugin_id
      - text: Show details for WAS plugin {plugin_id}.
        slots:
          plugin_id: path.plugin_id
      method: generated
      generated: '2026-10-01'