Skip to content

Commit 28775e9

Browse files
ViacheslavKlimovViacheslavKlimov
authored
Merge pull request #36 from thingsboard/auto/update-ce-client-master
Update CE OpenAPI spec (from master)
2 parents f74a19c + 3488f31 commit 28775e9

27 files changed

Lines changed: 1252 additions & 300 deletions

‎ce/docs/AlarmCountQuery.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ A JSON value representing the alarm count query.
1111
|------------ | ------------- | ------------- | -------------|
1212
| **entityFilter** | **EntityFilter** | | [optional] |
1313
| **keyFilters** | **List\<KeyFilter\>** | | [optional] |
14+
| **keyFiltersOperation** | **AlarmRuleComplexOperation** | | [optional] |
1415
| **startTs** | **Long** | | [optional] |
1516
| **endTs** | **Long** | | [optional] |
1617
| **timeWindow** | **Long** | | [optional] |
@@ -19,6 +20,7 @@ A JSON value representing the alarm count query.
1920
| **severityList** | **List\<AlarmSeverity\>** | | [optional] |
2021
| **searchPropagatedAlarms** | **Boolean** | | [optional] |
2122
| **assigneeId** | **UserId** | | [optional] |
23+
| **keyFiltersOperationOrDefault** | **AlarmRuleComplexOperation** | | [optional] |
2224

2325

2426

@@ -156,6 +158,9 @@ A JSON value representing the alarm count query.
156158
| valueType | EntityKeyValueType | | [optional] |
157159
| predicate | KeyFilterPredicate | | [optional] |
158160

161+
#### AlarmRuleComplexOperation (enum)
162+
`AND` | `OR`
163+
159164
#### AlarmSearchStatus (enum)
160165
`ANY` | `ACTIVE` | `CLEARED` | `ACK` | `UNACK`
161166

@@ -185,7 +190,7 @@ A JSON value representing the alarm count query.
185190
#### ComplexFilterPredicate *(extends KeyFilterPredicate, type=`COMPLEX`)*
186191
| Name | Type | Description | Notes |
187192
|------|------|-------------|-------|
188-
| operation | ComplexOperation | | [optional] |
193+
| operation | AlarmRuleComplexOperation | | [optional] |
189194
| predicates | List<KeyFilterPredicate> | | [optional] |
190195

191196
#### NumericFilterPredicate *(extends KeyFilterPredicate, type=`NUMERIC`)*
@@ -257,9 +262,6 @@ A JSON value representing the alarm count query.
257262
| userValue | Boolean | | [optional] |
258263
| dynamicValue | DynamicValueBoolean | | [optional] |
259264

260-
#### ComplexOperation (enum)
261-
`AND` | `OR`
262-
263265
#### DynamicValueString
264266
| Name | Type | Description | Notes |
265267
|------|------|-------------|-------|

‎ce/docs/AlarmDataQuery.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,12 @@ A JSON value representing the alarm data query. See API call notes above for mor
1111
|------------ | ------------- | ------------- | -------------|
1212
| **entityFilter** | **EntityFilter** | | [optional] |
1313
| **keyFilters** | **List\<KeyFilter\>** | | [optional] |
14+
| **keyFiltersOperation** | **AlarmRuleComplexOperation** | | [optional] |
1415
| **pageLink** | **AlarmDataPageLink** | | [optional] |
1516
| **entityFields** | **List\<EntityKey\>** | | [optional] |
1617
| **latestValues** | **List\<EntityKey\>** | | [optional] |
1718
| **alarmFields** | **List\<EntityKey\>** | | [optional] |
19+
| **keyFiltersOperationOrDefault** | **AlarmRuleComplexOperation** | | [optional] |
1820

1921

2022

@@ -152,6 +154,9 @@ A JSON value representing the alarm data query. See API call notes above for mor
152154
| valueType | EntityKeyValueType | | [optional] |
153155
| predicate | KeyFilterPredicate | | [optional] |
154156

157+
#### AlarmRuleComplexOperation (enum)
158+
`AND` | `OR`
159+
155160
#### AlarmDataPageLink
156161
| Name | Type | Description | Notes |
157162
|------|------|-------------|-------|
@@ -192,7 +197,7 @@ A JSON value representing the alarm data query. See API call notes above for mor
192197
#### ComplexFilterPredicate *(extends KeyFilterPredicate, type=`COMPLEX`)*
193198
| Name | Type | Description | Notes |
194199
|------|------|-------------|-------|
195-
| operation | ComplexOperation | | [optional] |
200+
| operation | AlarmRuleComplexOperation | | [optional] |
196201
| predicates | List<KeyFilterPredicate> | | [optional] |
197202

