@openshift-migration-advisor/planner-sdk 0.13.3-391ade47acd8 → 0.13.3-a0b90cb3da5f

package/dist/models/index.d.ts

@@ -9,9 +9,11 @@ export * from './ClusterRequirementsRequest.js';
 export * from './ClusterRequirementsResponse.js';
 export * from './ClusterRequirementsStoredInput.js';
 export * from './ClusterSizing.js';
+export * from './ClusterUtilization.js';
 export * from './ComplexityDiskScoreEntry.js';
 export * from './ComplexityOSNameEntry.js';
 export * from './ComplexityOSScoreEntry.js';
+export * from './CpuOverCommitRatio.js';
 export * from './Customer.js';
 export * from './Datastore.js';
 export * from './DiskSizeTierSummary.js';
@@ -36,6 +38,7 @@ export * from './Label.js';
 export * from './Member.js';
 export * from './MemberCreate.js';
 export * from './MemberUpdate.js';
+export * from './MemoryOverCommitRatio.js';
 export * from './MigrationComplexityRequest.js';
 export * from './MigrationComplexityResponse.js';
 export * from './MigrationEstimationByComplexityResponse.js';
@@ -62,6 +65,8 @@ export * from './Source.js';
 export * from './SourceCreate.js';
 export * from './SourceInfra.js';
 export * from './SourceUpdate.js';
+export * from './StandaloneClusterRequirementsRequest.js';
+export * from './StandaloneClusterRequirementsResponse.js';
 export * from './Status.js';
 export * from './UpdateInventory.js';
 export * from './VCenter.js';

package/dist/models/index.js

@@ -27,9 +27,11 @@ __exportStar(require("./ClusterRequirementsRequest.js"), exports);
 __exportStar(require("./ClusterRequirementsResponse.js"), exports);
 __exportStar(require("./ClusterRequirementsStoredInput.js"), exports);
 __exportStar(require("./ClusterSizing.js"), exports);
+__exportStar(require("./ClusterUtilization.js"), exports);
 __exportStar(require("./ComplexityDiskScoreEntry.js"), exports);
 __exportStar(require("./ComplexityOSNameEntry.js"), exports);
 __exportStar(require("./ComplexityOSScoreEntry.js"), exports);
+__exportStar(require("./CpuOverCommitRatio.js"), exports);
 __exportStar(require("./Customer.js"), exports);
 __exportStar(require("./Datastore.js"), exports);
 __exportStar(require("./DiskSizeTierSummary.js"), exports);
@@ -54,6 +56,7 @@ __exportStar(require("./Label.js"), exports);
 __exportStar(require("./Member.js"), exports);
 __exportStar(require("./MemberCreate.js"), exports);
 __exportStar(require("./MemberUpdate.js"), exports);
+__exportStar(require("./MemoryOverCommitRatio.js"), exports);
 __exportStar(require("./MigrationComplexityRequest.js"), exports);
 __exportStar(require("./MigrationComplexityResponse.js"), exports);
 __exportStar(require("./MigrationEstimationByComplexityResponse.js"), exports);
@@ -80,6 +83,8 @@ __exportStar(require("./Source.js"), exports);
 __exportStar(require("./SourceCreate.js"), exports);
 __exportStar(require("./SourceInfra.js"), exports);
 __exportStar(require("./SourceUpdate.js"), exports);
+__exportStar(require("./StandaloneClusterRequirementsRequest.js"), exports);
+__exportStar(require("./StandaloneClusterRequirementsResponse.js"), exports);
 __exportStar(require("./Status.js"), exports);
 __exportStar(require("./UpdateInventory.js"), exports);
 __exportStar(require("./VCenter.js"), exports);

package/docs/ClusterRequirementsRequest.md

@@ -8,8 +8,8 @@ Request payload for calculating cluster requirements
 Name | Type
 ------------ | -------------
 `clusterId` | string
-`cpuOverCommitRatio` | string
-`memoryOverCommitRatio` | string
+`cpuOverCommitRatio` | [CpuOverCommitRatio](CpuOverCommitRatio.md)
+`memoryOverCommitRatio` | [MemoryOverCommitRatio](MemoryOverCommitRatio.md)
 `workerNodeCPU` | number
 `workerNodeMemory` | number
 `workerNodeThreads` | number

package/docs/ClusterUtilization.md

