Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Vulnerability Management Policies API

9 actions 9 updates phrasing extends openapi/tenable-policies-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 9

$.info
$.paths['/policies'].get
$.paths['/policies'].post
$.paths['/policies/{policy_id}/copy'].post
$.paths['/policies/import'].post
$.paths['/policies/{policy_id}/export'].get
$.paths['/policies/{policy_id}'].get
$.paths['/policies/{policy_id}'].put
$.paths['/policies/{policy_id}'].delete

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 Policies API
  version: 1.0.0
extends: openapi/tenable-policies-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: 8
- target: $.paths['/policies'].get
  update:
    x-apievangelist-phrasing:
      intent: List scan policies
      effect: read
      questions:
      - Which scan templates (policies) have we saved?
      - What user-defined scan policies exist in my account?
      instructions:
      - text: List all my scan policies.
      - text: Show me every saved scan template.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a scan policy
      effect: write
      questions:
      - How do I create a new scan template from one of the built-in templates?
      - Which template UUID and settings does a new policy need?
      instructions:
      - text: Create a scan policy from template {uuid} with settings {settings}.
        slots:
          uuid: requestBody.uuid
          settings: requestBody.settings
      - text: 'Build a new scan template based on {uuid} using these settings: {settings}.'
        slots:
          uuid: requestBody.uuid
          settings: requestBody.settings
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/{policy_id}/copy'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy a scan policy
      effect: write
      questions:
      - Can I duplicate an existing scan template to tweak it?
      - Is there a quick way to make a copy of a policy?
      instructions:
      - text: Copy scan policy {policy_id}.
        slots:
          policy_id: path.policy_id
      - text: Duplicate the scan template {policy_id}.
        slots:
          policy_id: path.policy_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a .nessus scan policy
      effect: write
      questions:
      - How do I import a scan policy from a .nessus file I uploaded?
      - Which file formats can be imported as a scan template?
      instructions:
      - text: Import the uploaded scan policy file {file}.
        slots:
          file: requestBody.file
      - text: Create a scan template from the .nessus file {file}.
        slots:
          file: requestBody.file
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/{policy_id}/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a scan policy as .nessus
      effect: read
      questions:
      - Can I export a scan template to a .nessus file?
      - What format does a policy export download in?
      instructions:
      - text: Export scan policy {policy_id} in nessus format.
        slots:
          policy_id: path.policy_id
      - text: Download policy {policy_id} as a .nessus file.
        slots:
          policy_id: path.policy_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/{policy_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scan policy's settings
      effect: read
      questions:
      - What settings and plugins are configured in a given scan template?
      - Can I view the full configuration of one policy?
      instructions:
      - text: Show the settings of scan policy {policy_id}.
        slots:
          policy_id: path.policy_id
      - text: Get the full configuration for policy {policy_id}.
        slots:
          policy_id: path.policy_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/{policy_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a scan policy
      effect: write
      questions:
      - How do I change the settings of an existing scan template?
      - Can I edit a saved policy instead of creating a new one?
      instructions:
      - text: Update scan policy {policy_id} with new settings.
        slots:
          policy_id: path.policy_id
      - text: Edit the configuration of policy {policy_id}.
        slots:
          policy_id: path.policy_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/{policy_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a scan policy
      effect: destructive
      questions:
      - How do I delete a scan template I no longer use?
      - Can a deleted scan policy be recovered?
      instructions:
      - text: Delete scan policy {policy_id}.
        slots:
          policy_id: path.policy_id
      - text: Remove the scan template {policy_id}.
        slots:
          policy_id: path.policy_id
      method: generated
      generated: '2026-10-01'