ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes HTTP Server Endpoint Scheduled Tests API

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

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 Tests API
  version: 1.0.0
extends: openapi/thousandeyes-http-server-endpoint-scheduled-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['/endpoint/tests/scheduled-tests/http-server'].get
  update:
    x-apievangelist-phrasing:
      intent: List HTTP server endpoint tests
      effect: read
      questions:
      - Which HTTP server tests are scheduled on my endpoint agents?
      - Does the endpoint HTTP server test list exclude private snapshots?
      instructions:
      - text: List all HTTP server endpoint scheduled tests.
      - text: Show endpoint HTTP server tests in account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/tests/scheduled-tests/http-server'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an HTTP server endpoint test
      effect: write
      questions:
      - How do I monitor a web app's HTTP response from employee devices?
      - Can a new endpoint HTTP server test also collect network measurements?
      instructions:
      - text: Create an endpoint HTTP server test running every {interval} seconds.
        slots:
          interval: requestBody.interval
      - text: Create an endpoint HTTP server test with network measurements set to {networkMeasurements}.
        slots:
          networkMeasurements: requestBody.networkMeasurements
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/tests/scheduled-tests/http-server/{testId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an HTTP server endpoint test
      effect: read
      questions:
      - What URL and interval does a given endpoint HTTP server test use?
      - Can I retrieve one scheduled endpoint HTTP test by ID?
      instructions:
      - text: Show endpoint HTTP server test {testId}.
        slots:
          testId: path.testId
      - text: Get the configuration of scheduled endpoint HTTP test {testId}.
        slots:
          testId: path.testId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/tests/scheduled-tests/http-server/{testId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an HTTP server endpoint test
      effect: destructive
      questions:
      - Is there a way to delete an endpoint HTTP server test?
      - What removes a scheduled HTTP test from my endpoint agents?
      instructions:
      - text: Delete endpoint HTTP server test {testId}.
        slots:
          testId: path.testId
      - text: Remove the scheduled endpoint HTTP server test {testId}.
        slots:
          testId: path.testId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/tests/scheduled-tests/http-server/{testId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an HTTP server endpoint test
      effect: write
      questions:
      - Can I pause an endpoint HTTP server test without deleting it?
      - How do I change the URL an endpoint HTTP test checks?
      instructions:
      - text: Disable endpoint HTTP server test {testId}.
        slots:
          testId: path.testId
      - text: Point endpoint HTTP test {testId} at URL {url}.
        slots:
          testId: path.testId
          url: requestBody.url
      - text: Rename endpoint HTTP server test {testId} to {testName}.
        slots:
          testId: path.testId
          testName: requestBody.testName
      method: generated
      generated: '2026-09-26'