|
@@ -18,7 +18,7 @@ paths:
|
|
/api/clusters:
|
|
/api/clusters:
|
|
get:
|
|
get:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters
|
|
|
|
|
|
+ - Clusters
|
|
summary: getClusters
|
|
summary: getClusters
|
|
operationId: getClusters
|
|
operationId: getClusters
|
|
responses:
|
|
responses:
|
|
@@ -34,7 +34,7 @@ paths:
|
|
/api/clusters/{clusterName}/brokers:
|
|
/api/clusters/{clusterName}/brokers:
|
|
get:
|
|
get:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters
|
|
|
|
|
|
+ - Brokers
|
|
summary: getBrokers
|
|
summary: getBrokers
|
|
operationId: getBrokers
|
|
operationId: getBrokers
|
|
parameters:
|
|
parameters:
|
|
@@ -56,7 +56,7 @@ paths:
|
|
/api/clusters/{clusterName}/metrics:
|
|
/api/clusters/{clusterName}/metrics:
|
|
get:
|
|
get:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters
|
|
|
|
|
|
+ - Clusters
|
|
summary: getClusterMetrics
|
|
summary: getClusterMetrics
|
|
operationId: getClusterMetrics
|
|
operationId: getClusterMetrics
|
|
parameters:
|
|
parameters:
|
|
@@ -76,7 +76,7 @@ paths:
|
|
/api/clusters/{clusterName}/stats:
|
|
/api/clusters/{clusterName}/stats:
|
|
get:
|
|
get:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters
|
|
|
|
|
|
+ - Clusters
|
|
summary: getClusterStats
|
|
summary: getClusterStats
|
|
operationId: getClusterStats
|
|
operationId: getClusterStats
|
|
parameters:
|
|
parameters:
|
|
@@ -96,7 +96,7 @@ paths:
|
|
/api/clusters/{clusterName}/brokers/{id}/metrics:
|
|
/api/clusters/{clusterName}/brokers/{id}/metrics:
|
|
get:
|
|
get:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters
|
|
|
|
|
|
+ - Brokers
|
|
summary: getBrokersMetrics
|
|
summary: getBrokersMetrics
|
|
operationId: getBrokersMetrics
|
|
operationId: getBrokersMetrics
|
|
parameters:
|
|
parameters:
|
|
@@ -121,7 +121,7 @@ paths:
|
|
/api/clusters/{clusterName}/topics:
|
|
/api/clusters/{clusterName}/topics:
|
|
get:
|
|
get:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters
|
|
|
|
|
|
+ - Topics
|
|
summary: getTopics
|
|
summary: getTopics
|
|
operationId: getTopics
|
|
operationId: getTopics
|
|
parameters:
|
|
parameters:
|
|
@@ -149,7 +149,7 @@ paths:
|
|
$ref: '#/components/schemas/TopicsResponse'
|
|
$ref: '#/components/schemas/TopicsResponse'
|
|
post:
|
|
post:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters
|
|
|
|
|
|
+ - Topics
|
|
summary: createTopic
|
|
summary: createTopic
|
|
operationId: createTopic
|
|
operationId: createTopic
|
|
parameters:
|
|
parameters:
|
|
@@ -174,7 +174,7 @@ paths:
|
|
/api/clusters/{clusterName}/topics/{topicName}:
|
|
/api/clusters/{clusterName}/topics/{topicName}:
|
|
get:
|
|
get:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters
|
|
|
|
|
|
+ - Topics
|
|
summary: getTopicDetails
|
|
summary: getTopicDetails
|
|
operationId: getTopicDetails
|
|
operationId: getTopicDetails
|
|
parameters:
|
|
parameters:
|
|
@@ -197,7 +197,7 @@ paths:
|
|
$ref: '#/components/schemas/TopicDetails'
|
|
$ref: '#/components/schemas/TopicDetails'
|
|
patch:
|
|
patch:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters
|
|
|
|
|
|
+ - Topics
|
|
summary: updateTopic
|
|
summary: updateTopic
|
|
operationId: updateTopic
|
|
operationId: updateTopic
|
|
parameters:
|
|
parameters:
|
|
@@ -225,7 +225,7 @@ paths:
|
|
$ref: '#/components/schemas/Topic'
|
|
$ref: '#/components/schemas/Topic'
|
|
delete:
|
|
delete:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters
|
|
|
|
|
|
+ - Topics
|
|
summary: deleteTopic
|
|
summary: deleteTopic
|
|
operationId: deleteTopic
|
|
operationId: deleteTopic
|
|
parameters:
|
|
parameters:
|
|
@@ -248,7 +248,7 @@ paths:
|
|
/api/clusters/{clusterName}/topics/{topicName}/config:
|
|
/api/clusters/{clusterName}/topics/{topicName}/config:
|
|
get:
|
|
get:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters
|
|
|
|
|
|
+ - Topics
|
|
summary: getTopicConfigs
|
|
summary: getTopicConfigs
|
|
operationId: getTopicConfigs
|
|
operationId: getTopicConfigs
|
|
parameters:
|
|
parameters:
|
|
@@ -275,7 +275,7 @@ paths:
|
|
/api/clusters/{clusterName}/topics/{topicName}/messages:
|
|
/api/clusters/{clusterName}/topics/{topicName}/messages:
|
|
get:
|
|
get:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters
|
|
|
|
|
|
+ - Messages
|
|
summary: getTopicMessages
|
|
summary: getTopicMessages
|
|
operationId: getTopicMessages
|
|
operationId: getTopicMessages
|
|
parameters:
|
|
parameters:
|
|
@@ -317,11 +317,39 @@ paths:
|
|
type: array
|
|
type: array
|
|
items:
|
|
items:
|
|
$ref: '#/components/schemas/TopicMessage'
|
|
$ref: '#/components/schemas/TopicMessage'
|
|
|
|
+ delete:
|
|
|
|
+ tags:
|
|
|
|
+ - Messages
|
|
|
|
+ summary: deleteTopicMessages
|
|
|
|
+ operationId: deleteTopicMessages
|
|
|
|
+ parameters:
|
|
|
|
+ - name: clusterName
|
|
|
|
+ in: path
|
|
|
|
+ required: true
|
|
|
|
+ schema:
|
|
|
|
+ type: string
|
|
|
|
+ - name: topicName
|
|
|
|
+ in: path
|
|
|
|
+ required: true
|
|
|
|
+ schema:
|
|
|
|
+ type: string
|
|
|
|
+ - name: partitions
|
|
|
|
+ in: query
|
|
|
|
+ required: false
|
|
|
|
+ schema:
|
|
|
|
+ type: array
|
|
|
|
+ items:
|
|
|
|
+ type: integer
|
|
|
|
+ responses:
|
|
|
|
+ 200:
|
|
|
|
+ description: OK
|
|
|
|
+ 404:
|
|
|
|
+ description: Not found
|
|
|
|
|
|
/api/clusters/{clusterName}/consumer-groups/{id}:
|
|
/api/clusters/{clusterName}/consumer-groups/{id}:
|
|
get:
|
|
get:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters
|
|
|
|
|
|
+ - Consumer Groups
|
|
summary: get Consumer Group By Id
|
|
summary: get Consumer Group By Id
|
|
operationId: getConsumerGroup
|
|
operationId: getConsumerGroup
|
|
parameters:
|
|
parameters:
|
|
@@ -346,7 +374,7 @@ paths:
|
|
/api/clusters/{clusterName}/consumerGroups:
|
|
/api/clusters/{clusterName}/consumerGroups:
|
|
get:
|
|
get:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters
|
|
|
|
|
|
+ - Consumer Groups
|
|
summary: get all ConsumerGroups
|
|
summary: get all ConsumerGroups
|
|
operationId: getConsumerGroups
|
|
operationId: getConsumerGroups
|
|
parameters:
|
|
parameters:
|
|
@@ -368,7 +396,7 @@ paths:
|
|
/api/clusters/{clusterName}/schemas:
|
|
/api/clusters/{clusterName}/schemas:
|
|
post:
|
|
post:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters
|
|
|
|
|
|
+ - Schemas
|
|
summary: create a new subject schema
|
|
summary: create a new subject schema
|
|
operationId: createNewSchema
|
|
operationId: createNewSchema
|
|
parameters:
|
|
parameters:
|
|
@@ -397,7 +425,7 @@ paths:
|
|
description: Invalid parameters
|
|
description: Invalid parameters
|
|
get:
|
|
get:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters
|
|
|
|
|
|
+ - Schemas
|
|
summary: get all schemas of latest version from Schema Registry service
|
|
summary: get all schemas of latest version from Schema Registry service
|
|
operationId: getSchemas
|
|
operationId: getSchemas
|
|
parameters:
|
|
parameters:
|
|
@@ -419,7 +447,7 @@ paths:
|
|
/api/clusters/{clusterName}/schemas/{subject}:
|
|
/api/clusters/{clusterName}/schemas/{subject}:
|
|
delete:
|
|
delete:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters
|
|
|
|
|
|
+ - Schemas
|
|
summary: delete schema from Schema Registry service
|
|
summary: delete schema from Schema Registry service
|
|
operationId: deleteSchema
|
|
operationId: deleteSchema
|
|
parameters:
|
|
parameters:
|
|
@@ -442,7 +470,7 @@ paths:
|
|
/api/clusters/{clusterName}/schemas/{subject}/versions:
|
|
/api/clusters/{clusterName}/schemas/{subject}/versions:
|
|
get:
|
|
get:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters
|
|
|
|
|
|
+ - Schemas
|
|
summary: get all version of subject from Schema Registry service
|
|
summary: get all version of subject from Schema Registry service
|
|
operationId: getAllVersionsBySubject
|
|
operationId: getAllVersionsBySubject
|
|
parameters:
|
|
parameters:
|
|
@@ -469,7 +497,7 @@ paths:
|
|
/api/clusters/{clusterName}/schemas/{subject}/latest:
|
|
/api/clusters/{clusterName}/schemas/{subject}/latest:
|
|
get:
|
|
get:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters
|
|
|
|
|
|
+ - Schemas
|
|
summary: get the latest schema from Schema Registry service
|
|
summary: get the latest schema from Schema Registry service
|
|
operationId: getLatestSchema
|
|
operationId: getLatestSchema
|
|
parameters:
|
|
parameters:
|
|
@@ -492,7 +520,7 @@ paths:
|
|
$ref: '#/components/schemas/SchemaSubject'
|
|
$ref: '#/components/schemas/SchemaSubject'
|
|
delete:
|
|
delete:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters
|
|
|
|
|
|
+ - Schemas
|
|
summary: delete the latest schema from schema registry
|
|
summary: delete the latest schema from schema registry
|
|
operationId: deleteLatestSchema
|
|
operationId: deleteLatestSchema
|
|
parameters:
|
|
parameters:
|
|
@@ -516,7 +544,7 @@ paths:
|
|
/api/clusters/{clusterName}/schemas/{subject}/versions/{version}:
|
|
/api/clusters/{clusterName}/schemas/{subject}/versions/{version}:
|
|
get:
|
|
get:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters
|
|
|
|
|
|
+ - Schemas
|
|
summary: get schema by version from Schema Registry service
|
|
summary: get schema by version from Schema Registry service
|
|
operationId: getSchemaByVersion
|
|
operationId: getSchemaByVersion
|
|
parameters:
|
|
parameters:
|
|
@@ -544,7 +572,7 @@ paths:
|
|
$ref: '#/components/schemas/SchemaSubject'
|
|
$ref: '#/components/schemas/SchemaSubject'
|
|
delete:
|
|
delete:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters
|
|
|
|
|
|
+ - Schemas
|
|
summary: delete schema by version from schema registry
|
|
summary: delete schema by version from schema registry
|
|
operationId: deleteSchemaByVersion
|
|
operationId: deleteSchemaByVersion
|
|
parameters:
|
|
parameters:
|
|
@@ -572,7 +600,7 @@ paths:
|
|
/api/clusters/{clusterName}/schemas/compatibility:
|
|
/api/clusters/{clusterName}/schemas/compatibility:
|
|
get:
|
|
get:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters
|
|
|
|
|
|
+ - Schemas
|
|
summary: Get global schema compatibility level
|
|
summary: Get global schema compatibility level
|
|
operationId: getGlobalSchemaCompatibilityLevel
|
|
operationId: getGlobalSchemaCompatibilityLevel
|
|
parameters:
|
|
parameters:
|
|
@@ -590,7 +618,7 @@ paths:
|
|
$ref: '#/components/schemas/CompatibilityLevel'
|
|
$ref: '#/components/schemas/CompatibilityLevel'
|
|
put:
|
|
put:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters
|
|
|
|
|
|
+ - Schemas
|
|
summary: Update compatibility level globally
|
|
summary: Update compatibility level globally
|
|
operationId: updateGlobalSchemaCompatibilityLevel
|
|
operationId: updateGlobalSchemaCompatibilityLevel
|
|
parameters:
|
|
parameters:
|
|
@@ -613,7 +641,7 @@ paths:
|
|
/api/clusters/{clusterName}/schemas/{subject}/compatibility:
|
|
/api/clusters/{clusterName}/schemas/{subject}/compatibility:
|
|
put:
|
|
put:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters
|
|
|
|
|
|
+ - Schemas
|
|
summary: Update compatibility level for specific schema.
|
|
summary: Update compatibility level for specific schema.
|
|
operationId: updateSchemaCompatibilityLevel
|
|
operationId: updateSchemaCompatibilityLevel
|
|
parameters:
|
|
parameters:
|
|
@@ -641,7 +669,7 @@ paths:
|
|
/api/clusters/{clusterName}/schemas/{subject}/check:
|
|
/api/clusters/{clusterName}/schemas/{subject}/check:
|
|
post:
|
|
post:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters
|
|
|
|
|
|
+ - Schemas
|
|
summary: Check compatibility of the schema.
|
|
summary: Check compatibility of the schema.
|
|
operationId: checkSchemaCompatibility
|
|
operationId: checkSchemaCompatibility
|
|
parameters:
|
|
parameters:
|
|
@@ -673,7 +701,7 @@ paths:
|
|
/api/clusters/{clusterName}/connects:
|
|
/api/clusters/{clusterName}/connects:
|
|
get:
|
|
get:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters/connects
|
|
|
|
|
|
+ - Kafka Connect
|
|
summary: get all kafka connect instances
|
|
summary: get all kafka connect instances
|
|
operationId: getConnects
|
|
operationId: getConnects
|
|
parameters:
|
|
parameters:
|
|
@@ -695,7 +723,7 @@ paths:
|
|
/api/clusters/{clusterName}/connects/{connectName}/connectors:
|
|
/api/clusters/{clusterName}/connects/{connectName}/connectors:
|
|
get:
|
|
get:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters/connects
|
|
|
|
|
|
+ - Kafka Connect
|
|
summary: get all connectors from Kafka Connect service
|
|
summary: get all connectors from Kafka Connect service
|
|
operationId: getConnectors
|
|
operationId: getConnectors
|
|
parameters:
|
|
parameters:
|
|
@@ -720,7 +748,7 @@ paths:
|
|
type: string
|
|
type: string
|
|
post:
|
|
post:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters/connects
|
|
|
|
|
|
+ - Kafka Connect
|
|
summary: create new connector
|
|
summary: create new connector
|
|
operationId: createConnector
|
|
operationId: createConnector
|
|
parameters:
|
|
parameters:
|
|
@@ -752,7 +780,7 @@ paths:
|
|
/api/clusters/{clusterName}/connects/{connectName}/connectors/{connectorName}:
|
|
/api/clusters/{clusterName}/connects/{connectName}/connectors/{connectorName}:
|
|
get:
|
|
get:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters/connects
|
|
|
|
|
|
+ - Kafka Connect
|
|
summary: get information about the connector
|
|
summary: get information about the connector
|
|
operationId: getConnector
|
|
operationId: getConnector
|
|
parameters:
|
|
parameters:
|
|
@@ -780,7 +808,7 @@ paths:
|
|
$ref: '#/components/schemas/Connector'
|
|
$ref: '#/components/schemas/Connector'
|
|
delete:
|
|
delete:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters/connects
|
|
|
|
|
|
+ - Kafka Connect
|
|
summary: delete connector
|
|
summary: delete connector
|
|
operationId: deleteConnector
|
|
operationId: deleteConnector
|
|
parameters:
|
|
parameters:
|
|
@@ -808,7 +836,7 @@ paths:
|
|
/api/clusters/{clusterName}/connects/{connectName}/connectors/{connectorName}/action/{action}:
|
|
/api/clusters/{clusterName}/connects/{connectName}/connectors/{connectorName}/action/{action}:
|
|
post:
|
|
post:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters/connects
|
|
|
|
|
|
+ - Kafka Connect
|
|
summary: update connector state (restart, pause or resume)
|
|
summary: update connector state (restart, pause or resume)
|
|
operationId: updateConnectorState
|
|
operationId: updateConnectorState
|
|
parameters:
|
|
parameters:
|
|
@@ -841,7 +869,7 @@ paths:
|
|
/api/clusters/{clusterName}/connects/{connectName}/connectors/{connectorName}/config:
|
|
/api/clusters/{clusterName}/connects/{connectName}/connectors/{connectorName}/config:
|
|
get:
|
|
get:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters/connects
|
|
|
|
|
|
+ - Kafka Connect
|
|
summary: get connector configuration
|
|
summary: get connector configuration
|
|
operationId: getConnectorConfig
|
|
operationId: getConnectorConfig
|
|
parameters:
|
|
parameters:
|
|
@@ -869,7 +897,7 @@ paths:
|
|
$ref: '#/components/schemas/ConnectorConfig'
|
|
$ref: '#/components/schemas/ConnectorConfig'
|
|
put:
|
|
put:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters/connects
|
|
|
|
|
|
+ - Kafka Connect
|
|
summary: update or create connector with provided config
|
|
summary: update or create connector with provided config
|
|
operationId: setConnectorConfig
|
|
operationId: setConnectorConfig
|
|
parameters:
|
|
parameters:
|
|
@@ -906,7 +934,7 @@ paths:
|
|
/api/clusters/{clusterName}/connects/{connectName}/connectors/{connectorName}/tasks:
|
|
/api/clusters/{clusterName}/connects/{connectName}/connectors/{connectorName}/tasks:
|
|
get:
|
|
get:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters/connects
|
|
|
|
|
|
+ - Kafka Connect
|
|
summary: get connector tasks
|
|
summary: get connector tasks
|
|
operationId: getConnectorTasks
|
|
operationId: getConnectorTasks
|
|
parameters:
|
|
parameters:
|
|
@@ -938,7 +966,7 @@ paths:
|
|
/api/clusters/{clusterName}/connects/{connectName}/connectors/{connectorName}/tasks/{taskId}/action/restart:
|
|
/api/clusters/{clusterName}/connects/{connectName}/connectors/{connectorName}/tasks/{taskId}/action/restart:
|
|
post:
|
|
post:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters/connects
|
|
|
|
|
|
+ - Kafka Connect
|
|
summary: restart connector task
|
|
summary: restart connector task
|
|
operationId: restartConnectorTask
|
|
operationId: restartConnectorTask
|
|
parameters:
|
|
parameters:
|
|
@@ -969,7 +997,7 @@ paths:
|
|
/api/clusters/{clusterName}/connects/{connectName}/plugins:
|
|
/api/clusters/{clusterName}/connects/{connectName}/plugins:
|
|
get:
|
|
get:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters/connects
|
|
|
|
|
|
+ - Kafka Connect
|
|
summary: get connector plugins
|
|
summary: get connector plugins
|
|
operationId: getConnectorPlugins
|
|
operationId: getConnectorPlugins
|
|
parameters:
|
|
parameters:
|
|
@@ -996,7 +1024,7 @@ paths:
|
|
/api/clusters/{clusterName}/connects/{connectName}/plugins/{pluginName}/config/validate:
|
|
/api/clusters/{clusterName}/connects/{connectName}/plugins/{pluginName}/config/validate:
|
|
put:
|
|
put:
|
|
tags:
|
|
tags:
|
|
- - /api/clusters/connects
|
|
|
|
|
|
+ - Kafka Connect
|
|
summary: validate connector plugin configuration
|
|
summary: validate connector plugin configuration
|
|
operationId: validateConnectorPluginConfig
|
|
operationId: validateConnectorPluginConfig
|
|
parameters:
|
|
parameters:
|