Skip to content

Update CE OpenAPI spec (from master) #36

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

Open
ViacheslavKlimov wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update CE OpenAPI spec (from master) #36

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
10 changes: 6 additions & 4 deletions ce/docs/AlarmCountQuery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ A JSON value representing the alarm count query.
|------------ | ------------- | ------------- | -------------|
| **entityFilter** | **EntityFilter** | | [optional] |
| **keyFilters** | **List\<KeyFilter\>** | | [optional] |
| **keyFiltersOperation** | **AlarmRuleComplexOperation** | | [optional] |
| **startTs** | **Long** | | [optional] |
| **endTs** | **Long** | | [optional] |
| **timeWindow** | **Long** | | [optional] |
Expand All @@ -19,6 +20,7 @@ A JSON value representing the alarm count query.
| **severityList** | **List\<AlarmSeverity\>** | | [optional] |
| **searchPropagatedAlarms** | **Boolean** | | [optional] |
| **assigneeId** | **UserId** | | [optional] |
| **keyFiltersOperationOrDefault** | **AlarmRuleComplexOperation** | | [optional] |



Expand Down Expand Up @@ -156,6 +158,9 @@ A JSON value representing the alarm count query.
| valueType | EntityKeyValueType | | [optional] |
| predicate | KeyFilterPredicate | | [optional] |

#### AlarmRuleComplexOperation (enum)
`AND` | `OR`

#### AlarmSearchStatus (enum)
`ANY` | `ACTIVE` | `CLEARED` | `ACK` | `UNACK`

Expand Down Expand Up @@ -185,7 +190,7 @@ A JSON value representing the alarm count query.
#### ComplexFilterPredicate *(extends KeyFilterPredicate, type=`COMPLEX`)*
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| operation | ComplexOperation | | [optional] |
| operation | AlarmRuleComplexOperation | | [optional] |
| predicates | List<KeyFilterPredicate> | | [optional] |

#### NumericFilterPredicate *(extends KeyFilterPredicate, type=`NUMERIC`)*
Expand Down Expand Up @@ -257,9 +262,6 @@ A JSON value representing the alarm count query.
| userValue | Boolean | | [optional] |
| dynamicValue | DynamicValueBoolean | | [optional] |

#### ComplexOperation (enum)
`AND` | `OR`

#### DynamicValueString
| Name | Type | Description | Notes |
|------|------|-------------|-------|
Expand Down
10 changes: 6 additions & 4 deletions ce/docs/AlarmDataQuery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,12 @@ A JSON value representing the alarm data query. See API call notes above for mor
|------------ | ------------- | ------------- | -------------|
| **entityFilter** | **EntityFilter** | | [optional] |
| **keyFilters** | **List\<KeyFilter\>** | | [optional] |
| **keyFiltersOperation** | **AlarmRuleComplexOperation** | | [optional] |
| **pageLink** | **AlarmDataPageLink** | | [optional] |
| **entityFields** | **List\<EntityKey\>** | | [optional] |
| **latestValues** | **List\<EntityKey\>** | | [optional] |
| **alarmFields** | **List\<EntityKey\>** | | [optional] |
| **keyFiltersOperationOrDefault** | **AlarmRuleComplexOperation** | | [optional] |



Expand Down Expand Up @@ -152,6 +154,9 @@ A JSON value representing the alarm data query. See API call notes above for mor
| valueType | EntityKeyValueType | | [optional] |
| predicate | KeyFilterPredicate | | [optional] |

#### AlarmRuleComplexOperation (enum)
`AND` | `OR`

#### AlarmDataPageLink
| Name | Type | Description | Notes |
|------|------|-------------|-------|
Expand Down Expand Up @@ -192,7 +197,7 @@ A JSON value representing the alarm data query. See API call notes above for mor
#### ComplexFilterPredicate *(extends KeyFilterPredicate, type=`COMPLEX`)*
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| operation | ComplexOperation | | [optional] |
| operation | AlarmRuleComplexOperation | | [optional] |
| predicates | List<KeyFilterPredicate> | | [optional] |

