kb-cloud-client-typescript 2.3.0-alpha.85 → 2.3.0-alpha.87

package/src/sdk/openapi/apis/engine-api.ts

@@ -28,6 +28,8 @@ import type { Engine } from '../models';
 // @ts-ignore
 import type { EngineLicenseList } from '../models';
 // @ts-ignore
+import type { EngineNetworkModeSupported } from '../models';
+// @ts-ignore
 import type { EngineSchedulingPolicy } from '../models';
 // @ts-ignore
 import type { EngineServiceVersions } from '../models';
@@ -41,6 +43,57 @@ import type { ResourceConstraintList } from '../models';
  */
 export const EngineApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
+        /**
+         * 
+         * @summary Get supported network modes for engine+mode from engineOption config
+         * @param {string} environmentName environment name
+         * @param {string} engineName engine name
+         * @param {string} mode engine mode
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getEngineNetworkModeSupported: async (environmentName: string, engineName: string, mode: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'environmentName' is not null or undefined
+            assertParamExists('getEngineNetworkModeSupported', 'environmentName', environmentName)
+            // verify required parameter 'engineName' is not null or undefined
+            assertParamExists('getEngineNetworkModeSupported', 'engineName', engineName)
+            // verify required parameter 'mode' is not null or undefined
+            assertParamExists('getEngineNetworkModeSupported', 'mode', mode)
+            const localVarPath = `/api/v1/environments/{environmentName}/engineNetworkModes/supported`
+                .replace(`{${"environmentName"}}`, encodeURIComponent(String(environmentName)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication BearerToken required
+            await setApiKeyToObject(localVarHeaderParameter, "authorization", configuration)
+
+            if (engineName !== undefined) {
+                localVarQueryParameter['engineName'] = engineName;
+            }
+
+            if (mode !== undefined) {
+                localVarQueryParameter['mode'] = mode;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * list all engineLicenses
          * @summary List all engineLicenses
@@ -387,6 +440,21 @@ export const EngineApiAxiosParamCreator = function (configuration?: Configuratio
 export const EngineApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = EngineApiAxiosParamCreator(configuration)
     return {
+        /**
+         * 
+         * @summary Get supported network modes for engine+mode from engineOption config
+         * @param {string} environmentName environment name
+         * @param {string} engineName engine name
+         * @param {string} mode engine mode
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getEngineNetworkModeSupported(environmentName: string, engineName: string, mode: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EngineNetworkModeSupported>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getEngineNetworkModeSupported(environmentName, engineName, mode, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['EngineApi.getEngineNetworkModeSupported']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * list all engineLicenses
          * @summary List all engineLicenses
@@ -502,6 +570,16 @@ export const EngineApiFp = function(configuration?: Configuration) {
 export const EngineApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = EngineApiFp(configuration)
     return {
+        /**
+         * 
+         * @summary Get supported network modes for engine+mode from engineOption config
+         * @param {EngineApiGetEngineNetworkModeSupportedRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getEngineNetworkModeSupported(requestParameters: EngineApiGetEngineNetworkModeSupportedRequest, options?: RawAxiosRequestConfig): AxiosPromise<EngineNetworkModeSupported> {
+            return localVarFp.getEngineNetworkModeSupported(requestParameters.environmentName, requestParameters.engineName, requestParameters.mode, options).then((request) => request(axios, basePath));
+        },
         /**
          * list all engineLicenses
          * @summary List all engineLicenses
@@ -580,6 +658,16 @@ export const EngineApiFactory = function (configuration?: Configuration, basePat
  * @interface EngineApi
  */
 export interface EngineApiInterface {
+    /**
+     * 
+     * @summary Get supported network modes for engine+mode from engineOption config
+     * @param {EngineApiGetEngineNetworkModeSupportedRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EngineApiInterface
+     */
+    getEngineNetworkModeSupported(requestParameters: EngineApiGetEngineNetworkModeSupportedRequest, options?: RawAxiosRequestConfig): AxiosPromise<EngineNetworkModeSupported>;
+
     /**
      * list all engineLicenses
      * @summary List all engineLicenses
@@ -651,6 +739,34 @@ export interface EngineApiInterface {
 
 }
 
+/**
+ * Request parameters for getEngineNetworkModeSupported operation in EngineApi.
+ * @export
+ * @interface EngineApiGetEngineNetworkModeSupportedRequest
+ */
+export interface EngineApiGetEngineNetworkModeSupportedRequest {
+    /**
+     * environment name
+     * @type {string}
+     * @memberof EngineApiGetEngineNetworkModeSupported
+     */
+    readonly environmentName: string
+
+    /**
+     * engine name
+     * @type {string}
+     * @memberof EngineApiGetEngineNetworkModeSupported
+     */
+    readonly engineName: string
+
+    /**
+     * engine mode
+     * @type {string}
+     * @memberof EngineApiGetEngineNetworkModeSupported
+     */
+    readonly mode: string
+}
+
 /**
  * Request parameters for listEngineLicenses operation in EngineApi.
  * @export
@@ -847,6 +963,18 @@ export interface EngineApiListUpgradeableServiceVersionRequest {
  * @extends {BaseAPI}
  */
 export class EngineApi extends BaseAPI implements EngineApiInterface {
+    /**
+     * 
+     * @summary Get supported network modes for engine+mode from engineOption config
+     * @param {EngineApiGetEngineNetworkModeSupportedRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EngineApi
+     */
+    public getEngineNetworkModeSupported(requestParameters: EngineApiGetEngineNetworkModeSupportedRequest, options?: RawAxiosRequestConfig) {
+        return EngineApiFp(this.configuration).getEngineNetworkModeSupported(requestParameters.environmentName, requestParameters.engineName, requestParameters.mode, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * list all engineLicenses
      * @summary List all engineLicenses

package/src/sdk/openapi/models/engine-network-mode-supported.ts

@@ -0,0 +1,39 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * ***KubeBlocks Cloud API*** is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { NetworkMode } from './network-mode';
+
+/**
+ * 
+ * @export
+ * @interface EngineNetworkModeSupported
+ */
+export interface EngineNetworkModeSupported {
+    /**
+     * supported network modes
+     * @type {Array<NetworkMode>}
+     * @memberof EngineNetworkModeSupported
+     */
+    'supported'?: Array<NetworkMode>;
+    /**
+     * not supported versions, key is networkMode, value is array of versions
+     * @type {{ [key: string]: Array<string>; }}
+     * @memberof EngineNetworkModeSupported
+     */
+    'notSupportedVersions'?: { [key: string]: Array<string>; };
+}
+

package/src/sdk/openapi/models/index.ts

@@ -328,6 +328,7 @@ export * from './engine-license';
 export * from './engine-license-list';
 export * from './engine-mapping';
 export * from './engine-mode-transition';
+export * from './engine-network-mode-supported';
 export * from './engine-option';
 export * from './engine-option-license';
 export * from './engine-option-list';

package/src/sdk/openapi.yaml

@@ -16600,6 +16600,44 @@ paths:
           $ref: '#/components/responses/403'
         '404':
           $ref: '#/components/responses/404'
+  /api/v1/environments/{environmentName}/engineNetworkModes/supported:
+    get:
+      tags:
+        - engine
+      operationId: getEngineNetworkModeSupported
+      summary: Get supported network modes for engine+mode from engineOption config
+      parameters:
+        - name: environmentName
+          in: path
+          description: environment name
+          required: true
+          schema:
+            type: string
+        - name: engineName
+          in: query
+          description: engine name
+          required: true
+          schema:
+            type: string
+        - name: mode
+          in: query
+          description: engine mode
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: A successful response.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/engineNetworkModeSupported'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
   /api/v1/organizations/{orgName}/blueGreenDeployment/{deploymentID}:
     get:
       operationId: getBlueGreenDeployment
@@ -30511,6 +30549,21 @@ components:
         - engine
         - engineMode
         - schedulingPolicyType
+    engineNetworkModeSupported:
+      type: object
+      properties:
+        supported:
+          type: array
+          items:
+            $ref: '#/components/schemas/networkMode'
+          description: supported network modes
+        notSupportedVersions:
+          type: object
+          additionalProperties:
+            type: array
+            items:
+              type: string
+          description: not supported versions, key is networkMode, value is array of versions
     blueGreenDeploymentStatus:
       description: The status of a blue-green deployment.
       enum: