Skip to content

Update PE OpenAPI spec (from master) #33

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 16, 2026
Merged

Update PE OpenAPI spec (from master) #33

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
4 changes: 2 additions & 2 deletions pe/docs/AiModel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
|------------ | ------------- | ------------- | -------------|
| **id** | **AiModelId** | | [optional] |
| **createdTime** | **Long** | Entity creation timestamp in milliseconds since Unix epoch | [optional] [readonly] |
| **tenantId** | **TenantId** | JSON object representing the ID of the tenant associated with this AI model | [readonly] |
| **version** | **Long** | Version of the AI model record; increments automatically whenever the record is changed | [readonly] |
| **tenantId** | **TenantId** | JSON object representing the ID of the tenant associated with this AI model | [optional] [readonly] |
| **version** | **Long** | Version of the AI model record; increments automatically whenever the record is changed | [optional] [readonly] |
| **name** | **String** | Display name for this AI model configuration; not the technical model identifier | |
| **_configuration** | **AiModelConfig** | Configuration of the AI model | [optional] |

Expand Down
1 change: 1 addition & 0 deletions pe/docs/CfReprocessingJobConfiguration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
| success | Boolean | | [optional] |
| discarded | Boolean | | [optional] |
| finishTs | Long | | [optional] |
| error | String | | [optional] |
| jobType | String | | |

#### EntityType (enum)
Expand Down
1 change: 1 addition & 0 deletions pe/docs/CfReprocessingJobResult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
| success | Boolean | | [optional] |
| discarded | Boolean | | [optional] |
| finishTs | Long | | [optional] |
| error | String | | [optional] |
| jobType | String | | |

---
Expand Down
1 change: 1 addition & 0 deletions pe/docs/CfReprocessingTaskResult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
| success | Boolean | | [optional] |
| discarded | Boolean | | [optional] |
| finishTs | Long | | [optional] |
| error | String | | [optional] |
| jobType | String | | |

#### CfReprocessingTaskFailure
Expand Down
1 change: 1 addition & 0 deletions pe/docs/DummyJobConfiguration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Dummy job configuration
| success | Boolean | | [optional] |
| discarded | Boolean | | [optional] |
| finishTs | Long | | [optional] |
| error | String | | [optional] |
| jobType | String | | |

---
Expand Down
1 change: 1 addition & 0 deletions pe/docs/DummyJobResult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
| success | Boolean | | [optional] |
| discarded | Boolean | | [optional] |
| finishTs | Long | | [optional] |
| error | String | | [optional] |
| jobType | String | | |

---
Expand Down
1 change: 1 addition & 0 deletions pe/docs/DummyTaskResult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
| success | Boolean | | [optional] |
| discarded | Boolean | | [optional] |
| finishTs | Long | | [optional] |
| error | String | | [optional] |
| jobType | String | | |

#### DummyTaskFailure
Expand Down
1 change: 1 addition & 0 deletions pe/docs/Job.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@
| success | Boolean | | [optional] |
| discarded | Boolean | | [optional] |
| finishTs | Long | | [optional] |
| error | String | | [optional] |
| jobType | String | | |

#### NotificationRequest
Expand Down
1 change: 1 addition & 0 deletions pe/docs/JobConfiguration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
| success | Boolean | | [optional] |
| discarded | Boolean | | [optional] |
| finishTs | Long | | [optional] |
| error | String | | [optional] |
| jobType | String | | |

#### NotificationRequest
Expand Down
1 change: 1 addition & 0 deletions pe/docs/JobResult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ Job execution result
| success | Boolean | | [optional] |
| discarded | Boolean | | [optional] |
| finishTs | Long | | [optional] |
| error | String | | [optional] |
| jobType | String | | |

#### Report
Expand Down
4 changes: 2 additions & 2 deletions pe/docs/PageDataAiModel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@
|------|------|-------------|-------|
| id | AiModelId | | [optional] |
| createdTime | Long | Entity creation timestamp in milliseconds since Unix epoch | [optional] [readonly] |
| tenantId | TenantId | JSON object representing the ID of the tenant associated with this AI model | [readonly] |
| version | Long | Version of the AI model record; increments automatically whenever the record is changed | [readonly] |
| tenantId | TenantId | JSON object representing the ID of the tenant associated with this AI model | [optional] [readonly] |
| version | Long | Version of the AI model record; increments automatically whenever the record is changed | [optional] [readonly] |
| name | String | Display name for this AI model configuration; not the technical model identifier | |
| _configuration | AiModelConfig | Configuration of the AI model | [optional] |

Expand Down
1 change: 1 addition & 0 deletions pe/docs/PageDataJob.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@
| success | Boolean | | [optional] |
| discarded | Boolean | | [optional] |
| finishTs | Long | | [optional] |
| error | String | | [optional] |
| jobType | String | | |

