Skip to content

Commit 67df216

Browse files
chore(openapi): update connector-mgmt/v1 OpenAPI document (#106)
Co-authored-by: app-services-ci <app-services-ci@users.noreply.github.com>
1 parent 1b6446e commit 67df216

File tree

1 file changed

+25
-28
lines changed

1 file changed

+25
-28
lines changed

.openapi/connector_mgmt.yaml

Lines changed: 25 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ paths:
7171
$ref: "#/components/examples/500Example"
7272
description: Unexpected error occurred
7373
security:
74-
- Bearer: []
74+
- Bearer: [ ]
7575
operationId: getConnectorTypeByID
7676
summary: Get a connector type by id
7777

@@ -80,7 +80,7 @@ paths:
8080
tags:
8181
- Connector Types
8282
security:
83-
- Bearer: []
83+
- Bearer: [ ]
8484
operationId: listConnectorTypes
8585
summary: Returns a list of connector types
8686
parameters:
@@ -174,7 +174,7 @@ paths:
174174
$ref: "#/components/examples/500Example"
175175
description: An unexpected error occurred creating the connector
176176
security:
177-
- Bearer: []
177+
- Bearer: [ ]
178178
summary: Create a new connector
179179
get:
180180
tags:
@@ -213,7 +213,7 @@ paths:
213213
$ref: "#/components/examples/500Example"
214214
description: Unexpected error occurred
215215
security:
216-
- Bearer: []
216+
- Bearer: [ ]
217217
operationId: listConnectors
218218
summary: Returns a list of connector types
219219
"/api/connector_mgmt/v1/kafka_connectors/{id}":
@@ -262,7 +262,7 @@ paths:
262262
$ref: "#/components/examples/500Example"
263263
description: Unexpected error occurred
264264
security:
265-
- Bearer: []
265+
- Bearer: [ ]
266266
operationId: getConnector
267267
summary: Get a connector
268268
delete:
@@ -303,7 +303,7 @@ paths:
303303
$ref: "#/components/examples/500DeleteExample"
304304
description: Unexpected error occurred
305305
security:
306-
- Bearer: []
306+
- Bearer: [ ]
307307
operationId: deleteConnector
308308
summary: Delete a connector
309309
patch:
@@ -344,19 +344,21 @@ paths:
344344
$ref: "#/components/examples/500Example"
345345
description: Unexpected error occurred
346346
security:
347-
- Bearer: []
347+
- Bearer: [ ]
348348
operationId: patchConnector
349349
summary: patch a connector
350350
requestBody:
351351
description: Data to patch the connector with
352352
content:
353-
application/json-patch+json:
353+
application/json:
354354
schema:
355-
description: A JSON Patch, RFC 6902 - https://tools.ietf.org/html/rfc6902
356-
type: object
355+
$ref: "#/components/schemas/Connector"
357356
application/merge-patch+json:
358357
schema:
359-
description: A JSON Merge Patch, RFC 7386 - https://tools.ietf.org/html/rfc7386
358+
$ref: "#/components/schemas/Connector"
359+
application/json-patch+json:
360+
schema:
361+
description: A JSON Patch, RFC 6902 - https://tools.ietf.org/html/rfc6902
360362
type: object
361363
required: true
362364

@@ -424,7 +426,7 @@ paths:
424426
$ref: "#/components/examples/500Example"
425427
description: An unexpected error occurred creating the connector cluster
426428
security:
427-
- Bearer: []
429+
- Bearer: [ ]
428430
summary: Create a new connector cluster
429431
get:
430432
tags:
@@ -458,7 +460,7 @@ paths:
458460
$ref: "#/components/examples/500Example"
459461
description: Unexpected error occurred
460462
security:
461-
- Bearer: []
463+
- Bearer: [ ]
462464
operationId: listConnectorClusters
463465
summary: Returns a list of connector clusters
464466
/api/connector_mgmt/v1/kafka_connector_clusters/{connector_cluster_id}:
@@ -507,7 +509,7 @@ paths:
507509
$ref: "#/components/examples/500Example"
508510
description: Unexpected error occurred
509511
security:
510-
- Bearer: []
512+
- Bearer: [ ]
511513
operationId: getConnectorCluster
512514
summary: Get a connector cluster
513515
delete:
@@ -548,11 +550,11 @@ paths:
548550
$ref: "#/components/examples/500DeleteExample"
549551
description: Unexpected error occurred
550552
security:
551-
- Bearer: []
553+
- Bearer: [ ]
552554
operationId: deleteConnectorCluster
553555
summary: Delete a connector cluster
554-
? /api/connector_mgmt/v1/kafka_connector_clusters/{connector_cluster_id}/addon_parameters
555-
: parameters:
556+
/api/connector_mgmt/v1/kafka_connector_clusters/{connector_cluster_id}/addon_parameters:
557+
parameters:
556558
- name: connector_cluster_id
557559
description: The id of the connector cluster
558560
schema:
@@ -597,7 +599,7 @@ paths:
597599
$ref: "#/components/examples/500Example"
598600
description: Unexpected error occurred
599601
security:
600-
- Bearer: []
602+
- Bearer: [ ]
601603
operationId: getConnectorClusterAddonParameters
602604
summary: Get a connector cluster's addon parameters
603605

@@ -636,13 +638,12 @@ components:
636638
type: array
637639
items:
638640
type: string
639-
enum: [sink, source]
641+
enum: [ sink, source ]
640642
json_schema:
641643
description: >-
642644
A json schema that can be used to validate a connectors
643645
connector_spec field.
644646
type: object # todo: replace with better type
645-
646647
ConnectorTypeList:
647648
allOf:
648649
- $ref: "#/components/schemas/List"
@@ -651,8 +652,7 @@ components:
651652
items:
652653
type: array
653654
items:
654-
allOf:
655-
- $ref: "#/components/schemas/ConnectorType"
655+
$ref: "#/components/schemas/ConnectorType"
656656

657657
ConnectorList:
658658
allOf:
@@ -662,8 +662,7 @@ components:
662662
items:
663663
type: array
664664
items:
665-
allOf:
666-
- $ref: "#/components/schemas/Connector"
665+
$ref: "#/components/schemas/Connector"
667666

668667
Connector:
669668
description: A connector holds the configuration to connect a Kafka topic to another system.
@@ -744,8 +743,7 @@ components:
744743
description: "A list of addon parameters"
745744
type: array
746745
items:
747-
allOf:
748-
- $ref: "#/components/schemas/AddonParameter"
746+
$ref: "#/components/schemas/AddonParameter"
749747

750748
AddonParameter:
751749
description: "A addon parameter"
@@ -786,8 +784,7 @@ components:
786784
items:
787785
type: array
788786
items:
789-
allOf:
790-
- $ref: "#/components/schemas/ConnectorCluster"
787+
$ref: "#/components/schemas/ConnectorCluster"
791788

792789
KafkaConnectionSettings:
793790
properties:

0 commit comments

Comments
 (0)