Skip to content

Commit eca270b

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

File tree

7 files changed

+682
-23
lines changed

7 files changed

+682
-23
lines changed

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: 62 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134196,6 +134196,13 @@
134196134196
"items": {
134197134197
"$ref": "#/components/schemas/RuleChainConnectionInfo"
134198134198
}
134199+
},
134200+
"notes": {
134201+
"type": "array",
134202+
"description": "List of sticky notes placed on the rule chain canvas",
134203+
"items": {
134204+
"$ref": "#/components/schemas/RuleChainNote"
134205+
}
134199134206
}
134200134207
},
134201134208
"required": [
@@ -134206,6 +134213,60 @@
134206134213
"ruleChainId"
134207134214
]
134208134215
},
134216+
"RuleChainNote": {
134217+
"type": "object",
134218+
"properties": {
134219+
"id": {
134220+
"type": "string",
134221+
"description": "Unique identifier of the note on the canvas"
134222+
},
134223+
"x": {
134224+
"type": "integer",
134225+
"format": "int32",
134226+
"description": "Horizontal position of the note on the canvas, in pixels"
134227+
},
134228+
"y": {
134229+
"type": "integer",
134230+
"format": "int32",
134231+
"description": "Vertical position of the note on the canvas, in pixels"
134232+
},
134233+
"width": {
134234+
"type": "integer",
134235+
"format": "int32",
134236+
"description": "Width of the note, in pixels"
134237+
},
134238+
"height": {
134239+
"type": "integer",
134240+
"format": "int32",
134241+
"description": "Height of the note, in pixels"
134242+
},
134243+
"content": {
134244+
"type": "string",
134245+
"description": "Markdown or HTML content of the note"
134246+
},
134247+
"backgroundColor": {
134248+
"type": "string",
134249+
"description": "Background color of the note in CSS hex format, e.g. '#FFF9C4'"
134250+
},
134251+
"borderColor": {
134252+
"type": "string",
134253+
"description": "Border color of the note in CSS hex format, e.g. '#E6C800'"
134254+
},
134255+
"borderWidth": {
134256+
"type": "integer",
134257+
"format": "int32",
134258+
"description": "Border width of the note in pixels"
134259+
},
134260+
"applyDefaultMarkdownStyle": {
134261+
"type": "boolean",
134262+
"description": "Whether to apply the default markdown stylesheet to the note content"
134263+
},
134264+
"markdownCss": {
134265+
"type": "string",
134266+
"description": "Custom CSS styles applied to the note content"
134267+
}
134268+
}
134269+
},
134209134270
"RuleChainOutputLabelsUsage": {
134210134271
"type": "object",
134211134272
"properties": {
@@ -135242,7 +135303,7 @@
135242135303
"type": "string",
135243135304
"description": "Title of the customer."
135244135305
},
135245-
"isPublic": {
135306+
"public": {
135246135307
"type": "boolean",
135247135308
"description": "Indicates special 'Public' customer used to embed dashboards on public websites."
135248135309
}

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)