kb-cloud-client-typescript 2.4.0-alpha.5 → 2.4.0-alpha.50

package/src/openapi/apis/cluster-log-api.ts

@@ -359,7 +359,7 @@ export const ClusterLogApiAxiosParamCreator = function (configuration?: Configur
             };
         },
         /**
-         * Explain a slow log template sample using DMS. The SQL is selected by templateId and time range; request body does not accept raw SQL. Only MySQL-compatible and PostgreSQL SELECT samples are supported.
+         * Explain a slow log template sample using DMS. The SQL is selected by templateId and time range; request body does not accept raw SQL. Only MySQL-compatible, PostgreSQL, and SQL Server SELECT samples are supported.
          * @summary Explain cluster slow log template
          * @param {string} orgName 
          * @param {string} clusterName 
@@ -1981,7 +1981,7 @@ export const ClusterLogApiFp = function(configuration?: Configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Explain a slow log template sample using DMS. The SQL is selected by templateId and time range; request body does not accept raw SQL. Only MySQL-compatible and PostgreSQL SELECT samples are supported.
+         * Explain a slow log template sample using DMS. The SQL is selected by templateId and time range; request body does not accept raw SQL. Only MySQL-compatible, PostgreSQL, and SQL Server SELECT samples are supported.
          * @summary Explain cluster slow log template
          * @param {string} orgName 
          * @param {string} clusterName 
@@ -2379,7 +2379,7 @@ export const ClusterLogApiFactory = function (configuration?: Configuration, bas
             return localVarFp.explainSlowLog(requestParameters.orgName, requestParameters.clusterName, requestParameters.dmsExplainRequest, options).then((request) => request(axios, basePath));
         },
         /**
-         * Explain a slow log template sample using DMS. The SQL is selected by templateId and time range; request body does not accept raw SQL. Only MySQL-compatible and PostgreSQL SELECT samples are supported.
+         * Explain a slow log template sample using DMS. The SQL is selected by templateId and time range; request body does not accept raw SQL. Only MySQL-compatible, PostgreSQL, and SQL Server SELECT samples are supported.
          * @summary Explain cluster slow log template
          * @param {ClusterLogApiExplainSlowLogTemplateRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -2538,7 +2538,7 @@ export interface ClusterLogApiInterface {
     explainSlowLog(requestParameters: ClusterLogApiExplainSlowLogRequest, options?: RawAxiosRequestConfig): AxiosPromise<ClusterSlowLogExplainResponse>;
 
     /**
-     * Explain a slow log template sample using DMS. The SQL is selected by templateId and time range; request body does not accept raw SQL. Only MySQL-compatible and PostgreSQL SELECT samples are supported.
+     * Explain a slow log template sample using DMS. The SQL is selected by templateId and time range; request body does not accept raw SQL. Only MySQL-compatible, PostgreSQL, and SQL Server SELECT samples are supported.
      * @summary Explain cluster slow log template
      * @param {ClusterLogApiExplainSlowLogTemplateRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -4579,7 +4579,7 @@ export class ClusterLogApi extends BaseAPI implements ClusterLogApiInterface {
     }
 
     /**
-     * Explain a slow log template sample using DMS. The SQL is selected by templateId and time range; request body does not accept raw SQL. Only MySQL-compatible and PostgreSQL SELECT samples are supported.
+     * Explain a slow log template sample using DMS. The SQL is selected by templateId and time range; request body does not accept raw SQL. Only MySQL-compatible, PostgreSQL, and SQL Server SELECT samples are supported.
      * @summary Explain cluster slow log template
      * @param {ClusterLogApiExplainSlowLogTemplateRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/src/openapi/apis/dashboard-config-api.ts

@@ -0,0 +1,172 @@
+/* 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.
+ */
+
+
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
+// @ts-ignore
+import type { APIErrorResponse } from '../models';
+// @ts-ignore
+import type { DashboardConfig } from '../models';
+/**
+ * DashboardConfigApi - axios parameter creator
+ * @export
+ */
+export const DashboardConfigApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Requires authentication. Reads platform-wide configuration; organization identifiers in a key do not restrict access. Missing keys return 200 with a null value.
+         * @summary Get dashboard configuration by key
+         * @param {string} key Frontend-defined non-blank configuration key, up to 512 Unicode characters. URL-encode the key when used in a request path.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getDashboardConfig: async (key: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'key' is not null or undefined
+            assertParamExists('getDashboardConfig', 'key', key)
+            const localVarPath = `/api/v1/dashboardConfigs/{key}`
+                .replace(`{${"key"}}`, encodeURIComponent(String(key)));
+            // 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
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            // authentication DigestAuth required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * DashboardConfigApi - functional programming interface
+ * @export
+ */
+export const DashboardConfigApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = DashboardConfigApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Requires authentication. Reads platform-wide configuration; organization identifiers in a key do not restrict access. Missing keys return 200 with a null value.
+         * @summary Get dashboard configuration by key
+         * @param {string} key Frontend-defined non-blank configuration key, up to 512 Unicode characters. URL-encode the key when used in a request path.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getDashboardConfig(key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DashboardConfig>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getDashboardConfig(key, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DashboardConfigApi.getDashboardConfig']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * DashboardConfigApi - factory interface
+ * @export
+ */
+export const DashboardConfigApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = DashboardConfigApiFp(configuration)
+    return {
+        /**
+         * Requires authentication. Reads platform-wide configuration; organization identifiers in a key do not restrict access. Missing keys return 200 with a null value.
+         * @summary Get dashboard configuration by key
+         * @param {DashboardConfigApiGetDashboardConfigRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getDashboardConfig(requestParameters: DashboardConfigApiGetDashboardConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<DashboardConfig> {
+            return localVarFp.getDashboardConfig(requestParameters.key, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * DashboardConfigApi - interface
+ * @export
+ * @interface DashboardConfigApi
+ */
+export interface DashboardConfigApiInterface {
+    /**
+     * Requires authentication. Reads platform-wide configuration; organization identifiers in a key do not restrict access. Missing keys return 200 with a null value.
+     * @summary Get dashboard configuration by key
+     * @param {DashboardConfigApiGetDashboardConfigRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardConfigApiInterface
+     */
+    getDashboardConfig(requestParameters: DashboardConfigApiGetDashboardConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<DashboardConfig>;
+
+}
+
+/**
+ * Request parameters for getDashboardConfig operation in DashboardConfigApi.
+ * @export
+ * @interface DashboardConfigApiGetDashboardConfigRequest
+ */
+export interface DashboardConfigApiGetDashboardConfigRequest {
+    /**
+     * Frontend-defined non-blank configuration key, up to 512 Unicode characters. URL-encode the key when used in a request path.
+     * @type {string}
+     * @memberof DashboardConfigApiGetDashboardConfig
+     */
+    readonly key: string
+}
+
+/**
+ * DashboardConfigApi - object-oriented interface
+ * @export
+ * @class DashboardConfigApi
+ * @extends {BaseAPI}
+ */
+export class DashboardConfigApi extends BaseAPI implements DashboardConfigApiInterface {
+    /**
+     * Requires authentication. Reads platform-wide configuration; organization identifiers in a key do not restrict access. Missing keys return 200 with a null value.
+     * @summary Get dashboard configuration by key
+     * @param {DashboardConfigApiGetDashboardConfigRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardConfigApi
+     */
+    public getDashboardConfig(requestParameters: DashboardConfigApiGetDashboardConfigRequest, options?: RawAxiosRequestConfig) {
+        return DashboardConfigApiFp(this.configuration).getDashboardConfig(requestParameters.key, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+