ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Network BGP Test Results API

3 actions 3 updates phrasing extends openapi/thousandeyes-network-bgp-test-results-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 3

$.info
$.paths['/test-results/{testId}/bgp'].get
$.paths['/test-results/{testId}/bgp/routes/prefix/{prefixId}/round/{roundId}'].get

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 Network BGP Test Results API
  version: 1.0.0
extends: openapi/thousandeyes-network-bgp-test-results-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: 2
- target: $.paths['/test-results/{testId}/bgp'].get
  update:
    x-apievangelist-phrasing:
      intent: Get BGP test results
      effect: read
      questions:
      - Which BGP monitors can see our target prefix, and how reachable is it?
      - Can I get BGP reachability and path changes over a time window?
      instructions:
      - text: Get BGP results for test {testId}.
        slots:
          testId: path.testId
      - text: Show BGP results for test {testId} over the last {window}.
        slots:
          testId: path.testId
          window: query.window
      method: generated
      generated: '2026-09-26'
- target: $.paths['/test-results/{testId}/bgp/routes/prefix/{prefixId}/round/{roundId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get BGP routes for a prefix in a round
      effect: read
      questions:
      - What AS path did a prefix take in a given BGP test round?
      - Can I see the networks crossed by one prefix?
      instructions:
      - text: Show BGP routes for prefix {prefixId} in round {roundId} of test {testId}.
        slots:
          prefixId: path.prefixId
          roundId: path.roundId
          testId: path.testId
      - text: Get route paths of test {testId} for prefix {prefixId}, round {roundId}.
        slots:
          testId: path.testId
          prefixId: path.prefixId
          roundId: path.roundId
      method: generated
      generated: '2026-09-26'