ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Account Groups API

6 actions 6 updates phrasing extends openapi/thousandeyes-account-groups-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['/account-groups'].get

$.paths['/account-groups'].post

$.paths['/account-groups/{id}'].get

$.paths['/account-groups/{id}'].put

$.paths['/account-groups/{id}'].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 Account Groups API
  version: 1.0.0
extends: openapi/thousandeyes-account-groups-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['/account-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List account groups
      effect: read
      questions:
      - Which account groups can I access?
      - Where do I find the aid values for my account groups?
      instructions:
      - text: List my account groups.
      - text: Show every account group available to me.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account group
      effect: write
      questions:
      - What permission is needed to create a new account group?
      - Can I assign agents to an account group when I create it?
      instructions:
      - text: Create an account group named {accountGroupName}.
        slots:
          accountGroupName: requestBody.accountGroupName
      - text: Create account group {accountGroupName} with agents {agents}.
        slots:
          accountGroupName: requestBody.accountGroupName
          agents: requestBody.agents
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account-groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account group's details
      effect: read
      questions:
      - What details can I see for one account group?
      - Which permission lets me view an account group's settings?
      instructions:
      - text: Show account group {id}.
        slots:
          id: path.id
      - text: Get the details of account group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account-groups/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename an account group or change its agents
      effect: write
      questions:
      - Can I rename an existing account group?
      - How can I change which agents belong to an account group?
      instructions:
      - text: Rename account group {id} to {accountGroupName}.
        slots:
          id: path.id
          accountGroupName: requestBody.accountGroupName
      - text: Set the agents of account group {id} to {agents}, keeping the name {accountGroupName}.
        slots:
          id: path.id
          agents: requestBody.agents
          accountGroupName: requestBody.accountGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account-groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account group
      effect: destructive
      questions:
      - Which permissions are required to delete an account group?
      - Can an account group be removed permanently?
      instructions:
      - text: Delete account group {id}.
        slots:
          id: path.id
      - text: Permanently remove account group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'