# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Soda Cloud API v4 Notification Rules API
  version: 1.0.0
extends: openapi/soda-data-notification-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: 4
- target: $.paths['/api/v1/notificationRules'].get
  update:
    x-apievangelist-phrasing:
      intent: List notification rules
      effect: read
      questions:
      - Which notification rules decide who gets alerted about failing checks?
      - What alert routing rules exist in my organization?
      instructions:
      - text: List all notification rules.
      - text: Show page {page} of notification rules.
        slots:
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/notificationRules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a notification rule
      effect: write
      questions:
      - How do I alert a user group when checks with a certain attribute fail?
      - Can a notification rule send to plain email addresses or integrations?
      instructions:
      - text: Create a {ruleType} notification rule {name} sending to {recipients}.
        slots:
          ruleType: requestBody.ruleType
          name: requestBody.name
          recipients: requestBody.recipients
      - text: Add notification rule {name} of type {ruleType} for {recipients} matching filter {filter}.
        slots:
          name: requestBody.name
          ruleType: requestBody.ruleType
          recipients: requestBody.recipients
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/notificationRules/{notificationRuleId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Replace a notification rule
      effect: write
      questions:
      - Can I change who an existing notification rule alerts?
      - Does editing a notification rule replace all its settings?
      instructions:
      - text: Update notification rule {notificationRuleId} to {name}, type {ruleType}, recipients {recipients}.
        slots:
          notificationRuleId: path.notificationRuleId
          name: requestBody.name
          ruleType: requestBody.ruleType
          recipients: requestBody.recipients
      - text: Set rule {notificationRuleId} ({name}, {ruleType}, to {recipients}) to status {status}.
        slots:
          notificationRuleId: path.notificationRuleId
          name: requestBody.name
          ruleType: requestBody.ruleType
          recipients: requestBody.recipients
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/notificationRules/{notificationRuleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a notification rule
      effect: destructive
      questions:
      - How do I stop an alert rule from sending notifications permanently?
      - Is a deleted notification rule removed right away?
      instructions:
      - text: Delete notification rule {notificationRuleId}.
        slots:
          notificationRuleId: path.notificationRuleId
      - text: Remove alert rule {notificationRuleId}.
        slots:
          notificationRuleId: path.notificationRuleId
      method: generated
      generated: '2026-09-26'