kb-cloud-client-typescript 2.4.0-alpha.47 → 2.4.0-alpha.49

package/src/adminapi/models/dashboard-config.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface DashboardConfig
+ */
+export interface DashboardConfig {
+    /**
+     * Frontend-defined platform-wide key. Organization identifiers in this key do not enforce tenant isolation.
+     * @type {string}
+     * @memberof DashboardConfig
+     */
+    'key': string;
+    /**
+     * Stored JSON value, or null when the key has no configuration.
+     * @type {any}
+     * @memberof DashboardConfig
+     */
+    'value'?: any;
+}
+

package/src/adminapi/models/index.ts

@@ -246,6 +246,8 @@ export * from './dameng-session-list-item';
 export * from './dameng-space-analysis';
 export * from './dameng-table-size-item';
 export * from './dameng-tablespace-item';
+export * from './dashboard-config';
+export * from './dashboard-config-update';
 export * from './dashboard-option';
 export * from './dashboard-option-instance-panels-inner';
 export * from './dashboard-option-instance-panels-inner-panels-inner';

package/src/adminapi.yaml

@@ -16843,6 +16843,78 @@ paths:
           $ref: '#/components/responses/500'
       tags:
         - instance
+  /admin/v1/dashboardConfigs/{key}:
+    get:
+      parameters:
+        - $ref: '#/components/parameters/dashboardConfigKey'
+      tags:
+        - dashboardConfig
+      operationId: getDashboardConfig
+      summary: Get dashboard configuration by key
+      description: Requires platform configuration read access. Missing keys return 200 with a null value.
+      responses:
+        '200':
+          description: Stored configuration or a null value for a missing key.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/dashboardConfig'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '500':
+          $ref: '#/components/responses/500'
+    put:
+      parameters:
+        - $ref: '#/components/parameters/dashboardConfigKey'
+      tags:
+        - dashboardConfig
+      operationId: putDashboardConfig
+      summary: Create or replace dashboard configuration by key
+      description: Requires platform configuration write access. Atomic upsert with last-write-wins semantics. Request body is limited to 1 MiB.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/dashboardConfigUpdate'
+      responses:
+        '200':
+          description: Saved configuration.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/dashboardConfig'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '500':
+          $ref: '#/components/responses/500'
+    delete:
+      parameters:
+        - $ref: '#/components/parameters/dashboardConfigKey'
+      tags:
+        - dashboardConfig
+      operationId: deleteDashboardConfig
+      summary: Delete dashboard configuration by key
+      description: Requires platform configuration write access. Deleting a missing key succeeds.
+      responses:
+        '204':
+          description: Configuration is absent.
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '500':
+          $ref: '#/components/responses/500'
   /admin/v1/platformParameters:
     get:
       tags:
@@ -40738,6 +40810,27 @@ components:
         isVariable:
           type: boolean
           description: whether the param is tenant variable or param
+    dashboardConfig:
+      type: object
+      required:
+        - key
+      properties:
+        key:
+          type: string
+          description: Frontend-defined platform-wide key. Organization identifiers in this key do not enforce tenant isolation.
+          minLength: 1
+          maxLength: 512
+        value:
+          description: Stored JSON value, or null when the key has no configuration.
+          x-omitempty: false
+    dashboardConfigUpdate:
+      type: object
+      required:
+        - value
+      properties:
+        value:
+          description: Any non-null JSON value. Replaces the complete stored value.
+          x-omitempty: false
     platformParameterCategory:
       type: string
       description: platformParameter category, representing the platformParameter group
@@ -47190,6 +47283,15 @@ components:
       name: query
       schema:
         type: string
+    dashboardConfigKey:
+      in: path
+      name: key
+      required: true
+      description: Frontend-defined non-blank configuration key, up to 512 Unicode characters. URL-encode the key when used in a request path.
+      schema:
+        type: string
+        minLength: 1
+        maxLength: 512
 x-tagGroups:
   - name: User
     tags:

package/src/openapi/.openapi-generator/FILES

@@ -26,6 +26,7 @@ apis/cluster-log-api.ts
 apis/cluster-loki-log-api.ts
 apis/cluster-tag-api.ts
 apis/dameng-api.ts
+apis/dashboard-config-api.ts
 apis/data-replication-api.ts
 apis/database-api.ts
 apis/diagnostics-api.ts
@@ -320,6 +321,7 @@ models/dameng-space-analysis.ts
 models/dameng-sqlanalysis.ts
 models/dameng-table-size-item.ts
 models/dameng-tablespace-item.ts
+models/dashboard-config.ts
 models/dashboard-option-instance-panels-inner-panels-inner.ts
 models/dashboard-option-instance-panels-inner.ts
 models/dashboard-option.ts

package/src/openapi/api.ts

@@ -38,6 +38,7 @@ export * from './apis/cluster-log-api';
 export * from './apis/cluster-loki-log-api';
 export * from './apis/cluster-tag-api';
 export * from './apis/dameng-api';
+export * from './apis/dashboard-config-api';
 export * from './apis/data-replication-api';
 export * from './apis/database-api';
 export * from './apis/diagnostics-api';

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));
+    }
+}
+

package/src/openapi/models/dashboard-config.ts

@@ -0,0 +1,36 @@
+/* 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface DashboardConfig
+ */
+export interface DashboardConfig {
+    /**
+     * Frontend-defined platform-wide key. Organization identifiers in this key do not enforce tenant isolation.
+     * @type {string}
+     * @memberof DashboardConfig
+     */
+    'key': string;
+    /**
+     * Stored JSON value, or null when the key has no configuration.
+     * @type {any}
+     * @memberof DashboardConfig
+     */
+    'value'?: any;
+}
+

package/src/openapi/models/index.ts

@@ -233,6 +233,7 @@ export * from './dameng-session-list-item';
 export * from './dameng-space-analysis';
 export * from './dameng-table-size-item';
 export * from './dameng-tablespace-item';
+export * from './dashboard-config';
 export * from './dashboard-option';
 export * from './dashboard-option-instance-panels-inner';
 export * from './dashboard-option-instance-panels-inner-panels-inner';

package/src/openapi.yaml

@@ -19769,6 +19769,28 @@ paths:
           $ref: '#/components/responses/401'
         '403':
           $ref: '#/components/responses/403'
+  /api/v1/dashboardConfigs/{key}:
+    get:
+      parameters:
+        - $ref: '#/components/parameters/dashboardConfigKey'
+      tags:
+        - dashboardConfig
+      operationId: getDashboardConfig
+      summary: Get dashboard configuration by key
+      description: Requires authentication. Reads platform-wide configuration; organization identifiers in a key do not restrict access. Missing keys return 200 with a null value.
+      responses:
+        '200':
+          description: Stored configuration or a null value for a missing key.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/dashboardConfig'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '500':
+          $ref: '#/components/responses/500'
   /api/v1/platformParameters:
     get:
       tags:
@@ -38747,6 +38769,19 @@ components:
       required:
         - items
       type: object
+    dashboardConfig:
+      type: object
+      required:
+        - key
+      properties:
+        key:
+          type: string
+          description: Frontend-defined platform-wide key. Organization identifiers in this key do not enforce tenant isolation.
+          minLength: 1
+          maxLength: 512
+        value:
+          description: Stored JSON value, or null when the key has no configuration.
+          x-omitempty: false
     platformParameterCategory:
       type: string
       description: platformParameter category, representing the platformParameter group
@@ -40703,6 +40738,15 @@ components:
       name: query
       schema:
         type: string
+    dashboardConfigKey:
+      in: path
+      name: key
+      required: true
+      description: Frontend-defined non-blank configuration key, up to 512 Unicode characters. URL-encode the key when used in a request path.
+      schema:
+        type: string
+        minLength: 1
+        maxLength: 512
 x-tagGroups:
   - name: User
     tags: