Skip to content

Commit db8b6ac

Browse files
ViacheslavKlimovViacheslavKlimov
committed
Update CE OpenAPI spec (from port-openapi)
1 parent faa097d commit db8b6ac

14 files changed

Lines changed: 198 additions & 935 deletions

‎ce/docs/EntityDataDiff.md‎

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,6 @@
227227
| nodes | List<RuleNode> | List of rule node JSON objects | |
228228
| connections | List<NodeConnectionInfo> | List of JSON objects that represent connections between rule nodes | |
229229
| ruleChainConnections | List<RuleChainConnectionInfo> | List of JSON objects that represent connections between rule nodes and other rule chains. | |
230-
| notes | List<RuleChainNote> | List of sticky notes placed on the rule chain canvas | [optional] |
231230

232231
#### Output
233232
| Name | Type | Description | Notes |
@@ -288,21 +287,6 @@
288287
| additionalInfo | com.fasterxml.jackson.databind.JsonNode | JSON object with the additional information about the connection. | |
289288
| type | String | Type of the relation. Typically indicated the result of processing by the 'from' rule node. For example, 'Success' or 'Failure' | |
290289

291-
#### RuleChainNote
292-
| Name | Type | Description | Notes |
293-
|------|------|-------------|-------|
294-
| id | String | Unique identifier of the note on the canvas | [optional] |
295-
| x | Integer | Horizontal position of the note on the canvas, in pixels | [optional] |
296-
| y | Integer | Vertical position of the note on the canvas, in pixels | [optional] |
297-
| width | Integer | Width of the note, in pixels | [optional] |
298-
| height | Integer | Height of the note, in pixels | [optional] |
299-
| content | String | Markdown or HTML content of the note | [optional] |
300-
| backgroundColor | String | Background color of the note in CSS hex format, e.g. '#FFF9C4' | [optional] |
301-
| borderColor | String | Border color of the note in CSS hex format, e.g. '#E6C800' | [optional] |
302-
| borderWidth | Integer | Border width of the note in pixels | [optional] |
303-
| applyDefaultMarkdownStyle | Boolean | Whether to apply the default markdown stylesheet to the note content | [optional] |
304-
| markdownCss | String | Custom CSS styles applied to the note content | [optional] |
305-
306290
#### AttributeScope (enum)
307291
`CLIENT_SCOPE` | `SERVER_SCOPE` | `SHARED_SCOPE`
308292

‎ce/docs/EntityExportData.md‎

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,6 @@ Base export container for ThingsBoard entities
146146
| nodes | List<RuleNode> | List of rule node JSON objects | |
147147
| connections | List<NodeConnectionInfo> | List of JSON objects that represent connections between rule nodes | |
148148
| ruleChainConnections | List<RuleChainConnectionInfo> | List of JSON objects that represent connections between rule nodes and other rule chains. | |
149-
| notes | List<RuleChainNote> | List of sticky notes placed on the rule chain canvas | [optional] |
150149

151150
#### RelationTypeGroup (enum)
152151
`COMMON` | `DASHBOARD` | `RULE_CHAIN` | `RULE_NODE` | `EDGE` | `EDGE_AUTO_ASSIGN_RULE_CHAIN`
@@ -267,21 +266,6 @@ Base export container for ThingsBoard entities
267266
| additionalInfo | com.fasterxml.jackson.databind.JsonNode | JSON object with the additional information about the connection. | |
268267
| type | String | Type of the relation. Typically indicated the result of processing by the 'from' rule node. For example, 'Success' or 'Failure' | |
269268

270-
#### RuleChainNote
271-
| Name | Type | Description | Notes |
272-
|------|------|-------------|-------|
273-
| id | String | Unique identifier of the note on the canvas | [optional] |
274-
| x | Integer | Horizontal position of the note on the canvas, in pixels | [optional] |
275-
| y | Integer | Vertical position of the note on the canvas, in pixels | [optional] |
276-
| width | Integer | Width of the note, in pixels | [optional] |
277-
| height | Integer | Height of the note, in pixels | [optional] |
278-
| content | String | Markdown or HTML content of the note | [optional] |
279-
| backgroundColor | String | Background color of the note in CSS hex format, e.g. '#FFF9C4' | [optional] |
280-
| borderColor | String | Border color of the note in CSS hex format, e.g. '#E6C800' | [optional] |
281-
| borderWidth | Integer | Border width of the note in pixels | [optional] |
282-
| applyDefaultMarkdownStyle | Boolean | Whether to apply the default markdown stylesheet to the note content | [optional] |
283-
| markdownCss | String | Custom CSS styles applied to the note content | [optional] |
284-
285269
#### Output
286270
| Name | Type | Description | Notes |
287271
|------|------|-------------|-------|

‎ce/docs/OAuth2Client.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
|------------ | ------------- | ------------- | -------------|
1010
| **id** | **OAuth2ClientId** | | [optional] |
1111
| **createdTime** | **Long** | Entity creation timestamp in milliseconds since Unix epoch | [optional] [readonly] |
12-
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional info of OAuth2 client (e.g. providerName) | |
12+
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional info of OAuth2 client. Must include: 'providerName' (string, name of the OAuth2 provider). | |
1313
| **tenantId** | **TenantId** | JSON object with Tenant Id | [optional] |
1414
| **title** | **String** | Oauth2 client title | |
1515
| **mapperConfig** | **OAuth2MapperConfig** | Config for mapping OAuth2 log in response to platform entities | |

