Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tenable Platform & Settings OT Connectors API

7 actions 7 updates phrasing extends openapi/tenable-ot-connectors-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['/sensors'].post

$.paths['/sensors/{type}'].get

$.paths['/sensors/{type}/{id}'].get

$.paths['/sensors/{type}/{id}'].put

$.paths['/sensors/{type}/{id}'].delete

$.paths['/sensors/{type}/linking-key'].post

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 OT Connectors API
  version: 1.0.0
extends: openapi/tenable-ot-connectors-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['/sensors'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an OT connector
      effect: write
      questions:
      - How do I connect a Tenable OT Security instance to Vulnerability Management?
      - What linking key and target site do I need to create an OT connector?
      instructions:
      - text: Create OT connector {name} of subtype {subType}, enabled {enabled}, with linking key {x-linking-key} and site {x-target-site}.
        slots:
          name: requestBody.name
          subType: requestBody.subType
          enabled: requestBody.enabled
          x-linking-key: header.x-linking-key
          x-target-site: header.x-target-site
      - text: Register a new OT connector named {name} using linking key {x-linking-key}, target site {x-target-site}, subtype {subType}, enabled {enabled}.
        slots:
          name: requestBody.name
          x-linking-key: header.x-linking-key
          x-target-site: header.x-target-site
          subType: requestBody.subType
          enabled: requestBody.enabled
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sensors/{type}'].get
  update:
    x-apievangelist-phrasing:
      intent: List OT connectors
      effect: read
      questions:
      - Which OT connectors are linked to my account?
      - Can I sort and page through my OT connectors?
      instructions:
      - text: List my OT connectors of type {type}.
        slots:
          type: path.type
      - text: List {limit} OT connectors of type {type} sorted by {sortBy}.
        slots:
          limit: query.limit
          type: path.type
          sortBy: query.sortBy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sensors/{type}/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an OT connector's details
      effect: read
      questions:
      - What's the status and configuration of a specific OT connector?
      - Can I look up one OT connector by its ID?
      instructions:
      - text: Get the details of OT connector {id} of type {type}.
        slots:
          id: path.id
          type: path.type
      - text: Show whether OT connector {id} ({type}) is enabled.
        slots:
          id: path.id
          type: path.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sensors/{type}/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update or toggle an OT connector
      effect: write
      questions:
      - Can I disable an OT connector without deleting it?
      - Is it possible to rename an existing OT connector?
      instructions:
      - text: Set OT connector {id} of type {type} enabled to {enabled}.
        slots:
          id: path.id
          type: path.type
          enabled: requestBody.enabled
      - text: Rename OT connector {id} ({type}) to {name}.
        slots:
          id: path.id
          type: path.type
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sensors/{type}/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an OT connector
      effect: destructive
      questions:
      - Can I remove an OT connector I decommissioned?
      - Which call deletes an OT connector permanently?
      instructions:
      - text: Delete OT connector {id} of type {type}.
        slots:
          id: path.id
          type: path.type
      - text: Remove the {type} OT connector {id}.
        slots:
          type: path.type
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sensors/{type}/linking-key'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a linking key for OT connectors
      effect: write
      questions:
      - How long is an OT connector linking key valid?
      - Where do I get the linking key and target site needed to link an OT connector?
      instructions:
      - text: Generate a linking key for OT connector type {type}.
        slots:
          type: path.type
      - text: Get a single-use linking key and my target site for {type} connectors.
        slots:
          type: path.type
      method: generated
      generated: '2026-10-01'