ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Endpoint Agent Labels API

6 actions 6 updates phrasing extends openapi/thousandeyes-endpoint-agent-labels-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/labels'].get
$.paths['/endpoint/labels'].post
$.paths['/endpoint/labels/{id}'].get
$.paths['/endpoint/labels/{id}'].delete
$.paths['/endpoint/labels/{id}'].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 Endpoint Agent Labels API
  version: 1.0.0
extends: openapi/thousandeyes-endpoint-agent-labels-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/labels'].get
  update:
    x-apievangelist-phrasing:
      intent: List endpoint agent labels
      effect: read
      questions:
      - What labels group my endpoint agents?
      - Can I page through endpoint labels with a cursor?
      instructions:
      - text: List all endpoint agent labels.
      - text: Show up to {max} endpoint labels.
        slots:
          max: query.max
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/labels'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an endpoint agent label
      effect: write
      questions:
      - How do I group endpoint agents automatically with a label?
      - Can a label match agents using filters and a match type?
      instructions:
      - text: Create an endpoint label named {name} with color {color}.
        slots:
          name: requestBody.name
          color: requestBody.color
      - text: Create endpoint label {name} matching agents by filters {filters}.
        slots:
          name: requestBody.name
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/labels/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an endpoint agent label
      effect: read
      questions:
      - What filters define a particular endpoint label?
      - Can I retrieve one endpoint label by its ID?
      instructions:
      - text: Show endpoint label {id}.
        slots:
          id: path.id
      - text: Get the filters of endpoint agent label {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/labels/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an endpoint agent label
      effect: destructive
      questions:
      - Is there a way to delete an endpoint agent label?
      - Can I remove a label I no longer use for endpoint agents?
      instructions:
      - text: Delete endpoint label {id}.
        slots:
          id: path.id
      - text: Remove endpoint agent label {id} from my account.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/labels/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an endpoint agent label
      effect: write
      questions:
      - How do I change the filters on an endpoint label?
      - Can I recolor or rename an existing endpoint label?
      instructions:
      - text: Rename endpoint label {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Change the color of endpoint label {id} to {color}.
        slots:
          id: path.id
          color: requestBody.color
      - text: Update the matching filters of endpoint label {id} to {filters}.
        slots:
          id: path.id
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'