Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Notification Types (notifications/v1) API

3 actions 3 updates phrasing extends openapi/confluent-the-data-streaming-platform-notification-types-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 3

$.info

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

$.paths['/notifications/v1/notification-types'].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 Notification Types (notifications/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-notification-types-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: 2
- target: $.paths['/notifications/v1/notification-types/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a notification type
      effect: read
      questions:
      - What does a specific notification type cover?
      - Can I read one notification type's description by id?
      instructions:
      - text: Show notification type {id}.
        slots:
          id: path.id
      - text: Describe notification type {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/v1/notification-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List notification types
      effect: read
      questions:
      - Which notification types can I subscribe to?
      - Can I list only the notification types for a given resource type?
      instructions:
      - text: List all notification types.
      - text: List notification types for resource type {resource_type}.
        slots:
          resource_type: query.resource_type
      method: generated
      generated: '2026-09-26'