Skip to content

Commit 4bbde17

Browse files
Merge pull request #67 from thingsboard/auto/update-paas-client-master
Update PAAS OpenAPI spec in master (from develop/4.4)
2 parents 275dee7 + 03cd36c commit 4bbde17

148 files changed

Lines changed: 6097 additions & 7070 deletions

File tree

Some content is hidden

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

‎paas/docs/AiChatControllerApi.md‎

Lines changed: 4 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) // 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)
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,8 @@ sendChatMessage
117117
|------------- | ------------- | ------------- | -------------|
118118
| **chatId** | **UUID** | | |
119119
| **xAuthorization** | **String** | | |
120-
| **body** | **String** | | |
120+
| **body** | **Object** | | |
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+

‎paas/docs/Alarm.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
| **id** | **AlarmId** | JSON object with the alarm Id. Specify this field to update the alarm. Referencing non-existing alarm Id will cause error. Omit this field to create new alarm. | [optional] |
1111
| **createdTime** | **Long** | Timestamp of the alarm creation, in milliseconds | [optional] [readonly] |
1212
| **tenantId** | **TenantId** | JSON object with Tenant Id | [optional] [readonly] |
13-
| **customerId** | **CustomerId** | JSON object with Customer Id | [optional] [readonly] |
13+
| **customerId** | **CustomerId** | JSON object with Customer Id. Derived from the originator entity owner and cannot be set independently; any value supplied in the request body must match the originator's customer or the request is rejected. | [optional] [readonly] |
1414
| **type** | **String** | representing type of the Alarm | |
1515
| **originator** | **EntityId** | JSON object with alarm originator id | |
1616
| **severity** | **AlarmSeverity** | Alarm severity | |

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

‎paas/docs/AlarmData.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
| **id** | **AlarmId** | JSON object with the alarm Id. Specify this field to update the alarm. Referencing non-existing alarm Id will cause error. Omit this field to create new alarm. | [optional] |
1111
| **createdTime** | **Long** | Timestamp of the alarm creation, in milliseconds | [optional] [readonly] |
1212
| **tenantId** | **TenantId** | JSON object with Tenant Id | [optional] [readonly] |
13-
| **customerId** | **CustomerId** | JSON object with Customer Id | [optional] [readonly] |
13+
| **customerId** | **CustomerId** | JSON object with Customer Id. Derived from the originator entity owner and cannot be set independently; any value supplied in the request body must match the originator's customer or the request is rejected. | [optional] [readonly] |
1414
| **type** | **String** | representing type of the Alarm | |
1515
| **originator** | **EntityId** | JSON object with alarm originator id | |
1616
| **severity** | **AlarmSeverity** | Alarm severity | |

‎paas/docs/AlarmInfo.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
| **id** | **AlarmId** | JSON object with the alarm Id. Specify this field to update the alarm. Referencing non-existing alarm Id will cause error. Omit this field to create new alarm. | [optional] |
1111
| **createdTime** | **Long** | Timestamp of the alarm creation, in milliseconds | [optional] [readonly] |
1212
| **tenantId** | **TenantId** | JSON object with Tenant Id | [optional] [readonly] |
13-
| **customerId** | **CustomerId** | JSON object with Customer Id | [optional] [readonly] |
13+
| **customerId** | **CustomerId** | JSON object with Customer Id. Derived from the originator entity owner and cannot be set independently; any value supplied in the request body must match the originator's customer or the request is rejected. | [optional] [readonly] |
1414
| **type** | **String** | representing type of the Alarm | |
1515
| **originator** | **EntityId** | JSON object with alarm originator id | |
1616
| **severity** | **AlarmSeverity** | Alarm severity | |

