ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Agent to Server Endpoint Scheduled Tests API

6 actions 6 updates phrasing extends openapi/thousandeyes-agent-to-server-endpoint-scheduled-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/scheduled-tests/agent-to-server'].get
$.paths['/endpoint/tests/scheduled-tests/agent-to-server'].post
$.paths['/endpoint/tests/scheduled-tests/agent-to-server/{testId}'].get
$.paths['/endpoint/tests/scheduled-tests/agent-to-server/{testId}'].delete
$.paths['/endpoint/tests/scheduled-tests/agent-to-server/{testId}'].patch

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 Agent to Server Endpoint Scheduled Tests API
  version: 1.0.0
extends: openapi/thousandeyes-agent-to-server-endpoint-scheduled-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/scheduled-tests/agent-to-server'].get
  update:
    x-apievangelist-phrasing:
      intent: List agent to server endpoint tests
      effect: read
      questions:
      - Which agent to server tests are scheduled on my endpoint agents?
      - Does the endpoint agent-to-server test list include private snapshots?
      instructions:
      - text: List all agent to server endpoint scheduled tests.
      - text: Show endpoint agent-to-server tests in account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/tests/scheduled-tests/agent-to-server'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an agent to server endpoint test
      effect: write
      questions:
      - How do I schedule a network test from employee laptops to a server?
      - Can I set the interval and protocol on a new endpoint agent-to-server test?
      instructions:
      - text: Create an endpoint agent-to-server test running every {interval} seconds.
        slots:
          interval: requestBody.interval
      - text: Create a prioritized endpoint agent-to-server test using protocol {protocol}.
        slots:
          protocol: requestBody.protocol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/tests/scheduled-tests/agent-to-server/{testId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an agent to server endpoint test
      effect: read
      questions:
      - Where do I see the settings of one endpoint agent-to-server test?
      - What server and port is a scheduled endpoint test targeting?
      instructions:
      - text: Show endpoint agent-to-server test {testId}.
        slots:
          testId: path.testId
      - text: Get the configuration of scheduled endpoint test {testId}.
        slots:
          testId: path.testId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/tests/scheduled-tests/agent-to-server/{testId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an agent to server endpoint test
      effect: destructive
      questions:
      - Can I remove an agent to server test from my endpoint agents?
      - What call deletes a scheduled endpoint network test?
      instructions:
      - text: Delete endpoint agent-to-server test {testId}.
        slots:
          testId: path.testId
      - text: Remove the scheduled endpoint agent to server test {testId}.
        slots:
          testId: path.testId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/tests/scheduled-tests/agent-to-server/{testId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an agent to server endpoint test
      effect: write
      questions:
      - Can I disable an endpoint agent-to-server test without deleting it?
      - How do I change the target server or port of an endpoint test?
      instructions:
      - text: Disable endpoint agent-to-server test {testId}.
        slots:
          testId: path.testId
      - text: Point endpoint test {testId} at server {server} on port {port}.
        slots:
          testId: path.testId
          server: requestBody.server
          port: requestBody.port
      - text: Rename endpoint agent-to-server test {testId} to {testName}.
        slots:
          testId: path.testId
          testName: requestBody.testName
      method: generated
      generated: '2026-09-26'