‎ce/docs/RuleChainData.md‎

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ A JSON value representing the rule chains.
4242
| nodes | List<RuleNode> | List of rule node JSON objects | |
4343
| connections | List<NodeConnectionInfo> | List of JSON objects that represent connections between rule nodes | |
4444
| ruleChainConnections | List<RuleChainConnectionInfo> | List of JSON objects that represent connections between rule nodes and other rule chains. | |
45-
| notes | List<RuleChainNote> | List of sticky notes placed on the rule chain canvas | [optional] |
4645

4746
#### RuleChainType (enum)
4847
`CORE` | `EDGE`
@@ -79,21 +78,6 @@ A JSON value representing the rule chains.
7978
| additionalInfo | com.fasterxml.jackson.databind.JsonNode | JSON object with the additional information about the connection. | |
8079
| type | String | Type of the relation. Typically indicated the result of processing by the 'from' rule node. For example, 'Success' or 'Failure' | |
8180

82-
#### RuleChainNote
83-
| Name | Type | Description | Notes |
84-
|------|------|-------------|-------|
85-
| id | String | Unique identifier of the note on the canvas | [optional] |
86-
| x | Integer | Horizontal position of the note on the canvas, in pixels | [optional] |
87-
| y | Integer | Vertical position of the note on the canvas, in pixels | [optional] |
88-
| width | Integer | Width of the note, in pixels | [optional] |
89-
| height | Integer | Height of the note, in pixels | [optional] |
90-
| content | String | Markdown or HTML content of the note | [optional] |
91-
| backgroundColor | String | Background color of the note in CSS hex format, e.g. '#FFF9C4' | [optional] |
92-
| borderColor | String | Border color of the note in CSS hex format, e.g. '#E6C800' | [optional] |
93-
| borderWidth | Integer | Border width of the note in pixels | [optional] |
94-
| applyDefaultMarkdownStyle | Boolean | Whether to apply the default markdown stylesheet to the note content | [optional] |
95-
| markdownCss | String | Custom CSS styles applied to the note content | [optional] |
96-
9781
#### DebugSettings
9882
| Name | Type | Description | Notes |
9983
|------|------|-------------|-------|

‎ce/docs/RuleChainExportData.md‎

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@
3535
| nodes | List<RuleNode> | List of rule node JSON objects | |
3636
| connections | List<NodeConnectionInfo> | List of JSON objects that represent connections between rule nodes | |
3737
| ruleChainConnections | List<RuleChainConnectionInfo> | List of JSON objects that represent connections between rule nodes and other rule chains. | |
38-
| notes | List<RuleChainNote> | List of sticky notes placed on the rule chain canvas | [optional] |
3938

4039
#### ExportableEntity
4140
| Name | Type | Description | Notes |
@@ -117,21 +116,6 @@
117116
| additionalInfo | com.fasterxml.jackson.databind.JsonNode | JSON object with the additional information about the connection. | |
118117
| type | String | Type of the relation. Typically indicated the result of processing by the 'from' rule node. For example, 'Success' or 'Failure' | |
119118

120-
#### RuleChainNote
121-
| Name | Type | Description | Notes |
122-
|------|------|-------------|-------|
123-
| id | String | Unique identifier of the note on the canvas | [optional] |
124-
| x | Integer | Horizontal position of the note on the canvas, in pixels | [optional] |
125-
| y | Integer | Vertical position of the note on the canvas, in pixels | [optional] |
126-
| width | Integer | Width of the note, in pixels | [optional] |
127-
| height | Integer | Height of the note, in pixels | [optional] |
128-
| content | String | Markdown or HTML content of the note | [optional] |
129-
| backgroundColor | String | Background color of the note in CSS hex format, e.g. '#FFF9C4' | [optional] |
130-
| borderColor | String | Border color of the note in CSS hex format, e.g. '#E6C800' | [optional] |
131-
| borderWidth | Integer | Border width of the note in pixels | [optional] |
132-
| applyDefaultMarkdownStyle | Boolean | Whether to apply the default markdown stylesheet to the note content | [optional] |
133-
| markdownCss | String | Custom CSS styles applied to the note content | [optional] |
134-
135119
#### RelationTypeGroup (enum)
136120
`COMMON` | `DASHBOARD` | `RULE_CHAIN` | `RULE_NODE` | `EDGE` | `EDGE_AUTO_ASSIGN_RULE_CHAIN`
137121

‎ce/docs/RuleChainMetaData.md‎

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ A JSON value representing the rule chain metadata.
1515
| **nodes** | **List\<RuleNode\>** | List of rule node JSON objects | |
1616
| **connections** | **List\<NodeConnectionInfo\>** | List of JSON objects that represent connections between rule nodes | |
1717
| **ruleChainConnections** | **List\<RuleChainConnectionInfo\>** | List of JSON objects that represent connections between rule nodes and other rule chains. | |
18-
| **notes** | **List\<RuleChainNote\>** | List of sticky notes placed on the rule chain canvas | [optional] |
1918

