Skip to content

Update CE OpenAPI spec (from port-openapi) #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ViacheslavKlimov merged 1 commit into from
Apr 17, 2026
Merged

Update CE OpenAPI spec (from port-openapi) #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 0 additions & 16 deletions ce/docs/EntityDataDiff.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,6 @@
| nodes | List<RuleNode> | List of rule node JSON objects | |
| connections | List<NodeConnectionInfo> | List of JSON objects that represent connections between rule nodes | |
| ruleChainConnections | List<RuleChainConnectionInfo> | List of JSON objects that represent connections between rule nodes and other rule chains. | |
| notes | List<RuleChainNote> | List of sticky notes placed on the rule chain canvas | [optional] |

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

#### RuleChainNote
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| id | String | Unique identifier of the note on the canvas | [optional] |
| x | Integer | Horizontal position of the note on the canvas, in pixels | [optional] |
| y | Integer | Vertical position of the note on the canvas, in pixels | [optional] |
| width | Integer | Width of the note, in pixels | [optional] |
| height | Integer | Height of the note, in pixels | [optional] |
| content | String | Markdown or HTML content of the note | [optional] |
| backgroundColor | String | Background color of the note in CSS hex format, e.g. '#FFF9C4' | [optional] |
| borderColor | String | Border color of the note in CSS hex format, e.g. '#E6C800' | [optional] |
| borderWidth | Integer | Border width of the note in pixels | [optional] |
| applyDefaultMarkdownStyle | Boolean | Whether to apply the default markdown stylesheet to the note content | [optional] |
| markdownCss | String | Custom CSS styles applied to the note content | [optional] |

#### AttributeScope (enum)
`CLIENT_SCOPE` | `SERVER_SCOPE` | `SHARED_SCOPE`

Expand Down
16 changes: 0 additions & 16 deletions ce/docs/EntityExportData.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,6 @@ Base export container for ThingsBoard entities
| nodes | List<RuleNode> | List of rule node JSON objects | |
| connections | List<NodeConnectionInfo> | List of JSON objects that represent connections between rule nodes | |
| ruleChainConnections | List<RuleChainConnectionInfo> | List of JSON objects that represent connections between rule nodes and other rule chains. | |
| notes | List<RuleChainNote> | List of sticky notes placed on the rule chain canvas | [optional] |

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

#### RuleChainNote
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| id | String | Unique identifier of the note on the canvas | [optional] |
| x | Integer | Horizontal position of the note on the canvas, in pixels | [optional] |
| y | Integer | Vertical position of the note on the canvas, in pixels | [optional] |
| width | Integer | Width of the note, in pixels | [optional] |
| height | Integer | Height of the note, in pixels | [optional] |
| content | String | Markdown or HTML content of the note | [optional] |
| backgroundColor | String | Background color of the note in CSS hex format, e.g. '#FFF9C4' | [optional] |
| borderColor | String | Border color of the note in CSS hex format, e.g. '#E6C800' | [optional] |
| borderWidth | Integer | Border width of the note in pixels | [optional] |
| applyDefaultMarkdownStyle | Boolean | Whether to apply the default markdown stylesheet to the note content | [optional] |
| markdownCss | String | Custom CSS styles applied to the note content | [optional] |

#### Output
| Name | Type | Description | Notes |
|------|------|-------------|-------|
Expand Down
2 changes: 1 addition & 1 deletion ce/docs/OAuth2Client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
|------------ | ------------- | ------------- | -------------|
| **id** | **OAuth2ClientId** | | [optional] |
| **createdTime** | **Long** | Entity creation timestamp in milliseconds since Unix epoch | [optional] [readonly] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional info of OAuth2 client (e.g. providerName) | |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional info of OAuth2 client. Must include: 'providerName' (string, name of the OAuth2 provider). | |
| **tenantId** | **TenantId** | JSON object with Tenant Id | [optional] |
| **title** | **String** | Oauth2 client title | |
| **mapperConfig** | **OAuth2MapperConfig** | Config for mapping OAuth2 log in response to platform entities | |
Expand Down
16 changes: 0 additions & 16 deletions ce/docs/RuleChainData.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ A JSON value representing the rule chains.
| nodes | List<RuleNode> | List of rule node JSON objects | |
| connections | List<NodeConnectionInfo> | List of JSON objects that represent connections between rule nodes | |
| ruleChainConnections | List<RuleChainConnectionInfo> | List of JSON objects that represent connections between rule nodes and other rule chains. | |
| notes | List<RuleChainNote> | List of sticky notes placed on the rule chain canvas | [optional] |

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

