ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Tests API

3 actions 3 updates phrasing extends openapi/thousandeyes-tests-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['/tests'].get

$.paths['/tests/{testId}/history'].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 Tests API
  version: 1.0.0
extends: openapi/thousandeyes-tests-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['/tests'].get
  update:
    x-apievangelist-phrasing:
      intent: List all configured tests
      effect: read
      questions:
      - What tests of every type do we have configured?
      - Does the all-tests list include private snapshots?
      instructions:
      - text: List every configured test across all types.
      - text: Show all tests in account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/{testId}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a test's version history
      effect: read
      questions:
      - Who changed a test and when?
      - Can I limit how many versions of a test's history are returned?
      instructions:
      - text: Show the version history of test {testId}.
        slots:
          testId: path.testId
      - text: Get the last {limit} versions of test {testId}.
        slots:
          limit: query.limit
          testId: path.testId
      method: generated
      generated: '2026-09-26'