Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Clusters (srcm/v3) API

3 actions 3 updates phrasing extends openapi/confluent-the-data-streaming-platform-clusters-srcm-v3-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['/srcm/v3/clusters'].get
$.paths['/srcm/v3/clusters/{id}'].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 Clusters (srcm/v3) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-clusters-srcm-v3-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['/srcm/v3/clusters'].get
  update:
    x-apievangelist-phrasing:
      intent: List Schema Registry clusters
      effect: read
      questions:
      - Which Schema Registry clusters are in my environment?
      - Can I find the Schema Registry endpoint for an environment?
      instructions:
      - text: List Schema Registry clusters in environment {environment}.
        slots:
          environment: query.environment
      - text: Show the Schema Registry cluster for {environment}.
        slots:
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/srcm/v3/clusters/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Schema Registry cluster
      effect: read
      questions:
      - What is the endpoint and package of a Schema Registry cluster?
      - Can I read one Schema Registry cluster by id?
      instructions:
      - text: Show Schema Registry cluster {id} in environment {environment}.
        slots:
          environment: query.environment
          id: path.id
      - text: Get the endpoint of Schema Registry cluster {id} in {environment}.
        slots:
          environment: query.environment
          id: path.id
      method: generated
      generated: '2026-09-26'