#### NotificationRequest
Expand Down
2 changes: 1 addition & 1 deletion pe/docs/PageDataRuleChain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
| id | RuleChainId | JSON object with the Rule Chain Id. Specify this field to update the Rule Chain. Referencing non-existing Rule Chain Id will cause error. Omit this field to create new rule chain. | [optional] |
| createdTime | Long | Timestamp of the rule chain creation, in milliseconds | [optional] [readonly] |
| additionalInfo | com.fasterxml.jackson.databind.JsonNode | | [optional] |
| tenantId | TenantId | JSON object with Tenant Id. | [readonly] |
| tenantId | TenantId | JSON object with Tenant Id. | [optional] [readonly] |
| name | String | Rule Chain name | |
| type | RuleChainType | Rule Chain type. 'EDGE' rule chains are processing messages on the edge devices only. | [optional] |
| firstRuleNodeId | RuleNodeId | JSON object with Rule Chain Id. Pointer to the first rule node that should receive all messages pushed to this rule chain. | [optional] |
Expand Down
1 change: 1 addition & 0 deletions pe/docs/ReportJobConfiguration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@
| success | Boolean | | [optional] |
| discarded | Boolean | | [optional] |
| finishTs | Long | | [optional] |
| error | String | | [optional] |
| jobType | String | | |

#### NotificationTemplate
Expand Down
1 change: 1 addition & 0 deletions pe/docs/ReportJobResult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
| success | Boolean | | [optional] |
| discarded | Boolean | | [optional] |
| finishTs | Long | | [optional] |
| error | String | | [optional] |
| jobType | String | | |

#### TbReportFormat (enum)
Expand Down
1 change: 1 addition & 0 deletions pe/docs/ReportTaskResult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
| success | Boolean | | [optional] |
| discarded | Boolean | | [optional] |
| finishTs | Long | | [optional] |
| error | String | | [optional] |
| jobType | String | | |

#### Report
Expand Down
2 changes: 1 addition & 1 deletion pe/docs/RuleChain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ A JSON value representing the rule chain.
| **id** | **RuleChainId** | JSON object with the Rule Chain Id. Specify this field to update the Rule Chain. Referencing non-existing Rule Chain Id will cause error. Omit this field to create new rule chain. | [optional] |
| **createdTime** | **Long** | Timestamp of the rule chain creation, in milliseconds | [optional] [readonly] |
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | | [optional] |
| **tenantId** | **TenantId** | JSON object with Tenant Id. | [readonly] |
| **tenantId** | **TenantId** | JSON object with Tenant Id. | [optional] [readonly] |
| **name** | **String** | Rule Chain name | |
| **type** | **RuleChainType** | Rule Chain type. 'EDGE' rule chains are processing messages on the edge devices only. | [optional] |
| **firstRuleNodeId** | **RuleNodeId** | JSON object with Rule Chain Id. Pointer to the first rule node that should receive all messages pushed to this rule chain. | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion pe/docs/RuleChainData.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ A JSON value representing the rule chains.
| id | RuleChainId | JSON object with the Rule Chain Id. Specify this field to update the Rule Chain. Referencing non-existing Rule Chain Id will cause error. Omit this field to create new rule chain. | [optional] |
| createdTime | Long | Timestamp of the rule chain creation, in milliseconds | [optional] [readonly] |
| additionalInfo | com.fasterxml.jackson.databind.JsonNode | | [optional] |
| tenantId | TenantId | JSON object with Tenant Id. | [readonly] |
| tenantId | TenantId | JSON object with Tenant Id. | [optional] [readonly] |
| name | String | Rule Chain name | |
| type | RuleChainType | Rule Chain type. 'EDGE' rule chains are processing messages on the edge devices only. | [optional] |
| firstRuleNodeId | RuleNodeId | JSON object with Rule Chain Id. Pointer to the first rule node that should receive all messages pushed to this rule chain. | [optional] |
Expand Down
1 change: 1 addition & 0 deletions pe/docs/TaskResult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
| **success** | **Boolean** | | [optional] |
| **discarded** | **Boolean** | | [optional] |
| **finishTs** | **Long** | | [optional] |
| **error** | **String** | | [optional] |
| **jobType** | **String** | | |


