Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/compatibility/subjects/{subject}/versions/{version}'].post
$.paths['/compatibility/subjects/{subject}/versions'].post

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 Compatibility (v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-compatibility-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: 2
- target: $.paths['/compatibility/subjects/{subject}/versions/{version}'].post
  update:
    x-apievangelist-phrasing:
      intent: Test a schema against one subject version
      effect: read
      questions:
      - Is my new schema compatible with a specific version of a subject?
      - Which compatibility level is applied when testing against one version?
      instructions:
      - text: Test schema {schema} for compatibility with version {version} of subject {subject}.
        slots:
          schema: requestBody.schema
          version: path.version
          subject: path.subject
      - text: Check {schema} against {subject} version {version} and explain any incompatibilities.
        slots:
          schema: requestBody.schema
          subject: path.subject
          version: path.version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compatibility/subjects/{subject}/versions'].post
  update:
    x-apievangelist-phrasing:
      intent: Test a schema against all versions of a subject
      effect: read
      questions:
      - Would registering this schema break compatibility with the subject's existing versions?
      - Can I get verbose messages when a schema fails the subject-wide compatibility check?
      instructions:
      - text: Test schema {schema} for compatibility with all versions of subject {subject}.
        slots:
          schema: requestBody.schema
          subject: path.subject
      - text: Check whether {schema} is compatible with every registered version under {subject}.
        slots:
          schema: requestBody.schema
          subject: path.subject
      method: generated
      generated: '2026-09-26'