Checkly · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Checkly Public Heartbeats API

6 actions 6 updates phrasing extends openapi/checkly-heartbeats-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 6

$.info

$.paths['/v1/checks/heartbeat'].post

$.paths['/v1/checks/heartbeat/{id}'].put

$.paths['/v1/checks/heartbeats/{checkId}/availability'].get

$.paths['/v1/checks/heartbeats/{checkId}/events'].get

$.paths['/v1/checks/heartbeats/{checkId}/events/{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 Heartbeats API
  version: 1.0.0
extends: openapi/checkly-heartbeats-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: 5
- target: $.paths['/v1/checks/heartbeat'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a heartbeat check
      effect: write
      questions:
      - How do I monitor a cron job that should ping a URL on a schedule?
      - What happens if I create a heartbeat check beyond my plan limit?
      - Can a heartbeat check use my account-wide alert settings?
      instructions:
      - text: Create heartbeat check {name} with schedule {heartbeat}.
        slots:
          name: requestBody.name
          heartbeat: requestBody.heartbeat
      - text: Create heartbeat check {name} with {heartbeat}, tagged {tags}, in group {groupId}.
        slots:
          name: requestBody.name
          heartbeat: requestBody.heartbeat
          tags: requestBody.tags
          groupId: requestBody.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/heartbeat/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a heartbeat check
      effect: write
      questions:
      - How do I change the expected period or grace time of an existing heartbeat?
      - Can I mute a heartbeat check without deleting it?
      instructions:
      - text: Change heartbeat check {id} schedule to {heartbeat}.
        slots:
          id: path.id
          heartbeat: requestBody.heartbeat
      - text: Set heartbeat check {id} muted to {muted}.
        slots:
          id: path.id
          muted: requestBody.muted
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/heartbeats/{checkId}/availability'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a heartbeat's availability
      effect: read
      questions:
      - What percentage of expected pings did my heartbeat receive?
      - Can I check heartbeat availability for a specific time range?
      instructions:
      - text: Show availability for heartbeat {checkId}.
        slots:
          checkId: path.checkId
      - text: Get heartbeat {checkId} availability from {startTime} to {endTime}.
        slots:
          checkId: path.checkId
          startTime: query.startTime
          endTime: query.endTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/heartbeats/{checkId}/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List ping events for a heartbeat
      effect: read
      questions:
      - When did my heartbeat last receive a ping?
      - Can I list every ping a heartbeat got between two times?
      instructions:
      - text: List events for heartbeat {checkId}.
        slots:
          checkId: path.checkId
      - text: Show heartbeat {checkId} events between {startTime} and {endTime}, up to {limit}.
        slots:
          checkId: path.checkId
          startTime: query.startTime
          endTime: query.endTime
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/heartbeats/{checkId}/events/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one heartbeat event
      effect: read
      questions:
      - What details are recorded for a single heartbeat ping event?
      - Can I look up one heartbeat event by its id?
      instructions:
      - text: Show event {id} of heartbeat {checkId}.
        slots:
          id: path.id
          checkId: path.checkId
      - text: Get heartbeat {checkId} ping event {id}.
        slots:
          checkId: path.checkId
          id: path.id
      method: generated
      generated: '2026-09-26'