Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-resource-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/resource-subscriptions'].post

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

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

$.paths['/notifications/v1/resource-subscriptions/{id}'].patch

$.paths['/notifications/v1/resource-subscriptions:lookup'].get

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 Resource Subscriptions (notifications/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-resource-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/resource-subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to notifications for a resource
      effect: write
      questions:
      - How do I get notified about events on a specific cluster or resource?
      - Can I send resource notifications to an integration like email or a webhook?
      instructions:
      - text: Subscribe to {notification_type} notifications for resource {resource} via {integrations}.
        slots:
          notification_type: requestBody.notification_type
          resource: requestBody.resource
          integrations: requestBody.integrations
      - text: Create a resource subscription for {resource} of type {resource_type}.
        slots:
          resource: requestBody.resource
          resource_type: requestBody.resource_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/v1/resource-subscriptions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a resource subscription
      effect: read
      questions:
      - What notification type and integrations does one of my subscriptions use?
      - Can I read a resource subscription by its ID?
      instructions:
      - text: Get resource subscription {id}.
        slots:
          id: path.id
      - text: Show the integrations on resource subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/v1/resource-subscriptions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe from a resource's notifications
      effect: destructive
      questions:
      - How do I stop getting notifications for a resource?
      - Can I delete a resource subscription?
      instructions:
      - text: Delete resource subscription {id}.
        slots:
          id: path.id
      - text: Unsubscribe me by removing resource subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/v1/resource-subscriptions/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a resource subscription
      effect: write
      questions:
      - How do I change where notifications for a resource are delivered?
      - Can I switch the notification type on an existing subscription?
      instructions:
      - text: Change resource subscription {id} to deliver to {integrations}.
        slots:
          id: path.id
          integrations: requestBody.integrations
      - text: Set notification type {notification_type} on resource subscription {id}.
        slots:
          id: path.id
          notification_type: requestBody.notification_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/v1/resource-subscriptions:lookup'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up subscriptions for a resource
      effect: read
      questions:
      - Which notification subscriptions exist for a particular resource?
      - Who is subscribed to alerts on one of my clusters?
      instructions:
      - text: Look up subscriptions for resource {resource} of type {resource_type}.
        slots:
          resource: query.resource
          resource_type: query.resource_type
      - text: Find notification subscriptions on {resource_type} {resource}.
        slots:
          resource: query.resource
          resource_type: query.resource_type
      method: generated
      generated: '2026-09-26'