Skip to content

Commit 7aba756

Browse files
ViacheslavKlimovTeamCity
andauthored
Update PE OpenAPI spec (from master) (#20)
Co-authored-by: TeamCity <teamcity@thingsboard.io>
1 parent 723e360 commit 7aba756

File tree

288 files changed

+7034
-6970
lines changed

Some content is hidden

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

288 files changed

+7034
-6970
lines changed

pe/docs/AiModel.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@
77

88
| Name | Type | Description | Notes |
99
|------------ | ------------- | ------------- | -------------|
10+
| **id** | **AiModelId** | | [optional] |
11+
| **createdTime** | **Long** | Entity creation timestamp in milliseconds since Unix epoch | [optional] [readonly] |
1012
| **tenantId** | **TenantId** | JSON object representing the ID of the tenant associated with this AI model | [readonly] |
1113
| **version** | **Long** | Version of the AI model record; increments automatically whenever the record is changed | [readonly] |
1214
| **name** | **String** | Display name for this AI model configuration; not the technical model identifier | |
1315
| **_configuration** | **AiModelConfig** | Configuration of the AI model | [optional] |
14-
| **id** | **AiModelId** | | [optional] |
15-
| **createdTime** | **Long** | Entity creation timestamp in milliseconds since Unix epoch | [optional] [readonly] |
1616

1717

1818

pe/docs/Alarm.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77

88
| Name | Type | Description | Notes |
99
|------------ | ------------- | ------------- | -------------|
10+
| **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] |
11+
| **createdTime** | **Long** | Timestamp of the alarm creation, in milliseconds | [optional] [readonly] |
1012
| **tenantId** | **TenantId** | JSON object with Tenant Id | [optional] [readonly] |
1113
| **customerId** | **CustomerId** | JSON object with Customer Id | [optional] [readonly] |
1214
| **type** | **String** | representing type of the Alarm | |
@@ -26,8 +28,6 @@
2628
| **propagateToOwnerHierarchy** | **Boolean** | Propagation flag to specify if alarm should be propagated to the owner (tenant or customer) and all parent owners in the customer hierarchy | [optional] |
2729
| **propagateToTenant** | **Boolean** | Propagation flag to specify if alarm should be propagated to the tenant entity | [optional] |
2830
| **propagateRelationTypes** | **List\<String\>** | JSON array of relation types that should be used for propagation. By default, 'propagateRelationTypes' array is empty which means that the alarm will be propagated based on any relation type to parent entities. This parameter should be used only in case when 'propagate' parameter is set to true, otherwise, 'propagateRelationTypes' array will be ignored. | [optional] |
29-
| **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] |
30-
| **createdTime** | **Long** | Timestamp of the alarm creation, in milliseconds | [optional] [readonly] |
3131
| **name** | **String** | representing type of the Alarm | [readonly] |
3232
| **status** | **AlarmStatus** | status of the Alarm | [readonly] |
3333

pe/docs/AlarmComment.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@
77

88
| Name | Type | Description | Notes |
99
|------------ | ------------- | ------------- | -------------|
10+
| **id** | **AlarmCommentId** | JSON object with the alarm comment Id. Specify this field to update the alarm comment. Referencing non-existing alarm Id will cause error. Omit this field to create new alarm. | [optional] |
11+
| **createdTime** | **Long** | Timestamp of the alarm comment creation, in milliseconds | [optional] [readonly] |
1012
| **alarmId** | **AlarmId** | JSON object with Alarm id. | [optional] [readonly] |
1113
| **userId** | **UserId** | JSON object with User id. | [optional] [readonly] |
1214
| **type** | **AlarmCommentType** | Defines origination of comment. System type means comment was created by TB. OTHER type means comment was created by user. | [optional] |
1315
| **comment** | **com.fasterxml.jackson.databind.JsonNode** | JSON object with text of comment. | [optional] |
14-
| **id** | **AlarmCommentId** | JSON object with the alarm comment Id. Specify this field to update the alarm comment. Referencing non-existing alarm Id will cause error. Omit this field to create new alarm. | [optional] |
15-
| **createdTime** | **Long** | Timestamp of the alarm comment creation, in milliseconds | [optional] [readonly] |
1616
| **name** | **String** | representing comment text | [optional] [readonly] |
1717

1818

pe/docs/AlarmConditionFilter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@
77

88
| Name | Type | Description | Notes |
99
|------------ | ------------- | ------------- | -------------|
10-
| **key** | **AlarmConditionFilterKey** | JSON object for specifying alarm condition by specific key | [optional] |
1110
| **valueType** | **EntityKeyValueType** | String representation of the type of the value | [optional] |
12-
| **value** | **Object** | | [optional] |
11+
| **key** | **AlarmConditionFilterKey** | JSON object for specifying alarm condition by specific key | [optional] |
1312
| **predicate** | **KeyFilterPredicate** | JSON object representing filter condition | [optional] |
13+
| **value** | **Object** | | [optional] |
1414

1515

1616

