ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes API Test Results API

3 actions 3 updates phrasing extends openapi/thousandeyes-api-test-results-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['/test-results/{testId}/api'].get
$.paths['/test-results/{testId}/api/agent/{agentId}/round/{roundId}'].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 API Test Results API
  version: 1.0.0
extends: openapi/thousandeyes-api-test-results-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['/test-results/{testId}/api'].get
  update:
    x-apievangelist-phrasing:
      intent: Get API test results
      effect: read
      questions:
      - Did my API test's requests succeed in the most recent round?
      - Can I retrieve API test results for a past time window?
      instructions:
      - text: Get API test results for test {testId}.
        slots:
          testId: path.testId
      - text: Show API test results for test {testId} from {startDate} to {endDate}.
        slots:
          testId: path.testId
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/test-results/{testId}/api/agent/{agentId}/round/{roundId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get API test results for an agent round
      effect: read
      questions:
      - How do I see what one agent got back in a single API test round?
      - Which call returns per-step API results for one agent and round?
      instructions:
      - text: Get API results for test {testId} from agent {agentId} in round {roundId}.
        slots:
          testId: path.testId
          agentId: path.agentId
          roundId: path.roundId
      - text: Show round {roundId} of API test {testId} run by agent {agentId}.
        slots:
          roundId: path.roundId
          testId: path.testId
          agentId: path.agentId
      method: generated
      generated: '2026-09-26'