ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Voice Tests API

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

$.paths['/tests/voice'].post

$.paths['/tests/voice/{testId}'].get

$.paths['/tests/voice/{testId}'].put

$.paths['/tests/voice/{testId}'].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 Voice Tests API
  version: 1.0.0
extends: openapi/thousandeyes-voice-tests-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['/tests/voice'].get
  update:
    x-apievangelist-phrasing:
      intent: List Voice tests
      effect: read
      questions:
      - What Voice tests do I have?
      - Are private snapshots part of the Voice test list?
      instructions:
      - text: List all Voice tests.
      - text: Show Voice tests in account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/voice'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Voice test
      effect: write
      questions:
      - How do I measure call quality between two agents on a schedule?
      - Can I add BGP monitors to a new Voice test?
      instructions:
      - text: Create a new Voice test.
      - text: Create a Voice test with monitors {monitors}.
        slots:
          monitors: requestBody.monitors
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/voice/{testId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Voice test
      effect: read
      questions:
      - Which agents and interval does a Voice test use?
      - Can I retrieve a past version of a Voice test?
      instructions:
      - text: Show Voice test {testId}.
        slots:
          testId: path.testId
      - text: Get version {versionId} of Voice test {testId}.
        slots:
          versionId: query.versionId
          testId: path.testId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/voice/{testId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Voice test
      effect: write
      questions:
      - What can I change on a shared Voice test?
      - Is it possible to edit the monitors on an existing Voice test?
      instructions:
      - text: Update Voice test {testId}.
        slots:
          testId: path.testId
      - text: Set the monitors of Voice test {testId} to {monitors}.
        slots:
          testId: path.testId
          monitors: requestBody.monitors
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/voice/{testId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Voice test
      effect: destructive
      questions:
      - How do I delete a Voice test?
      - Does deleting a Voice test require admin rights?
      instructions:
      - text: Delete Voice test {testId}.
        slots:
          testId: path.testId
      - text: Remove the voice test {testId}.
        slots:
          testId: path.testId
      method: generated
      generated: '2026-09-26'