‎paas/docs/Asset.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 asset creation, in milliseconds | [optional] [readonly] |
1212
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the asset. May include: 'description' (string). | [optional] |
1313
| **tenantId** | **TenantId** | JSON object with Tenant Id. | [optional] [readonly] |
14-
| **customerId** | **CustomerId** | JSON object with Customer Id. Use 'assignAssetToCustomer' to change the Customer Id. | [optional] [readonly] |
14+
| **customerId** | **CustomerId** | JSON object with Customer Id. Optional on create: when omitted, defaults to the owner of the target Entity Group or to the current Customer user. Cannot be changed on update via this endpoint; use the Owner API (changeOwnerToCustomer) to re-assign an existing Asset. | [optional] |
1515
| **name** | **String** | Unique Asset Name in scope of Tenant | |
1616
| **type** | **String** | Asset type | [optional] |
1717
| **label** | **String** | Label that may be used in widgets | [optional] |

‎paas/docs/AssetControllerApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Returns a page of asset info objects owned by the tenant or the customer of a cu
8888
|------------- | ------------- | ------------- | -------------|
8989
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
9090
| **page** | **Integer** | Sequence number of page starting from 0 | |
91-
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities | [optional] |
91+
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities. For tenant administrator: when true, includes entities for all customers; when false (default), only own entities are returned. For customer user: when true, includes entities for all sub-customers. | [optional] |
9292
| **assetProfileId** | **String** | A string value representing the asset profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | [optional] |
9393
| **textSearch** | **String** | The case insensitive 'substring' filter based on the asset name. | [optional] |
9494
| **sortProperty** | **String** | Property of entity to sort by | [optional] [enum: createdTime, name, type, label, customerTitle] |
@@ -237,7 +237,7 @@ Returns a page of asset info objects owned by the specified customer. Asset Info
237237
| **customerId** | **String** | A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
238238
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
239239
| **page** | **Integer** | Sequence number of page starting from 0 | |
240-
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities | [optional] |
240+
| **includeCustomers** | **Boolean** | Include customer or sub-customer entities. For tenant administrator: when true, includes entities for all customers; when false (default), only own entities are returned. For customer user: when true, includes entities for all sub-customers. | [optional] |
241241
| **assetProfileId** | **String** | A string value representing the asset profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | [optional] |
242242
| **textSearch** | **String** | The case insensitive 'substring' filter based on the asset name. | [optional] |
243243
| **sortProperty** | **String** | Property of entity to sort by | [optional] [enum: createdTime, name, type, label, customerTitle] |

‎paas/docs/AssetInfo.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 asset creation, in milliseconds | [optional] [readonly] |
1212
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the asset. May include: 'description' (string). | [optional] |
1313
| **tenantId** | **TenantId** | JSON object with Tenant Id. | [optional] [readonly] |
14-
| **customerId** | **CustomerId** | JSON object with Customer Id. Use 'assignAssetToCustomer' to change the Customer Id. | [optional] [readonly] |
14+
| **customerId** | **CustomerId** | JSON object with Customer Id. Optional on create: when omitted, defaults to the owner of the target Entity Group or to the current Customer user. Cannot be changed on update via this endpoint; use the Owner API (changeOwnerToCustomer) to re-assign an existing Asset. | [optional] |
1515
| **name** | **String** | Unique Asset Name in scope of Tenant | |
1616
| **type** | **String** | Asset type | [optional] |
1717
| **label** | **String** | Label that may be used in widgets | [optional] |

‎paas/docs/AvailableEntityKeys.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Contains unique time series and attribute key names discovered from entities mat
1010
| Name | Type | Description | Notes |
1111
|------------ | ------------- | ------------- | -------------|
1212
| **entityTypes** | **Set\<EntityType\>** | Set of entity types found among the matched entities. | |
13-
| **timeseries** | **Set\<String\>** | | |
14-
| **attribute** | **Set\<String\>** | | |
13+
| **timeseries** | **Set\<String\>** | List of unique time series key names available on the matched entities. | |
14+
| **attribute** | **Set\<String\>** | List of unique attribute key names available on the matched entities. | |
1515

1616

1717

0 commit comments

Comments
 (0)