@@ -0,0 +1,46 @@
+
+# ClusterUtilization
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`cpuAvg` | number
+`cpuP95` | number
+`cpuMax` | number
+`memAvg` | number
+`memP95` | number
+`memMax` | number
+`confidence` | number
+
+## Example
+
+```typescript
+import type { ClusterUtilization } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "cpuAvg": null,
+  "cpuP95": null,
+  "cpuMax": null,
+  "memAvg": null,
+  "memP95": null,
+  "memMax": null,
+  "confidence": null,
+} satisfies ClusterUtilization
+
+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 ClusterUtilization
+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/CpuOverCommitRatio.md

@@ -0,0 +1,33 @@
+
+# CpuOverCommitRatio
+
+CPU over-commit ratio
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { CpuOverCommitRatio } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies CpuOverCommitRatio
+
+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 CpuOverCommitRatio
+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/InventoryData.md

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `vcenter` | [VCenter](VCenter.md)
 `clusterFeatures` | [ClusterFeatures](ClusterFeatures.md)
+`clusterUtilization` | [ClusterUtilization](ClusterUtilization.md)
 `vms` | [VMs](VMs.md)
 `infra` | [Infra](Infra.md)
 
@@ -20,6 +21,7 @@ import type { InventoryData } from '@openshift-migration-advisor/planner-sdk'
 const example = {
   "vcenter": null,
   "clusterFeatures": null,
+  "clusterUtilization": null,
   "vms": null,
   "infra": null,
 } satisfies InventoryData

package/docs/MemoryOverCommitRatio.md

@@ -0,0 +1,33 @@
+
+# MemoryOverCommitRatio
+
+Memory over-commit ratio
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { MemoryOverCommitRatio } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies MemoryOverCommitRatio
+
+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 MemoryOverCommitRatio
+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/SizingApi.md

@@ -0,0 +1,80 @@
+# SizingApi
+
+All URIs are relative to *https://raw.githubusercontent.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**calculateClusterRequirements**](SizingApi.md#calculateclusterrequirements) | **POST** /api/v1/cluster-requirements |  |
+
+
+
+## calculateClusterRequirements
+
+> StandaloneClusterRequirementsResponse calculateClusterRequirements(standaloneClusterRequirementsRequest)
+
+
+
+Calculate cluster requirements for hypothetical workload with inline inventory data (no assessment required)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SizingApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { CalculateClusterRequirementsRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new SizingApi();
+
+  const body = {
+    // StandaloneClusterRequirementsRequest
+    standaloneClusterRequirementsRequest: {"totalVMs":100,"totalCPU":400,"totalMemory":800,"cpuOverCommitRatio":"1:4","memoryOverCommitRatio":"1:2","workerNodeCPU":16,"workerNodeMemory":64},
+  } satisfies CalculateClusterRequirementsRequest;
+
+  try {
+    const data = await api.calculateClusterRequirements(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **standaloneClusterRequirementsRequest** | [StandaloneClusterRequirementsRequest](StandaloneClusterRequirementsRequest.md) |  | |
+
+### Return type
+
+[**StandaloneClusterRequirementsResponse**](StandaloneClusterRequirementsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Cluster requirements calculation successful |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **500** | Internal error |  -  |
+| **503** | Service Unavailable |  -  |
+
+[[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/StandaloneClusterRequirementsRequest.md

@@ -0,0 +1,59 @@
+
+# StandaloneClusterRequirementsRequest
+
+Request payload for calculating cluster requirements with inline inventory data (no assessment required)
+
+## Properties
+
+Name | Type
+------------ | -------------
+`totalVMs` | number
+`totalCPU` | number
+`totalMemory` | number
+`cpuOverCommitRatio` | [CpuOverCommitRatio](CpuOverCommitRatio.md)
+`memoryOverCommitRatio` | [MemoryOverCommitRatio](MemoryOverCommitRatio.md)
+`workerNodeCPU` | number
+`workerNodeMemory` | number
+`workerNodeThreads` | number
+`controlPlaneSchedulable` | boolean
+`controlPlaneCPU` | number
+`controlPlaneMemory` | number
+`controlPlaneNodeCount` | number
+`hostedControlPlane` | boolean
+
+## Example
+
+```typescript
+import type { StandaloneClusterRequirementsRequest } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "totalVMs": null,
+  "totalCPU": null,
+  "totalMemory": null,
+  "cpuOverCommitRatio": null,
+  "memoryOverCommitRatio": null,
+  "workerNodeCPU": null,
+  "workerNodeMemory": null,
+  "workerNodeThreads": null,
+  "controlPlaneSchedulable": null,
+  "controlPlaneCPU": null,
+  "controlPlaneMemory": null,
+  "controlPlaneNodeCount": null,
+  "hostedControlPlane": null,
+} satisfies StandaloneClusterRequirementsRequest
+
+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 StandaloneClusterRequirementsRequest
+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/StandaloneClusterRequirementsResponse.md

@@ -0,0 +1,37 @@
+
+# StandaloneClusterRequirementsResponse
+
+Sizing results; omits inventoryTotals (already in the request).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`clusterSizing` | [ClusterSizing](ClusterSizing.md)
+`resourceConsumption` | [SizingResourceConsumption](SizingResourceConsumption.md)
+
+## Example
+
+```typescript
+import type { StandaloneClusterRequirementsResponse } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "clusterSizing": null,
+  "resourceConsumption": null,
+} satisfies StandaloneClusterRequirementsResponse
+
+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 StandaloneClusterRequirementsResponse
+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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openshift-migration-advisor/planner-sdk",
-  "version": "0.13.3-391ade47acd8",
+  "version": "0.13.3-a0b90cb3da5f",
   "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/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'],