Confluent · 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-consumer-shares-cdx-v1-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Confluent's API. It is a proposal applied on top of the contract, not a document Confluent 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

Raw ↑ 
# 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-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 shares I've received
      effect: read
      questions:
      - Which stream shares have I accepted as a consumer?
      - Can I list consumer shares for one shared resource, including deactivated ones?
      instructions:
      - text: List my consumer shares.
      - text: List 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 is the status of a share I received?
      - Can I read one consumer share by ID?
      instructions:
      - text: Get consumer share {id}.
        slots:
          id: path.id
      - text: Show details of the share {id} I received.
        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 I accepted?
      - Can I delete a consumer share?
      instructions:
      - text: Delete consumer share {id}.
        slots:
          id: path.id
      - text: Leave the stream share {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'