ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Emulation API

4 actions 4 updates phrasing extends openapi/thousandeyes-emulation-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['/user-agents'].get
$.paths['/emulated-devices'].get
$.paths['/emulated-devices'].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 Emulation API
  version: 1.0.0
extends: openapi/thousandeyes-emulation-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['/user-agents'].get
  update:
    x-apievangelist-phrasing:
      intent: List user-agent strings
      effect: read
      questions:
      - Which user-agent strings can browser tests emulate?
      - Can I see the available user-agents for an account group?
      instructions:
      - text: List the available user-agent strings.
      - text: Show user-agents for account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/emulated-devices'].get
  update:
    x-apievangelist-phrasing:
      intent: List emulated devices
      effect: read
      questions:
      - Which devices can browser tests emulate?
      - Can I see the screen sizes of emulated devices?
      instructions:
      - text: List emulated devices for browser tests.
      - text: Show all emulated devices with {expand} expanded.
        slots:
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/emulated-devices'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an emulated device
      effect: write
      questions:
      - Can I add a custom device size for browser tests to emulate?
      - What fields define a new emulated device?
      instructions:
      - text: Create a {category} emulated device {width} by {height}.
        slots:
          category: requestBody.category
          width: requestBody.width
          height: requestBody.height
      - text: Add an emulated device in category {category} with width {width} and height {height}.
        slots:
          category: requestBody.category
          width: requestBody.width
          height: requestBody.height
      method: generated
      generated: '2026-09-26'