Confluent · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/confluent-user-notifications-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/user-notifications'].get

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

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

$.paths['/notifications/v1/user-notifications:mark-all'].patch

$.paths['/notifications/v1/user-notifications:summary'].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 User Notifications (notifications/v1) API
  version: 1.0.0
extends: openapi/confluent-user-notifications-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/user-notifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List my notifications
      effect: read
      questions:
      - What unread critical notifications do I have?
      - Can I filter my notifications by severity, resource or time window?
      - Is there a way to search my notifications by text?
      instructions:
      - text: List my unread notifications.
      - text: List notifications with severity {severity} in the last {time_range}.
        slots:
          severity: query.severity
          time_range: query.time_range
      - text: Search my notifications for {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/v1/user-notifications/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a notification
      effect: read
      questions:
      - What recommended actions come with a particular notification?
      - Can I open one notification by its ID?
      instructions:
      - text: Show notification {id}.
        slots:
          id: path.id
      - text: Get the details and recommended actions of notification {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/v1/user-notifications/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Mark a notification read or unread
      effect: write
      questions:
      - How do I mark a single notification as read?
      - Can I flip one notification back to unread?
      instructions:
      - text: 'Mark notification {id} as read: {read}.'
        slots:
          id: path.id
          read: requestBody.read
      - text: Set notification {id} back to unread.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/v1/user-notifications:mark-all'].patch
  update:
    x-apievangelist-phrasing:
      intent: Mark many notifications read or unread
      effect: write
      questions:
      - Can I mark all my notifications as read at once?
      - Is it possible to bulk mark only critical notifications as read?
      instructions:
      - text: 'Mark all my notifications read: {read}.'
        slots:
          read: requestBody.read
      - text: Set read to {read} on every notification with severity {severity}.
        slots:
          read: requestBody.read
          severity: query.severity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/v1/user-notifications:summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a summary of my notifications
      effect: read
      questions:
      - How many notifications do I have overall?
      - Can I get a quick summary count of my notifications?
      instructions:
      - text: Give me a summary of my notifications.
      - text: Show my notification counts.
      method: generated
      generated: '2026-09-26'