@openshift-migration-advisor/planner-sdk 0.13.4 → 0.13.6-b314a1e352c6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/.openapi-generator/FILES +4 -0
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +5 -4
  4. package/dist/apis/SourceApi.d.ts +0 -30
  5. package/dist/apis/SourceApi.js +0 -36
  6. package/dist/esm/apis/SourceApi.d.ts +0 -30
  7. package/dist/esm/apis/SourceApi.js +0 -36
  8. package/dist/esm/models/ClusterRequirementsResponse.d.ts +20 -0
  9. package/dist/esm/models/ClusterRequirementsResponse.js +8 -0
  10. package/dist/esm/models/ClusterSizing.d.ts +18 -0
  11. package/dist/esm/models/ClusterSizing.js +6 -0
  12. package/dist/esm/models/OptimizationStatus.d.ts +48 -0
  13. package/dist/esm/models/OptimizationStatus.js +56 -0
  14. package/dist/esm/models/Savings.d.ts +44 -0
  15. package/dist/esm/models/Savings.js +51 -0
  16. package/dist/esm/models/index.d.ts +2 -0
  17. package/dist/esm/models/index.js +2 -0
  18. package/dist/esm/runtime.js +2 -1
  19. package/dist/models/ClusterRequirementsResponse.d.ts +20 -0
  20. package/dist/models/ClusterRequirementsResponse.js +8 -0
  21. package/dist/models/ClusterSizing.d.ts +18 -0
  22. package/dist/models/ClusterSizing.js +6 -0
  23. package/dist/models/OptimizationStatus.d.ts +48 -0
  24. package/dist/models/OptimizationStatus.js +64 -0
  25. package/dist/models/Savings.d.ts +44 -0
  26. package/dist/models/Savings.js +58 -0
  27. package/dist/models/index.d.ts +2 -0
  28. package/dist/models/index.js +2 -0
  29. package/dist/runtime.js +2 -1
  30. package/docs/ClusterRequirementsResponse.md +6 -0
  31. package/docs/ClusterSizing.md +6 -0
  32. package/docs/ImageApi.md +2 -0
  33. package/docs/OptimizationStatus.md +37 -0
  34. package/docs/Savings.md +39 -0
  35. package/docs/SourceApi.md +0 -62
  36. package/package.json +1 -1
  37. package/src/apis/SourceApi.ts +0 -62
  38. package/src/models/ClusterRequirementsResponse.ts +38 -0
  39. package/src/models/ClusterSizing.ts +24 -0
  40. package/src/models/OptimizationStatus.ts +88 -0
  41. package/src/models/Savings.ts +84 -0
  42. package/src/models/index.ts +2 -0
  43. package/src/runtime.ts +1 -1
@@ -9,9 +9,11 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { Savings } from './Savings.js';
12
13
  import type { SizingResourceConsumption } from './SizingResourceConsumption.js';
13
14
  import type { InventoryTotals } from './InventoryTotals.js';
14
15
  import type { ClusterSizing } from './ClusterSizing.js';
16
+ import type { OptimizationStatus } from './OptimizationStatus.js';
15
17
  /**
16
18
  * Cluster requirements calculation results
17
19
  * @export
@@ -24,6 +26,24 @@ export interface ClusterRequirementsResponse {
24
26
  * @memberof ClusterRequirementsResponse
25
27
  */
26
28
  clusterSizing: ClusterSizing;
