ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes BGP Tests API

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

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

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

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

$.paths['/tests/bgp/{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 BGP Tests API
  version: 1.0.0
extends: openapi/thousandeyes-bgp-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/bgp'].get
  update:
    x-apievangelist-phrasing:
      intent: List BGP tests
      effect: read
      questions:
      - Which BGP tests are monitoring our prefixes?
      - Are saved events included in the BGP test list?
      instructions:
      - text: List all BGP tests.
      - text: Show BGP tests in account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/bgp'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a BGP test
      effect: write
      questions:
      - Can I monitor route changes for one of our prefixes?
      - Which BGP monitors can I attach to a new BGP test?
      instructions:
      - text: Create a BGP test using monitors {monitors}.
        slots:
          monitors: requestBody.monitors
      - text: Create a BGP test with alert rules {alertRules}.
        slots:
          alertRules: requestBody.alertRules
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/bgp/{testId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a BGP test
      effect: read
      questions:
      - What alert rules and monitors does a specific BGP test use?
      - Can I view the configuration of one BGP test?
      instructions:
      - text: Show BGP test {testId}.
        slots:
          testId: path.testId
      - text: Get the details of BGP test {testId}.
        slots:
          testId: path.testId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/bgp/{testId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a BGP test
      effect: write
      questions:
      - Can I change the monitors on an existing BGP test?
      - What is editable on a shared BGP test?
      instructions:
      - text: Set the monitors on BGP test {testId} to {monitors}.
        slots:
          testId: path.testId
          monitors: requestBody.monitors
      - text: Update alert rules on BGP test {testId} to {alertRules}.
        slots:
          testId: path.testId
          alertRules: requestBody.alertRules
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/bgp/{testId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a BGP test
      effect: destructive
      questions:
      - Can I stop and remove a BGP test?
      - Who is permitted to delete BGP tests?
      instructions:
      - text: Delete BGP test {testId}.
        slots:
          testId: path.testId
      - text: Remove BGP test {testId} from account group {aid}.
        slots:
          testId: path.testId
          aid: query.aid
      method: generated
      generated: '2026-09-26'