Skip to content

Commit 07397e1

Browse files
author
TeamCity
committed
Update PE OpenAPI spec (from master)
1 parent 74fb34a commit 07397e1

17 files changed

Lines changed: 574 additions & 193 deletions

‎pe/docs/CalculatedField.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
| **configurationVersion** | **Integer** | Version of calculated field configuration. | [optional] |
1919
| **_configuration** | **CalculatedFieldConfiguration** | | |
2020
| **version** | **Long** | | [optional] |
21+
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the calculated field | [optional] |
2122

2223

2324

‎pe/docs/CalculatedFieldInfo.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
| **configurationVersion** | **Integer** | Version of calculated field configuration. | [optional] |
1919
| **_configuration** | **CalculatedFieldConfiguration** | | |
2020
| **version** | **Long** | | [optional] |
21+
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the calculated field | [optional] |
2122
| **entityName** | **String** | | [optional] |
2223

2324

‎pe/docs/EdgeEventType.md‎

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

9595
* `AI_MODEL` (value: `"AI_MODEL"`)
9696

97+
* `API_KEY` (value: `"API_KEY"`)
98+
9799

98100

99101
---

‎pe/docs/EntityGroupControllerApi.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ void removeEntitiesFromEntityGroup(@Nonnull String entityGroupId, @Nonnull List<
3737
EntityGroupInfo saveEntityGroup(@Nonnull EntityGroup entityGroup) // Create Or Update Entity Group (saveEntityGroup)
3838
void shareEntityGroup(@Nonnull String entityGroupId, @Nonnull ShareGroupRequest shareGroupRequest) // Share the Entity Group (shareEntityGroup)
3939
void shareEntityGroupToChildOwnerUserGroup(@Nonnull String entityGroupId, @Nonnull String userGroupId, @Nonnull String roleId) // Share the Entity Group with User group (shareEntityGroupToChildOwnerUserGroup)
40+
void shareEntityGroupToChildOwnerUserGroupV2(@Nonnull UUID entityGroupId, @Nonnull ShareGroupRequest shareGroupRequest) // Share the Entity Group with User group (shareEntityGroupToChildOwnerUserGroupV2)
4041
EntityGroup unassignEntityGroupFromEdge(@Nonnull String edgeId, @Nonnull String groupType, @Nonnull String entityGroupId) // Unassign entity group from edge (unassignEntityGroupFromEdge)
4142
```
4243

@@ -945,6 +946,31 @@ Share the entity group with specified user group using specified role. Availab
945946
null (empty response body)
946947

947948

949+
## shareEntityGroupToChildOwnerUserGroupV2
950+
951+
```
952+
void shareEntityGroupToChildOwnerUserGroupV2(@Nonnull UUID entityGroupId, @Nonnull ShareGroupRequest shareGroupRequest)
953+
```
954+
955+
**POST** `/api/v2/entityGroup/{entityGroupId}/share`
956+
957+
Share the Entity Group with User group (shareEntityGroupToChildOwnerUserGroupV2)
958+
959+
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.
960+
961+
962+
### Parameters
963+
964+
| Name | Type | Description | Notes |
965+
|------------- | ------------- | ------------- | -------------|
966+
| **entityGroupId** | **UUID** | A uuid value representing the Entity Group Id that you would like to share. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
967+
| **shareGroupRequest** | **ShareGroupRequest** | | |
968+
969+
### Return type
970+
971+
null (empty response body)
972+
973+
948974
## unassignEntityGroupFromEdge
949975

950976
```

‎pe/docs/FeaturesInfo.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@
1010
| **whiteLabelingEnabled** | **Boolean** | | [optional] |
1111
| **smsEnabled** | **Boolean** | | [optional] |
1212
| **oauthEnabled** | **Boolean** | | [optional] |
13+
| **notificationEnabled** | **Boolean** | | [optional] |
1314
| **twoFaEnabled** | **Boolean** | | [optional] |
1415
| **emailEnabled** | **Boolean** | | [optional] |
15-
| **notificationEnabled** | **Boolean** | | [optional] |
1616

1717

1818

‎pe/docs/TbResource.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ A JSON value representing the Resource.
2525
| **preview** | **String** | | [optional] |
2626
| **name** | **String** | | [optional] [readonly] |
2727
| **_public** | **Boolean** | | [optional] |
28-
| **link** | **String** | | [optional] [readonly] |
2928
| **publicLink** | **String** | | [optional] [readonly] |
29+
| **link** | **String** | | [optional] [readonly] |
3030

3131

3232

‎pe/docs/TbResourceInfo.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ A JSON value representing the Resource Info.
2323
| **descriptor** | **com.fasterxml.jackson.databind.JsonNode** | Resource descriptor. | [optional] |
2424
| **name** | **String** | | [optional] [readonly] |
2525
| **_public** | **Boolean** | | [optional] |
26-
| **link** | **String** | | [optional] [readonly] |
2726
| **publicLink** | **String** | | [optional] [readonly] |
27+
| **link** | **String** | | [optional] [readonly] |
2828

2929

3030

‎pe/docs/TsKvEntry.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@
1212
| **key** | **String** | | [optional] |
1313
| **booleanValue** | **Boolean** | | [optional] |
1414
| **valueAsString** | **String** | | [optional] |
15-
| **dataType** | **DataType** | | [optional] |
16-
| **jsonValue** | **String** | | [optional] |
17-
| **strValue** | **String** | | [optional] |
1815
| **longValue** | **Long** | | [optional] |
1916
| **doubleValue** | **Double** | | [optional] |
17+
| **strValue** | **String** | | [optional] |
18+
| **dataType** | **DataType** | | [optional] |
19+
| **jsonValue** | **String** | | [optional] |
2020
| **version** | **Long** | | [optional] |
2121

2222

‎pe/spec/openapi.json‎

Lines changed: 176 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -49495,6 +49495,156 @@
4949549495
]
4949649496
}
4949749497
},
49498+
"/api/v2/entityGroup/{entityGroupId}/share": {
49499+
"post": {
49500+
"tags": [
49501+
"entity-group-controller"
49502+
],
49503+
"summary": "Share the Entity Group with User group (shareEntityGroupToChildOwnerUserGroupV2)",
49504+
"description": "Share the entity group with specified user group using specified role. \n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for specified group.",
49505+
"operationId": "shareEntityGroupToChildOwnerUserGroupV2",
49506+
"parameters": [
49507+
{
49508+
"name": "entityGroupId",
49509+
"in": "path",
49510+
"description": "A uuid value representing the Entity Group Id that you would like to share. For example, '784f394c-42b6-435a-983c-b7beff2784f9'",
49511+
"required": true,
49512+
"schema": {
49513+
"type": "string",
49514+
"format": "uuid"
49515+
}
49516+
}
49517+
],
49518+
"requestBody": {
49519+
"content": {
49520+
"application/json": {
49521+
"schema": {
49522+
"$ref": "#/components/schemas/ShareGroupRequest"
49523+
}
49524+
}
49525+
},
49526+
"required": true
49527+
},
49528+
"responses": {
49529+
"200": {
49530+
"description": "OK"
49531+
},
49532+
"400": {
49533+
"description": "Bad Request",
49534+
"content": {
49535+
"application/json": {
49536+
"schema": {
49537+
"$ref": "#/components/schemas/ThingsboardErrorResponse"
49538+
},
49539+
"examples": {
49540+
"error-code-400": {
49541+
"summary": "Bad Request",
49542+
"value": {
49543+
"status": 400,
49544+
"message": "Invalid request body",
49545+
"errorCode": 31,
49546+
"timestamp": 1609459200000
49547+
}
49548+
}
49549+
}
49550+
}
49551+
}
49552+
},
49553+
"401": {
49554+
"description": "Unauthorized",
49555+
"content": {
49556+
"application/json": {
49557+
"schema": {
49558+
"$ref": "#/components/schemas/ThingsboardErrorResponse"
49559+
},
49560+
"examples": {
49561+
"error-code-401": {
49562+
"summary": "Unauthorized",
49563+
"value": {
49564+
"status": 401,
49565+
"message": "Authentication failed",
49566+
"errorCode": 10,
49567+
"timestamp": 1609459200000
49568+
}
49569+
}
49570+
}
49571+
}
49572+
}
49573+
},
49574+
"403": {
49575+
"description": "Forbidden",
49576+
"content": {
49577+
"application/json": {
49578+
"schema": {
49579+
"$ref": "#/components/schemas/ThingsboardErrorResponse"
49580+
},
49581+
"examples": {
49582+
"error-code-403": {
49583+
"summary": "Forbidden",
49584+
"value": {
49585+
"status": 403,
49586+
"message": "You don't have permission to perform this operation!",
49587+
"errorCode": 20,
49588+
"timestamp": 1609459200000
49589+
}
49590+
}
49591+
}
49592+
}
49593+
}
49594+
},
49595+
"404": {
49596+
"description": "Not Found",
49597+
"content": {
49598+
"application/json": {
49599+
"schema": {
49600+
"$ref": "#/components/schemas/ThingsboardErrorResponse"
49601+
},
49602+
"examples": {
49603+
"error-code-404": {
49604+
"summary": "Not Found",
49605+
"value": {
49606+
"status": 404,
49607+
"message": "Requested item wasn't found!",
49608+
"errorCode": 32,
49609+
"timestamp": 1609459200000
49610+
}
49611+
}
49612+
}
49613+
}
49614+
}
49615+
},
49616+
"429": {
49617+
"description": "Too Many Requests",
49618+
"content": {
49619+
"application/json": {
49620+
"schema": {
49621+
"$ref": "#/components/schemas/ThingsboardErrorResponse"
49622+
},
49623+
"examples": {
49624+
"error-code-429": {
49625+
"summary": "Too Many Requests",
49626+
"value": {
49627+
"status": 429,
49628+
"message": "Too many requests for current tenant!",
49629+
"errorCode": 33,
49630+
"timestamp": 1609459200000
49631+
}
49632+
}
49633+
}
49634+
}
49635+
}
49636+
}
49637+
},
49638+
"security": [
49639+
{
49640+
"HttpLoginForm": []
49641+
},
49642+
{
49643+
"ApiKeyForm": []
49644+
}
49645+
]
49646+
}
49647+
},
4949849648
"/api/alarmsQuery/count": {
4949949649
"post": {
4950049650
"tags": [
@@ -117787,6 +117937,10 @@
117787117937
"version": {
117788117938
"type": "integer",
117789117939
"format": "int64"
117940+
},
117941+
"additionalInfo": {
117942+
"$ref": "#/components/schemas/JsonNode",
117943+
"description": "Additional parameters of the calculated field"
117790117944
}
117791117945
},
117792117946
"required": [
@@ -117966,6 +118120,10 @@
117966118120
"type": "integer",
117967118121
"format": "int64"
117968118122
},
118123+
"additionalInfo": {
118124+
"$ref": "#/components/schemas/JsonNode",
118125+
"description": "Additional parameters of the calculated field"
118126+
},
117969118127
"entityName": {
117970118128
"type": "string"
117971118129
}
@@ -122131,7 +122289,8 @@
122131122289
"ENCRYPTION_KEY",
122132122290
"SECRET",
122133122291
"REPORT_TEMPLATE",
122134-
"AI_MODEL"
122292+
"AI_MODEL",
122293+
"API_KEY"
122135122294
]
122136122295
},
122137122296
"EdgeId": {
@@ -124393,13 +124552,13 @@
124393124552
"oauthEnabled": {
124394124553
"type": "boolean"
124395124554
},
124396-
"twoFaEnabled": {
124555+
"notificationEnabled": {
124397124556
"type": "boolean"
124398124557
},
124399-
"emailEnabled": {
124558+
"twoFaEnabled": {
124400124559
"type": "boolean"
124401124560
},
124402-
"notificationEnabled": {
124561+
"emailEnabled": {
124403124562
"type": "boolean"
124404124563
}
124405124564
}
@@ -137004,11 +137163,11 @@
137004137163
"public": {
137005137164
"type": "boolean"
137006137165
},
137007-
"link": {
137166+
"publicLink": {
137008137167
"type": "string",
137009137168
"readOnly": true
137010137169
},
137011-
"publicLink": {
137170+
"link": {
137012137171
"type": "string",
137013137172
"readOnly": true
137014137173
}
@@ -137135,11 +137294,11 @@
137135137294
"public": {
137136137295
"type": "boolean"
137137137296
},
137138-
"link": {
137297+
"publicLink": {
137139137298
"type": "string",
137140137299
"readOnly": true
137141137300
},
137142-
"publicLink": {
137301+
"link": {
137143137302
"type": "string",
137144137303
"readOnly": true
137145137304
}
@@ -138879,15 +139038,6 @@
138879139038
"valueAsString": {
138880139039
"type": "string"
138881139040
},
138882-
"dataType": {
138883-
"$ref": "#/components/schemas/DataType"
138884-
},
138885-
"jsonValue": {
138886-
"type": "string"
138887-
},
138888-
"strValue": {
138889-
"type": "string"
138890-
},
138891139041
"longValue": {
138892139042
"type": "integer",
138893139043
"format": "int64"
@@ -138896,6 +139046,15 @@
138896139046
"type": "number",
138897139047
"format": "double"
138898139048
},
139049+
"strValue": {
139050+
"type": "string"
139051+
},
139052+
"dataType": {
139053+
"$ref": "#/components/schemas/DataType"
139054+
},
139055+
"jsonValue": {
139056+
"type": "string"
139057+
},
138899139058
"version": {
138900139059
"type": "integer",
138901139060
"format": "int64"

0 commit comments

Comments
 (0)