29
+ /**
30
+ *
31
+ * @type {ClusterSizing}
32
+ * @memberof ClusterRequirementsResponse
33
+ */
34
+ optimizedSizing?: ClusterSizing;
35
+ /**
36
+ *
37
+ * @type {Savings}
38
+ * @memberof ClusterRequirementsResponse
39
+ */
40
+ savings?: Savings;
41
+ /**
42
+ *
43
+ * @type {OptimizationStatus}
44
+ * @memberof ClusterRequirementsResponse
45
+ */
46
+ optimizationStatus?: OptimizationStatus;
27
47
  /**
28
48
  *
29
49
  * @type {SizingResourceConsumption}
@@ -18,9 +18,11 @@ exports.ClusterRequirementsResponseFromJSON = ClusterRequirementsResponseFromJSO
18
18
  exports.ClusterRequirementsResponseFromJSONTyped = ClusterRequirementsResponseFromJSONTyped;
19
19
  exports.ClusterRequirementsResponseToJSON = ClusterRequirementsResponseToJSON;
20
20
  exports.ClusterRequirementsResponseToJSONTyped = ClusterRequirementsResponseToJSONTyped;
21
+ const Savings_js_1 = require("./Savings.js");
21
22
  const SizingResourceConsumption_js_1 = require("./SizingResourceConsumption.js");
22
23
  const InventoryTotals_js_1 = require("./InventoryTotals.js");
23
24
  const ClusterSizing_js_1 = require("./ClusterSizing.js");
25
+ const OptimizationStatus_js_1 = require("./OptimizationStatus.js");
24
26
  /**
25
27
  * Check if a given object implements the ClusterRequirementsResponse interface.
26
28
  */
@@ -42,6 +44,9 @@ function ClusterRequirementsResponseFromJSONTyped(json, ignoreDiscriminator) {
42
44
  }
43
45
  return {
44
46
  'clusterSizing': (0, ClusterSizing_js_1.ClusterSizingFromJSON)(json['clusterSizing']),
47
+ 'optimizedSizing': json['optimizedSizing'] == null ? undefined : (0, ClusterSizing_js_1.ClusterSizingFromJSON)(json['optimizedSizing']),
48
+ 'savings': json['savings'] == null ? undefined : (0, Savings_js_1.SavingsFromJSON)(json['savings']),
49
+ 'optimizationStatus': json['optimizationStatus'] == null ? undefined : (0, OptimizationStatus_js_1.OptimizationStatusFromJSON)(json['optimizationStatus']),
45
50
  'resourceConsumption': (0, SizingResourceConsumption_js_1.SizingResourceConsumptionFromJSON)(json['resourceConsumption']),
46
51
  'inventoryTotals': (0, InventoryTotals_js_1.InventoryTotalsFromJSON)(json['inventoryTotals']),
47
52
  };
@@ -55,6 +60,9 @@ function ClusterRequirementsResponseToJSONTyped(value, ignoreDiscriminator = fal
55
60
  }
56
61
  return {
57
62
  'clusterSizing': (0, ClusterSizing_js_1.ClusterSizingToJSON)(value['clusterSizing']),
63
+ 'optimizedSizing': (0, ClusterSizing_js_1.ClusterSizingToJSON)(value['optimizedSizing']),
64
+ 'savings': (0, Savings_js_1.SavingsToJSON)(value['savings']),
65
+ 'optimizationStatus': (0, OptimizationStatus_js_1.OptimizationStatusToJSON)(value['optimizationStatus']),
58
66
  'resourceConsumption': (0, SizingResourceConsumption_js_1.SizingResourceConsumptionToJSON)(value['resourceConsumption']),
59
67
  'inventoryTotals': (0, InventoryTotals_js_1.InventoryTotalsToJSON)(value['inventoryTotals']),
60
68
  };
@@ -51,6 +51,24 @@ export interface ClusterSizing {
51
51
  * @memberof ClusterSizing
52
52
  */
53
53
  totalMemory: number;
54
+ /**
55
+ * CPU utilization maximum percentage (only in optimized_sizing)
56
+ * @type {number}
57
+ * @memberof ClusterSizing
58
+ */
59
+ cpuUtilizationMax?: number;
60
+ /**
61
+ * Memory utilization maximum percentage (only in optimized_sizing)
62
+ * @type {number}
63
+ * @memberof ClusterSizing
64
+ */
65
+ memoryUtilizationMax?: number;
66
+ /**
67
+ * Data coverage confidence 0-100 (only in optimized_sizing)
68
+ * @type {number}
69
+ * @memberof ClusterSizing
70
+ */
71
+ confidence?: number;
54
72
  }
