Checkly · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Checkly Public Status Page Services API

6 actions 6 updates phrasing extends openapi/checkly-status-page-services-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/status-pages/services'].get
$.paths['/v1/status-pages/services'].post
$.paths['/v1/status-pages/services/{serviceId}'].get
$.paths['/v1/status-pages/services/{serviceId}'].put
$.paths['/v1/status-pages/services/{serviceId}'].delete

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 Status Page Services API
  version: 1.0.0
extends: openapi/checkly-status-page-services-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/status-pages/services'].get
  update:
    x-apievangelist-phrasing:
      intent: List status page services
      effect: read
      questions:
      - Which services are defined for my status pages?
      - Can I page through status page services?
      instructions:
      - text: List all my status page services.
      - text: Show status page services after {nextId}.
        slots:
          nextId: query.nextId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/status-pages/services'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a status page service
      effect: write
      questions:
      - How do I add a new service that incidents can be reported against?
      - What do I need to create a status page service?
      instructions:
      - text: Create a status page service named {name}.
        slots:
          name: requestBody.name
      - text: Add {name} as a new service for my status pages.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/status-pages/services/{serviceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a status page service
      effect: read
      questions:
      - What are the details of one status page service?
      - Can I look up a status page service by its id?
      instructions:
      - text: Show status page service {serviceId}.
        slots:
          serviceId: path.serviceId
      - text: Get the details of service {serviceId}.
        slots:
          serviceId: path.serviceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/status-pages/services/{serviceId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a status page service
      effect: write
      questions:
      - How do I rename a service shown on my status page?
      - Can I update an existing status page service?
      instructions:
      - text: Rename status page service {serviceId} to {name}.
        slots:
          serviceId: path.serviceId
          name: requestBody.name
      - text: Update service {serviceId} with the name {name}.
        slots:
          serviceId: path.serviceId
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/status-pages/services/{serviceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a status page service
      effect: destructive
      questions:
      - How do I remove a service from my status pages?
      - Can I delete a status page service I no longer offer?
      instructions:
      - text: Delete status page service {serviceId}.
        slots:
          serviceId: path.serviceId
      - text: Remove service {serviceId} from my status pages.
        slots:
          serviceId: path.serviceId
      method: generated
      generated: '2026-09-26'