Expand Down
10 changes: 5 additions & 5 deletions pe/spec/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115921,9 +115921,7 @@
}
},
"required": [
"name",
"tenantId",
"version"
"name"
]
},
"AiModelConfig": {
Expand Down Expand Up @@ -135266,8 +135264,7 @@
}
},
"required": [
"name",
"tenantId"
"name"
]
},
"RuleChainConnectionInfo": {
Expand Down Expand Up @@ -137776,6 +137773,9 @@
"type": "integer",
"format": "int64"
},
"error": {
"type": "string"
},
"jobType": {
"type": "string"
}
Expand Down
16 changes: 8 additions & 8 deletions pe/src/main/java/org/thingsboard/client/model/AiModel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,11 @@ public class AiModel {
private Long createdTime;

public static final String JSON_PROPERTY_TENANT_ID = "tenantId";
@Nonnull
@Nullable
private TenantId tenantId;

public static final String JSON_PROPERTY_VERSION = "version";
@Nonnull
@Nullable
private Long version = 1l;

public static final String JSON_PROPERTY_NAME = "name";
Expand Down Expand Up @@ -131,9 +131,9 @@ public Long getCreatedTime() {
* JSON object representing the ID of the tenant associated with this AI model
* @return tenantId
*/
@Nonnull
@JsonProperty(value = JSON_PROPERTY_TENANT_ID, required = true)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
@Nullable
@JsonProperty(value = JSON_PROPERTY_TENANT_ID, required = false)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public TenantId getTenantId() {
return tenantId;
}
Expand All @@ -145,9 +145,9 @@ public TenantId getTenantId() {
* Version of the AI model record; increments automatically whenever the record is changed
* @return version
*/
@Nonnull
@JsonProperty(value = JSON_PROPERTY_VERSION, required = true)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
@Nullable
@JsonProperty(value = JSON_PROPERTY_VERSION, required = false)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Long getVersion() {
return version;
}
Expand Down
11 changes: 11 additions & 0 deletions pe/src/main/java/org/thingsboard/client/model/CfReprocessingTaskResult.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,12 @@ public CfReprocessingTaskResult finishTs(@Nullable Long finishTs) {
return this;
}

@Override
public CfReprocessingTaskResult error(@Nullable String error) {
this.setError(error);
return this;
}

/**
* Return true if this CfReprocessingTaskResult object is equal to o.
*/
Expand Down Expand Up @@ -196,6 +202,11 @@ public String toUrlQueryString(String prefix) {
joiner.add(String.format(java.util.Locale.ROOT, "%sfinishTs%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getFinishTs()))));
}

// add `error` to the URL query string
if (getError() != null) {
joiner.add(String.format(java.util.Locale.ROOT, "%serror%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getError()))));
}

// add `jobType` to the URL query string
if (getJobType() != null) {
joiner.add(String.format(java.util.Locale.ROOT, "%sjobType%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getJobType()))));
Expand Down
11 changes: 11 additions & 0 deletions pe/src/main/java/org/thingsboard/client/model/DummyTaskResult.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,12 @@ public DummyTaskResult finishTs(@Nullable Long finishTs) {
return this;
}

@Override
public DummyTaskResult error(@Nullable String error) {
this.setError(error);
return this;
}

/**
* Return true if this DummyTaskResult object is equal to o.
*/
Expand Down Expand Up @@ -196,6 +202,11 @@ public String toUrlQueryString(String prefix) {
joiner.add(String.format(java.util.Locale.ROOT, "%sfinishTs%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getFinishTs()))));
}

// add `error` to the URL query string
if (getError() != null) {
joiner.add(String.format(java.util.Locale.ROOT, "%serror%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getError()))));
}

// add `jobType` to the URL query string
if (getJobType() != null) {
joiner.add(String.format(java.util.Locale.ROOT, "%sjobType%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getJobType()))));
Expand Down
11 changes: 11 additions & 0 deletions pe/src/main/java/org/thingsboard/client/model/ReportTaskResult.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,12 @@ public ReportTaskResult finishTs(@Nullable Long finishTs) {
return this;
}

@Override
public ReportTaskResult error(@Nullable String error) {
this.setError(error);
return this;
}

/**
* Return true if this ReportTaskResult object is equal to o.
*/
Expand Down Expand Up @@ -196,6 +202,11 @@ public String toUrlQueryString(String prefix) {
joiner.add(String.format(java.util.Locale.ROOT, "%sfinishTs%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getFinishTs()))));
}

// add `error` to the URL query string
if (getError() != null) {
joiner.add(String.format(java.util.Locale.ROOT, "%serror%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getError()))));
}

// add `jobType` to the URL query string
if (getJobType() != null) {
joiner.add(String.format(java.util.Locale.ROOT, "%sjobType%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getJobType()))));
Expand Down
8 changes: 4 additions & 4 deletions pe/src/main/java/org/thingsboard/client/model/RuleChain.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ public class RuleChain {
private com.fasterxml.jackson.databind.JsonNode additionalInfo = null;

public static final String JSON_PROPERTY_TENANT_ID = "tenantId";
@Nonnull
@Nullable
private TenantId tenantId;

public static final String JSON_PROPERTY_NAME = "name";
Expand Down Expand Up @@ -179,9 +179,9 @@ public void setAdditionalInfo(@Nullable com.fasterxml.jackson.databind.JsonNode
* JSON object with Tenant Id.
* @return tenantId
*/
@Nonnull
@JsonProperty(value = JSON_PROPERTY_TENANT_ID, required = true)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
@Nullable
@JsonProperty(value = JSON_PROPERTY_TENANT_ID, required = false)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public TenantId getTenantId() {
return tenantId;
}
Expand Down
Loading
Loading