chore(openapi): update connector-mgmt/v1 OpenAPI document (#174)

Author: app-services-ci

.openapi/connector_mgmt.yaml

@@ -226,11 +226,7 @@ paths:
       parameters:
         - $ref: "#/components/parameters/page"
         - $ref: "#/components/parameters/size"
-        - in: query
-          name: kafka_id
-          description: The kafka cluster id
-          schema:
-            type: string
+
       responses:
         "200":
           content:
@@ -260,11 +256,6 @@ paths:
   "/api/connector_mgmt/v1/kafka_connectors/{id}":
     parameters:
       - $ref: "#/components/parameters/id"
-      - in: query
-        name: kafka_id
-        description: The kafka cluster id
-        schema:
-          type: string
     get:
       tags:
         - Connectors
@@ -360,16 +351,17 @@ paths:
       requestBody:
         description: Data to patch the connector with
         content:
-          application/json:
-            schema:
-              $ref: "#/components/schemas/ConnectorRequest"
           application/merge-patch+json:
             schema:
-              $ref: "#/components/schemas/ConnectorRequest"
+              type: object
           application/json-patch+json:
             schema:
               description: A JSON Patch, RFC 6902 - https://tools.ietf.org/html/rfc6902
               type: object
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ConnectorRequest"
+  
         required: true
       responses:
         "202":
@@ -822,18 +814,6 @@ components:
                 allOf:
                   - $ref: "#/components/schemas/ObjectReference"
 
-    ServiceStatus:
-      description: Schema for the service status response body
-      example:
-        kafkas:
-          max_capacity_reached: true
-      type: object
-      properties:
-        # TODO: what to show here ?
-        clusters:
-          description: The connector to upgrade
-          type: string
-
     #
     # Services
     #

openapitools.json

@@ -2,6 +2,6 @@
   "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json",
   "spaces": 2,
   "generator-cli": {
-    "version": "5.3.1"
+    "version": "5.4.0"
   }
 }

packages/connector-management-sdk/README.md

@@ -168,12 +168,12 @@ Class | Method | HTTP request | Description
  - [Error](docs/Error.md)
  - [ErrorAllOf](docs/ErrorAllOf.md)
  - [KafkaConnectionSettings](docs/KafkaConnectionSettings.md)
+ - [ModelList](docs/ModelList.md)
  - [ObjectMeta](docs/ObjectMeta.md)
  - [ObjectReference](docs/ObjectReference.md)
  - [SchemaRegistryConnectionSettings](docs/SchemaRegistryConnectionSettings.md)
  - [ServiceAccount](docs/ServiceAccount.md)
  - [ServiceConnectionSettings](docs/ServiceConnectionSettings.md)
- - [ServiceStatus](docs/ServiceStatus.md)
  - [VersionMetadata](docs/VersionMetadata.md)
  - [VersionMetadataAllOf](docs/VersionMetadataAllOf.md)
 

packages/connector-management-sdk/api/openapi.yaml

@@ -238,14 +238,6 @@ paths:
         schema:
           type: string
         style: form
-      - description: The kafka cluster id
-        explode: true
-        in: query
-        name: kafka_id
-        required: false
-        schema:
-          type: string
-        style: form
       responses:
         "200":
           content:
@@ -362,14 +354,6 @@ paths:
         schema:
           type: string
         style: simple
-      - description: The kafka cluster id
-        explode: true
-        in: query
-        name: kafka_id
-        required: false
-        schema:
-          type: string
-        style: form
       responses:
         "204":
           content:
@@ -422,14 +406,6 @@ paths:
         schema:
           type: string
         style: simple
-      - description: The kafka cluster id
-        explode: true
-        in: query
-        name: kafka_id
-        required: false
-        schema:
-          type: string
-        style: form
       responses:
         "200":
           content:
@@ -482,26 +458,18 @@ paths:
         schema:
           type: string
         style: simple
-      - description: The kafka cluster id
-        explode: true
-        in: query
-        name: kafka_id
-        required: false
-        schema:
-          type: string
-        style: form
       requestBody:
         content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/ConnectorRequest'
           application/merge-patch+json:
             schema:
-              $ref: '#/components/schemas/ConnectorRequest'
+              type: object
           application/json-patch+json:
             schema:
               description: A JSON Patch, RFC 6902 - https://tools.ietf.org/html/rfc6902
               type: object
+          application/json:
+            schema:
+              $ref: '#/components/schemas/ConnectorRequest'
         description: Data to patch the connector with
         required: true
       responses:
@@ -543,7 +511,7 @@ paths:
       summary: Patch a connector
       tags:
       - Connectors
-      x-contentType: application/json
+      x-contentType: application/merge-patch+json
       x-accepts: application/json
   /api/connector_mgmt/v1/kafka_connector_clusters:
     get:
@@ -1278,16 +1246,6 @@ components:
       allOf:
       - $ref: '#/components/schemas/ObjectReference'
       - $ref: '#/components/schemas/VersionMetadata_allOf'
-    ServiceStatus:
-      description: Schema for the service status response body
-      example:
-        kafkas:
-          max_capacity_reached: true
-      properties:
-        clusters:
-          description: The connector to upgrade
-          type: string
-      type: object
     KafkaConnectionSettings:
       allOf:
       - $ref: '#/components/schemas/ServiceConnectionSettings'

packages/connector-management-sdk/docs/ConnectorPatch.md