#### NumericFilterPredicate *(extends KeyFilterPredicate, type=`NUMERIC`)*
Expand Down Expand Up @@ -279,9 +284,6 @@ A JSON value representing the alarm data query. See API call notes above for mor
| userValue | Boolean | | [optional] |
| dynamicValue | DynamicValueBoolean | | [optional] |

#### ComplexOperation (enum)
`AND` | `OR`

#### DynamicValueString
| Name | Type | Description | Notes |
|------|------|-------------|-------|
Expand Down
8 changes: 4 additions & 4 deletions ce/docs/AssetControllerApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ PageDataAsset getEdgeAssets(@Nonnull String edgeId, @Nonnull Integer pageSize, @
Asset getTenantAssetByName(@Nonnull String assetName) // Get Tenant Asset (getTenantAssetByName)
PageDataAssetInfo getTenantAssetInfos(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String type, @Nullable String assetProfileId, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get Tenant Asset Infos (getTenantAssetInfos)
PageDataAsset getTenantAssets(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String type, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get Tenant Assets (getTenantAssets)
BulkImportResultAsset processAssetsBulkImport(@Nonnull BulkImportRequest bulkImportRequest) // Import the bulk of assets (processAssetsBulkImport)
BulkImportResultAsset processAssetBulkImport(@Nonnull BulkImportRequest bulkImportRequest) // Import the bulk of assets (processAssetBulkImport)
Asset saveAsset(@Nonnull Asset asset, @Nullable NameConflictPolicy nameConflictPolicy, @Nullable String uniquifySeparator, @Nullable UniquifyStrategy uniquifyStrategy) // Create Or Update Asset (saveAsset)
Asset unassignAssetFromCustomer(@Nonnull String assetId) // Unassign asset from customer (unassignAssetFromCustomer)
Asset unassignAssetFromEdge(@Nonnull String edgeId, @Nonnull String assetId) // Unassign asset from edge (unassignAssetFromEdge)
Expand Down Expand Up @@ -412,15 +412,15 @@ Returns a page of assets owned by tenant. You can specify parameters to filter t
**PageDataAsset**


## processAssetsBulkImport
## processAssetBulkImport

```
BulkImportResultAsset processAssetsBulkImport(@Nonnull BulkImportRequest bulkImportRequest)
BulkImportResultAsset processAssetBulkImport(@Nonnull BulkImportRequest bulkImportRequest)
```

**POST** `/api/asset/bulk_import`

Import the bulk of assets (processAssetsBulkImport)
Import the bulk of assets (processAssetBulkImport)

There's an ability to import the bulk of assets using the only .csv file.

Expand Down
4 changes: 2 additions & 2 deletions ce/docs/ComplexFilterPredicate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **operation** | **ComplexOperation** | | [optional] |
| **operation** | **AlarmRuleComplexOperation** | | [optional] |
| **predicates** | **List\<KeyFilterPredicate\>** | | [optional] |


Expand All @@ -21,7 +21,7 @@
|------|------|-------------|-------|
| type | String | | |

#### ComplexOperation (enum)
#### AlarmRuleComplexOperation (enum)
`AND` | `OR`

---
Expand Down
23 changes: 0 additions & 23 deletions ce/docs/ComplexOperation.md
View file
Open in desktop

This file was deleted.

8 changes: 4 additions & 4 deletions ce/docs/DomainControllerApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
```
void deleteDomain(@Nonnull UUID id) // Delete Domain by ID (deleteDomain)
DomainInfo getDomainInfoById(@Nonnull UUID id) // Get Domain info by Id (getDomainInfoById)
PageDataDomainInfo getTenantDomainInfos(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get Domain infos (getTenantDomainInfos)
PageDataDomainInfo getDomainInfos(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get Domain infos (getDomainInfos)
Domain saveDomain(@Nonnull Domain domain, @Nullable List<String> oauth2ClientIds) // Save or Update Domain (saveDomain)
void updateDomainOauth2Clients(@Nonnull UUID id, @Nonnull List<UUID> UUID) // Update oauth2 clients (updateDomainOauth2Clients)
```
Expand Down Expand Up @@ -59,15 +59,15 @@ Get Domain info by Id (getDomainInfoById)
**DomainInfo**


## getTenantDomainInfos
## getDomainInfos

```
PageDataDomainInfo getTenantDomainInfos(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder)
PageDataDomainInfo getDomainInfos(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder)
```

**GET** `/api/domain/infos`

Get Domain infos (getTenantDomainInfos)
Get Domain infos (getDomainInfos)

Available for users with 'SYS_ADMIN' authority.

Expand Down
10 changes: 6 additions & 4 deletions ce/docs/EntityCountQuery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ A JSON value representing the entity count query. See API call notes above for m
|------------ | ------------- | ------------- | -------------|
| **entityFilter** | **EntityFilter** | | [optional] |
| **keyFilters** | **List\<KeyFilter\>** | | [optional] |
| **keyFiltersOperation** | **AlarmRuleComplexOperation** | | [optional] |
| **keyFiltersOperationOrDefault** | **AlarmRuleComplexOperation** | | [optional] |



Expand Down Expand Up @@ -148,6 +150,9 @@ A JSON value representing the entity count query. See API call notes above for m
| valueType | EntityKeyValueType | | [optional] |
| predicate | KeyFilterPredicate | | [optional] |

#### AlarmRuleComplexOperation (enum)
`AND` | `OR`

#### EntityKey
| Name | Type | Description | Notes |
|------|------|-------------|-------|
Expand All @@ -171,7 +176,7 @@ A JSON value representing the entity count query. See API call notes above for m
#### ComplexFilterPredicate *(extends KeyFilterPredicate, type=`COMPLEX`)*
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| operation | ComplexOperation | | [optional] |
| operation | AlarmRuleComplexOperation | | [optional] |
| predicates | List<KeyFilterPredicate> | | [optional] |

#### NumericFilterPredicate *(extends KeyFilterPredicate, type=`NUMERIC`)*
Expand Down Expand Up @@ -243,9 +248,6 @@ A JSON value representing the entity count query. See API call notes above for m
| userValue | Boolean | | [optional] |
| dynamicValue | DynamicValueBoolean | | [optional] |

#### ComplexOperation (enum)
`AND` | `OR`

#### DynamicValueString
| Name | Type | Description | Notes |
|------|------|-------------|-------|
Expand Down
16 changes: 16 additions & 0 deletions ce/docs/EntityDataDiff.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,7 @@
| 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 @@ -287,6 +288,21 @@
| 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
10 changes: 6 additions & 4 deletions ce/docs/EntityDataQuery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,11 @@ Entity data query to find entities. Page size is capped at 100.
|------------ | ------------- | ------------- | -------------|
| **entityFilter** | **EntityFilter** | | [optional] |
| **keyFilters** | **List\<KeyFilter\>** | | [optional] |
| **keyFiltersOperation** | **AlarmRuleComplexOperation** | | [optional] |
| **pageLink** | **EntityDataPageLink** | | [optional] |
| **entityFields** | **List\<EntityKey\>** | | [optional] |
| **latestValues** | **List\<EntityKey\>** | | [optional] |
| **keyFiltersOperationOrDefault** | **AlarmRuleComplexOperation** | | [optional] |



Expand Down Expand Up @@ -151,6 +153,9 @@ Entity data query to find entities. Page size is capped at 100.
| valueType | EntityKeyValueType | | [optional] |
| predicate | KeyFilterPredicate | | [optional] |

#### AlarmRuleComplexOperation (enum)
`AND` | `OR`

#### EntityDataPageLink
| Name | Type | Description | Notes |
|------|------|-------------|-------|
Expand Down Expand Up @@ -183,7 +188,7 @@ Entity data query to find entities. Page size is capped at 100.
#### ComplexFilterPredicate *(extends KeyFilterPredicate, type=`COMPLEX`)*
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| operation | ComplexOperation | | [optional] |
| operation | AlarmRuleComplexOperation | | [optional] |
| predicates | List<KeyFilterPredicate> | | [optional] |

#### NumericFilterPredicate *(extends KeyFilterPredicate, type=`NUMERIC`)*
Expand Down Expand Up @@ -264,9 +269,6 @@ Entity data query to find entities. Page size is capped at 100.
| userValue | Boolean | | [optional] |
| dynamicValue | DynamicValueBoolean | | [optional] |

#### ComplexOperation (enum)
`AND` | `OR`

#### DynamicValueString
| Name | Type | Description | Notes |
|------|------|-------------|-------|
Expand Down
16 changes: 16 additions & 0 deletions ce/docs/EntityExportData.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@ 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 @@ -266,6 +267,21 @@ 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
4 changes: 2 additions & 2 deletions ce/docs/KeyFilter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
#### ComplexFilterPredicate *(extends KeyFilterPredicate, type=`COMPLEX`)*
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| operation | ComplexOperation | | [optional] |
| operation | AlarmRuleComplexOperation | | [optional] |
| predicates | List<KeyFilterPredicate> | | [optional] |

#### NumericFilterPredicate *(extends KeyFilterPredicate, type=`NUMERIC`)*
Expand Down Expand Up @@ -87,7 +87,7 @@
| userValue | Boolean | | [optional] |
| dynamicValue | DynamicValueBoolean | | [optional] |

#### ComplexOperation (enum)
#### AlarmRuleComplexOperation (enum)
`AND` | `OR`

#### DynamicValueString
Expand Down
4 changes: 2 additions & 2 deletions ce/docs/KeyFilterPredicate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Filter predicate for key-based filtering
#### ComplexFilterPredicate *(type=`COMPLEX`)*
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| operation | ComplexOperation | | [optional] |
| operation | AlarmRuleComplexOperation | | [optional] |
| predicates | List<KeyFilterPredicate> | | [optional] |

#### NumericFilterPredicate *(type=`NUMERIC`)*
Expand Down Expand Up @@ -52,7 +52,7 @@ Filter predicate for key-based filtering
| userValue | Boolean | | [optional] |
| dynamicValue | DynamicValueBoolean | | [optional] |

#### ComplexOperation (enum)
#### AlarmRuleComplexOperation (enum)
`AND` | `OR`

#### NumericOperation (enum)
Expand Down
8 changes: 4 additions & 4 deletions ce/docs/OAuth2ControllerApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

```
void deleteOauth2Client(@Nonnull UUID id) // Delete oauth2 client (deleteOauth2Client)
PageDataOAuth2ClientInfo findTenantOAuth2ClientInfos(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get OAuth2 Client infos (findTenantOAuth2ClientInfos)
PageDataOAuth2ClientInfo findOAuth2ClientInfos(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get OAuth2 Client infos (findOAuth2ClientInfos)
List<OAuth2ClientInfo> findTenantOAuth2ClientInfosByIds(@Nonnull List<String> clientIds) // Get OAuth2 Client infos By Ids (findTenantOAuth2ClientInfosByIds)
String getLoginProcessingUrl() // Get OAuth2 log in processing URL (getLoginProcessingUrl)
OAuth2Client getOAuth2ClientById(@Nonnull UUID id) // Get OAuth2 Client by id (getOAuth2ClientById)
Expand Down Expand Up @@ -37,15 +37,15 @@ Deletes the oauth2 client. Referencing non-existing oauth2 client Id will cause
null (empty response body)


## findTenantOAuth2ClientInfos
## findOAuth2ClientInfos

```
PageDataOAuth2ClientInfo findTenantOAuth2ClientInfos(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder)
PageDataOAuth2ClientInfo findOAuth2ClientInfos(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder)
```

**GET** `/api/oauth2/client/infos`

Get OAuth2 Client infos (findTenantOAuth2ClientInfos)
Get OAuth2 Client infos (findOAuth2ClientInfos)

Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority.

Expand Down
Loading
Loading