ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Local Network Endpoint Test Results API

4 actions 4 updates phrasing extends openapi/thousandeyes-local-network-endpoint-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 4

$.info

$.paths['/endpoint/test-results/local-networks'].get

$.paths['/endpoint/test-results/local-networks/topologies/filter'].post

$.paths['/endpoint/test-results/local-networks/topologies/{networkTopologyId}'].get

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 Local Network Endpoint Test Results API
  version: 1.0.0
extends: openapi/thousandeyes-local-network-endpoint-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: 3
- target: $.paths['/endpoint/test-results/local-networks'].get
  update:
    x-apievangelist-phrasing:
      intent: List local networks used by endpoint agents
      effect: read
      questions:
      - Which local networks are my endpoint agents connected through?
      - Can I see every network my endpoint agents have used?
      instructions:
      - text: List the local networks used by endpoint agents.
      - text: Show local networks for account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/test-results/local-networks/topologies/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Search local network topology probes
      effect: read
      questions:
      - How do I find local network topology probes for a date range?
      - Can I filter endpoint topology probes by threshold?
      instructions:
      - text: List local network topology probes from the last {window}.
        slots:
          window: query.window
      - text: Find topology probes matching filters {searchFilters}.
        slots:
          searchFilters: requestBody.searchFilters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/test-results/local-networks/topologies/{networkTopologyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a local network topology
      effect: read
      questions:
      - What does the local network path look like for one topology?
      - Where can I see the detailed data of a single local network topology?
      instructions:
      - text: Show local network topology {networkTopologyId}.
        slots:
          networkTopologyId: path.networkTopologyId
      - text: Get details of endpoint network topology {networkTopologyId}.
        slots:
          networkTopologyId: path.networkTopologyId
      method: generated
      generated: '2026-09-26'