Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-resource-preferences-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-preferences'].post
$.paths['/notifications/v1/resource-preferences/{id}'].get
$.paths['/notifications/v1/resource-preferences/{id}'].delete
$.paths['/notifications/v1/resource-preferences/{id}'].patch
$.paths['/notifications/v1/resource-preferences:lookup'].get

OpenAPI Overlay

Raw ↑
# 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 Preferences (notifications/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-resource-preferences-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-preferences'].post
  update:
    x-apievangelist-phrasing:
      intent: Set notification preference for a resource
      effect: write
      questions:
      - How do I turn notifications on or off for one specific resource?
      - Can I mute notifications for a single Kafka cluster?
      instructions:
      - text: Set notification state {current_state} for resource {resource} of type {resource_type}.
        slots:
          current_state: requestBody.current_state
          resource: requestBody.resource
          resource_type: requestBody.resource_type
      - text: Mute notifications for resource {resource}.
        slots:
          resource: requestBody.resource
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/v1/resource-preferences/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a resource notification preference
      effect: read
      questions:
      - What notification setting applies to a resource preference I created?
      - Can I read a resource preference by its id?
      instructions:
      - text: Show resource preference {id}.
        slots:
          id: path.id
      - text: Get the notification state of resource preference {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/v1/resource-preferences/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a resource notification preference
      effect: destructive
      questions:
      - How do I remove a per-resource notification override?
      - Can I delete a resource preference so defaults apply again?
      instructions:
      - text: Delete resource preference {id}.
        slots:
          id: path.id
      - text: Remove the notification override with preference id {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/v1/resource-preferences/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a resource notification preference
      effect: write
      questions:
      - Can I flip an existing resource preference from muted to enabled?
      - Is it possible to change a resource preference's state?
      instructions:
      - text: Set resource preference {id} to state {current_state}.
        slots:
          id: path.id
          current_state: requestBody.current_state
      - text: Re-enable notifications on resource preference {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/v1/resource-preferences:lookup'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a resource's notification preference
      effect: read
      questions:
      - What notification preference is set for a given resource and resource type?
      - Can I find a preference by the resource itself instead of its id?
      instructions:
      - text: Look up the notification preference for resource {resource} of type {resource_type}.
        slots:
          resource: query.resource
          resource_type: query.resource_type
      - text: Find the preference for {resource_type} resource {resource}.
        slots:
          resource: query.resource
          resource_type: query.resource_type
      method: generated
      generated: '2026-09-26'