@openshift-migration-advisor/agent-sdk 0.8.0 → 0.12.0

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 (70) hide show
  1. package/.openapi-generator/FILES +6 -2
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +19 -17
  4. package/dist/apis/DefaultApi.d.ts +141 -133
  5. package/dist/apis/DefaultApi.js +168 -163
  6. package/dist/esm/apis/DefaultApi.d.ts +141 -133
  7. package/dist/esm/apis/DefaultApi.js +169 -164
  8. package/dist/esm/models/InspectorStatus.d.ts +20 -7
  9. package/dist/esm/models/InspectorStatus.js +12 -7
  10. package/dist/esm/models/StartInspectionRequest.d.ts +32 -0
  11. package/dist/esm/models/StartInspectionRequest.js +43 -0
  12. package/dist/esm/models/VMs.d.ts +18 -0
  13. package/dist/esm/models/VMs.js +4 -0
  14. package/dist/esm/models/VirtualMachine.d.ts +7 -1
  15. package/dist/esm/models/VirtualMachine.js +4 -4
  16. package/dist/esm/models/VirtualMachineDetail.d.ts +3 -3
  17. package/dist/esm/models/VirtualMachineDetail.js +3 -3
  18. package/dist/esm/models/VmInspectionConcern.d.ts +44 -0
  19. package/dist/esm/models/VmInspectionConcern.js +51 -0
  20. package/dist/esm/models/VmInspectionResults.d.ts +33 -0
  21. package/dist/esm/models/VmInspectionResults.js +42 -0
  22. package/dist/esm/models/VmInspectionStatus.d.ts +0 -1
  23. package/dist/esm/models/VmInspectionStatus.js +1 -2
  24. package/dist/esm/models/index.d.ts +3 -1
  25. package/dist/esm/models/index.js +3 -1
  26. package/dist/esm/runtime.js +1 -1
  27. package/dist/models/InspectorStatus.d.ts +20 -7
  28. package/dist/models/InspectorStatus.js +12 -7
  29. package/dist/models/StartInspectionRequest.d.ts +32 -0
  30. package/dist/models/StartInspectionRequest.js +50 -0
  31. package/dist/models/VMs.d.ts +18 -0
  32. package/dist/models/VMs.js +4 -0
  33. package/dist/models/VirtualMachine.d.ts +7 -1
  34. package/dist/models/VirtualMachine.js +4 -4
  35. package/dist/models/VirtualMachineDetail.d.ts +3 -3
  36. package/dist/models/VirtualMachineDetail.js +3 -3
  37. package/dist/models/VmInspectionConcern.d.ts +44 -0
  38. package/dist/models/VmInspectionConcern.js +58 -0
  39. package/dist/models/VmInspectionResults.d.ts +33 -0
  40. package/dist/models/VmInspectionResults.js +49 -0
  41. package/dist/models/VmInspectionStatus.d.ts +0 -1
  42. package/dist/models/VmInspectionStatus.js +1 -2
  43. package/dist/models/index.d.ts +3 -1
  44. package/dist/models/index.js +3 -1
  45. package/dist/runtime.js +1 -1
  46. package/docs/DefaultApi.md +191 -179
  47. package/docs/InspectorStatus.md +4 -0
  48. package/docs/{InspectorStartRequest.md → StartInspectionRequest.md} +5 -6
  49. package/docs/VMs.md +4 -0
  50. package/docs/VirtualMachine.md +4 -2
  51. package/docs/VirtualMachineDetail.md +1 -1
  52. package/docs/VmInspectionConcern.md +39 -0
  53. package/docs/VmInspectionResults.md +35 -0
  54. package/package.json +1 -1
  55. package/src/apis/DefaultApi.ts +302 -283
  56. package/src/models/InspectorStatus.ts +37 -7
  57. package/src/models/StartInspectionRequest.ts +66 -0
  58. package/src/models/VMs.ts +18 -0
  59. package/src/models/VirtualMachine.ts +11 -4
  60. package/src/models/VirtualMachineDetail.ts +11 -11
  61. package/src/models/VmInspectionConcern.ts +84 -0
  62. package/src/models/VmInspectionResults.ts +73 -0
  63. package/src/models/VmInspectionStatus.ts +1 -2
  64. package/src/models/index.ts +3 -1
  65. package/src/runtime.ts +1 -1
  66. package/dist/esm/models/InspectorStartRequest.d.ts +0 -39
  67. package/dist/esm/models/InspectorStartRequest.js +0 -48
  68. package/dist/models/InspectorStartRequest.d.ts +0 -39
  69. package/dist/models/InspectorStartRequest.js +0 -55
  70. package/src/models/InspectorStartRequest.ts +0 -83
