Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Confluent Cloud Exporters (v1) API
12 actions
12 updates
phrasing
extends
openapi/confluent-the-data-streaming-platform-exporters-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.
What the actions change
x-apievangelist-phrasing
Targets 12
$.info
$.paths['/exporters'].get
$.paths['/exporters'].post
$.paths['/exporters/{name}'].get
$.paths['/exporters/{name}'].put
$.paths['/exporters/{name}'].delete
$.paths['/exporters/{name}/status'].get
$.paths['/exporters/{name}/config'].get
$.paths['/exporters/{name}/config'].put
$.paths['/exporters/{name}/pause'].put
$.paths['/exporters/{name}/reset'].put
$.paths['/exporters/{name}/resume'].put
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 Exporters (v1) API
version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-exporters-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: 11
- target: $.paths['/exporters'].get
update:
x-apievangelist-phrasing:
intent: List schema exporters
effect: read
questions:
- Which schema exporters have been set up in my Schema Registry?
- Can I see every schema exporter that has been created so far?
instructions:
- text: List all my schema exporters.
- text: Show me the names of every schema exporter in Schema Registry.
method: generated
generated: '2026-09-26'
- target: $.paths['/exporters'].post
update:
x-apievangelist-phrasing:
intent: Create a schema exporter
effect: write
questions:
- How do I start exporting schemas from one Schema Registry to another?
- Can a new schema exporter copy only certain subjects and rename them on the destination?
instructions:
- text: Create a schema exporter named {name} that exports subjects {subjects}.
slots:
name: requestBody.name
subjects: requestBody.subjects
- text: Set up a new schema exporter {name} with destination config {config}.
slots:
name: requestBody.name
config: requestBody.config
method: generated
generated: '2026-09-26'
- target: $.paths['/exporters/{name}'].get
update:
x-apievangelist-phrasing:
intent: Get a schema exporter's details
effect: read
questions:
- What subjects and context does a given schema exporter export?
- Where can I see the rename formats a schema exporter was created with?
instructions:
- text: Show the details of schema exporter {name}.
slots:
name: path.name
- text: Get the subjects and context type configured on exporter {name}.
slots:
name: path.name
method: generated
generated: '2026-09-26'
- target: $.paths['/exporters/{name}'].put
update:
x-apievangelist-phrasing:
intent: Update a schema exporter's settings
effect: write
questions:
- Can I change which subjects an existing schema exporter sends?
- Is it possible to change the subject rename format on an exporter I already created?
instructions:
- text: Change schema exporter {name} to export subjects {subjects}.
slots:
name: path.name
subjects: requestBody.subjects
- text: Update exporter {name} so subjects are renamed with {subjectRenameFormat}.
slots:
name: path.name
subjectRenameFormat: requestBody.subjectRenameFormat
method: generated
generated: '2026-09-26'
- target: $.paths['/exporters/{name}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a schema exporter
effect: destructive
questions:
- How do I remove a schema exporter I no longer need?
- What happens when I delete a schema exporter by name?
instructions:
- text: Delete schema exporter {name}.
slots:
name: path.name
- text: Remove the {name} exporter from Schema Registry.
slots:
name: path.name
method: generated
generated: '2026-09-26'
- target: $.paths['/exporters/{name}/status'].get
update:
x-apievangelist-phrasing:
intent: Check a schema exporter's status
effect: read
questions:
- Is my schema exporter running, paused or in an error state?
- Where do I see how far a schema exporter has got and any error it hit?
instructions:
- text: Check the status of schema exporter {name}.
slots:
name: path.name
- text: Tell me whether exporter {name} is currently running.
slots:
name: path.name
method: generated
generated: '2026-09-26'
- target: $.paths['/exporters/{name}/config'].get
update:
x-apievangelist-phrasing:
intent: Get a schema exporter's destination config
effect: read
questions:
- Which destination Schema Registry URL is my exporter pointing at?
- Can I view just the connection config of a schema exporter?
instructions:
- text: Show the destination config of schema exporter {name}.
slots:
name: path.name
- text: Get the target registry URL configured for exporter {name}.
slots:
name: path.name
method: generated
generated: '2026-09-26'
- target: $.paths['/exporters/{name}/config'].put
update:
x-apievangelist-phrasing:
intent: Change a schema exporter's destination config
effect: write
questions:
- Can I point an existing schema exporter at a different destination registry URL?
- How do I rotate the basic auth credentials a schema exporter uses for its destination?
instructions:
- text: Point exporter {name} at destination registry {url}.
slots:
name: path.name
url: requestBody.schema.registry.url
- text: Update the destination basic auth user info for exporter {name} to {userinfo}.
slots:
name: path.name
userinfo: requestBody.basic.auth.user.info
method: generated
generated: '2026-09-26'
- target: $.paths['/exporters/{name}/pause'].put
update:
x-apievangelist-phrasing:
intent: Pause a schema exporter
effect: write
questions:
- Can I temporarily stop a schema exporter without deleting it?
- What's the way to halt schema exporting for a while?
instructions:
- text: Pause schema exporter {name}.
slots:
name: path.name
- text: Temporarily stop exporter {name} from exporting schemas.
slots:
name: path.name
method: generated
generated: '2026-09-26'
- target: $.paths['/exporters/{name}/reset'].put
update:
x-apievangelist-phrasing:
intent: Reset a schema exporter's state
effect: write
questions:
- Can I reset a schema exporter so it starts over from the beginning?
- Is there a way to clear the state of a stuck schema exporter?
instructions:
- text: Reset the state of schema exporter {name}.
slots:
name: path.name
- text: Reset exporter {name} so it starts exporting from scratch.
slots:
name: path.name
method: generated
generated: '2026-09-26'
- target: $.paths['/exporters/{name}/resume'].put
update:
x-apievangelist-phrasing:
intent: Resume a paused schema exporter
effect: write
questions:
- How do I restart a schema exporter I paused earlier?
- Can a paused exporter pick back up where it left off?
instructions:
- text: Resume schema exporter {name}.
slots:
name: path.name
- text: Start the paused exporter {name} running again.
slots:
name: path.name
method: generated
generated: '2026-09-26'