# 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-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 have provided
      effect: read
      questions:
      - Which topics have I shared with other organizations through Stream Sharing?
      - Can I include deleted provider shares or filter by a shared resource?
      instructions:
      - text: List my provider shares.
      - text: List provider shares for shared resource {shared_resource}, include deleted {include_deleted}.
        slots:
          shared_resource: query.shared_resource
          include_deleted: query.include_deleted
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cdx/v1/provider-shares'].post
  update:
    x-apievangelist-phrasing:
      intent: Share a resource with a consumer
      effect: write
      questions:
      - How do I share a topic with a partner who is outside my organization?
      - Can I send a share invite by email and restrict who can redeem it?
      instructions:
      - text: Share resources {resources} via {delivery_method}.
        slots:
          resources: requestBody.resources
          delivery_method: requestBody.delivery_method
      - text: Create a provider share for {resources} restricted to {consumer_restriction}.
        slots:
          resources: requestBody.resources
          consumer_restriction: requestBody.consumer_restriction
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cdx/v1/provider-shares/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one provider share
      effect: read
      questions:
      - Has the consumer accepted a share I sent?
      - What resources and status does a specific provider share have?
      instructions:
      - text: Get provider share {id}.
        slots:
          id: path.id
      - text: Show the status of stream 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:
      - How do I stop sharing a topic with a consumer?
      - Does deleting a provider share cut off 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 share invitation
      effect: write
      questions:
      - Can I resend a share invite the recipient never received?
      - What do I do if the share invitation email expired or was lost?
      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'