Skip to content

Commit 71f93b9

Browse files
ViacheslavKlimovViacheslavKlimov
committed
Update PE OpenAPI spec (from master)
1 parent 455126f commit 71f93b9

25 files changed

Lines changed: 1089 additions & 58 deletions

‎pe/docs/CsvReportTemplateConfig.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -829,8 +829,8 @@
829829
| methodName | String | | [optional] |
830830
| fileName | String | | [optional] |
831831
| lineNumber | Integer | | [optional] |
832-
| nativeMethod | Boolean | | [optional] |
833832
| className | String | | [optional] |
833+
| nativeMethod | Boolean | | [optional] |
834834

835835
#### AliasEntityType (enum)
836836
`CURRENT_CUSTOMER` | `CURRENT_TENANT` | `CURRENT_USER` | `CURRENT_USER_OWNER`

‎pe/docs/EntityDataDiff.md‎

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

254255
#### GroupPermission
255256
| Name | Type | Description | Notes |
@@ -333,6 +334,21 @@
333334
| additionalInfo | com.fasterxml.jackson.databind.JsonNode | JSON object with the additional information about the connection. | |
334335
| type | String | Type of the relation. Typically indicated the result of processing by the 'from' rule node. For example, 'Success' or 'Failure' | |
335336

337+
#### RuleChainNote
338+
| Name | Type | Description | Notes |
339+
|------|------|-------------|-------|
340+
| id | String | Unique identifier of the note on the canvas | [optional] |
341+
| x | Integer | Horizontal position of the note on the canvas, in pixels | [optional] |
342+
| y | Integer | Vertical position of the note on the canvas, in pixels | [optional] |
343+
| width | Integer | Width of the note, in pixels | [optional] |
344+
| height | Integer | Height of the note, in pixels | [optional] |
345+
| content | String | Markdown or HTML content of the note | [optional] |
346+
| backgroundColor | String | Background color of the note in CSS hex format, e.g. '#FFF9C4' | [optional] |
347+
| borderColor | String | Border color of the note in CSS hex format, e.g. '#E6C800' | [optional] |
348+
| borderWidth | Integer | Border width of the note in pixels | [optional] |
349+
| applyDefaultMarkdownStyle | Boolean | Whether to apply the default markdown stylesheet to the note content | [optional] |
350+
| markdownCss | String | Custom CSS styles applied to the note content | [optional] |
351+
336352
#### OtaPackageType (enum)
337353
`FIRMWARE` | `SOFTWARE`
338354

‎pe/docs/EntityExportData.md‎

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

195196
#### RelationTypeGroup (enum)
196197
`COMMON` | `DASHBOARD` | `FROM_ENTITY_GROUP` | `RULE_CHAIN` | `RULE_NODE` | `EDGE` | `EDGE_AUTO_ASSIGN_RULE_CHAIN`
@@ -315,6 +316,21 @@ Base export container for ThingsBoard entities
315316
| additionalInfo | com.fasterxml.jackson.databind.JsonNode | JSON object with the additional information about the connection. | |
316317
| type | String | Type of the relation. Typically indicated the result of processing by the 'from' rule node. For example, 'Success' or 'Failure' | |
317318

319+
#### RuleChainNote
320+
| Name | Type | Description | Notes |
321+
|------|------|-------------|-------|
322+
| id | String | Unique identifier of the note on the canvas | [optional] |
323+
| x | Integer | Horizontal position of the note on the canvas, in pixels | [optional] |
324+
| y | Integer | Vertical position of the note on the canvas, in pixels | [optional] |
325+
| width | Integer | Width of the note, in pixels | [optional] |
326+
| height | Integer | Height of the note, in pixels | [optional] |
327+
| content | String | Markdown or HTML content of the note | [optional] |
328+
| backgroundColor | String | Background color of the note in CSS hex format, e.g. '#FFF9C4' | [optional] |
329+
| borderColor | String | Border color of the note in CSS hex format, e.g. '#E6C800' | [optional] |
330+
| borderWidth | Integer | Border width of the note in pixels | [optional] |
331+
| applyDefaultMarkdownStyle | Boolean | Whether to apply the default markdown stylesheet to the note content | [optional] |
332+
| markdownCss | String | Custom CSS styles applied to the note content | [optional] |
333+
318334
#### Output
319335
| Name | Type | Description | Notes |
320336
|------|------|-------------|-------|

