Skip to content

Commit 96ae949

Browse files
author
TeamCity
committed
Update PE OpenAPI spec (from master)
1 parent d9b1560 commit 96ae949

34 files changed

+1716
-3119
lines changed

pe/docs/CustomMenuConfig.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33

44
`org.thingsboard.client.model.CustomMenuConfig`
55

6-
A JSON value representing the custom menu configuration
7-
86
## Properties
97

108
| Name | Type | Description | Notes |

pe/docs/CustomMenuControllerApi.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
```
66
CustomMenu createCustomMenu(@Nonnull CustomMenuInfo customMenuInfo, @Nullable List<String> assignToList, @Nullable Boolean force) // Create Custom Menu (createCustomMenu)
77
CustomMenuDeleteResult deleteCustomMenu(@Nonnull UUID customMenuId, @Nullable Boolean force) // Delete custom menu (deleteCustomMenu)
8-
void getCustomMenu(@Nullable String ifNoneMatch) // Get end-user Custom Menu configuration (getCustomMenu)
8+
CustomMenuConfig getCustomMenu(@Nullable String ifNoneMatch) // Get end-user Custom Menu configuration (getCustomMenu)
99
List<EntityInfo> getCustomMenuAssigneeList(@Nonnull UUID customMenuId) // Get Custom Menu assignee list (getCustomMenuAssigneeList)
1010
CustomMenuConfig getCustomMenuConfig(@Nonnull UUID customMenuId) // Get Custom Menu configuration by id (getCustomMenuConfig)
1111
CustomMenuInfo getCustomMenuInfoById(@Nonnull UUID customMenuId) // Get Custom Menu Info (getCustomMenuInfoById)
@@ -70,7 +70,7 @@ Deletes the custom menu based on the provided Custom Menu Id. Referencing non-ex
7070
## getCustomMenu
7171

7272
```
73-
void getCustomMenu(@Nullable String ifNoneMatch)
73+
CustomMenuConfig getCustomMenu(@Nullable String ifNoneMatch)
7474
```
7575

7676
**GET** `/api/customMenu`
@@ -88,7 +88,7 @@ Fetch the Custom Menu configuration object for the authorized user. The custom m
8888

8989
### Return type
9090

91-
null (empty response body)
91+
**CustomMenuConfig**
9292

9393

9494
## getCustomMenuAssigneeList

pe/docs/Customer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
| **address2** | **String** | Address Line 2 | [optional] |
1818
| **zip** | **String** | Zip code | [optional] |
1919
| **phone** | **String** | Phone number | [optional] |
20-
| **email** | **String** | Email | |
20+
| **email** | **String** | Email | [optional] |
2121
| **title** | **String** | Title of the customer | |
2222
| **tenantId** | **TenantId** | JSON object with Tenant Id | [optional] |
2323
| **parentCustomerId** | **CustomerId** | JSON object with parent Customer Id | [optional] |

pe/docs/CustomerInfo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
| **address2** | **String** | Address Line 2 | [optional] |
1818
| **zip** | **String** | Zip code | [optional] |
1919
| **phone** | **String** | Phone number | [optional] |
20-
| **email** | **String** | Email | |
20+
| **email** | **String** | Email | [optional] |
2121
| **title** | **String** | Title of the customer | |
2222
| **tenantId** | **TenantId** | JSON object with Tenant Id | [optional] |
2323
| **parentCustomerId** | **CustomerId** | JSON object with parent Customer Id | [optional] |

pe/docs/DashboardControllerApi.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ List<Dashboard> exportGroupDashboards(@Nonnull String entityGroupId, @Nonnull In
88
PageDataDashboardInfo getAllDashboards(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable Boolean includeCustomers, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get All Dashboards for current user (getAllDashboards)
99
PageDataDashboardInfo getCustomerDashboards(@Nonnull String customerId, @Nonnull Integer pageSize, @Nonnull Integer page, @Nullable Boolean includeCustomers, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get Customer Dashboards (getCustomerDashboards)
1010
HomeDashboardInfo getCustomerHomeDashboardInfo() // Get Customer Home Dashboard Info (getCustomerHomeDashboardInfo)
11-
void getDashboardById(@Nonnull String dashboardId, @Nullable Boolean includeResources, @Nullable String acceptEncoding) // Get Dashboard (getDashboardById)
11+
Dashboard getDashboardById(@Nonnull String dashboardId, @Nullable Boolean includeResources, @Nullable String acceptEncoding) // Get Dashboard (getDashboardById)
1212
DashboardInfo getDashboardInfoById(@Nonnull String dashboardId) // Get Dashboard Info (getDashboardInfoById)
1313
PageDataDashboardInfo getDashboardsByEntityGroupId(@Nonnull String entityGroupId, @Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get dashboards by Entity Group Id (getDashboardsByEntityGroupId)
1414
List<DashboardInfo> getDashboardsByIds(@Nonnull List<String> dashboardIds) // Get dashboards by Dashboard Ids (getDashboardsByIds)
15-
void getHomeDashboard(@Nullable String acceptEncoding) // Get Home Dashboard (getHomeDashboard)
15+
HomeDashboard getHomeDashboard(@Nullable String acceptEncoding) // Get Home Dashboard (getHomeDashboard)
1616
HomeDashboardInfo getHomeDashboardInfo() // Get Home Dashboard Info (getHomeDashboardInfo)
1717
Long getMaxDatapointsLimit() // Get max data points limit (getMaxDatapointsLimit)
1818
Long getServerTime() // Get server time (getServerTime)
@@ -156,7 +156,7 @@ Returns the home dashboard info object that is configured as 'homeDashboardId' p
156156
## getDashboardById
157157

158158
```
159-
void getDashboardById(@Nonnull String dashboardId, @Nullable Boolean includeResources, @Nullable String acceptEncoding)
159+
Dashboard getDashboardById(@Nonnull String dashboardId, @Nullable Boolean includeResources, @Nullable String acceptEncoding)
160160
```
161161

162162
**GET** `/api/dashboard/{dashboardId}`
@@ -176,7 +176,7 @@ Get the dashboard based on 'dashboardId' parameter. The Dashboard object is a he
176176

177177
### Return type
178178

179-
null (empty response body)
179+
**Dashboard**
180180

181181

182182
## getDashboardInfoById
@@ -259,7 +259,7 @@ Returns a list of DashboardInfo objects based on the provided ids. Filters the l
259259
## getHomeDashboard
260260

261261
```
262-
void getHomeDashboard(@Nullable String acceptEncoding)
262+
HomeDashboard getHomeDashboard(@Nullable String acceptEncoding)
263263
```
264264

265265
**GET** `/api/dashboard/home`
@@ -277,7 +277,7 @@ Returns the home dashboard object that is configured as 'homeDashboardId' parame
277277

278278
### Return type
279279

280-
null (empty response body)
280+
**HomeDashboard**
281281

282282

283283
## getHomeDashboardInfo

pe/docs/Device.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
| **name** | **String** | Unique Device Name in scope of Tenant | [optional] |
1616
| **type** | **String** | Device Profile Name | [optional] |
1717
| **label** | **String** | Label that may be used in widgets | [optional] |
18-
| **deviceProfileId** | **DeviceProfileId** | JSON object with Device Profile Id. | |
18+
| **deviceProfileId** | **DeviceProfileId** | JSON object with Device Profile Id. If not provided, the default device profile will be used. | [optional] |
1919
| **deviceData** | **DeviceData** | JSON object with content specific to type of transport in the device profile. | [optional] |
2020
| **firmwareId** | **OtaPackageId** | JSON object with Ota Package Id. | [optional] |
2121
| **softwareId** | **OtaPackageId** | JSON object with Ota Package Id. | [optional] |

pe/docs/DeviceInfo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
| **name** | **String** | Unique Device Name in scope of Tenant | [optional] |
1616
| **type** | **String** | Device Profile Name | [optional] |
1717
| **label** | **String** | Label that may be used in widgets | [optional] |
18-
| **deviceProfileId** | **DeviceProfileId** | JSON object with Device Profile Id. | |
18+
| **deviceProfileId** | **DeviceProfileId** | JSON object with Device Profile Id. If not provided, the default device profile will be used. | [optional] |
1919
| **deviceData** | **DeviceData** | JSON object with content specific to type of transport in the device profile. | [optional] |
2020
| **firmwareId** | **OtaPackageId** | JSON object with Ota Package Id. | [optional] |
2121
| **softwareId** | **OtaPackageId** | JSON object with Ota Package Id. | [optional] |

pe/docs/DeviceProfileInfo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
| Name | Type | Description | Notes |
99
|------------ | ------------- | ------------- | -------------|
10-
| **id** | **EntityId** | JSON object with the entity Id. | [optional] |
10+
| **id** | **DeviceProfileId** | JSON object with the Device Profile Id. | [optional] |
1111
| **name** | **String** | Entity Name | [optional] |
1212
| **image** | **String** | Either URL or Base64 data of the icon. Used in the mobile application to visualize set of device profiles in the grid view. | [optional] |
1313
| **defaultDashboardId** | **DashboardId** | Reference to the dashboard. Used in the mobile application to open the default dashboard when user navigates to device details. | [optional] |

pe/docs/EntityGroupInfo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
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] |
18-
| **ownerIds** | **Set\<EntityGroupInfoOwnerIdsInner\>** | List of the entity group owners. | |
18+
| **ownerIds** | **Set\<EntityId\>** | | [optional] |
1919
| **edgeGroupAll** | **Boolean** | Indicates special edge group 'All' that contains all entities and can't be deleted. | [optional] [readonly] |
2020
| **groupAll** | **Boolean** | Indicates special group 'All' that contains all entities and can't be deleted. | [optional] |
2121
| **tenantId** | **TenantId** | | [optional] |

pe/docs/EntityGroupInfoOwnerIdsInner.md

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

0 commit comments

Comments
 (0)