Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tenable Platform & Settings Scanner Profiles API

4 actions 4 updates phrasing extends openapi/tenable-scanner-profiles-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 4

$.info

$.paths['/scanners/scanners/bulkAssignToProfile'].post

$.paths['/scanners/scanners/bulkAssignToProfile'].delete

$.paths['/scanners/request-status/{request_status_id}'].get

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 Tenable Platform & Settings Scanner Profiles API
  version: 1.0.0
extends: openapi/tenable-scanner-profiles-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: 3
- target: $.paths['/scanners/scanners/bulkAssignToProfile'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign scanners to a scanner profile
      effect: write
      questions:
      - How do I assign several scanners to a scanner profile at once?
      - Is bulk assigning scanners to a profile asynchronous?
      instructions:
      - text: Assign scanners {scanner_uuids} to profile {profile_uuid}.
        slots:
          scanner_uuids: requestBody.scanner_uuids
          profile_uuid: requestBody.profile_uuid
      - text: Add scanners {scanner_uuids} to scanner profile {profile_uuid}.
        slots:
          scanner_uuids: requestBody.scanner_uuids
          profile_uuid: requestBody.profile_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/scanners/bulkAssignToProfile'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove scanners from a scanner profile
      effect: destructive
      questions:
      - Can I remove multiple scanners from a scanner profile in one call?
      - How do I take scanners out of a profile?
      instructions:
      - text: Remove scanners {scanner_uuids} from profile {profile_uuid}.
        slots:
          scanner_uuids: requestBody.scanner_uuids
          profile_uuid: requestBody.profile_uuid
      - text: Unassign {scanner_uuids} from scanner profile {profile_uuid}.
        slots:
          scanner_uuids: requestBody.scanner_uuids
          profile_uuid: requestBody.profile_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/request-status/{request_status_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a bulk scanner task's status
      effect: read
      questions:
      - Did my bulk scanner profile assignment finish?
      - How can I track progress of an asynchronous scanner task?
      instructions:
      - text: Check scanner task status {request_status_id}.
        slots:
          request_status_id: path.request_status_id
      - text: Tell me whether bulk scanner task {request_status_id} completed.
        slots:
          request_status_id: path.request_status_id
      method: generated
      generated: '2026-10-01'