Confluent · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/confluent-resource-subscriptions-notifications-v1-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Confluent's API. It is a proposal applied on top of the contract, not a document Confluent 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)…
  version: 1.0.0
extends: openapi/confluent-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 a resource to notifications
      effect: write
      questions:
      - How do I get notified about events on one specific cluster or resource?
      - Can I route a resource's notifications to particular integrations?
      instructions:
      - text: Subscribe resource {resource} to notification type {notification_type}.
        slots:
          resource: requestBody.resource
          notification_type: requestBody.notification_type
      - text: Send {notification_type} alerts for resource {resource} to integrations {integrations}.
        slots:
          notification_type: requestBody.notification_type
          resource: requestBody.resource
          integrations: requestBody.integrations
      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 a resource subscription use?
      - Can I read one resource subscription by its ID?
      instructions:
      - text: Get resource subscription {id}.
        slots:
          id: path.id
      - text: Show the details of notification 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: Delete a resource subscription
      effect: destructive
      questions:
      - How do I stop notifications for a resource I subscribed to?
      - Can I delete a single resource subscription?
      instructions:
      - text: Delete resource subscription {id}.
        slots:
          id: path.id
      - text: Unsubscribe 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:
      - Can I disable a resource subscription without deleting it?
      - Which call changes the integrations a resource subscription notifies?
      instructions:
      - text: Set resource subscription {id} state to {current_state}.
        slots:
          id: path.id
          current_state: requestBody.current_state
      - text: Change the integrations on resource subscription {id} to {integrations}.
        slots:
          id: path.id
          integrations: requestBody.integrations
      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 given cluster or resource?
      - Can I find resource subscriptions by resource and resource type?
      instructions:
      - text: Look up resource subscriptions for {resource} of type {resource_type}.
        slots:
          resource: query.resource
          resource_type: query.resource_type
      - text: Find notification subscriptions on {resource_type} resource {resource}.
        slots:
          resource: query.resource
          resource_type: query.resource_type
      method: generated
      generated: '2026-09-26'