Skip to content

Commit ee72a15

Browse files
fix(connector-mgmt/v1): update connector-mgmt/v1 SDK (#349)
Co-authored-by: app-services-ci <app-services-ci@users.noreply.github.com>
1 parent 02af63a commit ee72a15

80 files changed

Lines changed: 532 additions & 533 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.openapi/connector_mgmt.yaml

Lines changed: 57 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ info:
55
title: Connector Management API
66
version: 0.1.0
77
description: Connector Management API is a REST API to manage connectors.
8+
license:
9+
name: 'Apache 2.0'
10+
url: 'https://www.apache.org/licenses/LICENSE-2.0'
11+
contact:
12+
name: 'Red Hat OpenShift Streams for Apache Kafka Support'
13+
email: 'rhosak-support@redhat.com'
814
servers:
915
- url: https://api.openshift.com
1016
description: Main (production) server
@@ -23,7 +29,8 @@ tags:
2329
description: ""
2430
- name: Connector Service
2531
description: ""
26-
32+
- name : Connector Namespaces
33+
description: ""
2734
paths:
2835
#
2936
# Connector Service
@@ -510,6 +517,8 @@ paths:
510517
parameters:
511518
- $ref: "#/components/parameters/page"
512519
- $ref: "#/components/parameters/size"
520+
- $ref: "#/components/parameters/orderBy"
521+
- $ref: "#/components/parameters/search"
513522
responses:
514523
"200":
515524
content:
@@ -986,18 +995,28 @@ components:
986995
type: integer
987996
total:
988997
type: integer
998+
items:
999+
type: array
1000+
items:
1001+
$ref: "#/components/schemas/ObjectReference"
9891002

9901003
Error:
991-
allOf:
992-
- $ref: "#/components/schemas/ObjectReference"
993-
- type: object
994-
properties:
995-
code:
996-
type: string
997-
reason:
998-
type: string
999-
operation_id:
1000-
type: string
1004+
type: object
1005+
nullable: true
1006+
required: [id, kind, href, code, reason]
1007+
properties:
1008+
reason:
1009+
type: string
1010+
operation_id:
1011+
type: string
1012+
id:
1013+
type: string
1014+
kind:
1015+
type: string
1016+
href:
1017+
type: string
1018+
code:
1019+
type: string
10011020

10021021
ObjectReference:
10031022
type: object
@@ -1265,17 +1284,11 @@ components:
12651284
#
12661285

12671286
ConnectorType:
1268-
description: >-
1269-
Represents a connector type supported by the API
1270-
oneOf:
1271-
- required:
1272-
- name
1273-
- version
1274-
- schema
1275-
- required:
1276-
- name
1277-
- version
1278-
- json_schema
1287+
description: Represents a connector type supported by the API
1288+
required:
1289+
- name
1290+
- version
1291+
- schema
12791292
allOf:
12801293
- $ref: "#/components/schemas/ObjectReference"
12811294
- type: object
@@ -1312,11 +1325,6 @@ components:
13121325
A json schema that can be used to validate a ConnectorRequest
13131326
connector field.
13141327
type: object
1315-
json_schema:
1316-
description: >-
1317-
A json schema that can be used to validate a ConnectorRequest
1318-
connector field.
1319-
type: object
13201328

13211329
ConnectorTypeList:
13221330
allOf:
@@ -1516,7 +1524,7 @@ components:
15161524
description: |-
15171525
Specifies the order by criteria. The syntax of this parameter is
15181526
similar to the syntax of the `order by` clause of an SQL statement.
1519-
Each query can be ordered by any of the `ConnectorType` fields.
1527+
Each query can be ordered by any of the underlying resource fields supported in the search parameter.
15201528
For example, to return all Connector types ordered by their name, use the following syntax:
15211529
15221530
```sql
@@ -1546,8 +1554,16 @@ components:
15461554
Search criteria.
15471555
15481556
The syntax of this parameter is similar to the syntax of the `where` clause of a
1549-
SQL statement. Allowed fields in the search are `name`, `description`, `version`, `label`, and `channel`.
1550-
Allowed operators are `<>`, `=`, or `LIKE`.
1557+
SQL statement.
1558+
1559+
Allowed fields in the search depend on the resource type:
1560+
1561+
* Cluster: id, created_at, updated_at, owner, organisation_id, name, state, client_id
1562+
* Namespace: id, created_at, updated_at, name, cluster_id, owner, expiration, tenant_user_id, tenant_organisation_id, state
1563+
* Connector Types: id, created_at, updated_at, version, name, description, label, channel
1564+
* Connectors: id, created_at, updated_at, name, owner, organisation_id, connector_type_id, desired_state, state, channel, namespace_id, kafka_id, kafka_bootstrap_server, service_account_client_id, schema_registry_id, schema_registry_url
1565+
1566+
Allowed operators are `<>`, `=`, `LIKE`, or `ILIKE`.
15511567
Allowed conjunctive operators are `AND` and `OR`. However, you can use a maximum of 10 conjunctions in a search query.
15521568
15531569
Examples:
@@ -1558,13 +1574,19 @@ components:
15581574
name = aws-sqs-source and channel = stable
15591575
```[p-]
15601576
1561-
To return a Kafka instance with a name that starts with `aws`, use the following syntax:
1577+
To return a connector instance with a name that starts with `aws`, use the following syntax:
15621578
15631579
```
15641580
name like aws%25
15651581
```
15661582
1567-
If the parameter isn't provided, or if the value is empty, then all the Connector Type
1583+
To return a connector type with a name containing `aws` matching any character case combination, use the following syntax:
1584+
1585+
```
1586+
name ilike %25aws%25
1587+
```
1588+
1589+
If the parameter isn't provided, or if the value is empty, then all the resources
15681590
that the user has permission to see are returned.
15691591
15701592
Note. If the query is invalid, an error is returned.
@@ -1719,6 +1741,9 @@ components:
17191741
error_handling:
17201742
dead_letter_queue:
17211743
topic: "dlq"
1744+
service_account:
1745+
client_id: "SA-121212"
1746+
client_secret: "secret"
17221747
ConnectorNamespaceCreateExample:
17231748
value:
17241749
name: "MyNamespace"

packages/connector-management-sdk/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,6 @@ Class | Method | HTTP request | Description
184184
- [ConnectorTypeList](docs/ConnectorTypeList.md)
185185
- [ConnectorTypeListAllOf](docs/ConnectorTypeListAllOf.md)
186186
- [Error](docs/Error.md)
187-
- [ErrorAllOf](docs/ErrorAllOf.md)
188187
- [KafkaConnectionSettings](docs/KafkaConnectionSettings.md)
189188
- [ModelList](docs/ModelList.md)
190189
- [ObjectMeta](docs/ObjectMeta.md)
@@ -211,5 +210,5 @@ It's recommended to create an instance of `ApiClient` per thread in a multithrea
211210

212211
## Author
213212

214-
213+
rhosak-support@redhat.com
215214

0 commit comments

Comments
 (0)