ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes API Tests API

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

$.info

$.paths['/tests/api'].get

$.paths['/tests/api'].post

$.paths['/tests/api/{testId}'].get

$.paths['/tests/api/{testId}'].put

$.paths['/tests/api/{testId}'].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 API Tests API
  version: 1.0.0
extends: openapi/thousandeyes-api-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: 5
- target: $.paths['/tests/api'].get
  update:
    x-apievangelist-phrasing:
      intent: List API tests
      effect: read
      questions:
      - What API tests do I have configured?
      - Does listing API tests also return private snapshots?
      instructions:
      - text: List all API tests.
      - text: Show API tests in account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/api'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API test
      effect: write
      questions:
      - How do I set up a scheduled test that calls my API endpoints?
      - Can an API test use credentials from the credential vault?
      instructions:
      - text: Create a new API test.
      - text: Create an API test that uses vault credentials {vaultCredentials}.
        slots:
          vaultCredentials: requestBody.vaultCredentials
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/api/{testId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API test
      effect: read
      questions:
      - Can I see the alert rules and agents attached to an API test?
      - Can I retrieve a past version of an API test's configuration?
      instructions:
      - text: Show API test {testId}.
        slots:
          testId: path.testId
      - text: Get API test {testId} with its agents and alert rules expanded via {expand}.
        slots:
          testId: path.testId
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/api/{testId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an API test
      effect: write
      questions:
      - Which fields can I change on a shared API test?
      - How do I swap the credentials used by an API test?
      instructions:
      - text: Update API test {testId}.
        slots:
          testId: path.testId
      - text: Set the credentials of API test {testId} to {credentials}.
        slots:
          testId: path.testId
          credentials: requestBody.credentials
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/api/{testId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API test
      effect: destructive
      questions:
      - Is there a way to remove an API test?
      - Can I delete a scheduled API test by its ID?
      instructions:
      - text: Delete API test {testId}.
        slots:
          testId: path.testId
      - text: Remove API test {testId} from account group {aid}.
        slots:
          testId: path.testId
          aid: query.aid
      method: generated
      generated: '2026-09-26'