Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Endpoints (endpoint/v1) API

2 actions 2 updates phrasing extends openapi/confluent-the-data-streaming-platform-endpoints-endpoint-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 2

$.info

$.paths['/endpoint/v1/endpoints'].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 Endpoints (endpoint/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-endpoints-endpoint-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: 1
- target: $.paths['/endpoint/v1/endpoints'].get
  update:
    x-apievangelist-phrasing:
      intent: List service endpoints in an environment
      effect: read
      questions:
      - What connection endpoints does a service in my environment expose?
      - Can I list only private endpoints for a given cloud and region?
      instructions:
      - text: List {service} endpoints in environment {environment}.
        slots:
          service: query.service
          environment: query.environment
      - text: List private {service} endpoints in {environment} on {cloud} region {region}.
        slots:
          service: query.service
          environment: query.environment
          cloud: query.cloud
          region: query.region
      - text: List {service} endpoints for resource {resource} in {environment}.
        slots:
          service: query.service
          resource: query.resource
          environment: query.environment
      method: generated
      generated: '2026-09-26'