198203
#### NumericFilterPredicate *(extends KeyFilterPredicate, type=`NUMERIC`)*
@@ -279,9 +284,6 @@ A JSON value representing the alarm data query. See API call notes above for mor
279284
| userValue | Boolean | | [optional] |
280285
| dynamicValue | DynamicValueBoolean | | [optional] |
281286

282-
#### ComplexOperation (enum)
283-
`AND` | `OR`
284-
285287
#### DynamicValueString
286288
| Name | Type | Description | Notes |
287289
|------|------|-------------|-------|

‎ce/docs/AssetControllerApi.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ PageDataAsset getEdgeAssets(@Nonnull String edgeId, @Nonnull Integer pageSize, @
1818
Asset getTenantAssetByName(@Nonnull String assetName) // Get Tenant Asset (getTenantAssetByName)
1919
PageDataAssetInfo getTenantAssetInfos(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String type, @Nullable String assetProfileId, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get Tenant Asset Infos (getTenantAssetInfos)
2020
PageDataAsset getTenantAssets(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String type, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get Tenant Assets (getTenantAssets)
21-
BulkImportResultAsset processAssetsBulkImport(@Nonnull BulkImportRequest bulkImportRequest) // Import the bulk of assets (processAssetsBulkImport)
21+
BulkImportResultAsset processAssetBulkImport(@Nonnull BulkImportRequest bulkImportRequest) // Import the bulk of assets (processAssetBulkImport)
2222
Asset saveAsset(@Nonnull Asset asset, @Nullable NameConflictPolicy nameConflictPolicy, @Nullable String uniquifySeparator, @Nullable UniquifyStrategy uniquifyStrategy) // Create Or Update Asset (saveAsset)
2323
Asset unassignAssetFromCustomer(@Nonnull String assetId) // Unassign asset from customer (unassignAssetFromCustomer)
2424
Asset unassignAssetFromEdge(@Nonnull String edgeId, @Nonnull String assetId) // Unassign asset from edge (unassignAssetFromEdge)
@@ -412,15 +412,15 @@ Returns a page of assets owned by tenant. You can specify parameters to filter t
412412
**PageDataAsset**
413413

414414

415-
## processAssetsBulkImport
415+
## processAssetBulkImport
416416

417417
```
418-
BulkImportResultAsset processAssetsBulkImport(@Nonnull BulkImportRequest bulkImportRequest)
418+
BulkImportResultAsset processAssetBulkImport(@Nonnull BulkImportRequest bulkImportRequest)
419419
```
420420

421421
**POST** `/api/asset/bulk_import`
422422

423-
Import the bulk of assets (processAssetsBulkImport)
423+
Import the bulk of assets (processAssetBulkImport)
424424

425425
There's an ability to import the bulk of assets using the only .csv file.
426426

‎ce/docs/ComplexFilterPredicate.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
| Name | Type | Description | Notes |
1111
|------------ | ------------- | ------------- | -------------|
12-
| **operation** | **ComplexOperation** | | [optional] |
12+
| **operation** | **AlarmRuleComplexOperation** | | [optional] |
1313
| **predicates** | **List\<KeyFilterPredicate\>** | | [optional] |
1414

1515

@@ -21,7 +21,7 @@
2121
|------|------|-------------|-------|
2222
| type | String | | |
2323

24-
#### ComplexOperation (enum)
24+
#### AlarmRuleComplexOperation (enum)
2525
`AND` | `OR`
2626

2727
---

‎ce/docs/ComplexOperation.md‎

Lines changed: 0 additions & 23 deletions
This file was deleted.

‎ce/docs/DomainControllerApi.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
```
66
void deleteDomain(@Nonnull UUID id) // Delete Domain by ID (deleteDomain)
77
DomainInfo getDomainInfoById(@Nonnull UUID id) // Get Domain info by Id (getDomainInfoById)
8-
PageDataDomainInfo getTenantDomainInfos(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get Domain infos (getTenantDomainInfos)
8+
PageDataDomainInfo getDomainInfos(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get Domain infos (getDomainInfos)
99
Domain saveDomain(@Nonnull Domain domain, @Nullable List<String> oauth2ClientIds) // Save or Update Domain (saveDomain)
1010
void updateDomainOauth2Clients(@Nonnull UUID id, @Nonnull List<UUID> UUID) // Update oauth2 clients (updateDomainOauth2Clients)
1111
```
@@ -59,15 +59,15 @@ Get Domain info by Id (getDomainInfoById)
5959
**DomainInfo**
6060

6161

62-
## getTenantDomainInfos
62+
## getDomainInfos
6363

6464
```
65-
PageDataDomainInfo getTenantDomainInfos(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder)
65+
PageDataDomainInfo getDomainInfos(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder)
6666
```
6767

6868
**GET** `/api/domain/infos`
6969

70-
Get Domain infos (getTenantDomainInfos)
70+
Get Domain infos (getDomainInfos)
7171

7272
Available for users with 'SYS_ADMIN' authority.
7373

‎ce/docs/EntityCountQuery.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ A JSON value representing the entity count query. See API call notes above for m
1111
|------------ | ------------- | ------------- | -------------|
1212
| **entityFilter** | **EntityFilter** | | [optional] |
1313
| **keyFilters** | **List\<KeyFilter\>** | | [optional] |
14+
| **keyFiltersOperation** | **AlarmRuleComplexOperation** | | [optional] |
15+
| **keyFiltersOperationOrDefault** | **AlarmRuleComplexOperation** | | [optional] |
1416

1517

1618

@@ -148,6 +150,9 @@ A JSON value representing the entity count query. See API call notes above for m
148150
| valueType | EntityKeyValueType | | [optional] |
149151
| predicate | KeyFilterPredicate | | [optional] |
150152

153+
#### AlarmRuleComplexOperation (enum)
154+
`AND` | `OR`
155+
151156
#### EntityKey
152157
| Name | Type | Description | Notes |
153158
|------|------|-------------|-------|
@@ -171,7 +176,7 @@ A JSON value representing the entity count query. See API call notes above for m
171176
#### ComplexFilterPredicate *(extends KeyFilterPredicate, type=`COMPLEX`)*
172177
| Name | Type | Description | Notes |
173178
|------|------|-------------|-------|
174-
| operation | ComplexOperation | | [optional] |
179+
| operation | AlarmRuleComplexOperation | | [optional] |
175180
| predicates | List<KeyFilterPredicate> | | [optional] |
176181

177182
#### NumericFilterPredicate *(extends KeyFilterPredicate, type=`NUMERIC`)*
@@ -243,9 +248,6 @@ A JSON value representing the entity count query. See API call notes above for m
243248
| userValue | Boolean | | [optional] |
244249
| dynamicValue | DynamicValueBoolean | | [optional] |
245250

246-
#### ComplexOperation (enum)
247-
`AND` | `OR`
248-
249251
#### DynamicValueString
250252
| Name | Type | Description | Notes |
251253
|------|------|-------------|-------|

‎ce/docs/EntityDataDiff.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,7 @@
227227
| nodes | List<RuleNode> | List of rule node JSON objects | |
228228
| connections | List<NodeConnectionInfo> | List of JSON objects that represent connections between rule nodes | |
229229
| ruleChainConnections | List<RuleChainConnectionInfo> | List of JSON objects that represent connections between rule nodes and other rule chains. | |
230+
| notes | List<RuleChainNote> | List of sticky notes placed on the rule chain canvas | [optional] |
230231

231232
#### Output
232233
| Name | Type | Description | Notes |
@@ -287,6 +288,21 @@
287288
| additionalInfo | com.fasterxml.jackson.databind.JsonNode | JSON object with the additional information about the connection. | |
288289
| type | String | Type of the relation. Typically indicated the result of processing by the 'from' rule node. For example, 'Success' or 'Failure' | |
289290

291+
#### RuleChainNote
292+
| Name | Type | Description | Notes |
293+
|------|------|-------------|-------|
294+
| id | String | Unique identifier of the note on the canvas | [optional] |
295+
| x | Integer | Horizontal position of the note on the canvas, in pixels | [optional] |
296+
| y | Integer | Vertical position of the note on the canvas, in pixels | [optional] |
297+
| width | Integer | Width of the note, in pixels | [optional] |
298+
| height | Integer | Height of the note, in pixels | [optional] |
299+
| content | String | Markdown or HTML content of the note | [optional] |
300+
| backgroundColor | String | Background color of the note in CSS hex format, e.g. '#FFF9C4' | [optional] |
301+
| borderColor | String | Border color of the note in CSS hex format, e.g. '#E6C800' | [optional] |
302+
| borderWidth | Integer | Border width of the note in pixels | [optional] |
303+
| applyDefaultMarkdownStyle | Boolean | Whether to apply the default markdown stylesheet to the note content | [optional] |
304+
| markdownCss | String | Custom CSS styles applied to the note content | [optional] |
305+
290306
#### AttributeScope (enum)
291307
`CLIENT_SCOPE` | `SERVER_SCOPE` | `SHARED_SCOPE`
292308

‎ce/docs/EntityDataQuery.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,11 @@ Entity data query to find entities. Page size is capped at 100.
1111
|------------ | ------------- | ------------- | -------------|
1212
| **entityFilter** | **EntityFilter** | | [optional] |
1313
| **keyFilters** | **List\<KeyFilter\>** | | [optional] |
14+
| **keyFiltersOperation** | **AlarmRuleComplexOperation** | | [optional] |
1415
| **pageLink** | **EntityDataPageLink** | | [optional] |
1516
| **entityFields** | **List\<EntityKey\>** | | [optional] |
1617
| **latestValues** | **List\<EntityKey\>** | | [optional] |
18+
| **keyFiltersOperationOrDefault** | **AlarmRuleComplexOperation** | | [optional] |
1719

1820

1921

@@ -151,6 +153,9 @@ Entity data query to find entities. Page size is capped at 100.
151153
| valueType | EntityKeyValueType | | [optional] |
152154
| predicate | KeyFilterPredicate | | [optional] |
153155

156+
#### AlarmRuleComplexOperation (enum)
157+
`AND` | `OR`
158+
154159
#### EntityDataPageLink
155160
| Name | Type | Description | Notes |
156161
|------|------|-------------|-------|
@@ -183,7 +188,7 @@ Entity data query to find entities. Page size is capped at 100.
183188
#### ComplexFilterPredicate *(extends KeyFilterPredicate, type=`COMPLEX`)*
184189
| Name | Type | Description | Notes |
185190
|------|------|-------------|-------|
186-
| operation | ComplexOperation | | [optional] |
191+
| operation | AlarmRuleComplexOperation | | [optional] |
187192
| predicates | List<KeyFilterPredicate> | | [optional] |
188193

189194
#### NumericFilterPredicate *(extends KeyFilterPredicate, type=`NUMERIC`)*
@@ -264,9 +269,6 @@ Entity data query to find entities. Page size is capped at 100.
264269
| userValue | Boolean | | [optional] |
265270
| dynamicValue | DynamicValueBoolean | | [optional] |
266271

267-
#### ComplexOperation (enum)
268-
`AND` | `OR`
269-
270272
#### DynamicValueString
271273
| Name | Type | Description | Notes |
272274
|------|------|-------------|-------|

‎ce/docs/EntityExportData.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,7 @@ Base export container for ThingsBoard entities
146146
| nodes | List<RuleNode> | List of rule node JSON objects | |
147147
| connections | List<NodeConnectionInfo> | List of JSON objects that represent connections between rule nodes | |
148148
| ruleChainConnections | List<RuleChainConnectionInfo> | List of JSON objects that represent connections between rule nodes and other rule chains. | |
149+
| notes | List<RuleChainNote> | List of sticky notes placed on the rule chain canvas | [optional] |
149150

150151
#### RelationTypeGroup (enum)
151152
`COMMON` | `DASHBOARD` | `RULE_CHAIN` | `RULE_NODE` | `EDGE` | `EDGE_AUTO_ASSIGN_RULE_CHAIN`
@@ -266,6 +267,21 @@ Base export container for ThingsBoard entities
266267
| additionalInfo | com.fasterxml.jackson.databind.JsonNode | JSON object with the additional information about the connection. | |
267268
| type | String | Type of the relation. Typically indicated the result of processing by the 'from' rule node. For example, 'Success' or 'Failure' | |
268269

270+
#### RuleChainNote
271+
| Name | Type | Description | Notes |
272+
|------|------|-------------|-------|
273+
| id | String | Unique identifier of the note on the canvas | [optional] |
274+
| x | Integer | Horizontal position of the note on the canvas, in pixels | [optional] |
275+
| y | Integer | Vertical position of the note on the canvas, in pixels | [optional] |
276+
| width | Integer | Width of the note, in pixels | [optional] |
277+
| height | Integer | Height of the note, in pixels | [optional] |
278+
| content | String | Markdown or HTML content of the note | [optional] |
279+
| backgroundColor | String | Background color of the note in CSS hex format, e.g. '#FFF9C4' | [optional] |
280+
| borderColor | String | Border color of the note in CSS hex format, e.g. '#E6C800' | [optional] |
281+
| borderWidth | Integer | Border width of the note in pixels | [optional] |
282+
| applyDefaultMarkdownStyle | Boolean | Whether to apply the default markdown stylesheet to the note content | [optional] |
283+
| markdownCss | String | Custom CSS styles applied to the note content | [optional] |
284+
269285
#### Output
270286
| Name | Type | Description | Notes |
271287
|------|------|-------------|-------|

0 commit comments

Comments
 (0)