# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Nylas Pub/Sub Notifications API
  version: 1.0.0
extends: openapi/nylas-pub-sub-notifications-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['/v3/webhooks/mock-payload'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview a sample notification payload
      effect: read
      questions:
      - What does a notification body look like for a specific trigger type?
      - Can I get an example payload to test my Pub/Sub consumer?
      instructions:
      - text: Show an example notification payload for {trigger_type}.
        slots:
          trigger_type: requestBody.trigger_type
      - text: Generate a mock payload for trigger {trigger_type}.
        slots:
          trigger_type: requestBody.trigger_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/channels/pubsub'].get
  update:
    x-apievangelist-phrasing:
      intent: List Pub/Sub notification channels
      effect: read
      questions:
      - Which Google Pub/Sub channels is my application sending notifications to?
      - Can I see all my Pub/Sub channels at once?
      instructions:
      - text: List all Pub/Sub channels for my application.
      - text: Show every Pub/Sub notification channel in my app.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/channels/pubsub'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Pub/Sub notification channel
      effect: write
      questions:
      - How do I send Nylas notifications to a Google Pub/Sub topic?
      - Can I be emailed if delivery to my Pub/Sub channel fails?
      instructions:
      - text: Create a Pub/Sub channel to topic {topic} for triggers {trigger_types}.
        slots:
          topic: requestBody.topic
          trigger_types: requestBody.trigger_types
      - text: Set up Pub/Sub delivery of {trigger_types} to {topic} with compressed payloads.
        slots:
          trigger_types: requestBody.trigger_types
          topic: requestBody.topic
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/channels/pubsub/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Pub/Sub channel
      effect: read
      questions:
      - What topic and triggers are set on a particular Pub/Sub channel?
      - Can I check a single Pub/Sub channel's status?
      instructions:
      - text: Show Pub/Sub channel {id}.
        slots:
          id: path.id
      - text: Get the configuration of Pub/Sub channel {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/channels/pubsub/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Pub/Sub channel
      effect: write
      questions:
      - How do I restart a Pub/Sub channel I paused?
      - Can I change the topic an existing Pub/Sub channel publishes to?
      instructions:
      - text: Point Pub/Sub channel {id} at topic {topic}.
        slots:
          id: path.id
          topic: requestBody.topic
      - text: Set the status of Pub/Sub channel {id} to {status}.
        slots:
          id: path.id
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/channels/pubsub/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Pub/Sub channel
      effect: destructive
      questions:
      - How do I stop sending notifications to a Pub/Sub topic?
      - Can I remove a Pub/Sub channel I no longer use?
      instructions:
      - text: Delete Pub/Sub channel {id}.
        slots:
          id: path.id
      - text: Remove Pub/Sub channel {id} from my application.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'