Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Custom Connect Plugins (ccpm/v1) API

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-custom-connect-plugins-ccpm-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['/ccpm/v1/plugins'].get

$.paths['/ccpm/v1/plugins'].post

$.paths['/ccpm/v1/plugins/{id}'].get

$.paths['/ccpm/v1/plugins/{id}'].delete

$.paths['/ccpm/v1/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 Connect Plugins (ccpm/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-custom-connect-plugins-ccpm-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['/ccpm/v1/plugins'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom connector plugins
      effect: read
      questions:
      - Which custom connector plugins have I uploaded to an environment?
      - Can I filter my custom Connect plugins by cloud?
      instructions:
      - text: List custom connect plugins in environment {environment}.
        slots:
          environment: query.environment
      - text: List custom connect plugins on cloud {cloud} in environment {environment}.
        slots:
          cloud: query.spec.cloud
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccpm/v1/plugins'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom connector plugin
      effect: write
      questions:
      - How do I register a custom connector plugin after uploading its archive?
      - Can I create a custom Connect plugin in a specific environment?
      instructions:
      - text: Create a custom connect plugin with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: Register my uploaded connector archive as a new custom connect plugin.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccpm/v1/plugins/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom connector plugin
      effect: read
      questions:
      - What versions and cloud does one of my custom plugins have?
      - Can I read a custom connect plugin by ID?
      instructions:
      - text: Get custom connect plugin {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Show the details of custom plugin {id} in {environment}.
        slots:
          id: path.id
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccpm/v1/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 no longer need?
      - Can I delete a custom Connect plugin from an environment?
      instructions:
      - text: Delete custom connect plugin {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Remove custom plugin {id} from {environment}.
        slots:
          id: path.id
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccpm/v1/plugins/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a custom connector plugin
      effect: write
      questions:
      - How do I rename or re-describe a custom connector plugin?
      - Can I change the spec of an existing custom Connect plugin?
      instructions:
      - text: Update custom connect plugin {id} with spec {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      - text: Rename custom connect plugin {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'