‎pe/docs/EntityGroupControllerApi.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ void removeEntitiesFromEntityGroup(@Nonnull String entityGroupId, @Nonnull List<
3737
EntityGroupInfo saveEntityGroup(@Nonnull EntityGroup entityGroup) // Create Or Update Entity Group (saveEntityGroup)
3838
void shareEntityGroup(@Nonnull String entityGroupId, @Nonnull ShareGroupRequest shareGroupRequest) // Share the Entity Group (shareEntityGroup)
3939
void shareEntityGroupToChildOwnerUserGroup(@Nonnull String entityGroupId, @Nonnull String userGroupId, @Nonnull String roleId) // Share the Entity Group with User group (shareEntityGroupToChildOwnerUserGroup)
40+
void shareEntityGroupToChildOwnerUserGroupV2(@Nonnull UUID entityGroupId, @Nonnull ShareGroupRequest shareGroupRequest) // Share the Entity Group with User group (shareEntityGroupToChildOwnerUserGroupV2)
4041
EntityGroup unassignEntityGroupFromEdge(@Nonnull String edgeId, @Nonnull String groupType, @Nonnull String entityGroupId) // Unassign entity group from edge (unassignEntityGroupFromEdge)
4142
```
4243

@@ -945,6 +946,31 @@ Share the entity group with specified user group using specified role. Availab
945946
null (empty response body)
946947

947948

949+
## shareEntityGroupToChildOwnerUserGroupV2
950+
951+
```
952+
void shareEntityGroupToChildOwnerUserGroupV2(@Nonnull UUID entityGroupId, @Nonnull ShareGroupRequest shareGroupRequest)
953+
```
954+
955+
**POST** `/api/v2/entityGroup/{entityGroupId}/share`
956+
957+
Share the Entity Group with User group (shareEntityGroupToChildOwnerUserGroupV2)
958+
959+
Share the entity group with specified user group using specified role. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for specified group.
960+
961+
962+
### Parameters
963+
964+
| Name | Type | Description | Notes |
965+
|------------- | ------------- | ------------- | -------------|
966+
| **entityGroupId** | **UUID** | A uuid value representing the Entity Group Id that you would like to share. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
967+
| **shareGroupRequest** | **ShareGroupRequest** | | |
968+
969+
### Return type
970+
971+
null (empty response body)
972+
973+
948974
## unassignEntityGroupFromEdge
949975

950976
```

‎pe/docs/ErrorComponent.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@
5353
| methodName | String | | [optional] |
5454
| fileName | String | | [optional] |
5555
| lineNumber | Integer | | [optional] |
56-
| nativeMethod | Boolean | | [optional] |
5756
| className | String | | [optional] |
57+
| nativeMethod | Boolean | | [optional] |
5858

5959
---
6060

‎pe/docs/ErrorComponentAllOfException.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@
3333
| methodName | String | | [optional] |
3434
| fileName | String | | [optional] |
3535
| lineNumber | Integer | | [optional] |
36-
| nativeMethod | Boolean | | [optional] |
3736
| className | String | | [optional] |
37+
| nativeMethod | Boolean | | [optional] |
3838

3939
---
4040

‎pe/docs/ErrorComponentAllOfExceptionCause.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@
2424
| methodName | String | | [optional] |
2525
| fileName | String | | [optional] |
2626
| lineNumber | Integer | | [optional] |
27-
| nativeMethod | Boolean | | [optional] |
2827
| className | String | | [optional] |
28+
| nativeMethod | Boolean | | [optional] |
2929

3030
---
3131

‎pe/docs/ErrorComponentAllOfExceptionCauseStackTrace.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313
| **methodName** | **String** | | [optional] |
1414
| **fileName** | **String** | | [optional] |
1515
| **lineNumber** | **Integer** | | [optional] |
16-
| **nativeMethod** | **Boolean** | | [optional] |
1716
| **className** | **String** | | [optional] |
17+
| **nativeMethod** | **Boolean** | | [optional] |
1818

1919

2020

‎pe/docs/HeaderFooter.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -562,8 +562,8 @@
562562
| methodName | String | | [optional] |
563563
| fileName | String | | [optional] |
564564
| lineNumber | Integer | | [optional] |
565-
| nativeMethod | Boolean | | [optional] |
566565
| className | String | | [optional] |
566+
| nativeMethod | Boolean | | [optional] |
567567

568568
#### Aggregation (enum)
569569
`MIN` | `MAX` | `AVG` | `SUM` | `COUNT` | `NONE`

‎pe/docs/PdfReportTemplateConfig.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -848,8 +848,8 @@
848848
| methodName | String | | [optional] |
849849
| fileName | String | | [optional] |
850850
| lineNumber | Integer | | [optional] |
851-
| nativeMethod | Boolean | | [optional] |
852851
| className | String | | [optional] |
852+
| nativeMethod | Boolean | | [optional] |
853853

854854
#### AliasEntityType (enum)
855855
`CURRENT_CUSTOMER` | `CURRENT_TENANT` | `CURRENT_USER` | `CURRENT_USER_OWNER`

0 commit comments

Comments
 (0)