Skip to content

Commit 8d89e69

Browse files
chore(openapi): update connector-mgmt/v1 OpenAPI document (#159)
Co-authored-by: app-services-ci <app-services-ci@users.noreply.github.com>
1 parent 6b177ac commit 8d89e69

File tree

1 file changed

+67
-2
lines changed

1 file changed

+67
-2
lines changed

.openapi/connector_mgmt.yaml

Lines changed: 67 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -669,7 +669,7 @@ components:
669669
description: Version of the connector type.
670670
type: string
671671
channels:
672-
description: Version of the connector type.
672+
description: Channels of the connector type.
673673
type: array
674674
items:
675675
type: string
@@ -680,7 +680,7 @@ components:
680680
description: URL to an icon of the connector.
681681
type: string
682682
labels:
683-
description: labels used to categorize the connector
683+
description: Labels used to categorize the connector
684684
type: array
685685
items:
686686
type: string
@@ -918,6 +918,71 @@ components:
918918
examples:
919919
size:
920920
value: "100"
921+
orderBy:
922+
description: |-
923+
Specifies the order by criteria. The syntax of this parameter is
924+
similar to the syntax of the `order by` clause of an SQL statement.
925+
Each query can be ordered by any of the `ConnectorType` fields.
926+
For example, to return all Connector types ordered by their name, use the following syntax:
927+
928+
```sql
929+
name asc
930+
```
931+
932+
To return all Connector types ordered by their name _and_ version, use the following syntax:
933+
934+
```sql
935+
name asc, version asc
936+
```
937+
938+
If the parameter isn't provided, or if the value is empty, then
939+
the results are ordered by name.
940+
explode: true
941+
examples:
942+
orderBy:
943+
value: "name asc"
944+
in: query
945+
name: orderBy
946+
required: false
947+
schema:
948+
type: string
949+
style: form
950+
search:
951+
description: |
952+
Search criteria.
953+
954+
The syntax of this parameter is similar to the syntax of the `where` clause of a
955+
SQL statement. Allowed fields in the search are `name`, `description`, `version`, `label`, and `channel`. Allowed operators are `<>`, `=`, or `LIKE`.
956+
Allowed conjunctive operators are `AND` and `OR`. However, you can use a maximum of 10 conjunctions in a search query.
957+
958+
Examples:
959+
960+
To return a Connector Type with the name `aws-sqs-source` and the channel `stable`, use the following syntax:
961+
962+
```
963+
name = aws-sqs-source and channel = stable
964+
```[p-]
965+
966+
To return a Kafka instance with a name that starts with `aws`, use the following syntax:
967+
968+
```
969+
name like aws%25
970+
```
971+
972+
If the parameter isn't provided, or if the value is empty, then all the Connector Type
973+
that the user has permission to see are returned.
974+
975+
Note. If the query is invalid, an error is returned.
976+
explode: true
977+
name: search
978+
in: query
979+
required: false
980+
examples:
981+
search:
982+
value: "name = aws-sqs-source and channel = stable"
983+
schema:
984+
type: string
985+
style: form
921986

922987
securitySchemes:
923988
Bearer:

0 commit comments

Comments
 (0)