Skip to content

Commit d049a28

Browse files
fix(openapi): update connector-mgmt/v1 OpenAPI document (#153)
Co-authored-by: app-services-ci <app-services-ci@users.noreply.github.com>
1 parent 83f6a3a commit d049a28

1 file changed

Lines changed: 29 additions & 19 deletions

File tree

.openapi/connector_mgmt.yaml

Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,8 @@ paths:
8686
parameters:
8787
- $ref: "#/components/parameters/page"
8888
- $ref: "#/components/parameters/size"
89+
- $ref: "#/components/parameters/orderBy"
90+
- $ref: "#/components/parameters/search"
8991
responses:
9092
"200":
9193
content:
@@ -176,6 +178,7 @@ paths:
176178
security:
177179
- Bearer: [ ]
178180
summary: Create a new connector
181+
179182
get:
180183
tags:
181184
- Connectors
@@ -599,6 +602,7 @@ paths:
599602
- Bearer: [ ]
600603
operationId: deleteConnectorCluster
601604
summary: Delete a connector cluster
605+
602606
/api/connector_mgmt/v1/kafka_connector_clusters/{connector_cluster_id}/addon_parameters:
603607
parameters:
604608
- name: connector_cluster_id
@@ -654,10 +658,15 @@ components:
654658
ConnectorType:
655659
description: >-
656660
Represents a connector type supported by the API
657-
required:
658-
- name
659-
- version
660-
- json_schema
661+
oneOf:
662+
- required:
663+
- name
664+
- version
665+
- schema
666+
- required:
667+
- name
668+
- version
669+
- json_schema
661670
allOf:
662671
- $ref: "#/components/schemas/ObjectReference"
663672
- type: object
@@ -685,6 +694,11 @@ components:
685694
items:
686695
type: string
687696
enum: [ sink, source ]
697+
schema:
698+
description: >-
699+
A json schema that can be used to validate a connectors
700+
connector_spec field.
701+
type: object # todo: replace with better type
688702
json_schema:
689703
description: >-
690704
A json schema that can be used to validate a connectors
@@ -759,38 +773,34 @@ components:
759773
`GET /api/connector_mgmt/v1/kafka_connector_types/{connector_type_id}`.
760774
761775
ClusterTarget:
762-
required:
763-
- kind
764-
properties:
765-
kind:
766-
type: string
767-
type: object
768776
discriminator:
769777
propertyName: kind
770778
mapping:
771779
addon: "#/components/schemas/AddonClusterTarget"
772780
cloud_provider: "#/components/schemas/CloudProviderClusterTarget"
781+
oneOf:
782+
- $ref: "#/components/schemas/AddonClusterTarget"
783+
- $ref: "#/components/schemas/CloudProviderClusterTarget"
773784

774785
AddonClusterTarget:
775-
allOf:
776-
- $ref: "#/components/schemas/ClusterTarget"
777-
- $ref: "#/components/schemas/AddonClusterTarget_allOf"
778-
779-
AddonClusterTarget_allOf:
780786
description: "Targets workloads to an addon cluster"
781787
type: object
788+
required:
789+
- kind
782790
properties:
791+
kind:
792+
type: string
783793
cluster_id:
784794
type: string
785795

786796
CloudProviderClusterTarget:
787-
allOf:
788-
- $ref: "#/components/schemas/ClusterTarget"
789-
- $ref: "#/components/schemas/CloudProviderClusterTarget_allOf"
790-
CloudProviderClusterTarget_allOf:
791797
description: "Targets workloads to a cloud provider"
792798
type: object
799+
required:
800+
- kind
793801
properties:
802+
kind:
803+
type: string
794804
cloud_provider:
795805
type: string
796806
region:

0 commit comments

Comments
 (0)