Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/confluent-the-data-streaming-platform-consumer-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 4

$.info

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

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

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

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 Consumer Shares (cdx/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-consumer-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: 3
- target: $.paths['/cdx/v1/consumer-shares'].get
  update:
    x-apievangelist-phrasing:
      intent: List stream shares I've received
      effect: read
      questions:
      - Which stream shares have been shared with me as a consumer?
      - Can I include deleted consumer shares in the list?
      instructions:
      - text: List my consumer shares.
      - text: Show consumer shares for shared resource {shared_resource}.
        slots:
          shared_resource: query.shared_resource
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cdx/v1/consumer-shares/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a consumer share
      effect: read
      questions:
      - What resource and provider details does one consumer share have?
      - Can I read a single stream share I received by ID?
      instructions:
      - text: Show consumer share {id}.
        slots:
          id: path.id
      - text: Read the details of stream share {id} shared with me.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cdx/v1/consumer-shares/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a consumer share
      effect: destructive
      questions:
      - How do I stop consuming a stream share someone gave me?
      - Can I remove a consumer share I no longer need?
      instructions:
      - text: Delete consumer share {id}.
        slots:
          id: path.id
      - text: Remove stream share {id} from my consumer shares.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'