Checkly · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Checkly Public Check alerts API

3 actions 3 updates phrasing extends openapi/checkly-check-alerts-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-alerts'].get
$.paths['/v1/check-alerts/{checkId}'].get

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 Checkly Public Check alerts API
  version: 1.0.0
extends: openapi/checkly-check-alerts-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-alerts'].get
  update:
    x-apievangelist-phrasing:
      intent: List alerts across all checks
      effect: read
      questions:
      - Which alerts fired across my whole account in the last six hours?
      - How wide a time window can I query for account alerts?
      instructions:
      - text: List all check alerts in my account.
      - text: Show every alert for my account between {from} and {to}.
        slots:
          from: query.from
          to: query.to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/check-alerts/{checkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List alerts for one check
      effect: read
      questions:
      - What alerts has a specific check triggered recently?
      - Can I see one check's alert history for a chosen window?
      instructions:
      - text: List alerts for check {checkId}.
        slots:
          checkId: path.checkId
      - text: Show alerts for check {checkId} from {from} to {to}.
        slots:
          checkId: path.checkId
          from: query.from
          to: query.to
      method: generated
      generated: '2026-09-26'