Skip to content

Commit b53830f

Browse files
ViacheslavKlimovTeamCity
ViacheslavKlimov
and
TeamCity
authored
Update PAAS OpenAPI spec (from develop/4.4) (#26)
Co-authored-by: TeamCity <teamcity@thingsboard.io>
1 parent 6a81689 commit b53830f

26 files changed

Lines changed: 4403 additions & 427 deletions

‎paas/docs/AiChatControllerApi.md‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
com.fasterxml.jackson.databind.JsonNode createChat(@Nonnull Object body) // createChat
77
void deleteChat(@Nonnull UUID chatId) // deleteChat
88
com.fasterxml.jackson.databind.JsonNode getChatMessages(@Nonnull UUID chatId) // getChatMessages
9-
com.fasterxml.jackson.databind.JsonNode listChats() // listChats
9+
com.fasterxml.jackson.databind.JsonNode listChats(@Nonnull ChatType chatType) // listChats
1010
List<Object> sendChatMessage(@Nonnull UUID chatId, @Nonnull String xAuthorization, @Nonnull String body) // sendChatMessage
1111
void updateChat(@Nonnull UUID chatId, @Nonnull Object body) // updateChat
1212
```
@@ -81,13 +81,20 @@ getChatMessages
8181
## listChats
8282

8383
```
84-
com.fasterxml.jackson.databind.JsonNode listChats()
84+
com.fasterxml.jackson.databind.JsonNode listChats(@Nonnull ChatType chatType)
8585
```
8686

87-
**GET** `/api/ai/chats`
87+
**GET** `/api/ai/chats/{chatType}`
8888

8989
listChats
9090

91+
92+
### Parameters
93+
94+
| Name | Type | Description | Notes |
95+
|------------- | ------------- | ------------- | -------------|
96+
| **chatType** | **ChatType** | | [enum: GENERIC, SOLUTION_BUILDER] |
97+
9198
### Return type
9299

93100
**com.fasterxml.jackson.databind.JsonNode**

‎paas/docs/AiSolutionControllerApi.md‎

Lines changed: 276 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,276 @@
1+
# AiSolutionControllerApi
2+
3+
`ThingsboardClient` methods:
4+
5+
```
6+
com.fasterxml.jackson.databind.JsonNode chat(@Nonnull UUID solutionId, @Nonnull SolutionStep step, @Nonnull String body) // chat
7+
void clearStep(@Nonnull UUID solutionId, @Nonnull SolutionStep step) // clearStep
8+
com.fasterxml.jackson.databind.JsonNode createSolution(@Nonnull UUID solutionId) // createSolution
9+
void deleteSolution(@Nonnull UUID solutionId) // deleteSolution
10+
com.fasterxml.jackson.databind.JsonNode exportSolution(@Nonnull UUID solutionId) // exportSolution
11+
com.fasterxml.jackson.databind.JsonNode getSolution(@Nonnull UUID solutionId) // getSolution
12+
com.fasterxml.jackson.databind.JsonNode getSolutions() // getSolutions
13+
com.fasterxml.jackson.databind.JsonNode importSolution(@Nonnull Object body) // importSolution
14+
com.fasterxml.jackson.databind.JsonNode installSolution(@Nonnull UUID solutionId, @Nonnull String xAuthorization) // installSolution
15+
com.fasterxml.jackson.databind.JsonNode startNew() // startNew
16+
com.fasterxml.jackson.databind.JsonNode uninstallSolution(@Nonnull UUID solutionId, @Nonnull String xAuthorization) // uninstallSolution
17+
com.fasterxml.jackson.databind.JsonNode updateData(@Nonnull UUID solutionId, @Nonnull String dataKey, @Nonnull Object body) // updateData
18+
```
19+
20+
21+
## chat
22+
23+
```
24+
com.fasterxml.jackson.databind.JsonNode chat(@Nonnull UUID solutionId, @Nonnull SolutionStep step, @Nonnull String body)
25+
```
26+
27+
**POST** `/api/ai/solution/{solutionId}/{step}/chat`
28+
29+
chat
30+
31+
32+
### Parameters
33+
34+
| Name | Type | Description | Notes |
35+
|------------- | ------------- | ------------- | -------------|
36+
| **solutionId** | **UUID** | | |
37+
| **step** | **SolutionStep** | | [enum: INITIAL_CONFIGURATION, DASHBOARDS_CONFIGURATION] |
38+
| **body** | **String** | | |
39+
40+
### Return type
41+
42+
**com.fasterxml.jackson.databind.JsonNode**
43+
44+
45+
## clearStep
46+
47+
```
48+
void clearStep(@Nonnull UUID solutionId, @Nonnull SolutionStep step)
49+
```
50+
51+
**DELETE** `/api/ai/solution/{solutionId}/{step}/clear`
52+
53+
clearStep
54+
55+
56+
### Parameters
57+
58+
| Name | Type | Description | Notes |
59+
|------------- | ------------- | ------------- | -------------|
60+
| **solutionId** | **UUID** | | |
61+
| **step** | **SolutionStep** | | [enum: INITIAL_CONFIGURATION, DASHBOARDS_CONFIGURATION] |
62+
63+
### Return type
64+
65+
null (empty response body)
66+
67+
68+
## createSolution
69+
70+
```
71+
com.fasterxml.jackson.databind.JsonNode createSolution(@Nonnull UUID solutionId)
72+
```
73+
74+
**POST** `/api/ai/solution/{solutionId}/create`
75+
76+
createSolution
77+
78+
79+
### Parameters
80+
81+
| Name | Type | Description | Notes |
82+
|------------- | ------------- | ------------- | -------------|
83+
| **solutionId** | **UUID** | | |
84+
85+
### Return type
86+
87+
**com.fasterxml.jackson.databind.JsonNode**
88+
89+
90+
## deleteSolution
91+
92+
```
93+
void deleteSolution(@Nonnull UUID solutionId)
94+
```
95+
96+
**DELETE** `/api/ai/solution/{solutionId}`
97+
98+
deleteSolution
99+
100+
101+
### Parameters
102+
103+
| Name | Type | Description | Notes |
104+
|------------- | ------------- | ------------- | -------------|
105+
| **solutionId** | **UUID** | | |
106+
107+
### Return type
108+
109+
null (empty response body)
110+
111+
112+
## exportSolution
113+
114+
```
115+
com.fasterxml.jackson.databind.JsonNode exportSolution(@Nonnull UUID solutionId)
116+
```
117+
118+
**GET** `/api/ai/solution/{solutionId}/export`
119+
120+
exportSolution
121+
122+
123+
### Parameters
124+
125+
| Name | Type | Description | Notes |
126+
|------------- | ------------- | ------------- | -------------|
127+
| **solutionId** | **UUID** | | |
128+
129+
### Return type
130+
131+
**com.fasterxml.jackson.databind.JsonNode**
132+
133+
134+
## getSolution
135+
136+
```
137+
com.fasterxml.jackson.databind.JsonNode getSolution(@Nonnull UUID solutionId)
138+
```
139+
140+
**GET** `/api/ai/solution/{solutionId}`
141+
142+
getSolution
143+
144+
145+
### Parameters
146+
147+
| Name | Type | Description | Notes |
148+
|------------- | ------------- | ------------- | -------------|
149+
| **solutionId** | **UUID** | | |
150+
151+
### Return type
152+
153+
**com.fasterxml.jackson.databind.JsonNode**
154+
155+
156+
## getSolutions
157+
158+
```
159+
com.fasterxml.jackson.databind.JsonNode getSolutions()
160+
```
161+
162+
**GET** `/api/ai/solution/infos`
163+
164+
getSolutions
165+
166+
### Return type
167+
168+
**com.fasterxml.jackson.databind.JsonNode**
169+
170+
171+
## importSolution
172+
173+
```
174+
com.fasterxml.jackson.databind.JsonNode importSolution(@Nonnull Object body)
175+
```
176+
177+
**POST** `/api/ai/solution/import`
178+
179+
importSolution
180+
181+
182+
### Parameters
183+
184+
| Name | Type | Description | Notes |
185+
|------------- | ------------- | ------------- | -------------|
186+
| **body** | **Object** | | |
187+
188+
### Return type
189+
190+
**com.fasterxml.jackson.databind.JsonNode**
191+
192+
193+
## installSolution
194+
195+
```
196+
com.fasterxml.jackson.databind.JsonNode installSolution(@Nonnull UUID solutionId, @Nonnull String xAuthorization)
197+
```
198+
199+
**POST** `/api/ai/solution/{solutionId}/install`
200+
201+
installSolution
202+
203+
204+
### Parameters
205+
206+
| Name | Type | Description | Notes |
207+
|------------- | ------------- | ------------- | -------------|
208+
| **solutionId** | **UUID** | | |
209+
| **xAuthorization** | **String** | | |
210+
211+
### Return type
212+
213+
**com.fasterxml.jackson.databind.JsonNode**
214+
215+
216+
## startNew
217+
218+
```
219+
com.fasterxml.jackson.databind.JsonNode startNew()
220+
```
221+
222+
**POST** `/api/ai/solution/start`
223+
224+
startNew
225+
226+
### Return type
227+
228+
**com.fasterxml.jackson.databind.JsonNode**
229+
230+
231+
## uninstallSolution
232+
233+
```
234+
com.fasterxml.jackson.databind.JsonNode uninstallSolution(@Nonnull UUID solutionId, @Nonnull String xAuthorization)
235+
```
236+
237+
**DELETE** `/api/ai/solution/{solutionId}/uninstall`
238+
239+
uninstallSolution
240+
241+
242+
### Parameters
243+
244+
| Name | Type | Description | Notes |
245+
|------------- | ------------- | ------------- | -------------|
246+
| **solutionId** | **UUID** | | |
247+
| **xAuthorization** | **String** | | |
248+
249+
### Return type
250+
251+
**com.fasterxml.jackson.databind.JsonNode**
252+
253+
254+
## updateData
255+
256+
```
257+
com.fasterxml.jackson.databind.JsonNode updateData(@Nonnull UUID solutionId, @Nonnull String dataKey, @Nonnull Object body)
258+
```
259+
260+
**PUT** `/api/ai/solution/{solutionId}/{dataKey}`
261+
262+
updateData
263+
264+
265+
### Parameters
266+
267+
| Name | Type | Description | Notes |
268+
|------------- | ------------- | ------------- | -------------|
269+
| **solutionId** | **UUID** | | |
270+
| **dataKey** | **String** | | |
271+
| **body** | **Object** | | |
272+
273+
### Return type
274+
275+
**com.fasterxml.jackson.databind.JsonNode**
276+

‎paas/docs/CalculatedFieldConfiguration.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
|------------ | ------------- | ------------- | -------------|
1010
| **type** | **String** | | |
1111
| **output** | **Output** | | [optional] |
12-
| **aiGenerated** | **Boolean** | | [optional] |
1312

1413

1514

‎paas/docs/ChatType.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
2+
# ChatType
3+
4+
`org.thingsboard.client.model.ChatType`
5+
6+
## Enum Values
7+
8+
9+
* `GENERIC` (value: `"GENERIC"`)
10+
11+
* `SOLUTION_BUILDER` (value: `"SOLUTION_BUILDER"`)
12+
13+
14+
15+
---
16+
17+
### Conventions
18+
19+
- **Package:** `org.thingsboard.client.model`
20+
- **Getter pattern:** `get<PropertyName>()` — e.g., `getId()`, `getName()`
21+
- **Setter pattern:** `set<PropertyName>(value)` — e.g., `setId(value)`, `setName(value)`
22+
- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions
23+

‎paas/docs/Resource.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@
112112

113113
* `AI_MODEL` (value: `"AI_MODEL"`)
114114

115-
* `AI_SOLUTION_CREATOR` (value: `"AI_SOLUTION_CREATOR"`)
115+
* `AI` (value: `"AI"`)
116116

117117
* `API_KEY` (value: `"API_KEY"`)
118118

‎paas/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

‎paas/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+

‎paas/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

0 commit comments

Comments
 (0)