Skip to content

Commit 57ba57c

Browse files
ViacheslavKlimovViacheslavKlimov
committed
Cleanup the docs
1 parent dbfef41 commit 57ba57c

File tree

228 files changed

+6808
-58152
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

+6808
-58152
lines changed

‎ce/docs/AdminControllerApi.md‎

Lines changed: 35 additions & 693 deletions
Large diffs are not rendered by default.

‎ce/docs/AiModelControllerApi.md‎

Lines changed: 14 additions & 141 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
# AiModelControllerApi
22

3-
All URIs are relative to *http://localhost:8080*
4-
53
| Method | HTTP request | Description |
64
|------------- | ------------- | -------------|
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) |
5+
| [**deleteAiModelById**](#deleteAiModelById) | **DELETE** /api/ai/model/{modelUuid} | Delete AI model by ID (deleteAiModelById) |
6+
| [**getAiModelById**](#getAiModelById) | **GET** /api/ai/model/{modelUuid} | Get AI model by ID (getAiModelById) |
7+
| [**getAiModels**](#getAiModels) | **GET** /api/ai/model | Get AI models (getAiModels) |
8+
| [**saveAiModel**](#saveAiModel) | **POST** /api/ai/model | Create or update AI model (saveAiModel) |
9+
| [**sendChatRequest**](#sendChatRequest) | **POST** /api/ai/model/chat | Send request to AI chat model (sendChatRequest) |
1210

1311

1412

@@ -22,34 +20,9 @@ Deletes the AI model record by its `id`. If a record with the specifie
2220

2321
### Parameters
2422

25-
2623
| Name | Type | Description | Notes |
2724
|------------- | ------------- | ------------- | -------------|
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 | - |
25+
| **modelUuid** | **UUID** | ID of the AI model record | |
5326

5427

5528
## getAiModelById
@@ -62,34 +35,9 @@ Fetches an AI model record by its `id`. Available for users with &#39
6235

6336
### Parameters
6437

65-
6638
| Name | Type | Description | Notes |
6739
|------------- | ------------- | ------------- | -------------|
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 | - |
40+
| **modelUuid** | **UUID** | ID of the AI model record | |
9341

9442

9543
## getAiModels
@@ -102,38 +50,13 @@ Returns a page of AI models. You can specify parameters to filter the results. T
10250

10351
### Parameters
10452

105-
10653
| Name | Type | Description | Notes |
10754
|------------- | ------------- | ------------- | -------------|
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 | - |
55+
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
56+
| **page** | **Integer** | Sequence number of page starting from 0 | |
57+
| **textSearch** | **String** | The case insensitive 'substring' filter based on the AI model name, provider and model ID. | [optional] |
58+
| **sortProperty** | **String** | Property of entity to sort by | [optional] [enum: createdTime, name, provider, modelId] |
59+
| **sortOrder** | **String** | Sort order. ASC (ASCENDING) or DESC (DESCENDING) | [optional] [enum: ASC, DESC] |
13760

13861

13962
## saveAiModel
@@ -146,34 +69,9 @@ Creates or updates an AI model record. • **Create:** Omit the `id`
14669

14770
### Parameters
14871

149-
15072
| Name | Type | Description | Notes |
15173
|------------- | ------------- | ------------- | -------------|
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 | - |
74+
| **aiModel** | **AiModel** | | |
17775

17876

17977
## sendChatRequest
@@ -186,32 +84,7 @@ Submits a single prompt - made up of an optional system message and a required u
18684

18785
### Parameters
18886

189-
19087
| Name | Type | Description | Notes |
19188
|------------- | ------------- | ------------- | -------------|
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 | - |
89+
| **tbChatRequest** | **TbChatRequest** | | |
21790

‎ce/docs/AlarmCommentControllerApi.md‎

Lines changed: 12 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
# AlarmCommentControllerApi
22

3-
All URIs are relative to *http://localhost:8080*
4-
53
| Method | HTTP request | Description |
64
|------------- | ------------- | -------------|
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 |
5+
| [**deleteAlarmComment**](#deleteAlarmComment) | **DELETE** /api/alarm/{alarmId}/comment/{commentId} | Delete Alarm comment (deleteAlarmComment) |
6+
| [**getAlarmComments**](#getAlarmComments) | **GET** /api/alarm/{alarmId}/comment | Get Alarm comments (getAlarmComments) |
7+
| [**saveAlarmComment**](#saveAlarmComment) | **POST** /api/alarm/{alarmId}/comment | Create or update Alarm Comment |
108

119

1210

@@ -20,35 +18,10 @@ Deletes the Alarm comment. Referencing non-existing Alarm comment Id will cause
2018

2119
### Parameters
2220

23-
2421
| Name | Type | Description | Notes |
2522
|------------- | ------------- | ------------- | -------------|
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 | - |
23+
| **alarmId** | **String** | A string value representing the alarm id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
24+
| **commentId** | **String** | A string value representing the alarm comment id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
5225

5326

5427
## getAlarmComments
@@ -61,38 +34,13 @@ Returns a page of alarm comments for specified alarm. You can specify parameters
6134

6235
### Parameters
6336

64-
6537
| Name | Type | Description | Notes |
6638
|------------- | ------------- | ------------- | -------------|
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 | - |
39+
| **alarmId** | **String** | A string value representing the alarm id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
40+
| **pageSize** | **Integer** | Maximum amount of entities in a one page | |
41+
| **page** | **Integer** | Sequence number of page starting from 0 | |
42+
| **sortProperty** | **String** | Property of entity to sort by | [optional] [enum: createdTime, id] |
43+
| **sortOrder** | **String** | Sort order. ASC (ASCENDING) or DESC (DESCENDING) | [optional] [enum: ASC, DESC] |
9644

9745

9846
## saveAlarmComment
@@ -105,33 +53,8 @@ Creates or Updates the Alarm Comment. When creating comment, platform generates
10553

10654
### Parameters
10755

108-
10956
| Name | Type | Description | Notes |
11057
|------------- | ------------- | ------------- | -------------|
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 | - |
58+
| **alarmId** | **String** | A string value representing the alarm id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
59+
| **alarmComment** | **AlarmComment** | A JSON value representing the comment. | |
13760

0 commit comments

Comments
 (0)