Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

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

$.info

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

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

$.paths['/cdx/v1/consumer-shared-resources/{id}/images/{file_name}'].get

$.paths['/cdx/v1/consumer-shared-resources/{id}:network'].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 Consumer Shared Resources (cdx/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-consumer-shared-resources-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: 4
- target: $.paths['/cdx/v1/consumer-shared-resources'].get
  update:
    x-apievangelist-phrasing:
      intent: List resources shared with me
      effect: read
      questions:
      - Which topics have other organizations shared with me through Stream Sharing?
      - Can I list shared resources from a specific stream share?
      instructions:
      - text: List consumer shared resources available to me.
      - text: List resources shared with me in stream share {stream_share}.
        slots:
          stream_share: query.stream_share
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cdx/v1/consumer-shared-resources/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a resource shared with me
      effect: read
      questions:
      - What details did the provider publish about a resource shared with me?
      - Can I read one consumer shared resource by ID?
      instructions:
      - text: Get consumer shared resource {id}.
        slots:
          id: path.id
      - text: Show the details of resource {id} shared with me.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cdx/v1/consumer-shared-resources/{id}/images/{file_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the image on a resource shared with me
      effect: read
      questions:
      - Can I download the provider's logo for a resource shared with me?
      - Which image file comes with a consumer shared resource?
      instructions:
      - text: Get image {file_name} for consumer shared resource {id}.
        slots:
          id: path.id
          file_name: path.file_name
      - text: Download the {file_name} logo from resource {id} shared with me.
        slots:
          id: path.id
          file_name: path.file_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cdx/v1/consumer-shared-resources/{id}:network'].get
  update:
    x-apievangelist-phrasing:
      intent: Get network config for a shared resource
      effect: read
      questions:
      - What network settings do I need to reach a resource shared with me?
      - Can I get the private networking details of a shared topic?
      instructions:
      - text: Get network configuration for consumer shared resource {id}.
        slots:
          id: path.id
      - text: Show how to connect over the network to shared resource {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'