@openshift-migration-advisor/agent-sdk 0.16.0 → 0.17.0-65f4a2a64a85

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.
Files changed (68) hide show
  1. package/.openapi-generator/FILES +8 -0
  2. package/README.md +13 -9
  3. package/dist/apis/DefaultApi.d.ts +74 -85
  4. package/dist/apis/DefaultApi.js +80 -86
  5. package/dist/esm/apis/DefaultApi.d.ts +74 -85
  6. package/dist/esm/apis/DefaultApi.js +80 -86
  7. package/dist/esm/models/BatchUpdateExclusionRequest.d.ts +38 -0
  8. package/dist/esm/models/BatchUpdateExclusionRequest.js +47 -0
  9. package/dist/esm/models/CollectorStartRequest.d.ts +12 -12
  10. package/dist/esm/models/CollectorStartRequest.js +5 -11
  11. package/dist/esm/models/Datastore.js +1 -1
  12. package/dist/esm/models/ExportInventory400Response.d.ts +32 -0
  13. package/dist/esm/models/ExportInventory400Response.js +41 -0
  14. package/dist/esm/models/ExportInventory500Response.d.ts +32 -0
  15. package/dist/esm/models/ExportInventory500Response.js +41 -0
  16. package/dist/esm/models/Host.js +3 -3
  17. package/dist/esm/models/IssuesBreakdown.d.ts +56 -0
  18. package/dist/esm/models/IssuesBreakdown.js +59 -0
  19. package/dist/esm/models/OsInfo.d.ts +16 -0
  20. package/dist/esm/models/OsInfo.js +11 -0
  21. package/dist/esm/models/VMs.d.ts +7 -0
  22. package/dist/esm/models/VMs.js +3 -0
  23. package/dist/esm/models/index.d.ts +4 -0
  24. package/dist/esm/models/index.js +4 -0
  25. package/dist/esm/runtime.d.ts +1 -0
  26. package/dist/esm/runtime.js +4 -0
  27. package/dist/models/BatchUpdateExclusionRequest.d.ts +38 -0
  28. package/dist/models/BatchUpdateExclusionRequest.js +54 -0
  29. package/dist/models/CollectorStartRequest.d.ts +12 -12
  30. package/dist/models/CollectorStartRequest.js +5 -11
  31. package/dist/models/Datastore.js +1 -1
  32. package/dist/models/ExportInventory400Response.d.ts +32 -0
  33. package/dist/models/ExportInventory400Response.js +48 -0
  34. package/dist/models/ExportInventory500Response.d.ts +32 -0
  35. package/dist/models/ExportInventory500Response.js +48 -0
  36. package/dist/models/Host.js +3 -3
  37. package/dist/models/IssuesBreakdown.d.ts +56 -0
  38. package/dist/models/IssuesBreakdown.js +66 -0
  39. package/dist/models/OsInfo.d.ts +16 -0
  40. package/dist/models/OsInfo.js +12 -0
  41. package/dist/models/VMs.d.ts +7 -0
  42. package/dist/models/VMs.js +3 -0
  43. package/dist/models/index.d.ts +4 -0
  44. package/dist/models/index.js +4 -0
  45. package/dist/runtime.d.ts +1 -0
  46. package/dist/runtime.js +5 -0
  47. package/docs/BatchUpdateExclusionRequest.md +36 -0
  48. package/docs/CollectorStartRequest.md +3 -2
  49. package/docs/DefaultApi.md +139 -139
  50. package/docs/ExportInventory400Response.md +34 -0
  51. package/docs/ExportInventory500Response.md +34 -0
  52. package/docs/IssuesBreakdown.md +42 -0
  53. package/docs/OsInfo.md +2 -0
  54. package/docs/VMs.md +2 -0
  55. package/package.json +1 -1
  56. package/src/apis/DefaultApi.ts +159 -159
  57. package/src/models/BatchUpdateExclusionRequest.ts +75 -0
  58. package/src/models/CollectorStartRequest.ts +17 -20
  59. package/src/models/Datastore.ts +1 -1
  60. package/src/models/ExportInventory400Response.ts +65 -0
  61. package/src/models/ExportInventory500Response.ts +65 -0
  62. package/src/models/Host.ts +3 -3
  63. package/src/models/IssuesBreakdown.ts +102 -0
  64. package/src/models/OsInfo.ts +21 -0
  65. package/src/models/VMs.ts +15 -0
  66. package/src/models/index.ts +4 -0
  67. package/src/runtime.ts +5 -0
  68. package/tsconfig.json +1 -1
@@ -4,11 +4,13 @@ All URIs are relative to *https://raw.githubusercontent.com/api/v1*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  |------------- | ------------- | -------------|
7
+ | [**batchUpdateVMExclusion**](DefaultApi.md#batchupdatevmexclusion) | **POST** /vms/batch-update-exclusion | Batch update VM exclusion status |
7
8
  | [**createGroup**](DefaultApi.md#creategroupoperation) | **POST** /groups | Create a new group |
8
9
  | [**deleteCredentials**](DefaultApi.md#deletecredentials) | **DELETE** /credentials | Delete stored credentials |
9
10
  | [**deleteForecasterRun**](DefaultApi.md#deleteforecasterrun) | **DELETE** /forecaster/runs/{id} | Delete a benchmark run |
10
11
  | [**deleteGroup**](DefaultApi.md#deletegroup) | **DELETE** /groups/{id} | Delete group |
11
12
  | [**deleteLabelGlobally**](DefaultApi.md#deletelabelglobally) | **DELETE** /vms/labels/{label} | Delete label from all VMs |
13
+ | [**exportInventory**](DefaultApi.md#exportinventory) | **GET** /export | Export VM inventory and migration planning data |
12
14
  | [**getAgentStatus**](DefaultApi.md#getagentstatus) | **GET** /agent | Get agent status |
13
15
  | [**getApplications**](DefaultApi.md#getapplications) | **GET** /applications | List detected applications running on VMs |
14
16
  | [**getClusterUtilization**](DefaultApi.md#getclusterutilization) | **GET** /clusters/{cluster_id}/utilization | Get latest cluster utilization by cluster ID |
@@ -23,10 +25,8 @@ All URIs are relative to *https://raw.githubusercontent.com/api/v1*
23
25
  | [**getInspectorStatus**](DefaultApi.md#getinspectorstatus) | **GET** /inspector | Get inspector status |
24
26
  | [**getInspectorVddkStatus**](DefaultApi.md#getinspectorvddkstatus) | **GET** /inspector/vddk | Get VDDK status |
25
27
  | [**getInventory**](DefaultApi.md#getinventory) | **GET** /inventory | Get collected inventory |
26
- | [**getLatestRightsizingClusters**](DefaultApi.md#getlatestrightsizingclusters) | **GET** /cluster_rightsizing | Get cluster-level utilization aggregates for the latest completed report |
27
28
  | [**getRightsizingReport**](DefaultApi.md#getrightsizingreport) | **GET** /rightsizing/{report_id} | Get a specific rightsizing report with full VM metrics |
28
29
  | [**getRightsizingReportCluster**](DefaultApi.md#getrightsizingreportcluster) | **GET** /rightsizing/{report_id}/clusters/{cluster_id} | Get utilization for a specific cluster from a specific report |
29
- | [**getRightsizingReportClusters**](DefaultApi.md#getrightsizingreportclusters) | **GET** /cluster_rightsizing/{report_id} | Get cluster-level utilization aggregates for a specific report |
30
30
  | [**getVM**](DefaultApi.md#getvm) | **GET** /vms/{id} | Get details about a vm |
31
31
  | [**getVMLabels**](DefaultApi.md#getvmlabels) | **GET** /vms/labels | Get all distinct labels in use across VMs |
32
32
  | [**getVMUtilization**](DefaultApi.md#getvmutilization) | **GET** /vms/{id}/utilization | Get utilization breakdown for a specific VM |
@@ -57,6 +57,74 @@ All URIs are relative to *https://raw.githubusercontent.com/api/v1*
57
57
 
58
58
 
59
59
 
60
+ ## batchUpdateVMExclusion
61
+
62
+ > batchUpdateVMExclusion(batchUpdateExclusionRequest)
63
+
64
+ Batch update VM exclusion status
65
+
66
+ ### Example
67
+
68
+ ```ts
69
+ import {
70
+ Configuration,
71
+ DefaultApi,
72
+ } from '@openshift-migration-advisor/agent-sdk';
73
+ import type { BatchUpdateVMExclusionRequest } from '@openshift-migration-advisor/agent-sdk';
74
+
75
+ async function example() {
76
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
77
+ const api = new DefaultApi();
78
+
79
+ const body = {
80
+ // BatchUpdateExclusionRequest
81
+ batchUpdateExclusionRequest: ...,
82
+ } satisfies BatchUpdateVMExclusionRequest;
83
+
84
+ try {
85
+ const data = await api.batchUpdateVMExclusion(body);
86
+ console.log(data);
87
+ } catch (error) {
88
+ console.error(error);
89
+ }
90
+ }
91
+
92
+ // Run the test
93
+ example().catch(console.error);
94
+ ```
95
+
96
+ ### Parameters
97
+
98
+
99
+ | Name | Type | Description | Notes |
100
+ |------------- | ------------- | ------------- | -------------|
101
+ | **batchUpdateExclusionRequest** | [BatchUpdateExclusionRequest](BatchUpdateExclusionRequest.md) | | |
102
+
103
+ ### Return type
104
+
105
+ `void` (Empty response body)
106
+
107
+ ### Authorization
108
+
109
+ No authorization required
110
+
111
+ ### HTTP request headers
112
+
113
+ - **Content-Type**: `application/json`
114
+ - **Accept**: Not defined
115
+
116
+
117
+ ### HTTP response details
118
+ | Status code | Description | Response headers |
119
+ |-------------|-------------|------------------|
120
+ | **200** | All VMs updated successfully | - |
121
+ | **400** | Invalid request | - |
122
+ | **404** | One or more VMs not found | - |
123
+ | **500** | Internal server error | - |
124
+
125
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
126
+
127
+
60
128
  ## createGroup
61
129
 
62
130
  > Group createGroup(createGroupRequest)
@@ -385,6 +453,75 @@ No authorization required
385
453
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
386
454
 
387
455
 
456
+ ## exportInventory
457
+
458
+ > Blob exportInventory(scope)
459
+
460
+ Export VM inventory and migration planning data
461
+
462
+ Exports selected data scopes as CSV files packaged in a ZIP archive. Supports flexible scope selection for offline analysis in Excel or custom tools.
463
+
464
+ ### Example
465
+
466
+ ```ts
467
+ import {
468
+ Configuration,
469
+ DefaultApi,
470
+ } from '@openshift-migration-advisor/agent-sdk';
471
+ import type { ExportInventoryRequest } from '@openshift-migration-advisor/agent-sdk';
472
+
473
+ async function example() {
474
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
475
+ const api = new DefaultApi();
476
+
477
+ const body = {
478
+ // string | Comma-separated list of scopes to export (default: overview). Available scopes: overview, hosts, clusters, datastores, vms, network, utilization, storage-forecast, applications, groups, inspection (optional)
479
+ scope: overview,hosts,vms,
480
+ } satisfies ExportInventoryRequest;
481
+
482
+ try {
483
+ const data = await api.exportInventory(body);
484
+ console.log(data);
485
+ } catch (error) {
486
+ console.error(error);
487
+ }
488
+ }
489
+
490
+ // Run the test
491
+ example().catch(console.error);
492
+ ```
493
+
494
+ ### Parameters
495
+
496
+
497
+ | Name | Type | Description | Notes |
498
+ |------------- | ------------- | ------------- | -------------|
499
+ | **scope** | `string` | Comma-separated list of scopes to export (default: overview). Available scopes: overview, hosts, clusters, datastores, vms, network, utilization, storage-forecast, applications, groups, inspection | [Optional] [Defaults to `undefined`] |
500
+
501
+ ### Return type
502
+
503
+ **Blob**
504
+
505
+ ### Authorization
506
+
507
+ No authorization required
508
+
509
+ ### HTTP request headers
510
+
511
+ - **Content-Type**: Not defined
512
+ - **Accept**: `application/zip`, `application/json`
513
+
514
+
515
+ ### HTTP response details
516
+ | Status code | Description | Response headers |
517
+ |-------------|-------------|------------------|
518
+ | **200** | ZIP archive containing CSV files for requested scopes | - |
519
+ | **400** | Invalid scope name | - |
520
+ | **500** | Internal server error | - |
521
+
522
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
523
+
524
+
388
525
  ## getAgentStatus
389
526
 
390
527
  > AgentStatus getAgentStatus()
@@ -1284,73 +1421,6 @@ No authorization required
1284
1421
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1285
1422
 
1286
1423
 
1287
- ## getLatestRightsizingClusters
1288
-
1289
- > RightsizingClusterListResponse getLatestRightsizingClusters(byExpression)
1290
-
1291
- Get cluster-level utilization aggregates for the latest completed report
1292
-
1293
- ### Example
1294
-
1295
- ```ts
1296
- import {
1297
- Configuration,
1298
- DefaultApi,
1299
- } from '@openshift-migration-advisor/agent-sdk';
1300
- import type { GetLatestRightsizingClustersRequest } from '@openshift-migration-advisor/agent-sdk';
1301
-
1302
- async function example() {
1303
- console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
1304
- const api = new DefaultApi();
1305
-
1306
- const body = {
1307
- // string | Filter DSL expression (e.g. \"cluster_id = \'domain-c123\'\"). Omit to return all clusters. (optional)
1308
- byExpression: byExpression_example,
1309
- } satisfies GetLatestRightsizingClustersRequest;
1310
-
1311
- try {
1312
- const data = await api.getLatestRightsizingClusters(body);
1313
- console.log(data);
1314
- } catch (error) {
1315
- console.error(error);
1316
- }
1317
- }
1318
-
1319
- // Run the test
1320
- example().catch(console.error);
1321
- ```
1322
-
1323
- ### Parameters
1324
-
1325
-
1326
- | Name | Type | Description | Notes |
1327
- |------------- | ------------- | ------------- | -------------|
1328
- | **byExpression** | `string` | Filter DSL expression (e.g. \"cluster_id = \'domain-c123\'\"). Omit to return all clusters. | [Optional] [Defaults to `undefined`] |
1329
-
1330
- ### Return type
1331
-
1332
- [**RightsizingClusterListResponse**](RightsizingClusterListResponse.md)
1333
-
1334
- ### Authorization
1335
-
1336
- No authorization required
1337
-
1338
- ### HTTP request headers
1339
-
1340
- - **Content-Type**: Not defined
1341
- - **Accept**: `application/json`
1342
-
1343
-
1344
- ### HTTP response details
1345
- | Status code | Description | Response headers |
1346
- |-------------|-------------|------------------|
1347
- | **200** | Cluster utilization aggregates | - |
1348
- | **404** | No completed rightsizing report found | - |
1349
- | **500** | Internal server error | - |
1350
-
1351
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1352
-
1353
-
1354
1424
  ## getRightsizingReport
1355
1425
 
1356
1426
  > RightsizingReport getRightsizingReport(reportId)
@@ -1488,76 +1558,6 @@ No authorization required
1488
1558
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1489
1559
 
1490
1560
 
1491
- ## getRightsizingReportClusters
1492
-
1493
- > RightsizingClusterListResponse getRightsizingReportClusters(reportId, byExpression)
1494
-
1495
- Get cluster-level utilization aggregates for a specific report
1496
-
1497
- ### Example
1498
-
1499
- ```ts
1500
- import {
1501
- Configuration,
1502
- DefaultApi,
1503
- } from '@openshift-migration-advisor/agent-sdk';
1504
- import type { GetRightsizingReportClustersRequest } from '@openshift-migration-advisor/agent-sdk';
1505
-
1506
- async function example() {
1507
- console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
1508
- const api = new DefaultApi();
1509
-
1510
- const body = {
1511
- // string | Rightsizing report UUID
1512
- reportId: reportId_example,
1513
- // string | Filter DSL expression (e.g. \"cluster_id = \'domain-c123\'\"). Omit to return all clusters. (optional)
1514
- byExpression: byExpression_example,
1515
- } satisfies GetRightsizingReportClustersRequest;
1516
-
1517
- try {
1518
- const data = await api.getRightsizingReportClusters(body);
1519
- console.log(data);
1520
- } catch (error) {
1521
- console.error(error);
1522
- }
1523
- }
1524
-
1525
- // Run the test
1526
- example().catch(console.error);
1527
- ```
1528
-
1529
- ### Parameters
1530
-
1531
-
1532
- | Name | Type | Description | Notes |
1533
- |------------- | ------------- | ------------- | -------------|
1534
- | **reportId** | `string` | Rightsizing report UUID | [Defaults to `undefined`] |
1535
- | **byExpression** | `string` | Filter DSL expression (e.g. \"cluster_id = \'domain-c123\'\"). Omit to return all clusters. | [Optional] [Defaults to `undefined`] |
1536
-
1537
- ### Return type
1538
-
1539
- [**RightsizingClusterListResponse**](RightsizingClusterListResponse.md)
1540
-
1541
- ### Authorization
1542
-
1543
- No authorization required
1544
-
1545
- ### HTTP request headers
1546
-
1547
- - **Content-Type**: Not defined
1548
- - **Accept**: `application/json`
1549
-
1550
-
1551
- ### HTTP response details
1552
- | Status code | Description | Response headers |
1553
- |-------------|-------------|------------------|
1554
- | **200** | Cluster utilization aggregates | - |
1555
- | **404** | Report not found | - |
1556
- | **500** | Internal server error | - |
1557
-
1558
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1559
-
1560
-
1561
1561
  ## getVM
1562
1562
 
1563
1563
  > VirtualMachineDetail getVM(id)
@@ -0,0 +1,34 @@
1
+
2
+ # ExportInventory400Response
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `error` | string
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { ExportInventory400Response } from '@openshift-migration-advisor/agent-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "error": invalid scope: unknown,
19
+ } satisfies ExportInventory400Response
20
+
21
+ console.log(example)
22
+
23
+ // Convert the instance to a JSON string
24
+ const exampleJSON: string = JSON.stringify(example)
25
+ console.log(exampleJSON)
26
+
27
+ // Parse the JSON string back to an object
28
+ const exampleParsed = JSON.parse(exampleJSON) as ExportInventory400Response
29
+ console.log(exampleParsed)
30
+ ```
31
+
32
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
33
+
34
+
@@ -0,0 +1,34 @@
1
+
2
+ # ExportInventory500Response
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `error` | string
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { ExportInventory500Response } from '@openshift-migration-advisor/agent-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "error": null,
19
+ } satisfies ExportInventory500Response
20
+
21
+ console.log(example)
22
+
23
+ // Convert the instance to a JSON string
24
+ const exampleJSON: string = JSON.stringify(example)
25
+ console.log(exampleJSON)
26
+
27
+ // Parse the JSON string back to an object
28
+ const exampleParsed = JSON.parse(exampleJSON) as ExportInventory500Response
29
+ console.log(exampleParsed)
30
+ ```
31
+
32
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
33
+
34
+
@@ -0,0 +1,42 @@
1
+
2
+ # IssuesBreakdown
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `critical` | number
10
+ `warning` | number
11
+ `information` | number
12
+ `advisory` | number
13
+ `error` | number
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { IssuesBreakdown } from '@openshift-migration-advisor/agent-sdk'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "critical": null,
23
+ "warning": null,
24
+ "information": null,
25
+ "advisory": null,
26
+ "error": null,
27
+ } satisfies IssuesBreakdown
28
+
29
+ console.log(example)
30
+
31
+ // Convert the instance to a JSON string
32
+ const exampleJSON: string = JSON.stringify(example)
33
+ console.log(exampleJSON)
34
+
35
+ // Parse the JSON string back to an object
36
+ const exampleParsed = JSON.parse(exampleJSON) as IssuesBreakdown
37
+ console.log(exampleParsed)
38
+ ```
39
+
40
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
41
+
42
+
package/docs/OsInfo.md CHANGED
@@ -8,6 +8,7 @@ Name | Type
8
8
  ------------ | -------------
9
9
  `count` | number
10
10
  `supported` | boolean
11
+ `supportTier` | string
11
12
  `upgradeRecommendation` | string
12
13
 
13
14
  ## Example
@@ -19,6 +20,7 @@ import type { OsInfo } from '@openshift-migration-advisor/agent-sdk'
19
20
  const example = {
20
21
  "count": null,
21
22
  "supported": null,
23
+ "supportTier": null,
22
24
  "upgradeRecommendation": null,
23
25
  } satisfies OsInfo
24
26
 
package/docs/VMs.md CHANGED
@@ -28,6 +28,7 @@ Name | Type
28
28
  `osInfo` | [{ [key: string]: OsInfo; }](OsInfo.md)
29
29
  `notMigratableReasons` | [Array<MigrationIssue>](MigrationIssue.md)
30
30
  `migrationWarnings` | [Array<MigrationIssue>](MigrationIssue.md)
31
+ `issuesBreakdown` | [IssuesBreakdown](IssuesBreakdown.md)
31
32
 
32
33
  ## Example
33
34
 
@@ -58,6 +59,7 @@ const example = {
58
59
  "osInfo": null,
59
60
  "notMigratableReasons": null,
60
61
  "migrationWarnings": null,
62
+ "issuesBreakdown": null,
61
63
  } satisfies VMs
62
64
 
63
65
  console.log(example)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openshift-migration-advisor/agent-sdk",
3
- "version": "0.16.0",
3
+ "version": "0.17.0-65f4a2a64a85",
4
4
  "description": "OpenAPI client for @openshift-migration-advisor/agent-sdk",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {