Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Scopes (service-quota/v1) API

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

$.info

$.paths['/service-quota/v1/scopes'].get

$.paths['/service-quota/v1/scopes/{id}'].get

OpenAPI Overlay

# 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 Scopes (service-quota/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-scopes-service-quota-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: 2
- target: $.paths['/service-quota/v1/scopes'].get
  update:
    x-apievangelist-phrasing:
      intent: List service quota scopes
      effect: read
      questions:
      - At which levels are service quotas applied in Confluent Cloud?
      - Can I list all the scopes that service quotas are grouped by?
      instructions:
      - text: List service quota scopes.
      - text: Show every scope quotas can apply to.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/service-quota/v1/scopes/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a service quota scope
      effect: read
      questions:
      - What does a particular service quota scope cover?
      - Can I look up one quota scope by ID?
      instructions:
      - text: Get service quota scope {id}.
        slots:
          id: path.id
      - text: Show the details of quota scope {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'