# 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 Alert channels API
  version: 1.0.0
extends: openapi/checkly-alert-channels-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: 6
- target: $.paths['/v1/alert-channels'].get
  update:
    x-apievangelist-phrasing:
      intent: List alert channels
      effect: read
      questions:
      - Which alert channels are set up in my Checkly account?
      - What checks are subscribed to each of my alert channels?
      instructions:
      - text: List all my alert channels.
      - text: Show page {page} of alert channels with their subscribed checks.
        slots:
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/alert-channels'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an alert channel
      effect: write
      questions:
      - How do I get notified by email or chat when a check fails?
      - Can a new alert channel warn me before SSL certificates expire?
      - Can new checks subscribe to an alert channel automatically?
      instructions:
      - text: Create a {type} alert channel with config {config}.
        slots:
          type: requestBody.type
          config: requestBody.config
      - text: Add a {type} alert channel using {config} that auto-subscribes new checks {autoSubscribe}.
        slots:
          type: requestBody.type
          config: requestBody.config
          autoSubscribe: requestBody.autoSubscribe
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/alert-channels/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an alert channel
      effect: read
      questions:
      - What config and subscriptions does a specific alert channel have?
      - Does a given alert channel send recovery and degraded notifications?
      instructions:
      - text: Show alert channel {id}.
        slots:
          id: path.id
      - text: Get the settings of alert channel {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/alert-channels/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an alert channel
      effect: write
      questions:
      - How do I change where an existing alert channel sends notifications?
      - Can I turn off recovery messages on an alert channel I already have?
      instructions:
      - text: Update alert channel {id} to type {type} with config {config}.
        slots:
          id: path.id
          type: requestBody.type
          config: requestBody.config
      - text: Change alert channel {id} ({type}, {config}) to send recovery alerts {sendRecovery}.
        slots:
          id: path.id
          type: requestBody.type
          config: requestBody.config
          sendRecovery: requestBody.sendRecovery
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/alert-channels/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an alert channel
      effect: destructive
      questions:
      - How do I remove an alert channel I no longer use?
      - Is deleting an alert channel permanent?
      instructions:
      - text: Delete alert channel {id}.
        slots:
          id: path.id
      - text: Permanently remove alert channel {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/alert-channels/{id}/subscriptions'].put
  update:
    x-apievangelist-phrasing:
      intent: Subscribe a check or group to an alert channel
      effect: write
      questions:
      - How do I make one check send its failure alerts to a particular channel?
      - Can I subscribe a whole check group to an alert channel?
      instructions:
      - text: Subscribe check {checkId} to alert channel {id} with activated {activated}.
        slots:
          checkId: requestBody.checkId
          id: path.id
          activated: requestBody.activated
      - text: Set check group {groupId} subscription on alert channel {id} to activated {activated}.
        slots:
          groupId: requestBody.groupId
          id: path.id
          activated: requestBody.activated
      method: generated
      generated: '2026-09-26'