Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/clusterconfig'].get
$.paths['/config/{subject}'].get
$.paths['/config/{subject}'].put
$.paths['/config/{subject}'].delete
$.paths['/config'].get
$.paths['/config'].put
$.paths['/config'].delete

OpenAPI Overlay

Raw ↑
# 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 Config (v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-config-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: 7
- target: $.paths['/clusterconfig'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Schema Registry cluster config
      effect: read
      questions:
      - Where can I see the Schema Registry cluster-level config information?
      - Can I read the cluster config of my Schema Registry?
      instructions:
      - text: Show the Schema Registry cluster config.
      - text: Get the cluster configuration information for Schema Registry.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/{subject}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subject's compatibility settings
      effect: read
      questions:
      - What compatibility level is set for a specific schema subject?
      - Can I see a subject's config and fall back to the global default if none is set?
      instructions:
      - text: Show the compatibility level for subject {subject}.
        slots:
          subject: path.subject
      - text: Get the config for subject {subject}, defaulting to global {defaultToGlobal}.
        slots:
          subject: path.subject
          defaultToGlobal: query.defaultToGlobal
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/{subject}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a subject's compatibility level
      effect: write
      questions:
      - How do I change the compatibility level for just one subject?
      - Can I turn on schema normalization for a single subject?
      instructions:
      - text: Set the compatibility of subject {subject} to {compatibility}.
        slots:
          subject: path.subject
          compatibility: requestBody.compatibility
      - text: Enable normalization {normalize} on subject {subject}.
        slots:
          subject: path.subject
          normalize: requestBody.normalize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/{subject}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revert a subject to the global compatibility
      effect: destructive
      questions:
      - How do I remove a subject-level compatibility override?
      - Can I make a subject go back to using the global compatibility default?
      instructions:
      - text: Delete the compatibility override on subject {subject}.
        slots:
          subject: path.subject
      - text: Revert subject {subject} to the global compatibility level.
        slots:
          subject: path.subject
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the global compatibility level
      effect: read
      questions:
      - What is the global compatibility level for my Schema Registry?
      - Which default rule set and metadata apply registry-wide?
      instructions:
      - text: Show the global compatibility level.
      - text: Get the registry-wide compatibility and rule set defaults.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the global compatibility level
      effect: write
      questions:
      - How do I change the default compatibility level for every subject?
      - Can I set a registry-wide default rule set?
      instructions:
      - text: Set the global compatibility level to {compatibility}.
        slots:
          compatibility: requestBody.compatibility
      - text: Apply default rule set {defaultRuleSet} across the whole registry.
        slots:
          defaultRuleSet: requestBody.defaultRuleSet
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset the global compatibility level
      effect: destructive
      questions:
      - Can I clear the global compatibility setting and go back to the default?
      - What happens if I delete the registry-wide compatibility config?
      instructions:
      - text: Delete the global compatibility config.
      - text: Reset the registry-wide compatibility level to the default.
      method: generated
      generated: '2026-09-26'