Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

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

$.info

$.paths['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/pause'].put

$.paths['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/resume'].put

$.paths['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/restart'].post

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 Lifecycle (connect/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-lifecycle-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: 3
- target: $.paths['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/pause'].put
  update:
    x-apievangelist-phrasing:
      intent: Pause a connector
      effect: write
      questions:
      - How do I temporarily stop a connector from processing messages?
      - Is pausing a connector asynchronous?
      instructions:
      - text: Pause connector {connector} on cluster {cluster} in {environment}.
        slots:
          connector: path.connector_name
          cluster: path.kafka_cluster_id
          environment: path.environment_id
      - text: Stop {connector} processing until I resume it.
        slots:
          connector: path.connector_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/resume'].put
  update:
    x-apievangelist-phrasing:
      intent: Resume a paused connector
      effect: write
      questions:
      - Can I restart message processing on a paused connector?
      - What happens if I resume a connector that isn't paused?
      instructions:
      - text: Resume connector {connector} on cluster {cluster} in {environment}.
        slots:
          connector: path.connector_name
          cluster: path.kafka_cluster_id
          environment: path.environment_id
      - text: Unpause {connector}.
        slots:
          connector: path.connector_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/restart'].post
  update:
    x-apievangelist-phrasing:
      intent: Restart a connector and its tasks
      effect: write
      questions:
      - Can I restart a failed connector and its tasks?
      - Does restarting a connector interrupt message flow?
      instructions:
      - text: Restart connector {connector} on cluster {cluster} in {environment}.
        slots:
          connector: path.connector_name
          cluster: path.kafka_cluster_id
          environment: path.environment_id
      - text: Bounce {connector} and all its tasks.
        slots:
          connector: path.connector_name
      method: generated
      generated: '2026-09-26'