ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes HTTP Server Tests API

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

$.paths['/tests/http-server'].post

$.paths['/tests/http-server/{testId}'].get

$.paths['/tests/http-server/{testId}'].put

$.paths['/tests/http-server/{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 HTTP Server Tests API
  version: 1.0.0
extends: openapi/thousandeyes-http-server-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/http-server'].get
  update:
    x-apievangelist-phrasing:
      intent: List HTTP Server tests
      effect: read
      questions:
      - Which HTTP Server tests are monitoring our websites?
      - Does the HTTP Server test list include saved events?
      instructions:
      - text: List all HTTP Server tests.
      - text: Show HTTP Server tests in account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/http-server'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a scheduled HTTP Server test
      effect: write
      questions:
      - Can I monitor a URL's availability and response time on a schedule?
      - What permission is needed to create an HTTP Server test?
      instructions:
      - text: Create a scheduled HTTP Server test with BGP monitors {monitors}.
        slots:
          monitors: requestBody.monitors
      - text: Set up a recurring HTTP Server test in account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/http-server/{testId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an HTTP Server test
      effect: read
      questions:
      - What agents and alert rules does one HTTP Server test use?
      - Can I read an earlier version of an HTTP Server test?
      instructions:
      - text: Show HTTP Server test {testId}.
        slots:
          testId: path.testId
      - text: Get version {versionId} of HTTP Server test {testId}.
        slots:
          versionId: query.versionId
          testId: path.testId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/http-server/{testId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an HTTP Server test
      effect: write
      questions:
      - Can I change the monitors on an HTTP Server test?
      - What is editable on a shared HTTP Server test?
      instructions:
      - text: Set the monitors on HTTP Server test {testId} to {monitors}.
        slots:
          testId: path.testId
          monitors: requestBody.monitors
      - text: Update HTTP Server test {testId}.
        slots:
          testId: path.testId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/http-server/{testId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an HTTP Server test
      effect: destructive
      questions:
      - Can I remove an HTTP Server test?
      - Who is permitted to delete an HTTP Server test?
      instructions:
      - text: Delete HTTP Server test {testId}.
        slots:
          testId: path.testId
      - text: Remove HTTP Server test {testId} from account group {aid}.
        slots:
          testId: path.testId
          aid: query.aid
      method: generated
      generated: '2026-09-26'