Checkly · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Checkly Public Incident Updates API

4 actions 4 updates phrasing extends openapi/checkly-incident-updates-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/incidents/{incidentId}/updates'].post

$.paths['/v1/incidents/{incidentId}/updates/{id}'].put

$.paths['/v1/incidents/{incidentId}/updates/{id}'].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 Incident Updates API
  version: 1.0.0
extends: openapi/checkly-incident-updates-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: 3
- target: $.paths['/v1/incidents/{incidentId}/updates'].post
  update:
    x-apievangelist-phrasing:
      intent: Post an update on a dashboard incident
      effect: write
      questions:
      - How do I tell dashboard viewers we've identified the cause of an incident?
      - Which statuses can a dashboard incident update have?
      instructions:
      - text: 'Post a {status} update on dashboard incident {incidentId}: {description}.'
        slots:
          status: requestBody.status
          incidentId: path.incidentId
          description: requestBody.description
      - text: Mark dashboard incident {incidentId} as {status} with note {description}.
        slots:
          incidentId: path.incidentId
          status: requestBody.status
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/incidents/{incidentId}/updates/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a dashboard incident update
      effect: write
      questions:
      - Can I reword an update I already posted on a dashboard incident?
      - How do I fix a mistake in a dashboard incident update?
      instructions:
      - text: Change update {id} on dashboard incident {incidentId} to say {description}.
        slots:
          id: path.id
          incidentId: path.incidentId
          description: requestBody.description
      - text: Rewrite dashboard incident {incidentId} update {id} as {description}.
        slots:
          incidentId: path.incidentId
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/incidents/{incidentId}/updates/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a dashboard incident update
      effect: destructive
      questions:
      - How do I remove a single update from a dashboard incident?
      - Is deleting a dashboard incident update permanent?
      instructions:
      - text: Delete update {id} from dashboard incident {incidentId}.
        slots:
          id: path.id
          incidentId: path.incidentId
      - text: Remove dashboard incident {incidentId} update {id}.
        slots:
          incidentId: path.incidentId
          id: path.id
      method: generated
      generated: '2026-09-26'