Confluent · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/confluent-lifecycle-connect-v1-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Confluent's API. It is a proposal applied on top of the contract, not a document Confluent 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-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?
      - Do a connector's tasks pause immediately when I pause it?
      instructions:
      - text: Pause 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: Halt message processing for {connector_name} ({environment_id}, {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'
- 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 flow on a connector I paused?
      - What happens if I resume a connector that isn't paused?
      instructions:
      - text: Resume 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: Unpause {connector_name} ({environment_id}, {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'
- 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:
      - Is there a way to restart a connector and all its tasks?
      - Can restarting a failed connector get it processing again?
      instructions:
      - text: Restart 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: Restart {connector_name} and its tasks ({environment_id}, {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'