ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Alerts API

3 actions 3 updates phrasing extends openapi/thousandeyes-alerts-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['/alerts'].get
$.paths['/alerts/{alertId}'].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 ThousandEyes Alerts API
  version: 1.0.0
extends: openapi/thousandeyes-alerts-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['/alerts'].get
  update:
    x-apievangelist-phrasing:
      intent: List alerts
      effect: read
      questions:
      - Which alerts are currently triggered?
      - Can I see alerts that have already cleared?
      - What time range is used when I list alerts without a filter?
      instructions:
      - text: List active alerts.
      - text: List alerts in state {state} from the last {window}.
        slots:
          state: query.state
          window: query.window
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alerts/{alertId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an alert's details
      effect: read
      questions:
      - What triggered a specific alert?
      - Can I look up one alert by its ID?
      instructions:
      - text: Show alert {alertId}.
        slots:
          alertId: path.alertId
      - text: Get the details of alert {alertId}.
        slots:
          alertId: path.alertId
      method: generated
      generated: '2026-09-26'