Generated by API Evangelist
Written by API Evangelist tooling for Confluent's API. It is a proposal applied on top of the contract, not a document Confluent publishes.
# 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 Modes (v1) API
version: 1.0.0
extends: openapi/confluent-modes-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['/mode/{subject}'].get
update:
x-apievangelist-phrasing:
intent: Get a subject's Schema Registry mode
effect: read
questions:
- Is a particular subject in READONLY, READWRITE or IMPORT mode?
- Can I fall back to the global mode when a subject has none set?
instructions:
- text: Get the mode of subject {subject}.
slots:
subject: path.subject
- text: Show subject {subject}'s mode, defaulting to global {defaultToGlobal}.
slots:
subject: path.subject
defaultToGlobal: query.defaultToGlobal
method: generated
generated: '2026-09-26'
- target: $.paths['/mode/{subject}'].put
update:
x-apievangelist-phrasing:
intent: Set a subject's Schema Registry mode
effect: write
questions:
- How do I make one subject read-only?
- Can I force a subject into IMPORT mode even though schemas already exist?
instructions:
- text: Set subject {subject} to mode {mode}.
slots:
subject: path.subject
mode: requestBody.mode
- text: Force subject {subject} into mode {mode} with force={force}.
slots:
subject: path.subject
mode: requestBody.mode
force: query.force
method: generated
generated: '2026-09-26'
- target: $.paths['/mode/{subject}'].delete
update:
x-apievangelist-phrasing:
intent: Reset a subject's mode to the global default
effect: destructive
questions:
- How do I clear a subject-level mode so it inherits the global mode again?
- Can I undo a per-subject mode override?
instructions:
- text: Delete the mode override on subject {subject}.
slots:
subject: path.subject
- text: Revert subject {subject} to the global mode.
slots:
subject: path.subject
method: generated
generated: '2026-09-26'
- target: $.paths['/mode'].get
update:
x-apievangelist-phrasing:
intent: Get the global Schema Registry mode
effect: read
questions:
- What mode is my Schema Registry running in globally?
- Is the whole registry currently read-only?
instructions:
- text: Get the global Schema Registry mode.
- text: Show the registry-wide mode.
method: generated
generated: '2026-09-26'
- target: $.paths['/mode'].put
update:
x-apievangelist-phrasing:
intent: Set the global Schema Registry mode
effect: write
questions:
- How do I put the whole Schema Registry into read-only mode?
- Can I switch the global mode to IMPORT for a migration?
instructions:
- text: Set the global registry mode to {mode}.
slots:
mode: requestBody.mode
- text: Force the registry-wide mode to {mode} with force={force}.
slots:
mode: requestBody.mode
force: query.force
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.