Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-clusters-srcm-v2-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 6

$.info
$.paths['/srcm/v2/clusters'].get
$.paths['/srcm/v2/clusters'].post
$.paths['/srcm/v2/clusters/{id}'].get
$.paths['/srcm/v2/clusters/{id}'].delete
$.paths['/srcm/v2/clusters/{id}'].patch

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/v2) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-clusters-srcm-v2-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: 5
- target: $.paths['/srcm/v2/clusters'].get
  update:
    x-apievangelist-phrasing:
      intent: List Schema Registry clusters
      effect: read
      questions:
      - Which Schema Registry clusters exist in my environment?
      - Can I see the Schema Registry cluster for a given 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/v2/clusters'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Schema Registry cluster
      effect: write
      questions:
      - How do I enable Schema Registry for an environment?
      - Can I provision a Schema Registry cluster in a specific region?
      instructions:
      - text: Create a Schema Registry cluster with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: Provision a new Schema Registry cluster for my environment.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/srcm/v2/clusters/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Schema Registry cluster
      effect: read
      questions:
      - What is the endpoint of my Schema Registry cluster?
      - What package and region is a Schema Registry cluster using?
      instructions:
      - text: Get Schema Registry cluster {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Show the endpoint of Schema Registry cluster {id} in {environment}.
        slots:
          id: path.id
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/srcm/v2/clusters/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Schema Registry cluster
      effect: destructive
      questions:
      - How do I remove the Schema Registry cluster from an environment?
      - Can I delete a Schema Registry cluster I no longer use?
      instructions:
      - text: Delete Schema Registry cluster {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Remove Schema Registry cluster {id} from {environment}.
        slots:
          id: path.id
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/srcm/v2/clusters/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Schema Registry cluster
      effect: write
      questions:
      - How do I change the package on my Schema Registry cluster?
      - Can I modify an existing Schema Registry cluster's spec?
      instructions:
      - text: Update Schema Registry cluster {id} with spec {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      - text: Upgrade the package of Schema Registry cluster {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'