Skip to content

Commit dbfef41

Browse files
ViacheslavKlimovViacheslavKlimov
committed
Split docs per controller
1 parent ce26883 commit dbfef41

File tree

228 files changed

+85844
-3
lines changed

Some content is hidden

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

228 files changed

+85844
-3
lines changed

‎ce/docs/AdminControllerApi.md‎

Lines changed: 947 additions & 0 deletions
Large diffs are not rendered by default.

‎ce/docs/AiModelControllerApi.md‎

Lines changed: 217 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,217 @@
1+
# AiModelControllerApi
2+
3+
All URIs are relative to *http://localhost:8080*
4+
5+
| Method | HTTP request | Description |
6+
|------------- | ------------- | -------------|
7+
| [**deleteAiModelById**](AiModelControllerApi.md#deleteAiModelById) | **DELETE** /api/ai/model/{modelUuid} | Delete AI model by ID (deleteAiModelById) |
8+
| [**getAiModelById**](AiModelControllerApi.md#getAiModelById) | **GET** /api/ai/model/{modelUuid} | Get AI model by ID (getAiModelById) |
9+
| [**getAiModels**](AiModelControllerApi.md#getAiModels) | **GET** /api/ai/model | Get AI models (getAiModels) |
10+
| [**saveAiModel**](AiModelControllerApi.md#saveAiModel) | **POST** /api/ai/model | Create or update AI model (saveAiModel) |
11+
| [**sendChatRequest**](AiModelControllerApi.md#sendChatRequest) | **POST** /api/ai/model/chat | Send request to AI chat model (sendChatRequest) |
12+
13+
14+
15+
## deleteAiModelById
16+
17+
> Boolean deleteAiModelById(modelUuid)
18+
19+
Delete AI model by ID (deleteAiModelById)
20+
21+
Deletes the AI model record by its `id`. If a record with the specified `id` exists, the record is deleted and the endpoint returns `true`. If no such record exists, the endpoint returns `false`. Available for users with 'TENANT_ADMIN' authority.
22+
23+
### Parameters
24+
25+
26+
| Name | Type | Description | Notes |
27+
|------------- | ------------- | ------------- | -------------|
28+
| **modelUuid** | **UUID**| ID of the AI model record | |
29+
30+
### Return type
31+
32+
**Boolean**
33+
34+
### Authorization
35+
36+
[api_key_form](../README.md#api_key_form), [http_login_form](../README.md#http_login_form)
37+
38+
### HTTP request headers
39+
40+
- **Content-Type**: Not defined
41+
- **Accept**: application/json
42+
43+
44+
### HTTP response details
45+
| Status code | Description | Response headers |
46+
|-------------|-------------|------------------|
47+
| **200** | OK | - |
48+
| **400** | Bad Request | - |
49+
| **401** | Unauthorized | - |
50+
| **403** | Forbidden | - |
51+
| **404** | Not Found | - |
52+
| **429** | Too Many Requests | - |
53+
54+
55+
## getAiModelById
56+
57+
> AiModel getAiModelById(modelUuid)
58+
59+
Get AI model by ID (getAiModelById)
60+
61+
Fetches an AI model record by its `id`. Available for users with 'TENANT_ADMIN' authority.
62+
63+
### Parameters
64+
65+
66+
| Name | Type | Description | Notes |
67+
|------------- | ------------- | ------------- | -------------|
68+
| **modelUuid** | **UUID**| ID of the AI model record | |
69+
70+
### Return type
71+
72+
[**AiModel**](AiModel.md)
73+
74+
### Authorization
75+
76+
[api_key_form](../README.md#api_key_form), [http_login_form](../README.md#http_login_form)
77+
78+
### HTTP request headers
79+
80+
- **Content-Type**: Not defined
81+
- **Accept**: application/json
82+
83+
84+
### HTTP response details
85+
| Status code | Description | Response headers |
86+
|-------------|-------------|------------------|
87+
| **200** | OK | - |
88+
| **400** | Bad Request | - |
89+
| **401** | Unauthorized | - |
90+
| **403** | Forbidden | - |
91+
| **404** | Not Found | - |
92+
| **429** | Too Many Requests | - |
93+
94+
95+
## getAiModels
96+
97+
> PageDataAiModel getAiModels(pageSize, page, textSearch, sortProperty, sortOrder)
98+
99+
Get AI models (getAiModels)
100+
101+
Returns a page of AI models. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. Available for users with 'TENANT_ADMIN' authority.
102+
103+
### Parameters
104+
105+
106+
| Name | Type | Description | Notes |
107+
|------------- | ------------- | ------------- | -------------|
108+
| **pageSize** | **Integer**| Maximum amount of entities in a one page | |
109+
| **page** | **Integer**| Sequence number of page starting from 0 | |
110+
| **textSearch** | **String**| The case insensitive 'substring' filter based on the AI model name, provider and model ID. | [optional] |
111+
| **sortProperty** | **String**| Property of entity to sort by | [optional] [enum: createdTime, name, provider, modelId] |
112+
| **sortOrder** | **String**| Sort order. ASC (ASCENDING) or DESC (DESCENDING) | [optional] [enum: ASC, DESC] |
113+
114+
### Return type
115+
116+
[**PageDataAiModel**](PageDataAiModel.md)
117+
118+
### Authorization
119+
120+
[api_key_form](../README.md#api_key_form), [http_login_form](../README.md#http_login_form)
121+
122+
### HTTP request headers
123+
124+
- **Content-Type**: Not defined
125+
- **Accept**: application/json
126+
127+
128+
### HTTP response details
129+
| Status code | Description | Response headers |
130+
|-------------|-------------|------------------|
131+
| **200** | OK | - |
132+
| **400** | Bad Request | - |
133+
| **401** | Unauthorized | - |
134+
| **403** | Forbidden | - |
135+
| **404** | Not Found | - |
136+
| **429** | Too Many Requests | - |
137+
138+
139+
## saveAiModel
140+
141+
> AiModel saveAiModel(aiModel)
142+
143+
Create or update AI model (saveAiModel)
144+
145+
Creates or updates an AI model record. • **Create:** Omit the `id` to create a new record. The platform assigns a UUID to the new record and returns it in the `id` field of the response. • **Update:** Include an existing `id` to modify that record. If no matching record exists, the API responds with **404 Not Found**. Tenant ID for the AI model will be taken from the authenticated user making the request, regardless of any value provided in the request body. Available for users with 'TENANT_ADMIN' authority.
146+
147+
### Parameters
148+
149+
150+
| Name | Type | Description | Notes |
151+
|------------- | ------------- | ------------- | -------------|
152+
| **aiModel** | [**AiModel**](AiModel.md)| | |
153+
154+
### Return type
155+
156+
[**AiModel**](AiModel.md)
157+
158+
### Authorization
159+
160+
[api_key_form](../README.md#api_key_form), [http_login_form](../README.md#http_login_form)
161+
162+
### HTTP request headers
163+
164+
- **Content-Type**: application/json
165+
- **Accept**: application/json
166+
167+
168+
### HTTP response details
169+
| Status code | Description | Response headers |
170+
|-------------|-------------|------------------|
171+
| **200** | OK | - |
172+
| **400** | Bad Request | - |
173+
| **401** | Unauthorized | - |
174+
| **403** | Forbidden | - |
175+
| **404** | Not Found | - |
176+
| **429** | Too Many Requests | - |
177+
178+
179+
## sendChatRequest
180+
181+
> TbChatResponse sendChatRequest(tbChatRequest)
182+
183+
Send request to AI chat model (sendChatRequest)
184+
185+
Submits a single prompt - made up of an optional system message and a required user message - to the specified AI chat model and returns either the generated answer or an error envelope. Available for users with 'TENANT_ADMIN' authority.
186+
187+
### Parameters
188+
189+
190+
| Name | Type | Description | Notes |
191+
|------------- | ------------- | ------------- | -------------|
192+
| **tbChatRequest** | [**TbChatRequest**](TbChatRequest.md)| | |
193+
194+
### Return type
195+
196+
[**TbChatResponse**](TbChatResponse.md)
197+
198+
### Authorization
199+
200+
[api_key_form](../README.md#api_key_form), [http_login_form](../README.md#http_login_form)
201+
202+
### HTTP request headers
203+
204+
- **Content-Type**: application/json
205+
- **Accept**: application/json
206+
207+
208+
### HTTP response details
209+
| Status code | Description | Response headers |
210+
|-------------|-------------|------------------|
211+
| **200** | OK | - |
212+
| **400** | Bad Request | - |
213+
| **401** | Unauthorized | - |
214+
| **403** | Forbidden | - |
215+
| **404** | Not Found | - |
216+
| **429** | Too Many Requests | - |
217+

‎ce/docs/AlarmCommentControllerApi.md‎

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
# AlarmCommentControllerApi
2+
3+
All URIs are relative to *http://localhost:8080*
4+
5+
| Method | HTTP request | Description |
6+
|------------- | ------------- | -------------|
7+
| [**deleteAlarmComment**](AlarmCommentControllerApi.md#deleteAlarmComment) | **DELETE** /api/alarm/{alarmId}/comment/{commentId} | Delete Alarm comment (deleteAlarmComment) |
8+
| [**getAlarmComments**](AlarmCommentControllerApi.md#getAlarmComments) | **GET** /api/alarm/{alarmId}/comment | Get Alarm comments (getAlarmComments) |
9+
| [**saveAlarmComment**](AlarmCommentControllerApi.md#saveAlarmComment) | **POST** /api/alarm/{alarmId}/comment | Create or update Alarm Comment |
10+
11+
12+
13+
## deleteAlarmComment
14+
15+
> deleteAlarmComment(alarmId, commentId)
16+
17+
Delete Alarm comment (deleteAlarmComment)
18+
19+
Deletes the Alarm comment. Referencing non-existing Alarm comment Id will cause an error. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
20+
21+
### Parameters
22+
23+
24+
| Name | Type | Description | Notes |
25+
|------------- | ------------- | ------------- | -------------|
26+
| **alarmId** | **String**| A string value representing the alarm id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
27+
| **commentId** | **String**| A string value representing the alarm comment id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
28+
29+
### Return type
30+
31+
null (empty response body)
32+
33+
### Authorization
34+
35+
[api_key_form](../README.md#api_key_form), [http_login_form](../README.md#http_login_form)
36+
37+
### HTTP request headers
38+
39+
- **Content-Type**: Not defined
40+
- **Accept**: application/json
41+
42+
43+
### HTTP response details
44+
| Status code | Description | Response headers |
45+
|-------------|-------------|------------------|
46+
| **200** | OK | - |
47+
| **400** | Bad Request | - |
48+
| **401** | Unauthorized | - |
49+
| **403** | Forbidden | - |
50+
| **404** | Not Found | - |
51+
| **429** | Too Many Requests | - |
52+
53+
54+
## getAlarmComments
55+
56+
> PageDataAlarmCommentInfo getAlarmComments(alarmId, pageSize, page, sortProperty, sortOrder)
57+
58+
Get Alarm comments (getAlarmComments)
59+
60+
Returns a page of alarm comments for specified alarm. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
61+
62+
### Parameters
63+
64+
65+
| Name | Type | Description | Notes |
66+
|------------- | ------------- | ------------- | -------------|
67+
| **alarmId** | **String**| A string value representing the alarm id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
68+
| **pageSize** | **Integer**| Maximum amount of entities in a one page | |
69+
| **page** | **Integer**| Sequence number of page starting from 0 | |
70+
| **sortProperty** | **String**| Property of entity to sort by | [optional] [enum: createdTime, id] |
71+
| **sortOrder** | **String**| Sort order. ASC (ASCENDING) or DESC (DESCENDING) | [optional] [enum: ASC, DESC] |
72+
73+
### Return type
74+
75+
[**PageDataAlarmCommentInfo**](PageDataAlarmCommentInfo.md)
76+
77+
### Authorization
78+
79+
[api_key_form](../README.md#api_key_form), [http_login_form](../README.md#http_login_form)
80+
81+
### HTTP request headers
82+
83+
- **Content-Type**: Not defined
84+
- **Accept**: application/json
85+
86+
87+
### HTTP response details
88+
| Status code | Description | Response headers |
89+
|-------------|-------------|------------------|
90+
| **200** | OK | - |
91+
| **400** | Bad Request | - |
92+
| **401** | Unauthorized | - |
93+
| **403** | Forbidden | - |
94+
| **404** | Not Found | - |
95+
| **429** | Too Many Requests | - |
96+
97+
98+
## saveAlarmComment
99+
100+
> AlarmComment saveAlarmComment(alarmId, alarmComment)
101+
102+
Create or update Alarm Comment
103+
104+
Creates or Updates the Alarm Comment. When creating comment, platform generates Alarm Comment Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Alarm Comment id will be present in the response. Specify existing Alarm Comment id to update the alarm. Referencing non-existing Alarm Comment Id will cause 'Not Found' error. To create new Alarm comment entity it is enough to specify 'comment' json element with 'text' node, for example: {\"comment\": { \"text\": \"my comment\"}}. If comment type is not specified the default value 'OTHER' will be saved. If 'alarmId' or 'userId' specified in body it will be ignored. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
105+
106+
### Parameters
107+
108+
109+
| Name | Type | Description | Notes |
110+
|------------- | ------------- | ------------- | -------------|
111+
| **alarmId** | **String**| A string value representing the alarm id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
112+
| **alarmComment** | [**AlarmComment**](AlarmComment.md)| A JSON value representing the comment. | |
113+
114+
### Return type
115+
116+
[**AlarmComment**](AlarmComment.md)
117+
118+
### Authorization
119+
120+
[api_key_form](../README.md#api_key_form), [http_login_form](../README.md#http_login_form)
121+
122+
### HTTP request headers
123+
124+
- **Content-Type**: application/json
125+
- **Accept**: application/json
126+
127+
128+
### HTTP response details
129+
| Status code | Description | Response headers |
130+
|-------------|-------------|------------------|
131+
| **200** | OK | - |
132+
| **400** | Bad Request | - |
133+
| **401** | Unauthorized | - |
134+
| **403** | Forbidden | - |
135+
| **404** | Not Found | - |
136+
| **429** | Too Many Requests | - |
137+

0 commit comments

Comments
 (0)