ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Cloud and Enterprise Agents API

5 actions 5 updates phrasing extends openapi/thousandeyes-cloud-and-enterprise-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 5

$.info

$.paths['/agents'].get

$.paths['/agents/{agentId}'].get

$.paths['/agents/{agentId}'].put

$.paths['/agents/{agentId}'].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 Cloud and Enterprise Agents API
  version: 1.0.0
extends: openapi/thousandeyes-cloud-and-enterprise-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: 4
- target: $.paths['/agents'].get
  update:
    x-apievangelist-phrasing:
      intent: List Cloud and Enterprise Agents
      effect: read
      questions:
      - Which Cloud and Enterprise Agents can my tests run from?
      - Can I list only Enterprise Agents, or filter agents by label?
      instructions:
      - text: List all Cloud and Enterprise Agents.
      - text: List agents of type {agentTypes}.
        slots:
          agentTypes: query.agentTypes
      - text: Show agents with labels {labels}.
        slots:
          labels: query.labels
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/{agentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Cloud or Enterprise Agent
      effect: read
      questions:
      - What tests are assigned to a particular agent?
      - Can I see an Enterprise Agent's utilization?
      instructions:
      - text: Show agent {agentId}.
        slots:
          agentId: path.agentId
      - text: Get details and assigned tests for agent {agentId}.
        slots:
          agentId: path.agentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/{agentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an Enterprise Agent
      effect: write
      questions:
      - Can I rename an Enterprise Agent or disable it?
      - Is it possible to move an Enterprise Agent into other account groups?
      instructions:
      - text: Rename Enterprise Agent {agentId} to {agentName}.
        slots:
          agentId: path.agentId
          agentName: requestBody.agentName
      - text: Set Enterprise Agent {agentId} enabled to {enabled}.
        slots:
          agentId: path.agentId
          enabled: requestBody.enabled
      - text: Assign Enterprise Agent {agentId} to account groups {accountGroups}.
        slots:
          agentId: path.agentId
          accountGroups: requestBody.accountGroups
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/{agentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Enterprise Agent
      effect: destructive
      questions:
      - What happens to tests when an Enterprise Agent is deleted?
      - Can I decommission an Enterprise Agent?
      instructions:
      - text: Delete Enterprise Agent {agentId}.
        slots:
          agentId: path.agentId
      - text: Decommission Enterprise Agent {agentId}.
        slots:
          agentId: path.agentId
      method: generated
      generated: '2026-09-26'