ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Page Load Tests API

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

$.paths['/tests/page-load'].post

$.paths['/tests/page-load/{testId}'].get

$.paths['/tests/page-load/{testId}'].put

$.paths['/tests/page-load/{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 Page Load Tests API
  version: 1.0.0
extends: openapi/thousandeyes-page-load-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/page-load'].get
  update:
    x-apievangelist-phrasing:
      intent: List Page Load tests
      effect: read
      questions:
      - What Page Load tests are configured in my account?
      - Are private snapshots included when I list Page Load tests?
      instructions:
      - text: List all Page Load tests.
      - text: Show Page Load tests in account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/page-load'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Page Load test
      effect: write
      questions:
      - How do I measure full browser page load time on a schedule?
      - Can I attach BGP monitors to a new Page Load test?
      instructions:
      - text: Create a new Page Load test.
      - text: Create a Page Load test with monitors {monitors}.
        slots:
          monitors: requestBody.monitors
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/page-load/{testId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Page Load test
      effect: read
      questions:
      - Which agents and alert rules does a Page Load test use?
      - Can I pull an older version of a Page Load test?
      instructions:
      - text: Show Page Load test {testId}.
        slots:
          testId: path.testId
      - text: Get version {versionId} of Page Load test {testId}.
        slots:
          versionId: query.versionId
          testId: path.testId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/page-load/{testId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Page Load test
      effect: write
      questions:
      - What fields are editable on a shared Page Load test?
      - How do I change the monitors on an existing Page Load test?
      instructions:
      - text: Update Page Load test {testId}.
        slots:
          testId: path.testId
      - text: Set the monitors of Page Load test {testId} to {monitors}.
        slots:
          testId: path.testId
          monitors: requestBody.monitors
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tests/page-load/{testId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Page Load test
      effect: destructive
      questions:
      - Can I delete a Page Load test?
      - Is Account Admin needed to remove a Page Load test?
      instructions:
      - text: Delete Page Load test {testId}.
        slots:
          testId: path.testId
      - text: Remove the page load test {testId}.
        slots:
          testId: path.testId
      method: generated
      generated: '2026-09-26'