Confluent | the Data Streaming Platform · 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-the-data-streaming-platform-custom-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 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

# 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-the-data-streaming-platform-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 to Confluent Cloud?
      - Can I list only the custom connector plugins for one cloud provider?
      instructions:
      - text: List my custom connector plugins.
      - text: Show custom connector plugins available in 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: Register a custom connector plugin
      effect: write
      questions:
      - How do I register my own connector plugin after uploading its archive?
      - What do I need to supply, like the connector class and type, to add a custom plugin?
      instructions:
      - text: Create a custom connector plugin {display_name} with class {connector_class} from upload {upload_source}.
        slots:
          display_name: requestBody.display_name
          connector_class: requestBody.connector_class
          upload_source: requestBody.upload_source
      - text: Register a {connector_type} custom connector plugin named {display_name} in cloud {cloud}.
        slots:
          connector_type: requestBody.connector_type
          display_name: requestBody.display_name
          cloud: requestBody.cloud
      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 sensitive properties does one custom plugin declare?
      - Can I look up a single custom connector plugin by ID?
      instructions:
      - text: Show custom connector plugin {id}.
        slots:
          id: path.id
      - text: Read the details 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 run connectors from?
      instructions:
      - text: Delete custom connector plugin {id}.
        slots:
          id: path.id
      - text: Remove custom plugin {id} from my account.
        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 name or documentation link of an existing custom plugin?
      - How would I mark more config properties as sensitive on a custom plugin?
      instructions:
      - text: Rename custom connector plugin {id} to {display_name}.
        slots:
          id: path.id
          display_name: requestBody.display_name
      - text: Set the documentation link of custom plugin {id} to {documentation_link}.
        slots:
          id: path.id
          documentation_link: requestBody.documentation_link
      method: generated
      generated: '2026-09-26'