Page History

# This already exists in production
/connector-plugins:
  get:
    summary: Lists available Connector plugins
    # Existing behavior, will not repeat it here


# Newly Proposed Endpoints
/plugins:
  get:
    summary: Returns plugin descriptions of all types
    responses:
      '200':
        description: A list of plugins
        content:
          application/json:
            schema:
              # Consistent with existing "/connector-plugins" endpoint
              type: array
              items:
                type: object
                properties:
                  class:
                    type: string
                    description: Plugin class name (e.g. "io.confluent.connect.hdfs.HdfsSinkConnector")

/plugins/{plugin-type}:
  get:
    summary: Returns plugin descriptions of the given type
    parameters:
      -in: path
      name: plugin-type
      schema:
        type: string
        required: true
        description: plugin-type can be one of connector, converter, header-converter, transformation, config-provider, connect-rest-extension
    responses:
      '200':
        description: A list of plugins
        content:
          application/json:
            schema:
              # Consistent with existing "/connector-plugins" endpoint
              type: array
              items:
                type: object
                properties:
                  class:
                    type: string
                    description: Plugin class name (e.g. "io.confluent.connect.hdfs.HdfsSinkConnector")
      '400':
        description: Invalid request, such as unknown plugin type, as constructed with existing ConnectRestException
        content:
          application/json:
            schema:
              # Consistent with https://docs.confluent.io/platform/current/connect/references/restapi.html#status-and-errors
              type: object
              properties:
                error_code:
                  type: integer
                  description: HTTP Error code (e.g. 400).
                message:
                  type: string
                  description: Human readable message to suggest action to caller.