Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tenable Platform & Settings Profiles API

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

$.info
$.paths['/sensors/profiles/{sensor_type}'].get
$.paths['/sensors/profiles/{sensor_type}'].post
$.paths['/sensors/profiles/{sensor_type}/{profile_uuid}'].get
$.paths['/sensors/profiles/{sensor_type}/{profile_uuid}'].put
$.paths['/sensors/profiles/{sensor_type}/{profile_uuid}'].delete
$.paths['/sensors/profiles/{sensor_type}/{profile_uuid}/clone'].post
$.paths['/sensors/profiles/feed_versions'].get

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 Platform & Settings Profiles API
  version: 1.0.0
extends: openapi/tenable-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: 7
- target: $.paths['/sensors/profiles/{sensor_type}'].get
  update:
    x-apievangelist-phrasing:
      intent: List agent or scanner profiles
      effect: read
      questions:
      - Which agent profiles or scanner profiles do I have?
      - Can I list only the profiles for scanners rather than agents?
      instructions:
      - text: List all {sensor_type} profiles.
        slots:
          sensor_type: path.sensor_type
      - text: Show me the profiles defined for sensor type {sensor_type}.
        slots:
          sensor_type: path.sensor_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sensors/profiles/{sensor_type}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an agent or scanner profile
      effect: write
      questions:
      - How do I create a new profile to pin agents to a plugin set?
      - What can I put in a new scanner profile's configuration?
      instructions:
      - text: Create a {sensor_type} profile named {name}.
        slots:
          sensor_type: path.sensor_type
          name: requestBody.name
      - text: Create {sensor_type} profile {name} described as {description} with config {config}.
        slots:
          sensor_type: path.sensor_type
          name: requestBody.name
          description: requestBody.description
          config: requestBody.config
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sensors/profiles/{sensor_type}/{profile_uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a profile's details
      effect: read
      questions:
      - What configuration does a particular agent profile have?
      - Can I view one scanner profile by its UUID?
      instructions:
      - text: Show {sensor_type} profile {profile_uuid}.
        slots:
          sensor_type: path.sensor_type
          profile_uuid: path.profile_uuid
      - text: Get the configuration of {sensor_type} profile {profile_uuid}.
        slots:
          sensor_type: path.sensor_type
          profile_uuid: path.profile_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sensors/profiles/{sensor_type}/{profile_uuid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a profile
      effect: write
      questions:
      - How do I change the name or configuration of an existing profile?
      - Can I update a scanner profile's description?
      instructions:
      - text: Rename {sensor_type} profile {profile_uuid} to {name}.
        slots:
          sensor_type: path.sensor_type
          profile_uuid: path.profile_uuid
          name: requestBody.name
      - text: 'Update {sensor_type} profile {profile_uuid}: name {name}, config {config}.'
        slots:
          sensor_type: path.sensor_type
          profile_uuid: path.profile_uuid
          name: requestBody.name
          config: requestBody.config
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sensors/profiles/{sensor_type}/{profile_uuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a profile
      effect: destructive
      questions:
      - How do I delete an agent or scanner profile?
      - Can I monitor whether a profile deletion request has completed?
      instructions:
      - text: Delete {sensor_type} profile {profile_uuid}.
        slots:
          sensor_type: path.sensor_type
          profile_uuid: path.profile_uuid
      - text: Remove the profile {profile_uuid} of type {sensor_type}.
        slots:
          profile_uuid: path.profile_uuid
          sensor_type: path.sensor_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sensors/profiles/{sensor_type}/{profile_uuid}/clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone a profile
      effect: write
      questions:
      - Can I make a copy of an existing profile under a new name?
      - Is there a way to duplicate a scanner profile and give it a description?
      instructions:
      - text: Clone {sensor_type} profile {profile_uuid} as {name}.
        slots:
          sensor_type: path.sensor_type
          profile_uuid: path.profile_uuid
          name: requestBody.name
      - text: Copy profile {profile_uuid} ({sensor_type}) to a new one called {name} with description {description}.
        slots:
          profile_uuid: path.profile_uuid
          sensor_type: path.sensor_type
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sensors/profiles/feed_versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent plugin sets for profiles
      effect: read
      questions:
      - Which plugin sets were released to the feed in the last 30 days?
      - What plugin set versions can I pin a profile to?
      instructions:
      - text: List the plugin sets available to agent and scanner profiles.
      - text: Show the latest plugin feed versions from the past 30 days.
      method: generated
      generated: '2026-10-01'