Skip to content

Commit fc4159e

Browse files
author
TeamCity
committed
Update PE OpenAPI spec (from master)
1 parent d9b1560 commit fc4159e

File tree

9 files changed

+723
-36
lines changed

9 files changed

+723
-36
lines changed

‎pe/docs/Role.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ A JSON value representing the role.
1616
| **customerId** | **CustomerId** | JSON object with Customer Id. | [optional] [readonly] |
1717
| **name** | **String** | Role Name | |
1818
| **type** | **RoleType** | Type of the role: generic or group | |
19-
| **permissions** | **com.fasterxml.jackson.databind.JsonNode** | | [optional] |
19+
| **permissions** | **com.fasterxml.jackson.databind.JsonNode** | JSON object with the set of permissions. Structure is specific for role type | [optional] [readonly] |
20+
| **excludedPermissions** | **com.fasterxml.jackson.databind.JsonNode** | JSON object with the set of excluded permissions. Only applicable for generic roles. Structure is the same as permissions | [optional] [readonly] |
2021
| **version** | **Long** | | [optional] |
2122
| **ownerId** | **EntityId** | JSON object with Customer or Tenant Id | [optional] [readonly] |
2223

‎pe/docs/RuleChainMetaData.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ 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] |
1819

1920

2021

‎pe/docs/RuleChainNote.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
2+
# RuleChainNote
3+
4+
`org.thingsboard.client.model.RuleChainNote`
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
| **id** | **String** | Unique identifier of the note on the canvas | [optional] |
11+
| **x** | **Integer** | Horizontal position of the note on the canvas, in pixels | [optional] |
12+
| **y** | **Integer** | Vertical position of the note on the canvas, in pixels | [optional] |
13+
| **width** | **Integer** | Width of the note, in pixels | [optional] |
14+
| **height** | **Integer** | Height of the note, in pixels | [optional] |
15+
| **content** | **String** | Markdown or HTML content of the note | [optional] |
16+
| **backgroundColor** | **String** | Background color of the note in CSS hex format, e.g. '#FFF9C4' | [optional] |
17+
| **borderColor** | **String** | Border color of the note in CSS hex format, e.g. '#E6C800' | [optional] |
18+
| **borderWidth** | **Integer** | Border width of the note in pixels | [optional] |
19+
| **applyDefaultMarkdownStyle** | **Boolean** | Whether to apply the default markdown stylesheet to the note content | [optional] |
20+
| **markdownCss** | **String** | Custom CSS styles applied to the note content | [optional] |
21+
22+
23+
24+
---
25+
26+
### Conventions
27+
28+
- **Package:** `org.thingsboard.client.model`
29+
- **Getter pattern:** `get<PropertyName>()` — e.g., `getId()`, `getName()`
30+
- **Setter pattern:** `set<PropertyName>(value)` — e.g., `setId(value)`, `setName(value)`
31+
- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions
32+

‎pe/docs/ShortCustomerInfo.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
|------------ | ------------- | ------------- | -------------|
1010
| **customerId** | **CustomerId** | JSON object with the customer Id. | [optional] |
1111
| **title** | **String** | Title of the customer. | [optional] |
12-
| **isPublic** | **Boolean** | Indicates special 'Public' customer used to embed dashboards on public websites. | [optional] |
12+
| **_public** | **Boolean** | Indicates special 'Public' customer used to embed dashboards on public websites. | [optional] |
1313

1414

1515

‎pe/spec/openapi.json‎

Lines changed: 70 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133849,7 +133849,14 @@
133849133849
"example": "GROUP"
133850133850
},
133851133851
"permissions": {
133852-
"$ref": "#/components/schemas/JsonNode"
133852+
"$ref": "#/components/schemas/JsonNode",
133853+
"description": "JSON object with the set of permissions. Structure is specific for role type",
133854+
"readOnly": true
133855+
},
133856+
"excludedPermissions": {
133857+
"$ref": "#/components/schemas/JsonNode",
133858+
"description": "JSON object with the set of excluded permissions. Only applicable for generic roles. Structure is the same as permissions",
133859+
"readOnly": true
133853133860
},
133854133861
"version": {
133855133862
"type": "integer",
@@ -134196,6 +134203,13 @@
134196134203
"items": {
134197134204
"$ref": "#/components/schemas/RuleChainConnectionInfo"
134198134205
}
134206+
},
134207+
"notes": {
134208+
"type": "array",
134209+
"description": "List of sticky notes placed on the rule chain canvas",
134210+
"items": {
134211+
"$ref": "#/components/schemas/RuleChainNote"
134212+
}
134199134213
}
134200134214
},
134201134215
"required": [
@@ -134206,6 +134220,60 @@
134206134220
"ruleChainId"
134207134221
]
134208134222
},
134223+
"RuleChainNote": {
134224+
"type": "object",
134225+
"properties": {
134226+
"id": {
134227+
"type": "string",
134228+
"description": "Unique identifier of the note on the canvas"
134229+
},
134230+
"x": {
134231+
"type": "integer",
134232+
"format": "int32",
134233+
"description": "Horizontal position of the note on the canvas, in pixels"
134234+
},
134235+
"y": {
134236+
"type": "integer",
134237+
"format": "int32",
134238+
"description": "Vertical position of the note on the canvas, in pixels"
134239+
},
134240+
"width": {
134241+
"type": "integer",
134242+
"format": "int32",
134243+
"description": "Width of the note, in pixels"
134244+
},
134245+
"height": {
134246+
"type": "integer",
134247+
"format": "int32",
134248+
"description": "Height of the note, in pixels"
134249+
},
134250+
"content": {
134251+
"type": "string",
134252+
"description": "Markdown or HTML content of the note"
134253+
},
134254+
"backgroundColor": {
134255+
"type": "string",
134256+
"description": "Background color of the note in CSS hex format, e.g. '#FFF9C4'"
134257+
},
134258+
"borderColor": {
134259+
"type": "string",
134260+
"description": "Border color of the note in CSS hex format, e.g. '#E6C800'"
134261+
},
134262+
"borderWidth": {
134263+
"type": "integer",
134264+
"format": "int32",
134265+
"description": "Border width of the note in pixels"
134266+
},
134267+
"applyDefaultMarkdownStyle": {
134268+
"type": "boolean",
134269+
"description": "Whether to apply the default markdown stylesheet to the note content"
134270+
},
134271+
"markdownCss": {
134272+
"type": "string",
134273+
"description": "Custom CSS styles applied to the note content"
134274+
}
134275+
}
134276+
},
134209134277
"RuleChainOutputLabelsUsage": {
134210134278
"type": "object",
134211134279
"properties": {
@@ -135242,7 +135310,7 @@
135242135310
"type": "string",
135243135311
"description": "Title of the customer."
135244135312
},
135245-
"isPublic": {
135313+
"public": {
135246135314
"type": "boolean",
135247135315
"description": "Indicates special 'Public' customer used to embed dashboards on public websites."
135248135316
}

‎pe/src/main/java/org/thingsboard/client/model/Role.java‎

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@
5151
Role.JSON_PROPERTY_NAME,
5252
Role.JSON_PROPERTY_TYPE,
5353
Role.JSON_PROPERTY_PERMISSIONS,
54+
Role.JSON_PROPERTY_EXCLUDED_PERMISSIONS,
5455
Role.JSON_PROPERTY_VERSION,
5556
Role.JSON_PROPERTY_OWNER_ID
5657
})
@@ -86,7 +87,11 @@ public class Role {
8687

8788
public static final String JSON_PROPERTY_PERMISSIONS = "permissions";
8889
@Nullable
89-
private com.fasterxml.jackson.databind.JsonNode permissions = null;
90+
private com.fasterxml.jackson.databind.JsonNode permissions;
91+
92+
public static final String JSON_PROPERTY_EXCLUDED_PERMISSIONS = "excludedPermissions";
93+
@Nullable
94+
private com.fasterxml.jackson.databind.JsonNode excludedPermissions;
9095

9196
public static final String JSON_PROPERTY_VERSION = "version";
9297
@Nullable
@@ -104,12 +109,16 @@ public Role(
104109
@JsonProperty(JSON_PROPERTY_CREATED_TIME) Long createdTime,
105110
@JsonProperty(JSON_PROPERTY_TENANT_ID) TenantId tenantId,
106111
@JsonProperty(JSON_PROPERTY_CUSTOMER_ID) CustomerId customerId,
112+
@JsonProperty(JSON_PROPERTY_PERMISSIONS) com.fasterxml.jackson.databind.JsonNode permissions,
113+
@JsonProperty(JSON_PROPERTY_EXCLUDED_PERMISSIONS) com.fasterxml.jackson.databind.JsonNode excludedPermissions,
107114
@JsonProperty(JSON_PROPERTY_OWNER_ID) EntityId ownerId
108115
) {
109116
this();
110117
this.createdTime = createdTime;
111118
this.tenantId = tenantId;
112119
this.customerId = customerId;
120+
this.permissions = permissions;
121+
this.excludedPermissions = excludedPermissions;
113122
this.ownerId = ownerId;
114123
}
115124

@@ -251,13 +260,8 @@ public void setType(@Nonnull RoleType type) {
251260
}
252261

253262

254-
public Role permissions(@Nullable com.fasterxml.jackson.databind.JsonNode permissions) {
255-
this.permissions = permissions;
256-
return this;
257-
}
258-
259263
/**
260-
* Get permissions
264+
* JSON object with the set of permissions. Structure is specific for role type
261265
* @return permissions
262266
*/
263267
@Nullable
@@ -268,13 +272,22 @@ public com.fasterxml.jackson.databind.JsonNode getPermissions() {
268272
}
269273

270274

271-
@JsonProperty(value = JSON_PROPERTY_PERMISSIONS, required = false)
275+
276+
277+
/**
278+
* JSON object with the set of excluded permissions. Only applicable for generic roles. Structure is the same as permissions
279+
* @return excludedPermissions
280+
*/
281+
@Nullable
282+
@JsonProperty(value = JSON_PROPERTY_EXCLUDED_PERMISSIONS, required = false)
272283
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
273-
public void setPermissions(@Nullable com.fasterxml.jackson.databind.JsonNode permissions) {
274-
this.permissions = permissions;
284+
public com.fasterxml.jackson.databind.JsonNode getExcludedPermissions() {
285+
return excludedPermissions;
275286
}
276287

277288

289+
290+
278291
public Role version(@Nullable Long version) {
279292
this.version = version;
280293
return this;
@@ -333,13 +346,14 @@ public boolean equals(Object o) {
333346
Objects.equals(this.name, role.name) &&
334347
Objects.equals(this.type, role.type) &&
335348
Objects.equals(this.permissions, role.permissions) &&
349+
Objects.equals(this.excludedPermissions, role.excludedPermissions) &&
336350
Objects.equals(this.version, role.version) &&
337351
Objects.equals(this.ownerId, role.ownerId);
338352
}
339353

340354
@Override
341355
public int hashCode() {
342-
return Objects.hash(id, createdTime, additionalInfo, tenantId, customerId, name, type, permissions, version, ownerId);
356+
return Objects.hash(id, createdTime, additionalInfo, tenantId, customerId, name, type, permissions, excludedPermissions, version, ownerId);
343357
}
344358

345359
@Override
@@ -354,6 +368,7 @@ public String toString() {
354368
sb.append(" name: ").append(toIndentedString(name)).append("\n");
355369
sb.append(" type: ").append(toIndentedString(type)).append("\n");
356370
sb.append(" permissions: ").append(toIndentedString(permissions)).append("\n");
371+
sb.append(" excludedPermissions: ").append(toIndentedString(excludedPermissions)).append("\n");
357372
sb.append(" version: ").append(toIndentedString(version)).append("\n");
358373
sb.append(" ownerId: ").append(toIndentedString(ownerId)).append("\n");
359374
sb.append("}");
@@ -443,6 +458,11 @@ public String toUrlQueryString(String prefix) {
443458
joiner.add(String.format(java.util.Locale.ROOT, "%spermissions%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getPermissions()))));
444459
}
445460

461+
// add `excludedPermissions` to the URL query string
462+
if (getExcludedPermissions() != null) {
463+
joiner.add(String.format(java.util.Locale.ROOT, "%sexcludedPermissions%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getExcludedPermissions()))));
464+
}
465+
446466
// add `version` to the URL query string
447467
if (getVersion() != null) {
448468
joiner.add(String.format(java.util.Locale.ROOT, "%sversion%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getVersion()))));

‎pe/src/main/java/org/thingsboard/client/model/RuleChainMetaData.java‎

Lines changed: 53 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
import org.thingsboard.client.model.NodeConnectionInfo;
3636
import org.thingsboard.client.model.RuleChainConnectionInfo;
3737
import org.thingsboard.client.model.RuleChainId;
38+
import org.thingsboard.client.model.RuleChainNote;
3839
import org.thingsboard.client.model.RuleNode;
3940
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
4041

@@ -49,7 +50,8 @@
4950
RuleChainMetaData.JSON_PROPERTY_FIRST_NODE_INDEX,
5051
RuleChainMetaData.JSON_PROPERTY_NODES,
5152
RuleChainMetaData.JSON_PROPERTY_CONNECTIONS,
52-
RuleChainMetaData.JSON_PROPERTY_RULE_CHAIN_CONNECTIONS
53+
RuleChainMetaData.JSON_PROPERTY_RULE_CHAIN_CONNECTIONS,
54+
RuleChainMetaData.JSON_PROPERTY_NOTES
5355
})
5456
@Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.20.0")
5557
public class RuleChainMetaData {
@@ -77,6 +79,10 @@ public class RuleChainMetaData {
7779
@Nonnull
7880
private List<RuleChainConnectionInfo> ruleChainConnections = new ArrayList<>();
7981

82+
public static final String JSON_PROPERTY_NOTES = "notes";
83+
@Nullable
84+
private List<RuleChainNote> notes = new ArrayList<>();
85+
8086
public RuleChainMetaData() {
8187
}
8288

@@ -246,6 +252,38 @@ public void setRuleChainConnections(@Nonnull List<RuleChainConnectionInfo> ruleC
246252
}
247253

248254

255+
public RuleChainMetaData notes(@Nullable List<RuleChainNote> notes) {
256+
this.notes = notes;
257+
return this;
258+
}
259+
260+
public RuleChainMetaData addNotesItem(RuleChainNote notesItem) {
261+
if (this.notes == null) {
262+
this.notes = new ArrayList<>();
263+
}
264+
this.notes.add(notesItem);
265+
return this;
266+
}
267+
268+
/**
269+
* List of sticky notes placed on the rule chain canvas
270+
* @return notes
271+
*/
272+
@Nullable
273+
@JsonProperty(value = JSON_PROPERTY_NOTES, required = false)
274+
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
275+
public List<RuleChainNote> getNotes() {
276+
return notes;
277+
}
278+
279+
280+
@JsonProperty(value = JSON_PROPERTY_NOTES, required = false)
281+
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
282+
public void setNotes(@Nullable List<RuleChainNote> notes) {
283+
this.notes = notes;
284+
}
285+
286+
249287
/**
250288
* Return true if this RuleChainMetaData object is equal to o.
251289
*/
@@ -263,12 +301,13 @@ public boolean equals(Object o) {
263301
Objects.equals(this.firstNodeIndex, ruleChainMetaData.firstNodeIndex) &&
264302
Objects.equals(this.nodes, ruleChainMetaData.nodes) &&
265303
Objects.equals(this.connections, ruleChainMetaData.connections) &&
266-
Objects.equals(this.ruleChainConnections, ruleChainMetaData.ruleChainConnections);
304+
Objects.equals(this.ruleChainConnections, ruleChainMetaData.ruleChainConnections) &&
305+
Objects.equals(this.notes, ruleChainMetaData.notes);
267306
}
268307

269308
@Override
270309
public int hashCode() {
271-
return Objects.hash(ruleChainId, version, firstNodeIndex, nodes, connections, ruleChainConnections);
310+
return Objects.hash(ruleChainId, version, firstNodeIndex, nodes, connections, ruleChainConnections, notes);
272311
}
273312

274313
@Override
@@ -281,6 +320,7 @@ public String toString() {
281320
sb.append(" nodes: ").append(toIndentedString(nodes)).append("\n");
282321
sb.append(" connections: ").append(toIndentedString(connections)).append("\n");
283322
sb.append(" ruleChainConnections: ").append(toIndentedString(ruleChainConnections)).append("\n");
323+
sb.append(" notes: ").append(toIndentedString(notes)).append("\n");
284324
sb.append("}");
285325
return sb.toString();
286326
}
@@ -373,6 +413,16 @@ public String toUrlQueryString(String prefix) {
373413
}
374414
}
375415

416+
// add `notes` to the URL query string
417+
if (getNotes() != null) {
418+
for (int i = 0; i < getNotes().size(); i++) {
419+
if (getNotes().get(i) != null) {
420+
joiner.add(getNotes().get(i).toUrlQueryString(String.format(java.util.Locale.ROOT, "%snotes%s%s", prefix, suffix,
421+
"".equals(suffix) ? "" : String.format(java.util.Locale.ROOT, "%s%d%s", containerPrefix, i, containerSuffix))));
422+
}
423+
}
424+
}
425+
376426
return joiner.toString();
377427
}
378428
}

0 commit comments

Comments
 (0)