Skip to content

Commit 2be2057

Browse files
dashevchenkodashevchenko
committed
regenerated clients
1 parent 9504fb8 commit 2be2057

13 files changed

Lines changed: 175 additions & 1306 deletions

File tree

‎ce/docs/EntityRelationControllerApi.md‎

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

33
| Method | HTTP request | Description |
44
|------------- | ------------- | -------------|
5-
| [**deleteRelation**](#deleteRelation) | **DELETE** /api/relation | Delete Relation (deleteRelation) |
6-
| [**deleteRelationAndReturn**](#deleteRelationAndReturn) | **DELETE** /api/v2/relation | Delete Relation (deleteRelationAndReturn) |
5+
| [**deleteRelation**](#deleteRelation) | **DELETE** /api/v2/relation | Delete Relation (deleteRelation) |
76
| [**deleteRelations**](#deleteRelations) | **DELETE** /api/relations | Delete common relations (deleteRelations) |
87
| [**findEntityRelationInfosByFrom**](#findEntityRelationInfosByFrom) | **GET** /api/relations/info/from/{fromType}/{fromId} | Get List of Relation Infos (findEntityRelationInfosByFrom) |
98
| [**findEntityRelationInfosByQuery**](#findEntityRelationInfosByQuery) | **POST** /api/relations/info | Find related entity infos (findEntityRelationInfosByQuery) |
@@ -20,38 +19,13 @@
2019

2120
## deleteRelation
2221

23-
> deleteRelation(fromId, fromType, relationType, toId, toType, relationTypeGroup)
22+
> EntityRelation deleteRelation(fromId, fromType, relationType, toId, toType, relationTypeGroup)
2423
2524
Delete Relation (deleteRelation)
2625

2726
Deletes a relation between two entities in the platform. If the user has the authority of 'System Administrator', the server checks that 'from' and 'to' entities are owned by the sysadmin. If the user has the authority of 'Tenant Administrator', the server checks that 'from' and 'to' entities are owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the 'from' and 'to' entities are assigned to the same customer.
2827

2928

30-
### Parameters
31-
32-
| Name | Type | Description | Notes |
33-
|------------- | ------------- | ------------- | -------------|
34-
| **fromId** | **String** | A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
35-
| **fromType** | **String** | A string value representing the entity type. For example, 'DEVICE' | |
36-
| **relationType** | **String** | A string value representing relation type between entities. For example, 'Contains', 'Manages'. It can be any string value. | |
37-
| **toId** | **String** | A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
38-
| **toType** | **String** | A string value representing the entity type. For example, 'DEVICE' | |
39-
| **relationTypeGroup** | **String** | A string value representing relation type group. For example, 'COMMON' | [optional] |
40-
41-
### Return type
42-
43-
null (empty response body)
44-
45-
46-
## deleteRelationAndReturn
47-
48-
> EntityRelation deleteRelationAndReturn(fromId, fromType, relationType, toId, toType, relationTypeGroup)
49-
50-
Delete Relation (deleteRelationAndReturn)
51-
52-
Deletes a relation between two entities in the platform. If the user has the authority of 'System Administrator', the server checks that 'from' and 'to' entities are owned by the sysadmin. If the user has the authority of 'Tenant Administrator', the server checks that 'from' and 'to' entities are owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the 'from' and 'to' entities are assigned to the same customer.
53-
54-
5529
### Parameters
5630

5731
| Name | Type | Description | Notes |

‎ce/spec/openapi.json‎

Lines changed: 4 additions & 186 deletions
Original file line numberDiff line numberDiff line change
@@ -38572,188 +38572,6 @@
3857238572
"ApiKeyForm": []
3857338573
}
3857438574
]
38575-
},
38576-
"delete": {
38577-
"tags": [
38578-
"entity-relation-controller"
38579-
],
38580-
"summary": "Delete Relation (deleteRelation)",
38581-
"description": "Deletes a relation between two entities in the platform. \n\nIf the user has the authority of 'System Administrator', the server checks that 'from' and 'to' entities are owned by the sysadmin. If the user has the authority of 'Tenant Administrator', the server checks that 'from' and 'to' entities are owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the 'from' and 'to' entities are assigned to the same customer.",
38582-
"operationId": "deleteRelation",
38583-
"parameters": [
38584-
{
38585-
"name": "fromId",
38586-
"in": "query",
38587-
"description": "A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'",
38588-
"required": true,
38589-
"schema": {
38590-
"type": "string"
38591-
}
38592-
},
38593-
{
38594-
"name": "fromType",
38595-
"in": "query",
38596-
"description": "A string value representing the entity type. For example, 'DEVICE'",
38597-
"required": true,
38598-
"schema": {
38599-
"type": "string"
38600-
}
38601-
},
38602-
{
38603-
"name": "relationType",
38604-
"in": "query",
38605-
"description": "A string value representing relation type between entities. For example, 'Contains', 'Manages'. It can be any string value.",
38606-
"required": true,
38607-
"schema": {
38608-
"type": "string"
38609-
}
38610-
},
38611-
{
38612-
"name": "relationTypeGroup",
38613-
"in": "query",
38614-
"description": "A string value representing relation type group. For example, 'COMMON'",
38615-
"required": false,
38616-
"schema": {
38617-
"type": "string"
38618-
}
38619-
},
38620-
{
38621-
"name": "toId",
38622-
"in": "query",
38623-
"description": "A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'",
38624-
"required": true,
38625-
"schema": {
38626-
"type": "string"
38627-
}
38628-
},
38629-
{
38630-
"name": "toType",
38631-
"in": "query",
38632-
"description": "A string value representing the entity type. For example, 'DEVICE'",
38633-
"required": true,
38634-
"schema": {
38635-
"type": "string"
38636-
}
38637-
}
38638-
],
38639-
"responses": {
38640-
"200": {
38641-
"description": "OK"
38642-
},
38643-
"400": {
38644-
"description": "Bad Request",
38645-
"content": {
38646-
"application/json": {
38647-
"schema": {
38648-
"$ref": "#/components/schemas/ThingsboardErrorResponse"
38649-
},
38650-
"examples": {
38651-
"error-code-400": {
38652-
"summary": "Bad Request",
38653-
"value": {
38654-
"status": 400,
38655-
"message": "Invalid UUID string: 123",
38656-
"errorCode": 31,
38657-
"timestamp": 1609459200000
38658-
}
38659-
}
38660-
}
38661-
}
38662-
}
38663-
},
38664-
"401": {
38665-
"description": "Unauthorized",
38666-
"content": {
38667-
"application/json": {
38668-
"schema": {
38669-
"$ref": "#/components/schemas/ThingsboardErrorResponse"
38670-
},
38671-
"examples": {
38672-
"error-code-401": {
38673-
"summary": "Unauthorized",
38674-
"value": {
38675-
"status": 401,
38676-
"message": "Authentication failed",
38677-
"errorCode": 10,
38678-
"timestamp": 1609459200000
38679-
}
38680-
}
38681-
}
38682-
}
38683-
}
38684-
},
38685-
"403": {
38686-
"description": "Forbidden",
38687-
"content": {
38688-
"application/json": {
38689-
"schema": {
38690-
"$ref": "#/components/schemas/ThingsboardErrorResponse"
38691-
},
38692-
"examples": {
38693-
"error-code-403": {
38694-
"summary": "Forbidden",
38695-
"value": {
38696-
"status": 403,
38697-
"message": "You don't have permission to perform this operation!",
38698-
"errorCode": 20,
38699-
"timestamp": 1609459200000
38700-
}
38701-
}
38702-
}
38703-
}
38704-
}
38705-
},
38706-
"404": {
38707-
"description": "Not Found",
38708-
"content": {
38709-
"application/json": {
38710-
"schema": {
38711-
"$ref": "#/components/schemas/ThingsboardErrorResponse"
38712-
},
38713-
"examples": {
38714-
"error-code-404": {
38715-
"summary": "Not Found",
38716-
"value": {
38717-
"status": 404,
38718-
"message": "Requested item wasn't found!",
38719-
"errorCode": 32,
38720-
"timestamp": 1609459200000
38721-
}
38722-
}
38723-
}
38724-
}
38725-
}
38726-
},
38727-
"429": {
38728-
"description": "Too Many Requests",
38729-
"content": {
38730-
"application/json": {
38731-
"schema": {
38732-
"$ref": "#/components/schemas/ThingsboardErrorResponse"
38733-
},
38734-
"examples": {
38735-
"error-code-429": {
38736-
"summary": "Too Many Requests",
38737-
"value": {
38738-
"status": 429,
38739-
"message": "Too many requests for current tenant!",
38740-
"errorCode": 33,
38741-
"timestamp": 1609459200000
38742-
}
38743-
}
38744-
}
38745-
}
38746-
}
38747-
}
38748-
},
38749-
"security": [
38750-
{
38751-
"HttpLoginForm": []
38752-
},
38753-
{
38754-
"ApiKeyForm": []
38755-
}
38756-
]
3875738575
}
3875838576
},
3875938577
"/api/relations": {
@@ -40366,9 +40184,9 @@
4036640184
"tags": [
4036740185
"entity-relation-controller"
4036840186
],
40369-
"summary": "Delete Relation (deleteRelationAndReturn)",
40187+
"summary": "Delete Relation (deleteRelation)",
4037040188
"description": "Deletes a relation between two entities in the platform. \n\nIf the user has the authority of 'System Administrator', the server checks that 'from' and 'to' entities are owned by the sysadmin. If the user has the authority of 'Tenant Administrator', the server checks that 'from' and 'to' entities are owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the 'from' and 'to' entities are assigned to the same customer.",
40371-
"operationId": "deleteRelationAndReturn",
40189+
"operationId": "deleteRelation",
4037240190
"parameters": [
4037340191
{
4037440192
"name": "fromId",
@@ -47111,7 +46929,7 @@
4711146929
"message": "User password expired!",
4711246930
"errorCode": 15,
4711346931
"timestamp": 1609459200000,
47114-
"resetToken": "GKUiVvgXp7IFwt5ZQhyTLh0MsE8trE"
46932+
"resetToken": "udgDQOpS1Q4ZFEL8qHF9s8cSKQ7d1h"
4711546933
}
4711646934
}
4711746935
}
@@ -47221,7 +47039,7 @@
4722147039
"message": "User password expired!",
4722247040
"errorCode": 15,
4722347041
"timestamp": 1609459200000,
47224-
"resetToken": "GKUiVvgXp7IFwt5ZQhyTLh0MsE8trE"
47042+
"resetToken": "udgDQOpS1Q4ZFEL8qHF9s8cSKQ7d1h"
4722547043
}
4722647044
}
4722747045
}

0 commit comments

Comments
 (0)