2019

2120

@@ -55,21 +54,6 @@ A JSON value representing the rule chain metadata.
5554
| additionalInfo | com.fasterxml.jackson.databind.JsonNode | JSON object with the additional information about the connection. | |
5655
| type | String | Type of the relation. Typically indicated the result of processing by the 'from' rule node. For example, 'Success' or 'Failure' | |
5756

58-
#### RuleChainNote
59-
| Name | Type | Description | Notes |
60-
|------|------|-------------|-------|
61-
| id | String | Unique identifier of the note on the canvas | [optional] |
62-
| x | Integer | Horizontal position of the note on the canvas, in pixels | [optional] |
63-
| y | Integer | Vertical position of the note on the canvas, in pixels | [optional] |
64-
| width | Integer | Width of the note, in pixels | [optional] |
65-
| height | Integer | Height of the note, in pixels | [optional] |
66-
| content | String | Markdown or HTML content of the note | [optional] |
67-
| backgroundColor | String | Background color of the note in CSS hex format, e.g. '#FFF9C4' | [optional] |
68-
| borderColor | String | Border color of the note in CSS hex format, e.g. '#E6C800' | [optional] |
69-
| borderWidth | Integer | Border width of the note in pixels | [optional] |
70-
| applyDefaultMarkdownStyle | Boolean | Whether to apply the default markdown stylesheet to the note content | [optional] |
71-
| markdownCss | String | Custom CSS styles applied to the note content | [optional] |
72-
7357
#### DebugSettings
7458
| Name | Type | Description | Notes |
7559
|------|------|-------------|-------|

‎ce/docs/RuleChainNote.md‎

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

‎ce/docs/UserControllerApi.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ String getActivationLink(@Nonnull String userId) // Get activation link (getActi
1111
UserActivationLink getActivationLinkInfo(@Nonnull String userId) // Get activation link info (getActivationLinkInfo)
1212
PageDataUser getCustomerUsers(@Nonnull String customerId, @Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get Customer Users (getCustomerUsers)
1313
com.fasterxml.jackson.databind.JsonNode getGeneralUserSettings() // Get user settings (getGeneralUserSettings)
14+
UserDashboardsInfo getLastVisitedDashboards() // Get information about last visited and starred dashboards (getLastVisitedDashboards)
1415
MobileSessionInfo getMobileSession(@Nonnull String xMobileToken) // getMobileSession
1516
PageDataUser getTenantAdmins(@Nonnull String tenantId, @Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get Tenant Users (getTenantAdmins)
1617
User getUserById(@Nonnull String userId) // Get User (getUserById)
17-
UserDashboardsInfo getUserDashboardsInfo() // Get information about last visited and starred dashboards (getUserDashboardsInfo)
1818
com.fasterxml.jackson.databind.JsonNode getUserSettings(@Nonnull String type) // Get user settings (getUserSettings)
1919
JwtPair getUserToken(@Nonnull String userId) // Get User Token (getUserToken)
2020
PageDataUser getUsers(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get Users (getUsers)
@@ -228,6 +228,23 @@ Fetch the User settings based on authorized user.
228228
**com.fasterxml.jackson.databind.JsonNode**
229229

230230

231+
## getLastVisitedDashboards
232+
233+
```
234+
UserDashboardsInfo getLastVisitedDashboards()
235+
```
236+
237+
**GET** `/api/user/lastVisitedDashboards`
238+
239+
Get information about last visited and starred dashboards (getLastVisitedDashboards)
240+
241+
Fetch the list of last visited and starred dashboards. Both lists are limited to 10 items. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
242+
243+
### Return type
244+
245+
**UserDashboardsInfo**
246+
247+
231248
## getMobileSession
232249

233250
```
@@ -303,23 +320,6 @@ Fetch the User object based on the provided User Id. If the user has the authori
303320
**User**
304321

305322

306-
## getUserDashboardsInfo
307-
308-
```
309-
UserDashboardsInfo getUserDashboardsInfo()
310-
```
311-
312-
**GET** `/api/user/dashboards`
313-
314-
Get information about last visited and starred dashboards (getUserDashboardsInfo)
315-
316-
Fetch the list of last visited and starred dashboards. Both lists are limited to 10 items. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
317-
318-
### Return type
319-
320-
**UserDashboardsInfo**
321-
322-
323323
## getUserSettings
324324

325325
```

‎ce/docs/WidgetTypeControllerApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Returns an array of Widget Type fqns that belong to specified Widget Bundle. Av
7070
List<WidgetType> getBundleWidgetTypes(@Nonnull String widgetsBundleId)
7171
```
7272

73-
**GET** `/api/widgetsBundles/{widgetsBundleId}/widgetTypes`
73+
**GET** `/api/widgetsBundle/{widgetsBundleId}/widgetTypes`
7474

7575
Get all Widget types for specified Bundle (getBundleWidgetTypes)
7676

0 commit comments

Comments
 (0)