Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Subscriptions (notifications/v1) API

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-subscriptions-notifications-v1-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Confluent | the Data Streaming Platform's API. It is a proposal applied on top of the contract, not a document Confluent | the Data Streaming Platform publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/notifications/v1/subscriptions'].get

$.paths['/notifications/v1/subscriptions'].post

$.paths['/notifications/v1/subscriptions/{id}'].get

$.paths['/notifications/v1/subscriptions/{id}'].delete

$.paths['/notifications/v1/subscriptions/{id}'].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 Confluent Cloud Subscriptions (notifications/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-subscriptions-notifications-v1-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['/notifications/v1/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List notification subscriptions
      effect: read
      questions:
      - Which notification types am I subscribed to?
      - Can I see all notification subscriptions in my org?
      instructions:
      - text: List my notification subscriptions.
      - text: Show every notification subscription and its integrations.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/v1/subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to a notification type
      effect: write
      questions:
      - How do I start receiving alerts for a particular notification type?
      - Can I route a notification type to specific integrations?
      instructions:
      - text: Subscribe to notification type {notification_type} via integrations {integrations}.
        slots:
          notification_type: requestBody.notification_type
          integrations: requestBody.integrations
      - text: Create a subscription for {notification_type}.
        slots:
          notification_type: requestBody.notification_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/v1/subscriptions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a notification subscription
      effect: read
      questions:
      - Which integrations does a given subscription deliver to?
      - Can I read one notification subscription by id?
      instructions:
      - text: Show subscription {id}.
        slots:
          id: path.id
      - text: Get the integrations on notification subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/v1/subscriptions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe from a notification type
      effect: destructive
      questions:
      - How do I stop receiving a type of notification?
      - Can I delete a notification subscription?
      instructions:
      - text: Delete subscription {id}.
        slots:
          id: path.id
      - text: Unsubscribe by removing notification subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/v1/subscriptions/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a notification subscription
      effect: write
      questions:
      - Can I change which integrations an existing subscription uses?
      - Is it possible to disable a subscription without deleting it?
      instructions:
      - text: Update subscription {id} to deliver to {integrations}.
        slots:
          id: path.id
          integrations: requestBody.integrations
      - text: Set subscription {id} to state {current_state}.
        slots:
          id: path.id
          current_state: requestBody.current_state
      method: generated
      generated: '2026-09-26'