Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity Exposure Reason API

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

$.info
$.paths['/api/reasons'].get
$.paths['/api/reasons/{id}'].get
$.paths['/api/profiles/{profileId}/checkers/{checkerId}/reasons'].get
$.paths['/api/profiles/{profileId}/infrastructures/{infrastructureId}/directories/{directoryId}/events/{eventId}/reasons'].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 Identity Exposure Reason API
  version: 1.0.0
extends: openapi/tenable-reason-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: 4
- target: $.paths['/api/reasons'].get
  update:
    x-apievangelist-phrasing:
      intent: List deviance reasons
      effect: read
      questions:
      - What reasons can a deviance be raised for?
      - Can I list every reason across all checkers?
      instructions:
      - text: List all reasons.
      - text: Show every deviance reason defined.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/reasons/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deviance reason
      effect: read
      questions:
      - How do I look up what one reason id means?
      - What does a specific deviance reason describe?
      instructions:
      - text: Get reason {id}.
        slots:
          id: path.id
      - text: Explain deviance reason {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/profiles/{profileId}/checkers/{checkerId}/reasons'].get
  update:
    x-apievangelist-phrasing:
      intent: List reasons with deviances for a checker
      effect: read
      questions:
      - Which reasons are actually producing deviances for one indicator?
      - Can I see the active reasons behind a checker's findings in a profile?
      instructions:
      - text: List reasons with deviances for checker {checkerId} in profile {profileId}.
        slots:
          checkerId: path.checkerId
          profileId: path.profileId
      - text: Show why checker {checkerId} is failing in profile {profileId}.
        slots:
          checkerId: path.checkerId
          profileId: path.profileId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/profiles/{profileId}/infrastructures/{infrastructureId}/directories/{directoryId}/events/{eventId}/reasons'].get
  update:
    x-apievangelist-phrasing:
      intent: List reasons with deviances for an event
      effect: read
      questions:
      - Which reasons explain the deviances a specific event created?
      - Can I see the reasons tied to one AD change event?
      instructions:
      - text: List reasons for event {eventId} in directory {directoryId}, forest {infrastructureId}, profile {profileId}.
        slots:
          eventId: path.eventId
          directoryId: path.directoryId
          infrastructureId: path.infrastructureId
          profileId: path.profileId
      - text: Show why event {eventId} in {infrastructureId}/{directoryId} raised deviances under profile {profileId}.
        slots:
          eventId: path.eventId
          directoryId: path.directoryId
          infrastructureId: path.infrastructureId
          profileId: path.profileId
      method: generated
      generated: '2026-10-01'