ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Agent to Server Tests API

6 actions 6 updates phrasing extends openapi/thousandeyes-agent-to-server-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/agent-to-server'].get

$.paths['/tests/agent-to-server'].post

$.paths['/tests/agent-to-server/{testId}'].get

$.paths['/tests/agent-to-server/{testId}'].put

$.paths['/tests/agent-to-server/{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 Agent to Server Tests API
  version: 1.0.0
extends: openapi/thousandeyes-agent-to-server-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/agent-to-server'].get
  update:
    x-apievangelist-phrasing:
      intent: List Agent to Server tests
      effect: read
      questions:
      - Which Agent to Server network tests are configured?
      - Are private snapshots included when I list Agent to Server tests?
      instructions:
      - text: List all Agent to Server tests.
      - text: Show Agent to Server tests in account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/agent-to-server'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an Agent to Server test
      effect: write
      questions:
      - What permissions do I need to create an Agent to Server test?
      - Can I choose the port an Agent to Server test probes?
      instructions:
      - text: Create an Agent to Server test on port {port}.
        slots:
          port: requestBody.port
      - text: Create an Agent to Server test using BGP monitors {monitors}.
        slots:
          monitors: requestBody.monitors
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/agent-to-server/{testId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Agent to Server test
      effect: read
      questions:
      - Which agents and alert rules are on a given Agent to Server test?
      - Can I read an older version of an Agent to Server test?
      instructions:
      - text: Show Agent to Server test {testId}.
        slots:
          testId: path.testId
      - text: Get version {versionId} of Agent to Server test {testId}.
        slots:
          versionId: query.versionId
          testId: path.testId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/agent-to-server/{testId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an Agent to Server test
      effect: write
      questions:
      - What can I change on a shared Agent to Server test?
      - Can I change the target server or interval of an Agent to Server test?
      instructions:
      - text: Point Agent to Server test {testId} at server {server}.
        slots:
          testId: path.testId
          server: requestBody.server
      - text: Set Agent to Server test {testId} to run every {interval} seconds.
        slots:
          testId: path.testId
          interval: requestBody.interval
      - text: Disable alerts on Agent to Server test {testId} by setting alertsEnabled to {alertsEnabled}.
        slots:
          testId: path.testId
          alertsEnabled: requestBody.alertsEnabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/agent-to-server/{testId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Agent to Server test
      effect: destructive
      questions:
      - Can I delete an Agent to Server test I no longer need?
      - Who is allowed to remove an Agent to Server test?
      instructions:
      - text: Delete Agent to Server test {testId}.
        slots:
          testId: path.testId
      - text: Remove the Agent to Server test {testId} from account group {aid}.
        slots:
          testId: path.testId
          aid: query.aid
      method: generated
      generated: '2026-09-26'