Checkly · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Checkly Public Check status API

3 actions 3 updates phrasing extends openapi/checkly-check-status-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/check-statuses'].get

$.paths['/v1/check-statuses/{checkId}'].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 Check status API
  version: 1.0.0
extends: openapi/checkly-check-status-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/check-statuses'].get
  update:
    x-apievangelist-phrasing:
      intent: List the current status of all checks
      effect: read
      questions:
      - Which of my checks are currently failing or degraded?
      - Can I get a live status overview of every check at once?
      instructions:
      - text: List the current status of all my checks.
      - text: Show which checks are passing or failing right now.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/check-statuses/{checkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current status of a check
      effect: read
      questions:
      - Is a specific check passing right now?
      - What is the latest status information for one check?
      instructions:
      - text: Show the current status of check {checkId}.
        slots:
          checkId: path.checkId
      - text: Check whether {checkId} is failing at the moment.
        slots:
          checkId: path.checkId
      method: generated
      generated: '2026-09-26'