Checkly · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Checkly Public Runtimes API

3 actions 3 updates phrasing extends openapi/checkly-runtimes-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v1/runtimes'].get

$.paths['/v1/runtimes/{id}'].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 Checkly Public Runtimes API
  version: 1.0.0
extends: openapi/checkly-runtimes-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: 2
- target: $.paths['/v1/runtimes'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported runtimes
      effect: read
      questions:
      - Which runtimes can my browser checks and setup scripts use?
      - What NPM packages are included in the available runtimes?
      instructions:
      - text: List all supported runtimes.
      - text: Show the runtimes and their bundled NPM packages.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/runtimes/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a runtime's packages and versions
      effect: read
      questions:
      - Which package versions ship in a specific runtime?
      - Does a given runtime include the NPM package I need?
      instructions:
      - text: Show runtime {id}.
        slots:
          id: path.id
      - text: List the NPM packages and versions in runtime {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'