ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes HTTP Server Endpoint Scheduled Test Results API

4 actions 4 updates phrasing extends openapi/thousandeyes-http-server-endpoint-scheduled-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/scheduled-tests/{testId}/http-server'].get
$.paths['/endpoint/test-results/scheduled-tests/{testId}/http-server/filter'].post
$.paths['/endpoint/test-results/scheduled-tests/http-server/filter'].post

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 HTTP Server Endpoint Scheduled Test Results API
  version: 1.0.0
extends: openapi/thousandeyes-http-server-endpoint-scheduled-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/scheduled-tests/{testId}/http-server'].get
  update:
    x-apievangelist-phrasing:
      intent: Get endpoint HTTP server test results
      effect: read
      questions:
      - What DNS, connect, wait and receive times did one endpoint HTTP test record?
      - Can I get endpoint HTTP timings for a scheduled test over a time window?
      instructions:
      - text: Get HTTP server results for endpoint scheduled test {testId}.
        slots:
          testId: path.testId
      - text: Show endpoint HTTP timings for test {testId} over the last {window}.
        slots:
          testId: path.testId
          window: query.window
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/test-results/scheduled-tests/{testId}/http-server/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Filter HTTP results for one endpoint test
      effect: read
      questions:
      - How do I filter one endpoint HTTP test's results by threshold?
      - Can I sort and filter the HTTP timings of a single scheduled endpoint test?
      instructions:
      - text: Filter HTTP results of endpoint test {testId} with filters {searchFilters}.
        slots:
          testId: path.testId
          searchFilters: requestBody.searchFilters
      - text: Show HTTP results of endpoint test {testId} above threshold {thresholdFilter}.
        slots:
          testId: path.testId
          thresholdFilter: requestBody.thresholdFilter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/test-results/scheduled-tests/http-server/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Filter HTTP results across endpoint tests
      effect: read
      questions:
      - Is there a way to search HTTP results across all my endpoint scheduled tests at once?
      - Can I include every permitted account group when filtering endpoint HTTP results?
      instructions:
      - text: Search HTTP results across all endpoint scheduled tests with filters {searchFilters}.
        slots:
          searchFilters: requestBody.searchFilters
      - text: Filter endpoint HTTP results across all account groups I can access ({useAllPermittedAids}).
        slots:
          useAllPermittedAids: query.useAllPermittedAids
      method: generated
      generated: '2026-09-26'