Confluent · OpenAPI Overlay 1.0.0

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

8 actions 8 updates phrasing extends openapi/confluent-config-v1-api-openapi.yml
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.
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-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:
      - What cluster-wide configuration is my Schema Registry running with?
      - Can I read the cluster config information of Schema Registry?
      instructions:
      - text: Show the Schema Registry cluster config.
      - text: Get the cluster configuration information for my 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 on a particular subject?
      - Can I fall back to the global compatibility level when a subject has none set?
      instructions:
      - text: Get the compatibility level for subject {subject}.
        slots:
          subject: path.subject
      - text: 'Show subject {subject}''s compatibility, 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 of just one subject?
      - Can I turn on schema normalization for a single subject only?
      - Is it possible to make one subject an alias of another?
      instructions:
      - text: Set subject {subject} to compatibility {compatibility}.
        slots:
          subject: path.subject
          compatibility: requestBody.compatibility
      - text: Enable normalization {normalize} on subject {subject}.
        slots:
          subject: path.subject
          normalize: requestBody.normalize
      - text: Make subject {subject} an alias for {alias}.
        slots:
          subject: path.subject
          alias: requestBody.alias
      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 drop a subject's own compatibility setting so it follows the global default?
      - Can I delete the subject-level config for one subject?
      instructions:
      - text: Delete the compatibility config for subject {subject}.
        slots:
          subject: path.subject
      - text: Revert subject {subject} to the global compatibility default.
        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, normalization 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 can I change the default compatibility level for every subject?
      - Can I switch on schema normalization registry-wide?
      instructions:
      - text: Set the global compatibility level to {compatibility}.
        slots:
          compatibility: requestBody.compatibility
      - text: Turn global schema normalization to {normalize}.
        slots:
          normalize: requestBody.normalize
      - text: Set the registry-wide default rule set to {defaultRuleSet}.
        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 remove my custom global compatibility level and go back to the default?
      - What happens if I delete the global compatibility config?
      instructions:
      - text: Delete the global compatibility config.
      - text: Reset the registry-wide compatibility level to its default.
      method: generated
      generated: '2026-09-26'