pe/docs/AlarmConditionValueAlarmRuleSchedule.md

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

88
| Name | Type | Description | Notes |
99
|------------ | ------------- | ------------- | -------------|
10-
| **staticValue** | **AlarmRuleSchedule** | | [optional] |
1110
| **dynamicValueArgument** | **String** | | [optional] |
11+
| **staticValue** | **AlarmRuleSchedule** | | [optional] |
1212

1313

1414

pe/docs/AlarmCountQuery.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ A JSON value representing the alarm count query.
99

1010
| Name | Type | Description | Notes |
1111
|------------ | ------------- | ------------- | -------------|
12+
| **entityFilter** | **EntityFilter** | | [optional] |
13+
| **keyFilters** | **List\<KeyFilter\>** | | [optional] |
1214
| **startTs** | **Long** | | [optional] |
1315
| **endTs** | **Long** | | [optional] |
1416
| **timeWindow** | **Long** | | [optional] |
@@ -17,8 +19,6 @@ A JSON value representing the alarm count query.
1719
| **severityList** | **List\<AlarmSeverity\>** | | [optional] |
1820
| **searchPropagatedAlarms** | **Boolean** | | [optional] |
1921
| **assigneeId** | **UserId** | | [optional] |
20-
| **entityFilter** | **EntityFilter** | | [optional] |
21-
| **keyFilters** | **List\<KeyFilter\>** | | [optional] |
2222

2323

2424

pe/docs/AlarmData.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@
77

88
| Name | Type | Description | Notes |
99
|------------ | ------------- | ------------- | -------------|
10-
| **entityId** | **EntityId** | | [optional] |
11-
| **latest** | **Map\<String, Map<String, TsValue>\>** | | [optional] |
1210
| **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] |
1311
| **createdTime** | **Long** | Timestamp of the alarm creation, in milliseconds | [optional] [readonly] |
1412
| **tenantId** | **TenantId** | JSON object with Tenant Id | [optional] [readonly] |
@@ -34,6 +32,8 @@
3432
| **originatorLabel** | **String** | Alarm originator label | [optional] |
3533
| **originatorDisplayName** | **String** | Originator display name | [optional] |
3634
| **assignee** | **AlarmAssignee** | Alarm assignee | [optional] |
35+
| **entityId** | **EntityId** | | [optional] |
36+
| **latest** | **Map\<String, Map<String, TsValue>\>** | | [optional] |
3737
| **name** | **String** | representing type of the Alarm | [readonly] |
3838
| **status** | **AlarmStatus** | status of the Alarm | [readonly] |
3939

pe/docs/AlarmDataPageLink.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@
77

88
| Name | Type | Description | Notes |
99
|------------ | ------------- | ------------- | -------------|
10+
| **pageSize** | **Integer** | | [optional] |
11+
| **page** | **Integer** | | [optional] |
12+
| **textSearch** | **String** | | [optional] |
13+
| **sortOrder** | **EntityDataSortOrder** | | [optional] |
14+
| **dynamic** | **Boolean** | | [optional] |
1015
| **startTs** | **Long** | | [optional] |
1116
| **endTs** | **Long** | | [optional] |
1217
| **timeWindow** | **Long** | | [optional] |
@@ -15,11 +20,6 @@
1520
| **severityList** | **List\<AlarmSeverity\>** | | [optional] |
1621
| **searchPropagatedAlarms** | **Boolean** | | [optional] |
1722
| **assigneeId** | **UserId** | | [optional] |
18-
| **pageSize** | **Integer** | | [optional] |
19-
| **page** | **Integer** | | [optional] |
20-
| **textSearch** | **String** | | [optional] |
21-
| **sortOrder** | **EntityDataSortOrder** | | [optional] |
22-
| **dynamic** | **Boolean** | | [optional] |
2323

2424

2525

pe/docs/AlarmRule.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
| Name | Type | Description | Notes |
99
|------------ | ------------- | ------------- | -------------|
1010
| **condition** | **AlarmCondition** | JSON object representing the alarm rule condition | [optional] |
11-
| **schedule** | **AlarmSchedule** | JSON object representing time interval during which the rule is active | [optional] |
1211
| **alarmDetails** | **String** | String value representing the additional details for an alarm rule | [optional] |
1312
| **dashboardId** | **DashboardId** | JSON object with the dashboard Id representing the reference to alarm details dashboard used by mobile application | [optional] |
13+
| **schedule** | **AlarmSchedule** | JSON object representing time interval during which the rule is active | [optional] |
1414

1515

1616

pe/docs/AlarmRuleConditionFilter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
| Name | Type | Description | Notes |
99
|------------ | ------------- | ------------- | -------------|
1010
| **argument** | **String** | | |
11-
| **valueType** | **EntityKeyValueType** | | |
1211
| **operation** | **ComplexOperation** | | [optional] |
1312
| **predicates** | **List\<AlarmRuleKeyFilterPredicate\>** | | |
13+
| **valueType** | **EntityKeyValueType** | | |
1414

1515

1616

0 commit comments

Comments
 (0)