@openshift-migration-advisor/planner-sdk 0.8.0 → 0.9.0-a26ff9932eeb

package/docs/EstimationContext.md

@@ -0,0 +1,36 @@
+
+# EstimationContext
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`schemas` | Array<string>
+`params` | { [key: string]: number; }
+
+## Example
+
+```typescript
+import type { EstimationContext } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "schemas": null,
+  "params": null,
+} satisfies EstimationContext
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as EstimationContext
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/EstimationDetail.md

@@ -8,6 +8,8 @@ Detailed estimation result from a single calculator
 Name | Type
 ------------ | -------------
 `duration` | string
+`minDuration` | string
+`maxDuration` | string
 `reason` | string
 
 ## Example
@@ -18,7 +20,9 @@ import type { EstimationDetail } from '@openshift-migration-advisor/planner-sdk'
 // TODO: Update the object below with actual values
 const example = {
   "duration": 3h40m0s,
-  "reason": 1000.00 GB at 110 minutes per 500GB,
+  "minDuration": 8m20s,
+  "maxDuration": 33m20s,
+  "reason": null,
 } satisfies EstimationDetail
 
 console.log(example)

package/docs/MigrationEstimationByComplexityResponse.md

@@ -0,0 +1,38 @@
+
+# MigrationEstimationByComplexityResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`complexityByOsDisk` | [Array<OsDiskEstimationEntry>](OsDiskEstimationEntry.md)
+`complexityMatrix` | { [key: string]: { [key: string]: number; }; }
+`estimationContext` | [EstimationContext](EstimationContext.md)
+
+## Example
+
+```typescript
+import type { MigrationEstimationByComplexityResponse } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "complexityByOsDisk": null,
+  "complexityMatrix": null,
+  "estimationContext": null,
+} satisfies MigrationEstimationByComplexityResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as MigrationEstimationByComplexityResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/MigrationEstimationRequest.md

@@ -8,6 +8,8 @@ Request payload for calculating migration time estimation
 Name | Type
 ------------ | -------------
 `clusterId` | string
+`estimationSchema` | Array<string>
+`params` | { [key: string]: any; }
 
 ## Example
 
@@ -17,6 +19,8 @@ import type { MigrationEstimationRequest } from '@openshift-migration-advisor/pl
 // TODO: Update the object below with actual values
 const example = {
   "clusterId": domain-c8,
+  "estimationSchema": null,
+  "params": null,
 } satisfies MigrationEstimationRequest
 
 console.log(example)

package/docs/OsDiskEstimationEntry.md

@@ -0,0 +1,40 @@
+
+# OsDiskEstimationEntry
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`score` | number
+`vmCount` | number
+`totalDiskSizeTB` | number
+`estimation` | [{ [key: string]: SchemaEstimationResult; }](SchemaEstimationResult.md)
+
+## Example
+
+```typescript
+import type { OsDiskEstimationEntry } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "score": null,
+  "vmCount": null,
+  "totalDiskSizeTB": null,
+  "estimation": null,
+} satisfies OsDiskEstimationEntry
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as OsDiskEstimationEntry
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/{MigrationEstimationResponse.md → SchemaEstimationResult.md}

@@ -1,25 +1,27 @@
 
-# MigrationEstimationResponse
+# SchemaEstimationResult
 
-Migration time estimation results
+Estimation results for a single schema
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`totalDuration` | string
+`minTotalDuration` | string
+`maxTotalDuration` | string
 `breakdown` | [{ [key: string]: EstimationDetail; }](EstimationDetail.md)
 
 ## Example
 
 ```typescript
-import type { MigrationEstimationResponse } from '@openshift-migration-advisor/planner-sdk'
+import type { SchemaEstimationResult } from '@openshift-migration-advisor/planner-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
-  "totalDuration": 4h30m0s,
+  "minTotalDuration": 1h20m0s,
+  "maxTotalDuration": 5h20m0s,
   "breakdown": null,
-} satisfies MigrationEstimationResponse
+} satisfies SchemaEstimationResult
 
 console.log(example)
 
@@ -28,7 +30,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as MigrationEstimationResponse
+const exampleParsed = JSON.parse(exampleJSON) as SchemaEstimationResult
 console.log(exampleParsed)
 ```
 

package/docs/VMs.md

@@ -17,6 +17,7 @@ Name | Type
 `distributionByMemoryTier` | { [key: string]: number; }
 `distributionByNicCount` | { [key: string]: number; }
 `distributionByComplexity` | { [key: string]: number; }
+`complexityDistribution` | [{ [key: string]: DiskSizeTierSummary; }](DiskSizeTierSummary.md)
 `ramGB` | [VMResourceBreakdown](VMResourceBreakdown.md)
 `diskGB` | [VMResourceBreakdown](VMResourceBreakdown.md)
 `diskCount` | [VMResourceBreakdown](VMResourceBreakdown.md)
@@ -45,6 +46,7 @@ const example = {
   "distributionByMemoryTier": null,
   "distributionByNicCount": null,
   "distributionByComplexity": null,
+  "complexityDistribution": null,
   "ramGB": null,
   "diskGB": null,
   "diskCount": null,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openshift-migration-advisor/planner-sdk",
-  "version": "0.8.0",
+  "version": "0.9.0-a26ff9932eeb",
   "description": "OpenAPI client for @openshift-migration-advisor/planner-sdk",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/AssessmentApi.ts

@@ -22,8 +22,9 @@ import type {
   ClusterRequirementsResponse,
   MigrationComplexityRequest,
   MigrationComplexityResponse,
+  MigrationEstimationByComplexityResponse,
   MigrationEstimationRequest,
-  MigrationEstimationResponse,
+  SchemaEstimationResult,
 } from '../models/index.js';
 import {
     AssessmentFromJSON,
@@ -40,10 +41,12 @@ import {
     MigrationComplexityRequestToJSON,
     MigrationComplexityResponseFromJSON,
     MigrationComplexityResponseToJSON,
+    MigrationEstimationByComplexityResponseFromJSON,
+    MigrationEstimationByComplexityResponseToJSON,
     MigrationEstimationRequestFromJSON,
     MigrationEstimationRequestToJSON,
-    MigrationEstimationResponseFromJSON,
-    MigrationEstimationResponseToJSON,
+    SchemaEstimationResultFromJSON,
+    SchemaEstimationResultToJSON,
 } from '../models/index.js';
 
 export interface CalculateAssessmentClusterRequirementsRequest {
@@ -61,6 +64,11 @@ export interface CalculateMigrationEstimationRequest {
     migrationEstimationRequest: MigrationEstimationRequest;
 }
 
+export interface CalculateMigrationEstimationByComplexityRequest {
+    id: string;
+    migrationEstimationRequest: MigrationEstimationRequest;
+}
+
 export interface CreateAssessmentRequest {
     assessmentForm: AssessmentForm;
 }
@@ -154,12 +162,36 @@ export interface AssessmentApiInterface {
      * @throws {RequiredError}
      * @memberof AssessmentApiInterface
      */
-    calculateMigrationEstimationRaw(requestParameters: CalculateMigrationEstimationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MigrationEstimationResponse>>;
+    calculateMigrationEstimationRaw(requestParameters: CalculateMigrationEstimationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{ [key: string]: SchemaEstimationResult; }>>;
 
     /**
      * Calculate migration time estimation for an assessment
      */
-    calculateMigrationEstimation(requestParameters: CalculateMigrationEstimationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MigrationEstimationResponse>;
+    calculateMigrationEstimation(requestParameters: CalculateMigrationEstimationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{ [key: string]: SchemaEstimationResult; }>;
+
+    /**
+     * Creates request options for calculateMigrationEstimationByComplexity without sending the request
+     * @param {string} id ID of the assessment
+     * @param {MigrationEstimationRequest} migrationEstimationRequest 
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    calculateMigrationEstimationByComplexityRequestOpts(requestParameters: CalculateMigrationEstimationByComplexityRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Calculate migration time estimation broken down by combined OS+Disk complexity
+     * @param {string} id ID of the assessment
+     * @param {MigrationEstimationRequest} migrationEstimationRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    calculateMigrationEstimationByComplexityRaw(requestParameters: CalculateMigrationEstimationByComplexityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MigrationEstimationByComplexityResponse>>;
+
+    /**
+     * Calculate migration time estimation broken down by combined OS+Disk complexity
+     */
+    calculateMigrationEstimationByComplexity(requestParameters: CalculateMigrationEstimationByComplexityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MigrationEstimationByComplexityResponse>;
 
     /**
      * Creates request options for createAssessment without sending the request
@@ -430,21 +462,76 @@ export class AssessmentApi extends runtime.BaseAPI implements AssessmentApiInter
     /**
      * Calculate migration time estimation for an assessment
      */
-    async calculateMigrationEstimationRaw(requestParameters: CalculateMigrationEstimationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MigrationEstimationResponse>> {
+    async calculateMigrationEstimationRaw(requestParameters: CalculateMigrationEstimationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{ [key: string]: SchemaEstimationResult; }>> {
         const requestOptions = await this.calculateMigrationEstimationRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
-        return new runtime.JSONApiResponse(response, (jsonValue) => MigrationEstimationResponseFromJSON(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => runtime.mapValues(jsonValue, SchemaEstimationResultFromJSON));
     }
 
     /**
      * Calculate migration time estimation for an assessment
      */
-    async calculateMigrationEstimation(requestParameters: CalculateMigrationEstimationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MigrationEstimationResponse> {
+    async calculateMigrationEstimation(requestParameters: CalculateMigrationEstimationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{ [key: string]: SchemaEstimationResult; }> {
         const response = await this.calculateMigrationEstimationRaw(requestParameters, initOverrides);
         return await response.value();
     }
 
+    /**
+     * Creates request options for calculateMigrationEstimationByComplexity without sending the request
+     */
+    async calculateMigrationEstimationByComplexityRequestOpts(requestParameters: CalculateMigrationEstimationByComplexityRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling calculateMigrationEstimationByComplexity().'
+            );
+        }
+
+        if (requestParameters['migrationEstimationRequest'] == null) {
+            throw new runtime.RequiredError(
+                'migrationEstimationRequest',
+                'Required parameter "migrationEstimationRequest" was null or undefined when calling calculateMigrationEstimationByComplexity().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/api/v1/assessments/{id}/migration-estimation/by-complexity`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: MigrationEstimationRequestToJSON(requestParameters['migrationEstimationRequest']),
+        };
+    }
+
+    /**
+     * Calculate migration time estimation broken down by combined OS+Disk complexity
+     */
+    async calculateMigrationEstimationByComplexityRaw(requestParameters: CalculateMigrationEstimationByComplexityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MigrationEstimationByComplexityResponse>> {
+        const requestOptions = await this.calculateMigrationEstimationByComplexityRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => MigrationEstimationByComplexityResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Calculate migration time estimation broken down by combined OS+Disk complexity
+     */
+    async calculateMigrationEstimationByComplexity(requestParameters: CalculateMigrationEstimationByComplexityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MigrationEstimationByComplexityResponse> {
+        const response = await this.calculateMigrationEstimationByComplexityRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for createAssessment without sending the request
      */

package/src/models/ClusterRequirementsRequest.ts

@@ -56,7 +56,7 @@ export interface ClusterRequirementsRequest {
      */
     workerNodeThreads?: number;
     /**
-     * Allow workload scheduling on control plane nodes
+     * Allow workload scheduling on control plane nodes (default: false)
      * @type {boolean}
      * @memberof ClusterRequirementsRequest
      */
@@ -68,17 +68,23 @@ export interface ClusterRequirementsRequest {
      */
     controlPlaneCPU?: number;
     /**
-     * Memory (GB) per control plane node (default: 16)
+     * Memory in GB per control plane node (default: 16)
      * @type {number}
      * @memberof ClusterRequirementsRequest
      */
     controlPlaneMemory?: number;
     /**
-     * Number of control plane nodes (1 for single node, 3 for HA)
+     * Number of control plane nodes: 1 or 3 (default: 3)
      * @type {ClusterRequirementsRequestControlPlaneNodeCountEnum}
      * @memberof ClusterRequirementsRequest
      */
     controlPlaneNodeCount?: ClusterRequirementsRequestControlPlaneNodeCountEnum;
+    /**
+     * If true, control plane is hosted externally. Incompatible with control plane fields (default: false)
+     * @type {boolean}
+     * @memberof ClusterRequirementsRequest
+     */
+    hostedControlPlane?: boolean;
 }
 
 
@@ -145,6 +151,7 @@ export function ClusterRequirementsRequestFromJSONTyped(json: any, ignoreDiscrim
         'controlPlaneCPU': json['controlPlaneCPU'] == null ? undefined : json['controlPlaneCPU'],
         'controlPlaneMemory': json['controlPlaneMemory'] == null ? undefined : json['controlPlaneMemory'],
         'controlPlaneNodeCount': json['controlPlaneNodeCount'] == null ? undefined : json['controlPlaneNodeCount'],
+        'hostedControlPlane': json['hostedControlPlane'] == null ? undefined : json['hostedControlPlane'],
     };
 }
 
@@ -169,6 +176,7 @@ export function ClusterRequirementsRequestToJSONTyped(value?: ClusterRequirement
         'controlPlaneCPU': value['controlPlaneCPU'],
         'controlPlaneMemory': value['controlPlaneMemory'],
         'controlPlaneNodeCount': value['controlPlaneNodeCount'],
+        'hostedControlPlane': value['hostedControlPlane'],
     };
 }
 

package/src/models/ComplexityOSNameEntry.ts

@@ -27,7 +27,7 @@ export interface ComplexityOSNameEntry {
      */
     osName: string;
     /**
-     * Complexity score assigned by ClassifyOS. 0 = unclassified, 1 = least complex, 4 = most complex.
+     * Complexity score assigned by ClassifyOS. 0 = unknown, 1 = least complex, 4 = most complex.
      * 
      * @type {number}
      * @memberof ComplexityOSNameEntry

package/src/models/ComplexityOSScoreEntry.ts

@@ -20,7 +20,7 @@ import { mapValues } from '../runtime.js';
  */
 export interface ComplexityOSScoreEntry {
     /**
-     * Complexity score from 0 to 4, where 1 indicates the least complex OS to migrate and 0 indicates an OS that could not be classified.
+     * Complexity score from 0 to 4, where 1 indicates the least complex OS to migrate and 0 indicates an OS with unknown complexity.
      * 
      * @type {number}
      * @memberof ComplexityOSScoreEntry

package/src/models/EstimationContext.ts

@@ -0,0 +1,73 @@
+/* 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: undefined
+ * 
+ *
+ * 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 EstimationContext
+ */
+export interface EstimationContext {
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof EstimationContext
+     */
+    schemas?: Array<string>;
+    /**
+     * 
+     * @type {{ [key: string]: number; }}
+     * @memberof EstimationContext
+     */
+    params?: { [key: string]: number; };
+}
+
+/**
+ * Check if a given object implements the EstimationContext interface.
+ */
+export function instanceOfEstimationContext(value: object): value is EstimationContext {
+    return true;
+}
+
+export function EstimationContextFromJSON(json: any): EstimationContext {
+    return EstimationContextFromJSONTyped(json, false);
+}
+
+export function EstimationContextFromJSONTyped(json: any, ignoreDiscriminator: boolean): EstimationContext {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'schemas': json['schemas'] == null ? undefined : json['schemas'],
+        'params': json['params'] == null ? undefined : json['params'],
+    };
+}
+
+export function EstimationContextToJSON(json: any): EstimationContext {
+    return EstimationContextToJSONTyped(json, false);
+}
+
+export function EstimationContextToJSONTyped(value?: EstimationContext | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'schemas': value['schemas'],
+        'params': value['params'],
+    };
+}
+

package/src/models/EstimationDetail.ts

@@ -20,11 +20,23 @@ import { mapValues } from '../runtime.js';
  */
 export interface EstimationDetail {
     /**
-     * Estimated duration for this component (formatted as duration string)
+     * Estimated duration for this component (point calculators only)
      * @type {string}
      * @memberof EstimationDetail
      */
-    duration: string;
+    duration?: string;
+    /**
+     * Minimum estimated duration (ranged calculators only)
+     * @type {string}
+     * @memberof EstimationDetail
+     */
+    minDuration?: string;
+    /**
+     * Maximum estimated duration (ranged calculators only)
+     * @type {string}
+     * @memberof EstimationDetail
+     */
+    maxDuration?: string;
     /**
      * Explanation of how the estimation was calculated
      * @type {string}
@@ -37,7 +49,6 @@ export interface EstimationDetail {
  * Check if a given object implements the EstimationDetail interface.
  */
 export function instanceOfEstimationDetail(value: object): value is EstimationDetail {
-    if (!('duration' in value) || value['duration'] === undefined) return false;
     if (!('reason' in value) || value['reason'] === undefined) return false;
     return true;
 }
@@ -52,7 +63,9 @@ export function EstimationDetailFromJSONTyped(json: any, ignoreDiscriminator: bo
     }
     return {
         
-        'duration': json['duration'],
+        'duration': json['duration'] == null ? undefined : json['duration'],
+        'minDuration': json['minDuration'] == null ? undefined : json['minDuration'],
+        'maxDuration': json['maxDuration'] == null ? undefined : json['maxDuration'],
         'reason': json['reason'],
     };
 }
@@ -69,6 +82,8 @@ export function EstimationDetailToJSONTyped(value?: EstimationDetail | null, ign
     return {
         
         'duration': value['duration'],
+        'minDuration': value['minDuration'],
+        'maxDuration': value['maxDuration'],
         'reason': value['reason'],
     };
 }

package/src/models/MigrationComplexityResponse.ts

@@ -49,7 +49,7 @@ export interface MigrationComplexityResponse {
      */
     complexityByDisk: Array<ComplexityDiskScoreEntry>;
     /**
-     * OS complexity scores, one entry per score level (0-4). Score 1 indicates the least complex OS to migrate; score 0 indicates an OS that could not be classified. All five score levels are always present.
+     * OS complexity scores, one entry per score level (0-4). Score 1 indicates the least complex OS to migrate; score 0 indicates an OS with unknown complexity. All five score levels are always present.
      * 
      * @type {Array<ComplexityOSScoreEntry>}
      * @memberof MigrationComplexityResponse
@@ -63,7 +63,7 @@ export interface MigrationComplexityResponse {
      */
     diskSizeRatings: { [key: string]: number; };
     /**
-     * Per-OS-name score for every OS found in this cluster's inventory. Keys are the OS name strings exactly as they appear in vms.osInfo; values are the numeric complexity score assigned by ClassifyOS (0 = unclassified, 1-4 = increasing complexity). The map contains one entry per distinct OS name in the cluster, regardless of how many VMs run it.
+     * Per-OS-name score for every OS found in this cluster's inventory. Keys are the OS name strings exactly as they appear in vms.osInfo; values are the numeric complexity score assigned by ClassifyOS (0 = unknown, 1-4 = increasing complexity). The map contains one entry per distinct OS name in the cluster, regardless of how many VMs run it.
      * 
      * @type {{ [key: string]: number; }}
      * @memberof MigrationComplexityResponse