kb-cloud-client-typescript 2.3.0-alpha.199 → 2.3.0-alpha.200

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 (26) hide show
  1. package/dist/adminapi/apis/environment-api.d.ts +5 -5
  2. package/dist/adminapi/apis/environment-api.js +4 -4
  3. package/dist/adminapi/models/environment-module-action.d.ts +1 -1
  4. package/dist/adminapi/models/environment-module-action.js +1 -1
  5. package/dist/adminapi/models/environment-module-status.d.ts +4 -1
  6. package/dist/adminapi/models/environment-module-status.d.ts.map +1 -1
  7. package/dist/adminapi/models/environment-module-status.js +4 -1
  8. package/dist/adminapi/models/environment-module-status.js.map +1 -1
  9. package/dist/adminapi/models/environment-module-update.d.ts +1 -7
  10. package/dist/adminapi/models/environment-module-update.d.ts.map +1 -1
  11. package/dist/adminapi/models/environment-module.d.ts +1 -1
  12. package/dist/openapi/models/environment-module-status.d.ts +4 -1
  13. package/dist/openapi/models/environment-module-status.d.ts.map +1 -1
  14. package/dist/openapi/models/environment-module-status.js +4 -1
  15. package/dist/openapi/models/environment-module-status.js.map +1 -1
  16. package/dist/openapi/models/environment-module.d.ts +1 -1
  17. package/package.json +1 -1
  18. package/src/adminapi/apis/environment-api.ts +5 -5
  19. package/src/adminapi/models/environment-module-action.ts +1 -1
  20. package/src/adminapi/models/environment-module-status.ts +4 -1
  21. package/src/adminapi/models/environment-module-update.ts +1 -7
  22. package/src/adminapi/models/environment-module.ts +1 -1
  23. package/src/adminapi.yaml +9 -9
  24. package/src/openapi/models/environment-module-status.ts +4 -1
  25. package/src/openapi/models/environment-module.ts +1 -1
  26. package/src/openapi.yaml +6 -3
