ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes DNS Trace Tests API

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

$.paths['/tests/dns-trace'].post

$.paths['/tests/dns-trace/{testId}'].get

$.paths['/tests/dns-trace/{testId}'].put

$.paths['/tests/dns-trace/{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 DNS Trace Tests API
  version: 1.0.0
extends: openapi/thousandeyes-dns-trace-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/dns-trace'].get
  update:
    x-apievangelist-phrasing:
      intent: List DNS Trace tests
      effect: read
      questions:
      - What DNS Trace tests am I running?
      - Does the DNS Trace test list include private snapshots?
      instructions:
      - text: List all DNS Trace tests.
      - text: Show DNS Trace tests in account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/dns-trace'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a DNS Trace test
      effect: write
      questions:
      - How do I trace DNS delegation for a domain on a schedule?
      - Who can create a new DNS Trace test?
      instructions:
      - text: Create a new DNS Trace test.
      - text: Create a DNS Trace test in account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/dns-trace/{testId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a DNS Trace test
      effect: read
      questions:
      - Which agents and interval does a DNS Trace test use?
      - Can I fetch an earlier version of a DNS Trace test?
      instructions:
      - text: Show DNS Trace test {testId}.
        slots:
          testId: path.testId
      - text: Get version {versionId} of DNS Trace test {testId}.
        slots:
          versionId: query.versionId
          testId: path.testId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/dns-trace/{testId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a DNS Trace test
      effect: write
      questions:
      - What can I change on a shared DNS Trace test?
      - Is it possible to edit an existing DNS Trace test's alert rules?
      instructions:
      - text: Update DNS Trace test {testId}.
        slots:
          testId: path.testId
      - text: Edit the alert rules and labels on DNS Trace test {testId}.
        slots:
          testId: path.testId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/dns-trace/{testId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a DNS Trace test
      effect: destructive
      questions:
      - How do I delete a DNS Trace test?
      - Does removing a DNS Trace test need admin permissions?
      instructions:
      - text: Delete DNS Trace test {testId}.
        slots:
          testId: path.testId
      - text: Remove the DNS trace test {testId}.
        slots:
          testId: path.testId
      method: generated
      generated: '2026-09-26'