# 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 Push Topics API
  version: 1.0.0
extends: openapi/salesforce-pushtopics-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: 5
- target: $.paths['/sobjects/PushTopic'].get
  update:
    x-apievangelist-phrasing:
      intent: List PushTopics
      effect: read
      questions:
      - Which PushTopics are defined in my org?
      - What SOQL queries are my existing PushTopics watching?
      instructions:
      - text: List all PushTopic records.
      - text: Show every PushTopic and its query.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sobjects/PushTopic'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a PushTopic
      effect: write
      questions:
      - How do I stream record changes that match a SOQL query?
      - Can I choose which operations, like create or delete, trigger PushTopic events?
      instructions:
      - text: Create PushTopic {name} with query {query}.
        slots:
          name: requestBody.Name
          query: requestBody.Query
      - text: Create PushTopic {name} for {query} that notifies on {notify_fields} fields.
        slots:
          name: requestBody.Name
          query: requestBody.Query
          notify_fields: requestBody.NotifyForFields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sobjects/PushTopic/{pushTopicId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a PushTopic
      effect: read
      questions:
      - How do I see one PushTopic's query and notification settings?
      - Is a given PushTopic active?
      instructions:
      - text: Get PushTopic {topic_id}.
        slots:
          topic_id: path.pushTopicId
      - text: Show the query and settings of PushTopic {topic_id}.
        slots:
          topic_id: path.pushTopicId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sobjects/PushTopic/{pushTopicId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a PushTopic
      effect: destructive
      questions:
      - How do I remove a PushTopic I no longer need?
      - Will deleting a PushTopic disconnect its subscribers?
      instructions:
      - text: Delete PushTopic {topic_id}.
        slots:
          topic_id: path.pushTopicId
      - text: Remove PushTopic {topic_id} and drop its subscribers.
        slots:
          topic_id: path.pushTopicId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sobjects/PushTopic/{pushTopicId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a PushTopic
      effect: write
      questions:
      - Can I change the SOQL query an existing PushTopic watches?
      - How do I deactivate a PushTopic without deleting it?
      instructions:
      - text: Change the query on PushTopic {topic_id} to {query}.
        slots:
          topic_id: path.pushTopicId
          query: requestBody.Query
      - text: Set PushTopic {topic_id} active flag to {is_active}.
        slots:
          topic_id: path.pushTopicId
          is_active: requestBody.IsActive
      method: generated
      generated: '2026-09-26'