@openshift-migration-advisor/agent-sdk 0.12.0-4e95135f8529 → 0.12.0-63f65d8f0324
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.
- package/.openapi-generator/FILES +6 -0
- package/README.md +6 -2
- package/dist/apis/DefaultApi.d.ts +34 -0
- package/dist/apis/DefaultApi.js +38 -0
- package/dist/esm/apis/DefaultApi.d.ts +34 -0
- package/dist/esm/apis/DefaultApi.js +38 -0
- package/dist/esm/models/CapabilityStatus.d.ts +33 -0
- package/dist/esm/models/CapabilityStatus.js +44 -0
- package/dist/esm/models/CapabilityStatusCapabilities.d.ts +45 -0
- package/dist/esm/models/CapabilityStatusCapabilities.js +52 -0
- package/dist/esm/models/OperationCapability.d.ts +38 -0
- package/dist/esm/models/OperationCapability.js +45 -0
- package/dist/esm/models/VmInspectionStatus.d.ts +6 -0
- package/dist/esm/models/VmInspectionStatus.js +4 -0
- package/dist/esm/models/index.d.ts +3 -0
- package/dist/esm/models/index.js +3 -0
- package/dist/models/CapabilityStatus.d.ts +33 -0
- package/dist/models/CapabilityStatus.js +51 -0
- package/dist/models/CapabilityStatusCapabilities.d.ts +45 -0
- package/dist/models/CapabilityStatusCapabilities.js +59 -0
- package/dist/models/OperationCapability.d.ts +38 -0
- package/dist/models/OperationCapability.js +52 -0
- package/dist/models/VmInspectionStatus.d.ts +6 -0
- package/dist/models/VmInspectionStatus.js +4 -0
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/docs/CapabilityStatus.md +34 -0
- package/docs/CapabilityStatusCapabilities.md +38 -0
- package/docs/DefaultApi.md +65 -3
- package/docs/OperationCapability.md +36 -0
- package/docs/VmInspectionStatus.md +2 -0
- package/package.json +1 -1
- package/src/apis/DefaultApi.ts +66 -0
- package/src/models/CapabilityStatus.ts +74 -0
- package/src/models/CapabilityStatusCapabilities.ts +92 -0
- package/src/models/OperationCapability.ts +74 -0
- package/src/models/VmInspectionStatus.ts +9 -0
- package/src/models/index.ts +3 -0
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Assisted Migration Agent API
|
|
6
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: v1
|
|
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.instanceOfCapabilityStatus = instanceOfCapabilityStatus;
|
|
17
|
+
exports.CapabilityStatusFromJSON = CapabilityStatusFromJSON;
|
|
18
|
+
exports.CapabilityStatusFromJSONTyped = CapabilityStatusFromJSONTyped;
|
|
19
|
+
exports.CapabilityStatusToJSON = CapabilityStatusToJSON;
|
|
20
|
+
exports.CapabilityStatusToJSONTyped = CapabilityStatusToJSONTyped;
|
|
21
|
+
const CapabilityStatusCapabilities_js_1 = require("./CapabilityStatusCapabilities.js");
|
|
22
|
+
/**
|
|
23
|
+
* Check if a given object implements the CapabilityStatus interface.
|
|
24
|
+
*/
|
|
25
|
+
function instanceOfCapabilityStatus(value) {
|
|
26
|
+
if (!('capabilities' in value) || value['capabilities'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
return true;
|
|
29
|
+
}
|
|
30
|
+
function CapabilityStatusFromJSON(json) {
|
|
31
|
+
return CapabilityStatusFromJSONTyped(json, false);
|
|
32
|
+
}
|
|
33
|
+
function CapabilityStatusFromJSONTyped(json, ignoreDiscriminator) {
|
|
34
|
+
if (json == null) {
|
|
35
|
+
return json;
|
|
36
|
+
}
|
|
37
|
+
return {
|
|
38
|
+
'capabilities': (0, CapabilityStatusCapabilities_js_1.CapabilityStatusCapabilitiesFromJSON)(json['capabilities']),
|
|
39
|
+
};
|
|
40
|
+
}
|
|
41
|
+
function CapabilityStatusToJSON(json) {
|
|
42
|
+
return CapabilityStatusToJSONTyped(json, false);
|
|
43
|
+
}
|
|
44
|
+
function CapabilityStatusToJSONTyped(value, ignoreDiscriminator = false) {
|
|
45
|
+
if (value == null) {
|
|
46
|
+
return value;
|
|
47
|
+
}
|
|
48
|
+
return {
|
|
49
|
+
'capabilities': (0, CapabilityStatusCapabilities_js_1.CapabilityStatusCapabilitiesToJSON)(value['capabilities']),
|
|
50
|
+
};
|
|
51
|
+
}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Assisted Migration Agent API
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v1
|
|
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
|
+
import type { OperationCapability } from './OperationCapability.js';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface CapabilityStatusCapabilities
|
|
17
|
+
*/
|
|
18
|
+
export interface CapabilityStatusCapabilities {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {OperationCapability}
|
|
22
|
+
* @memberof CapabilityStatusCapabilities
|
|
23
|
+
*/
|
|
24
|
+
collector: OperationCapability;
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @type {OperationCapability}
|
|
28
|
+
* @memberof CapabilityStatusCapabilities
|
|
29
|
+
*/
|
|
30
|
+
inspector: OperationCapability;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @type {OperationCapability}
|
|
34
|
+
* @memberof CapabilityStatusCapabilities
|
|
35
|
+
*/
|
|
36
|
+
forecaster: OperationCapability;
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Check if a given object implements the CapabilityStatusCapabilities interface.
|
|
40
|
+
*/
|
|
41
|
+
export declare function instanceOfCapabilityStatusCapabilities(value: object): value is CapabilityStatusCapabilities;
|
|
42
|
+
export declare function CapabilityStatusCapabilitiesFromJSON(json: any): CapabilityStatusCapabilities;
|
|
43
|
+
export declare function CapabilityStatusCapabilitiesFromJSONTyped(json: any, ignoreDiscriminator: boolean): CapabilityStatusCapabilities;
|
|
44
|
+
export declare function CapabilityStatusCapabilitiesToJSON(json: any): CapabilityStatusCapabilities;
|
|
45
|
+
export declare function CapabilityStatusCapabilitiesToJSONTyped(value?: CapabilityStatusCapabilities | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Assisted Migration Agent API
|
|
6
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: v1
|
|
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.instanceOfCapabilityStatusCapabilities = instanceOfCapabilityStatusCapabilities;
|
|
17
|
+
exports.CapabilityStatusCapabilitiesFromJSON = CapabilityStatusCapabilitiesFromJSON;
|
|
18
|
+
exports.CapabilityStatusCapabilitiesFromJSONTyped = CapabilityStatusCapabilitiesFromJSONTyped;
|
|
19
|
+
exports.CapabilityStatusCapabilitiesToJSON = CapabilityStatusCapabilitiesToJSON;
|
|
20
|
+
exports.CapabilityStatusCapabilitiesToJSONTyped = CapabilityStatusCapabilitiesToJSONTyped;
|
|
21
|
+
const OperationCapability_js_1 = require("./OperationCapability.js");
|
|
22
|
+
/**
|
|
23
|
+
* Check if a given object implements the CapabilityStatusCapabilities interface.
|
|
24
|
+
*/
|
|
25
|
+
function instanceOfCapabilityStatusCapabilities(value) {
|
|
26
|
+
if (!('collector' in value) || value['collector'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
if (!('inspector' in value) || value['inspector'] === undefined)
|
|
29
|
+
return false;
|
|
30
|
+
if (!('forecaster' in value) || value['forecaster'] === undefined)
|
|
31
|
+
return false;
|
|
32
|
+
return true;
|
|
33
|
+
}
|
|
34
|
+
function CapabilityStatusCapabilitiesFromJSON(json) {
|
|
35
|
+
return CapabilityStatusCapabilitiesFromJSONTyped(json, false);
|
|
36
|
+
}
|
|
37
|
+
function CapabilityStatusCapabilitiesFromJSONTyped(json, ignoreDiscriminator) {
|
|
38
|
+
if (json == null) {
|
|
39
|
+
return json;
|
|
40
|
+
}
|
|
41
|
+
return {
|
|
42
|
+
'collector': (0, OperationCapability_js_1.OperationCapabilityFromJSON)(json['collector']),
|
|
43
|
+
'inspector': (0, OperationCapability_js_1.OperationCapabilityFromJSON)(json['inspector']),
|
|
44
|
+
'forecaster': (0, OperationCapability_js_1.OperationCapabilityFromJSON)(json['forecaster']),
|
|
45
|
+
};
|
|
46
|
+
}
|
|
47
|
+
function CapabilityStatusCapabilitiesToJSON(json) {
|
|
48
|
+
return CapabilityStatusCapabilitiesToJSONTyped(json, false);
|
|
49
|
+
}
|
|
50
|
+
function CapabilityStatusCapabilitiesToJSONTyped(value, ignoreDiscriminator = false) {
|
|
51
|
+
if (value == null) {
|
|
52
|
+
return value;
|
|
53
|
+
}
|
|
54
|
+
return {
|
|
55
|
+
'collector': (0, OperationCapability_js_1.OperationCapabilityToJSON)(value['collector']),
|
|
56
|
+
'inspector': (0, OperationCapability_js_1.OperationCapabilityToJSON)(value['inspector']),
|
|
57
|
+
'forecaster': (0, OperationCapability_js_1.OperationCapabilityToJSON)(value['forecaster']),
|
|
58
|
+
};
|
|
59
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Assisted Migration Agent API
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v1
|
|
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
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface OperationCapability
|
|
16
|
+
*/
|
|
17
|
+
export interface OperationCapability {
|
|
18
|
+
/**
|
|
19
|
+
* Whether stored credentials have sufficient privileges
|
|
20
|
+
* @type {boolean}
|
|
21
|
+
* @memberof OperationCapability
|
|
22
|
+
*/
|
|
23
|
+
enabled: boolean;
|
|
24
|
+
/**
|
|
25
|
+
* Specific vSphere privileges that are missing
|
|
26
|
+
* @type {Array<string>}
|
|
27
|
+
* @memberof OperationCapability
|
|
28
|
+
*/
|
|
29
|
+
missingPrivileges?: Array<string>;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Check if a given object implements the OperationCapability interface.
|
|
33
|
+
*/
|
|
34
|
+
export declare function instanceOfOperationCapability(value: object): value is OperationCapability;
|
|
35
|
+
export declare function OperationCapabilityFromJSON(json: any): OperationCapability;
|
|
36
|
+
export declare function OperationCapabilityFromJSONTyped(json: any, ignoreDiscriminator: boolean): OperationCapability;
|
|
37
|
+
export declare function OperationCapabilityToJSON(json: any): OperationCapability;
|
|
38
|
+
export declare function OperationCapabilityToJSONTyped(value?: OperationCapability | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Assisted Migration Agent API
|
|
6
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: v1
|
|
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.instanceOfOperationCapability = instanceOfOperationCapability;
|
|
17
|
+
exports.OperationCapabilityFromJSON = OperationCapabilityFromJSON;
|
|
18
|
+
exports.OperationCapabilityFromJSONTyped = OperationCapabilityFromJSONTyped;
|
|
19
|
+
exports.OperationCapabilityToJSON = OperationCapabilityToJSON;
|
|
20
|
+
exports.OperationCapabilityToJSONTyped = OperationCapabilityToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the OperationCapability interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfOperationCapability(value) {
|
|
25
|
+
if (!('enabled' in value) || value['enabled'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
return true;
|
|
28
|
+
}
|
|
29
|
+
function OperationCapabilityFromJSON(json) {
|
|
30
|
+
return OperationCapabilityFromJSONTyped(json, false);
|
|
31
|
+
}
|
|
32
|
+
function OperationCapabilityFromJSONTyped(json, ignoreDiscriminator) {
|
|
33
|
+
if (json == null) {
|
|
34
|
+
return json;
|
|
35
|
+
}
|
|
36
|
+
return {
|
|
37
|
+
'enabled': json['enabled'],
|
|
38
|
+
'missingPrivileges': json['missingPrivileges'] == null ? undefined : json['missingPrivileges'],
|
|
39
|
+
};
|
|
40
|
+
}
|
|
41
|
+
function OperationCapabilityToJSON(json) {
|
|
42
|
+
return OperationCapabilityToJSONTyped(json, false);
|
|
43
|
+
}
|
|
44
|
+
function OperationCapabilityToJSONTyped(value, ignoreDiscriminator = false) {
|
|
45
|
+
if (value == null) {
|
|
46
|
+
return value;
|
|
47
|
+
}
|
|
48
|
+
return {
|
|
49
|
+
'enabled': value['enabled'],
|
|
50
|
+
'missingPrivileges': value['missingPrivileges'],
|
|
51
|
+
};
|
|
52
|
+
}
|
|
@@ -21,6 +21,12 @@ export interface VmInspectionStatus {
|
|
|
21
21
|
* @memberof VmInspectionStatus
|
|
22
22
|
*/
|
|
23
23
|
state: VmInspectionStatusStateEnum;
|
|
24
|
+
/**
|
|
25
|
+
* State details
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof VmInspectionStatus
|
|
28
|
+
*/
|
|
29
|
+
message: string;
|
|
24
30
|
/**
|
|
25
31
|
* Error message when state is error
|
|
26
32
|
* @type {string}
|
|
@@ -35,6 +35,8 @@ exports.VmInspectionStatusStateEnum = {
|
|
|
35
35
|
function instanceOfVmInspectionStatus(value) {
|
|
36
36
|
if (!('state' in value) || value['state'] === undefined)
|
|
37
37
|
return false;
|
|
38
|
+
if (!('message' in value) || value['message'] === undefined)
|
|
39
|
+
return false;
|
|
38
40
|
return true;
|
|
39
41
|
}
|
|
40
42
|
function VmInspectionStatusFromJSON(json) {
|
|
@@ -46,6 +48,7 @@ function VmInspectionStatusFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
46
48
|
}
|
|
47
49
|
return {
|
|
48
50
|
'state': json['state'],
|
|
51
|
+
'message': json['message'],
|
|
49
52
|
'error': json['error'] == null ? undefined : json['error'],
|
|
50
53
|
'results': json['results'] == null ? undefined : json['results'],
|
|
51
54
|
};
|
|
@@ -59,6 +62,7 @@ function VmInspectionStatusToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
59
62
|
}
|
|
60
63
|
return {
|
|
61
64
|
'state': value['state'],
|
|
65
|
+
'message': value['message'],
|
|
62
66
|
'error': value['error'],
|
|
63
67
|
'results': value['results'],
|
|
64
68
|
};
|
package/dist/models/index.d.ts
CHANGED
|
@@ -4,6 +4,8 @@ export * from './ApplicationListResponse.js';
|
|
|
4
4
|
export * from './ApplicationOverview.js';
|
|
5
5
|
export * from './ApplicationVM.js';
|
|
6
6
|
export * from './BenchmarkRun.js';
|
|
7
|
+
export * from './CapabilityStatus.js';
|
|
8
|
+
export * from './CapabilityStatusCapabilities.js';
|
|
7
9
|
export * from './ClusterFeatures.js';
|
|
8
10
|
export * from './ClusterUtilization.js';
|
|
9
11
|
export * from './CollectorStartRequest.js';
|
|
@@ -35,6 +37,7 @@ export * from './Inventory.js';
|
|
|
35
37
|
export * from './InventoryData.js';
|
|
36
38
|
export * from './MigrationIssue.js';
|
|
37
39
|
export * from './Network.js';
|
|
40
|
+
export * from './OperationCapability.js';
|
|
38
41
|
export * from './OsInfo.js';
|
|
39
42
|
export * from './PairCapability.js';
|
|
40
43
|
export * from './PairCapabilityRequest.js';
|
package/dist/models/index.js
CHANGED
|
@@ -22,6 +22,8 @@ __exportStar(require("./ApplicationListResponse.js"), exports);
|
|
|
22
22
|
__exportStar(require("./ApplicationOverview.js"), exports);
|
|
23
23
|
__exportStar(require("./ApplicationVM.js"), exports);
|
|
24
24
|
__exportStar(require("./BenchmarkRun.js"), exports);
|
|
25
|
+
__exportStar(require("./CapabilityStatus.js"), exports);
|
|
26
|
+
__exportStar(require("./CapabilityStatusCapabilities.js"), exports);
|
|
25
27
|
__exportStar(require("./ClusterFeatures.js"), exports);
|
|
26
28
|
__exportStar(require("./ClusterUtilization.js"), exports);
|
|
27
29
|
__exportStar(require("./CollectorStartRequest.js"), exports);
|
|
@@ -53,6 +55,7 @@ __exportStar(require("./Inventory.js"), exports);
|
|
|
53
55
|
__exportStar(require("./InventoryData.js"), exports);
|
|
54
56
|
__exportStar(require("./MigrationIssue.js"), exports);
|
|
55
57
|
__exportStar(require("./Network.js"), exports);
|
|
58
|
+
__exportStar(require("./OperationCapability.js"), exports);
|
|
56
59
|
__exportStar(require("./OsInfo.js"), exports);
|
|
57
60
|
__exportStar(require("./PairCapability.js"), exports);
|
|
58
61
|
__exportStar(require("./PairCapabilityRequest.js"), exports);
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# CapabilityStatus
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`capabilities` | [CapabilityStatusCapabilities](CapabilityStatusCapabilities.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { CapabilityStatus } from '@openshift-migration-advisor/agent-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"capabilities": null,
|
|
19
|
+
} satisfies CapabilityStatus
|
|
20
|
+
|
|
21
|
+
console.log(example)
|
|
22
|
+
|
|
23
|
+
// Convert the instance to a JSON string
|
|
24
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
25
|
+
console.log(exampleJSON)
|
|
26
|
+
|
|
27
|
+
// Parse the JSON string back to an object
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as CapabilityStatus
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
33
|
+
|
|
34
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# CapabilityStatusCapabilities
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`collector` | [OperationCapability](OperationCapability.md)
|
|
10
|
+
`inspector` | [OperationCapability](OperationCapability.md)
|
|
11
|
+
`forecaster` | [OperationCapability](OperationCapability.md)
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { CapabilityStatusCapabilities } from '@openshift-migration-advisor/agent-sdk'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"collector": null,
|
|
21
|
+
"inspector": null,
|
|
22
|
+
"forecaster": null,
|
|
23
|
+
} satisfies CapabilityStatusCapabilities
|
|
24
|
+
|
|
25
|
+
console.log(example)
|
|
26
|
+
|
|
27
|
+
// Convert the instance to a JSON string
|
|
28
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
29
|
+
console.log(exampleJSON)
|
|
30
|
+
|
|
31
|
+
// Parse the JSON string back to an object
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as CapabilityStatusCapabilities
|
|
33
|
+
console.log(exampleParsed)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
37
|
+
|
|
38
|
+
|
package/docs/DefaultApi.md
CHANGED
|
@@ -13,6 +13,7 @@ All URIs are relative to *https://raw.githubusercontent.com/api/v1*
|
|
|
13
13
|
| [**getApplications**](DefaultApi.md#getapplications) | **GET** /applications | List detected applications running on VMs |
|
|
14
14
|
| [**getClusterUtilization**](DefaultApi.md#getclusterutilization) | **GET** /clusters/{cluster_id}/utilization | Get latest cluster utilization by cluster ID |
|
|
15
15
|
| [**getCollectorStatus**](DefaultApi.md#getcollectorstatus) | **GET** /collector | Get collector status |
|
|
16
|
+
| [**getCredentialCapabilities**](DefaultApi.md#getcredentialcapabilities) | **GET** /credentials/capabilities | Check vSphere operation capabilities |
|
|
16
17
|
| [**getCredentials**](DefaultApi.md#getcredentials) | **GET** /credentials | Get stored credential status |
|
|
17
18
|
| [**getForecasterDatastores**](DefaultApi.md#getforecasterdatastores) | **POST** /forecaster/datastores | List available datastores |
|
|
18
19
|
| [**getForecasterRuns**](DefaultApi.md#getforecasterruns) | **GET** /forecaster/runs | List benchmark runs |
|
|
@@ -272,7 +273,7 @@ async function example() {
|
|
|
272
273
|
|
|
273
274
|
const body = {
|
|
274
275
|
// string | Group ID
|
|
275
|
-
id:
|
|
276
|
+
id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
276
277
|
} satisfies DeleteGroupRequest;
|
|
277
278
|
|
|
278
279
|
try {
|
|
@@ -626,6 +627,67 @@ No authorization required
|
|
|
626
627
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
627
628
|
|
|
628
629
|
|
|
630
|
+
## getCredentialCapabilities
|
|
631
|
+
|
|
632
|
+
> CapabilityStatus getCredentialCapabilities()
|
|
633
|
+
|
|
634
|
+
Check vSphere operation capabilities
|
|
635
|
+
|
|
636
|
+
Checks vSphere privileges for all operations (collector, inspector, forecaster) using stored credentials. Single live vSphere check, no caching.
|
|
637
|
+
|
|
638
|
+
### Example
|
|
639
|
+
|
|
640
|
+
```ts
|
|
641
|
+
import {
|
|
642
|
+
Configuration,
|
|
643
|
+
DefaultApi,
|
|
644
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
645
|
+
import type { GetCredentialCapabilitiesRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
646
|
+
|
|
647
|
+
async function example() {
|
|
648
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
649
|
+
const api = new DefaultApi();
|
|
650
|
+
|
|
651
|
+
try {
|
|
652
|
+
const data = await api.getCredentialCapabilities();
|
|
653
|
+
console.log(data);
|
|
654
|
+
} catch (error) {
|
|
655
|
+
console.error(error);
|
|
656
|
+
}
|
|
657
|
+
}
|
|
658
|
+
|
|
659
|
+
// Run the test
|
|
660
|
+
example().catch(console.error);
|
|
661
|
+
```
|
|
662
|
+
|
|
663
|
+
### Parameters
|
|
664
|
+
|
|
665
|
+
This endpoint does not need any parameter.
|
|
666
|
+
|
|
667
|
+
### Return type
|
|
668
|
+
|
|
669
|
+
[**CapabilityStatus**](CapabilityStatus.md)
|
|
670
|
+
|
|
671
|
+
### Authorization
|
|
672
|
+
|
|
673
|
+
No authorization required
|
|
674
|
+
|
|
675
|
+
### HTTP request headers
|
|
676
|
+
|
|
677
|
+
- **Content-Type**: Not defined
|
|
678
|
+
- **Accept**: `application/json`
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
### HTTP response details
|
|
682
|
+
| Status code | Description | Response headers |
|
|
683
|
+
|-------------|-------------|------------------|
|
|
684
|
+
| **200** | Capability status per operation | - |
|
|
685
|
+
| **404** | No credentials stored | - |
|
|
686
|
+
| **500** | Internal server error | - |
|
|
687
|
+
|
|
688
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
689
|
+
|
|
690
|
+
|
|
629
691
|
## getCredentials
|
|
630
692
|
|
|
631
693
|
> CredentialStatus getCredentials()
|
|
@@ -972,7 +1034,7 @@ async function example() {
|
|
|
972
1034
|
|
|
973
1035
|
const body = {
|
|
974
1036
|
// string | Group ID
|
|
975
|
-
id:
|
|
1037
|
+
id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
976
1038
|
// Array<string> | Sort fields with direction (e.g., \"name:asc\" or \"cluster:desc,name:asc\"). Valid fields are name, vCenterState, cluster, diskSize, memory, issues, cpuUsage, diskUsage, ramUsage, cpuAvg, memAvg. (optional)
|
|
977
1039
|
sort: ["cluster:asc","name:desc"],
|
|
978
1040
|
// number | Page number for pagination (optional)
|
|
@@ -3036,7 +3098,7 @@ async function example() {
|
|
|
3036
3098
|
|
|
3037
3099
|
const body = {
|
|
3038
3100
|
// string | Group ID
|
|
3039
|
-
id:
|
|
3101
|
+
id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
3040
3102
|
// UpdateGroupRequest
|
|
3041
3103
|
updateGroupRequest: ...,
|
|
3042
3104
|
} satisfies UpdateGroupOperationRequest;
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# OperationCapability
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`enabled` | boolean
|
|
10
|
+
`missingPrivileges` | Array<string>
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { OperationCapability } from '@openshift-migration-advisor/agent-sdk'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"enabled": null,
|
|
20
|
+
"missingPrivileges": null,
|
|
21
|
+
} satisfies OperationCapability
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as OperationCapability
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`state` | string
|
|
10
|
+
`message` | string
|
|
10
11
|
`error` | string
|
|
11
12
|
`results` | object
|
|
12
13
|
|
|
@@ -18,6 +19,7 @@ import type { VmInspectionStatus } from '@openshift-migration-advisor/agent-sdk'
|
|
|
18
19
|
// TODO: Update the object below with actual values
|
|
19
20
|
const example = {
|
|
20
21
|
"state": null,
|
|
22
|
+
"message": null,
|
|
21
23
|
"error": null,
|
|
22
24
|
"results": null,
|
|
23
25
|
} satisfies VmInspectionStatus
|
package/package.json
CHANGED
package/src/apis/DefaultApi.ts
CHANGED
|
@@ -33,6 +33,11 @@ import {
|
|
|
33
33
|
BenchmarkRunFromJSON,
|
|
34
34
|
BenchmarkRunToJSON,
|
|
35
35
|
} from '../models/BenchmarkRun.js';
|
|
36
|
+
import {
|
|
37
|
+
type CapabilityStatus,
|
|
38
|
+
CapabilityStatusFromJSON,
|
|
39
|
+
CapabilityStatusToJSON,
|
|
40
|
+
} from '../models/CapabilityStatus.js';
|
|
36
41
|
import {
|
|
37
42
|
type CollectorStartRequest,
|
|
38
43
|
CollectorStartRequestFromJSON,
|
|
@@ -586,6 +591,28 @@ export interface DefaultApiInterface {
|
|
|
586
591
|
*/
|
|
587
592
|
getCollectorStatus(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CollectorStatus>;
|
|
588
593
|
|
|
594
|
+
/**
|
|
595
|
+
* Creates request options for getCredentialCapabilities without sending the request
|
|
596
|
+
* @throws {RequiredError}
|
|
597
|
+
* @memberof DefaultApiInterface
|
|
598
|
+
*/
|
|
599
|
+
getCredentialCapabilitiesRequestOpts(): Promise<runtime.RequestOpts>;
|
|
600
|
+
|
|
601
|
+
/**
|
|
602
|
+
* Checks vSphere privileges for all operations (collector, inspector, forecaster) using stored credentials. Single live vSphere check, no caching.
|
|
603
|
+
* @summary Check vSphere operation capabilities
|
|
604
|
+
* @param {*} [options] Override http request option.
|
|
605
|
+
* @throws {RequiredError}
|
|
606
|
+
* @memberof DefaultApiInterface
|
|
607
|
+
*/
|
|
608
|
+
getCredentialCapabilitiesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CapabilityStatus>>;
|
|
609
|
+
|
|
610
|
+
/**
|
|
611
|
+
* Checks vSphere privileges for all operations (collector, inspector, forecaster) using stored credentials. Single live vSphere check, no caching.
|
|
612
|
+
* Check vSphere operation capabilities
|
|
613
|
+
*/
|
|
614
|
+
getCredentialCapabilities(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CapabilityStatus>;
|
|
615
|
+
|
|
589
616
|
/**
|
|
590
617
|
* Creates request options for getCredentials without sending the request
|
|
591
618
|
* @throws {RequiredError}
|
|
@@ -1914,6 +1941,45 @@ export class DefaultApi extends runtime.BaseAPI implements DefaultApiInterface {
|
|
|
1914
1941
|
return await response.value();
|
|
1915
1942
|
}
|
|
1916
1943
|
|
|
1944
|
+
/**
|
|
1945
|
+
* Creates request options for getCredentialCapabilities without sending the request
|
|
1946
|
+
*/
|
|
1947
|
+
async getCredentialCapabilitiesRequestOpts(): Promise<runtime.RequestOpts> {
|
|
1948
|
+
const queryParameters: any = {};
|
|
1949
|
+
|
|
1950
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1951
|
+
|
|
1952
|
+
|
|
1953
|
+
let urlPath = `/credentials/capabilities`;
|
|
1954
|
+
|
|
1955
|
+
return {
|
|
1956
|
+
path: urlPath,
|
|
1957
|
+
method: 'GET',
|
|
1958
|
+
headers: headerParameters,
|
|
1959
|
+
query: queryParameters,
|
|
1960
|
+
};
|
|
1961
|
+
}
|
|
1962
|
+
|
|
1963
|
+
/**
|
|
1964
|
+
* Checks vSphere privileges for all operations (collector, inspector, forecaster) using stored credentials. Single live vSphere check, no caching.
|
|
1965
|
+
* Check vSphere operation capabilities
|
|
1966
|
+
*/
|
|
1967
|
+
async getCredentialCapabilitiesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CapabilityStatus>> {
|
|
1968
|
+
const requestOptions = await this.getCredentialCapabilitiesRequestOpts();
|
|
1969
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
1970
|
+
|
|
1971
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CapabilityStatusFromJSON(jsonValue));
|
|
1972
|
+
}
|
|
1973
|
+
|
|
1974
|
+
/**
|
|
1975
|
+
* Checks vSphere privileges for all operations (collector, inspector, forecaster) using stored credentials. Single live vSphere check, no caching.
|
|
1976
|
+
* Check vSphere operation capabilities
|
|
1977
|
+
*/
|
|
1978
|
+
async getCredentialCapabilities(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CapabilityStatus> {
|
|
1979
|
+
const response = await this.getCredentialCapabilitiesRaw(initOverrides);
|
|
1980
|
+
return await response.value();
|
|
1981
|
+
}
|
|
1982
|
+
|
|
1917
1983
|
/**
|
|
1918
1984
|
* Creates request options for getCredentials without sending the request
|
|
1919
1985
|
*/
|