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

package/dist/models/StandaloneClusterRequirementsRequest.js

@@ -0,0 +1,96 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StandaloneClusterRequirementsRequestControlPlaneNodeCountEnum = void 0;
+exports.instanceOfStandaloneClusterRequirementsRequest = instanceOfStandaloneClusterRequirementsRequest;
+exports.StandaloneClusterRequirementsRequestFromJSON = StandaloneClusterRequirementsRequestFromJSON;
+exports.StandaloneClusterRequirementsRequestFromJSONTyped = StandaloneClusterRequirementsRequestFromJSONTyped;
+exports.StandaloneClusterRequirementsRequestToJSON = StandaloneClusterRequirementsRequestToJSON;
+exports.StandaloneClusterRequirementsRequestToJSONTyped = StandaloneClusterRequirementsRequestToJSONTyped;
+const CpuOverCommitRatio_js_1 = require("./CpuOverCommitRatio.js");
+const MemoryOverCommitRatio_js_1 = require("./MemoryOverCommitRatio.js");
+/**
+ * @export
+ */
+exports.StandaloneClusterRequirementsRequestControlPlaneNodeCountEnum = {
+    NUMBER_1: 1,
+    NUMBER_3: 3
+};
+/**
+ * Check if a given object implements the StandaloneClusterRequirementsRequest interface.
+ */
+function instanceOfStandaloneClusterRequirementsRequest(value) {
+    if (!('totalVMs' in value) || value['totalVMs'] === undefined)
+        return false;
+    if (!('totalCPU' in value) || value['totalCPU'] === undefined)
+        return false;
+    if (!('totalMemory' in value) || value['totalMemory'] === undefined)
+        return false;
+    if (!('cpuOverCommitRatio' in value) || value['cpuOverCommitRatio'] === undefined)
+        return false;
+    if (!('memoryOverCommitRatio' in value) || value['memoryOverCommitRatio'] === undefined)
+        return false;
+    if (!('workerNodeCPU' in value) || value['workerNodeCPU'] === undefined)
+        return false;
+    if (!('workerNodeMemory' in value) || value['workerNodeMemory'] === undefined)
+        return false;
+    return true;
+}
+function StandaloneClusterRequirementsRequestFromJSON(json) {
+    return StandaloneClusterRequirementsRequestFromJSONTyped(json, false);
+}
+function StandaloneClusterRequirementsRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'totalVMs': json['totalVMs'],
+        'totalCPU': json['totalCPU'],
+        'totalMemory': json['totalMemory'],
+        'cpuOverCommitRatio': (0, CpuOverCommitRatio_js_1.CpuOverCommitRatioFromJSON)(json['cpuOverCommitRatio']),
+        'memoryOverCommitRatio': (0, MemoryOverCommitRatio_js_1.MemoryOverCommitRatioFromJSON)(json['memoryOverCommitRatio']),
+        'workerNodeCPU': json['workerNodeCPU'],
+        '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'],
+        'controlPlaneNodeCount': json['controlPlaneNodeCount'] == null ? undefined : json['controlPlaneNodeCount'],
+        'hostedControlPlane': json['hostedControlPlane'] == null ? undefined : json['hostedControlPlane'],
+    };
+}
+function StandaloneClusterRequirementsRequestToJSON(json) {
+    return StandaloneClusterRequirementsRequestToJSONTyped(json, false);
+}
+function StandaloneClusterRequirementsRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'totalVMs': value['totalVMs'],
+        'totalCPU': value['totalCPU'],
+        'totalMemory': value['totalMemory'],
+        'cpuOverCommitRatio': (0, CpuOverCommitRatio_js_1.CpuOverCommitRatioToJSON)(value['cpuOverCommitRatio']),
+        'memoryOverCommitRatio': (0, MemoryOverCommitRatio_js_1.MemoryOverCommitRatioToJSON)(value['memoryOverCommitRatio']),
+        'workerNodeCPU': value['workerNodeCPU'],
+        'workerNodeMemory': value['workerNodeMemory'],
+        'workerNodeThreads': value['workerNodeThreads'],
+        'controlPlaneSchedulable': value['controlPlaneSchedulable'],
+        'controlPlaneCPU': value['controlPlaneCPU'],
+        'controlPlaneMemory': value['controlPlaneMemory'],
+        'controlPlaneNodeCount': value['controlPlaneNodeCount'],
+        'hostedControlPlane': value['hostedControlPlane'],
+    };
+}

package/dist/models/StandaloneClusterRequirementsResponse.d.ts

