ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Agent To Server Endpoint Dynamic Tests API

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

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

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

$.paths['/endpoint/tests/dynamic-tests/agent-to-server/{testId}'].delete

$.paths['/endpoint/tests/dynamic-tests/agent-to-server/{testId}'].patch

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 Endpoint Dynamic Tests API
  version: 1.0.0
extends: openapi/thousandeyes-agent-to-server-endpoint-dynamic-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['/endpoint/tests/dynamic-tests/agent-to-server'].get
  update:
    x-apievangelist-phrasing:
      intent: List endpoint dynamic tests
      effect: read
      questions:
      - Which agent-to-server dynamic tests run from our endpoint agents?
      - Does the endpoint dynamic test list include saved events?
      instructions:
      - text: List all endpoint dynamic tests.
      - text: Show agent-to-server dynamic tests in account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/tests/dynamic-tests/agent-to-server'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an endpoint dynamic test
      effect: write
      questions:
      - Can I have endpoint agents dynamically test the path to an application like Teams?
      - Who is allowed to create an endpoint dynamic test?
      instructions:
      - text: Create an endpoint dynamic test {testName} for application {application}.
        slots:
          testName: requestBody.testName
          application: requestBody.application
      - text: Create dynamic test {testName} for {application} running every {interval} seconds on up to {maxMachines} machines.
        slots:
          testName: requestBody.testName
          application: requestBody.application
          interval: requestBody.interval
          maxMachines: requestBody.maxMachines
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/tests/dynamic-tests/agent-to-server/{testId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an endpoint dynamic test
      effect: read
      questions:
      - What interval and targets are set on one endpoint dynamic test?
      - Can I look up a single dynamic test by its ID?
      instructions:
      - text: Show endpoint dynamic test {testId}.
        slots:
          testId: path.testId
      - text: Get the configuration of agent-to-server dynamic test {testId}.
        slots:
          testId: path.testId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/tests/dynamic-tests/agent-to-server/{testId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an endpoint dynamic test
      effect: destructive
      questions:
      - Can I remove an agent-to-server dynamic test from our endpoint agents?
      - Is deleting an endpoint dynamic test permanent?
      instructions:
      - text: Delete endpoint dynamic test {testId}.
        slots:
          testId: path.testId
      - text: Remove agent-to-server dynamic test {testId}.
        slots:
          testId: path.testId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/tests/dynamic-tests/agent-to-server/{testId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update or toggle an endpoint dynamic test
      effect: write
      questions:
      - Can I disable an endpoint dynamic test without deleting it?
      - Is it possible to change the protocol of an existing dynamic test?
      instructions:
      - text: Disable endpoint dynamic test {testId} by setting enabled to {isEnabled}.
        slots:
          testId: path.testId
          isEnabled: requestBody.isEnabled
      - text: Change dynamic test {testId} to run every {interval} seconds.
        slots:
          testId: path.testId
          interval: requestBody.interval
      method: generated
      generated: '2026-09-26'