Confluent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Managed Connector Plugins (connect/v1) API

4 actions 4 updates phrasing extends openapi/confluent-managed-connector-plugins-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}/connector-plugins'].get

$.paths['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/validate'].put

$.paths['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/translate?mask_sensitive=true'].put

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 Managed Connector Plugins (connect/v1) API
  version: 1.0.0
extends: openapi/confluent-managed-connector-plugins-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}/connector-plugins'].get
  update:
    x-apievangelist-phrasing:
      intent: List managed connector plugins
      effect: read
      questions:
      - Which fully managed connectors can I run on my Kafka cluster?
      - What connector plugins are installed for a cluster's Connect?
      instructions:
      - text: List managed connector plugins for cluster {kafka_cluster_id} in environment {environment_id}.
        slots:
          kafka_cluster_id: path.kafka_cluster_id
          environment_id: path.environment_id
      - text: Show available fully managed connectors on {kafka_cluster_id} in {environment_id}.
        slots:
          kafka_cluster_id: path.kafka_cluster_id
          environment_id: path.environment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/validate'].put
  update:
    x-apievangelist-phrasing:
      intent: Validate a managed connector config
      effect: read
      questions:
      - Can I check a connector configuration for errors before creating the connector?
      - Does config validation return suggested values for each setting?
      instructions:
      - text: Validate a config for connector plugin {plugin_name} on cluster {kafka_cluster_id} in {environment_id}.
        slots:
          plugin_name: path.plugin_name
          kafka_cluster_id: path.kafka_cluster_id
          environment_id: path.environment_id
      - text: Check my {plugin_name} connector settings for errors on {kafka_cluster_id}, environment {environment_id}.
        slots:
          plugin_name: path.plugin_name
          kafka_cluster_id: path.kafka_cluster_id
          environment_id: path.environment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/translate?mask_sensitive=true'].put
  update:
    x-apievangelist-phrasing:
      intent: Translate self-managed connector config
      effect: read
      questions:
      - How do I convert a self-managed connector config into a fully managed one?
      - Can sensitive values be masked when translating a connector configuration?
      instructions:
      - text: Translate my self-managed {plugin_name} config for cluster {kafka_cluster_id} in {environment_id}.
        slots:
          plugin_name: path.plugin_name
          kafka_cluster_id: path.kafka_cluster_id
          environment_id: path.environment_id
      - text: 'Convert a self-managed {plugin_name} config to fully managed on {kafka_cluster_id} in {environment_id}, masking secrets: {mask_sensitive}.'
        slots:
          plugin_name: path.plugin_name
          kafka_cluster_id: path.kafka_cluster_id
          environment_id: path.environment_id
          mask_sensitive: query.mask_sensitive
      method: generated
      generated: '2026-09-26'