Skip to content

Commit 2bdea18

Browse files
Merge pull request #51 from thingsboard/auto/update-pe-client-master
Update PE OpenAPI spec (from master)
2 parents c1ca8c7 + 72d1232 commit 2bdea18

29 files changed

Lines changed: 1289 additions & 53 deletions

pe/docs/AiChatControllerApi.md

Lines changed: 3 additions & 2 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) // sendChatMessage
10+
List<Object> sendChatMessage(@Nonnull UUID chatId, @Nonnull String xAuthorization, @Nonnull String 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)
106+
List<Object> sendChatMessage(@Nonnull UUID chatId, @Nonnull String xAuthorization, @Nonnull String body, @Nullable String acceptLanguage)
107107
```
108108

109109
**POST** `/api/ai/chats/{chatId}/messages`
@@ -118,6 +118,7 @@ sendChatMessage
118118
| **chatId** | **UUID** | | |
119119
| **xAuthorization** | **String** | | |
120120
| **body** | **String** | | |
121+
| **acceptLanguage** | **String** | | [optional] |
121122

122123
### Return type
123124

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# AiDeviceDashboardControllerApi
2+
3+
`ThingsboardClient` methods:
4+
5+
```
6+
com.fasterxml.jackson.databind.JsonNode generateDashboard(@Nonnull UUID deviceId, @Nonnull String xAuthorization, @Nonnull Object body) // generateDashboard
7+
```
8+
9+
10+
## generateDashboard
11+
12+
```
13+
com.fasterxml.jackson.databind.JsonNode generateDashboard(@Nonnull UUID deviceId, @Nonnull String xAuthorization, @Nonnull Object body)
14+
```
15+
16+
**POST** `/api/ai/devices/{deviceId}/dashboard`
17+
18+
generateDashboard
19+
20+
21+
### Parameters
22+
23+
| Name | Type | Description | Notes |
24+
|------------- | ------------- | ------------- | -------------|
25+
| **deviceId** | **UUID** | | |
26+
| **xAuthorization** | **String** | | |
27+
| **body** | **Object** | | |
28+
29+
### Return type
30+
31+
**com.fasterxml.jackson.databind.JsonNode**
32+

pe/docs/EntityDataDiff.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,10 @@
5454
#### EntityGroupExportData *(extends EntityExportData, entityType=`ENTITY_GROUP`)*
5555
| Name | Type | Description | Notes |
5656
|------|------|-------------|-------|
57-
| permissions | List<GroupPermission> | | [optional] |
58-
| groupOtaPackages | List<DeviceGroupOtaPackage> | | [optional] |
59-
| groupEntities | Boolean | | [optional] |
57+
| permissions | List<GroupPermission> | Group permissions to apply to this group on import. Meaningful only for USER groups; ignored for groups of any other type. Each entry's userGroupId, roleId, and entityGroupId may use the external IDs of other entities in this payload or the IDs of entities that already exist on the target tenant; the importer resolves them against the target tenant. System-tenant roles are not allowed and will be rejected. Leave null to skip permission management for this group. | [optional] |
58+
| groupOtaPackages | List<DeviceGroupOtaPackage> | OTA package assignments to apply to this group on import. Meaningful only for DEVICE groups; ignored for groups of any other type. Each entry's otaPackageId and groupId may reference external IDs of entities in this payload or IDs of entities that already exist on the target tenant. Leave null to skip OTA assignment management for this group. | [optional] |
59+
| groupEntities | Boolean | Marker indicating that the group's member entities are intended to be transported alongside this payload. Used by flows that convey members through a side channel (notably the version control flow, which stores members in a separate git index). The solution import API does not consume this flag and does not require it to be set. Safe to leave false (default). | [optional] |
60+
| memberIds | List<UUID> | External IDs of the entities that should be members of this group after import. Each ID is resolved against the target tenant — by other entity in this payload, by external ID, or by existing internal ID — and the matching entities are added to the group. The import fails if any listed member cannot be resolved. Must be null for the special 'All' group (whose membership is implicit and managed by the platform). Leave null to skip membership wiring; existing membership on the target tenant is left untouched. | [optional] |
6061

6162
#### EntityViewExportData *(extends EntityExportData, entityType=`ENTITY_VIEW`)*
6263
*See EntityExportData for properties.*
@@ -93,6 +94,9 @@
9394
#### TbResourceExportData *(extends EntityExportData, entityType=`TB_RESOURCE`)*
9495
*See EntityExportData for properties.*
9596

97+
#### UserExportData *(extends EntityExportData, entityType=`USER`)*
98+
*See EntityExportData for properties.*
99+
96100
#### WidgetsBundleExportData *(extends EntityExportData, entityType=`WIDGETS_BUNDLE`)*
97101
| Name | Type | Description | Notes |
98102
|------|------|-------------|-------|

pe/docs/EntityExportData.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,10 @@ Base export container for ThingsBoard entities
4848
#### EntityGroupExportData *(entityType=`ENTITY_GROUP`)*
4949
| Name | Type | Description | Notes |
5050
|------|------|-------------|-------|
51-
| permissions | List<GroupPermission> | | [optional] |
52-
| groupOtaPackages | List<DeviceGroupOtaPackage> | | [optional] |
53-
| groupEntities | Boolean | | [optional] |
51+
| permissions | List<GroupPermission> | Group permissions to apply to this group on import. Meaningful only for USER groups; ignored for groups of any other type. Each entry's userGroupId, roleId, and entityGroupId may use the external IDs of other entities in this payload or the IDs of entities that already exist on the target tenant; the importer resolves them against the target tenant. System-tenant roles are not allowed and will be rejected. Leave null to skip permission management for this group. | [optional] |
52+
| groupOtaPackages | List<DeviceGroupOtaPackage> | OTA package assignments to apply to this group on import. Meaningful only for DEVICE groups; ignored for groups of any other type. Each entry's otaPackageId and groupId may reference external IDs of entities in this payload or IDs of entities that already exist on the target tenant. Leave null to skip OTA assignment management for this group. | [optional] |
53+
| groupEntities | Boolean | Marker indicating that the group's member entities are intended to be transported alongside this payload. Used by flows that convey members through a side channel (notably the version control flow, which stores members in a separate git index). The solution import API does not consume this flag and does not require it to be set. Safe to leave false (default). | [optional] |
54+
| memberIds | List<UUID> | External IDs of the entities that should be members of this group after import. Each ID is resolved against the target tenant — by other entity in this payload, by external ID, or by existing internal ID — and the matching entities are added to the group. The import fails if any listed member cannot be resolved. Must be null for the special 'All' group (whose membership is implicit and managed by the platform). Leave null to skip membership wiring; existing membership on the target tenant is left untouched. | [optional] |
5455

5556
#### EntityViewExportData *(entityType=`ENTITY_VIEW`)*
5657
*(no additional properties)*
@@ -87,6 +88,9 @@ Base export container for ThingsBoard entities
8788
#### TbResourceExportData *(entityType=`TB_RESOURCE`)*
8889
*(no additional properties)*
8990

91+
#### UserExportData *(entityType=`USER`)*
92+
*(no additional properties)*
93+
9094
#### WidgetsBundleExportData *(entityType=`WIDGETS_BUNDLE`)*
9195
| Name | Type | Description | Notes |
9296
|------|------|-------------|-------|

pe/docs/EntityExportSettings.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
| **exportCalculatedFields** | **Boolean** | | [optional] |
1414
| **exportPermissions** | **Boolean** | | [optional] |
1515
| **exportGroupEntities** | **Boolean** | | [optional] |
16+
| **embedGroupMembers** | **Boolean** | | [optional] |
1617

1718

1819

pe/docs/EntityGroup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ A JSON value representing the entity group.
1313
| **createdTime** | **Long** | Timestamp of the entity group creation, in milliseconds | [optional] [readonly] |
1414
| **type** | **TypeEnum** | | |
1515
| **name** | **String** | Name of the entity group | |
16-
| **ownerId** | **EntityId** | JSON object with the owner of the group - Tenant or Customer Id. | [optional] |
16+
| **ownerId** | **EntityId** | JSON object with the owner of the group - Tenant or Customer Id. When omitted or null on creation, defaults to the current user's owner (Tenant for tenant admins, Customer for customer users). | [optional] |
1717
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the entity group. May include: 'description' (string), 'isPublic' (boolean, whether this group is shared publicly), 'publicCustomerId' (string, UUID of the public customer associated with this group). | [optional] |
1818
| **_configuration** | **com.fasterxml.jackson.databind.JsonNode** | JSON with the configuration for UI components: list of columns, settings, actions, etc | [optional] |
1919
| **version** | **Long** | | [optional] |

pe/docs/EntityGroupExportData.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,10 @@
99

1010
| Name | Type | Description | Notes |
1111
|------------ | ------------- | ------------- | -------------|
12-
| **permissions** | **List\<GroupPermission\>** | | [optional] |
13-
| **groupOtaPackages** | **List\<DeviceGroupOtaPackage\>** | | [optional] |
14-
| **groupEntities** | **Boolean** | | [optional] |
12+
| **permissions** | **List\<GroupPermission\>** | Group permissions to apply to this group on import. Meaningful only for USER groups; ignored for groups of any other type. Each entry's userGroupId, roleId, and entityGroupId may use the external IDs of other entities in this payload or the IDs of entities that already exist on the target tenant; the importer resolves them against the target tenant. System-tenant roles are not allowed and will be rejected. Leave null to skip permission management for this group. | [optional] |
13+
| **groupOtaPackages** | **List\<DeviceGroupOtaPackage\>** | OTA package assignments to apply to this group on import. Meaningful only for DEVICE groups; ignored for groups of any other type. Each entry's otaPackageId and groupId may reference external IDs of entities in this payload or IDs of entities that already exist on the target tenant. Leave null to skip OTA assignment management for this group. | [optional] |
14+
| **groupEntities** | **Boolean** | Marker indicating that the group's member entities are intended to be transported alongside this payload. Used by flows that convey members through a side channel (notably the version control flow, which stores members in a separate git index). The solution import API does not consume this flag and does not require it to be set. Safe to leave false (default). | [optional] |
15+
| **memberIds** | **List\<UUID\>** | External IDs of the entities that should be members of this group after import. Each ID is resolved against the target tenant — by other entity in this payload, by external ID, or by existing internal ID — and the matching entities are added to the group. The import fails if any listed member cannot be resolved. Must be null for the special 'All' group (whose membership is implicit and managed by the platform). Leave null to skip membership wiring; existing membership on the target tenant is left untouched. | [optional] |
1516

1617

1718

pe/docs/EntityGroupInfo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
| **createdTime** | **Long** | Timestamp of the entity group creation, in milliseconds | [optional] [readonly] |
1212
| **type** | **TypeEnum** | | |
1313
| **name** | **String** | Name of the entity group | |
14-
| **ownerId** | **EntityId** | JSON object with the owner of the group - Tenant or Customer Id. | [optional] |
14+
| **ownerId** | **EntityId** | JSON object with the owner of the group - Tenant or Customer Id. When omitted or null on creation, defaults to the current user's owner (Tenant for tenant admins, Customer for customer users). | [optional] |
1515
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the entity group. May include: 'description' (string), 'isPublic' (boolean, whether this group is shared publicly), 'publicCustomerId' (string, UUID of the public customer associated with this group). | [optional] |
1616
| **_configuration** | **com.fasterxml.jackson.databind.JsonNode** | JSON with the configuration for UI components: list of columns, settings, actions, etc | [optional] |
1717
| **version** | **Long** | | [optional] |

pe/docs/GroupPermissionInfo.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@
4444
| customerId | CustomerId | JSON object with Customer Id. | [optional] [readonly] |
4545
| name | String | Role Name | |
4646
| type | RoleType | Type of the role: generic or group | |
47-
| permissions | com.fasterxml.jackson.databind.JsonNode | JSON object with the set of permissions. Structure is specific for role type | |
48-
| excludedPermissions | com.fasterxml.jackson.databind.JsonNode | JSON object with the set of excluded permissions. Only applicable for generic roles. Structure is the same as permissions | [optional] |
47+
| permissions | com.fasterxml.jackson.databind.JsonNode | Set of permissions granted by this role. The JSON shape depends on the role 'type': * GENERIC — JSON object mapping `Resource` enum names to arrays of `Operation` enum names allowed on that resource. The wildcard entry `{\"ALL\":[\"ALL\"]}` grants every operation on every resource. * GROUP — JSON array of `Operation` enum names that apply to the entity group this role is bound to via `GroupPermission.entityGroupId`. Only operations with `allowedForGroupRole=true` may appear (see `Operation` enum). The wildcard entry `[\"ALL\"]` grants every supported operation on the bound entity group. | |
48+
| excludedPermissions | com.fasterxml.jackson.databind.JsonNode | Operations to subtract from those granted by `permissions`. Only applicable to GENERIC roles — setting this on a GROUP role is rejected by validation. Same shape as the GENERIC variant of `permissions`: a JSON object mapping `Resource` enum names to non-empty arrays of `Operation` enum names. At evaluation time, for each resource the listed operations are removed from the resolved permission set (e.g. `permissions={\"ALL\":[\"ALL\"]}` combined with `excludedPermissions={\"DEVICE\":[\"DELETE\"]}` grants everything except deleting devices). May be null or an empty object when no exclusions apply. | [optional] |
4949
| version | Long | | [optional] |
5050
| ownerId | EntityId | JSON object with Customer or Tenant Id | [optional] [readonly] |
5151

pe/docs/PageDataEntityGroupInfo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
| createdTime | Long | Timestamp of the entity group creation, in milliseconds | [optional] [readonly] |
2626
| type | TypeEnum | | |
2727
| name | String | Name of the entity group | |
28-
| ownerId | EntityId | JSON object with the owner of the group - Tenant or Customer Id. | [optional] |
28+
| ownerId | EntityId | JSON object with the owner of the group - Tenant or Customer Id. When omitted or null on creation, defaults to the current user's owner (Tenant for tenant admins, Customer for customer users). | [optional] |
2929
| additionalInfo | com.fasterxml.jackson.databind.JsonNode | Additional parameters of the entity group. May include: 'description' (string), 'isPublic' (boolean, whether this group is shared publicly), 'publicCustomerId' (string, UUID of the public customer associated with this group). | [optional] |
3030
| _configuration | com.fasterxml.jackson.databind.JsonNode | JSON with the configuration for UI components: list of columns, settings, actions, etc | [optional] |
3131
| version | Long | | [optional] |

0 commit comments

Comments
 (0)