Skip to content

Commit 71a203a

Browse files
Merge pull request #68 from thingsboard/auto/update-pe-client-master
Update PE OpenAPI spec in master (from master)
2 parents 4bbde17 + 4e15820 commit 71a203a

41 files changed

Lines changed: 1057 additions & 68 deletions

Some content is hidden

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

‎pe/docs/AiChatControllerApi.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ com.fasterxml.jackson.databind.JsonNode createChat(@Nonnull Object body) // crea
77
void deleteChat(@Nonnull UUID chatId) // deleteChat
88
com.fasterxml.jackson.databind.JsonNode getChatMessages(@Nonnull UUID chatId) // getChatMessages
99
com.fasterxml.jackson.databind.JsonNode listChats(@Nonnull ChatType chatType) // listChats
10-
List<Object> sendChatMessage(@Nonnull UUID chatId, @Nonnull String xAuthorization, @Nonnull String body, @Nullable String acceptLanguage) // sendChatMessage
10+
List<Object> sendChatMessage(@Nonnull UUID chatId, @Nonnull String xAuthorization, @Nonnull Object body, @Nullable String acceptLanguage) // sendChatMessage
1111
void updateChat(@Nonnull UUID chatId, @Nonnull Object body) // updateChat
1212
```
1313

@@ -103,7 +103,7 @@ listChats
103103
## sendChatMessage
104104

105105
```
106-
List<Object> sendChatMessage(@Nonnull UUID chatId, @Nonnull String xAuthorization, @Nonnull String body, @Nullable String acceptLanguage)
106+
List<Object> sendChatMessage(@Nonnull UUID chatId, @Nonnull String xAuthorization, @Nonnull Object body, @Nullable String acceptLanguage)
107107
```
108108

109109
**POST** `/api/ai/chats/{chatId}/messages`
@@ -117,7 +117,7 @@ sendChatMessage
117117
|------------- | ------------- | ------------- | -------------|
118118
| **chatId** | **UUID** | | |
119119
| **xAuthorization** | **String** | | |
120-
| **body** | **String** | | |
120+
| **body** | **Object** | | |
121121
| **acceptLanguage** | **String** | | [optional] |
122122

123123
### Return type

‎pe/docs/AlarmControllerApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -370,7 +370,7 @@ Alarm saveAlarm(@Nonnull Alarm alarm)
370370

371371
Create or Update Alarm (saveAlarm)
372372

373-
Creates or Updates the Alarm. When creating alarm, platform generates Alarm Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Alarm id will be present in the response. Specify existing Alarm id to update the alarm. Referencing non-existing Alarm Id will cause 'Not Found' error. Platform also deduplicate the alarms based on the entity id of originator and alarm 'type'. For example, if the user or system component create the alarm with the type 'HighTemperature' for device 'Device A' the new active alarm is created. If the user tries to create 'HighTemperature' alarm for the same device again, the previous alarm will be updated (the 'end_ts' will be set to current timestamp). If the user clears the alarm (see 'Clear Alarm(clearAlarm)'), than new alarm with the same type and same device may be created. Remove 'id', 'tenantId' and optionally 'customerId' from the request body example (below) to create new Alarm entity. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for the entity (entities).
373+
Creates or Updates the Alarm. When creating alarm, platform generates Alarm Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Alarm id will be present in the response. Specify existing Alarm id to update the alarm. Referencing non-existing Alarm Id will cause 'Not Found' error. Platform also deduplicate the alarms based on the entity id of originator and alarm 'type'. For example, if the user or system component create the alarm with the type 'HighTemperature' for device 'Device A' the new active alarm is created. If the user tries to create 'HighTemperature' alarm for the same device again, the previous alarm will be updated (the 'end_ts' will be set to current timestamp). If the user clears the alarm (see 'Clear Alarm(clearAlarm)'), than new alarm with the same type and same device may be created. Remove 'id', 'tenantId' and optionally 'customerId' from the request body example (below) to create new Alarm entity. The alarm originator is an immutable routing key: when updating an existing alarm, the 'originator' in the request body must match the stored alarm's originator. A request that references an existing alarm id but carries a different originator is treated as a lookup miss and causes a 'Not Found' error. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for the entity (entities).
374374

375375

376376
### Parameters

‎pe/docs/Dashboard.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
| **assignedCustomers** | **Set\<ShortCustomerInfo\>** | List of assigned customers with their info. | [optional] |
1919
| **mobileHide** | **Boolean** | Hide dashboard from mobile devices. Useful if the dashboard is not designed for small screens. | [optional] [readonly] |
2020
| **mobileOrder** | **Integer** | Order on mobile devices. Useful to adjust sorting of the dashboards for mobile applications | [optional] [readonly] |
21-
| **_configuration** | **com.fasterxml.jackson.databind.JsonNode** | | [optional] |
21+
| **_configuration** | **com.fasterxml.jackson.databind.JsonNode** | JSON object with main configuration of the dashboard: layouts, widgets, aliases, etc. The JSON structure of the dashboard configuration is quite complex. The easiest way to learn it is to export existing dashboard to JSON. | [optional] |
2222
| **resources** | **List\<ResourceExportData\>** | | [optional] |
2323
| **version** | **Long** | | [optional] |
2424

‎pe/docs/DashboardInfo.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
| **assignedCustomers** | **Set\<ShortCustomerInfo\>** | List of assigned customers with their info. | [optional] |
1919
| **mobileHide** | **Boolean** | Hide dashboard from mobile devices. Useful if the dashboard is not designed for small screens. | [optional] [readonly] |
2020
| **mobileOrder** | **Integer** | Order on mobile devices. Useful to adjust sorting of the dashboards for mobile applications | [optional] [readonly] |
21-
| **_configuration** | **com.fasterxml.jackson.databind.JsonNode** | | [optional] |
21+
| **_configuration** | **com.fasterxml.jackson.databind.JsonNode** | JSON object with main configuration of the dashboard: layouts, widgets, aliases, etc. The JSON structure of the dashboard configuration is quite complex. The easiest way to learn it is to export existing dashboard to JSON. | [optional] |
2222
| **resources** | **List\<ResourceExportData\>** | | [optional] |
2323
| **version** | **Long** | | [optional] |
2424
| **groups** | **List\<EntityInfo\>** | Groups | [optional] |

‎pe/docs/EntityGroupControllerApi.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -930,16 +930,16 @@ void shareEntityGroupToChildOwnerUserGroup(@Nonnull String entityGroupId, @Nonnu
930930

931931
Share the Entity Group with User group (shareEntityGroupToChildOwnerUserGroup)
932932

933-
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.
933+
Share the entity group with the specified user group using the specified role. Unlike the 'shareEntityGroup' API method, this method is designed for sharing 'down' the owner hierarchy and does not require 'WRITE' permission for the shared entity group or the target user group. In particular, it allows the current user to re-share an entity group that was shared with them by the parent owner: for example, a customer user may re-share a tenant-owned dashboard group with a user group of their sub-customer. The following security checks are performed: * the target user group must belong to the current user's owner or to one of its sub-customers; * the current user must have the 'SHARE_GROUP' operation granted for the shared entity group: either as a generic permission for the corresponding entity group resource (applies only if the shared entity group belongs to the current user's owner hierarchy), or as a group permission created when the entity group was shared with the current user's user group using a group role that includes the 'SHARE_GROUP' operation; * the specified role must be a group role that is readable by the current user, so it must belong to the current user's owner or to one of its sub-customers; * the operations of the specified role must be a subset of the operations the current user was granted for the shared entity group (always passes if the current user was granted the 'ALL' operation). If the specified role also includes the 'SHARE_GROUP' operation, the members of the target user group will be able to re-share the entity group further down their own owner hierarchy in the same way. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
934934

935935

936936
### Parameters
937937

938938
| Name | Type | Description | Notes |
939939
|------------- | ------------- | ------------- | -------------|
940-
| **entityGroupId** | **String** | A string value representing the Entity Group Id that you would like to share. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
941-
| **userGroupId** | **String** | A string value representing the Entity(User) Group Id that you would like to share with. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
942-
| **roleId** | **String** | A string value representing the Role Id that describes set of permissions you would like to share (read, write, etc). For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
940+
| **entityGroupId** | **String** | ID of the entity group to share | |
941+
| **userGroupId** | **String** | ID of the user group to share the entity group with. The user group must belong to the current user's owner or to one of its sub-customers | |
942+
| **roleId** | **String** | ID of the group role that defines the set of operations to grant to the target user group | |
943943

944944
### Return type
945945

‎pe/docs/HomeDashboard.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
| **assignedCustomers** | **Set\<ShortCustomerInfo\>** | List of assigned customers with their info. | [optional] |
1919
| **mobileHide** | **Boolean** | Hide dashboard from mobile devices. Useful if the dashboard is not designed for small screens. | [optional] [readonly] |
2020
| **mobileOrder** | **Integer** | Order on mobile devices. Useful to adjust sorting of the dashboards for mobile applications | [optional] [readonly] |
21-
| **_configuration** | **com.fasterxml.jackson.databind.JsonNode** | | [optional] |
21+
| **_configuration** | **com.fasterxml.jackson.databind.JsonNode** | JSON object with main configuration of the dashboard: layouts, widgets, aliases, etc. The JSON structure of the dashboard configuration is quite complex. The easiest way to learn it is to export existing dashboard to JSON. | [optional] |
2222
| **resources** | **List\<ResourceExportData\>** | | [optional] |
2323
| **version** | **Long** | | [optional] |
2424
| **hideDashboardToolbar** | **Boolean** | Hide dashboard toolbar flag. Useful for rendering dashboards on mobile. | [optional] |

‎pe/docs/Job.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@
6666
| reportTemplateId | ReportTemplateId | | [optional] |
6767
| userId | UserId | | [optional] |
6868
| timezone | String | | [optional] |
69+
| makePublic | Boolean | | [optional] |
6970
| targets | List<UUID> | | [optional] |
7071
| notificationTemplateId | NotificationTemplateId | | [optional] |
7172
| notificationRequests | List<NotificationRequest> | | [optional] |
@@ -163,7 +164,9 @@
163164
| format | TbReportFormat | | |
164165
| name | String | | |
165166
| userId | UserId | | |
167+
| publicKey | String | | [optional] |
166168
| ownerId | EntityId | JSON object with Customer or Tenant Id | [optional] [readonly] |
169+
| _public | Boolean | | [optional] |
167170

168171
#### NotificationTemplate
169172
| Name | Type | Description | Notes |
@@ -221,6 +224,7 @@
221224
| reportTemplateId | ReportTemplateId | | [optional] |
222225
| userId | UserId | | [optional] |
223226
| timezone | String | | [optional] |
227+
| makePublic | Boolean | | [optional] |
224228

225229
#### DeliveryMethodNotificationTemplate
226230
| Name | Type | Description | Notes |

‎pe/docs/JobConfiguration.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
| reportTemplateId | ReportTemplateId | | [optional] |
4343
| userId | UserId | | [optional] |
4444
| timezone | String | | [optional] |
45+
| makePublic | Boolean | | [optional] |
4546
| targets | List<UUID> | | [optional] |
4647
| notificationTemplateId | NotificationTemplateId | | [optional] |
4748
| notificationRequests | List<NotificationRequest> | | [optional] |
@@ -160,6 +161,7 @@
160161
| reportTemplateId | ReportTemplateId | | [optional] |
161162
| userId | UserId | | [optional] |
162163
| timezone | String | | [optional] |
164+
| makePublic | Boolean | | [optional] |
163165

164166
#### DeliveryMethodNotificationTemplate
165167
| Name | Type | Description | Notes |

‎pe/docs/JobResult.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,9 @@ Job execution result
6060
| format | TbReportFormat | | |
6161
| name | String | | |
6262
| userId | UserId | | |
63+
| publicKey | String | | [optional] |
6364
| ownerId | EntityId | JSON object with Customer or Tenant Id | [optional] [readonly] |
65+
| _public | Boolean | | [optional] |
6466

6567
#### TbReportFormat (enum)
6668
`PDF` | `CSV`

‎pe/docs/LoginWhiteLabelingParams.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,11 @@ A JSON value representing the login white labeling configuration
1111
|------------ | ------------- | ------------- | -------------|
1212
| **logoImageUrl** | **String** | Logo image URL | [optional] |
1313
| **logoImageHeight** | **Integer** | The height of a logo container. Logo image will be automatically scaled. | [optional] |
14+
| **collapsedLogoImageUrl** | **String** | Logo shown when side menu is collapsed | [optional] |
1415
| **appTitle** | **String** | White-labeled name of the platform | [optional] |
1516
| **favicon** | **Favicon** | JSON object that contains website icon url and type | [optional] |
1617
| **paletteSettings** | **PaletteSettings** | Complex JSON that describes structure of the Angular Material Palette. See [theming](https://material.angular.io/guide/theming) for more details | [optional] |
18+
| **primaryColorPanels** | **Boolean** | Whether primary-color panels (top toolbar, side navigation, dialog and entity-details headers) use the primary palette color as background. When false, they render on a white background | [optional] |
1719
| **helpLinkBaseUrl** | **String** | Base URL for help link | [optional] |
1820
| **uiHelpBaseUrl** | **String** | Base URL for the repository with the UI help components (markdown) | [optional] |
1921
| **enableHelpLinks** | **Boolean** | Enable or Disable help links | [optional] |

0 commit comments

Comments
 (0)