@@ -472,7 +472,7 @@ export declare const EnvironmentApiAxiosParamCreator: (configuration?: Configura
472
472
  */
473
473
  updateEnvironmentKubeconfig: (environmentName: string, kubeconfig?: Kubeconfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
474
474
  /**
475
- * Performs the requested module action. For quick-install modules, action=Enable with dryRun=true synchronously checks whether installation is allowed without making changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Existing module actions that do not use the quick-install framework keep their original behavior.
475
+ * Performs the requested module action. Supported quick install and upgrade actions use dryRun=true for synchronous checks without changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Other module actions keep their original behavior.
476
476
  * @summary Update an environment module
477
477
  * @param {string} environmentName Environment Name
478
478
  * @param {EnvironmentModuleUpdate} [environmentModuleUpdate]
@@ -920,7 +920,7 @@ export declare const EnvironmentApiFp: (configuration?: Configuration) => {
920
920
  */
921
921
  updateEnvironmentKubeconfig(environmentName: string, kubeconfig?: Kubeconfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HttpBody>>;
922
922
  /**
923
- * Performs the requested module action. For quick-install modules, action=Enable with dryRun=true synchronously checks whether installation is allowed without making changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Existing module actions that do not use the quick-install framework keep their original behavior.
923
+ * Performs the requested module action. Supported quick install and upgrade actions use dryRun=true for synchronous checks without changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Other module actions keep their original behavior.
924
924
  * @summary Update an environment module
925
925
  * @param {string} environmentName Environment Name
926
926
  * @param {EnvironmentModuleUpdate} [environmentModuleUpdate]
@@ -1321,7 +1321,7 @@ export declare const EnvironmentApiFactory: (configuration?: Configuration, base
1321
1321
  */
1322
1322
  updateEnvironmentKubeconfig(requestParameters: EnvironmentApiUpdateEnvironmentKubeconfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<HttpBody>;
1323
1323
  /**
1324
- * Performs the requested module action. For quick-install modules, action=Enable with dryRun=true synchronously checks whether installation is allowed without making changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Existing module actions that do not use the quick-install framework keep their original behavior.
1324
+ * Performs the requested module action. Supported quick install and upgrade actions use dryRun=true for synchronous checks without changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Other module actions keep their original behavior.
1325
1325
  * @summary Update an environment module
1326
1326
  * @param {EnvironmentApiUpdateEnvironmentModuleRequest} requestParameters Request parameters.
1327
1327
  * @param {*} [options] Override http request option.
@@ -1769,7 +1769,7 @@ export interface EnvironmentApiInterface {
1769
1769
  */
1770
1770
  updateEnvironmentKubeconfig(requestParameters: EnvironmentApiUpdateEnvironmentKubeconfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<HttpBody>;
1771
1771
  /**
1772
- * Performs the requested module action. For quick-install modules, action=Enable with dryRun=true synchronously checks whether installation is allowed without making changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Existing module actions that do not use the quick-install framework keep their original behavior.
1772
+ * Performs the requested module action. Supported quick install and upgrade actions use dryRun=true for synchronous checks without changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Other module actions keep their original behavior.
1773
1773
  * @summary Update an environment module
1774
1774
  * @param {EnvironmentApiUpdateEnvironmentModuleRequest} requestParameters Request parameters.
1775
1775
  * @param {*} [options] Override http request option.
@@ -3105,7 +3105,7 @@ export declare class EnvironmentApi extends BaseAPI implements EnvironmentApiInt
3105
3105
  */
3106
3106
  updateEnvironmentKubeconfig(requestParameters: EnvironmentApiUpdateEnvironmentKubeconfigRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HttpBody, any, {}>>;
3107
3107
  /**
3108
- * Performs the requested module action. For quick-install modules, action=Enable with dryRun=true synchronously checks whether installation is allowed without making changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Existing module actions that do not use the quick-install framework keep their original behavior.
3108
+ * Performs the requested module action. Supported quick install and upgrade actions use dryRun=true for synchronous checks without changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Other module actions keep their original behavior.
3109
3109
  * @summary Update an environment module
3110
3110
  * @param {EnvironmentApiUpdateEnvironmentModuleRequest} requestParameters Request parameters.
3111
3111
  * @param {*} [options] Override http request option.
@@ -1825,7 +1825,7 @@ const EnvironmentApiAxiosParamCreator = function (configuration) {
1825
1825
  };
1826
1826
  },
1827
1827
  /**
1828
- * Performs the requested module action. For quick-install modules, action=Enable with dryRun=true synchronously checks whether installation is allowed without making changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Existing module actions that do not use the quick-install framework keep their original behavior.
1828
+ * Performs the requested module action. Supported quick install and upgrade actions use dryRun=true for synchronous checks without changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Other module actions keep their original behavior.
1829
1829
  * @summary Update an environment module
1830
1830
  * @param {string} environmentName Environment Name
1831
1831
  * @param {EnvironmentModuleUpdate} [environmentModuleUpdate]
@@ -2575,7 +2575,7 @@ const EnvironmentApiFp = function (configuration) {
2575
2575
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2576
2576
  },
2577
2577
  /**
2578
- * Performs the requested module action. For quick-install modules, action=Enable with dryRun=true synchronously checks whether installation is allowed without making changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Existing module actions that do not use the quick-install framework keep their original behavior.
2578
+ * Performs the requested module action. Supported quick install and upgrade actions use dryRun=true for synchronous checks without changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Other module actions keep their original behavior.
2579
2579
  * @summary Update an environment module
2580
2580
  * @param {string} environmentName Environment Name
2581
2581
  * @param {EnvironmentModuleUpdate} [environmentModuleUpdate]
@@ -3068,7 +3068,7 @@ const EnvironmentApiFactory = function (configuration, basePath, axios) {
3068
3068
  return localVarFp.updateEnvironmentKubeconfig(requestParameters.environmentName, requestParameters.kubeconfig, options).then((request) => request(axios, basePath));
3069
3069
  },
3070
3070
  /**
3071
- * Performs the requested module action. For quick-install modules, action=Enable with dryRun=true synchronously checks whether installation is allowed without making changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Existing module actions that do not use the quick-install framework keep their original behavior.
3071
+ * Performs the requested module action. Supported quick install and upgrade actions use dryRun=true for synchronous checks without changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Other module actions keep their original behavior.
3072
3072
  * @summary Update an environment module
3073
3073
  * @param {EnvironmentApiUpdateEnvironmentModuleRequest} requestParameters Request parameters.
3074
3074
  * @param {*} [options] Override http request option.
@@ -3603,7 +3603,7 @@ class EnvironmentApi extends base_1.BaseAPI {
3603
3603
  return (0, exports.EnvironmentApiFp)(this.configuration).updateEnvironmentKubeconfig(requestParameters.environmentName, requestParameters.kubeconfig, options).then((request) => request(this.axios, this.basePath));
3604
3604
  }
3605
3605
  /**
3606
- * Performs the requested module action. For quick-install modules, action=Enable with dryRun=true synchronously checks whether installation is allowed without making changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Existing module actions that do not use the quick-install framework keep their original behavior.
3606
+ * Performs the requested module action. Supported quick install and upgrade actions use dryRun=true for synchronous checks without changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Other module actions keep their original behavior.
3607
3607
  * @summary Update an environment module
3608
3608
  * @param {EnvironmentApiUpdateEnvironmentModuleRequest} requestParameters Request parameters.
3609
3609
  * @param {*} [options] Override http request option.
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Action to perform on the environment module: - Enable: Enable the module - Disable: Disable the module - Upgrade: Upgrade the module to specified version
13
+ * Action to perform on the environment module: - Enable: Enable the module - Disable: Disable the module - Upgrade: Upgrade the module
14
14
  * @export
15
15
  * @enum {string}
16
16
  */
@@ -15,7 +15,7 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.EnvironmentModuleAction = void 0;
17
17
  /**
18
- * Action to perform on the environment module: - Enable: Enable the module - Disable: Disable the module - Upgrade: Upgrade the module to specified version
18
+ * Action to perform on the environment module: - Enable: Enable the module - Disable: Disable the module - Upgrade: Upgrade the module
19
19
  * @export
20
20
  * @enum {string}
21
21
  */
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Status of an environment module. Enabled is only used as the desired state when creating an environment. NotInstalled, Installing, InstallationFailed, and Unknown are returned only for modules that support quick installation.
13
+ * Status of an environment module. Enabled is only used as the desired state when creating an environment. NotInstalled, Installing, and InstallationFailed describe quick installation; Upgradeable, Upgrading, and UpgradeFailed describe quick upgrade. Upgradeable means the component is running but an ApeCloud-bundled newer version is available. Unknown means the current state could not be determined.
14
14
  * @export
15
15
  * @enum {string}
16
16
  */
@@ -23,6 +23,9 @@ export declare const EnvironmentModuleStatus: {
23
23
  readonly NotInstalled: "NotInstalled";
24
24
  readonly Installing: "Installing";
25
25
  readonly InstallationFailed: "InstallationFailed";
26
+ readonly Upgradeable: "Upgradeable";
27
+ readonly Upgrading: "Upgrading";
28
+ readonly UpgradeFailed: "UpgradeFailed";
26
29
  readonly Unknown: "Unknown";
27
30
  };
28
31
  export type EnvironmentModuleStatus = typeof EnvironmentModuleStatus[keyof typeof EnvironmentModuleStatus];
@@ -1 +1 @@
1
- {"version":3,"file":"environment-module-status.d.ts","sourceRoot":"","sources":["../../../src/adminapi/models/environment-module-status.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AAEH,eAAO,MAAM,uBAAuB;;;;;;;;;;CAU1B,CAAC;AAEX,MAAM,MAAM,uBAAuB,GAAG,OAAO,uBAAuB,CAAC,MAAM,OAAO,uBAAuB,CAAC,CAAC"}
1
+ {"version":3,"file":"environment-module-status.d.ts","sourceRoot":"","sources":["../../../src/adminapi/models/environment-module-status.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AAEH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;CAa1B,CAAC;AAEX,MAAM,MAAM,uBAAuB,GAAG,OAAO,uBAAuB,CAAC,MAAM,OAAO,uBAAuB,CAAC,CAAC"}
@@ -15,7 +15,7 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.EnvironmentModuleStatus = void 0;
17
17
  /**
18
- * Status of an environment module. Enabled is only used as the desired state when creating an environment. NotInstalled, Installing, InstallationFailed, and Unknown are returned only for modules that support quick installation.
18
+ * Status of an environment module. Enabled is only used as the desired state when creating an environment. NotInstalled, Installing, and InstallationFailed describe quick installation; Upgradeable, Upgrading, and UpgradeFailed describe quick upgrade. Upgradeable means the component is running but an ApeCloud-bundled newer version is available. Unknown means the current state could not be determined.
19
19
  * @export
20
20
  * @enum {string}
21
21
  */
@@ -28,6 +28,9 @@ exports.EnvironmentModuleStatus = {
28
28
  NotInstalled: 'NotInstalled',
29
29
  Installing: 'Installing',
30
30
  InstallationFailed: 'InstallationFailed',
31
+ Upgradeable: 'Upgradeable',
32
+ Upgrading: 'Upgrading',
33
+ UpgradeFailed: 'UpgradeFailed',
31
34
  Unknown: 'Unknown'
32
35
  };
33
36
  //# sourceMappingURL=environment-module-status.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"environment-module-status.js","sourceRoot":"","sources":["../../../src/adminapi/models/environment-module-status.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAIH;;;;GAIG;AAEU,QAAA,uBAAuB,GAAG;IACnC,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,UAAU;IACpB,KAAK,EAAE,OAAO;IACd,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;IAClB,YAAY,EAAE,cAAc;IAC5B,UAAU,EAAE,YAAY;IACxB,kBAAkB,EAAE,oBAAoB;IACxC,OAAO,EAAE,SAAS;CACZ,CAAC"}
1
+ {"version":3,"file":"environment-module-status.js","sourceRoot":"","sources":["../../../src/adminapi/models/environment-module-status.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAIH;;;;GAIG;AAEU,QAAA,uBAAuB,GAAG;IACnC,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,UAAU;IACpB,KAAK,EAAE,OAAO;IACd,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;IAClB,YAAY,EAAE,cAAc;IAC5B,UAAU,EAAE,YAAY;IACxB,kBAAkB,EAAE,oBAAoB;IACxC,WAAW,EAAE,aAAa;IAC1B,SAAS,EAAE,WAAW;IACtB,aAAa,EAAE,eAAe;IAC9B,OAAO,EAAE,SAAS;CACZ,CAAC"}
@@ -29,13 +29,7 @@ export interface EnvironmentModuleUpdate {
29
29
  */
30
30
  'action': EnvironmentModuleAction;
31
31
  /**
32
- * Version of the environment module to upgrade to
33
- * @type {string}
34
- * @memberof EnvironmentModuleUpdate
35
- */
36
- 'version'?: string;
37
- /**
38
- * For action=Enable on a quick-install module, only run synchronous installation checks when true. When false or omitted, repeat the checks and submit the installation task if all checks pass. Existing module actions ignore this field when false or omitted.
32
+ * For a supported quick install or upgrade action, only run synchronous checks when true. When false or omitted, repeat the checks and submit the asynchronous task if all checks pass.
39
33
  * @type {boolean}
40
34
  * @memberof EnvironmentModuleUpdate
41
35
  */
@@ -1 +1 @@
1
- {"version":3,"file":"environment-module-update.d.ts","sourceRoot":"","sources":["../../../src/adminapi/models/environment-module-update.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAKH,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AAE3E;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,QAAQ,EAAE,uBAAuB,CAAC;IAClC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB"}
1
+ {"version":3,"file":"environment-module-update.d.ts","sourceRoot":"","sources":["../../../src/adminapi/models/environment-module-update.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAKH,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AAE3E;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,QAAQ,EAAE,uBAAuB,CAAC;IAClC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB"}
@@ -25,7 +25,7 @@ export interface EnvironmentModule {
25
25
  */
26
26
  'name': string;
27
27
  /**
28
- * Environment module version
28
+ * Currently installed environment module version
29
29
  * @type {string}
30
30
  * @memberof EnvironmentModule
31
31
  */
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Status of an environment module. Enabled is only used as the desired state when creating an environment. NotInstalled, Installing, InstallationFailed, and Unknown are returned only for modules that support quick installation.
13
+ * Status of an environment module. Enabled is only used as the desired state when creating an environment. NotInstalled, Installing, and InstallationFailed describe quick installation; Upgradeable, Upgrading, and UpgradeFailed describe quick upgrade. Upgradeable means the component is running but an ApeCloud-bundled newer version is available. Unknown means the current state could not be determined.
14
14
  * @export
15
15
  * @enum {string}
16
16
  */
@@ -23,6 +23,9 @@ export declare const EnvironmentModuleStatus: {
23
23
  readonly NotInstalled: "NotInstalled";
24
24
  readonly Installing: "Installing";
25
25
  readonly InstallationFailed: "InstallationFailed";
26
+ readonly Upgradeable: "Upgradeable";
27
+ readonly Upgrading: "Upgrading";
28
+ readonly UpgradeFailed: "UpgradeFailed";
26
29
  readonly Unknown: "Unknown";
27
30
  };
28
31
  export type EnvironmentModuleStatus = typeof EnvironmentModuleStatus[keyof typeof EnvironmentModuleStatus];
@@ -1 +1 @@
1
- {"version":3,"file":"environment-module-status.d.ts","sourceRoot":"","sources":["../../../src/openapi/models/environment-module-status.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AAEH,eAAO,MAAM,uBAAuB;;;;;;;;;;CAU1B,CAAC;AAEX,MAAM,MAAM,uBAAuB,GAAG,OAAO,uBAAuB,CAAC,MAAM,OAAO,uBAAuB,CAAC,CAAC"}
1
+ {"version":3,"file":"environment-module-status.d.ts","sourceRoot":"","sources":["../../../src/openapi/models/environment-module-status.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AAEH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;CAa1B,CAAC;AAEX,MAAM,MAAM,uBAAuB,GAAG,OAAO,uBAAuB,CAAC,MAAM,OAAO,uBAAuB,CAAC,CAAC"}
@@ -15,7 +15,7 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.EnvironmentModuleStatus = void 0;
17
17
  /**
18
- * Status of an environment module. Enabled is only used as the desired state when creating an environment. NotInstalled, Installing, InstallationFailed, and Unknown are returned only for modules that support quick installation.
18
+ * Status of an environment module. Enabled is only used as the desired state when creating an environment. NotInstalled, Installing, and InstallationFailed describe quick installation; Upgradeable, Upgrading, and UpgradeFailed describe quick upgrade. Upgradeable means the component is running but an ApeCloud-bundled newer version is available. Unknown means the current state could not be determined.
19
19
  * @export
20
20
  * @enum {string}
21
21
  */
@@ -28,6 +28,9 @@ exports.EnvironmentModuleStatus = {
28
28
  NotInstalled: 'NotInstalled',
29
29
  Installing: 'Installing',
30
30
  InstallationFailed: 'InstallationFailed',
31
+ Upgradeable: 'Upgradeable',
32
+ Upgrading: 'Upgrading',
33
+ UpgradeFailed: 'UpgradeFailed',
31
34
  Unknown: 'Unknown'
32
35
  };
33
36
  //# sourceMappingURL=environment-module-status.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"environment-module-status.js","sourceRoot":"","sources":["../../../src/openapi/models/environment-module-status.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAIH;;;;GAIG;AAEU,QAAA,uBAAuB,GAAG;IACnC,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,UAAU;IACpB,KAAK,EAAE,OAAO;IACd,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;IAClB,YAAY,EAAE,cAAc;IAC5B,UAAU,EAAE,YAAY;IACxB,kBAAkB,EAAE,oBAAoB;IACxC,OAAO,EAAE,SAAS;CACZ,CAAC"}
1
+ {"version":3,"file":"environment-module-status.js","sourceRoot":"","sources":["../../../src/openapi/models/environment-module-status.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAIH;;;;GAIG;AAEU,QAAA,uBAAuB,GAAG;IACnC,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,UAAU;IACpB,KAAK,EAAE,OAAO;IACd,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;IAClB,YAAY,EAAE,cAAc;IAC5B,UAAU,EAAE,YAAY;IACxB,kBAAkB,EAAE,oBAAoB;IACxC,WAAW,EAAE,aAAa;IAC1B,SAAS,EAAE,WAAW;IACtB,aAAa,EAAE,eAAe;IAC9B,OAAO,EAAE,SAAS;CACZ,CAAC"}
@@ -25,7 +25,7 @@ export interface EnvironmentModule {
25
25
  */
26
26
  'name': string;
27
27
  /**
28
- * Environment module version
28
+ * Currently installed environment module version
29
29
  * @type {string}
30
30
  * @memberof EnvironmentModule
31
31
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "kb-cloud-client-typescript",
3
- "version": "2.3.0-alpha.199",
3
+ "version": "2.3.0-alpha.200",
4
4
  "description": "Auto-generated TypeScript SDK for KubeBlocks Cloud API",
5
5
  "private": false,
6
6
  "license": "Apache-2.0",
@@ -2260,7 +2260,7 @@ export const EnvironmentApiAxiosParamCreator = function (configuration?: Configu
2260
2260
  };
2261
2261
  },
2262
2262
  /**
2263
- * Performs the requested module action. For quick-install modules, action=Enable with dryRun=true synchronously checks whether installation is allowed without making changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Existing module actions that do not use the quick-install framework keep their original behavior.
2263
+ * Performs the requested module action. Supported quick install and upgrade actions use dryRun=true for synchronous checks without changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Other module actions keep their original behavior.
2264
2264
  * @summary Update an environment module
2265
2265
  * @param {string} environmentName Environment Name
2266
2266
  * @param {EnvironmentModuleUpdate} [environmentModuleUpdate]
@@ -2971,7 +2971,7 @@ export const EnvironmentApiFp = function(configuration?: Configuration) {
2971
2971
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2972
2972
  },
2973
2973
  /**
2974
- * Performs the requested module action. For quick-install modules, action=Enable with dryRun=true synchronously checks whether installation is allowed without making changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Existing module actions that do not use the quick-install framework keep their original behavior.
2974
+ * Performs the requested module action. Supported quick install and upgrade actions use dryRun=true for synchronous checks without changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Other module actions keep their original behavior.
2975
2975
  * @summary Update an environment module
2976
2976
  * @param {string} environmentName Environment Name
2977
2977
  * @param {EnvironmentModuleUpdate} [environmentModuleUpdate]
@@ -3463,7 +3463,7 @@ export const EnvironmentApiFactory = function (configuration?: Configuration, ba
3463
3463
  return localVarFp.updateEnvironmentKubeconfig(requestParameters.environmentName, requestParameters.kubeconfig, options).then((request) => request(axios, basePath));
3464
3464
  },
3465
3465
  /**
3466
- * Performs the requested module action. For quick-install modules, action=Enable with dryRun=true synchronously checks whether installation is allowed without making changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Existing module actions that do not use the quick-install framework keep their original behavior.
3466
+ * Performs the requested module action. Supported quick install and upgrade actions use dryRun=true for synchronous checks without changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Other module actions keep their original behavior.
3467
3467
  * @summary Update an environment module
3468
3468
  * @param {EnvironmentApiUpdateEnvironmentModuleRequest} requestParameters Request parameters.
3469
3469
  * @param {*} [options] Override http request option.
@@ -3950,7 +3950,7 @@ export interface EnvironmentApiInterface {
3950
3950
  updateEnvironmentKubeconfig(requestParameters: EnvironmentApiUpdateEnvironmentKubeconfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<HttpBody>;
3951
3951
 
3952
3952
  /**
3953
- * Performs the requested module action. For quick-install modules, action=Enable with dryRun=true synchronously checks whether installation is allowed without making changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Existing module actions that do not use the quick-install framework keep their original behavior.
3953
+ * Performs the requested module action. Supported quick install and upgrade actions use dryRun=true for synchronous checks without changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Other module actions keep their original behavior.
3954
3954
  * @summary Update an environment module
3955
3955
  * @param {EnvironmentApiUpdateEnvironmentModuleRequest} requestParameters Request parameters.
3956
3956
  * @param {*} [options] Override http request option.
@@ -5511,7 +5511,7 @@ export class EnvironmentApi extends BaseAPI implements EnvironmentApiInterface {
5511
5511
  }
5512
5512
 
5513
5513
  /**
5514
- * Performs the requested module action. For quick-install modules, action=Enable with dryRun=true synchronously checks whether installation is allowed without making changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Existing module actions that do not use the quick-install framework keep their original behavior.
5514
+ * Performs the requested module action. Supported quick install and upgrade actions use dryRun=true for synchronous checks without changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Other module actions keep their original behavior.
5515
5515
  * @summary Update an environment module
5516
5516
  * @param {EnvironmentApiUpdateEnvironmentModuleRequest} requestParameters Request parameters.
5517
5517
  * @param {*} [options] Override http request option.
@@ -15,7 +15,7 @@
15
15
 
16
16
 
17
17
  /**
18
- * Action to perform on the environment module: - Enable: Enable the module - Disable: Disable the module - Upgrade: Upgrade the module to specified version
18
+ * Action to perform on the environment module: - Enable: Enable the module - Disable: Disable the module - Upgrade: Upgrade the module
19
19
  * @export
20
20
  * @enum {string}
21
21
  */
@@ -15,7 +15,7 @@
15
15
 
16
16
 
17
17
  /**
18
- * Status of an environment module. Enabled is only used as the desired state when creating an environment. NotInstalled, Installing, InstallationFailed, and Unknown are returned only for modules that support quick installation.
18
+ * Status of an environment module. Enabled is only used as the desired state when creating an environment. NotInstalled, Installing, and InstallationFailed describe quick installation; Upgradeable, Upgrading, and UpgradeFailed describe quick upgrade. Upgradeable means the component is running but an ApeCloud-bundled newer version is available. Unknown means the current state could not be determined.
19
19
  * @export
20
20
  * @enum {string}
21
21
  */
@@ -29,6 +29,9 @@ export const EnvironmentModuleStatus = {
29
29
  NotInstalled: 'NotInstalled',
30
30
  Installing: 'Installing',
31
31
  InstallationFailed: 'InstallationFailed',
32
+ Upgradeable: 'Upgradeable',
33
+ Upgrading: 'Upgrading',
34
+ UpgradeFailed: 'UpgradeFailed',
32
35
  Unknown: 'Unknown'
33
36
  } as const;
34
37
 
@@ -36,13 +36,7 @@ export interface EnvironmentModuleUpdate {
36
36
  */
37
37
  'action': EnvironmentModuleAction;
38
38
  /**
39
- * Version of the environment module to upgrade to
40
- * @type {string}
41
- * @memberof EnvironmentModuleUpdate
42
- */
43
- 'version'?: string;
44
- /**
45
- * For action=Enable on a quick-install module, only run synchronous installation checks when true. When false or omitted, repeat the checks and submit the installation task if all checks pass. Existing module actions ignore this field when false or omitted.
39
+ * For a supported quick install or upgrade action, only run synchronous checks when true. When false or omitted, repeat the checks and submit the asynchronous task if all checks pass.
46
40
  * @type {boolean}
47
41
  * @memberof EnvironmentModuleUpdate
48
42
  */
@@ -36,7 +36,7 @@ export interface EnvironmentModule {
36
36
  */
37
37
  'name': string;
38
38
  /**
39
- * Environment module version
39
+ * Currently installed environment module version
40
40
  * @type {string}
41
41
  * @memberof EnvironmentModule
42
42
  */
package/src/adminapi.yaml CHANGED
@@ -17124,7 +17124,7 @@ paths:
17124
17124
  patch:
17125
17125
  operationId: updateEnvironmentModule
17126
17126
  summary: Update an environment module
17127
- description: Performs the requested module action. For quick-install modules, action=Enable with dryRun=true synchronously checks whether installation is allowed without making changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Existing module actions that do not use the quick-install framework keep their original behavior.
17127
+ description: Performs the requested module action. Supported quick install and upgrade actions use dryRun=true for synchronous checks without changes; dryRun=false or omitted repeats the checks and submits an asynchronous task only when all checks pass. Other module actions keep their original behavior.
17128
17128
  parameters:
17129
17129
  - name: environmentName
17130
17130
  in: path
@@ -30635,7 +30635,7 @@ components:
30635
30635
  description: judge whether to set the backup is default which will be init
30636
30636
  environmentModuleStatus:
30637
30637
  type: string
30638
- description: Status of an environment module. Enabled is only used as the desired state when creating an environment. NotInstalled, Installing, InstallationFailed, and Unknown are returned only for modules that support quick installation.
30638
+ description: Status of an environment module. Enabled is only used as the desired state when creating an environment. NotInstalled, Installing, and InstallationFailed describe quick installation; Upgradeable, Upgrading, and UpgradeFailed describe quick upgrade. Upgradeable means the component is running but an ApeCloud-bundled newer version is available. Unknown means the current state could not be determined.
30639
30639
  enum:
30640
30640
  - Running
30641
30641
  - Updating
@@ -30645,6 +30645,9 @@ components:
30645
30645
  - NotInstalled
30646
30646
  - Installing
30647
30647
  - InstallationFailed
30648
+ - Upgradeable
30649
+ - Upgrading
30650
+ - UpgradeFailed
30648
30651
  - Unknown
30649
30652
  clusterInfo:
30650
30653
  type: object
@@ -30668,7 +30671,7 @@ components:
30668
30671
  description: Environment module name
30669
30672
  version:
30670
30673
  type: string
30671
- description: Environment module version
30674
+ description: Currently installed environment module version
30672
30675
  status:
30673
30676
  $ref: '#/components/schemas/environmentModuleStatus'
30674
30677
  replicas:
@@ -30697,7 +30700,7 @@ components:
30697
30700
  description: indicate whether module is enabled by default when creating environment. Only effective when optional is true
30698
30701
  actionWarning:
30699
30702
  $ref: '#/components/schemas/localizedDescription'
30700
- description: Localized business-impact warning shown before installing a NotInstalled module or retrying an InstallationFailed module.
30703
+ description: Localized business-impact warning for the component action represented by the current status.
30701
30704
  required:
30702
30705
  - name
30703
30706
  - status
@@ -38139,7 +38142,7 @@ components:
38139
38142
  Action to perform on the environment module:
38140
38143
  - Enable: Enable the module
38141
38144
  - Disable: Disable the module
38142
- - Upgrade: Upgrade the module to specified version
38145
+ - Upgrade: Upgrade the module
38143
38146
  enum:
38144
38147
  - Enable
38145
38148
  - Disable
@@ -38153,13 +38156,10 @@ components:
38153
38156
  description: Name of the environment module to update
38154
38157
  action:
38155
38158
  $ref: '#/components/schemas/environmentModuleAction'
38156
- version:
38157
- type: string
38158
- description: Version of the environment module to upgrade to
38159
38159
  dryRun:
38160
38160
  type: boolean
38161
38161
  default: false
38162
- description: For action=Enable on a quick-install module, only run synchronous installation checks when true. When false or omitted, repeat the checks and submit the installation task if all checks pass. Existing module actions ignore this field when false or omitted.
38162
+ description: For a supported quick install or upgrade action, only run synchronous checks when true. When false or omitted, repeat the checks and submit the asynchronous task if all checks pass.
38163
38163
  required:
38164
38164
  - name
38165
38165
  - action
@@ -15,7 +15,7 @@
15
15
 
16
16
 
17
17
  /**
18
- * Status of an environment module. Enabled is only used as the desired state when creating an environment. NotInstalled, Installing, InstallationFailed, and Unknown are returned only for modules that support quick installation.
18
+ * Status of an environment module. Enabled is only used as the desired state when creating an environment. NotInstalled, Installing, and InstallationFailed describe quick installation; Upgradeable, Upgrading, and UpgradeFailed describe quick upgrade. Upgradeable means the component is running but an ApeCloud-bundled newer version is available. Unknown means the current state could not be determined.
19
19
  * @export
20
20
  * @enum {string}
21
21
  */
@@ -29,6 +29,9 @@ export const EnvironmentModuleStatus = {
29
29
  NotInstalled: 'NotInstalled',
30
30
  Installing: 'Installing',
31
31
  InstallationFailed: 'InstallationFailed',
32
+ Upgradeable: 'Upgradeable',
33
+ Upgrading: 'Upgrading',
34
+ UpgradeFailed: 'UpgradeFailed',
32
35
  Unknown: 'Unknown'
33
36
  } as const;
34
37
 
@@ -36,7 +36,7 @@ export interface EnvironmentModule {
36
36
  */
37
37
  'name': string;
38
38
  /**
39
- * Environment module version
39
+ * Currently installed environment module version
40
40
  * @type {string}
41
41
  * @memberof EnvironmentModule
42
42
  */
package/src/openapi.yaml CHANGED
@@ -20867,7 +20867,7 @@ components:
20867
20867
  type: object
20868
20868
  environmentModuleStatus:
20869
20869
  type: string
20870
- description: Status of an environment module. Enabled is only used as the desired state when creating an environment. NotInstalled, Installing, InstallationFailed, and Unknown are returned only for modules that support quick installation.
20870
+ description: Status of an environment module. Enabled is only used as the desired state when creating an environment. NotInstalled, Installing, and InstallationFailed describe quick installation; Upgradeable, Upgrading, and UpgradeFailed describe quick upgrade. Upgradeable means the component is running but an ApeCloud-bundled newer version is available. Unknown means the current state could not be determined.
20871
20871
  enum:
20872
20872
  - Running
20873
20873
  - Updating
@@ -20877,6 +20877,9 @@ components:
20877
20877
  - NotInstalled
20878
20878
  - Installing
20879
20879
  - InstallationFailed
20880
+ - Upgradeable
20881
+ - Upgrading
20882
+ - UpgradeFailed
20880
20883
  - Unknown
20881
20884
  clusterInfo:
20882
20885
  type: object
@@ -20900,7 +20903,7 @@ components:
20900
20903
  description: Environment module name
20901
20904
  version:
20902
20905
  type: string
20903
- description: Environment module version
20906
+ description: Currently installed environment module version
20904
20907
  status:
20905
20908
  $ref: '#/components/schemas/environmentModuleStatus'
20906
20909
  replicas:
@@ -20929,7 +20932,7 @@ components:
20929
20932
  description: indicate whether module is enabled by default when creating environment. Only effective when optional is true
20930
20933
  actionWarning:
20931
20934
  $ref: '#/components/schemas/localizedDescription'
20932
- description: Localized business-impact warning shown before installing a NotInstalled module or retrying an InstallationFailed module.
20935
+ description: Localized business-impact warning for the component action represented by the current status.
20933
20936
  required:
20934
20937
  - name
20935
20938
  - status