@openshift-migration-advisor/planner-sdk 0.20.3 → 0.21.0-9bf9457f0ee9
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 +22 -0
- package/README.md +15 -2
- package/dist/apis/AccountApi.js +1 -1
- package/dist/apis/AssessmentApi.d.ts +81 -0
- package/dist/apis/AssessmentApi.js +84 -0
- package/dist/esm/apis/AccountApi.js +1 -1
- package/dist/esm/apis/AssessmentApi.d.ts +81 -0
- package/dist/esm/apis/AssessmentApi.js +84 -0
- package/dist/esm/models/ActiveEnvironmentsInput.d.ts +41 -0
- package/dist/esm/models/ActiveEnvironmentsInput.js +51 -0
- package/dist/esm/models/Agent.js +6 -5
- package/dist/esm/models/AriaAutomationInput.d.ts +51 -0
- package/dist/esm/models/AriaAutomationInput.js +61 -0
- package/dist/esm/models/AriaOpsInput.d.ts +49 -0
- package/dist/esm/models/AriaOpsInput.js +59 -0
- package/dist/esm/models/AriaSecureInput.d.ts +41 -0
- package/dist/esm/models/AriaSecureInput.js +51 -0
- package/dist/esm/models/Assessment.js +5 -4
- package/dist/esm/models/AssessmentSubsetInventory.js +3 -2
- package/dist/esm/models/ClusterFeatures.d.ts +2 -2
- package/dist/esm/models/ClusterFeatures.js +3 -3
- package/dist/esm/models/ClusterRequirementsRequest.js +1 -1
- package/dist/esm/models/ClusterRequirementsStoredInput.js +3 -3
- package/dist/esm/models/CpuOverCommitRatio.js +1 -1
- package/dist/esm/models/CustomerDetailsInput.d.ts +34 -0
- package/dist/esm/models/CustomerDetailsInput.js +43 -0
- package/dist/esm/models/DeployedEnvironmentInput.d.ts +40 -0
- package/dist/esm/models/DeployedEnvironmentInput.js +50 -0
- package/dist/esm/models/EnhancementData.d.ts +76 -0
- package/dist/esm/models/EnhancementData.js +69 -0
- package/dist/esm/models/Group.js +6 -5
- package/dist/esm/models/GroupCreate.js +1 -1
- package/dist/esm/models/Host.d.ts +8 -0
- package/dist/esm/models/Host.js +4 -0
- package/dist/esm/models/Identity.js +1 -1
- package/dist/esm/models/Infra.d.ts +4 -0
- package/dist/esm/models/Infra.js +2 -0
- package/dist/esm/models/Inventory.d.ts +4 -0
- package/dist/esm/models/Inventory.js +3 -1
- package/dist/esm/models/JobStatus.js +1 -1
- package/dist/esm/models/Member.js +5 -4
- package/dist/esm/models/MemoryOverCommitRatio.js +1 -1
- package/dist/esm/models/Network.js +1 -1
- package/dist/esm/models/NsxInput.d.ts +46 -0
- package/dist/esm/models/NsxInput.js +56 -0
- package/dist/esm/models/OptimizationStatus.js +1 -1
- package/dist/esm/models/OsInfo.js +1 -1
- package/dist/esm/models/PartnerRequest.js +7 -6
- package/dist/esm/models/PartnerRequestStatus.js +1 -1
- package/dist/esm/models/PresignedUrl.js +3 -2
- package/dist/esm/models/Snapshot.js +3 -2
- package/dist/esm/models/Source.js +6 -5
- package/dist/esm/models/SourceCreate.js +1 -1
- package/dist/esm/models/SourceUpdate.js +1 -1
- package/dist/esm/models/StandaloneClusterRequirementsRequest.js +1 -1
- package/dist/esm/models/StorageIoConfiguration.js +1 -1
- package/dist/esm/models/VMwareSubscriptionInput.d.ts +42 -0
- package/dist/esm/models/VMwareSubscriptionInput.js +52 -0
- package/dist/esm/models/VMwareVersionCountsInput.d.ts +42 -0
- package/dist/esm/models/VMwareVersionCountsInput.js +47 -0
- package/dist/esm/models/VsphereCoreInput.d.ts +38 -0
- package/dist/esm/models/VsphereCoreInput.js +45 -0
- package/dist/esm/models/index.d.ts +11 -0
- package/dist/esm/models/index.js +11 -0
- package/dist/esm/runtime.d.ts +11 -0
- package/dist/esm/runtime.js +47 -1
- package/dist/models/ActiveEnvironmentsInput.d.ts +41 -0
- package/dist/models/ActiveEnvironmentsInput.js +59 -0
- package/dist/models/Agent.js +6 -5
- package/dist/models/AriaAutomationInput.d.ts +51 -0
- package/dist/models/AriaAutomationInput.js +69 -0
- package/dist/models/AriaOpsInput.d.ts +49 -0
- package/dist/models/AriaOpsInput.js +67 -0
- package/dist/models/AriaSecureInput.d.ts +41 -0
- package/dist/models/AriaSecureInput.js +59 -0
- package/dist/models/Assessment.js +5 -4
- package/dist/models/AssessmentSubsetInventory.js +3 -2
- package/dist/models/ClusterFeatures.d.ts +2 -2
- package/dist/models/ClusterFeatures.js +3 -3
- package/dist/models/ClusterRequirementsRequest.js +1 -1
- package/dist/models/ClusterRequirementsStoredInput.js +3 -3
- package/dist/models/CpuOverCommitRatio.js +1 -1
- package/dist/models/CustomerDetailsInput.d.ts +34 -0
- package/dist/models/CustomerDetailsInput.js +50 -0
- package/dist/models/DeployedEnvironmentInput.d.ts +40 -0
- package/dist/models/DeployedEnvironmentInput.js +58 -0
- package/dist/models/EnhancementData.d.ts +76 -0
- package/dist/models/EnhancementData.js +76 -0
- package/dist/models/Group.js +6 -5
- package/dist/models/GroupCreate.js +1 -1
- package/dist/models/Host.d.ts +8 -0
- package/dist/models/Host.js +4 -0
- package/dist/models/Identity.js +1 -1
- package/dist/models/Infra.d.ts +4 -0
- package/dist/models/Infra.js +2 -0
- package/dist/models/Inventory.d.ts +4 -0
- package/dist/models/Inventory.js +2 -0
- package/dist/models/JobStatus.js +1 -1
- package/dist/models/Member.js +5 -4
- package/dist/models/MemoryOverCommitRatio.js +1 -1
- package/dist/models/Network.js +1 -1
- package/dist/models/NsxInput.d.ts +46 -0
- package/dist/models/NsxInput.js +64 -0
- package/dist/models/OptimizationStatus.js +1 -1
- package/dist/models/OsInfo.js +1 -1
- package/dist/models/PartnerRequest.js +7 -6
- package/dist/models/PartnerRequestStatus.js +1 -1
- package/dist/models/PresignedUrl.js +3 -2
- package/dist/models/Snapshot.js +3 -2
- package/dist/models/Source.js +6 -5
- package/dist/models/SourceCreate.js +1 -1
- package/dist/models/SourceUpdate.js +1 -1
- package/dist/models/StandaloneClusterRequirementsRequest.js +1 -1
- package/dist/models/StorageIoConfiguration.js +1 -1
- package/dist/models/VMwareSubscriptionInput.d.ts +42 -0
- package/dist/models/VMwareSubscriptionInput.js +60 -0
- package/dist/models/VMwareVersionCountsInput.d.ts +42 -0
- package/dist/models/VMwareVersionCountsInput.js +54 -0
- package/dist/models/VsphereCoreInput.d.ts +38 -0
- package/dist/models/VsphereCoreInput.js +52 -0
- package/dist/models/index.d.ts +11 -0
- package/dist/models/index.js +11 -0
- package/dist/runtime.d.ts +11 -0
- package/dist/runtime.js +51 -1
- package/docs/ActiveEnvironmentsInput.md +34 -0
- package/docs/AriaAutomationInput.md +34 -0
- package/docs/AriaOpsInput.md +34 -0
- package/docs/AriaSecureInput.md +34 -0
- package/docs/AssessmentApi.md +148 -0
- package/docs/ClusterFeatures.md +2 -2
- package/docs/CustomerDetailsInput.md +36 -0
- package/docs/DeployedEnvironmentInput.md +34 -0
- package/docs/EnhancementData.md +53 -0
- package/docs/Host.md +4 -0
- package/docs/Infra.md +2 -0
- package/docs/Inventory.md +2 -0
- package/docs/NsxInput.md +34 -0
- package/docs/VMwareSubscriptionInput.md +34 -0
- package/docs/VMwareVersionCountsInput.md +40 -0
- package/docs/VsphereCoreInput.md +38 -0
- package/package.json +1 -1
- package/src/apis/AccountApi.ts +1 -1
- package/src/apis/AssessmentApi.ts +169 -0
- package/src/models/ActiveEnvironmentsInput.ts +77 -0
- package/src/models/Agent.ts +6 -6
- package/src/models/AriaAutomationInput.ts +87 -0
- package/src/models/AriaOpsInput.ts +85 -0
- package/src/models/AriaSecureInput.ts +77 -0
- package/src/models/Assessment.ts +5 -5
- package/src/models/AssessmentSubsetInventory.ts +3 -3
- package/src/models/ClusterFeatures.ts +5 -5
- package/src/models/ClusterRequirementsRequest.ts +1 -1
- package/src/models/ClusterRequirementsStoredInput.ts +3 -3
- package/src/models/CpuOverCommitRatio.ts +1 -1
- package/src/models/CustomerDetailsInput.ts +69 -0
- package/src/models/DeployedEnvironmentInput.ts +76 -0
- package/src/models/EnhancementData.ts +188 -0
- package/src/models/Group.ts +6 -6
- package/src/models/GroupCreate.ts +1 -1
- package/src/models/Host.ts +12 -0
- package/src/models/Identity.ts +1 -1
- package/src/models/Infra.ts +6 -0
- package/src/models/Inventory.ts +7 -1
- package/src/models/JobStatus.ts +1 -1
- package/src/models/Member.ts +5 -5
- package/src/models/MemoryOverCommitRatio.ts +1 -1
- package/src/models/Network.ts +1 -1
- package/src/models/NsxInput.ts +82 -0
- package/src/models/OptimizationStatus.ts +1 -1
- package/src/models/OsInfo.ts +1 -1
- package/src/models/PartnerRequest.ts +7 -7
- package/src/models/PartnerRequestStatus.ts +1 -1
- package/src/models/PresignedUrl.ts +3 -3
- package/src/models/Snapshot.ts +3 -3
- package/src/models/Source.ts +6 -6
- package/src/models/SourceCreate.ts +1 -1
- package/src/models/SourceUpdate.ts +1 -1
- package/src/models/StandaloneClusterRequirementsRequest.ts +1 -1
- package/src/models/StorageIoConfiguration.ts +1 -1
- package/src/models/VMwareSubscriptionInput.ts +78 -0
- package/src/models/VMwareVersionCountsInput.ts +81 -0
- package/src/models/VsphereCoreInput.ts +75 -0
- package/src/models/index.ts +11 -0
- package/src/runtime.ts +52 -1
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# ActiveEnvironmentsInput
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`environments` | Set<string>
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { ActiveEnvironmentsInput } from '@openshift-migration-advisor/planner-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"environments": null,
|
|
19
|
+
} satisfies ActiveEnvironmentsInput
|
|
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 ActiveEnvironmentsInput
|
|
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
|
+
# AriaAutomationInput
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`features` | Set<string>
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { AriaAutomationInput } from '@openshift-migration-advisor/planner-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"features": null,
|
|
19
|
+
} satisfies AriaAutomationInput
|
|
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 AriaAutomationInput
|
|
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
|
+
# AriaOpsInput
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`features` | Set<string>
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { AriaOpsInput } from '@openshift-migration-advisor/planner-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"features": null,
|
|
19
|
+
} satisfies AriaOpsInput
|
|
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 AriaOpsInput
|
|
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
|
+
# AriaSecureInput
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`features` | Set<string>
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { AriaSecureInput } from '@openshift-migration-advisor/planner-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"features": null,
|
|
19
|
+
} satisfies AriaSecureInput
|
|
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 AriaSecureInput
|
|
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
|
+
|
package/docs/AssessmentApi.md
CHANGED
|
@@ -12,7 +12,9 @@ All URIs are relative to *https://raw.githubusercontent.com*
|
|
|
12
12
|
| [**deleteAssessment**](AssessmentApi.md#deleteassessment) | **DELETE** /api/v1/assessments/{id} | |
|
|
13
13
|
| [**getAssessment**](AssessmentApi.md#getassessment) | **GET** /api/v1/assessments/{id} | |
|
|
14
14
|
| [**getAssessmentClusterRequirementsStoredInput**](AssessmentApi.md#getassessmentclusterrequirementsstoredinput) | **GET** /api/v1/assessments/{id}/cluster-requirements/stored-input | |
|
|
15
|
+
| [**getAssessmentEnhancementData**](AssessmentApi.md#getassessmentenhancementdata) | **GET** /api/v1/assessments/{id}/enhancement-data | |
|
|
15
16
|
| [**listAssessments**](AssessmentApi.md#listassessments) | **GET** /api/v1/assessments | |
|
|
17
|
+
| [**saveAssessmentEnhancementData**](AssessmentApi.md#saveassessmentenhancementdata) | **POST** /api/v1/assessments/{id}/enhancement-data | |
|
|
16
18
|
| [**shareAssessment**](AssessmentApi.md#shareassessment) | **POST** /api/v1/assessments/{id}/share | |
|
|
17
19
|
| [**unshareAssessment**](AssessmentApi.md#unshareassessment) | **DELETE** /api/v1/assessments/{id}/share | |
|
|
18
20
|
| [**updateAssessment**](AssessmentApi.md#updateassessment) | **PUT** /api/v1/assessments/{id} | |
|
|
@@ -609,6 +611,77 @@ No authorization required
|
|
|
609
611
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
610
612
|
|
|
611
613
|
|
|
614
|
+
## getAssessmentEnhancementData
|
|
615
|
+
|
|
616
|
+
> EnhancementData getAssessmentEnhancementData(id)
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
Get stored enhancement data for an assessment
|
|
621
|
+
|
|
622
|
+
### Example
|
|
623
|
+
|
|
624
|
+
```ts
|
|
625
|
+
import {
|
|
626
|
+
Configuration,
|
|
627
|
+
AssessmentApi,
|
|
628
|
+
} from '@openshift-migration-advisor/planner-sdk';
|
|
629
|
+
import type { GetAssessmentEnhancementDataRequest } from '@openshift-migration-advisor/planner-sdk';
|
|
630
|
+
|
|
631
|
+
async function example() {
|
|
632
|
+
console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
|
|
633
|
+
const api = new AssessmentApi();
|
|
634
|
+
|
|
635
|
+
const body = {
|
|
636
|
+
// string | ID of the assessment
|
|
637
|
+
id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
638
|
+
} satisfies GetAssessmentEnhancementDataRequest;
|
|
639
|
+
|
|
640
|
+
try {
|
|
641
|
+
const data = await api.getAssessmentEnhancementData(body);
|
|
642
|
+
console.log(data);
|
|
643
|
+
} catch (error) {
|
|
644
|
+
console.error(error);
|
|
645
|
+
}
|
|
646
|
+
}
|
|
647
|
+
|
|
648
|
+
// Run the test
|
|
649
|
+
example().catch(console.error);
|
|
650
|
+
```
|
|
651
|
+
|
|
652
|
+
### Parameters
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
| Name | Type | Description | Notes |
|
|
656
|
+
|------------- | ------------- | ------------- | -------------|
|
|
657
|
+
| **id** | `string` | ID of the assessment | [Defaults to `undefined`] |
|
|
658
|
+
|
|
659
|
+
### Return type
|
|
660
|
+
|
|
661
|
+
[**EnhancementData**](EnhancementData.md)
|
|
662
|
+
|
|
663
|
+
### Authorization
|
|
664
|
+
|
|
665
|
+
No authorization required
|
|
666
|
+
|
|
667
|
+
### HTTP request headers
|
|
668
|
+
|
|
669
|
+
- **Content-Type**: Not defined
|
|
670
|
+
- **Accept**: `application/json`
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
### HTTP response details
|
|
674
|
+
| Status code | Description | Response headers |
|
|
675
|
+
|-------------|-------------|------------------|
|
|
676
|
+
| **200** | User inputs found | - |
|
|
677
|
+
| **401** | Unauthorized | - |
|
|
678
|
+
| **403** | Forbidden | - |
|
|
679
|
+
| **404** | Assessment not found | - |
|
|
680
|
+
| **500** | Internal error | - |
|
|
681
|
+
|
|
682
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
683
|
+
|
|
684
|
+
|
|
612
685
|
## listAssessments
|
|
613
686
|
|
|
614
687
|
> Array<Assessment> listAssessments(sourceId)
|
|
@@ -678,6 +751,81 @@ No authorization required
|
|
|
678
751
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
679
752
|
|
|
680
753
|
|
|
754
|
+
## saveAssessmentEnhancementData
|
|
755
|
+
|
|
756
|
+
> EnhancementData saveAssessmentEnhancementData(id, enhancementData)
|
|
757
|
+
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
Save enhancement data for an assessment
|
|
761
|
+
|
|
762
|
+
### Example
|
|
763
|
+
|
|
764
|
+
```ts
|
|
765
|
+
import {
|
|
766
|
+
Configuration,
|
|
767
|
+
AssessmentApi,
|
|
768
|
+
} from '@openshift-migration-advisor/planner-sdk';
|
|
769
|
+
import type { SaveAssessmentEnhancementDataRequest } from '@openshift-migration-advisor/planner-sdk';
|
|
770
|
+
|
|
771
|
+
async function example() {
|
|
772
|
+
console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
|
|
773
|
+
const api = new AssessmentApi();
|
|
774
|
+
|
|
775
|
+
const body = {
|
|
776
|
+
// string | ID of the assessment
|
|
777
|
+
id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
778
|
+
// EnhancementData
|
|
779
|
+
enhancementData: ...,
|
|
780
|
+
} satisfies SaveAssessmentEnhancementDataRequest;
|
|
781
|
+
|
|
782
|
+
try {
|
|
783
|
+
const data = await api.saveAssessmentEnhancementData(body);
|
|
784
|
+
console.log(data);
|
|
785
|
+
} catch (error) {
|
|
786
|
+
console.error(error);
|
|
787
|
+
}
|
|
788
|
+
}
|
|
789
|
+
|
|
790
|
+
// Run the test
|
|
791
|
+
example().catch(console.error);
|
|
792
|
+
```
|
|
793
|
+
|
|
794
|
+
### Parameters
|
|
795
|
+
|
|
796
|
+
|
|
797
|
+
| Name | Type | Description | Notes |
|
|
798
|
+
|------------- | ------------- | ------------- | -------------|
|
|
799
|
+
| **id** | `string` | ID of the assessment | [Defaults to `undefined`] |
|
|
800
|
+
| **enhancementData** | [EnhancementData](EnhancementData.md) | | |
|
|
801
|
+
|
|
802
|
+
### Return type
|
|
803
|
+
|
|
804
|
+
[**EnhancementData**](EnhancementData.md)
|
|
805
|
+
|
|
806
|
+
### Authorization
|
|
807
|
+
|
|
808
|
+
No authorization required
|
|
809
|
+
|
|
810
|
+
### HTTP request headers
|
|
811
|
+
|
|
812
|
+
- **Content-Type**: `application/json`
|
|
813
|
+
- **Accept**: `application/json`
|
|
814
|
+
|
|
815
|
+
|
|
816
|
+
### HTTP response details
|
|
817
|
+
| Status code | Description | Response headers |
|
|
818
|
+
|-------------|-------------|------------------|
|
|
819
|
+
| **200** | User inputs saved successfully | - |
|
|
820
|
+
| **400** | Bad Request | - |
|
|
821
|
+
| **401** | Unauthorized | - |
|
|
822
|
+
| **403** | Forbidden | - |
|
|
823
|
+
| **404** | Assessment not found | - |
|
|
824
|
+
| **500** | Internal error | - |
|
|
825
|
+
|
|
826
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
827
|
+
|
|
828
|
+
|
|
681
829
|
## shareAssessment
|
|
682
830
|
|
|
683
831
|
> Status shareAssessment(id)
|
package/docs/ClusterFeatures.md
CHANGED
|
@@ -8,7 +8,7 @@ Name | Type
|
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`drsEnabled` | boolean
|
|
10
10
|
`drsMode` | string
|
|
11
|
-
`
|
|
11
|
+
`haEnabled` | boolean
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -19,7 +19,7 @@ import type { ClusterFeatures } from '@openshift-migration-advisor/planner-sdk'
|
|
|
19
19
|
const example = {
|
|
20
20
|
"drsEnabled": null,
|
|
21
21
|
"drsMode": null,
|
|
22
|
-
"
|
|
22
|
+
"haEnabled": null,
|
|
23
23
|
} satisfies ClusterFeatures
|
|
24
24
|
|
|
25
25
|
console.log(example)
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# CustomerDetailsInput
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`physicalLocationsCount` | number
|
|
10
|
+
`targetHardware` | string
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { CustomerDetailsInput } from '@openshift-migration-advisor/planner-sdk'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"physicalLocationsCount": null,
|
|
20
|
+
"targetHardware": null,
|
|
21
|
+
} satisfies CustomerDetailsInput
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as CustomerDetailsInput
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# DeployedEnvironmentInput
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`environment` | string
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { DeployedEnvironmentInput } from '@openshift-migration-advisor/planner-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"environment": null,
|
|
19
|
+
} satisfies DeployedEnvironmentInput
|
|
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 DeployedEnvironmentInput
|
|
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,53 @@
|
|
|
1
|
+
|
|
2
|
+
# EnhancementData
|
|
3
|
+
|
|
4
|
+
VMA enhancement data — fields that cannot be auto-collected by Agent or RVTools
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`deployedEnvironment` | [DeployedEnvironmentInput](DeployedEnvironmentInput.md)
|
|
11
|
+
`vmwareVersionCounts` | [VMwareVersionCountsInput](VMwareVersionCountsInput.md)
|
|
12
|
+
`activeEnvironments` | [ActiveEnvironmentsInput](ActiveEnvironmentsInput.md)
|
|
13
|
+
`vmwareSubscription` | [VMwareSubscriptionInput](VMwareSubscriptionInput.md)
|
|
14
|
+
`vsphereCore` | [VsphereCoreInput](VsphereCoreInput.md)
|
|
15
|
+
`nsx` | [NsxInput](NsxInput.md)
|
|
16
|
+
`ariaOps` | [AriaOpsInput](AriaOpsInput.md)
|
|
17
|
+
`ariaAutomation` | [AriaAutomationInput](AriaAutomationInput.md)
|
|
18
|
+
`ariaSecure` | [AriaSecureInput](AriaSecureInput.md)
|
|
19
|
+
`customerDetails` | [CustomerDetailsInput](CustomerDetailsInput.md)
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import type { EnhancementData } from '@openshift-migration-advisor/planner-sdk'
|
|
25
|
+
|
|
26
|
+
// TODO: Update the object below with actual values
|
|
27
|
+
const example = {
|
|
28
|
+
"deployedEnvironment": null,
|
|
29
|
+
"vmwareVersionCounts": null,
|
|
30
|
+
"activeEnvironments": null,
|
|
31
|
+
"vmwareSubscription": null,
|
|
32
|
+
"vsphereCore": null,
|
|
33
|
+
"nsx": null,
|
|
34
|
+
"ariaOps": null,
|
|
35
|
+
"ariaAutomation": null,
|
|
36
|
+
"ariaSecure": null,
|
|
37
|
+
"customerDetails": null,
|
|
38
|
+
} satisfies EnhancementData
|
|
39
|
+
|
|
40
|
+
console.log(example)
|
|
41
|
+
|
|
42
|
+
// Convert the instance to a JSON string
|
|
43
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
44
|
+
console.log(exampleJSON)
|
|
45
|
+
|
|
46
|
+
// Parse the JSON string back to an object
|
|
47
|
+
const exampleParsed = JSON.parse(exampleJSON) as EnhancementData
|
|
48
|
+
console.log(exampleParsed)
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
52
|
+
|
|
53
|
+
|
package/docs/Host.md
CHANGED
|
@@ -12,6 +12,8 @@ Name | Type
|
|
|
12
12
|
`cpuCores` | number
|
|
13
13
|
`cpuSockets` | number
|
|
14
14
|
`memoryMB` | number
|
|
15
|
+
`vmotionSupported` | boolean
|
|
16
|
+
`storageVmotionSupported` | boolean
|
|
15
17
|
|
|
16
18
|
## Example
|
|
17
19
|
|
|
@@ -26,6 +28,8 @@ const example = {
|
|
|
26
28
|
"cpuCores": null,
|
|
27
29
|
"cpuSockets": null,
|
|
28
30
|
"memoryMB": null,
|
|
31
|
+
"vmotionSupported": null,
|
|
32
|
+
"storageVmotionSupported": null,
|
|
29
33
|
} satisfies Host
|
|
30
34
|
|
|
31
35
|
console.log(example)
|
package/docs/Infra.md
CHANGED
|
@@ -12,6 +12,7 @@ Name | Type
|
|
|
12
12
|
`clustersPerDatacenter` | Array<number>
|
|
13
13
|
`cpuOverCommitment` | number
|
|
14
14
|
`memoryOverCommitment` | number
|
|
15
|
+
`vmsPerHostAverage` | number
|
|
15
16
|
`hosts` | [Array<Host>](Host.md)
|
|
16
17
|
`hostsPerCluster` | Array<number>
|
|
17
18
|
`vmsPerCluster` | Array<number>
|
|
@@ -32,6 +33,7 @@ const example = {
|
|
|
32
33
|
"clustersPerDatacenter": null,
|
|
33
34
|
"cpuOverCommitment": null,
|
|
34
35
|
"memoryOverCommitment": null,
|
|
36
|
+
"vmsPerHostAverage": null,
|
|
35
37
|
"hosts": null,
|
|
36
38
|
"hostsPerCluster": null,
|
|
37
39
|
"vmsPerCluster": null,
|
package/docs/Inventory.md
CHANGED
|
@@ -10,6 +10,7 @@ Name | Type
|
|
|
10
10
|
`vcenterVersion` | string
|
|
11
11
|
`clusters` | [{ [key: string]: InventoryData; }](InventoryData.md)
|
|
12
12
|
`vcenter` | [InventoryData](InventoryData.md)
|
|
13
|
+
`createdAt` | Date
|
|
13
14
|
|
|
14
15
|
## Example
|
|
15
16
|
|
|
@@ -22,6 +23,7 @@ const example = {
|
|
|
22
23
|
"vcenterVersion": null,
|
|
23
24
|
"clusters": null,
|
|
24
25
|
"vcenter": null,
|
|
26
|
+
"createdAt": null,
|
|
25
27
|
} satisfies Inventory
|
|
26
28
|
|
|
27
29
|
console.log(example)
|
package/docs/NsxInput.md
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# NsxInput
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`features` | Set<string>
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { NsxInput } from '@openshift-migration-advisor/planner-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"features": null,
|
|
19
|
+
} satisfies NsxInput
|
|
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 NsxInput
|
|
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
|
+
# VMwareSubscriptionInput
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`level` | Set<string>
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { VMwareSubscriptionInput } from '@openshift-migration-advisor/planner-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"level": null,
|
|
19
|
+
} satisfies VMwareSubscriptionInput
|
|
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 VMwareSubscriptionInput
|
|
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,40 @@
|
|
|
1
|
+
|
|
2
|
+
# VMwareVersionCountsInput
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`perpetualLicensesCount` | number
|
|
10
|
+
`coresLicensingCount` | number
|
|
11
|
+
`environmentCount` | number
|
|
12
|
+
`otherNodesCount` | number
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { VMwareVersionCountsInput } from '@openshift-migration-advisor/planner-sdk'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"perpetualLicensesCount": null,
|
|
22
|
+
"coresLicensingCount": null,
|
|
23
|
+
"environmentCount": null,
|
|
24
|
+
"otherNodesCount": null,
|
|
25
|
+
} satisfies VMwareVersionCountsInput
|
|
26
|
+
|
|
27
|
+
console.log(example)
|
|
28
|
+
|
|
29
|
+
// Convert the instance to a JSON string
|
|
30
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
31
|
+
console.log(exampleJSON)
|
|
32
|
+
|
|
33
|
+
// Parse the JSON string back to an object
|
|
34
|
+
const exampleParsed = JSON.parse(exampleJSON) as VMwareVersionCountsInput
|
|
35
|
+
console.log(exampleParsed)
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
39
|
+
|
|
40
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# VsphereCoreInput
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`vmEncryptionEnabled` | boolean
|
|
10
|
+
`vmEncryptionPolicy` | string
|
|
11
|
+
`srmEnabled` | boolean
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { VsphereCoreInput } from '@openshift-migration-advisor/planner-sdk'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"vmEncryptionEnabled": null,
|
|
21
|
+
"vmEncryptionPolicy": null,
|
|
22
|
+
"srmEnabled": null,
|
|
23
|
+
} satisfies VsphereCoreInput
|
|
24
|
+
|
|
25
|
+
console.log(example)
|
|
26
|
+
|
|
27
|
+
// Convert the instance to a JSON string
|
|
28
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
29
|
+
console.log(exampleJSON)
|
|
30
|
+
|
|
31
|
+
// Parse the JSON string back to an object
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as VsphereCoreInput
|
|
33
|
+
console.log(exampleParsed)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
37
|
+
|
|
38
|
+
|
package/package.json
CHANGED
package/src/apis/AccountApi.ts
CHANGED
|
@@ -886,6 +886,6 @@ export class AccountApi extends runtime.BaseAPI implements AccountApiInterface {
|
|
|
886
886
|
*/
|
|
887
887
|
export const ListGroupsKindEnum = {
|
|
888
888
|
Partner: 'partner',
|
|
889
|
-
Admin: 'admin'
|
|
889
|
+
Admin: 'admin',
|
|
890
890
|
} as const;
|
|
891
891
|
export type ListGroupsKindEnum = typeof ListGroupsKindEnum[keyof typeof ListGroupsKindEnum];
|