Synadia Communications · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Synadia Control Plane / Synadia Cloud Pull Consumer API

4 actions 4 updates phrasing extends openapi/synadia-communications-pull-consumer-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Synadia Communications's API. It is a proposal applied on top of the contract, not a document Synadia Communications publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/core/beta/consumers/pull/{consumerId}'].get

$.paths['/core/beta/consumers/pull/{consumerId}'].delete

$.paths['/core/beta/consumers/pull/{consumerId}'].patch

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 Synadia Control Plane / Synadia Cloud Pull Consumer API
  version: 1.0.0
extends: openapi/synadia-communications-pull-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/pull/{consumerId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pull consumer's info
      effect: read
      questions:
      - How many messages are pending for my pull consumer?
      - Can I view a JetStream pull consumer's configuration and state?
      instructions:
      - text: Show pull consumer {consumerId}.
        slots:
          consumerId: path.consumerId
      - text: Get info for pull consumer {consumerId}.
        slots:
          consumerId: path.consumerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/consumers/pull/{consumerId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a pull consumer
      effect: destructive
      questions:
      - Can I delete a pull consumer I no longer need?
      - What's the way to remove a JetStream pull consumer?
      instructions:
      - text: Delete pull consumer {consumerId}.
        slots:
          consumerId: path.consumerId
      - text: Remove JetStream pull consumer {consumerId}.
        slots:
          consumerId: path.consumerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/consumers/pull/{consumerId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a pull consumer's settings
      effect: write
      questions:
      - Can I change a pull consumer's ack wait or max deliveries?
      - Is it possible to change the subjects a pull consumer filters on?
      instructions:
      - text: Set pull consumer {consumerId}'s ack wait to {ack_wait}.
        slots:
          consumerId: path.consumerId
          ack_wait: requestBody.ack_wait
      - text: Change pull consumer {consumerId} to filter subjects {filter_subjects}.
        slots:
          consumerId: path.consumerId
          filter_subjects: requestBody.filter_subjects
      - text: Limit pull consumer {consumerId} to {max_deliver} delivery attempts.
        slots:
          consumerId: path.consumerId
          max_deliver: requestBody.max_deliver
      method: generated
      generated: '2026-10-01'