ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Tags API

7 actions 7 updates phrasing extends openapi/thousandeyes-tags-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 7

$.info
$.paths['/tags'].get
$.paths['/tags'].post
$.paths['/tags/bulk'].post
$.paths['/tags/{id}'].get
$.paths['/tags/{id}'].put
$.paths['/tags/{id}'].delete

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 Tags API
  version: 1.0.0
extends: openapi/thousandeyes-tags-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: 6
- target: $.paths['/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List tags
      effect: read
      questions:
      - What tags exist in my account group?
      - Can I see which objects each tag is assigned to when listing tags?
      instructions:
      - text: List all my tags.
      - text: List tags in account group {aid} with their assignments expanded via {expand}.
        slots:
          aid: query.aid
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a single tag
      effect: write
      questions:
      - Can I create a key/value tag with its own color and icon?
      - What does it take to add one new tag?
      instructions:
      - text: Create a tag {key} with value {value}.
        slots:
          key: requestBody.key
          value: requestBody.value
      - text: Create tag {key}:{value} colored {color}.
        slots:
          key: requestBody.key
          value: requestBody.value
          color: requestBody.color
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Create many tags in one request
      effect: write
      questions:
      - Can I create a batch of tags at once and see which ones failed?
      - What does the statuses array mean when bulk-creating tags?
      instructions:
      - text: 'Bulk create these tags: {tags}.'
        slots:
          tags: requestBody.tags
      - text: Create multiple tags in one call from {tags}.
        slots:
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tag
      effect: read
      questions:
      - Can I look up a single tag by its ID?
      - What objects is a particular tag attached to?
      instructions:
      - text: Show tag {id}.
        slots:
          id: path.id
      - text: Get tag {id} with its assignments.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a tag
      effect: write
      questions:
      - Can I change a tag's value or color after it's created?
      - Is it possible to edit an existing tag's description?
      instructions:
      - text: Change tag {id} to value {value}.
        slots:
          id: path.id
          value: requestBody.value
      - text: Update tag {id} with color {color} and description {description}.
        slots:
          id: path.id
          color: requestBody.color
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tag
      effect: destructive
      questions:
      - Can I permanently delete a tag I no longer use?
      - What's the way to get rid of one tag by ID?
      instructions:
      - text: Delete tag {id}.
        slots:
          id: path.id
      - text: Remove tag {id} from account group {aid}.
        slots:
          id: path.id
          aid: query.aid
      method: generated
      generated: '2026-09-26'