Checkly · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Checkly Public Status Page Incidents API
11 actions
11 updates
phrasing
extends
openapi/checkly-status-page-incidents-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.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/v1/status-pages/incidents'].get
$.paths['/v1/status-pages/incidents'].post
$.paths['/v1/status-pages/incidents/{incidentId}'].get
$.paths['/v1/status-pages/incidents/{incidentId}'].put
$.paths['/v1/status-pages/incidents/{incidentId}'].delete
$.paths['/v1/status-pages/incidents/{incidentId}/incident-updates'].get
$.paths['/v1/status-pages/incidents/{incidentId}/incident-updates'].post
$.paths['/v1/status-pages/incidents/{incidentId}/incident-updates/{incidentUpdateId}'].get
$.paths['/v1/status-pages/incidents/{incidentId}/incident-updates/{incidentUpdateId}'].put
$.paths['/v1/status-pages/incidents/{incidentId}/incident-updates/{incidentUpdateId}'].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 Status Page Incidents API
version: 1.0.0
extends: openapi/checkly-status-page-incidents-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: 10
- target: $.paths['/v1/status-pages/incidents'].get
update:
x-apievangelist-phrasing:
intent: List recent status page incidents
effect: read
questions:
- What are the latest incidents posted across my status page services?
- Can I page through status page incidents beyond the first 100?
instructions:
- text: List my latest status page incidents.
- text: Show the next status page incidents after {nextId}.
slots:
nextId: query.nextId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/status-pages/incidents'].post
update:
x-apievangelist-phrasing:
intent: Open a status page incident
effect: write
questions:
- How do I declare an outage on my status page for specific services?
- Can I set the severity when I open a status page incident?
instructions:
- text: Open status page incident {name} with severity {severity} affecting {services} and first update {incidentUpdates}.
slots:
name: requestBody.name
severity: requestBody.severity
services: requestBody.services
incidentUpdates: requestBody.incidentUpdates
- text: Create a status page incident {name} at {severity} for services {services}, starting with update {incidentUpdates}.
slots:
name: requestBody.name
severity: requestBody.severity
services: requestBody.services
incidentUpdates: requestBody.incidentUpdates
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/status-pages/incidents/{incidentId}'].get
update:
x-apievangelist-phrasing:
intent: Get a status page incident
effect: read
questions:
- Which services did a specific status page incident affect?
- Can I see the full history of one status page incident?
instructions:
- text: Show status page incident {incidentId}.
slots:
incidentId: path.incidentId
- text: Get the history and affected services of status page incident {incidentId}.
slots:
incidentId: path.incidentId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/status-pages/incidents/{incidentId}'].put
update:
x-apievangelist-phrasing:
intent: Edit a status page incident
effect: write
questions:
- Can I raise the severity of a status page incident that's already open?
- How do I change which services a status page incident covers?
instructions:
- text: Update status page incident {incidentId} to name {name}, severity {severity}, services {services}.
slots:
incidentId: path.incidentId
name: requestBody.name
severity: requestBody.severity
services: requestBody.services
- text: Set status page incident {incidentId} severity to {severity}, keeping name {name} and services {services}.
slots:
incidentId: path.incidentId
severity: requestBody.severity
name: requestBody.name
services: requestBody.services
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/status-pages/incidents/{incidentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a status page incident
effect: destructive
questions:
- How do I remove a status page incident and all its updates?
- Is deleting a status page incident reversible?
instructions:
- text: Delete status page incident {incidentId}.
slots:
incidentId: path.incidentId
- text: Remove status page incident {incidentId} and every update on it.
slots:
incidentId: path.incidentId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/status-pages/incidents/{incidentId}/incident-updates'].get
update:
x-apievangelist-phrasing:
intent: List updates on a status page incident
effect: read
questions:
- What updates have been posted on one status page incident?
- How many updates can I fetch for a status page incident at once?
instructions:
- text: List the updates on status page incident {incidentId}.
slots:
incidentId: path.incidentId
- text: Show the latest 100 updates for status page incident {incidentId}.
slots:
incidentId: path.incidentId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/status-pages/incidents/{incidentId}/incident-updates'].post
update:
x-apievangelist-phrasing:
intent: Post an update on a status page incident
effect: write
questions:
- How do I post progress on a status page incident and notify subscribers?
- Can I backdate the public time of a status page incident update?
instructions:
- text: Post update {description} on status page incident {incidentId}.
slots:
description: requestBody.description
incidentId: path.incidentId
- text: Add a {status} update {description} to status page incident {incidentId} and notify subscribers.
slots:
status: requestBody.status
description: requestBody.description
incidentId: path.incidentId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/status-pages/incidents/{incidentId}/incident-updates/{incidentUpdateId}'].get
update:
x-apievangelist-phrasing:
intent: Get one status page incident update
effect: read
questions:
- What exactly did a specific update on a status page incident say?
- Can I look up one status page incident update by its id?
instructions:
- text: Show update {incidentUpdateId} on status page incident {incidentId}.
slots:
incidentUpdateId: path.incidentUpdateId
incidentId: path.incidentId
- text: Get status page incident update {incidentUpdateId} from incident {incidentId}.
slots:
incidentUpdateId: path.incidentUpdateId
incidentId: path.incidentId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/status-pages/incidents/{incidentId}/incident-updates/{incidentUpdateId}'].put
update:
x-apievangelist-phrasing:
intent: Edit a status page incident update
effect: write
questions:
- Can I correct the wording of an update already on my status page incident?
- How do I change the status on a posted status page incident update?
instructions:
- text: Change status page incident update {incidentUpdateId} on incident {incidentId} to say {description}.
slots:
incidentUpdateId: path.incidentUpdateId
incidentId: path.incidentId
description: requestBody.description
- text: Set update {incidentUpdateId} of status page incident {incidentId} to status {status} with text {description}.
slots:
incidentUpdateId: path.incidentUpdateId
incidentId: path.incidentId
status: requestBody.status
description: requestBody.description
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/status-pages/incidents/{incidentId}/incident-updates/{incidentUpdateId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a status page incident update
effect: destructive
questions:
- How do I remove one wrong update from a status page incident?
- Can I delete a single status page incident update and keep the incident?
instructions:
- text: Delete update {incidentUpdateId} from status page incident {incidentId}.
slots:
incidentUpdateId: path.incidentUpdateId
incidentId: path.incidentId
- text: Remove status page incident update {incidentUpdateId} on incident {incidentId}.
slots:
incidentUpdateId: path.incidentUpdateId
incidentId: path.incidentId
method: generated
generated: '2026-09-26'