ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Tests Assignment on Agents API

4 actions 4 updates phrasing extends openapi/thousandeyes-tests-assignment-on-agents-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 4

$.info
$.paths['/agents/{agentId}/tests/assign'].post
$.paths['/agents/{agentId}/tests/override'].post
$.paths['/agents/{agentId}/tests/unassign'].post

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 Tests Assignment on Agents API
  version: 1.0.0
extends: openapi/thousandeyes-tests-assignment-on-agents-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: 3
- target: $.paths['/agents/{agentId}/tests/assign'].post
  update:
    x-apievangelist-phrasing:
      intent: Add tests to an agent
      effect: write
      questions:
      - Can I add tests to an agent without removing the ones it already runs?
      - What happens if a test ID doesn't exist when assigning to an agent?
      instructions:
      - text: Assign tests {testIds} to agent {agentId}.
        slots:
          testIds: requestBody.testIds
          agentId: path.agentId
      - text: Add tests {testIds} to the ones agent {agentId} already runs.
        slots:
          testIds: requestBody.testIds
          agentId: path.agentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/{agentId}/tests/override'].post
  update:
    x-apievangelist-phrasing:
      intent: Replace all tests on an agent
      effect: write
      questions:
      - Can I replace every test on an agent with a new set?
      - Is there a way to overwrite an agent's test assignments in one go?
      instructions:
      - text: Replace all tests on agent {agentId} with {testIds}.
        slots:
          agentId: path.agentId
          testIds: requestBody.testIds
      - text: Overwrite agent {agentId} so it runs only tests {testIds}.
        slots:
          agentId: path.agentId
          testIds: requestBody.testIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/{agentId}/tests/unassign'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove tests from an agent
      effect: write
      questions:
      - Can I stop an agent from running specific tests?
      - Does unassigning tests from an agent fail if the agent doesn't exist?
      instructions:
      - text: Unassign tests {testIds} from agent {agentId}.
        slots:
          testIds: requestBody.testIds
          agentId: path.agentId
      - text: Stop agent {agentId} from running tests {testIds}.
        slots:
          agentId: path.agentId
          testIds: requestBody.testIds
      method: generated
      generated: '2026-09-26'