Confluent · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/confluent-custom-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 6

$.info
$.paths['/connect/v1/custom-connector-plugins'].get
$.paths['/connect/v1/custom-connector-plugins'].post
$.paths['/connect/v1/custom-connector-plugins/{id}'].get
$.paths['/connect/v1/custom-connector-plugins/{id}'].delete
$.paths['/connect/v1/custom-connector-plugins/{id}'].patch

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 Custom Connector Plugins (connect/v1) API
  version: 1.0.0
extends: openapi/confluent-custom-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: 5
- target: $.paths['/connect/v1/custom-connector-plugins'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom connector plugins
      effect: read
      questions:
      - Which custom connector plugins have I uploaded?
      - Can I list only the custom plugins for one cloud provider?
      instructions:
      - text: List my custom connector plugins.
      - text: List custom connector plugins available on cloud {cloud}.
        slots:
          cloud: query.cloud
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connect/v1/custom-connector-plugins'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom connector plugin
      effect: write
      questions:
      - How do I upload my own Kafka Connect plugin to Confluent Cloud?
      - Can I mark some connector config properties as sensitive?
      - Which connector types can a custom plugin be, source or sink?
      instructions:
      - text: Create custom connector plugin {display_name} with connector class {connector_class}.
        slots:
          display_name: requestBody.display_name
          connector_class: requestBody.connector_class
      - text: Register a {connector_type} custom plugin named {display_name} from upload source {upload_source}.
        slots:
          connector_type: requestBody.connector_type
          display_name: requestBody.display_name
          upload_source: requestBody.upload_source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connect/v1/custom-connector-plugins/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom connector plugin
      effect: read
      questions:
      - What connector class and type does one of my custom plugins use?
      - Can I view the details of a single custom connector plugin?
      instructions:
      - text: Get custom connector plugin {id}.
        slots:
          id: path.id
      - text: Show the configuration of custom plugin {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connect/v1/custom-connector-plugins/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom connector plugin
      effect: destructive
      questions:
      - How do I remove a custom connector plugin I uploaded?
      - Can I delete a custom plugin that I no longer use?
      instructions:
      - text: Delete custom connector plugin {id}.
        slots:
          id: path.id
      - text: Remove my uploaded custom plugin {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connect/v1/custom-connector-plugins/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a custom connector plugin
      effect: write
      questions:
      - Can I change the documentation link or description of a custom plugin?
      - Is it possible to update which properties are marked sensitive on a plugin?
      instructions:
      - text: Rename custom connector plugin {id} to {display_name}.
        slots:
          id: path.id
          display_name: requestBody.display_name
      - text: Update the documentation link of existing custom plugin {id} to {documentation_link}.
        slots:
          id: path.id
          documentation_link: requestBody.documentation_link
      method: generated
      generated: '2026-09-26'