@openshift-migration-advisor/planner-sdk 0.5.0 → 0.5.1-0ae313a75a60

package/docs/MigrationEstimationResponse.md

@@ -0,0 +1,37 @@
+
+# MigrationEstimationResponse
+
+Migration time estimation results
+
+## Properties
+
+Name | Type
+------------ | -------------
+`totalDuration` | string
+`breakdown` | [{ [key: string]: EstimationDetail; }](EstimationDetail.md)
+
+## Example
+
+```typescript
+import type { MigrationEstimationResponse } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "totalDuration": 4h30m0s,
+  "breakdown": null,
+} satisfies MigrationEstimationResponse
+
+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 MigrationEstimationResponse
+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/ModelError.md

@@ -7,7 +7,6 @@
 Name | Type
 ------------ | -------------
 `message` | string
-`requestId` | string
 
 ## Example
 
@@ -17,7 +16,6 @@ import type { ModelError } from '@openshift-migration-advisor/planner-sdk'
 // TODO: Update the object below with actual values
 const example = {
   "message": null,
-  "requestId": null,
 } satisfies ModelError
 
 console.log(example)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openshift-migration-advisor/planner-sdk",
-  "version": "0.5.0",
+  "version": "0.5.1-0ae313a75a60",
   "description": "OpenAPI client for @openshift-migration-advisor/planner-sdk",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/AssessmentApi.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined
@@ -20,6 +20,8 @@ import type {
   AssessmentUpdate,
   ClusterRequirementsRequest,
   ClusterRequirementsResponse,
+  MigrationEstimationRequest,
+  MigrationEstimationResponse,
 } from '../models/index.js';
 import {
     AssessmentFromJSON,
@@ -32,6 +34,10 @@ import {
     ClusterRequirementsRequestToJSON,
     ClusterRequirementsResponseFromJSON,
     ClusterRequirementsResponseToJSON,
+    MigrationEstimationRequestFromJSON,
+    MigrationEstimationRequestToJSON,
+    MigrationEstimationResponseFromJSON,
+    MigrationEstimationResponseToJSON,
 } from '../models/index.js';
 
 export interface CalculateAssessmentClusterRequirementsRequest {
@@ -39,6 +45,11 @@ export interface CalculateAssessmentClusterRequirementsRequest {
     clusterRequirementsRequest: ClusterRequirementsRequest;
 }
 
+export interface CalculateMigrationEstimationRequest {
+    id: string;
+    migrationEstimationRequest: MigrationEstimationRequest;
+}
+
 export interface CreateAssessmentRequest {
     assessmentForm: AssessmentForm;
 }
@@ -91,6 +102,30 @@ export interface AssessmentApiInterface {
      */
     calculateAssessmentClusterRequirements(requestParameters: CalculateAssessmentClusterRequirementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClusterRequirementsResponse>;
 
+    /**
+     * Creates request options for calculateMigrationEstimation without sending the request
+     * @param {string} id ID of the assessment
+     * @param {MigrationEstimationRequest} migrationEstimationRequest 
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    calculateMigrationEstimationRequestOpts(requestParameters: CalculateMigrationEstimationRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Calculate migration time estimation for an assessment
+     * @param {string} id ID of the assessment
+     * @param {MigrationEstimationRequest} migrationEstimationRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    calculateMigrationEstimationRaw(requestParameters: CalculateMigrationEstimationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MigrationEstimationResponse>>;
+
+    /**
+     * Calculate migration time estimation for an assessment
+     */
+    calculateMigrationEstimation(requestParameters: CalculateMigrationEstimationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MigrationEstimationResponse>;
+
     /**
      * Creates request options for createAssessment without sending the request
      * @param {AssessmentForm} assessmentForm 
@@ -265,6 +300,61 @@ export class AssessmentApi extends runtime.BaseAPI implements AssessmentApiInter
         return await response.value();
     }
 
+    /**
+     * Creates request options for calculateMigrationEstimation without sending the request
+     */
+    async calculateMigrationEstimationRequestOpts(requestParameters: CalculateMigrationEstimationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling calculateMigrationEstimation().'
+            );
+        }
+
+        if (requestParameters['migrationEstimationRequest'] == null) {
+            throw new runtime.RequiredError(
+                'migrationEstimationRequest',
+                'Required parameter "migrationEstimationRequest" was null or undefined when calling calculateMigrationEstimation().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/api/v1/assessments/{id}/migration-estimation`;
+        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 for an assessment
+     */
+    async calculateMigrationEstimationRaw(requestParameters: CalculateMigrationEstimationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MigrationEstimationResponse>> {
+        const requestOptions = await this.calculateMigrationEstimationRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => MigrationEstimationResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Calculate migration time estimation for an assessment
+     */
+    async calculateMigrationEstimation(requestParameters: CalculateMigrationEstimationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MigrationEstimationResponse> {
+        const response = await this.calculateMigrationEstimationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for createAssessment without sending the request
      */

package/src/apis/HealthApi.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/src/apis/ImageApi.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/src/apis/InfoApi.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined
@@ -37,7 +37,7 @@ export interface InfoApiInterface {
     getInfoRequestOpts(): Promise<runtime.RequestOpts>;
 
     /**
-     * Get migration planner information
+     * Get OpenShift Migration Advisor information
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof InfoApiInterface
@@ -45,7 +45,7 @@ export interface InfoApiInterface {
     getInfoRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Info>>;
 
     /**
-     * Get migration planner information
+     * Get OpenShift Migration Advisor information
      */
     getInfo(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Info>;
 
@@ -76,7 +76,7 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
-     * Get migration planner information
+     * Get OpenShift Migration Advisor information
      */
     async getInfoRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Info>> {
         const requestOptions = await this.getInfoRequestOpts();
@@ -86,7 +86,7 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
-     * Get migration planner information
+     * Get OpenShift Migration Advisor information
      */
     async getInfo(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Info> {
         const response = await this.getInfoRaw(initOverrides);

package/src/apis/JobApi.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/src/apis/SourceApi.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/src/models/Agent.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/src/models/AgentProxy.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/src/models/Assessment.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/src/models/AssessmentForm.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined
@@ -36,7 +36,7 @@ export interface AssessmentForm {
     /**
      * Source of the assessment data:
      *  * `inventory` - Manual inventory upload via JSON
-     *  * `agent` - Collected by migration planner agent
+     *  * `agent` - Collected by OpenShift Migration Advisor agent
      * 
      * @type {string}
      * @memberof AssessmentForm

package/src/models/AssessmentUpdate.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/src/models/ClusterRequirementsRequest.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined
@@ -61,6 +61,18 @@ export interface ClusterRequirementsRequest {
      * @memberof ClusterRequirementsRequest
      */
     controlPlaneSchedulable?: boolean;
+    /**
+     * CPU cores per control plane node (default: 6)
+     * @type {number}
+     * @memberof ClusterRequirementsRequest
+     */
+    controlPlaneCPU?: number;
+    /**
+     * Memory (GB) per control plane node (default: 16)
+     * @type {number}
+     * @memberof ClusterRequirementsRequest
+     */
+    controlPlaneMemory?: number;
 }
 
 
@@ -115,6 +127,8 @@ export function ClusterRequirementsRequestFromJSONTyped(json: any, ignoreDiscrim
         'workerNodeMemory': json['workerNodeMemory'],
         'workerNodeThreads': json['workerNodeThreads'] == null ? undefined : json['workerNodeThreads'],
         'controlPlaneSchedulable': json['controlPlaneSchedulable'] == null ? undefined : json['controlPlaneSchedulable'],
+        'controlPlaneCPU': json['controlPlaneCPU'] == null ? undefined : json['controlPlaneCPU'],
+        'controlPlaneMemory': json['controlPlaneMemory'] == null ? undefined : json['controlPlaneMemory'],
     };
 }
 
@@ -136,6 +150,8 @@ export function ClusterRequirementsRequestToJSONTyped(value?: ClusterRequirement
         'workerNodeMemory': value['workerNodeMemory'],
         'workerNodeThreads': value['workerNodeThreads'],
         'controlPlaneSchedulable': value['controlPlaneSchedulable'],
+        'controlPlaneCPU': value['controlPlaneCPU'],
+        'controlPlaneMemory': value['controlPlaneMemory'],
     };
 }
 

package/src/models/ClusterRequirementsResponse.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/src/models/ClusterSizing.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/src/models/Datastore.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/src/models/DiskSizeTierSummary.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/src/models/DiskTypeSummary.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/src/models/EstimationDetail.ts

@@ -0,0 +1,75 @@
+/* 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';
+/**
+ * Detailed estimation result from a single calculator
+ * @export
+ * @interface EstimationDetail
+ */
+export interface EstimationDetail {
+    /**
+     * Estimated duration for this component (formatted as duration string)
+     * @type {string}
+     * @memberof EstimationDetail
+     */
+    duration: string;
+    /**
+     * Explanation of how the estimation was calculated
+     * @type {string}
+     * @memberof EstimationDetail
+     */
+    reason: string;
+}
+
+/**
+ * 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;
+}
+
+export function EstimationDetailFromJSON(json: any): EstimationDetail {
+    return EstimationDetailFromJSONTyped(json, false);
+}
+
+export function EstimationDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): EstimationDetail {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'duration': json['duration'],
+        'reason': json['reason'],
+    };
+}
+
+export function EstimationDetailToJSON(json: any): EstimationDetail {
+    return EstimationDetailToJSONTyped(json, false);
+}
+
+export function EstimationDetailToJSONTyped(value?: EstimationDetail | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'duration': value['duration'],
+        'reason': value['reason'],
+    };
+}
+

package/src/models/Histogram.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/src/models/Host.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/src/models/Info.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined
@@ -14,7 +14,7 @@
 
 import { mapValues } from '../runtime.js';
 /**
- * Migration planner information
+ * OpenShift Migration Advisor information
  * @export
  * @interface Info
  */

package/src/models/Infra.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/src/models/Inventory.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/src/models/InventoryData.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/src/models/InventoryTotals.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/src/models/Ipv4Config.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/src/models/Job.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/src/models/JobStatus.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/src/models/Label.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined