API Evangelist conversational phrasing for Chef Automate API Documentation Notifications API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Chef Automate API Documentation Notifications API
  version: 1.0.0
extends: openapi/progress-software-notifications-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/api/v0/notifications/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List notification rules
      effect: read
      questions:
      - What notification rules are set up in Chef Automate?
      - Which alerts are configured to fire?
      instructions:
      - text: List all notification rules.
      - text: Show me every configured alert rule.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/notifications/rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a notification rule
      effect: write
      questions:
      - How do I set up a notification for failed runs or compliance failures?
      - Can I add a new alert rule that posts to a webhook?
      instructions:
      - text: Create notification rule {rule}.
        slots:
          rule: requestBody.rule
      - text: Add a new alert rule defined as {rule}.
        slots:
          rule: requestBody.rule
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/notifications/rules/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a notification rule
      effect: read
      questions:
      - What does a specific notification rule do?
      - Can I see one alert rule's target and event?
      instructions:
      - text: Show notification rule {id}.
        slots:
          id: path.id
      - text: Get details of alert rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/notifications/rules/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a notification rule
      effect: write
      questions:
      - How do I change an existing notification rule?
      - Can I edit the destination of an alert rule I already created?
      instructions:
      - text: Update notification rule {id} to {rule}.
        slots:
          id: path.id
          rule: requestBody.rule
      - text: Change existing alert rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/notifications/rules/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a notification rule
      effect: destructive
      questions:
      - How do I stop an alert from firing permanently?
      - Can I remove a notification rule?
      instructions:
      - text: Delete notification rule {id}.
        slots:
          id: path.id
      - text: Remove alert rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/notifications/version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the notifications service version
      effect: read
      questions:
      - What version of the notifications service is running?
      - Is the notifications service up and reporting its version?
      instructions:
      - text: Get the notifications service version.
      - text: Check which notifications service build is deployed.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/notifications/webhook'].post
  update:
    x-apievangelist-phrasing:
      intent: Test a notification webhook
      effect: read
      questions:
      - Can I check that a webhook URL works before using it in a rule?
      - How do I validate a webhook that needs basic auth or a stored secret?
      instructions:
      - text: Validate webhook {url}.
        slots:
          url: requestBody.url
      - text: Test webhook {url} using secret {secret_id}.
        slots:
          url: requestBody.url
          secret_id: requestBody.secret_id
      method: generated
      generated: '2026-10-01'