Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Status (connect/v1) API

3 actions 3 updates phrasing extends openapi/confluent-the-data-streaming-platform-status-connect-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['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/status'].get

$.paths['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/tasks'].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 Status (connect/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-status-connect-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['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a connector's status
      effect: read
      questions:
      - Is my connector running, paused or failed?
      - Why did my connector fail and which worker is it on?
      instructions:
      - text: Get the status of connector {connector_name} on cluster {kafka_cluster_id} in environment {environment_id}.
        slots:
          connector_name: path.connector_name
          environment_id: path.environment_id
          kafka_cluster_id: path.kafka_cluster_id
      - text: Check whether {connector_name} in {environment_id}, cluster {kafka_cluster_id}, has failed.
        slots:
          connector_name: path.connector_name
          environment_id: path.environment_id
          kafka_cluster_id: path.kafka_cluster_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List a connector's running tasks
      effect: read
      questions:
      - What tasks are currently running for my connector?
      - How many tasks is a connector running right now?
      instructions:
      - text: List tasks for connector {connector_name} on cluster {kafka_cluster_id} in environment {environment_id}.
        slots:
          connector_name: path.connector_name
          environment_id: path.environment_id
          kafka_cluster_id: path.kafka_cluster_id
      - text: Show running tasks of {connector_name} in {environment_id}, cluster {kafka_cluster_id}.
        slots:
          connector_name: path.connector_name
          environment_id: path.environment_id
          kafka_cluster_id: path.kafka_cluster_id
      method: generated
      generated: '2026-09-26'