ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes SIP Server Tests API

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

$.paths['/tests/sip-server'].post

$.paths['/tests/sip-server/{testId}'].get

$.paths['/tests/sip-server/{testId}'].put

$.paths['/tests/sip-server/{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 SIP Server Tests API
  version: 1.0.0
extends: openapi/thousandeyes-sip-server-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/sip-server'].get
  update:
    x-apievangelist-phrasing:
      intent: List SIP Server tests
      effect: read
      questions:
      - Which SIP Server tests are configured?
      - Does listing SIP Server tests include private snapshots?
      instructions:
      - text: List all SIP Server tests.
      - text: Show SIP Server tests in account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/sip-server'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a SIP Server test
      effect: write
      questions:
      - How do I monitor whether my SIP server accepts registrations?
      - What SIP credentials does a new SIP Server test need?
      instructions:
      - text: Create a SIP Server test named {testName} with target credentials {targetSipCredentials}.
        slots:
          testName: requestBody.testName
          targetSipCredentials: requestBody.targetSipCredentials
      - text: Create a SIP Server test running every {interval} seconds against {targetSipCredentials}.
        slots:
          interval: requestBody.interval
          targetSipCredentials: requestBody.targetSipCredentials
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/sip-server/{testId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a SIP Server test
      effect: read
      questions:
      - What agents and alert rules are on a SIP Server test?
      - Can I fetch an older version of a SIP Server test?
      instructions:
      - text: Show SIP Server test {testId}.
        slots:
          testId: path.testId
      - text: Get version {versionId} of SIP Server test {testId}.
        slots:
          versionId: query.versionId
          testId: path.testId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/sip-server/{testId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a SIP Server test
      effect: write
      questions:
      - Can I change the interval of an existing SIP Server test?
      - Which settings are editable on a shared SIP Server test?
      instructions:
      - text: Set SIP Server test {testId} to run every {interval} seconds using {targetSipCredentials}.
        slots:
          testId: path.testId
          interval: requestBody.interval
          targetSipCredentials: requestBody.targetSipCredentials
      - text: Update the SIP credentials of SIP Server test {testId} to {targetSipCredentials}.
        slots:
          testId: path.testId
          targetSipCredentials: requestBody.targetSipCredentials
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/sip-server/{testId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a SIP Server test
      effect: destructive
      questions:
      - How do I delete a SIP Server test?
      - Is an Account Admin role needed to remove a SIP test?
      instructions:
      - text: Delete SIP Server test {testId}.
        slots:
          testId: path.testId
      - text: Remove the SIP server test {testId}.
        slots:
          testId: path.testId
      method: generated
      generated: '2026-09-26'