Checkly · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Checkly Public Alert notifications API

2 actions 2 updates phrasing extends openapi/checkly-alert-notifications-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 2

$.info
$.paths['/v1/alert-notifications'].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 Alert notifications API
  version: 1.0.0
extends: openapi/checkly-alert-notifications-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: 1
- target: $.paths['/v1/alert-notifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List sent alert notifications
      effect: read
      questions:
      - Did my alert notifications actually get delivered?
      - Can I see only notifications that failed to send?
      - Can I narrow notifications to one alert channel?
      instructions:
      - text: List alert notifications sent through channel {alertChannelId}.
        slots:
          alertChannelId: query.alertChannelId
      - text: Show alert notifications that failed to send between {from} and {to}.
        slots:
          from: query.from
          to: query.to
      method: generated
      generated: '2026-09-26'