Skip to content

Commit ab87e36

Browse files
ViacheslavKlimovViacheslavKlimov
committed
Update CE OpenAPI spec (from master)
1 parent 455126f commit ab87e36

13 files changed

Lines changed: 888 additions & 150 deletions

‎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/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/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/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
|------|------|-------------|-------|

‎ce/docs/OAuth2ControllerApi.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
```
66
void deleteOauth2Client(@Nonnull UUID id) // Delete oauth2 client (deleteOauth2Client)
7-
PageDataOAuth2ClientInfo findTenantOAuth2ClientInfos(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get OAuth2 Client infos (findTenantOAuth2ClientInfos)
7+
PageDataOAuth2ClientInfo findOAuth2ClientInfos(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get OAuth2 Client infos (findOAuth2ClientInfos)
88
List<OAuth2ClientInfo> findTenantOAuth2ClientInfosByIds(@Nonnull List<String> clientIds) // Get OAuth2 Client infos By Ids (findTenantOAuth2ClientInfosByIds)
99
String getLoginProcessingUrl() // Get OAuth2 log in processing URL (getLoginProcessingUrl)
1010
OAuth2Client getOAuth2ClientById(@Nonnull UUID id) // Get OAuth2 Client by id (getOAuth2ClientById)
@@ -37,15 +37,15 @@ Deletes the oauth2 client. Referencing non-existing oauth2 client Id will cause
3737
null (empty response body)
3838

3939

40-
## findTenantOAuth2ClientInfos
40+
## findOAuth2ClientInfos
4141

4242
```
43-
PageDataOAuth2ClientInfo findTenantOAuth2ClientInfos(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder)
43+
PageDataOAuth2ClientInfo findOAuth2ClientInfos(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder)
4444
```
4545

4646
**GET** `/api/oauth2/client/infos`
4747

48-
Get OAuth2 Client infos (findTenantOAuth2ClientInfos)
48+
Get OAuth2 Client infos (findOAuth2ClientInfos)
4949

5050
Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority.
5151

‎ce/docs/RuleChainData.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ A JSON value representing the rule chains.
4242
| nodes | List<RuleNode> | List of rule node JSON objects | |
4343
| connections | List<NodeConnectionInfo> | List of JSON objects that represent connections between rule nodes | |
4444
| ruleChainConnections | List<RuleChainConnectionInfo> | List of JSON objects that represent connections between rule nodes and other rule chains. | |
45+
| notes | List<RuleChainNote> | List of sticky notes placed on the rule chain canvas | [optional] |
4546

4647
#### RuleChainType (enum)
4748
`CORE` | `EDGE`
@@ -78,6 +79,21 @@ A JSON value representing the rule chains.
7879
| additionalInfo | com.fasterxml.jackson.databind.JsonNode | JSON object with the additional information about the connection. | |
7980
| type | String | Type of the relation. Typically indicated the result of processing by the 'from' rule node. For example, 'Success' or 'Failure' | |
8081

82+
#### RuleChainNote
83+
| Name | Type | Description | Notes |
84+
|------|------|-------------|-------|
85+
| id | String | Unique identifier of the note on the canvas | [optional] |
86+
| x | Integer | Horizontal position of the note on the canvas, in pixels | [optional] |
87+
| y | Integer | Vertical position of the note on the canvas, in pixels | [optional] |
88+
| width | Integer | Width of the note, in pixels | [optional] |
89+
| height | Integer | Height of the note, in pixels | [optional] |
90+
| content | String | Markdown or HTML content of the note | [optional] |
91+
| backgroundColor | String | Background color of the note in CSS hex format, e.g. '#FFF9C4' | [optional] |
92+
| borderColor | String | Border color of the note in CSS hex format, e.g. '#E6C800' | [optional] |
93+
| borderWidth | Integer | Border width of the note in pixels | [optional] |
94+
| applyDefaultMarkdownStyle | Boolean | Whether to apply the default markdown stylesheet to the note content | [optional] |
95+
| markdownCss | String | Custom CSS styles applied to the note content | [optional] |
96+
8197
#### DebugSettings
8298
| Name | Type | Description | Notes |
8399
|------|------|-------------|-------|

‎ce/docs/RuleChainExportData.md‎

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

3940
#### ExportableEntity
4041
| Name | Type | Description | Notes |
@@ -116,6 +117,21 @@
116117
| additionalInfo | com.fasterxml.jackson.databind.JsonNode | JSON object with the additional information about the connection. | |
117118
| type | String | Type of the relation. Typically indicated the result of processing by the 'from' rule node. For example, 'Success' or 'Failure' | |
118119

120+
#### RuleChainNote
121+
| Name | Type | Description | Notes |
122+
|------|------|-------------|-------|
123+
| id | String | Unique identifier of the note on the canvas | [optional] |
124+
| x | Integer | Horizontal position of the note on the canvas, in pixels | [optional] |
125+
| y | Integer | Vertical position of the note on the canvas, in pixels | [optional] |
126+
| width | Integer | Width of the note, in pixels | [optional] |
127+
| height | Integer | Height of the note, in pixels | [optional] |
128+
| content | String | Markdown or HTML content of the note | [optional] |
129+
| backgroundColor | String | Background color of the note in CSS hex format, e.g. '#FFF9C4' | [optional] |
130+
| borderColor | String | Border color of the note in CSS hex format, e.g. '#E6C800' | [optional] |
131+
| borderWidth | Integer | Border width of the note in pixels | [optional] |
132+
| applyDefaultMarkdownStyle | Boolean | Whether to apply the default markdown stylesheet to the note content | [optional] |
133+
| markdownCss | String | Custom CSS styles applied to the note content | [optional] |
134+
119135
#### RelationTypeGroup (enum)
120136
`COMMON` | `DASHBOARD` | `RULE_CHAIN` | `RULE_NODE` | `EDGE` | `EDGE_AUTO_ASSIGN_RULE_CHAIN`
121137

‎ce/docs/RuleChainMetaData.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ A JSON value representing the rule chain metadata.
1515
| **nodes** | **List\<RuleNode\>** | List of rule node JSON objects | |
1616
| **connections** | **List\<NodeConnectionInfo\>** | List of JSON objects that represent connections between rule nodes | |
1717
| **ruleChainConnections** | **List\<RuleChainConnectionInfo\>** | List of JSON objects that represent connections between rule nodes and other rule chains. | |
18+
| **notes** | **List\<RuleChainNote\>** | List of sticky notes placed on the rule chain canvas | [optional] |
1819

1920

2021

@@ -54,6 +55,21 @@ A JSON value representing the rule chain metadata.
5455
| additionalInfo | com.fasterxml.jackson.databind.JsonNode | JSON object with the additional information about the connection. | |
5556
| type | String | Type of the relation. Typically indicated the result of processing by the 'from' rule node. For example, 'Success' or 'Failure' | |
5657

58+
#### RuleChainNote
59+
| Name | Type | Description | Notes |
60+
|------|------|-------------|-------|
61+
| id | String | Unique identifier of the note on the canvas | [optional] |
62+
| x | Integer | Horizontal position of the note on the canvas, in pixels | [optional] |
63+
| y | Integer | Vertical position of the note on the canvas, in pixels | [optional] |
64+
| width | Integer | Width of the note, in pixels | [optional] |
65+
| height | Integer | Height of the note, in pixels | [optional] |
66+
| content | String | Markdown or HTML content of the note | [optional] |
67+
| backgroundColor | String | Background color of the note in CSS hex format, e.g. '#FFF9C4' | [optional] |
68+
| borderColor | String | Border color of the note in CSS hex format, e.g. '#E6C800' | [optional] |
69+
| borderWidth | Integer | Border width of the note in pixels | [optional] |
70+
| applyDefaultMarkdownStyle | Boolean | Whether to apply the default markdown stylesheet to the note content | [optional] |
71+
| markdownCss | String | Custom CSS styles applied to the note content | [optional] |
72+
5773
#### DebugSettings
5874
| Name | Type | Description | Notes |
5975
|------|------|-------------|-------|

‎ce/docs/RuleChainNote.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
2+
# RuleChainNote
3+
4+
`org.thingsboard.client.model.RuleChainNote`
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
| **id** | **String** | Unique identifier of the note on the canvas | [optional] |
11+
| **x** | **Integer** | Horizontal position of the note on the canvas, in pixels | [optional] |
12+
| **y** | **Integer** | Vertical position of the note on the canvas, in pixels | [optional] |
13+
| **width** | **Integer** | Width of the note, in pixels | [optional] |
14+
| **height** | **Integer** | Height of the note, in pixels | [optional] |
15+
| **content** | **String** | Markdown or HTML content of the note | [optional] |
16+
| **backgroundColor** | **String** | Background color of the note in CSS hex format, e.g. '#FFF9C4' | [optional] |
17+
| **borderColor** | **String** | Border color of the note in CSS hex format, e.g. '#E6C800' | [optional] |
18+
| **borderWidth** | **Integer** | Border width of the note in pixels | [optional] |
19+
| **applyDefaultMarkdownStyle** | **Boolean** | Whether to apply the default markdown stylesheet to the note content | [optional] |
20+
| **markdownCss** | **String** | Custom CSS styles applied to the note content | [optional] |
21+
22+
23+
24+
---
25+
26+
### Conventions
27+
28+
- **Package:** `org.thingsboard.client.model`
29+
- **Getter pattern:** `get<PropertyName>()` — e.g., `getId()`, `getName()`
30+
- **Setter pattern:** `set<PropertyName>(value)` — e.g., `setId(value)`, `setName(value)`
31+
- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions
32+

0 commit comments

Comments
 (0)