Checkly · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Checkly Public Status Pages V3 Automation Rules API

6 actions 6 updates phrasing extends openapi/checkly-status-pages-v3-automation-rules-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['/v3/status-pages/{statusPageId}/automation-rules'].get

$.paths['/v3/status-pages/{statusPageId}/automation-rules'].post

$.paths['/v3/status-pages/{statusPageId}/automation-rules/{ruleId}'].get

$.paths['/v3/status-pages/{statusPageId}/automation-rules/{ruleId}'].put

$.paths['/v3/status-pages/{statusPageId}/automation-rules/{ruleId}'].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 Pages V3 Automation Rules API
  version: 1.0.0
extends: openapi/checkly-status-pages-v3-automation-rules-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['/v3/status-pages/{statusPageId}/automation-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a status page's automation rules
      effect: read
      questions:
      - Which automation rules open incidents on my status page?
      - Can I page through a status page's automation rules?
      instructions:
      - text: List automation rules on status page {statusPageId}.
        slots:
          statusPageId: path.statusPageId
      - text: Show {limit} automation rules on 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}/automation-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an incident automation rule
      effect: write
      questions:
      - How can failing checks automatically open an incident on my status page?
      - Can an automation rule wait a cool-down period before opening another incident?
      instructions:
      - text: Create automation rule {name} on page {statusPageId} for tags {tags}, first update {firstUpdate}, last update {lastUpdate}.
        slots:
          name: requestBody.name
          statusPageId: path.statusPageId
          tags: requestBody.tags
          firstUpdate: requestBody.firstUpdate
          lastUpdate: requestBody.lastUpdate
      - text: On status page {statusPageId}, auto-open incidents for checks tagged {tags} impacting {components}, rule {name}, updates {firstUpdate} and {lastUpdate}.
        slots:
          statusPageId: path.statusPageId
          tags: requestBody.tags
          components: requestBody.components
          name: requestBody.name
          firstUpdate: requestBody.firstUpdate
          lastUpdate: requestBody.lastUpdate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/status-pages/{statusPageId}/automation-rules/{ruleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an automation rule
      effect: read
      questions:
      - What tags and components does a specific automation rule use?
      - Can I view one automation rule's settings?
      instructions:
      - text: Show automation rule {ruleId} on status page {statusPageId}.
        slots:
          ruleId: path.ruleId
          statusPageId: path.statusPageId
      - text: Get the settings of rule {ruleId} from page {statusPageId}.
        slots:
          ruleId: path.ruleId
          statusPageId: path.statusPageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/status-pages/{statusPageId}/automation-rules/{ruleId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an automation rule
      effect: write
      questions:
      - Can I change the tags or components of an existing automation rule?
      - Does updating a rule replace its whole component list?
      instructions:
      - text: 'Update rule {ruleId} on page {statusPageId}: name {name}, tags {tags}, updates {firstUpdate} and {lastUpdate}.'
        slots:
          ruleId: path.ruleId
          statusPageId: path.statusPageId
          name: requestBody.name
          tags: requestBody.tags
          firstUpdate: requestBody.firstUpdate
          lastUpdate: requestBody.lastUpdate
      - text: Disable automation rule {ruleId} on {statusPageId} by setting enabled {enabled}, keeping name {name}, tags {tags}, updates {firstUpdate}/{lastUpdate}.
        slots:
          ruleId: path.ruleId
          statusPageId: path.statusPageId
          enabled: requestBody.enabled
          name: requestBody.name
          tags: requestBody.tags
          firstUpdate: requestBody.firstUpdate
          lastUpdate: requestBody.lastUpdate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/status-pages/{statusPageId}/automation-rules/{ruleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an automation rule
      effect: destructive
      questions:
      - How do I stop a rule from opening incidents automatically?
      - Does deleting an automation rule also remove incidents it opened?
      instructions:
      - text: Delete automation rule {ruleId} from status page {statusPageId}.
        slots:
          ruleId: path.ruleId
          statusPageId: path.statusPageId
      - text: Remove rule {ruleId} on page {statusPageId}.
        slots:
          ruleId: path.ruleId
          statusPageId: path.statusPageId
      method: generated
      generated: '2026-09-26'