#### RuleChainNote
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| id | String | Unique identifier of the note on the canvas | [optional] |
| x | Integer | Horizontal position of the note on the canvas, in pixels | [optional] |
| y | Integer | Vertical position of the note on the canvas, in pixels | [optional] |
| width | Integer | Width of the note, in pixels | [optional] |
| height | Integer | Height of the note, in pixels | [optional] |
| content | String | Markdown or HTML content of the note | [optional] |
| backgroundColor | String | Background color of the note in CSS hex format, e.g. '#FFF9C4' | [optional] |
| borderColor | String | Border color of the note in CSS hex format, e.g. '#E6C800' | [optional] |
| borderWidth | Integer | Border width of the note in pixels | [optional] |
| applyDefaultMarkdownStyle | Boolean | Whether to apply the default markdown stylesheet to the note content | [optional] |
| markdownCss | String | Custom CSS styles applied to the note content | [optional] |

#### DebugSettings
| Name | Type | Description | Notes |
|------|------|-------------|-------|
Expand Down
16 changes: 0 additions & 16 deletions ce/docs/RuleChainExportData.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@
| nodes | List<RuleNode> | List of rule node JSON objects | |
| connections | List<NodeConnectionInfo> | List of JSON objects that represent connections between rule nodes | |
| ruleChainConnections | List<RuleChainConnectionInfo> | List of JSON objects that represent connections between rule nodes and other rule chains. | |
| notes | List<RuleChainNote> | List of sticky notes placed on the rule chain canvas | [optional] |

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

#### RuleChainNote
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| id | String | Unique identifier of the note on the canvas | [optional] |
| x | Integer | Horizontal position of the note on the canvas, in pixels | [optional] |
| y | Integer | Vertical position of the note on the canvas, in pixels | [optional] |
| width | Integer | Width of the note, in pixels | [optional] |
| height | Integer | Height of the note, in pixels | [optional] |
| content | String | Markdown or HTML content of the note | [optional] |
| backgroundColor | String | Background color of the note in CSS hex format, e.g. '#FFF9C4' | [optional] |
| borderColor | String | Border color of the note in CSS hex format, e.g. '#E6C800' | [optional] |
| borderWidth | Integer | Border width of the note in pixels | [optional] |
| applyDefaultMarkdownStyle | Boolean | Whether to apply the default markdown stylesheet to the note content | [optional] |
| markdownCss | String | Custom CSS styles applied to the note content | [optional] |

#### RelationTypeGroup (enum)
`COMMON` | `DASHBOARD` | `RULE_CHAIN` | `RULE_NODE` | `EDGE` | `EDGE_AUTO_ASSIGN_RULE_CHAIN`

Expand Down
16 changes: 0 additions & 16 deletions ce/docs/RuleChainMetaData.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ A JSON value representing the rule chain metadata.
| **nodes** | **List\<RuleNode\>** | List of rule node JSON objects | |
| **connections** | **List\<NodeConnectionInfo\>** | List of JSON objects that represent connections between rule nodes | |
| **ruleChainConnections** | **List\<RuleChainConnectionInfo\>** | List of JSON objects that represent connections between rule nodes and other rule chains. | |
| **notes** | **List\<RuleChainNote\>** | List of sticky notes placed on the rule chain canvas | [optional] |



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

