@openshift-migration-advisor/planner-sdk 0.13.2 → 0.13.3-4f3d8bb515ec

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openshift-migration-advisor/planner-sdk",
-  "version": "0.13.2",
+  "version": "0.13.3-4f3d8bb515ec",
   "description": "OpenAPI client for @openshift-migration-advisor/planner-sdk",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/SizingApi.ts

@@ -0,0 +1,114 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * OpenShift Migration Advisor API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1alpha1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import * as runtime from '../runtime.js';
+import {
+    type StandaloneClusterRequirementsRequest,
+    StandaloneClusterRequirementsRequestFromJSON,
+    StandaloneClusterRequirementsRequestToJSON,
+} from '../models/StandaloneClusterRequirementsRequest.js';
+import {
+    type StandaloneClusterRequirementsResponse,
+    StandaloneClusterRequirementsResponseFromJSON,
+    StandaloneClusterRequirementsResponseToJSON,
+} from '../models/StandaloneClusterRequirementsResponse.js';
+
+export interface CalculateClusterRequirementsRequest {
+    standaloneClusterRequirementsRequest: StandaloneClusterRequirementsRequest;
+}
+
+/**
+ * SizingApi - interface
+ * 
+ * @export
+ * @interface SizingApiInterface
+ */
+export interface SizingApiInterface {
+    /**
+     * Creates request options for calculateClusterRequirements without sending the request
+     * @param {StandaloneClusterRequirementsRequest} standaloneClusterRequirementsRequest 
+     * @throws {RequiredError}
+     * @memberof SizingApiInterface
+     */
+    calculateClusterRequirementsRequestOpts(requestParameters: CalculateClusterRequirementsRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Calculate cluster requirements for hypothetical workload with inline inventory data (no assessment required)
+     * @param {StandaloneClusterRequirementsRequest} standaloneClusterRequirementsRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SizingApiInterface
+     */
+    calculateClusterRequirementsRaw(requestParameters: CalculateClusterRequirementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StandaloneClusterRequirementsResponse>>;
+
+    /**
+     * Calculate cluster requirements for hypothetical workload with inline inventory data (no assessment required)
+     */
+    calculateClusterRequirements(requestParameters: CalculateClusterRequirementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StandaloneClusterRequirementsResponse>;
+
+}
+
+/**
+ * 
+ */
+export class SizingApi extends runtime.BaseAPI implements SizingApiInterface {
+
+    /**
+     * Creates request options for calculateClusterRequirements without sending the request
+     */
+    async calculateClusterRequirementsRequestOpts(requestParameters: CalculateClusterRequirementsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['standaloneClusterRequirementsRequest'] == null) {
+            throw new runtime.RequiredError(
+                'standaloneClusterRequirementsRequest',
+                'Required parameter "standaloneClusterRequirementsRequest" was null or undefined when calling calculateClusterRequirements().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/api/v1/cluster-requirements`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: StandaloneClusterRequirementsRequestToJSON(requestParameters['standaloneClusterRequirementsRequest']),
+        };
+    }
+
+    /**
+     * Calculate cluster requirements for hypothetical workload with inline inventory data (no assessment required)
+     */
+    async calculateClusterRequirementsRaw(requestParameters: CalculateClusterRequirementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StandaloneClusterRequirementsResponse>> {
+        const requestOptions = await this.calculateClusterRequirementsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => StandaloneClusterRequirementsResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Calculate cluster requirements for hypothetical workload with inline inventory data (no assessment required)
+     */
+    async calculateClusterRequirements(requestParameters: CalculateClusterRequirementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StandaloneClusterRequirementsResponse> {
+        const response = await this.calculateClusterRequirementsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -7,4 +7,5 @@ export * from './ImageApi.js';
 export * from './InfoApi.js';
 export * from './JobApi.js';
 export * from './PartnerApi.js';
+export * from './SizingApi.js';
 export * from './SourceApi.js';

package/src/models/ClusterFeatures.ts

@@ -0,0 +1,94 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * OpenShift Migration Advisor API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1alpha1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime.js';
+/**
+ * 
+ * @export
+ * @interface ClusterFeatures
+ */
+export interface ClusterFeatures {
+    /**
+     * Whether DRS (Distributed Resource Scheduler) is enabled for this cluster
+     * @type {boolean}
+     * @memberof ClusterFeatures
+     */
+    drsEnabled?: boolean;
+    /**
+     * DRS automation mode for the cluster
+     * @type {ClusterFeaturesDrsModeEnum}
+     * @memberof ClusterFeatures
+     */
+    drsMode?: ClusterFeaturesDrsModeEnum;
+    /**
+     * Whether Storage DRS is enabled for this cluster
+     * @type {boolean}
+     * @memberof ClusterFeatures
+     */
+    storageDrsEnabled?: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const ClusterFeaturesDrsModeEnum = {
+    FullyAutomated: 'Fully Automated',
+    PartiallyAutomated: 'Partially Automated',
+    Manual: 'Manual',
+    None: 'None'
+} as const;
+export type ClusterFeaturesDrsModeEnum = typeof ClusterFeaturesDrsModeEnum[keyof typeof ClusterFeaturesDrsModeEnum];
+
+
+/**
+ * Check if a given object implements the ClusterFeatures interface.
+ */
+export function instanceOfClusterFeatures(value: object): value is ClusterFeatures {
+    return true;
+}
+
+export function ClusterFeaturesFromJSON(json: any): ClusterFeatures {
+    return ClusterFeaturesFromJSONTyped(json, false);
+}
+
+export function ClusterFeaturesFromJSONTyped(json: any, ignoreDiscriminator: boolean): ClusterFeatures {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'drsEnabled': json['drsEnabled'] == null ? undefined : json['drsEnabled'],
+        'drsMode': json['drsMode'] == null ? undefined : json['drsMode'],
+        'storageDrsEnabled': json['storageDrsEnabled'] == null ? undefined : json['storageDrsEnabled'],
+    };
+}
+
+export function ClusterFeaturesToJSON(json: any): ClusterFeatures {
+    return ClusterFeaturesToJSONTyped(json, false);
+}
+
+export function ClusterFeaturesToJSONTyped(value?: ClusterFeatures | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'drsEnabled': value['drsEnabled'],
+        'drsMode': value['drsMode'],
+        'storageDrsEnabled': value['storageDrsEnabled'],
+    };
+}
+

package/src/models/ClusterRequirementsRequest.ts

@@ -13,6 +13,21 @@
  */
 
 import { mapValues } from '../runtime.js';
+import type { CpuOverCommitRatio } from './CpuOverCommitRatio.js';
+import {
+    CpuOverCommitRatioFromJSON,
+    CpuOverCommitRatioFromJSONTyped,
+    CpuOverCommitRatioToJSON,
+    CpuOverCommitRatioToJSONTyped,
+} from './CpuOverCommitRatio.js';
+import type { MemoryOverCommitRatio } from './MemoryOverCommitRatio.js';
+import {
+    MemoryOverCommitRatioFromJSON,
+    MemoryOverCommitRatioFromJSONTyped,
+    MemoryOverCommitRatioToJSON,
+    MemoryOverCommitRatioToJSONTyped,
+} from './MemoryOverCommitRatio.js';
+
 /**
  * Request payload for calculating cluster requirements
  * @export
@@ -27,16 +42,16 @@ export interface ClusterRequirementsRequest {
     clusterId: string;
     /**
      * CPU over-commit ratio (e.g., "1:4")
-     * @type {ClusterRequirementsRequestCpuOverCommitRatioEnum}
+     * @type {CpuOverCommitRatio}
      * @memberof ClusterRequirementsRequest
      */
-    cpuOverCommitRatio: ClusterRequirementsRequestCpuOverCommitRatioEnum;
+    cpuOverCommitRatio: CpuOverCommitRatio;
     /**
      * Memory over-commit ratio (e.g., "1:2")
-     * @type {ClusterRequirementsRequestMemoryOverCommitRatioEnum}
+     * @type {MemoryOverCommitRatio}
      * @memberof ClusterRequirementsRequest
      */
-    memoryOverCommitRatio: ClusterRequirementsRequestMemoryOverCommitRatioEnum;
+    memoryOverCommitRatio: MemoryOverCommitRatio;
     /**
      * CPU cores per worker node
      * @type {number}
@@ -88,27 +103,6 @@ export interface ClusterRequirementsRequest {
 }
 
 
-/**
- * @export
- */
-export const ClusterRequirementsRequestCpuOverCommitRatioEnum = {
-    CpuOneToOne: '1:1',
-    CpuOneToTwo: '1:2',
-    CpuOneToFour: '1:4',
-    CpuOneToSix: '1:6'
-} as const;
-export type ClusterRequirementsRequestCpuOverCommitRatioEnum = typeof ClusterRequirementsRequestCpuOverCommitRatioEnum[keyof typeof ClusterRequirementsRequestCpuOverCommitRatioEnum];
-
-/**
- * @export
- */
-export const ClusterRequirementsRequestMemoryOverCommitRatioEnum = {
-    MemoryOneToOne: '1:1',
-    MemoryOneToTwo: '1:2',
-    MemoryOneToFour: '1:4'
-} as const;
-export type ClusterRequirementsRequestMemoryOverCommitRatioEnum = typeof ClusterRequirementsRequestMemoryOverCommitRatioEnum[keyof typeof ClusterRequirementsRequestMemoryOverCommitRatioEnum];
-
 /**
  * @export
  */
@@ -142,8 +136,8 @@ export function ClusterRequirementsRequestFromJSONTyped(json: any, ignoreDiscrim
     return {
         
         'clusterId': json['clusterId'],
-        'cpuOverCommitRatio': json['cpuOverCommitRatio'],
-        'memoryOverCommitRatio': json['memoryOverCommitRatio'],
+        'cpuOverCommitRatio': CpuOverCommitRatioFromJSON(json['cpuOverCommitRatio']),
+        'memoryOverCommitRatio': MemoryOverCommitRatioFromJSON(json['memoryOverCommitRatio']),
         'workerNodeCPU': json['workerNodeCPU'],
         'workerNodeMemory': json['workerNodeMemory'],
         'workerNodeThreads': json['workerNodeThreads'] == null ? undefined : json['workerNodeThreads'],
@@ -167,8 +161,8 @@ export function ClusterRequirementsRequestToJSONTyped(value?: ClusterRequirement
     return {
         
         'clusterId': value['clusterId'],
-        'cpuOverCommitRatio': value['cpuOverCommitRatio'],
-        'memoryOverCommitRatio': value['memoryOverCommitRatio'],
+        'cpuOverCommitRatio': CpuOverCommitRatioToJSON(value['cpuOverCommitRatio']),
+        'memoryOverCommitRatio': MemoryOverCommitRatioToJSON(value['memoryOverCommitRatio']),
         'workerNodeCPU': value['workerNodeCPU'],
         'workerNodeMemory': value['workerNodeMemory'],
         'workerNodeThreads': value['workerNodeThreads'],

package/src/models/CpuOverCommitRatio.ts

@@ -0,0 +1,55 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * OpenShift Migration Advisor API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1alpha1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * CPU over-commit ratio
+ * @export
+ */
+export const CpuOverCommitRatio = {
+    CpuOneToOne: '1:1',
+    CpuOneToTwo: '1:2',
+    CpuOneToFour: '1:4',
+    CpuOneToSix: '1:6'
+} as const;
+export type CpuOverCommitRatio = typeof CpuOverCommitRatio[keyof typeof CpuOverCommitRatio];
+
+
+export function instanceOfCpuOverCommitRatio(value: any): boolean {
+    for (const key in CpuOverCommitRatio) {
+        if (Object.prototype.hasOwnProperty.call(CpuOverCommitRatio, key)) {
+            if (CpuOverCommitRatio[key as keyof typeof CpuOverCommitRatio] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function CpuOverCommitRatioFromJSON(json: any): CpuOverCommitRatio {
+    return CpuOverCommitRatioFromJSONTyped(json, false);
+}
+
+export function CpuOverCommitRatioFromJSONTyped(json: any, ignoreDiscriminator: boolean): CpuOverCommitRatio {
+    return json as CpuOverCommitRatio;
+}
+
+export function CpuOverCommitRatioToJSON(value?: CpuOverCommitRatio | null): any {
+    return value as any;
+}
+
+export function CpuOverCommitRatioToJSONTyped(value: any, ignoreDiscriminator: boolean): CpuOverCommitRatio {
+    return value as CpuOverCommitRatio;
+}
+

package/src/models/Inventory.ts

@@ -33,6 +33,12 @@ export interface Inventory {
      * @memberof Inventory
      */
     vcenterId: string;
+    /**
+     * Version of the vCenter api. For example "8.0.3.0"
+     * @type {string}
+     * @memberof Inventory
+     */
+    vcenterVersion?: string;
     /**
      * Map of cluster names to their inventory data
      * @type {{ [key: string]: InventoryData; }}
@@ -51,7 +57,7 @@ export interface Inventory {
  * Check if a given object implements the Inventory interface.
  */
 export function instanceOfInventory(value: object): value is Inventory {
-    if (!('vcenterId' in value) || value['vcenterId'] === undefined) return false;
+    if ((!('vcenterId' in value) && !('vcenter_id' in value)) || (value['vcenterId'] === undefined && value['vcenter_id'] === undefined)) return false;
     if (!('clusters' in value) || value['clusters'] === undefined) return false;
     return true;
 }
@@ -67,6 +73,7 @@ export function InventoryFromJSONTyped(json: any, ignoreDiscriminator: boolean):
     return {
         
         'vcenterId': json['vcenter_id'],
+        'vcenterVersion': json['vcenter_version'] == null ? undefined : json['vcenter_version'],
         'clusters': (mapValues(json['clusters'], InventoryDataFromJSON)),
         'vcenter': json['vcenter'] == null ? undefined : InventoryDataFromJSON(json['vcenter']),
     };
@@ -84,6 +91,7 @@ export function InventoryToJSONTyped(value?: Inventory | null, ignoreDiscriminat
     return {
         
         'vcenter_id': value['vcenterId'],
+        'vcenter_version': value['vcenterVersion'],
         'clusters': (mapValues(value['clusters'], InventoryDataToJSON)),
         'vcenter': InventoryDataToJSON(value['vcenter']),
     };

package/src/models/InventoryData.ts

@@ -34,6 +34,13 @@ import {
     VMsToJSON,
     VMsToJSONTyped,
 } from './VMs.js';
+import type { ClusterFeatures } from './ClusterFeatures.js';
+import {
+    ClusterFeaturesFromJSON,
+    ClusterFeaturesFromJSONTyped,
+    ClusterFeaturesToJSON,
+    ClusterFeaturesToJSONTyped,
+} from './ClusterFeatures.js';
 
 /**
  * 
@@ -47,6 +54,12 @@ export interface InventoryData {
      * @memberof InventoryData
      */
     vcenter?: VCenter;
+    /**
+     * 
+     * @type {ClusterFeatures}
+     * @memberof InventoryData
+     */
+    clusterFeatures?: ClusterFeatures;
     /**
      * 
      * @type {VMs}
@@ -81,6 +94,7 @@ export function InventoryDataFromJSONTyped(json: any, ignoreDiscriminator: boole
     return {
         
         'vcenter': json['vcenter'] == null ? undefined : VCenterFromJSON(json['vcenter']),
+        'clusterFeatures': json['clusterFeatures'] == null ? undefined : ClusterFeaturesFromJSON(json['clusterFeatures']),
         'vms': VMsFromJSON(json['vms']),
         'infra': InfraFromJSON(json['infra']),
     };
@@ -98,6 +112,7 @@ export function InventoryDataToJSONTyped(value?: InventoryData | null, ignoreDis
     return {
         
         'vcenter': VCenterToJSON(value['vcenter']),
+        'clusterFeatures': ClusterFeaturesToJSON(value['clusterFeatures']),
         'vms': VMsToJSON(value['vms']),
         'infra': InfraToJSON(value['infra']),
     };

package/src/models/JobStatus.ts

@@ -16,8 +16,8 @@
 /**
  * Job status:
  *  * `pending` - Job is queued
- *  * `parsing` - Parsing RVTools Excel file
- *  * `validating` - Running OPA VM validations
+ *  * `validating` - Ingesting and validating RVTools file
+ *  * `parsing` - Building inventory from validated data
  *  * `completed` - Assessment created successfully
  *  * `failed` - Job failed with error
  *  * `cancelled` - Job was cancelled
@@ -26,8 +26,8 @@
  */
 export const JobStatus = {
     Pending: 'pending',
-    Parsing: 'parsing',
     Validating: 'validating',
+    Parsing: 'parsing',
     Completed: 'completed',
     Failed: 'failed',
     Cancelled: 'cancelled'

package/src/models/MemoryOverCommitRatio.ts

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * OpenShift Migration Advisor API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1alpha1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * Memory over-commit ratio
+ * @export
+ */
+export const MemoryOverCommitRatio = {
+    MemoryOneToOne: '1:1',
+    MemoryOneToTwo: '1:2',
+    MemoryOneToFour: '1:4'
+} as const;
+export type MemoryOverCommitRatio = typeof MemoryOverCommitRatio[keyof typeof MemoryOverCommitRatio];
+
+
+export function instanceOfMemoryOverCommitRatio(value: any): boolean {
+    for (const key in MemoryOverCommitRatio) {
+        if (Object.prototype.hasOwnProperty.call(MemoryOverCommitRatio, key)) {
+            if (MemoryOverCommitRatio[key as keyof typeof MemoryOverCommitRatio] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function MemoryOverCommitRatioFromJSON(json: any): MemoryOverCommitRatio {
+    return MemoryOverCommitRatioFromJSONTyped(json, false);
+}
+
+export function MemoryOverCommitRatioFromJSONTyped(json: any, ignoreDiscriminator: boolean): MemoryOverCommitRatio {
+    return json as MemoryOverCommitRatio;
+}
+
+export function MemoryOverCommitRatioToJSON(value?: MemoryOverCommitRatio | null): any {
+    return value as any;
+}
+
+export function MemoryOverCommitRatioToJSONTyped(value: any, ignoreDiscriminator: boolean): MemoryOverCommitRatio {
+    return value as MemoryOverCommitRatio;
+}
+