Checkly · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Checkly Public Error Groups API

5 actions 5 updates phrasing extends openapi/checkly-error-groups-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 5

$.info

$.paths['/v1/error-groups'].get

$.paths['/v1/error-groups/checks/{checkId}'].get

$.paths['/v1/error-groups/{id}'].get

$.paths['/v1/error-groups/{id}'].patch

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 Error Groups API
  version: 1.0.0
extends: openapi/checkly-error-groups-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: 4
- target: $.paths['/v1/error-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List error groups across my account
      effect: read
      questions:
      - Which recurring errors are my checks hitting across the whole account?
      - Can I page through all error groups?
      instructions:
      - text: List all error groups in my account.
      - text: Show page {page} of error groups, {limit} per page.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/error-groups/checks/{checkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List error groups for one check
      effect: read
      questions:
      - What distinct errors has a specific check been failing with?
      - Can I see error groups for just one check?
      instructions:
      - text: List error groups for check {checkId}.
        slots:
          checkId: path.checkId
      - text: Show {limit} error groups of check {checkId}.
        slots:
          limit: query.limit
          checkId: path.checkId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/error-groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an error group
      effect: read
      questions:
      - What are the details of one error group?
      - Can I look up a single error group by its ID?
      instructions:
      - text: Show error group {id}.
        slots:
          id: path.id
      - text: Get details of error group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/error-groups/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Archive an error group
      effect: write
      questions:
      - How do I archive an error group so it stops cluttering my list?
      - Can an archived error group come back when the error happens again?
      instructions:
      - text: Archive error group {id} forever.
        slots:
          id: path.id
      - text: 'Archive error group {id} until the next event: {archivedUntilNextEvent}.'
        slots:
          id: path.id
          archivedUntilNextEvent: requestBody.archivedUntilNextEvent
      method: generated
      generated: '2026-09-26'