55
73
  /**
56
74
  * Check if a given object implements the ClusterSizing interface.
@@ -50,6 +50,9 @@ function ClusterSizingFromJSONTyped(json, ignoreDiscriminator) {
50
50
  'failoverNodes': json['failoverNodes'],
51
51
  'totalCPU': json['totalCPU'],
52
52
  'totalMemory': json['totalMemory'],
53
+ 'cpuUtilizationMax': json['cpuUtilizationMax'] == null ? undefined : json['cpuUtilizationMax'],
54
+ 'memoryUtilizationMax': json['memoryUtilizationMax'] == null ? undefined : json['memoryUtilizationMax'],
55
+ 'confidence': json['confidence'] == null ? undefined : json['confidence'],
53
56
  };
54
57
  }
55
58
  function ClusterSizingToJSON(json) {
@@ -66,5 +69,8 @@ function ClusterSizingToJSONTyped(value, ignoreDiscriminator = false) {
66
69
  'failoverNodes': value['failoverNodes'],
67
70
  'totalCPU': value['totalCPU'],
68
71
  'totalMemory': value['totalMemory'],
72
+ 'cpuUtilizationMax': value['cpuUtilizationMax'],
73
+ 'memoryUtilizationMax': value['memoryUtilizationMax'],
74
+ 'confidence': value['confidence'],
69
75
  };
70
76
  }
@@ -0,0 +1,48 @@
1
+ /**
2
+ * OpenShift Migration Advisor API
3
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ *
5
+ * The version of the OpenAPI document: v1alpha1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Status of utilization-based optimization attempt
14
+ * @export
15
+ * @interface OptimizationStatus
16
+ */
17
+ export interface OptimizationStatus {
18
+ /**
19
+ * Whether optimization was attempted based on available utilization data
20
+ * @type {boolean}
21
+ * @memberof OptimizationStatus
22
+ */
23
+ attempted: boolean;
24
+ /**
25
+ * Reason for optimization result
26
+ * @type {OptimizationStatusReasonEnum}
27
+ * @memberof OptimizationStatus
28
+ */
29
+ reason: OptimizationStatusReasonEnum;
30
+ }
31
+ /**
32
+ * @export
33
+ */
34
+ export declare const OptimizationStatusReasonEnum: {
35
+ readonly NoUtilizationData: "no_utilization_data";
36
+ readonly LowConfidence: "low_confidence";
37
+ readonly CalculationError: "calculation_error";
38
+ readonly Success: "success";
39
+ };
40
+ export type OptimizationStatusReasonEnum = typeof OptimizationStatusReasonEnum[keyof typeof OptimizationStatusReasonEnum];
41
+ /**
42
+ * Check if a given object implements the OptimizationStatus interface.
43
+ */
44
+ export declare function instanceOfOptimizationStatus(value: object): value is OptimizationStatus;
45
+ export declare function OptimizationStatusFromJSON(json: any): OptimizationStatus;
46
+ export declare function OptimizationStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): OptimizationStatus;
47
+ export declare function OptimizationStatusToJSON(json: any): OptimizationStatus;
48
+ export declare function OptimizationStatusToJSONTyped(value?: OptimizationStatus | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,64 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * OpenShift Migration Advisor API
6
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
+ *
8
+ * The version of the OpenAPI document: v1alpha1
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.OptimizationStatusReasonEnum = void 0;
17
+ exports.instanceOfOptimizationStatus = instanceOfOptimizationStatus;
18
+ exports.OptimizationStatusFromJSON = OptimizationStatusFromJSON;
19
+ exports.OptimizationStatusFromJSONTyped = OptimizationStatusFromJSONTyped;
20
+ exports.OptimizationStatusToJSON = OptimizationStatusToJSON;
21
+ exports.OptimizationStatusToJSONTyped = OptimizationStatusToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.OptimizationStatusReasonEnum = {
26
+ NoUtilizationData: 'no_utilization_data',
27
+ LowConfidence: 'low_confidence',
28
+ CalculationError: 'calculation_error',
29
+ Success: 'success'
30
+ };
31
+ /**
32
+ * Check if a given object implements the OptimizationStatus interface.
33
+ */
34
+ function instanceOfOptimizationStatus(value) {
35
+ if (!('attempted' in value) || value['attempted'] === undefined)
36
+ return false;
37
+ if (!('reason' in value) || value['reason'] === undefined)
38
+ return false;
39
+ return true;
40
+ }
41
+ function OptimizationStatusFromJSON(json) {
42
+ return OptimizationStatusFromJSONTyped(json, false);
43
+ }
44
+ function OptimizationStatusFromJSONTyped(json, ignoreDiscriminator) {
45
+ if (json == null) {
46
+ return json;
47
+ }
48
+ return {
49
+ 'attempted': json['attempted'],
50
+ 'reason': json['reason'],
51
+ };
52
+ }
53
+ function OptimizationStatusToJSON(json) {
54
+ return OptimizationStatusToJSONTyped(json, false);
55
+ }
56
+ function OptimizationStatusToJSONTyped(value, ignoreDiscriminator = false) {
57
+ if (value == null) {
58
+ return value;
59
+ }
60
+ return {
61
+ 'attempted': value['attempted'],
62
+ 'reason': value['reason'],
63
+ };
64
+ }
@@ -0,0 +1,44 @@
1
+ /**
2
+ * OpenShift Migration Advisor API
3
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ *
5
+ * The version of the OpenAPI document: v1alpha1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Infrastructure savings comparison
14
+ * @export
15
+ * @interface Savings
16
+ */
17
+ export interface Savings {
18
+ /**
19
+ * Number of nodes saved compared to baseline
20
+ * @type {number}
21
+ * @memberof Savings
22
+ */
23
+ nodesSaved: number;
24
+ /**
25
+ * Percentage reduction in nodes
26
+ * @type {number}
27
+ * @memberof Savings
28
+ */
29
+ percentageReduction: number;
30
+ /**
31
+ * Human-readable description of savings source
32
+ * @type {string}
33
+ * @memberof Savings
34
+ */
35
+ description: string;
36
+ }
37
+ /**
38
+ * Check if a given object implements the Savings interface.
39
+ */
40
+ export declare function instanceOfSavings(value: object): value is Savings;
41
+ export declare function SavingsFromJSON(json: any): Savings;
42
+ export declare function SavingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): Savings;
43
+ export declare function SavingsToJSON(json: any): Savings;
44
+ export declare function SavingsToJSONTyped(value?: Savings | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,58 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * OpenShift Migration Advisor API
6
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
+ *
8
+ * The version of the OpenAPI document: v1alpha1
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfSavings = instanceOfSavings;
17
+ exports.SavingsFromJSON = SavingsFromJSON;
18
+ exports.SavingsFromJSONTyped = SavingsFromJSONTyped;
19
+ exports.SavingsToJSON = SavingsToJSON;
20
+ exports.SavingsToJSONTyped = SavingsToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the Savings interface.
23
+ */
24
+ function instanceOfSavings(value) {
25
+ if (!('nodesSaved' in value) || value['nodesSaved'] === undefined)
26
+ return false;
27
+ if (!('percentageReduction' in value) || value['percentageReduction'] === undefined)
28
+ return false;
29
+ if (!('description' in value) || value['description'] === undefined)
30
+ return false;
31
+ return true;
32
+ }
33
+ function SavingsFromJSON(json) {
34
+ return SavingsFromJSONTyped(json, false);
35
+ }
36
+ function SavingsFromJSONTyped(json, ignoreDiscriminator) {
37
+ if (json == null) {
38
+ return json;
39
+ }
40
+ return {
41
+ 'nodesSaved': json['nodesSaved'],
42
+ 'percentageReduction': json['percentageReduction'],
43
+ 'description': json['description'],
44
+ };
45
+ }
46
+ function SavingsToJSON(json) {
47
+ return SavingsToJSONTyped(json, false);
48
+ }
49
+ function SavingsToJSONTyped(value, ignoreDiscriminator = false) {
50
+ if (value == null) {
51
+ return value;
52
+ }
53
+ return {
54
+ 'nodesSaved': value['nodesSaved'],
55
+ 'percentageReduction': value['percentageReduction'],
56
+ 'description': value['description'],
57
+ };
58
+ }
@@ -47,6 +47,7 @@ export * from './MigrationEstimationResponse.js';
47
47
  export * from './MigrationIssue.js';
48
48
  export * from './ModelError.js';
49
49
  export * from './Network.js';
50
+ export * from './OptimizationStatus.js';
50
51
  export * from './OsDiskEstimationEntry.js';
51
52
  export * from './OsInfo.js';
52
53
  export * from './PartnerRequest.js';
@@ -55,6 +56,7 @@ export * from './PartnerRequestStatus.js';
55
56
  export * from './PartnerRequestUpdate.js';
56
57
  export * from './PartnerSummary.js';
57
58
  export * from './PresignedUrl.js';
59
+ export * from './Savings.js';
58
60
  export * from './SchemaEstimationResult.js';
59
61
  export * from './SharingSubject.js';
60
62
  export * from './SizingOverCommitRatio.js';
@@ -65,6 +65,7 @@ __exportStar(require("./MigrationEstimationResponse.js"), exports);
65
65
  __exportStar(require("./MigrationIssue.js"), exports);
66
66
  __exportStar(require("./ModelError.js"), exports);
67
67
  __exportStar(require("./Network.js"), exports);
68
+ __exportStar(require("./OptimizationStatus.js"), exports);
68
69
  __exportStar(require("./OsDiskEstimationEntry.js"), exports);
69
70
  __exportStar(require("./OsInfo.js"), exports);
70
71
  __exportStar(require("./PartnerRequest.js"), exports);
@@ -73,6 +74,7 @@ __exportStar(require("./PartnerRequestStatus.js"), exports);
73
74
  __exportStar(require("./PartnerRequestUpdate.js"), exports);
74
75
  __exportStar(require("./PartnerSummary.js"), exports);
75
76
  __exportStar(require("./PresignedUrl.js"), exports);
77
+ __exportStar(require("./Savings.js"), exports);
76
78
  __exportStar(require("./SchemaEstimationResult.js"), exports);
77
79
  __exportStar(require("./SharingSubject.js"), exports);
78
80
  __exportStar(require("./SizingOverCommitRatio.js"), exports);
package/dist/runtime.js CHANGED
@@ -309,8 +309,9 @@ function mapValues(data, fn) {
309
309
  return result;
310
310
  }
311
311
  function canConsumeForm(consumes) {
312
+ var _a;
312
313
  for (const consume of consumes) {
313
- if ('multipart/form-data' === consume.contentType) {
314
+ if (((_a = consume.contentType) === null || _a === void 0 ? void 0 : _a.startsWith('multipart/form-data')) == true) {
314
315
  return true;
315
316
  }
316
317
  }
@@ -8,6 +8,9 @@ Cluster requirements calculation results
8
8
  Name | Type
9
9
  ------------ | -------------
10
10
  `clusterSizing` | [ClusterSizing](ClusterSizing.md)
11
+ `optimizedSizing` | [ClusterSizing](ClusterSizing.md)
12
+ `savings` | [Savings](Savings.md)
13
+ `optimizationStatus` | [OptimizationStatus](OptimizationStatus.md)
11
14
  `resourceConsumption` | [SizingResourceConsumption](SizingResourceConsumption.md)
12
15
  `inventoryTotals` | [InventoryTotals](InventoryTotals.md)
13
16
 
@@ -19,6 +22,9 @@ import type { ClusterRequirementsResponse } from '@openshift-migration-advisor/p
19
22
  // TODO: Update the object below with actual values
20
23
  const example = {
21
24
  "clusterSizing": null,
25
+ "optimizedSizing": null,
26
+ "savings": null,
27
+ "optimizationStatus": null,
22
28
  "resourceConsumption": null,
23
29
  "inventoryTotals": null,
24
30
  } satisfies ClusterRequirementsResponse
@@ -13,6 +13,9 @@ Name | Type
13
13
  `failoverNodes` | number
14
14
  `totalCPU` | number
15
15
  `totalMemory` | number
16
+ `cpuUtilizationMax` | number
17
+ `memoryUtilizationMax` | number
18
+ `confidence` | number
16
19
 
17
20
  ## Example
18
21
 
@@ -27,6 +30,9 @@ const example = {
27
30
  "failoverNodes": null,
28
31
  "totalCPU": null,
29
32
  "totalMemory": null,
33
+ "cpuUtilizationMax": null,
34
+ "memoryUtilizationMax": null,
35
+ "confidence": null,
30
36
  } satisfies ClusterSizing
31
37
 
32
38
  console.log(example)
package/docs/ImageApi.md CHANGED
@@ -74,7 +74,9 @@ No authorization required
74
74
  | **200** | URL to download OVA image | - |
75
75
  | **400** | Bad Request | - |
76
76
  | **401** | Unauthorized | - |
77
+ | **403** | Forbidden | - |
77
78
  | **404** | NotFound | - |
79
+ | **500** | Internal error | - |
78
80
 
79
81
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
80
82
 
@@ -0,0 +1,37 @@
1
+
2
+ # OptimizationStatus
3
+
4
+ Status of utilization-based optimization attempt
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `attempted` | boolean
11
+ `reason` | string
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { OptimizationStatus } from '@openshift-migration-advisor/planner-sdk'
17
+
18
+ // TODO: Update the object below with actual values
19
+ const example = {
20
+ "attempted": null,
21
+ "reason": null,
22
+ } satisfies OptimizationStatus
23
+
24
+ console.log(example)
25
+
26
+ // Convert the instance to a JSON string
27
+ const exampleJSON: string = JSON.stringify(example)
28
+ console.log(exampleJSON)
29
+
30
+ // Parse the JSON string back to an object
31
+ const exampleParsed = JSON.parse(exampleJSON) as OptimizationStatus
32
+ console.log(exampleParsed)
33
+ ```
34
+
35
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
36
+
37
+
@@ -0,0 +1,39 @@
1
+
2
+ # Savings
3
+
4
+ Infrastructure savings comparison
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `nodesSaved` | number
11
+ `percentageReduction` | number
12
+ `description` | string
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import type { Savings } from '@openshift-migration-advisor/planner-sdk'
18
+
19
+ // TODO: Update the object below with actual values
20
+ const example = {
21
+ "nodesSaved": null,
22
+ "percentageReduction": null,
23
+ "description": null,
24
+ } satisfies Savings
25
+
26
+ console.log(example)
27
+
28
+ // Convert the instance to a JSON string
29
+ const exampleJSON: string = JSON.stringify(example)
30
+ console.log(exampleJSON)
31
+
32
+ // Parse the JSON string back to an object
33
+ const exampleParsed = JSON.parse(exampleJSON) as Savings
34
+ console.log(exampleParsed)
35
+ ```
36
+
37
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
38
+
39
+
package/docs/SourceApi.md CHANGED
@@ -6,7 +6,6 @@ All URIs are relative to *https://raw.githubusercontent.com*
6
6
  |------------- | ------------- | -------------|
7
7
  | [**createSource**](SourceApi.md#createsource) | **POST** /api/v1/sources | |
8
8
  | [**deleteSource**](SourceApi.md#deletesource) | **DELETE** /api/v1/sources/{id} | |
9
- | [**deleteSources**](SourceApi.md#deletesources) | **DELETE** /api/v1/sources | |
10
9
  | [**getSource**](SourceApi.md#getsource) | **GET** /api/v1/sources/{id} | |
11
10
  | [**listSources**](SourceApi.md#listsources) | **GET** /api/v1/sources | |
12
11
  | [**updateInventory**](SourceApi.md#updateinventory) | **PUT** /api/v1/sources/{id}/inventory | |
@@ -156,67 +155,6 @@ No authorization required
156
155
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
157
156
 
158
157
 
159
- ## deleteSources
160
-
161
- > Status deleteSources()
162
-
163
-
164
-
165
- delete a collection of sources
166
-
167
- ### Example
168
-
169
- ```ts
170
- import {
171
- Configuration,
172
- SourceApi,
173
- } from '@openshift-migration-advisor/planner-sdk';
174
- import type { DeleteSourcesRequest } from '@openshift-migration-advisor/planner-sdk';
175
-
176
- async function example() {
177
- console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
178
- const api = new SourceApi();
179
-
180
- try {
181
- const data = await api.deleteSources();
182
- console.log(data);
183
- } catch (error) {
184
- console.error(error);
185
- }
186
- }
187
-
188
- // Run the test
189
- example().catch(console.error);
190
- ```
191
-
192
- ### Parameters
193
-
194
- This endpoint does not need any parameter.
195
-
196
- ### Return type
197
-
198
- [**Status**](Status.md)
199
-
200
- ### Authorization
201
-
202
- No authorization required
203
-
204
- ### HTTP request headers
205
-
206
- - **Content-Type**: Not defined
207
- - **Accept**: `application/json`
208
-
209
-
210
- ### HTTP response details
211
- | Status code | Description | Response headers |
212
- |-------------|-------------|------------------|
213
- | **200** | OK | - |
214
- | **401** | Unauthorized | - |
215
- | **500** | Internal error | - |
216
-
217
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
218
-
219
-
220
158
  ## getSource
221
159
 
222
160
  > Source getSource(id)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openshift-migration-advisor/planner-sdk",
3
- "version": "0.13.4",
3
+ "version": "0.13.6-b314a1e352c6",
4
4
  "description": "OpenAPI client for @openshift-migration-advisor/planner-sdk",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -28,11 +28,6 @@ import {
28
28
  SourceUpdateFromJSON,
29
29
  SourceUpdateToJSON,
30
30
  } from '../models/SourceUpdate.js';
31
- import {
32
- type Status,
33
- StatusFromJSON,
34
- StatusToJSON,
35
- } from '../models/Status.js';
36
31
  import {
37
32
  type UpdateInventory,
38
33
  UpdateInventoryFromJSON,
@@ -112,26 +107,6 @@ export interface SourceApiInterface {
112
107
  */
113
108
  deleteSource(requestParameters: DeleteSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Source>;
114
109
 
115
- /**
116
- * Creates request options for deleteSources without sending the request
117
- * @throws {RequiredError}
118
- * @memberof SourceApiInterface
119
- */
120
- deleteSourcesRequestOpts(): Promise<runtime.RequestOpts>;
121
-
122
- /**
123
- * delete a collection of sources
124
- * @param {*} [options] Override http request option.
125
- * @throws {RequiredError}
126
- * @memberof SourceApiInterface
127
- */
128
- deleteSourcesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Status>>;
129
-
130
- /**
131
- * delete a collection of sources
132
- */
133
- deleteSources(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Status>;
134
-
135
110
  /**
136
111
  * Creates request options for getSource without sending the request
137
112
  * @param {string} id ID of the source
@@ -321,43 +296,6 @@ export class SourceApi extends runtime.BaseAPI implements SourceApiInterface {
321
296
  return await response.value();
322
297
  }
323
298
 
324
- /**
325
- * Creates request options for deleteSources without sending the request
326
- */
327
- async deleteSourcesRequestOpts(): Promise<runtime.RequestOpts> {
328
- const queryParameters: any = {};
329
-
330
- const headerParameters: runtime.HTTPHeaders = {};
331
-
332
-
333
- let urlPath = `/api/v1/sources`;
334
-
335
- return {
336
- path: urlPath,
337
- method: 'DELETE',
338
- headers: headerParameters,
339
- query: queryParameters,
340
- };
341
- }
342
-
343
- /**
344
- * delete a collection of sources
345
- */
346
- async deleteSourcesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Status>> {
347
- const requestOptions = await this.deleteSourcesRequestOpts();
348
- const response = await this.request(requestOptions, initOverrides);
349
-
350
- return new runtime.JSONApiResponse(response, (jsonValue) => StatusFromJSON(jsonValue));
351
- }
352
-
353
- /**
354
- * delete a collection of sources
355
- */
356
- async deleteSources(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Status> {
357
- const response = await this.deleteSourcesRaw(initOverrides);
358
- return await response.value();
359
- }
360
-
361
299
  /**
362
300
  * Creates request options for getSource without sending the request
363
301
  */