@@ -4,36 +4,36 @@ All URIs are relative to *https://raw.githubusercontent.com/api/v1*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  |------------- | ------------- | -------------|
7
- | [**addVMsToInspection**](DefaultApi.md#addvmstoinspection) | **PATCH** /vms/inspector | Add more VMs to inspection queue |
7
+ | [**addVMToInspection**](DefaultApi.md#addvmtoinspection) | **POST** /vms/{id}/inspection | Add VirtualMachine to inspection queue |
8
8
  | [**createGroup**](DefaultApi.md#creategroupoperation) | **POST** /groups | Create a new group |
9
9
  | [**deleteGroup**](DefaultApi.md#deletegroup) | **DELETE** /groups/{id} | Delete group |
10
10
  | [**getAgentStatus**](DefaultApi.md#getagentstatus) | **GET** /agent | Get agent status |
11
11
  | [**getCollectorStatus**](DefaultApi.md#getcollectorstatus) | **GET** /collector | Get collector status |
12
12
  | [**getGroup**](DefaultApi.md#getgroup) | **GET** /groups/{id} | Get group by ID with its VMs |
13
- | [**getInspectorStatus**](DefaultApi.md#getinspectorstatus) | **GET** /vms/inspector | Get inspector status |
13
+ | [**getInspectorStatus**](DefaultApi.md#getinspectorstatus) | **GET** /inspector | Get inspector status |
14
+ | [**getInspectorVddkStatus**](DefaultApi.md#getinspectorvddkstatus) | **GET** /inspector/vddk | Get VDDK status |
14
15
  | [**getInventory**](DefaultApi.md#getinventory) | **GET** /inventory | Get collected inventory |
15
16
  | [**getVM**](DefaultApi.md#getvm) | **GET** /vms/{id} | Get details about a vm |
16
- | [**getVMInspectionStatus**](DefaultApi.md#getvminspectionstatus) | **GET** /vms/{id}/inspector | Get inspection status for a specific VirtualMachine |
17
17
  | [**getVMs**](DefaultApi.md#getvms) | **GET** /vms | Get list of VMs with filtering and pagination |
18
- | [**getVddkStatus**](DefaultApi.md#getvddkstatus) | **GET** /vddk | Get VDDK status |
19
18
  | [**getVersion**](DefaultApi.md#getversion) | **GET** /version | Get agent version information |
20
19
  | [**listGroups**](DefaultApi.md#listgroups) | **GET** /groups | List all groups |
21
- | [**removeVMFromInspection**](DefaultApi.md#removevmfrominspection) | **DELETE** /vms/{id}/inspector | Remove VirtualMachine from inspection queue |
20
+ | [**putInspectorCredentials**](DefaultApi.md#putinspectorcredentials) | **PUT** /inspector/credentials | Set or replace inspector credentials |
21
+ | [**putInspectorVddk**](DefaultApi.md#putinspectorvddk) | **PUT** /inspector/vddk | Upload VDDK tarball |
22
+ | [**removeVMFromInspection**](DefaultApi.md#removevmfrominspection) | **DELETE** /vms/{id}/inspection | Remove VirtualMachine from inspection queue |
22
23
  | [**setAgentMode**](DefaultApi.md#setagentmode) | **POST** /agent | Change agent mode |
23
24
  | [**startCollector**](DefaultApi.md#startcollector) | **POST** /collector | Start inventory collection |
24
- | [**startInspection**](DefaultApi.md#startinspection) | **POST** /vms/inspector | Start inspection for VMs |
25
+ | [**startInspection**](DefaultApi.md#startinspectionoperation) | **POST** /inspector | Start inspection for VMs |
25
26
  | [**stopCollector**](DefaultApi.md#stopcollector) | **DELETE** /collector | Stop collection |
26
- | [**stopInspection**](DefaultApi.md#stopinspection) | **DELETE** /vms/inspector | Stop inspector entirely |
27
+ | [**stopInspection**](DefaultApi.md#stopinspection) | **DELETE** /inspector | Stop inspector entirely |
27
28
  | [**updateGroup**](DefaultApi.md#updategroupoperation) | **PATCH** /groups/{id} | Update group |
28
- | [**vddkPost**](DefaultApi.md#vddkpost) | **POST** /vddk | Upload VDDK tarball |
29
29
 
30
30
 
31
31
 
32
- ## addVMsToInspection
32
+ ## addVMToInspection
33
33
 
34
- > InspectorStatus addVMsToInspection(requestBody)
34
+ > VmInspectionStatus addVMToInspection(id)
35
35
 
36
- Add more VMs to inspection queue
36
+ Add VirtualMachine to inspection queue
37
37
 
38
38
  ### Example
39
39
 
@@ -42,19 +42,19 @@ import {
42
42
  Configuration,
43
43
  DefaultApi,
44
44
  } from '@openshift-migration-advisor/agent-sdk';
45
- import type { AddVMsToInspectionRequest } from '@openshift-migration-advisor/agent-sdk';
45
+ import type { AddVMToInspectionRequest } from '@openshift-migration-advisor/agent-sdk';
46
46
 
47
47
  async function example() {
48
48
  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
49
49
  const api = new DefaultApi();
50
50
 
51
51
  const body = {
52
- // Array<string>
53
- requestBody: ["vm-1236","vm-1237"],
54
- } satisfies AddVMsToInspectionRequest;
52
+ // string
53
+ id: id_example,
54
+ } satisfies AddVMToInspectionRequest;
55
55
 
56
56
  try {
57
- const data = await api.addVMsToInspection(body);
57
+ const data = await api.addVMToInspection(body);
58
58
  console.log(data);
59
59
  } catch (error) {
60
60
  console.error(error);
@@ -70,11 +70,11 @@ example().catch(console.error);
70
70
 
71
71
  | Name | Type | Description | Notes |
72
72
  |------------- | ------------- | ------------- | -------------|
73
- | **requestBody** | `Array<string>` | | |
73
+ | **id** | `string` | | [Defaults to `undefined`] |
74
74
 
75
75
  ### Return type
76
76
 
77
- [**InspectorStatus**](InspectorStatus.md)
77
+ [**VmInspectionStatus**](VmInspectionStatus.md)
78
78
 
79
79
  ### Authorization
80
80
 
@@ -82,16 +82,17 @@ No authorization required
82
82
 
83
83
  ### HTTP request headers
84
84
 
85
- - **Content-Type**: `application/json`
85
+ - **Content-Type**: Not defined
86
86
  - **Accept**: `application/json`
87
87
 
88
88
 
89
89
  ### HTTP response details
90
90
  | Status code | Description | Response headers |
91
91
  |-------------|-------------|------------------|
92
- | **202** | VMs added to inspection queue | - |
93
- | **400** | Invalid request | - |
94
- | **404** | Inspector not running | - |
92
+ | **202** | VM added to inspection queue | - |
93
+ | **400** | Inspector not running | - |
94
+ | **404** | VirtualMachine not found | - |
95
+ | **409** | VM already in inspection queue | - |
95
96
  | **500** | Internal server error | - |
96
97
 
97
98
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
@@ -424,7 +425,7 @@ No authorization required
424
425
 
425
426
  ## getInspectorStatus
426
427
 
427
- > InspectorStatus getInspectorStatus()
428
+ > InspectorStatus getInspectorStatus(includeVddk, includeCredentials)
428
429
 
429
430
  Get inspector status
430
431
 
@@ -441,8 +442,15 @@ async function example() {
441
442
  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
442
443
  const api = new DefaultApi();
443
444
 
445
+ const body = {
446
+ // boolean | If true, include uploaded VDDK metadata (`version`, `md5`) when present. omitted if VDDK was never uploaded. (optional)
447
+ includeVddk: true,
448
+ // boolean | If true, include configured vCenter URL and username (password is never returned). omitted if was never set. (optional)
449
+ includeCredentials: true,
450
+ } satisfies GetInspectorStatusRequest;
451
+
444
452
  try {
445
- const data = await api.getInspectorStatus();
453
+ const data = await api.getInspectorStatus(body);
446
454
  console.log(data);
447
455
  } catch (error) {
448
456
  console.error(error);
@@ -455,7 +463,11 @@ example().catch(console.error);
455
463
 
456
464
  ### Parameters
457
465
 
458
- This endpoint does not need any parameter.
466
+
467
+ | Name | Type | Description | Notes |
468
+ |------------- | ------------- | ------------- | -------------|
469
+ | **includeVddk** | `boolean` | If true, include uploaded VDDK metadata (&#x60;version&#x60;, &#x60;md5&#x60;) when present. omitted if VDDK was never uploaded. | [Optional] [Defaults to `false`] |
470
+ | **includeCredentials** | `boolean` | If true, include configured vCenter URL and username (password is never returned). omitted if was never set. | [Optional] [Defaults to `false`] |
459
471
 
460
472
  ### Return type
461
473
 
@@ -480,6 +492,65 @@ No authorization required
480
492
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
481
493
 
482
494
 
495
+ ## getInspectorVddkStatus
496
+
497
+ > VddkProperties getInspectorVddkStatus()
498
+
499
+ Get VDDK status
500
+
501
+ ### Example
502
+
503
+ ```ts
504
+ import {
505
+ Configuration,
506
+ DefaultApi,
507
+ } from '@openshift-migration-advisor/agent-sdk';
508
+ import type { GetInspectorVddkStatusRequest } from '@openshift-migration-advisor/agent-sdk';
509
+
510
+ async function example() {
511
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
512
+ const api = new DefaultApi();
513
+
514
+ try {
515
+ const data = await api.getInspectorVddkStatus();
516
+ console.log(data);
517
+ } catch (error) {
518
+ console.error(error);
519
+ }
520
+ }
521
+
522
+ // Run the test
523
+ example().catch(console.error);
524
+ ```
525
+
526
+ ### Parameters
527
+
528
+ This endpoint does not need any parameter.
529
+
530
+ ### Return type
531
+
532
+ [**VddkProperties**](VddkProperties.md)
533
+
534
+ ### Authorization
535
+
536
+ No authorization required
537
+
538
+ ### HTTP request headers
539
+
540
+ - **Content-Type**: Not defined
541
+ - **Accept**: `application/json`
542
+
543
+
544
+ ### HTTP response details
545
+ | Status code | Description | Response headers |
546
+ |-------------|-------------|------------------|
547
+ | **200** | Returns the current properties of the uploaded VMware VDDK tar. If the VDDK package has not been uploaded, a 404 response is returned. | - |
548
+ | **404** | Vddk not found | - |
549
+ | **500** | Internal server error | - |
550
+
551
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
552
+
553
+
483
554
  ## getInventory
484
555
 
485
556
  > GetInventory200Response getInventory(withAgentId, groupId)
@@ -617,11 +688,11 @@ No authorization required
617
688
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
618
689
 
619
690
 
620
- ## getVMInspectionStatus
691
+ ## getVMs
621
692
 
622
- > VmInspectionStatus getVMInspectionStatus(id)
693
+ > VirtualMachineListResponse getVMs(byExpression, sort, page, pageSize)
623
694
 
624
- Get inspection status for a specific VirtualMachine
695
+ Get list of VMs with filtering and pagination
625
696
 
626
697
  ### Example
627
698
 
@@ -630,19 +701,25 @@ import {
630
701
  Configuration,
631
702
  DefaultApi,
632
703
  } from '@openshift-migration-advisor/agent-sdk';
633
- import type { GetVMInspectionStatusRequest } from '@openshift-migration-advisor/agent-sdk';
704
+ import type { GetVMsRequest } from '@openshift-migration-advisor/agent-sdk';
634
705
 
635
706
  async function example() {
636
707
  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
637
708
  const api = new DefaultApi();
638
709
 
639
710
  const body = {
640
- // string | VirtualMachine ID
641
- id: id_example,
642
- } satisfies GetVMInspectionStatusRequest;
711
+ // string | Filter by expression (matches VMs with the provided expression) (optional)
712
+ byExpression: exp1,
713
+ // Array<string> | Sort fields with direction (e.g., \"name:asc\" or \"cluster:desc,name:asc\"). Valid fields are name, vCenterState, cluster, diskSize, memory, issues. (optional)
714
+ sort: ["cluster:asc","name:desc"],
715
+ // number | Page number for pagination (optional)
716
+ page: 56,
717
+ // number | Number of items per page (optional)
718
+ pageSize: 56,
719
+ } satisfies GetVMsRequest;
643
720
 
644
721
  try {
645
- const data = await api.getVMInspectionStatus(body);
722
+ const data = await api.getVMs(body);
646
723
  console.log(data);
647
724
  } catch (error) {
648
725
  console.error(error);
@@ -658,11 +735,14 @@ example().catch(console.error);
658
735
 
659
736
  | Name | Type | Description | Notes |
660
737
  |------------- | ------------- | ------------- | -------------|
661
- | **id** | `string` | VirtualMachine ID | [Defaults to `undefined`] |
738
+ | **byExpression** | `string` | Filter by expression (matches VMs with the provided expression) | [Optional] [Defaults to `undefined`] |
739
+ | **sort** | `Array<string>` | Sort fields with direction (e.g., \&quot;name:asc\&quot; or \&quot;cluster:desc,name:asc\&quot;). Valid fields are name, vCenterState, cluster, diskSize, memory, issues. | [Optional] |
740
+ | **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
741
+ | **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `undefined`] |
662
742
 
663
743
  ### Return type
664
744
 
665
- [**VmInspectionStatus**](VmInspectionStatus.md)
745
+ [**VirtualMachineListResponse**](VirtualMachineListResponse.md)
666
746
 
667
747
  ### Authorization
668
748
 
@@ -677,18 +757,18 @@ No authorization required
677
757
  ### HTTP response details
678
758
  | Status code | Description | Response headers |
679
759
  |-------------|-------------|------------------|
680
- | **200** | VirtualMachine inspection status | - |
681
- | **404** | VirtualMachine not found | - |
760
+ | **200** | List of VMs | - |
761
+ | **400** | Invalid request parameters | - |
682
762
  | **500** | Internal server error | - |
683
763
 
684
764
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
685
765
 
686
766
 
687
- ## getVMs
767
+ ## getVersion
688
768
 
689
- > VirtualMachineListResponse getVMs(byExpression, sort, page, pageSize)
769
+ > VersionInfo getVersion()
690
770
 
691
- Get list of VMs with filtering and pagination
771
+ Get agent version information
692
772
 
693
773
  ### Example
694
774
 
@@ -697,25 +777,14 @@ import {
697
777
  Configuration,
698
778
  DefaultApi,
699
779
  } from '@openshift-migration-advisor/agent-sdk';
700
- import type { GetVMsRequest } from '@openshift-migration-advisor/agent-sdk';
780
+ import type { GetVersionRequest } from '@openshift-migration-advisor/agent-sdk';
701
781
 
702
782
  async function example() {
703
783
  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
704
784
  const api = new DefaultApi();
705
785
 
706
- const body = {
707
- // string | Filter by expression (matches VMs with the provided expression) (optional)
708
- byExpression: exp1,
709
- // Array<string> | Sort fields with direction (e.g., \"name:asc\" or \"cluster:desc,name:asc\"). Valid fields are name, vCenterState, cluster, diskSize, memory, issues. (optional)
710
- sort: ["cluster:asc","name:desc"],
711
- // number | Page number for pagination (optional)
712
- page: 56,
713
- // number | Number of items per page (optional)
714
- pageSize: 56,
715
- } satisfies GetVMsRequest;
716
-
717
786
  try {
718
- const data = await api.getVMs(body);
787
+ const data = await api.getVersion();
719
788
  console.log(data);
720
789
  } catch (error) {
721
790
  console.error(error);
@@ -728,17 +797,11 @@ example().catch(console.error);
728
797
 
729
798
  ### Parameters
730
799
 
731
-
732
- | Name | Type | Description | Notes |
733
- |------------- | ------------- | ------------- | -------------|
734
- | **byExpression** | `string` | Filter by expression (matches VMs with the provided expression) | [Optional] [Defaults to `undefined`] |
735
- | **sort** | `Array<string>` | Sort fields with direction (e.g., \&quot;name:asc\&quot; or \&quot;cluster:desc,name:asc\&quot;). Valid fields are name, vCenterState, cluster, diskSize, memory, issues. | [Optional] |
736
- | **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
737
- | **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `undefined`] |
800
+ This endpoint does not need any parameter.
738
801
 
739
802
  ### Return type
740
803
 
741
- [**VirtualMachineListResponse**](VirtualMachineListResponse.md)
804
+ [**VersionInfo**](VersionInfo.md)
742
805
 
743
806
  ### Authorization
744
807
 
@@ -753,18 +816,16 @@ No authorization required
753
816
  ### HTTP response details
754
817
  | Status code | Description | Response headers |
755
818
  |-------------|-------------|------------------|
756
- | **200** | List of VMs | - |
757
- | **400** | Invalid request parameters | - |
758
- | **500** | Internal server error | - |
819
+ | **200** | Version information | - |
759
820
 
760
821
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
761
822
 
762
823
 
763
- ## getVddkStatus
824
+ ## listGroups
764
825
 
765
- > VddkProperties getVddkStatus()
826
+ > GroupListResponse listGroups(byName, page, pageSize)
766
827
 
767
- Get VDDK status
828
+ List all groups
768
829
 
769
830
  ### Example
770
831
 
@@ -773,14 +834,23 @@ import {
773
834
  Configuration,
774
835
  DefaultApi,
775
836
  } from '@openshift-migration-advisor/agent-sdk';
776
- import type { GetVddkStatusRequest } from '@openshift-migration-advisor/agent-sdk';
837
+ import type { ListGroupsRequest } from '@openshift-migration-advisor/agent-sdk';
777
838
 
778
839
  async function example() {
779
840
  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
780
841
  const api = new DefaultApi();
781
842
 
843
+ const body = {
844
+ // string | Filter groups by name (case-insensitive substring match) (optional)
845
+ byName: byName_example,
846
+ // number | Page number (1-indexed) (optional)
847
+ page: 56,
848
+ // number | Number of groups per page (optional)
849
+ pageSize: 56,
850
+ } satisfies ListGroupsRequest;
851
+
782
852
  try {
783
- const data = await api.getVddkStatus();
853
+ const data = await api.listGroups(body);
784
854
  console.log(data);
785
855
  } catch (error) {
786
856
  console.error(error);
@@ -793,11 +863,16 @@ example().catch(console.error);
793
863
 
794
864
  ### Parameters
795
865
 
796
- This endpoint does not need any parameter.
866
+
867
+ | Name | Type | Description | Notes |
868
+ |------------- | ------------- | ------------- | -------------|
869
+ | **byName** | `string` | Filter groups by name (case-insensitive substring match) | [Optional] [Defaults to `undefined`] |
870
+ | **page** | `number` | Page number (1-indexed) | [Optional] [Defaults to `1`] |
871
+ | **pageSize** | `number` | Number of groups per page | [Optional] [Defaults to `20`] |
797
872
 
798
873
  ### Return type
799
874
 
800
- [**VddkProperties**](VddkProperties.md)
875
+ [**GroupListResponse**](GroupListResponse.md)
801
876
 
802
877
  ### Authorization
803
878
 
@@ -812,18 +887,18 @@ No authorization required
812
887
  ### HTTP response details
813
888
  | Status code | Description | Response headers |
814
889
  |-------------|-------------|------------------|
815
- | **200** | Returns the current properties of the uploaded VMware VDDK tar. If the VDDK package has not been uploaded, a 404 response is returned. | - |
816
- | **404** | Vddk not found | - |
890
+ | **200** | List of groups | - |
891
+ | **400** | Invalid filter expression | - |
817
892
  | **500** | Internal server error | - |
818
893
 
819
894
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
820
895
 
821
896
 
822
- ## getVersion
897
+ ## putInspectorCredentials
823
898
 
824
- > VersionInfo getVersion()
899
+ > putInspectorCredentials(vcenterCredentials)
825
900
 
826
- Get agent version information
901
+ Set or replace inspector credentials
827
902
 
828
903
  ### Example
829
904
 
@@ -832,14 +907,19 @@ import {
832
907
  Configuration,
833
908
  DefaultApi,
834
909
  } from '@openshift-migration-advisor/agent-sdk';
835
- import type { GetVersionRequest } from '@openshift-migration-advisor/agent-sdk';
910
+ import type { PutInspectorCredentialsRequest } from '@openshift-migration-advisor/agent-sdk';
836
911
 
837
912
  async function example() {
838
913
  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
839
914
  const api = new DefaultApi();
840
915
 
916
+ const body = {
917
+ // VcenterCredentials
918
+ vcenterCredentials: ...,
919
+ } satisfies PutInspectorCredentialsRequest;
920
+
841
921
  try {
842
- const data = await api.getVersion();
922
+ const data = await api.putInspectorCredentials(body);
843
923
  console.log(data);
844
924
  } catch (error) {
845
925
  console.error(error);
@@ -852,11 +932,14 @@ example().catch(console.error);
852
932
 
853
933
  ### Parameters
854
934
 
855
- This endpoint does not need any parameter.
935
+
936
+ | Name | Type | Description | Notes |
937
+ |------------- | ------------- | ------------- | -------------|
938
+ | **vcenterCredentials** | [VcenterCredentials](VcenterCredentials.md) | | |
856
939
 
857
940
  ### Return type
858
941
 
859
- [**VersionInfo**](VersionInfo.md)
942
+ `void` (Empty response body)
860
943
 
861
944
  ### Authorization
862
945
 
@@ -864,23 +947,25 @@ No authorization required
864
947
 
865
948
  ### HTTP request headers
866
949
 
867
- - **Content-Type**: Not defined
868
- - **Accept**: `application/json`
950
+ - **Content-Type**: `application/json`
951
+ - **Accept**: Not defined
869
952
 
870
953
 
871
954
  ### HTTP response details
872
955
  | Status code | Description | Response headers |
873
956
  |-------------|-------------|------------------|
874
- | **200** | Version information | - |
957
+ | **200** | Credentials updated successfully | - |
958
+ | **400** | Bad Credentials | - |
959
+ | **500** | Internal server error | - |
875
960
 
876
961
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
877
962
 
878
963
 
879
- ## listGroups
964
+ ## putInspectorVddk
880
965
 
881
- > GroupListResponse listGroups(byName, page, pageSize)
966
+ > VddkProperties putInspectorVddk(file)
882
967
 
883
- List all groups
968
+ Upload VDDK tarball
884
969
 
885
970
  ### Example
886
971
 
@@ -889,23 +974,19 @@ import {
889
974
  Configuration,
890
975
  DefaultApi,
891
976
  } from '@openshift-migration-advisor/agent-sdk';
892
- import type { ListGroupsRequest } from '@openshift-migration-advisor/agent-sdk';
977
+ import type { PutInspectorVddkRequest } from '@openshift-migration-advisor/agent-sdk';
893
978
 
894
979
  async function example() {
895
980
  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
896
981
  const api = new DefaultApi();
897
982
 
898
983
  const body = {
899
- // string | Filter groups by name (case-insensitive substring match) (optional)
900
- byName: byName_example,
901
- // number | Page number (1-indexed) (optional)
902
- page: 56,
903
- // number | Number of groups per page (optional)
904
- pageSize: 56,
905
- } satisfies ListGroupsRequest;
984
+ // Blob | VDDK tarball
985
+ file: BINARY_DATA_HERE,
986
+ } satisfies PutInspectorVddkRequest;
906
987
 
907
988
  try {
908
- const data = await api.listGroups(body);
989
+ const data = await api.putInspectorVddk(body);
909
990
  console.log(data);
910
991
  } catch (error) {
911
992
  console.error(error);
@@ -921,13 +1002,11 @@ example().catch(console.error);
921
1002
 
922
1003
  | Name | Type | Description | Notes |
923
1004
  |------------- | ------------- | ------------- | -------------|
924
- | **byName** | `string` | Filter groups by name (case-insensitive substring match) | [Optional] [Defaults to `undefined`] |
925
- | **page** | `number` | Page number (1-indexed) | [Optional] [Defaults to `1`] |
926
- | **pageSize** | `number` | Number of groups per page | [Optional] [Defaults to `20`] |
1005
+ | **file** | `Blob` | VDDK tarball | [Defaults to `undefined`] |
927
1006
 
928
1007
  ### Return type
929
1008
 
930
- [**GroupListResponse**](GroupListResponse.md)
1009
+ [**VddkProperties**](VddkProperties.md)
931
1010
 
932
1011
  ### Authorization
933
1012
 
@@ -935,15 +1014,17 @@ No authorization required
935
1014
 
936
1015
  ### HTTP request headers
937
1016
 
938
- - **Content-Type**: Not defined
1017
+ - **Content-Type**: `multipart/form-data`
939
1018
  - **Accept**: `application/json`
940
1019
 
941
1020
 
942
1021
  ### HTTP response details
943
1022
  | Status code | Description | Response headers |
944
1023
  |-------------|-------------|------------------|
945
- | **200** | List of groups | - |
946
- | **400** | Invalid filter expression | - |
1024
+ | **200** | Upload successful | - |
1025
+ | **409** | Conflict | - |
1026
+ | **413** | File exceeds 64MB limit | - |
1027
+ | **400** | Bad request | - |
947
1028
  | **500** | Internal server error | - |
948
1029
 
949
1030
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
@@ -1010,8 +1091,8 @@ No authorization required
1010
1091
  | Status code | Description | Response headers |
1011
1092
  |-------------|-------------|------------------|
1012
1093
  | **200** | VMs removed from queue | - |
1013
- | **400** | Invalid request | - |
1014
- | **404** | Inspector not running | - |
1094
+ | **400** | Inspector not running or VirtualMachine cannot be canceled | - |
1095
+ | **404** | VirtualMachine not found or not in the queue | - |
1015
1096
  | **500** | Internal server error | - |
1016
1097
 
1017
1098
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
@@ -1155,7 +1236,7 @@ No authorization required
1155
1236
 
1156
1237
  ## startInspection
1157
1238
 
1158
- > InspectorStatus startInspection(inspectorStartRequest)
1239
+ > InspectorStatus startInspection(startInspectionRequest)
1159
1240
 
1160
1241
  Start inspection for VMs
1161
1242
 
@@ -1166,16 +1247,16 @@ import {
1166
1247
  Configuration,
1167
1248
  DefaultApi,
1168
1249
  } from '@openshift-migration-advisor/agent-sdk';
1169
- import type { StartInspectionRequest } from '@openshift-migration-advisor/agent-sdk';
1250
+ import type { StartInspectionOperationRequest } from '@openshift-migration-advisor/agent-sdk';
1170
1251
 
1171
1252
  async function example() {
1172
1253
  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
1173
1254
  const api = new DefaultApi();
1174
1255
 
1175
1256
  const body = {
1176
- // InspectorStartRequest
1177
- inspectorStartRequest: ...,
1178
- } satisfies StartInspectionRequest;
1257
+ // StartInspectionRequest
1258
+ startInspectionRequest: ...,
1259
+ } satisfies StartInspectionOperationRequest;
1179
1260
 
1180
1261
  try {
1181
1262
  const data = await api.startInspection(body);
@@ -1194,7 +1275,7 @@ example().catch(console.error);
1194
1275
 
1195
1276
  | Name | Type | Description | Notes |
1196
1277
  |------------- | ------------- | ------------- | -------------|
1197
- | **inspectorStartRequest** | [InspectorStartRequest](InspectorStartRequest.md) | | |
1278
+ | **startInspectionRequest** | [StartInspectionRequest](StartInspectionRequest.md) | | |
1198
1279
 
1199
1280
  ### Return type
1200
1281
 
@@ -1409,72 +1490,3 @@ No authorization required
1409
1490
 
1410
1491
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1411
1492
 
1412
-
1413
- ## vddkPost
1414
-
1415
- > VddkProperties vddkPost(file)
1416
-
1417
- Upload VDDK tarball
1418
-
1419
- ### Example
1420
-
1421
- ```ts
1422
- import {
1423
- Configuration,
1424
- DefaultApi,
1425
- } from '@openshift-migration-advisor/agent-sdk';
1426
- import type { VddkPostRequest } from '@openshift-migration-advisor/agent-sdk';
1427
-
1428
- async function example() {
1429
- console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
1430
- const api = new DefaultApi();
1431
-
1432
- const body = {
1433
- // Blob | VDDK tarball
1434
- file: BINARY_DATA_HERE,
1435
- } satisfies VddkPostRequest;
1436
-
1437
- try {
1438
- const data = await api.vddkPost(body);
1439
- console.log(data);
1440
- } catch (error) {
1441
- console.error(error);
1442
- }
1443
- }
1444
-
1445
- // Run the test
1446
- example().catch(console.error);
1447
- ```
1448
-
1449
- ### Parameters
1450
-
1451
-
1452
- | Name | Type | Description | Notes |
1453
- |------------- | ------------- | ------------- | -------------|
1454
- | **file** | `Blob` | VDDK tarball | [Defaults to `undefined`] |
1455
-
1456
- ### Return type
1457
-
1458
- [**VddkProperties**](VddkProperties.md)
1459
-
1460
- ### Authorization
1461
-
1462
- No authorization required
1463
-
1464
- ### HTTP request headers
1465
-
1466
- - **Content-Type**: `multipart/form-data`
1467
- - **Accept**: `application/json`
1468
-
1469
-
1470
- ### HTTP response details
1471
- | Status code | Description | Response headers |
1472
- |-------------|-------------|------------------|
1473
- | **200** | Upload successful | - |
1474
- | **409** | Conflict | - |
1475
- | **413** | File exceeds 64MB limit | - |
1476
- | **400** | Bad request | - |
1477
- | **500** | Internal server error | - |
1478
-
1479
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1480
-