Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Provider Shares (cdx/v1) API

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-provider-shares-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 6

$.info

$.paths['/cdx/v1/provider-shares'].get

$.paths['/cdx/v1/provider-shares'].post

$.paths['/cdx/v1/provider-shares/{id}'].get

$.paths['/cdx/v1/provider-shares/{id}'].delete

$.paths['/cdx/v1/provider-shares/{id}:resend'].post

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 Provider Shares (cdx/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-provider-shares-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: 5
- target: $.paths['/cdx/v1/provider-shares'].get
  update:
    x-apievangelist-phrasing:
      intent: List stream shares I've provided
      effect: read
      questions:
      - Which topics have I shared with other organizations through Stream Sharing?
      - Can I include deleted provider shares when listing?
      instructions:
      - text: List my provider shares.
      - text: List provider shares for shared resource {resource}.
        slots:
          resource: query.shared_resource
      - text: Show all provider shares including deleted ones.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cdx/v1/provider-shares'].post
  update:
    x-apievangelist-phrasing:
      intent: Share a stream with a consumer
      effect: write
      questions:
      - How do I share a Kafka topic with someone outside my organization?
      - Can I restrict who is allowed to redeem a share?
      instructions:
      - text: Create a provider share of {resources} via {delivery_method}.
        slots:
          resources: requestBody.resources
          delivery_method: requestBody.delivery_method
      - text: Share {resources} restricted to consumer {restriction}.
        slots:
          resources: requestBody.resources
          restriction: requestBody.consumer_restriction
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cdx/v1/provider-shares/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a provider share
      effect: read
      questions:
      - Has the consumer accepted a share I sent?
      - Can I look up a provider share by ID?
      instructions:
      - text: Get provider share {id}.
        slots:
          id: path.id
      - text: Show the status of share {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cdx/v1/provider-shares/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a provider share
      effect: destructive
      questions:
      - Can I stop sharing a topic with a consumer?
      - Does deleting a provider share revoke the consumer's access?
      instructions:
      - text: Delete provider share {id}.
        slots:
          id: path.id
      - text: Revoke stream share {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cdx/v1/provider-shares/{id}:resend'].post
  update:
    x-apievangelist-phrasing:
      intent: Resend a provider share invitation
      effect: write
      questions:
      - Can I resend a share invite the recipient never got?
      - What if the consumer lost the share email?
      instructions:
      - text: Resend provider share {id}.
        slots:
          id: path.id
      - text: Send the invitation for share {id} again.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'