# 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 Pages V3 Incidents API
  version: 1.0.0
extends: openapi/checkly-status-pages-v3-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: 11
- target: $.paths['/v3/status-pages/{statusPageId}/incidents'].get
  update:
    x-apievangelist-phrasing:
      intent: List incidents on a status page
      effect: read
      questions:
      - Which incidents are on my status page, most recently updated first?
      - Can I page through a status page's incident history?
      instructions:
      - text: List incidents on status page {statusPageId}.
        slots:
          statusPageId: path.statusPageId
      - text: Show the next {limit} incidents on status page {statusPageId} after {nextId}.
        slots:
          limit: query.limit
          statusPageId: path.statusPageId
          nextId: query.nextId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/status-pages/{statusPageId}/incidents'].post
  update:
    x-apievangelist-phrasing:
      intent: Open an incident on a status page
      effect: write
      questions:
      - How do I declare an outage on my status page?
      - Can a new incident mark specific components as impacted right away?
      instructions:
      - text: Open incident {name} on status page {statusPageId} with first update {incidentUpdates}.
        slots:
          name: requestBody.name
          statusPageId: path.statusPageId
          incidentUpdates: requestBody.incidentUpdates
      - text: Declare incident {name} on status page {statusPageId} impacting {componentImpacts}, starting with {incidentUpdates}.
        slots:
          name: requestBody.name
          statusPageId: path.statusPageId
          componentImpacts: requestBody.componentImpacts
          incidentUpdates: requestBody.incidentUpdates
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/status-pages/{statusPageId}/incidents/{incidentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an incident on a status page
      effect: read
      questions:
      - What updates and component impacts does a specific incident have?
      - Can I see the full detail of one incident on my status page?
      instructions:
      - text: Show incident {incidentId} on status page {statusPageId}.
        slots:
          incidentId: path.incidentId
          statusPageId: path.statusPageId
      - text: Get the details and impacts of incident {incidentId} from status page {statusPageId}.
        slots:
          incidentId: path.incidentId
          statusPageId: path.statusPageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/status-pages/{statusPageId}/incidents/{incidentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename an incident or set component status
      effect: write
      questions:
      - Can I rename an incident that's already open on my status page?
      - How can I change which components an open incident currently affects?
      instructions:
      - text: Rename incident {incidentId} on status page {statusPageId} to {name}.
        slots:
          incidentId: path.incidentId
          statusPageId: path.statusPageId
          name: requestBody.name
      - text: Set incident {incidentId} on page {statusPageId} to name {name} with current impacts {componentImpacts}.
        slots:
          incidentId: path.incidentId
          statusPageId: path.statusPageId
          name: requestBody.name
          componentImpacts: requestBody.componentImpacts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/status-pages/{statusPageId}/incidents/{incidentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an incident from a status page
      effect: destructive
      questions:
      - How do I remove an incident posted by mistake from my status page?
      - Does deleting an incident also delete all of its updates?
      instructions:
      - text: Delete incident {incidentId} from status page {statusPageId}.
        slots:
          incidentId: path.incidentId
          statusPageId: path.statusPageId
      - text: Permanently remove incident {incidentId} and its updates from page {statusPageId}.
        slots:
          incidentId: path.incidentId
          statusPageId: path.statusPageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/status-pages/{statusPageId}/incidents/{incidentId}/component-impacts'].put
  update:
    x-apievangelist-phrasing:
      intent: Rewrite an incident's component impact timeline
      effect: write
      questions:
      - Can I retroactively correct when each component was impacted during an incident?
      - Is there a way to replace an incident's whole per-component impact history?
      instructions:
      - text: Replace the impact timeline of incident {incidentId} on page {statusPageId} with {componentImpacts}.
        slots:
          incidentId: path.incidentId
          statusPageId: path.statusPageId
          componentImpacts: requestBody.componentImpacts
      - text: Retroactively set the component windows for incident {incidentId} on status page {statusPageId} to {componentImpacts}.
        slots:
          incidentId: path.incidentId
          statusPageId: path.statusPageId
          componentImpacts: requestBody.componentImpacts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/status-pages/{statusPageId}/incidents/{incidentId}/incident-updates'].get
  update:
    x-apievangelist-phrasing:
      intent: List the updates posted to an incident
      effect: read
      questions:
      - What progress updates have been posted on an incident so far?
      - How many updates does the incident update list return at most?
      instructions:
      - text: List updates for incident {incidentId} on status page {statusPageId}.
        slots:
          incidentId: path.incidentId
          statusPageId: path.statusPageId
      - text: Show the newest-first update history of incident {incidentId} on page {statusPageId}.
        slots:
          incidentId: path.incidentId
          statusPageId: path.statusPageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/status-pages/{statusPageId}/incidents/{incidentId}/incident-updates'].post
  update:
    x-apievangelist-phrasing:
      intent: Post a progress update to an incident
      effect: write
      questions:
      - How do I post a status update to an ongoing incident?
      - Does posting a RESOLVED update close the incident?
      - Can I choose whether subscribers get notified about an incident update?
      instructions:
      - text: Post update {description} with status {status} to incident {incidentId} on page {statusPageId}.
        slots:
          description: requestBody.description
          status: requestBody.status
          incidentId: path.incidentId
          statusPageId: path.statusPageId
      - text: Resolve incident {incidentId} on status page {statusPageId} with the note {description} and status {status}.
        slots:
          incidentId: path.incidentId
          statusPageId: path.statusPageId
          description: requestBody.description
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/status-pages/{statusPageId}/incidents/{incidentId}/incident-updates/{incidentUpdateId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single incident update
      effect: read
      questions:
      - What did one specific incident update say?
      - Can I read back a single update I posted to an incident?
      instructions:
      - text: Show update {incidentUpdateId} of incident {incidentId} on status page {statusPageId}.
        slots:
          incidentUpdateId: path.incidentUpdateId
          incidentId: path.incidentId
          statusPageId: path.statusPageId
      - text: Get incident update {incidentUpdateId} from incident {incidentId} on page {statusPageId}.
        slots:
          incidentUpdateId: path.incidentUpdateId
          incidentId: path.incidentId
          statusPageId: path.statusPageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/status-pages/{statusPageId}/incidents/{incidentId}/incident-updates/{incidentUpdateId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an incident update already posted
      effect: write
      questions:
      - Can I fix a typo in an update I already posted to an incident?
      - Is it possible to change the status or public date on an existing incident update?
      instructions:
      - text: Edit update {incidentUpdateId} on incident {incidentId} (page {statusPageId}) to say {description} with status {status}.
        slots:
          incidentUpdateId: path.incidentUpdateId
          incidentId: path.incidentId
          statusPageId: path.statusPageId
          description: requestBody.description
          status: requestBody.status
      - text: Correct the text of incident update {incidentUpdateId} for incident {incidentId} on {statusPageId} to {description}, keeping status {status}.
        slots:
          incidentUpdateId: path.incidentUpdateId
          incidentId: path.incidentId
          statusPageId: path.statusPageId
          description: requestBody.description
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/status-pages/{statusPageId}/incidents/{incidentId}/incident-updates/{incidentUpdateId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an incident update
      effect: destructive
      questions:
      - Can I delete one update from an incident's history?
      - Why can't I delete the last remaining update on an incident?
      instructions:
      - text: Delete update {incidentUpdateId} from incident {incidentId} on status page {statusPageId}.
        slots:
          incidentUpdateId: path.incidentUpdateId
          incidentId: path.incidentId
          statusPageId: path.statusPageId
      - text: Remove the incident update {incidentUpdateId} posted on incident {incidentId}, page {statusPageId}.
        slots:
          incidentUpdateId: path.incidentUpdateId
          incidentId: path.incidentId
          statusPageId: path.statusPageId
      method: generated
      generated: '2026-09-26'