ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Streaming API

6 actions 6 updates phrasing extends openapi/thousandeyes-streaming-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 6

$.info

$.paths['/streams'].get

$.paths['/streams'].post

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

$.paths['/streams/{id}'].put

$.paths['/streams/{id}'].delete

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 Streaming API
  version: 1.0.0
extends: openapi/thousandeyes-streaming-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: 5
- target: $.paths['/streams'].get
  update:
    x-apievangelist-phrasing:
      intent: List data streams
      effect: read
      questions:
      - Which data streams are exporting our test data?
      - Can I list only streams of a particular type?
      instructions:
      - text: List all data streams.
      - text: Show data streams of type {type}.
        slots:
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/streams'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data stream
      effect: write
      questions:
      - Can I stream test metrics to an OpenTelemetry collector?
      - Is it possible to add custom headers to a data stream?
      instructions:
      - text: Create a data stream named {name} sending to {streamEndpointUrl}.
        slots:
          name: requestBody.name
          streamEndpointUrl: requestBody.streamEndpointUrl
      - text: Create a {type} stream for signal {signal} to {streamEndpointUrl}.
        slots:
          type: requestBody.type
          signal: requestBody.signal
          streamEndpointUrl: requestBody.streamEndpointUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/streams/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data stream
      effect: read
      questions:
      - What endpoint and filters does a specific data stream use?
      - Can I look up one configured stream by ID?
      instructions:
      - text: Show data stream {id}.
        slots:
          id: path.id
      - text: Get the configuration of stream {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/streams/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a data stream
      effect: write
      questions:
      - Are fields replaced or appended when I update a data stream?
      - Can I pause a data stream without deleting it?
      instructions:
      - text: Point data stream {id} at {streamEndpointUrl}.
        slots:
          id: path.id
          streamEndpointUrl: requestBody.streamEndpointUrl
      - text: Set data stream {id} enabled to {enabled}.
        slots:
          id: path.id
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/streams/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data stream
      effect: destructive
      questions:
      - Can I stop and remove a data stream?
      - What deletes a configured data stream permanently?
      instructions:
      - text: Delete data stream {id}.
        slots:
          id: path.id
      - text: Remove stream {id} from account group {aid}.
        slots:
          id: path.id
          aid: query.aid
      method: generated
      generated: '2026-09-26'