Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/schemas/ids/{id}'].get
$.paths['/schemas/ids/{id}/schema'].get
$.paths['/schemas/types'].get
$.paths['/schemas'].get
$.paths['/schemas/ids/{id}/subjects'].get
$.paths['/schemas/ids/{id}/versions'].get

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 Schemas (v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-schemas-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: 6
- target: $.paths['/schemas/ids/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a schema record by ID
      effect: read
      questions:
      - How do I look up a registered schema and its type from a schema ID?
      - Can I get a schema by ID in a different output format?
      instructions:
      - text: Get the schema record for schema ID {id}.
        slots:
          id: path.id
      - text: Fetch schema ID {id} with its type and references in format {format}.
        slots:
          id: path.id
          format: query.format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schemas/ids/{id}/schema'].get
  update:
    x-apievangelist-phrasing:
      intent: Get only the raw schema text by ID
      effect: read
      questions:
      - Can I get just the raw schema body for an ID without the wrapper fields?
      - What endpoint returns only the schema definition itself for a schema ID?
      instructions:
      - text: Return only the raw schema text for ID {id}.
        slots:
          id: path.id
      - text: Download the bare schema definition for ID {id} under subject {subject}.
        slots:
          id: path.id
          subject: query.subject
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schemas/types'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported schema types
      effect: read
      questions:
      - Which schema formats does this Schema Registry support?
      - Does the registry accept Protobuf and JSON Schema as well as Avro?
      instructions:
      - text: List the schema types this registry supports.
      - text: Show me the supported schema formats.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schemas'].get
  update:
    x-apievangelist-phrasing:
      intent: Search registered schemas
      effect: read
      questions:
      - How can I find all schemas whose subject starts with a given prefix?
      - Can I list only the latest schema versions, including deleted ones?
      instructions:
      - text: List schemas for subjects starting with {subjectPrefix}.
        slots:
          subjectPrefix: query.subjectPrefix
      - text: Show only the latest schemas that have a {ruleType} rule.
        slots:
          ruleType: query.ruleType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schemas/ids/{id}/subjects'].get
  update:
    x-apievangelist-phrasing:
      intent: List subjects that use a schema ID
      effect: read
      questions:
      - Which subjects are using a particular schema ID?
      - Can I include deleted subjects when checking where a schema is used?
      instructions:
      - text: List the subjects associated with schema ID {id}.
        slots:
          id: path.id
      - text: Show which subjects reference schema {id}, including deleted ones.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schemas/ids/{id}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List subject-versions for a schema ID
      effect: read
      questions:
      - What subject and version pairs point to a given schema ID?
      - Can I see which version number a schema ID has in each subject?
      instructions:
      - text: List the subject-version pairs for schema ID {id}.
        slots:
          id: path.id
      - text: Show the versions of subject {subject} that use schema ID {id}.
        slots:
          subject: query.subject
          id: path.id
      method: generated
      generated: '2026-09-26'