Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/cdx/v1/provider-shared-resources'].get
$.paths['/cdx/v1/provider-shared-resources/{id}'].get
$.paths['/cdx/v1/provider-shared-resources/{id}'].patch
$.paths['/cdx/v1/provider-shared-resources/{id}/images/{file_name}'].get
$.paths['/cdx/v1/provider-shared-resources/{id}/images/{file_name}'].post
$.paths['/cdx/v1/provider-shared-resources/{id}/images/{file_name}'].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 Provider Shared Resources (cdx/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-provider-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: 6
- target: $.paths['/cdx/v1/provider-shared-resources'].get
  update:
    x-apievangelist-phrasing:
      intent: List resources I'm sharing as a provider
      effect: read
      questions:
      - Which resources have I shared with other organizations through Stream Sharing?
      - Can I include deleted shared resources when listing what I provide?
      instructions:
      - text: List my provider shared resources.
      - text: List provider shared resources for stream share {stream_share}.
        slots:
          stream_share: query.stream_share
      - text: List provider shared resources including deleted ones.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cdx/v1/provider-shared-resources/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a resource I'm sharing
      effect: read
      questions:
      - What details are on a resource I share with consumers?
      - Can I read one provider shared resource by ID?
      instructions:
      - text: Get provider shared resource {id}.
        slots:
          id: path.id
      - text: Show the details of the resource {id} I'm sharing.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cdx/v1/provider-shared-resources/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a resource I'm sharing
      effect: write
      questions:
      - How do I change the display name or description on a resource I share?
      - Can I update the organization contact shown on my shared resource?
      instructions:
      - text: Update provider shared resource {id} with display name {display_name}.
        slots:
          id: path.id
          display_name: requestBody.display_name
      - text: Set the description of shared resource {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cdx/v1/provider-shared-resources/{id}/images/{file_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the image on a resource I share
      effect: read
      questions:
      - Can I download the logo image attached to a resource I'm sharing?
      - Which image file is shown on my provider shared resource?
      instructions:
      - text: Get image {file_name} for provider shared resource {id}.
        slots:
          id: path.id
          file_name: path.file_name
      - text: Download the {file_name} image from my shared resource {id}.
        slots:
          id: path.id
          file_name: path.file_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cdx/v1/provider-shared-resources/{id}/images/{file_name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload an image for a resource I share
      effect: write
      questions:
      - How do I add a logo image to a resource I'm sharing?
      - Can I replace the image on my provider shared resource?
      instructions:
      - text: Upload image {file_name} to provider shared resource {id}.
        slots:
          id: path.id
          file_name: path.file_name
      - text: Attach the {file_name} logo to my shared resource {id}.
        slots:
          id: path.id
          file_name: path.file_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cdx/v1/provider-shared-resources/{id}/images/{file_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete the image on a resource I share
      effect: destructive
      questions:
      - How do I remove the image from a resource I share?
      - Can I delete a logo file from my provider shared resource?
      instructions:
      - text: Delete image {file_name} from provider shared resource {id}.
        slots:
          id: path.id
          file_name: path.file_name
      - text: Remove the {file_name} image on my shared resource {id}.
        slots:
          id: path.id
          file_name: path.file_name
      method: generated
      generated: '2026-09-26'