Checkly · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Checkly Public Subscriptions API

4 actions 4 updates phrasing extends openapi/checkly-subscriptions-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 4

$.info

$.paths['/v1/status-pages/{statusPageId}/subscriptions'].get

$.paths['/v1/status-pages/{statusPageId}/subscriptions/bulk'].post

$.paths['/v1/status-pages/{statusPageId}/subscriptions/{subscriptionId}'].delete

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 Subscriptions API
  version: 1.0.0
extends: openapi/checkly-subscriptions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/v1/status-pages/{statusPageId}/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscribers of a status page
      effect: read
      questions:
      - Which email subscribers are signed up to my status page?
      - How many people follow updates on a given status page?
      instructions:
      - text: List subscribers of status page {statusPageId}.
        slots:
          statusPageId: path.statusPageId
      - text: Show all subscriptions on page {statusPageId}.
        slots:
          statusPageId: path.statusPageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/status-pages/{statusPageId}/subscriptions/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Import subscribers onto a status page
      effect: write
      questions:
      - Can I import a list of subscribers onto a status page at once?
      - Do bulk-imported subscribers need to verify their subscription?
      instructions:
      - text: Import subscribers {subscriptions} onto status page {statusPageId}.
        slots:
          subscriptions: requestBody.subscriptions
          statusPageId: path.statusPageId
      - text: 'Bulk create subscriptions {subscriptions} on page {statusPageId} and auto-verify them: {autoVerify}.'
        slots:
          subscriptions: requestBody.subscriptions
          statusPageId: path.statusPageId
          autoVerify: requestBody.autoVerify
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/status-pages/{statusPageId}/subscriptions/{subscriptionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a status page subscription
      effect: destructive
      questions:
      - How do I remove one subscriber from a status page?
      - Can I delete a status page subscription by its ID?
      instructions:
      - text: Remove subscription {subscriptionId} from status page {statusPageId}.
        slots:
          subscriptionId: path.subscriptionId
          statusPageId: path.statusPageId
      - text: Delete subscriber {subscriptionId} on page {statusPageId}.
        slots:
          subscriptionId: path.subscriptionId
          statusPageId: path.statusPageId
      method: generated
      generated: '2026-10-01'