# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Salesforce Streaming Streaming Channels API
  version: 1.0.0
extends: openapi/salesforce-streaming-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['/sobjects/StreamingChannel'].get
  update:
    x-apievangelist-phrasing:
      intent: List generic streaming channels
      effect: read
      questions:
      - What generic Streaming Channels exist in my org?
      - Which custom JSON event channels have been set up?
      instructions:
      - text: List all Streaming Channel records.
      - text: Show every generic streaming channel in the org.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sobjects/StreamingChannel'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a generic streaming channel
      effect: write
      questions:
      - How do I create a channel to publish custom JSON events to subscribers?
      - Can I give a new streaming channel a name and description?
      instructions:
      - text: Create streaming channel {name}.
        slots:
          name: requestBody.Name
      - text: Create a generic channel named {name} described as {description}.
        slots:
          name: requestBody.Name
          description: requestBody.Description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sobjects/StreamingChannel/{channelId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a streaming channel
      effect: read
      questions:
      - How do I look up one streaming channel by ID?
      - What name does a given generic streaming channel use?
      instructions:
      - text: Get streaming channel {channel_id}.
        slots:
          channel_id: path.channelId
      - text: Show details of generic channel {channel_id}.
        slots:
          channel_id: path.channelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sobjects/StreamingChannel/{channelId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a streaming channel
      effect: destructive
      questions:
      - What happens to active subscribers when I delete a streaming channel?
      - How do I remove a generic streaming channel?
      instructions:
      - text: Delete streaming channel {channel_id}.
        slots:
          channel_id: path.channelId
      - text: Remove generic channel {channel_id} and disconnect its subscribers.
        slots:
          channel_id: path.channelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sobjects/StreamingChannel/{channelId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a streaming channel
      effect: write
      questions:
      - Can I rename a streaming channel or change its description?
      - How do I edit an existing generic streaming channel?
      instructions:
      - text: Rename streaming channel {channel_id} to {name}.
        slots:
          channel_id: path.channelId
          name: requestBody.Name
      - text: Update the description of channel {channel_id} to {description}.
        slots:
          channel_id: path.channelId
          description: requestBody.Description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sobjects/StreamingChannel/{channelId}/push'].post
  update:
    x-apievangelist-phrasing:
      intent: Push a custom event to channel subscribers
      effect: write
      questions:
      - How do I broadcast a custom event to everyone subscribed to a streaming channel?
      - How large can a generic streaming event payload be?
      instructions:
      - text: Push events {events} to streaming channel {channel_id}.
        slots:
          events: requestBody.pushEvents
          channel_id: path.channelId
      - text: Broadcast {events} to subscribers of {channel_id}.
        slots:
          events: requestBody.pushEvents
          channel_id: path.channelId
      method: generated
      generated: '2026-09-26'