Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Web Application Scanning v2 Templates API

7 actions 7 updates phrasing extends openapi/tenable-templates-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['/was/v2/templates'].get

$.paths['/was/v2/templates/{template_id}'].get

$.paths['/was/v2/user-templates/search'].post

$.paths['/was/v2/user-templates/{user_template_id}'].get

$.paths['/was/v2/user-templates/{user_template_id}'].put

$.paths['/was/v2/user-templates/{user_template_id}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Web Application Scanning v2 Templates API
  version: 1.0.0
extends: openapi/tenable-templates-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['/was/v2/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List Tenable-provided web app scan templates
      effect: read
      questions:
      - Which built-in templates can I base a web app scan configuration on?
      - Can I page through Tenable's web app scan templates?
      instructions:
      - text: List Tenable-provided web app scan templates.
      - text: List {limit} built-in WAS templates sorted by {sort}.
        slots:
          limit: query.limit
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v2/templates/{template_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Tenable-provided web app scan template
      effect: read
      questions:
      - What settings does a built-in web app scan template include?
      - Where can I see details for one of Tenable's WAS templates?
      instructions:
      - text: Get Tenable-provided WAS template {template_id}.
        slots:
          template_id: path.template_id
      - text: Show the defaults in built-in template {template_id}.
        slots:
          template_id: path.template_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v2/user-templates/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search user-defined web app scan templates
      effect: read
      questions:
      - Which custom web app scan templates have users in my org created?
      - Can I page through user-defined WAS templates?
      instructions:
      - text: Search my user-defined web app scan templates.
      - text: List {limit} user-defined WAS templates sorted by {sort}.
        slots:
          limit: query.limit
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v2/user-templates/{user_template_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user-defined web app scan template
      effect: read
      questions:
      - What's configured in one of our custom web app scan templates?
      - Where do I look up a user-defined WAS template by ID?
      instructions:
      - text: Get user-defined WAS template {user_template_id}.
        slots:
          user_template_id: path.user_template_id
      - text: Show custom template {user_template_id}.
        slots:
          user_template_id: path.user_template_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v2/user-templates/{user_template_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a user-defined web app scan template
      effect: write
      questions:
      - Can I change the settings or permissions of a custom web app scan template?
      - What fields must I send when updating a user-defined WAS template?
      instructions:
      - text: Change the settings of user-defined template {user_template_id} to {settings}.
        slots:
          user_template_id: path.user_template_id
          settings: requestBody.settings
      - text: Rename custom WAS template {user_template_id} to {name}.
        slots:
          user_template_id: path.user_template_id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v2/user-templates/{user_template_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user-defined web app scan template
      effect: destructive
      questions:
      - Why can't I delete a custom web app scan template?
      - How do I remove a user-defined WAS template no scan configs use?
      instructions:
      - text: Delete user-defined WAS template {user_template_id}.
        slots:
          user_template_id: path.user_template_id
      - text: Remove custom template {user_template_id}.
        slots:
          user_template_id: path.user_template_id
      method: generated
      generated: '2026-10-01'