Checkly · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Checkly Public Badges API

3 actions 3 updates phrasing extends openapi/checkly-badges-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/badges/checks/{checkId}'].get
$.paths['/v1/badges/groups/{groupId}'].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 Badges API
  version: 1.0.0
extends: openapi/checkly-badges-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/badges/checks/{checkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a status badge for a check
      effect: read
      questions:
      - How do I embed a live status badge for one check in my README?
      - Can a check badge show response time and a dark theme?
      instructions:
      - text: Get the status badge for check {checkId}.
        slots:
          checkId: path.checkId
      - text: Get check {checkId}'s badge in style {style} with theme {theme}.
        slots:
          checkId: path.checkId
          style: query.style
          theme: query.theme
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/badges/groups/{groupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a status badge for a check group
      effect: read
      questions:
      - Can I show one badge for the overall status of a check group?
      - Does a group badge need badges enabled in account settings?
      instructions:
      - text: Fetch the group-level badge for check group {groupId}.
        slots:
          groupId: path.groupId
      - text: Get group {groupId}'s badge with response time {responseTime}.
        slots:
          groupId: path.groupId
          responseTime: query.responseTime
      method: generated
      generated: '2026-09-26'