ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Synthetic Monitoring Tests API

2 actions 2 updates phrasing extends openapi/controlup-tests-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for ControlUp's API. It is a proposal applied on top of the contract, not a document ControlUp publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/tests'].get

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 Synthetic Monitoring Tests API
  version: 1.0.0
extends: openapi/controlup-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: 1
- target: $.paths['/tests'].get
  update:
    x-apievangelist-phrasing:
      intent: List Scout test results
      effect: read
      questions:
      - What were the results of my Scout tests over the last day?
      - Can I list only failed tests for a particular Scout?
      instructions:
      - text: List Scout test results from {start} to {end}.
        slots:
          end: query.end
          start: query.start
      - text: Show tests for Scout {scoutId} with status {status}.
        slots:
          scoutId: query.scoutId
          status: query.status
      method: generated
      generated: '2026-09-26'