# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Synadia Control Plane / Synadia Cloud Push Consumer API
  version: 1.0.0
extends: openapi/synadia-communications-push-consumer-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: 3
- target: $.paths['/core/beta/consumers/push/{consumerId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a push consumer's info
      effect: read
      questions:
      - How do I check a push consumer's delivery subject and pending messages?
      - What state does JetStream report for a push consumer?
      instructions:
      - text: Show push consumer {consumer}.
        slots:
          consumer: path.consumerId
      - text: Get info for push consumer {consumer}.
        slots:
          consumer: path.consumerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/consumers/push/{consumerId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a push consumer
      effect: destructive
      questions:
      - Can I delete a push consumer that is no longer delivering anywhere?
      - How do I remove a push consumer?
      instructions:
      - text: Delete push consumer {consumer}.
        slots:
          consumer: path.consumerId
      - text: Remove push consumer {consumer}.
        slots:
          consumer: path.consumerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/consumers/push/{consumerId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a push consumer
      effect: write
      questions:
      - How do I change where a push consumer delivers messages?
      - Can I throttle a push consumer with a rate limit?
      instructions:
      - text: Point push consumer {consumer} at deliver subject {subject}.
        slots:
          consumer: path.consumerId
          subject: requestBody.deliver_subject
      - text: Limit push consumer {consumer} to {bps} bits per second.
        slots:
          consumer: path.consumerId
          bps: requestBody.rate_limit_bps
      - text: Set push consumer {consumer}'s max deliveries to {max_deliver}.
        slots:
          consumer: path.consumerId
          max_deliver: requestBody.max_deliver
      method: generated
      generated: '2026-10-01'