Confluent | the Data Streaming Platform · 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-the-data-streaming-platform-managed-connector-plugins-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}/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

Raw ↑ 
# 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-the-data-streaming-platform-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 connector plugins can I use on my Kafka cluster?
      - Can I see the managed connector plugins installed on a cluster?
      instructions:
      - text: List managed connector plugins on cluster {kafka_cluster_id} in environment {environment_id}.
        slots:
          environment_id: path.environment_id
          kafka_cluster_id: path.kafka_cluster_id
      - text: Show available managed connectors for cluster {kafka_cluster_id}, environment {environment_id}.
        slots:
          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}/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?
      - Which config values are invalid for a managed connector plugin?
      instructions:
      - text: Validate my config for plugin {plugin_name} on cluster {kafka_cluster_id} in environment {environment_id}.
        slots:
          environment_id: path.environment_id
          kafka_cluster_id: path.kafka_cluster_id
          plugin_name: path.plugin_name
      - text: Check this configuration against managed plugin {plugin_name} on cluster {kafka_cluster_id}, environment {environment_id}.
        slots:
          environment_id: path.environment_id
          kafka_cluster_id: path.kafka_cluster_id
          plugin_name: path.plugin_name
      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 a self-managed connector config
      effect: read
      questions:
      - How do I convert a self-managed connector config into a fully managed one?
      - Can the translated connector config hide sensitive values?
      instructions:
      - text: Translate my self-managed config for plugin {plugin_name} on cluster {kafka_cluster_id} in environment {environment_id}.
        slots:
          environment_id: path.environment_id
          kafka_cluster_id: path.kafka_cluster_id
          plugin_name: path.plugin_name
      - text: Convert this self-managed {plugin_name} config for cluster {kafka_cluster_id}, environment {environment_id}, masking secrets {mask_sensitive}.
        slots:
          environment_id: path.environment_id
          kafka_cluster_id: path.kafka_cluster_id
          plugin_name: path.plugin_name
          mask_sensitive: query.mask_sensitive
      method: generated
      generated: '2026-09-26'