Checkly · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Checkly Public Incidents API

5 actions 5 updates phrasing extends openapi/checkly-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.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/v1/incidents'].post

$.paths['/v1/incidents/{id}'].get

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

$.paths['/v1/incidents/{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 Incidents API
  version: 1.0.0
extends: openapi/checkly-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: 4
- target: $.paths['/v1/incidents'].post
  update:
    x-apievangelist-phrasing:
      intent: Open an incident on a dashboard
      effect: write
      questions:
      - How do I announce an incident on one of my dashboards?
      - Can I set the impact level and start time of a dashboard incident?
      instructions:
      - text: Open incident {name} with impact {impact} on dashboard {dashboardId} with first update {incidentUpdates}.
        slots:
          name: requestBody.name
          impact: requestBody.impact
          dashboardId: requestBody.dashboardId
          incidentUpdates: requestBody.incidentUpdates
      - text: Create a dashboard incident {name}, impact {impact}, on {dashboardId}, started {startedAt}, first update {incidentUpdates}.
        slots:
          name: requestBody.name
          impact: requestBody.impact
          dashboardId: requestBody.dashboardId
          startedAt: requestBody.startedAt
          incidentUpdates: requestBody.incidentUpdates
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/incidents/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dashboard incident
      effect: read
      questions:
      - What's the current state of a dashboard incident?
      - Can I include every update when I fetch a dashboard incident?
      instructions:
      - text: Show dashboard incident {id}.
        slots:
          id: path.id
      - text: Get dashboard incident {id} with all updates {includeAllIncidentUpdates}.
        slots:
          id: path.id
          includeAllIncidentUpdates: query.includeAllIncidentUpdates
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/incidents/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a dashboard incident
      effect: write
      questions:
      - How do I mark a dashboard incident as stopped?
      - Can I change the impact of a dashboard incident after opening it?
      instructions:
      - text: Update dashboard incident {id} to name {name} and impact {impact}.
        slots:
          id: path.id
          name: requestBody.name
          impact: requestBody.impact
      - text: Close dashboard incident {id} ({name}, {impact}) with stop time {stoppedAt}.
        slots:
          id: path.id
          name: requestBody.name
          impact: requestBody.impact
          stoppedAt: requestBody.stoppedAt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/incidents/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a dashboard incident
      effect: destructive
      questions:
      - How do I remove a dashboard incident and all its updates?
      - Can a deleted dashboard incident be restored?
      instructions:
      - text: Delete dashboard incident {id}.
        slots:
          id: path.id
      - text: Remove dashboard incident {id} with every update on it.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'