Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

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

$.info

$.paths['/cdx/v1/shared-tokens:resources'].post

$.paths['/cdx/v1/shared-tokens:redeem'].post

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 Shared Tokens (cdx/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-shared-tokens-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: 2
- target: $.paths['/cdx/v1/shared-tokens:resources'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview resources in a shared token
      effect: read
      questions:
      - What topics were shared with me in a Stream Sharing token?
      - Can I check a shared token is valid before redeeming it?
      instructions:
      - text: Validate shared token {token} and show its resources.
        slots:
          token: requestBody.token
      - text: Preview which resources token {token} gives access to.
        slots:
          token: requestBody.token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cdx/v1/shared-tokens:redeem'].post
  update:
    x-apievangelist-phrasing:
      intent: Redeem a shared token
      effect: write
      questions:
      - How do I redeem a Stream Sharing token to get topic access?
      - Can I redeem a shared token for my AWS account to get private connectivity details?
      instructions:
      - text: Redeem shared token {token}.
        slots:
          token: requestBody.token
      - text: Redeem token {token} for AWS account {aws_account}.
        slots:
          token: requestBody.token
          aws_account: requestBody.aws_account
      method: generated
      generated: '2026-09-26'