@@ -0,0 +1,40 @@
+/**
+ * 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 type { SizingResourceConsumption } from './SizingResourceConsumption.js';
+import type { ClusterSizing } from './ClusterSizing.js';
+/**
+ * Sizing results; omits inventoryTotals (already in the request).
+ * @export
+ * @interface StandaloneClusterRequirementsResponse
+ */
+export interface StandaloneClusterRequirementsResponse {
+    /**
+     *
+     * @type {ClusterSizing}
+     * @memberof StandaloneClusterRequirementsResponse
+     */
+    clusterSizing: ClusterSizing;
+    /**
+     *
+     * @type {SizingResourceConsumption}
+     * @memberof StandaloneClusterRequirementsResponse
+     */
+    resourceConsumption: SizingResourceConsumption;
+}
+/**
+ * Check if a given object implements the StandaloneClusterRequirementsResponse interface.
+ */
+export declare function instanceOfStandaloneClusterRequirementsResponse(value: object): value is StandaloneClusterRequirementsResponse;
+export declare function StandaloneClusterRequirementsResponseFromJSON(json: any): StandaloneClusterRequirementsResponse;
+export declare function StandaloneClusterRequirementsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): StandaloneClusterRequirementsResponse;
+export declare function StandaloneClusterRequirementsResponseToJSON(json: any): StandaloneClusterRequirementsResponse;
+export declare function StandaloneClusterRequirementsResponseToJSONTyped(value?: StandaloneClusterRequirementsResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/StandaloneClusterRequirementsResponse.js

@@ -0,0 +1,56 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfStandaloneClusterRequirementsResponse = instanceOfStandaloneClusterRequirementsResponse;
+exports.StandaloneClusterRequirementsResponseFromJSON = StandaloneClusterRequirementsResponseFromJSON;
+exports.StandaloneClusterRequirementsResponseFromJSONTyped = StandaloneClusterRequirementsResponseFromJSONTyped;
+exports.StandaloneClusterRequirementsResponseToJSON = StandaloneClusterRequirementsResponseToJSON;
+exports.StandaloneClusterRequirementsResponseToJSONTyped = StandaloneClusterRequirementsResponseToJSONTyped;
+const SizingResourceConsumption_js_1 = require("./SizingResourceConsumption.js");
+const ClusterSizing_js_1 = require("./ClusterSizing.js");
+/**
+ * Check if a given object implements the StandaloneClusterRequirementsResponse interface.
+ */
+function instanceOfStandaloneClusterRequirementsResponse(value) {
+    if (!('clusterSizing' in value) || value['clusterSizing'] === undefined)
+        return false;
+    if (!('resourceConsumption' in value) || value['resourceConsumption'] === undefined)
+        return false;
+    return true;
+}
+function StandaloneClusterRequirementsResponseFromJSON(json) {
+    return StandaloneClusterRequirementsResponseFromJSONTyped(json, false);
+}
+function StandaloneClusterRequirementsResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'clusterSizing': (0, ClusterSizing_js_1.ClusterSizingFromJSON)(json['clusterSizing']),
+        'resourceConsumption': (0, SizingResourceConsumption_js_1.SizingResourceConsumptionFromJSON)(json['resourceConsumption']),
+    };
+}
+function StandaloneClusterRequirementsResponseToJSON(json) {
+    return StandaloneClusterRequirementsResponseToJSONTyped(json, false);
+}
+function StandaloneClusterRequirementsResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'clusterSizing': (0, ClusterSizing_js_1.ClusterSizingToJSON)(value['clusterSizing']),
+        'resourceConsumption': (0, SizingResourceConsumption_js_1.SizingResourceConsumptionToJSON)(value['resourceConsumption']),
+    };
+}

package/dist/models/index.d.ts

@@ -4,6 +4,7 @@ export * from './Assessment.js';
 export * from './AssessmentForm.js';
 export * from './AssessmentSharing.js';
 export * from './AssessmentUpdate.js';
+export * from './ClusterFeatures.js';
 export * from './ClusterRequirementsRequest.js';
 export * from './ClusterRequirementsResponse.js';
 export * from './ClusterRequirementsStoredInput.js';
@@ -11,6 +12,7 @@ export * from './ClusterSizing.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';
@@ -35,6 +37,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';
@@ -61,6 +64,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

@@ -22,6 +22,7 @@ __exportStar(require("./Assessment.js"), exports);
 __exportStar(require("./AssessmentForm.js"), exports);
 __exportStar(require("./AssessmentSharing.js"), exports);
 __exportStar(require("./AssessmentUpdate.js"), exports);