@@ -0,0 +1,21 @@
+
+
+# ConnectorPatch
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**connectorTypeId** | **String** |  | 
+**channel** | **Channel** |  |  [optional]
+**deploymentLocation** | [**DeploymentLocation**](DeploymentLocation.md) |  | 
+**desiredState** | **ConnectorDesiredState** |  | 
+**kafka** | [**KafkaConnectionSettings**](KafkaConnectionSettings.md) |  | 
+**serviceAccount** | [**ServiceAccount**](ServiceAccount.md) |  | 
+**schemaRegistry** | [**SchemaRegistryConnectionSettings**](SchemaRegistryConnectionSettings.md) |  |  [optional]
+**connector** | **Object** |  | 
+
+
+

packages/connector-management-sdk/docs/ConnectorsApi.md

@@ -91,7 +91,7 @@ Name | Type | Description  | Notes
 
 ## deleteConnector
 
-> Error deleteConnector(id, kafkaId)
+> Error deleteConnector(id)
 
 Delete a connector
 
@@ -119,9 +119,8 @@ public class Example {
 
         ConnectorsApi apiInstance = new ConnectorsApi(defaultClient);
         String id = "id_example"; // String | The ID of record
-        String kafkaId = "kafkaId_example"; // String | The kafka cluster id
         try {
-            Error result = apiInstance.deleteConnector(id, kafkaId);
+            Error result = apiInstance.deleteConnector(id);
             System.out.println(result);
         } catch (ApiException e) {
             System.err.println("Exception when calling ConnectorsApi#deleteConnector");
@@ -140,7 +139,6 @@ public class Example {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**| The ID of record |
- **kafkaId** | **String**| The kafka cluster id | [optional]
 
 ### Return type
 
@@ -167,7 +165,7 @@ Name | Type | Description  | Notes
 
 ## getConnector
 
-> Connector getConnector(id, kafkaId)
+> Connector getConnector(id)
 
 Get a connector
 
@@ -195,9 +193,8 @@ public class Example {
 
         ConnectorsApi apiInstance = new ConnectorsApi(defaultClient);
         String id = "id_example"; // String | The ID of record
-        String kafkaId = "kafkaId_example"; // String | The kafka cluster id
         try {
-            Connector result = apiInstance.getConnector(id, kafkaId);
+            Connector result = apiInstance.getConnector(id);
             System.out.println(result);
         } catch (ApiException e) {
             System.err.println("Exception when calling ConnectorsApi#getConnector");
@@ -216,7 +213,6 @@ public class Example {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**| The ID of record |
- **kafkaId** | **String**| The kafka cluster id | [optional]
 
 ### Return type
 
@@ -243,7 +239,7 @@ Name | Type | Description  | Notes
 
 ## listConnectors
 
-> ConnectorList listConnectors(page, size, kafkaId)
+> ConnectorList listConnectors(page, size)
 
 Returns a list of connector types
 
@@ -272,9 +268,8 @@ public class Example {
         ConnectorsApi apiInstance = new ConnectorsApi(defaultClient);
         String page = "1"; // String | Page index
         String size = "100"; // String | Number of items in each page
-        String kafkaId = "kafkaId_example"; // String | The kafka cluster id
         try {
-            ConnectorList result = apiInstance.listConnectors(page, size, kafkaId);
+            ConnectorList result = apiInstance.listConnectors(page, size);
             System.out.println(result);
         } catch (ApiException e) {
             System.err.println("Exception when calling ConnectorsApi#listConnectors");
@@ -294,7 +289,6 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **page** | **String**| Page index | [optional]
  **size** | **String**| Number of items in each page | [optional]
- **kafkaId** | **String**| The kafka cluster id | [optional]
 
 ### Return type
 
@@ -320,7 +314,7 @@ Name | Type | Description  | Notes
 
 ## patchConnector
 
-> Connector patchConnector(id, connectorRequest, kafkaId)
+> Connector patchConnector(id, body)
 
 Patch a connector
 
@@ -348,10 +342,9 @@ public class Example {
 
         ConnectorsApi apiInstance = new ConnectorsApi(defaultClient);
         String id = "id_example"; // String | The ID of record
-        ConnectorRequest connectorRequest = new ConnectorRequest(); // ConnectorRequest | Data to patch the connector with
-        String kafkaId = "kafkaId_example"; // String | The kafka cluster id
+        Object body = null; // Object | Data to patch the connector with
         try {
-            Connector result = apiInstance.patchConnector(id, connectorRequest, kafkaId);
+            Connector result = apiInstance.patchConnector(id, body);
             System.out.println(result);
         } catch (ApiException e) {
             System.err.println("Exception when calling ConnectorsApi#patchConnector");
@@ -370,8 +363,7 @@ public class Example {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**| The ID of record |
- **connectorRequest** | [**ConnectorRequest**](ConnectorRequest.md)| Data to patch the connector with |
- **kafkaId** | **String**| The kafka cluster id | [optional]
+ **body** | **Object**| Data to patch the connector with |
 
 ### Return type
 
@@ -383,7 +375,7 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
-- **Content-Type**: application/json, application/merge-patch+json, application/json-patch+json
+- **Content-Type**: application/merge-patch+json, application/json-patch+json, application/json
 - **Accept**: application/json
 
 

packages/connector-management-sdk/docs/ModelList.md

@@ -0,0 +1,16 @@
+
+
+# ModelList
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**kind** | **String** |  | 
+**page** | **Integer** |  | 
+**size** | **Integer** |  | 
+**total** | **Integer** |  | 
+
+
+