Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Opt Ins (cdx/v1) API

3 actions 3 updates phrasing extends openapi/confluent-the-data-streaming-platform-opt-ins-cdx-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['/cdx/v1/opt-in'].get

$.paths['/cdx/v1/opt-in'].patch

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 Opt Ins (cdx/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-opt-ins-cdx-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['/cdx/v1/opt-in'].get
  update:
    x-apievangelist-phrasing:
      intent: Check stream sharing opt-in
      effect: read
      questions:
      - Is stream sharing enabled for my organization?
      - Can I see my org's stream sharing opt-in setting?
      instructions:
      - text: Show my organization's stream sharing opt-in settings.
      - text: Check whether stream sharing is turned on.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cdx/v1/opt-in'].patch
  update:
    x-apievangelist-phrasing:
      intent: Turn stream sharing on or off
      effect: write
      questions:
      - How do I enable stream sharing for my organization?
      - Can I opt my org out of stream sharing?
      instructions:
      - text: Set stream sharing enabled to {stream_share_enabled}.
        slots:
          stream_share_enabled: requestBody.stream_share_enabled
      - text: Opt my organization in to stream sharing.
      method: generated
      generated: '2026-09-26'