+__exportStar(require("./ClusterFeatures.js"), exports);
 __exportStar(require("./ClusterRequirementsRequest.js"), exports);
 __exportStar(require("./ClusterRequirementsResponse.js"), exports);
 __exportStar(require("./ClusterRequirementsStoredInput.js"), exports);
@@ -29,6 +30,7 @@ __exportStar(require("./ClusterSizing.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);
@@ -53,6 +55,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);
@@ -79,6 +82,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/AccountApi.md

@@ -82,6 +82,7 @@ No authorization required
 | **201** | Created |  -  |
 | **400** | Bad Request |  -  |
 | **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
 | **500** | Internal error |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
@@ -155,6 +156,7 @@ No authorization required
 | **201** | Created |  -  |
 | **400** | Bad Request |  -  |
 | **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
 | **404** | Not Found |  -  |
 | **409** | Conflict |  -  |
 | **500** | Internal error |  -  |
@@ -226,6 +228,7 @@ No authorization required
 |-------------|-------------|------------------|
 | **200** | OK |  -  |
 | **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
 | **404** | Not Found |  -  |
 | **500** | Internal error |  -  |
 
@@ -296,6 +299,7 @@ No authorization required
 |-------------|-------------|------------------|
 | **200** | OK |  -  |
 | **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
 | **404** | Not Found |  -  |
 | **500** | Internal error |  -  |
 
@@ -427,6 +431,7 @@ No authorization required
 |-------------|-------------|------------------|
 | **200** | OK |  -  |
 | **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
 | **404** | Not Found |  -  |
 | **500** | Internal error |  -  |
 
@@ -503,6 +508,7 @@ No authorization required
 |-------------|-------------|------------------|
 | **200** | OK |  -  |
 | **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
 | **500** | Internal error |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
@@ -575,6 +581,7 @@ No authorization required
 |-------------|-------------|------------------|
 | **200** | OK |  -  |
 | **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
 | **400** | Bad Request |  -  |
 | **404** | Not Found |  -  |
 | **500** | Internal error |  -  |
@@ -650,6 +657,7 @@ No authorization required
 | **200** | OK |  -  |
 | **400** | Bad Request |  -  |
 | **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
 | **404** | Not Found |  -  |
 | **500** | Internal error |  -  |
 
@@ -727,6 +735,7 @@ No authorization required
 | **200** | OK |  -  |
 | **400** | Bad Request |  -  |
 | **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
 | **404** | Not Found |  -  |
 | **500** | Internal error |  -  |
 

package/docs/ClusterFeatures.md

@@ -0,0 +1,38 @@
+
+# ClusterFeatures
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`drsEnabled` | boolean
+`drsMode` | string
+`storageDrsEnabled` | boolean
+
+## Example
+
+```typescript
+import type { ClusterFeatures } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "drsEnabled": null,
+  "drsMode": null,
+  "storageDrsEnabled": null,
+} satisfies ClusterFeatures
+
+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 ClusterFeatures
+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/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/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/Inventory.md

@@ -7,6 +7,7 @@
 Name | Type
 ------------ | -------------
 `vcenterId` | string
+`vcenterVersion` | string
 `clusters` | [{ [key: string]: InventoryData; }](InventoryData.md)
 `vcenter` | [InventoryData](InventoryData.md)
 
@@ -18,6 +19,7 @@ import type { Inventory } from '@openshift-migration-advisor/planner-sdk'
 // TODO: Update the object below with actual values
 const example = {
   "vcenterId": null,
+  "vcenterVersion": null,
   "clusters": null,
   "vcenter": null,
 } satisfies Inventory

package/docs/InventoryData.md

@@ -7,6 +7,7 @@
 Name | Type
 ------------ | -------------
 `vcenter` | [VCenter](VCenter.md)
+`clusterFeatures` | [ClusterFeatures](ClusterFeatures.md)
 `vms` | [VMs](VMs.md)
 `infra` | [Infra](Infra.md)
 
@@ -18,6 +19,7 @@ import type { InventoryData } from '@openshift-migration-advisor/planner-sdk'
 // TODO: Update the object below with actual values
 const example = {
   "vcenter": null,
+  "clusterFeatures": null,
   "vms": null,
   "infra": null,
 } satisfies InventoryData

package/docs/JobStatus.md

@@ -1,7 +1,7 @@
 
 # JobStatus
 
-Job status:  * `pending` - Job is queued  * `parsing` - Parsing RVTools Excel file  * `validating` - Running OPA VM validations  * `completed` - Assessment created successfully  * `failed` - Job failed with error  * `cancelled` - Job was cancelled 
+Job status:  * `pending` - Job is queued  * `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 
 
 ## Properties
 

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)
+
+