Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tenable Folders API

9 actions 9 updates phrasing extends openapi/tenable-folders-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['/folders'].get
$.paths['/folders'].post
$.paths['/folders/{folder_id}'].put
$.paths['/folders/{folder_id}'].delete
$.paths['/was/v2/folders'].get
$.paths['/was/v2/folders'].post
$.paths['/was/v2/folders/{folder_id}'].put
$.paths['/was/v2/folders/{folder_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 Tenable Folders API
  version: 1.0.0
extends: openapi/tenable-folders-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['/folders'].get
  update:
    x-apievangelist-phrasing:
      intent: List vulnerability management scan folders
      effect: read
      questions:
      - What scan folders do I have in Vulnerability Management?
      - Does the folder list include Tenable's built-in folders as well as mine?
      instructions:
      - text: List my vulnerability management scan folders.
      - text: Show the built-in and custom folders for network scans.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/folders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a vulnerability management scan folder
      effect: write
      questions:
      - How do I create a new folder to organise my network scans?
      - Is there a rate limit on creating scan folders?
      instructions:
      - text: Create a vulnerability management folder named {name}.
        slots:
          name: requestBody.name
      - text: Make a new network scan folder called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/folders/{folder_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a vulnerability management scan folder
      effect: write
      questions:
      - Can I rename one of my network scan folders?
      - Why can't I rename a Tenable-provided scan folder?
      instructions:
      - text: Rename vulnerability management folder {folder_id} to {name}.
        slots:
          folder_id: path.folder_id
          name: requestBody.name
      - text: Change the name of network scan folder {folder_id} to {name}.
        slots:
          folder_id: path.folder_id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/folders/{folder_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a vulnerability management scan folder
      effect: destructive
      questions:
      - What happens to the scans in a network scan folder when I delete it?
      - Can an administrator delete another user's scan folder?
      instructions:
      - text: Delete vulnerability management folder {folder_id}.
        slots:
          folder_id: path.folder_id
      - text: Remove network scan folder {folder_id} and send its scans to Trash.
        slots:
          folder_id: path.folder_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v2/folders'].get
  update:
    x-apievangelist-phrasing:
      intent: List web app scanning folders
      effect: read
      questions:
      - Which custom folders do I have in Web App Scanning?
      - Where can I see my WAS scan folders?
      instructions:
      - text: List my web app scanning folders.
      - text: Show my custom WAS folders.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v2/folders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a web app scanning folder
      effect: write
      questions:
      - How do I create a folder for my web application scans?
      - Can I make custom folders in Web App Scanning?
      instructions:
      - text: Create a web app scanning folder named {name}.
        slots:
          name: requestBody.name
      - text: Make a new WAS folder called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v2/folders/{folder_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a web app scanning folder
      effect: write
      questions:
      - Can I rename a folder in Web App Scanning?
      - Am I allowed to rename another user's WAS folder as an admin?
      instructions:
      - text: Rename web app scanning folder {folder_id} to {name}.
        slots:
          folder_id: path.folder_id
          name: requestBody.name
      - text: Change WAS folder {folder_id} name to {name}.
        slots:
          folder_id: path.folder_id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v2/folders/{folder_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a web app scanning folder
      effect: destructive
      questions:
      - How do I delete a Web App Scanning folder?
      - Where do web app scans go when their WAS folder is deleted?
      instructions:
      - text: Delete web app scanning folder {folder_id}.
        slots:
          folder_id: path.folder_id
      - text: Remove WAS folder {folder_id}.
        slots:
          folder_id: path.folder_id
      method: generated
      generated: '2026-10-01'