Skip to content

Commit 710ddba

Browse files
ViacheslavKlimovViacheslavKlimov
committed
Update PE OpenAPI spec (from master)
1 parent f74a19c commit 710ddba

68 files changed

Lines changed: 14633 additions & 8642 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎pe/docs/AiChatControllerApi.md‎

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
# AiChatControllerApi
2+
3+
`ThingsboardClient` methods:
4+
5+
```
6+
com.fasterxml.jackson.databind.JsonNode createChat(@Nonnull Object body) // createChat
7+
void deleteChat(@Nonnull UUID chatId) // deleteChat
8+
com.fasterxml.jackson.databind.JsonNode getChatMessages(@Nonnull UUID chatId) // getChatMessages
9+
com.fasterxml.jackson.databind.JsonNode listChats(@Nonnull ChatType chatType) // listChats
10+
List<Object> sendChatMessage(@Nonnull UUID chatId, @Nonnull String xAuthorization, @Nonnull String body) // sendChatMessage
11+
void updateChat(@Nonnull UUID chatId, @Nonnull Object body) // updateChat
12+
```
13+
14+
15+
## createChat
16+
17+
```
18+
com.fasterxml.jackson.databind.JsonNode createChat(@Nonnull Object body)
19+
```
20+
21+
**POST** `/api/ai/chats`
22+
23+
createChat
24+
25+
26+
### Parameters
27+
28+
| Name | Type | Description | Notes |
29+
|------------- | ------------- | ------------- | -------------|
30+
| **body** | **Object** | | |
31+
32+
### Return type
33+
34+
**com.fasterxml.jackson.databind.JsonNode**
35+
36+
37+
## deleteChat
38+
39+
```
40+
void deleteChat(@Nonnull UUID chatId)
41+
```
42+
43+
**DELETE** `/api/ai/chats/{chatId}`
44+
45+
deleteChat
46+
47+
48+
### Parameters
49+
50+
| Name | Type | Description | Notes |
51+
|------------- | ------------- | ------------- | -------------|
52+
| **chatId** | **UUID** | | |
53+
54+
### Return type
55+
56+
null (empty response body)
57+
58+
59+
## getChatMessages
60+
61+
```
62+
com.fasterxml.jackson.databind.JsonNode getChatMessages(@Nonnull UUID chatId)
63+
```
64+
65+
**GET** `/api/ai/chats/{chatId}/messages`
66+
67+
getChatMessages
68+
69+
70+
### Parameters
71+
72+
| Name | Type | Description | Notes |
73+
|------------- | ------------- | ------------- | -------------|
74+
| **chatId** | **UUID** | | |
75+
76+
### Return type
77+
78+
**com.fasterxml.jackson.databind.JsonNode**
79+
80+
81+
## listChats
82+
83+
```
84+
com.fasterxml.jackson.databind.JsonNode listChats(@Nonnull ChatType chatType)
85+
```
86+
87+
**GET** `/api/ai/chats/{chatType}`
88+
89+
listChats
90+
91+
92+
### Parameters
93+
94+
| Name | Type | Description | Notes |
95+
|------------- | ------------- | ------------- | -------------|
96+
| **chatType** | **ChatType** | | [enum: GENERIC, SOLUTION_BUILDER] |
97+
98+
### Return type
99+
100+
**com.fasterxml.jackson.databind.JsonNode**
101+
102+
103+
## sendChatMessage
104+
105+
```
106+
List<Object> sendChatMessage(@Nonnull UUID chatId, @Nonnull String xAuthorization, @Nonnull String body)
107+
```
108+
109+
**POST** `/api/ai/chats/{chatId}/messages`
110+
111+
sendChatMessage
112+
113+
114+
### Parameters
115+
116+
| Name | Type | Description | Notes |
117+
|------------- | ------------- | ------------- | -------------|
118+
| **chatId** | **UUID** | | |
119+
| **xAuthorization** | **String** | | |
120+
| **body** | **String** | | |
121+
122+
### Return type
123+
124+
**List<Object>**
125+
126+
127+
## updateChat
128+
129+
```
130+
void updateChat(@Nonnull UUID chatId, @Nonnull Object body)
131+
```
132+
133+
**PATCH** `/api/ai/chats/{chatId}`
134+
135+
updateChat
136+
137+
138+
### Parameters
139+
140+
| Name | Type | Description | Notes |
141+
|------------- | ------------- | ------------- | -------------|
142+
| **chatId** | **UUID** | | |
143+
| **body** | **Object** | | |
144+
145+
### Return type
146+
147+
null (empty response body)
148+

‎pe/docs/AiSolutionControllerApi.md‎

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

0 commit comments

Comments
 (0)