Confluent | the Data Streaming Platform · 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-the-data-streaming-platform-user-notifications-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/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-the-data-streaming-platform-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:
      - Which critical notifications did I get in the last 7 days?
      - Can I see only unread notifications about a specific resource?
      - Is there a way to search my notifications by text?
      instructions:
      - text: List my notifications with severity {severity}.
        slots:
          severity: query.severity
      - text: Show unread notifications from time range {time_range}.
        slots:
          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: Get a notification
      effect: read
      questions:
      - What are the details and recommended actions of one notification?
      - Can I open a single notification by id?
      instructions:
      - text: Show notification {id}.
        slots:
          id: path.id
      - text: Get the full details of user 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 one notification as read?
      - Can I flag a single notification as unread again?
      instructions:
      - text: Mark notification {id} as read {read}.
        slots:
          id: path.id
          read: requestBody.read
      - text: Set the read state of notification {id}.
        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 warning notifications from the past day?
      instructions:
      - text: Mark all my notifications read {read}.
        slots:
          read: requestBody.read
      - text: Mark every notification with severity {severity} as read {read}.
        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 notification summary
      effect: read
      questions:
      - How many notifications do I have waiting?
      - Can I get a 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'