Confluent · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/confluent-clusters-srcm-v2-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 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-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 (deprecated v2)
      effect: read
      questions:
      - Which Schema Registry clusters does an environment have, using the older v2 API?
      - Is the v2 Schema Registry cluster list endpoint deprecated?
      instructions:
      - text: List Schema Registry clusters in environment {environment} with the deprecated v2 API.
        slots:
          environment: query.environment
      - text: Show the v2 Schema Registry clusters 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 (deprecated)
      effect: write
      questions:
      - Can I still enable a Schema Registry cluster through the deprecated v2 API?
      - What spec do I send to create a Schema Registry cluster in v2?
      instructions:
      - text: Create a Schema Registry cluster with spec {spec} via the v2 API.
        slots:
          spec: requestBody.spec
      - text: Enable Schema Registry using the deprecated v2 create with spec {spec}.
        slots:
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/srcm/v2/clusters/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Schema Registry cluster (deprecated v2)
      effect: read
      questions:
      - How do I read one Schema Registry cluster using the older v2 endpoint?
      - What endpoint URL does my Schema Registry cluster have in v2?
      instructions:
      - text: Get Schema Registry cluster {id} in {environment} via v2.
        slots:
          id: path.id
          environment: query.environment
      - text: Show v2 details for Schema Registry cluster {id} in environment {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 (deprecated)
      effect: destructive
      questions:
      - Can I remove a Schema Registry cluster through the v2 API?
      - What happens to an environment's schemas if I delete its Schema Registry cluster?
      instructions:
      - text: Delete Schema Registry cluster {id} in {environment} using v2.
        slots:
          id: path.id
          environment: query.environment
      - text: Remove the v2 Schema Registry cluster {id} from environment {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 (deprecated)
      effect: write
      questions:
      - Can I change a Schema Registry cluster's package through the v2 API?
      - Which v2 call edits an existing Schema Registry cluster?
      instructions:
      - text: Update Schema Registry cluster {id} with spec {spec} via v2.
        slots:
          id: path.id
          spec: requestBody.spec
      - text: Change the v2 Schema Registry cluster {id} to spec {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'