Confluent · 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-custom-connect-plugin-versions-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 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

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 Plugin Versions (ccpm/v1) API
  version: 1.0.0
extends: openapi/confluent-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 connect plugin
      effect: read
      questions:
      - Which versions of my custom connector plugin have been uploaded?
      - Can I see every version for one custom plugin in an environment?
      instructions:
      - text: List versions of plugin {plugin_id} in environment {environment}.
        slots:
          plugin_id: path.plugin_id
          environment: query.environment
      - text: Show all uploaded versions of custom plugin {plugin_id} in {environment}.
        slots:
          plugin_id: path.plugin_id
          environment: query.environment
      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 connect plugin
      effect: write
      questions:
      - How do I publish a new version of my custom connector plugin?
      - Can I register an uploaded plugin archive as a new version?
      instructions:
      - text: Create a new version of plugin {plugin_id} with spec {spec}.
        slots:
          plugin_id: path.plugin_id
          spec: requestBody.spec
      - text: Add plugin version {spec} to custom plugin {plugin_id}.
        slots:
          spec: requestBody.spec
          plugin_id: path.plugin_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccpm/v1/plugins/{plugin_id}/versions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one custom plugin version
      effect: read
      questions:
      - What connector classes and status does a specific plugin version have?
      - How do I read one version of a custom connect plugin?
      instructions:
      - text: Get version {id} of plugin {plugin_id} in environment {environment}.
        slots:
          id: path.id
          plugin_id: path.plugin_id
          environment: query.environment
      - text: Show details of plugin {plugin_id} version {id} in {environment}.
        slots:
          plugin_id: path.plugin_id
          id: path.id
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccpm/v1/plugins/{plugin_id}/versions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom plugin version
      effect: destructive
      questions:
      - How do I delete an old version of my custom connector plugin?
      - Can I remove a plugin version that was uploaded by mistake?
      instructions:
      - text: Delete version {id} of plugin {plugin_id} in environment {environment}.
        slots:
          id: path.id
          plugin_id: path.plugin_id
          environment: query.environment
      - text: Remove plugin {plugin_id} version {id} from {environment}.
        slots:
          plugin_id: path.plugin_id
          id: path.id
          environment: query.environment
      method: generated
      generated: '2026-09-26'