Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity Exposure Event API

4 actions 4 updates phrasing extends openapi/tenable-event-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['/api/directories/{directoryId}/events/{id}'].get

$.paths['/api/infrastructures/{infrastructureId}/directories/{directoryId}/events/{id}'].get

$.paths['/api/events/search'].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 Identity Exposure Event API
  version: 1.0.0
extends: openapi/tenable-event-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['/api/directories/{directoryId}/events/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an AD event in a directory
      effect: read
      questions:
      - How do I look up one AD change event by id in a domain?
      - What happened in a given event in a directory?
      instructions:
      - text: Get event {id} in directory {directoryId}.
        slots:
          id: path.id
          directoryId: path.directoryId
      - text: Show event {id} for domain {directoryId} without the forest.
        slots:
          id: path.id
          directoryId: path.directoryId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/infrastructures/{infrastructureId}/directories/{directoryId}/events/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an AD event within a forest
      effect: read
      questions:
      - Can I fetch an event using its forest and domain ids?
      - Which call returns an event scoped to an infrastructure?
      instructions:
      - text: Get event {id} in directory {directoryId} of forest {infrastructureId}.
        slots:
          id: path.id
          directoryId: path.directoryId
          infrastructureId: path.infrastructureId
      - text: Show event {id} from infrastructure {infrastructureId}, domain {directoryId}.
        slots:
          id: path.id
          directoryId: path.directoryId
          infrastructureId: path.infrastructureId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/events/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search AD change events
      effect: read
      questions:
      - How do I search AD change events across domains in a time window?
      - Can I filter the event trail with an expression?
      instructions:
      - text: Search events in profile {profileId} for directories {directoryIds} from {dateStart} to {dateEnd} matching {expression}.
        slots:
          profileId: requestBody.profileId
          directoryIds: requestBody.directoryIds
          dateStart: requestBody.dateStart
          dateEnd: requestBody.dateEnd
          expression: requestBody.expression
      - text: Find changes in directories {directoryIds} between {dateStart} and {dateEnd} for profile {profileId}, filter {expression}, sorted {order}.
        slots:
          directoryIds: requestBody.directoryIds
          dateStart: requestBody.dateStart
          dateEnd: requestBody.dateEnd
          profileId: requestBody.profileId
          expression: requestBody.expression
          order: requestBody.order
      method: generated
      generated: '2026-10-01'