Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Vulnerability Management Remediation Scans API

3 actions 3 updates phrasing extends openapi/tenable-remediation-scans-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 3

$.info
$.paths['/scans/remediation'].get
$.paths['/scans/remediation'].post

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 Vulnerability Management Remediation Scans API
  version: 1.0.0
extends: openapi/tenable-remediation-scans-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: 2
- target: $.paths['/scans/remediation'].get
  update:
    x-apievangelist-phrasing:
      intent: List remediation scans
      effect: read
      questions:
      - Which remediation scans exist in my account?
      - Can I page through my remediation scans?
      instructions:
      - text: List my remediation scans.
      - text: Show {limit} remediation scans sorted by {sort}.
        slots:
          limit: query.limit
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scans/remediation'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a remediation scan
      effect: write
      questions:
      - How do I create a scan that verifies a vulnerability has been fixed?
      - Can I enable only specific plugins on a remediation scan?
      instructions:
      - text: Create a remediation scan from template {uuid} with settings {settings}.
        slots:
          uuid: requestBody.uuid
          settings: requestBody.settings
      - text: Create a remediation scan using template {uuid}, settings {settings} and enabled plugins {enabled_plugins}.
        slots:
          uuid: requestBody.uuid
          settings: requestBody.settings
          enabled_plugins: requestBody.enabled_plugins
      method: generated
      generated: '2026-10-01'