Skip to content

Commit 29c9c03

Browse files
secondsunwtrocki
authored andcommitted
chore: regenerating with fixed pom versions
1 parent e70a00b commit 29c9c03

30 files changed

Lines changed: 525 additions & 421 deletions

File tree

docs/CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## Contributing to the SDK
2+
3+
### Generating the API
4+
5+
The main API classes of the SDK are auto generated using the command `make generate`.
6+
7+
### Building and Testing Locally
8+
9+
To build the SDK locally run `mvn clean install` from the root directory.
10+
11+
### Troubleshooting
12+
13+
#### Error "No <dockerHost> given" message when testing
14+
15+
The sdk-tests package uses a container `quay.io/rhosak/api-mock` to emulate the data plane services. Therefore, to run the tests the host system needs a Docker compatible daemon running with a socker exposed using the `DOCKER_HOST` environment variable.
16+
17+
To set up the variable using [Podman](https://podman.io) run the following commands :
18+
```
19+
podman system service -t 0 &
20+
export DOCKER_HOST=unix:///var/run/user/$(id -u)/podman/podman.sock
21+
```

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,4 @@
1717

1818
- [Authentication](./authentication.md)
1919
- [API stability](./apilevels.md)
20+
- [Contributing](./CONTRIBUTING.md)

packages/connector-management-sdk/README.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,6 @@ import com.openshift.cloud.api.connector.invoker.*;
7676
import com.openshift.cloud.api.connector.invoker.auth.*;
7777
import com.openshift.cloud.api.connector.models.*;
7878
import com.openshift.cloud.api.connector.ConnectorClustersApi;
79-
import com.openshift.cloud.api.connector.ApiErrorType;
8079

8180
public class ConnectorClustersApiExample {
8281

@@ -99,8 +98,6 @@ public class ConnectorClustersApiExample {
9998
System.err.println("Status code: " + e.getCode());
10099
System.err.println("Reason: " + e.getResponseBody());
101100
System.err.println("Response headers: " + e.getResponseHeaders());
102-
// TODO
103-
if(ApiErrorType.)
104101
e.printStackTrace();
105102
}
106103
}
@@ -132,10 +129,8 @@ Class | Method | HTTP request | Description
132129
## Documentation for Models
133130

134131
- [AddonClusterTarget](docs/AddonClusterTarget.md)
135-
- [AddonClusterTargetAllOf](docs/AddonClusterTargetAllOf.md)
136132
- [AddonParameter](docs/AddonParameter.md)
137133
- [CloudProviderClusterTarget](docs/CloudProviderClusterTarget.md)
138-
- [CloudProviderClusterTargetAllOf](docs/CloudProviderClusterTargetAllOf.md)
139134
- [ClusterTarget](docs/ClusterTarget.md)
140135
- [Connector](docs/Connector.md)
141136
- [ConnectorAllOf](docs/ConnectorAllOf.md)

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

Lines changed: 87 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,69 @@ paths:
9595
schema:
9696
type: string
9797
style: form
98+
- description: |-
99+
Specifies the order by criteria. The syntax of this parameter is
100+
similar to the syntax of the `order by` clause of an SQL statement.
101+
Each query can be ordered by any of the `ConnectorType` fields.
102+
For example, to return all Connector types ordered by their name, use the following syntax:
103+
104+
```sql
105+
name asc
106+
```
107+
108+
To return all Connector types ordered by their name _and_ version, use the following syntax:
109+
110+
```sql
111+
name asc, version asc
112+
```
113+
114+
If the parameter isn't provided, or if the value is empty, then
115+
the results are ordered by name.
116+
examples:
117+
orderBy:
118+
value: name asc
119+
explode: true
120+
in: query
121+
name: orderBy
122+
required: false
123+
schema:
124+
type: string
125+
style: form
126+
- description: |
127+
Search criteria.
128+
129+
The syntax of this parameter is similar to the syntax of the `where` clause of a
130+
SQL statement. Allowed fields in the search are `name`, `description`, `version`, `label`, and `channel`. Allowed operators are `<>`, `=`, or `LIKE`.
131+
Allowed conjunctive operators are `AND` and `OR`. However, you can use a maximum of 10 conjunctions in a search query.
132+
133+
Examples:
134+
135+
To return a Connector Type with the name `aws-sqs-source` and the channel `stable`, use the following syntax:
136+
137+
```
138+
name = aws-sqs-source and channel = stable
139+
```[p-]
140+
141+
To return a Kafka instance with a name that starts with `aws`, use the following syntax:
142+
143+
```
144+
name like aws%25
145+
```
146+
147+
If the parameter isn't provided, or if the value is empty, then all the Connector Type
148+
that the user has permission to see are returned.
149+
150+
Note. If the query is invalid, an error is returned.
151+
examples:
152+
search:
153+
value: name = aws-sqs-source and channel = stable
154+
explode: true
155+
in: query
156+
name: search
157+
required: false
158+
schema:
159+
type: string
160+
style: form
98161
responses:
99162
"200":
100163
content:
@@ -964,10 +1027,15 @@ components:
9641027
- $ref: '#/components/schemas/ObjectReference'
9651028
- $ref: '#/components/schemas/ConnectorType_allOf'
9661029
description: Represents a connector type supported by the API
967-
required:
968-
- json_schema
969-
- name
970-
- version
1030+
oneOf:
1031+
- required:
1032+
- name
1033+
- schema
1034+
- version
1035+
- required:
1036+
- json_schema
1037+
- name
1038+
- version
9711039
ConnectorTypeList:
9721040
allOf:
9731041
- $ref: '#/components/schemas/List'
@@ -995,35 +1063,32 @@ components:
9951063
addon: '#/components/schemas/AddonClusterTarget'
9961064
cloud_provider: '#/components/schemas/CloudProviderClusterTarget'
9971065
propertyName: kind
998-
properties:
999-
kind:
1000-
type: string
1001-
required:
1002-
- kind
1003-
type: object
1066+
oneOf:
1067+
- $ref: '#/components/schemas/AddonClusterTarget'
1068+
- $ref: '#/components/schemas/CloudProviderClusterTarget'
10041069
AddonClusterTarget:
1005-
allOf:
1006-
- $ref: '#/components/schemas/ClusterTarget'
1007-
- $ref: '#/components/schemas/AddonClusterTarget_allOf'
1008-
AddonClusterTarget_allOf:
10091070
description: Targets workloads to an addon cluster
10101071
properties:
1072+
kind:
1073+
type: string
10111074
cluster_id:
10121075
type: string
1076+
required:
1077+
- kind
10131078
type: object
10141079
CloudProviderClusterTarget:
1015-
allOf:
1016-
- $ref: '#/components/schemas/ClusterTarget'
1017-
- $ref: '#/components/schemas/CloudProviderClusterTarget_allOf'
1018-
CloudProviderClusterTarget_allOf:
10191080
description: Targets workloads to a cloud provider
10201081
properties:
1082+
kind:
1083+
type: string
10211084
cloud_provider:
10221085
type: string
10231086
region:
10241087
type: string
10251088
multi_az:
10261089
type: boolean
1090+
required:
1091+
- kind
10271092
type: object
10281093
AddonParameterList:
10291094
description: A list of addon parameters
@@ -1115,6 +1180,10 @@ components:
11151180
- source
11161181
type: string
11171182
type: array
1183+
schema:
1184+
description: A json schema that can be used to validate a connectors connector_spec
1185+
field.
1186+
type: object
11181187
json_schema:
11191188
description: A json schema that can be used to validate a connectors connector_spec
11201189
field.

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22

33
# AddonClusterTarget
44

5+
Targets workloads to an addon cluster
56

67
## Properties
78

89
Name | Type | Description | Notes
910
------------ | ------------- | ------------- | -------------
11+
**kind** | **String** | |
1012
**clusterId** | **String** | | [optional]
1113

1214

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22

33
# CloudProviderClusterTarget
44

5+
Targets workloads to a cloud provider
56

67
## Properties
78

89
Name | Type | Description | Notes
910
------------ | ------------- | ------------- | -------------
11+
**kind** | **String** | |
1012
**cloudProvider** | **String** | | [optional]
1113
**region** | **String** | | [optional]
1214
**multiAz** | **Boolean** | | [optional]

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@
88
Name | Type | Description | Notes
99
------------ | ------------- | ------------- | -------------
1010
**kind** | **String** | |
11+
**clusterId** | **String** | | [optional]
12+
**cloudProvider** | **String** | | [optional]
13+
**region** | **String** | | [optional]
14+
**multiAz** | **Boolean** | | [optional]
1115

1216

1317

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,14 @@ Name | Type | Description | Notes
1111
**id** | **String** | | [optional]
1212
**kind** | **String** | | [optional]
1313
**href** | **String** | | [optional]
14-
**name** | **String** | Name of the connector type. |
15-
**version** | **String** | Version of the connector type. |
14+
**name** | **String** | Name of the connector type. | [optional]
15+
**version** | **String** | Version of the connector type. | [optional]
1616
**channels** | **List&lt;String&gt;** | Channels of the connector type. | [optional]
1717
**description** | **String** | A description of the connector. | [optional]
1818
**iconHref** | **String** | URL to an icon of the connector. | [optional]
1919
**labels** | [**List&lt;LabelsEnum&gt;**](#List&lt;LabelsEnum&gt;) | Labels used to categorize the connector | [optional]
20-
**jsonSchema** | **Object** | A json schema that can be used to validate a connectors connector_spec field. |
20+
**schema** | **Object** | A json schema that can be used to validate a connectors connector_spec field. | [optional]
21+
**jsonSchema** | **Object** | A json schema that can be used to validate a connectors connector_spec field. | [optional]
2122

2223

2324

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
1313
**description** | **String** | A description of the connector. | [optional]
1414
**iconHref** | **String** | URL to an icon of the connector. | [optional]
1515
**labels** | [**List&lt;LabelsEnum&gt;**](#List&lt;LabelsEnum&gt;) | Labels used to categorize the connector | [optional]
16+
**schema** | **Object** | A json schema that can be used to validate a connectors connector_spec field. | [optional]
1617
**jsonSchema** | **Object** | A json schema that can be used to validate a connectors connector_spec field. | [optional]
1718

1819

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Name | Type | Description | Notes
8383

8484
## listConnectorTypes
8585

86-
> ConnectorTypeList listConnectorTypes(page, size)
86+
> ConnectorTypeList listConnectorTypes(page, size, orderBy, search)
8787
8888
Returns a list of connector types
8989

@@ -110,8 +110,10 @@ public class Example {
110110
ConnectorTypesApi apiInstance = new ConnectorTypesApi(defaultClient);
111111
String page = "1"; // String | Page index
112112
String size = "100"; // String | Number of items in each page
113+
String orderBy = "name asc"; // String | Specifies the order by criteria. The syntax of this parameter is similar to the syntax of the `order by` clause of an SQL statement. Each query can be ordered by any of the `ConnectorType` fields. For example, to return all Connector types ordered by their name, use the following syntax: ```sql name asc ``` To return all Connector types ordered by their name _and_ version, use the following syntax: ```sql name asc, version asc ``` If the parameter isn't provided, or if the value is empty, then the results are ordered by name.
114+
String search = "name = aws-sqs-source and channel = stable"; // String | Search criteria. The syntax of this parameter is similar to the syntax of the `where` clause of a SQL statement. Allowed fields in the search are `name`, `description`, `version`, `label`, and `channel`. Allowed operators are `<>`, `=`, or `LIKE`. Allowed conjunctive operators are `AND` and `OR`. However, you can use a maximum of 10 conjunctions in a search query. Examples: To return a Connector Type with the name `aws-sqs-source` and the channel `stable`, use the following syntax: ``` name = aws-sqs-source and channel = stable ```[p-] To return a Kafka instance with a name that starts with `aws`, use the following syntax: ``` name like aws%25 ``` If the parameter isn't provided, or if the value is empty, then all the Connector Type that the user has permission to see are returned. Note. If the query is invalid, an error is returned.
113115
try {
114-
ConnectorTypeList result = apiInstance.listConnectorTypes(page, size);
116+
ConnectorTypeList result = apiInstance.listConnectorTypes(page, size, orderBy, search);
115117
System.out.println(result);
116118
} catch (ApiException e) {
117119
System.err.println("Exception when calling ConnectorTypesApi#listConnectorTypes");
@@ -131,6 +133,8 @@ Name | Type | Description | Notes
131133
------------- | ------------- | ------------- | -------------
132134
**page** | **String**| Page index | [optional]
133135
**size** | **String**| Number of items in each page | [optional]
136+
**orderBy** | **String**| Specifies the order by criteria. The syntax of this parameter is similar to the syntax of the &#x60;order by&#x60; clause of an SQL statement. Each query can be ordered by any of the &#x60;ConnectorType&#x60; fields. For example, to return all Connector types ordered by their name, use the following syntax: &#x60;&#x60;&#x60;sql name asc &#x60;&#x60;&#x60; To return all Connector types ordered by their name _and_ version, use the following syntax: &#x60;&#x60;&#x60;sql name asc, version asc &#x60;&#x60;&#x60; If the parameter isn&#39;t provided, or if the value is empty, then the results are ordered by name. | [optional]
137+
**search** | **String**| Search criteria. The syntax of this parameter is similar to the syntax of the &#x60;where&#x60; clause of a SQL statement. Allowed fields in the search are &#x60;name&#x60;, &#x60;description&#x60;, &#x60;version&#x60;, &#x60;label&#x60;, and &#x60;channel&#x60;. Allowed operators are &#x60;&lt;&gt;&#x60;, &#x60;&#x3D;&#x60;, or &#x60;LIKE&#x60;. Allowed conjunctive operators are &#x60;AND&#x60; and &#x60;OR&#x60;. However, you can use a maximum of 10 conjunctions in a search query. Examples: To return a Connector Type with the name &#x60;aws-sqs-source&#x60; and the channel &#x60;stable&#x60;, use the following syntax: &#x60;&#x60;&#x60; name &#x3D; aws-sqs-source and channel &#x3D; stable &#x60;&#x60;&#x60;[p-] To return a Kafka instance with a name that starts with &#x60;aws&#x60;, use the following syntax: &#x60;&#x60;&#x60; name like aws%25 &#x60;&#x60;&#x60; If the parameter isn&#39;t provided, or if the value is empty, then all the Connector Type that the user has permission to see are returned. Note. If the query is invalid, an error is returned. | [optional]
134138

135139
### Return type
136140

0 commit comments

Comments
 (0)