ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Events API

3 actions 3 updates phrasing extends openapi/thousandeyes-events-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for ThousandEyes's API. It is a proposal applied on top of the contract, not a document ThousandEyes publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/events'].get

$.paths['/events/{id}'].get

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 ThousandEyes Events API
  version: 1.0.0
extends: openapi/thousandeyes-events-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List events
      effect: read
      questions:
      - Which network events were detected in the last day?
      - Can I list only ongoing events?
      instructions:
      - text: List events from the last {window}.
        slots:
          window: query.window
      - text: Show only ongoing events ({ongoing}).
        slots:
          ongoing: query.ongoing
      - text: List events between {startDate} and {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event's details
      effect: read
      questions:
      - What was affected by a specific event?
      - Can I look up one detected event by ID?
      instructions:
      - text: Show event {id}.
        slots:
          id: path.id
      - text: Get the details of event {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'