Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity Exposure Infrastructure API

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

$.info

$.paths['/api/infrastructures'].get

$.paths['/api/infrastructures'].post

$.paths['/api/infrastructures/{id}'].get

$.paths['/api/infrastructures/{id}'].delete

$.paths['/api/infrastructures/{id}'].patch

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 Identity Exposure Infrastructure API
  version: 1.0.0
extends: openapi/tenable-infrastructure-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: 5
- target: $.paths['/api/infrastructures'].get
  update:
    x-apievangelist-phrasing:
      intent: List forests
      effect: read
      questions:
      - Which AD forests are configured in Identity Exposure?
      - Can I list all infrastructures?
      instructions:
      - text: List all forests.
      - text: Show every infrastructure configured.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/infrastructures'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a forest
      effect: write
      questions:
      - How do I add a new Active Directory forest?
      - Can I register another infrastructure to monitor?
      instructions:
      - text: Create a new forest.
      - text: Add another infrastructure to Identity Exposure.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/infrastructures/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a forest
      effect: read
      questions:
      - How do I view one forest's settings?
      - Which login does an infrastructure use?
      instructions:
      - text: Get forest {id}.
        slots:
          id: path.id
      - text: Show infrastructure {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/infrastructures/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a forest
      effect: destructive
      questions:
      - How do I remove a forest from monitoring?
      - Can I delete an infrastructure entirely?
      instructions:
      - text: Delete forest {id}.
        slots:
          id: path.id
      - text: Remove infrastructure {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/infrastructures/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a forest's name or credentials
      effect: write
      questions:
      - Can I rotate the service account password for a forest?
      - How do I rename an infrastructure?
      instructions:
      - text: Rename forest {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set login {login} and password {password} on infrastructure {id}.
        slots:
          login: requestBody.login
          password: requestBody.password
          id: path.id
      method: generated
      generated: '2026-10-01'