Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

5 actions 5 updates phrasing extends openapi/confluent-the-data-streaming-platform-custom-connect-plugin-versions-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 5

$.info

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

$.paths['/ccpm/v1/plugins/{plugin_id}/versions'].post

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

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

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 Plugin Versions (ccpm/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-custom-connect-plugin-versions-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: 4
- target: $.paths['/ccpm/v1/plugins/{plugin_id}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List versions of a custom connector plugin
      effect: read
      questions:
      - Which versions of my custom connector plugin have been uploaded?
      - Can I see every version of a custom Connect plugin?
      instructions:
      - text: List versions of custom plugin {plugin} in environment {environment}.
        slots:
          plugin: path.plugin_id
          environment: query.environment
      - text: Show all uploaded versions of plugin {plugin}.
        slots:
          plugin: path.plugin_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccpm/v1/plugins/{plugin_id}/versions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a version to a custom connector plugin
      effect: write
      questions:
      - How do I upload a new version of my custom connector plugin?
      - Can I register a new plugin version from an uploaded archive?
      instructions:
      - text: Create a new version of custom plugin {plugin} with spec {spec}.
        slots:
          plugin: path.plugin_id
          spec: requestBody.spec
      - text: Add a plugin version to {plugin}.
        slots:
          plugin: path.plugin_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccpm/v1/plugins/{plugin_id}/versions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a custom connector plugin version
      effect: read
      questions:
      - What's the status of a particular plugin version?
      - Can I look up one version of a custom plugin by ID?
      instructions:
      - text: Get version {id} of custom plugin {plugin} in environment {environment}.
        slots:
          id: path.id
          plugin: path.plugin_id
          environment: query.environment
      - text: Show plugin {plugin} version {id}.
        slots:
          id: path.id
          plugin: path.plugin_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccpm/v1/plugins/{plugin_id}/versions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom connector plugin version
      effect: destructive
      questions:
      - Can I delete an old version of my custom plugin?
      - Is removing a plugin version permanent?
      instructions:
      - text: Delete version {id} of custom plugin {plugin} in environment {environment}.
        slots:
          id: path.id
          plugin: path.plugin_id
          environment: query.environment
      - text: Remove plugin version {id} from {plugin}.
        slots:
          id: path.id
          plugin: path.plugin_id
      method: generated
      generated: '2026-09-26'