#### RuleChainNote
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| id | String | Unique identifier of the note on the canvas | [optional] |
| x | Integer | Horizontal position of the note on the canvas, in pixels | [optional] |
| y | Integer | Vertical position of the note on the canvas, in pixels | [optional] |
| width | Integer | Width of the note, in pixels | [optional] |
| height | Integer | Height of the note, in pixels | [optional] |
| content | String | Markdown or HTML content of the note | [optional] |
| backgroundColor | String | Background color of the note in CSS hex format, e.g. '#FFF9C4' | [optional] |
| borderColor | String | Border color of the note in CSS hex format, e.g. '#E6C800' | [optional] |
| borderWidth | Integer | Border width of the note in pixels | [optional] |
| applyDefaultMarkdownStyle | Boolean | Whether to apply the default markdown stylesheet to the note content | [optional] |
| markdownCss | String | Custom CSS styles applied to the note content | [optional] |

#### DebugSettings
| Name | Type | Description | Notes |
|------|------|-------------|-------|
Expand Down
32 changes: 0 additions & 32 deletions ce/docs/RuleChainNote.md
View file
Open in desktop

This file was deleted.

36 changes: 18 additions & 18 deletions ce/docs/UserControllerApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ String getActivationLink(@Nonnull String userId) // Get activation link (getActi
UserActivationLink getActivationLinkInfo(@Nonnull String userId) // Get activation link info (getActivationLinkInfo)
PageDataUser getCustomerUsers(@Nonnull String customerId, @Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get Customer Users (getCustomerUsers)
com.fasterxml.jackson.databind.JsonNode getGeneralUserSettings() // Get user settings (getGeneralUserSettings)
UserDashboardsInfo getLastVisitedDashboards() // Get information about last visited and starred dashboards (getLastVisitedDashboards)
MobileSessionInfo getMobileSession(@Nonnull String xMobileToken) // getMobileSession
PageDataUser getTenantAdmins(@Nonnull String tenantId, @Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get Tenant Users (getTenantAdmins)
User getUserById(@Nonnull String userId) // Get User (getUserById)
UserDashboardsInfo getUserDashboardsInfo() // Get information about last visited and starred dashboards (getUserDashboardsInfo)
com.fasterxml.jackson.databind.JsonNode getUserSettings(@Nonnull String type) // Get user settings (getUserSettings)
JwtPair getUserToken(@Nonnull String userId) // Get User Token (getUserToken)
PageDataUser getUsers(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get Users (getUsers)
Expand Down Expand Up @@ -228,6 +228,23 @@ Fetch the User settings based on authorized user.
**com.fasterxml.jackson.databind.JsonNode**


## getLastVisitedDashboards

```
UserDashboardsInfo getLastVisitedDashboards()
```

**GET** `/api/user/lastVisitedDashboards`

Get information about last visited and starred dashboards (getLastVisitedDashboards)

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.

### Return type

**UserDashboardsInfo**


## getMobileSession

```
Expand Down Expand Up @@ -303,23 +320,6 @@ Fetch the User object based on the provided User Id. If the user has the authori
**User**


## getUserDashboardsInfo

```
UserDashboardsInfo getUserDashboardsInfo()
```

**GET** `/api/user/dashboards`

Get information about last visited and starred dashboards (getUserDashboardsInfo)

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.

### Return type

**UserDashboardsInfo**


## getUserSettings

```
Expand Down
2 changes: 1 addition & 1 deletion ce/docs/WidgetTypeControllerApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Returns an array of Widget Type fqns that belong to specified Widget Bundle. Av
List<WidgetType> getBundleWidgetTypes(@Nonnull String widgetsBundleId)
```

**GET** `/api/widgetsBundles/{widgetsBundleId}/widgetTypes`
**GET** `/api/widgetsBundle/{widgetsBundleId}/widgetTypes`

Get all Widget types for specified Bundle (getBundleWidgetTypes)

Expand Down
Loading
Loading