Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Modes (v1) API

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

$.info

$.paths['/mode/{subject}'].get

$.paths['/mode/{subject}'].put

$.paths['/mode/{subject}'].delete

$.paths['/mode'].get

$.paths['/mode'].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 Modes (v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-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 subject in READWRITE, READONLY 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 the mode for {subject}, defaulting to global.
        slots:
          subject: path.subject
      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 if it has schemas?
      instructions:
      - text: Set subject {subject} to mode {mode}.
        slots:
          subject: path.subject
          mode: requestBody.mode
      - text: Force {subject} into {mode} mode.
        slots:
          subject: path.subject
          mode: requestBody.mode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mode/{subject}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a subject's mode override
      effect: destructive
      questions:
      - Can I clear a subject-level mode so it goes back to the global default?
      - What mode does a subject use after its override is deleted?
      instructions:
      - text: Delete the mode override on subject {subject}.
        slots:
          subject: path.subject
      - text: Revert {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 is the registry-wide mode right now?
      - Is my whole schema registry read-only?
      instructions:
      - text: Get the global schema registry mode.
      - text: Show the registry's top-level 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:
      - Can I put the entire registry into read-only mode for maintenance?
      - What happens if I force the global mode to IMPORT?
      instructions:
      - text: Set the global registry mode to {mode}.
        slots:
          mode: requestBody.mode
      - text: Force the whole registry into {mode} mode.
        slots:
          mode: requestBody.mode
      method: generated
      generated: '2026-09-26'