Confluent · 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-custom-connect-plugins-ccpm-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['/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

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 Connect Plugins (ccpm/v1) API
  version: 1.0.0
extends: openapi/confluent-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 Connect plugins
      effect: read
      questions:
      - Which custom connector plugins have I uploaded to an environment?
      - Can I list only the custom Connect plugins for one cloud?
      instructions:
      - text: List custom Connect plugins in environment {environment}.
        slots:
          environment: query.environment
      - text: List custom Connect plugins on {cloud} in {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 Connect plugin
      effect: write
      questions:
      - How do I register my own connector plugin in Confluent Cloud?
      - What spec is needed to add a custom Connect plugin?
      instructions:
      - text: Create a custom Connect plugin with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: Register a new custom connector plugin using {spec}.
        slots:
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccpm/v1/plugins/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom Connect plugin
      effect: read
      questions:
      - What versions and cloud does one of my custom plugins have?
      - Can I read a custom Connect plugin by its ID?
      instructions:
      - text: Get custom Connect plugin {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Show 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 Connect plugin
      effect: destructive
      questions:
      - How do I remove a custom connector plugin I uploaded?
      - Can I delete a custom Connect plugin from one environment?
      instructions:
      - text: Delete custom Connect plugin {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Remove the 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 Connect plugin
      effect: write
      questions:
      - Can I rename or change the description of a custom Connect plugin?
      - Which call edits an existing custom connector plugin?
      instructions:
      - text: Update custom Connect plugin {id} with spec {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      - text: Change the settings of custom plugin {id} to {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'