Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/srcm/v2/regions'].get
$.paths['/srcm/v2/regions/{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 Regions (srcm/v2) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-regions-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: 2
- target: $.paths['/srcm/v2/regions'].get
  update:
    x-apievangelist-phrasing:
      intent: List Schema Registry regions
      effect: read
      questions:
      - Which cloud regions can host a Schema Registry cluster?
      - Can I filter Schema Registry regions by cloud or package?
      instructions:
      - text: List Schema Registry regions on cloud {cloud}.
        slots:
          cloud: query.spec.cloud
      - text: Show Schema Registry regions that support package {packages}.
        slots:
          packages: query.spec.packages
      method: generated
      generated: '2026-09-26'
- target: $.paths['/srcm/v2/regions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Schema Registry region
      effect: read
      questions:
      - What cloud and packages does one Schema Registry region offer?
      - Can I look up a single Schema Registry region by ID?
      instructions:
      - text: Show Schema Registry region {id}.
        slots:
          id: path.id
      - text: Read the details of region {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'