ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Web Transaction Tests API

6 actions 6 updates phrasing extends openapi/thousandeyes-web-transaction-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/web-transactions'].get

$.paths['/tests/web-transactions'].post

$.paths['/tests/web-transactions/{testId}'].get

$.paths['/tests/web-transactions/{testId}'].put

$.paths['/tests/web-transactions/{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 Web Transaction Tests API
  version: 1.0.0
extends: openapi/thousandeyes-web-transaction-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/web-transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List Web Transactions tests
      effect: read
      questions:
      - Which scripted Web Transactions tests are configured?
      - Are private snapshots included when listing Web Transactions tests?
      instructions:
      - text: List all Web Transactions tests.
      - text: Show Web Transactions tests in account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/web-transactions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a scheduled Web Transactions test
      effect: write
      questions:
      - Can I script a multi-step user journey and run it on a schedule?
      - Can a new Web Transactions test use stored credentials?
      instructions:
      - text: Create a scheduled Web Transactions test using credentials {credentials}.
        slots:
          credentials: requestBody.credentials
      - text: Create a recurring Web Transactions test with BGP monitors {monitors}.
        slots:
          monitors: requestBody.monitors
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/web-transactions/{testId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Web Transactions test
      effect: read
      questions:
      - What agents and alert rules are on a Web Transactions test?
      - Can I view an older version of a Web Transactions test?
      instructions:
      - text: Show Web Transactions test {testId}.
        slots:
          testId: path.testId
      - text: Get version {versionId} of Web Transactions test {testId}.
        slots:
          versionId: query.versionId
          testId: path.testId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/web-transactions/{testId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Web Transactions test
      effect: write
      questions:
      - Can I swap the credentials a Web Transactions test uses?
      - What can be changed on a shared Web Transactions test?
      instructions:
      - text: Set the credentials on Web Transactions test {testId} to {credentials}.
        slots:
          testId: path.testId
          credentials: requestBody.credentials
      - text: Change the monitors on Web Transactions test {testId} to {monitors}.
        slots:
          testId: path.testId
          monitors: requestBody.monitors
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/web-transactions/{testId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Web Transactions test
      effect: destructive
      questions:
      - Can I remove a Web Transactions test?
      - Who can delete Web Transactions tests?
      instructions:
      - text: Delete Web Transactions test {testId}.
        slots:
          testId: path.testId
      - text: Remove Web Transactions test {testId} from account group {aid}.
        slots:
          testId: path.testId
          aid: query.aid
      method: generated
      generated: '2026-09-26'