@nestbox-ai/admin 1.0.42 → 1.0.48
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +3 -0
- package/.openapi-generator/VERSION +1 -1
- package/README.md +9 -2
- package/api.ts +387 -0
- package/common.ts +4 -4
- package/dist/api.d.ts +219 -0
- package/dist/api.js +310 -0
- package/dist/esm/api.d.ts +219 -0
- package/dist/esm/api.js +310 -0
- package/docs/BenchmarkingDatapointDto.md +22 -0
- package/docs/BenchmarkingReportsDto.md +22 -0
- package/docs/MachineAgentLogsApi.md +65 -0
- package/docs/MachineInstancesApi.md +177 -0
- package/docs/MachineStatusDto.md +24 -0
- package/package.json +1 -1
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# BenchmarkingReportsDto
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**content** | **string** | Combined markdown content of all benchmarking reports | [default to undefined]
|
|
9
|
+
**totalReports** | **number** | Total number of reports found | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { BenchmarkingReportsDto } from '@nestbox-ai/admin';
|
|
15
|
+
|
|
16
|
+
const instance: BenchmarkingReportsDto = {
|
|
17
|
+
content,
|
|
18
|
+
totalReports,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -4,8 +4,73 @@ All URIs are relative to *http://localhost*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**logsControllerFetchAgentLogs**](#logscontrollerfetchagentlogs) | **GET** /projects/{projectId}/logs/{agentId} | Fetch agent logs.|
|
|
7
8
|
|[**logsControllerFetchEventLogs**](#logscontrollerfetcheventlogs) | **GET** /projects/{projectId}/fetchEventLogs/{agentId} | Fetch event logs.|
|
|
8
9
|
|
|
10
|
+
# **logsControllerFetchAgentLogs**
|
|
11
|
+
> object logsControllerFetchAgentLogs()
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
### Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import {
|
|
18
|
+
MachineAgentLogsApi,
|
|
19
|
+
Configuration
|
|
20
|
+
} from '@nestbox-ai/admin';
|
|
21
|
+
|
|
22
|
+
const configuration = new Configuration();
|
|
23
|
+
const apiInstance = new MachineAgentLogsApi(configuration);
|
|
24
|
+
|
|
25
|
+
let projectId: string; // (default to undefined)
|
|
26
|
+
let agentId: string; // (default to undefined)
|
|
27
|
+
let direction: string; // (default to undefined)
|
|
28
|
+
let cursor: string; // (default to undefined)
|
|
29
|
+
|
|
30
|
+
const { status, data } = await apiInstance.logsControllerFetchAgentLogs(
|
|
31
|
+
projectId,
|
|
32
|
+
agentId,
|
|
33
|
+
direction,
|
|
34
|
+
cursor
|
|
35
|
+
);
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Parameters
|
|
39
|
+
|
|
40
|
+
|Name | Type | Description | Notes|
|
|
41
|
+
|------------- | ------------- | ------------- | -------------|
|
|
42
|
+
| **projectId** | [**string**] | | defaults to undefined|
|
|
43
|
+
| **agentId** | [**string**] | | defaults to undefined|
|
|
44
|
+
| **direction** | [**string**] | | defaults to undefined|
|
|
45
|
+
| **cursor** | [**string**] | | defaults to undefined|
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
### Return type
|
|
49
|
+
|
|
50
|
+
**object**
|
|
51
|
+
|
|
52
|
+
### Authorization
|
|
53
|
+
|
|
54
|
+
No authorization required
|
|
55
|
+
|
|
56
|
+
### HTTP request headers
|
|
57
|
+
|
|
58
|
+
- **Content-Type**: Not defined
|
|
59
|
+
- **Accept**: application/json
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
### HTTP response details
|
|
63
|
+
| Status code | Description | Response headers |
|
|
64
|
+
|-------------|-------------|------------------|
|
|
65
|
+
|**200** | | - |
|
|
66
|
+
|**400** | | - |
|
|
67
|
+
|**401** | | - |
|
|
68
|
+
|**403** | | - |
|
|
69
|
+
|**404** | | - |
|
|
70
|
+
|**500** | | - |
|
|
71
|
+
|
|
72
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
73
|
+
|
|
9
74
|
# **logsControllerFetchEventLogs**
|
|
10
75
|
> object logsControllerFetchEventLogs()
|
|
11
76
|
|
|
@@ -7,6 +7,9 @@ All URIs are relative to *http://localhost*
|
|
|
7
7
|
|[**machineInstancesControllerCreateMachineInstance**](#machineinstancescontrollercreatemachineinstance) | **POST** /projects/{projectId}/instances | Create Machine Instance|
|
|
8
8
|
|[**machineInstancesControllerDeleteMachineInstance**](#machineinstancescontrollerdeletemachineinstance) | **DELETE** /projects/{projectId}/instances | Delete machine instances by ids|
|
|
9
9
|
|[**machineInstancesControllerGetInstanceRunningStatus**](#machineinstancescontrollergetinstancerunningstatus) | **GET** /projects/{projectId}/instances/status | Retrieve running status of instances|
|
|
10
|
+
|[**machineInstancesControllerGetMachineBenchmarkingDatapoints**](#machineinstancescontrollergetmachinebenchmarkingdatapoints) | **GET** /projects/{projectId}/instances/machine/{machineId}/benchmarking-datapoints | Retrieve CSV benchmarking datapoints for a specific machine|
|
|
11
|
+
|[**machineInstancesControllerGetMachineBenchmarkingReports**](#machineinstancescontrollergetmachinebenchmarkingreports) | **GET** /projects/{projectId}/instances/machine/{machineId}/benchmarking-reports | Retrieve benchmarking reports for a specific machine|
|
|
12
|
+
|[**machineInstancesControllerGetMachineBootstrapStatus**](#machineinstancescontrollergetmachinebootstrapstatus) | **GET** /projects/{projectId}/instances/machine/{machineId}/status | Retrieve status of a specific machine instance|
|
|
10
13
|
|[**machineInstancesControllerGetMachineInstanceById**](#machineinstancescontrollergetmachineinstancebyid) | **GET** /projects/{projectId}/instances/machine/{machineId} | Retrieve running status of instances|
|
|
11
14
|
|[**machineInstancesControllerGetMachineInstanceByUserId**](#machineinstancescontrollergetmachineinstancebyuserid) | **GET** /projects/{projectId}/instances | Retrieve all machine instances with count|
|
|
12
15
|
|[**machineInstancesControllerUpdateRunningStatus**](#machineinstancescontrollerupdaterunningstatus) | **PUT** /projects/{projectId}/instances/status | Update Machine Instance Running Status|
|
|
@@ -164,6 +167,180 @@ No authorization required
|
|
|
164
167
|
- **Accept**: application/json
|
|
165
168
|
|
|
166
169
|
|
|
170
|
+
### HTTP response details
|
|
171
|
+
| Status code | Description | Response headers |
|
|
172
|
+
|-------------|-------------|------------------|
|
|
173
|
+
|**200** | | - |
|
|
174
|
+
|**400** | | - |
|
|
175
|
+
|**401** | | - |
|
|
176
|
+
|**403** | | - |
|
|
177
|
+
|**404** | | - |
|
|
178
|
+
|**500** | | - |
|
|
179
|
+
|
|
180
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
181
|
+
|
|
182
|
+
# **machineInstancesControllerGetMachineBenchmarkingDatapoints**
|
|
183
|
+
> BenchmarkingDatapointDto machineInstancesControllerGetMachineBenchmarkingDatapoints()
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
### Example
|
|
187
|
+
|
|
188
|
+
```typescript
|
|
189
|
+
import {
|
|
190
|
+
MachineInstancesApi,
|
|
191
|
+
Configuration
|
|
192
|
+
} from '@nestbox-ai/admin';
|
|
193
|
+
|
|
194
|
+
const configuration = new Configuration();
|
|
195
|
+
const apiInstance = new MachineInstancesApi(configuration);
|
|
196
|
+
|
|
197
|
+
let projectId: string; // (default to undefined)
|
|
198
|
+
let machineId: string; // (default to undefined)
|
|
199
|
+
|
|
200
|
+
const { status, data } = await apiInstance.machineInstancesControllerGetMachineBenchmarkingDatapoints(
|
|
201
|
+
projectId,
|
|
202
|
+
machineId
|
|
203
|
+
);
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
### Parameters
|
|
207
|
+
|
|
208
|
+
|Name | Type | Description | Notes|
|
|
209
|
+
|------------- | ------------- | ------------- | -------------|
|
|
210
|
+
| **projectId** | [**string**] | | defaults to undefined|
|
|
211
|
+
| **machineId** | [**string**] | | defaults to undefined|
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
### Return type
|
|
215
|
+
|
|
216
|
+
**BenchmarkingDatapointDto**
|
|
217
|
+
|
|
218
|
+
### Authorization
|
|
219
|
+
|
|
220
|
+
No authorization required
|
|
221
|
+
|
|
222
|
+
### HTTP request headers
|
|
223
|
+
|
|
224
|
+
- **Content-Type**: Not defined
|
|
225
|
+
- **Accept**: application/json
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
### HTTP response details
|
|
229
|
+
| Status code | Description | Response headers |
|
|
230
|
+
|-------------|-------------|------------------|
|
|
231
|
+
|**200** | | - |
|
|
232
|
+
|**400** | | - |
|
|
233
|
+
|**401** | | - |
|
|
234
|
+
|**403** | | - |
|
|
235
|
+
|**404** | | - |
|
|
236
|
+
|**500** | | - |
|
|
237
|
+
|
|
238
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
239
|
+
|
|
240
|
+
# **machineInstancesControllerGetMachineBenchmarkingReports**
|
|
241
|
+
> BenchmarkingReportsDto machineInstancesControllerGetMachineBenchmarkingReports()
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
### Example
|
|
245
|
+
|
|
246
|
+
```typescript
|
|
247
|
+
import {
|
|
248
|
+
MachineInstancesApi,
|
|
249
|
+
Configuration
|
|
250
|
+
} from '@nestbox-ai/admin';
|
|
251
|
+
|
|
252
|
+
const configuration = new Configuration();
|
|
253
|
+
const apiInstance = new MachineInstancesApi(configuration);
|
|
254
|
+
|
|
255
|
+
let projectId: string; // (default to undefined)
|
|
256
|
+
let machineId: string; // (default to undefined)
|
|
257
|
+
|
|
258
|
+
const { status, data } = await apiInstance.machineInstancesControllerGetMachineBenchmarkingReports(
|
|
259
|
+
projectId,
|
|
260
|
+
machineId
|
|
261
|
+
);
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
### Parameters
|
|
265
|
+
|
|
266
|
+
|Name | Type | Description | Notes|
|
|
267
|
+
|------------- | ------------- | ------------- | -------------|
|
|
268
|
+
| **projectId** | [**string**] | | defaults to undefined|
|
|
269
|
+
| **machineId** | [**string**] | | defaults to undefined|
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
### Return type
|
|
273
|
+
|
|
274
|
+
**BenchmarkingReportsDto**
|
|
275
|
+
|
|
276
|
+
### Authorization
|
|
277
|
+
|
|
278
|
+
No authorization required
|
|
279
|
+
|
|
280
|
+
### HTTP request headers
|
|
281
|
+
|
|
282
|
+
- **Content-Type**: Not defined
|
|
283
|
+
- **Accept**: application/json
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
### HTTP response details
|
|
287
|
+
| Status code | Description | Response headers |
|
|
288
|
+
|-------------|-------------|------------------|
|
|
289
|
+
|**200** | | - |
|
|
290
|
+
|**400** | | - |
|
|
291
|
+
|**401** | | - |
|
|
292
|
+
|**403** | | - |
|
|
293
|
+
|**404** | | - |
|
|
294
|
+
|**500** | | - |
|
|
295
|
+
|
|
296
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
297
|
+
|
|
298
|
+
# **machineInstancesControllerGetMachineBootstrapStatus**
|
|
299
|
+
> MachineStatusDto machineInstancesControllerGetMachineBootstrapStatus()
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
### Example
|
|
303
|
+
|
|
304
|
+
```typescript
|
|
305
|
+
import {
|
|
306
|
+
MachineInstancesApi,
|
|
307
|
+
Configuration
|
|
308
|
+
} from '@nestbox-ai/admin';
|
|
309
|
+
|
|
310
|
+
const configuration = new Configuration();
|
|
311
|
+
const apiInstance = new MachineInstancesApi(configuration);
|
|
312
|
+
|
|
313
|
+
let projectId: string; // (default to undefined)
|
|
314
|
+
let machineId: string; // (default to undefined)
|
|
315
|
+
|
|
316
|
+
const { status, data } = await apiInstance.machineInstancesControllerGetMachineBootstrapStatus(
|
|
317
|
+
projectId,
|
|
318
|
+
machineId
|
|
319
|
+
);
|
|
320
|
+
```
|
|
321
|
+
|
|
322
|
+
### Parameters
|
|
323
|
+
|
|
324
|
+
|Name | Type | Description | Notes|
|
|
325
|
+
|------------- | ------------- | ------------- | -------------|
|
|
326
|
+
| **projectId** | [**string**] | | defaults to undefined|
|
|
327
|
+
| **machineId** | [**string**] | | defaults to undefined|
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
### Return type
|
|
331
|
+
|
|
332
|
+
**MachineStatusDto**
|
|
333
|
+
|
|
334
|
+
### Authorization
|
|
335
|
+
|
|
336
|
+
No authorization required
|
|
337
|
+
|
|
338
|
+
### HTTP request headers
|
|
339
|
+
|
|
340
|
+
- **Content-Type**: Not defined
|
|
341
|
+
- **Accept**: application/json
|
|
342
|
+
|
|
343
|
+
|
|
167
344
|
### HTTP response details
|
|
168
345
|
| Status code | Description | Response headers |
|
|
169
346
|
|-------------|-------------|------------------|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# MachineStatusDto
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | Current status of the machine instance | [default to undefined]
|
|
9
|
+
**logs** | **string** | Logs from the machine instance execution | [default to undefined]
|
|
10
|
+
**timeStamp** | **string** | Timestamp of the status update | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { MachineStatusDto } from '@nestbox-ai/admin';
|
|
16
|
+
|
|
17
|
+
const instance: MachineStatusDto = {
|
|
18
|
+
status,
|
|
19
|
+
logs,
|
|
20
|
+
timeStamp,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|