kb-cloud-client-typescript 2.3.0-beta.0 → 2.3.0-beta.2

package/src/internalapi.yaml

@@ -486,6 +486,17 @@ paths:
           description: license id
           schema:
             type: integer
+        - name: endpointHost
+          in: query
+          description: Case-insensitive substring to match against the host part of cached cluster endpoints
+          schema:
+            type: string
+        - name: includeEndpoints
+          in: query
+          description: Whether to include cached user-visible endpoints in each cluster item
+          schema:
+            type: boolean
+            default: false
       responses:
         '200':
           description: A successful response.
@@ -1789,6 +1800,88 @@ components:
         - public
         - private
       default: public
+    tag:
+      description: tag info
+      properties:
+        id:
+          description: The id of the tag
+          format: int64
+          type: string
+        key:
+          description: the key of the tag
+          type: string
+        value:
+          description: The value corresponding to the key
+          type: string
+      required:
+        - id
+      type: object
+    endpointType:
+      description: Type of endpoint
+      type: string
+      enum:
+        - ClusterIP
+        - NodePort
+        - LoadBalancer
+        - PodIP
+        - HostNetwork
+        - PodFQDN
+    endpointNetworkType:
+      description: Network type of endpoint
+      type: string
+      enum:
+        - Internet
+        - Intranet
+    endpoint:
+      description: Endpoint is the information of cluster endpoints
+      properties:
+        title:
+          description: title of the endpoint
+          type: string
+        component:
+          description: Component type name
+          type: string
+        hosts:
+          description: Endpoint hosts
+          type: array
+          items:
+            type: string
+        port:
+          description: Endpoint port
+          type: integer
+          format: int32
+        type:
+          $ref: '#/components/schemas/endpointType'
+        networkType:
+          $ref: '#/components/schemas/endpointNetworkType'
+        serviceName:
+          description: Service name of endpoint
+          type: string
+        podService:
+          description: Pod service name of endpoint
+          type: boolean
+        portName:
+          description: Port name of endpoint
+          type: string
+        instances:
+          description: Endpoint backend instances
+          type: array
+          items:
+            type: string
+        mutable:
+          description: Whether the endpoint is mutable
+          type: boolean
+      required:
+        - title
+        - component
+        - hosts
+        - port
+        - type
+        - networkType
+        - serviceName
+        - portName
+        - mutable
+      type: object
     clusterListItem:
       description: KubeBlocks cluster information
       properties:
@@ -1895,6 +1988,20 @@ components:
         orgName:
           description: Org Name
           type: string
+        project:
+          description: Name of project, it is the alias of environment namespace
+          type: string
+        tags:
+          description: Tags bound to the cluster
+          items:
+            $ref: '#/components/schemas/tag'
+          type: array
+        endpoints:
+          description: Cached user-visible endpoints of the cluster; omitted unless includeEndpoints is true
+          items:
+            $ref: '#/components/schemas/endpoint'
+          type: array
+          x-omitempty: true
       required:
         - cloudProvider
         - createdAt
@@ -1960,72 +2067,6 @@ components:
           items:
             $ref: '#/components/schemas/serviceRef'
       description: ClusterUpdate is the payload to update a KubeBlocks cluster
-    endpointType:
-      description: Type of endpoint
-      type: string
-      enum:
-        - ClusterIP
-        - NodePort
-        - LoadBalancer
-        - PodIP
-        - HostNetwork
-        - PodFQDN
-    endpointNetworkType:
-      description: Network type of endpoint
-      type: string
-      enum:
-        - Internet
-        - Intranet
-    endpoint:
-      description: Endpoint is the information of cluster endpoints
-      properties:
-        title:
-          description: title of the endpoint
-          type: string
-        component:
-          description: Component type name
-          type: string
-        hosts:
-          description: Endpoint hosts
-          type: array
-          items:
-            type: string
-        port:
-          description: Endpoint port
-          type: integer
-          format: int32
-        type:
-          $ref: '#/components/schemas/endpointType'
-        networkType:
-          $ref: '#/components/schemas/endpointNetworkType'
-        serviceName:
-          description: Service name of endpoint
-          type: string
-        podService:
-          description: Pod service name of endpoint
-          type: boolean
-        portName:
-          description: Port name of endpoint
-          type: string
-        instances:
-          description: Endpoint backend instances
-          type: array
-          items:
-            type: string
-        mutable:
-          description: Whether the endpoint is mutable
-          type: boolean
-      required:
-        - title
-        - component
-        - hosts
-        - port
-        - type
-        - networkType
-        - serviceName
-        - portName
-        - mutable
-      type: object
     endpointList:
       required:
         - items

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

@@ -730,10 +730,12 @@ export const ClusterApiAxiosParamCreator = function (configuration?: Configurati
          * @param {Array<string>} [tagValues] A list of tags\&#39; values corresponding to the tagKeys
          * @param {number} [licenseId] license id
          * @param {string} [refClusterName] list clusters referenced by this cluster
+         * @param {string} [endpointHost] Case-insensitive substring to match against the host part of cached cluster endpoints
+         * @param {boolean} [includeEndpoints] Whether to include cached user-visible endpoints in each cluster item
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listCluster: async (orgName: string, clusterDefinition?: string, environmentName?: string, environmentType?: EnvironmentType, tagKey?: string, tagValue?: string, tagKeys?: Array<string>, tagValues?: Array<string>, licenseId?: number, refClusterName?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        listCluster: async (orgName: string, clusterDefinition?: string, environmentName?: string, environmentType?: EnvironmentType, tagKey?: string, tagValue?: string, tagKeys?: Array<string>, tagValues?: Array<string>, licenseId?: number, refClusterName?: string, endpointHost?: string, includeEndpoints?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'orgName' is not null or undefined
             assertParamExists('listCluster', 'orgName', orgName)
             const localVarPath = `/api/v1/organizations/{orgName}/clusters`
@@ -792,6 +794,14 @@ export const ClusterApiAxiosParamCreator = function (configuration?: Configurati
                 localVarQueryParameter['refClusterName'] = refClusterName;
             }
 
+            if (endpointHost !== undefined) {
+                localVarQueryParameter['endpointHost'] = endpointHost;
+            }
+
+            if (includeEndpoints !== undefined) {
+                localVarQueryParameter['includeEndpoints'] = includeEndpoints;
+            }
+
 
     
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -1579,11 +1589,13 @@ export const ClusterApiFp = function(configuration?: Configuration) {
          * @param {Array<string>} [tagValues] A list of tags\&#39; values corresponding to the tagKeys
          * @param {number} [licenseId] license id
          * @param {string} [refClusterName] list clusters referenced by this cluster
+         * @param {string} [endpointHost] Case-insensitive substring to match against the host part of cached cluster endpoints
+         * @param {boolean} [includeEndpoints] Whether to include cached user-visible endpoints in each cluster item
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listCluster(orgName: string, clusterDefinition?: string, environmentName?: string, environmentType?: EnvironmentType, tagKey?: string, tagValue?: string, tagKeys?: Array<string>, tagValues?: Array<string>, licenseId?: number, refClusterName?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClusterList>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.listCluster(orgName, clusterDefinition, environmentName, environmentType, tagKey, tagValue, tagKeys, tagValues, licenseId, refClusterName, options);
+        async listCluster(orgName: string, clusterDefinition?: string, environmentName?: string, environmentType?: EnvironmentType, tagKey?: string, tagValue?: string, tagKeys?: Array<string>, tagValues?: Array<string>, licenseId?: number, refClusterName?: string, endpointHost?: string, includeEndpoints?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClusterList>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listCluster(orgName, clusterDefinition, environmentName, environmentType, tagKey, tagValue, tagKeys, tagValues, licenseId, refClusterName, endpointHost, includeEndpoints, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['ClusterApi.listCluster']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1892,7 +1904,7 @@ export const ClusterApiFactory = function (configuration?: Configuration, basePa
          * @throws {RequiredError}
          */
         listCluster(requestParameters: ClusterApiListClusterRequest, options?: RawAxiosRequestConfig): AxiosPromise<ClusterList> {
-            return localVarFp.listCluster(requestParameters.orgName, requestParameters.clusterDefinition, requestParameters.environmentName, requestParameters.environmentType, requestParameters.tagKey, requestParameters.tagValue, requestParameters.tagKeys, requestParameters.tagValues, requestParameters.licenseId, requestParameters.refClusterName, options).then((request) => request(axios, basePath));
+            return localVarFp.listCluster(requestParameters.orgName, requestParameters.clusterDefinition, requestParameters.environmentName, requestParameters.environmentType, requestParameters.tagKey, requestParameters.tagValue, requestParameters.tagKeys, requestParameters.tagValues, requestParameters.licenseId, requestParameters.refClusterName, requestParameters.endpointHost, requestParameters.includeEndpoints, options).then((request) => request(axios, basePath));
         },
         /**
          * 
@@ -2708,6 +2720,20 @@ export interface ClusterApiListClusterRequest {
      * @memberof ClusterApiListCluster
      */
     readonly refClusterName?: string
+
+    /**
+     * Case-insensitive substring to match against the host part of cached cluster endpoints
+     * @type {string}
+     * @memberof ClusterApiListCluster
+     */
+    readonly endpointHost?: string
+
+    /**
+     * Whether to include cached user-visible endpoints in each cluster item
+     * @type {boolean}
+     * @memberof ClusterApiListCluster
+     */
+    readonly includeEndpoints?: boolean
 }
 
 /**
@@ -3185,7 +3211,7 @@ export class ClusterApi extends BaseAPI implements ClusterApiInterface {
      * @memberof ClusterApi
      */
     public listCluster(requestParameters: ClusterApiListClusterRequest, options?: RawAxiosRequestConfig) {
-        return ClusterApiFp(this.configuration).listCluster(requestParameters.orgName, requestParameters.clusterDefinition, requestParameters.environmentName, requestParameters.environmentType, requestParameters.tagKey, requestParameters.tagValue, requestParameters.tagKeys, requestParameters.tagValues, requestParameters.licenseId, requestParameters.refClusterName, options).then((request) => request(this.axios, this.basePath));
+        return ClusterApiFp(this.configuration).listCluster(requestParameters.orgName, requestParameters.clusterDefinition, requestParameters.environmentName, requestParameters.environmentType, requestParameters.tagKey, requestParameters.tagValue, requestParameters.tagKeys, requestParameters.tagValues, requestParameters.licenseId, requestParameters.refClusterName, requestParameters.endpointHost, requestParameters.includeEndpoints, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**

package/src/openapi/apis/shared-api.ts

@@ -8288,10 +8288,12 @@ export const SharedApiAxiosParamCreator = function (configuration?: Configuratio
          * @param {Array<string>} [tagValues] A list of tags\&#39; values corresponding to the tagKeys
          * @param {number} [licenseId] license id
          * @param {string} [refClusterName] list clusters referenced by this cluster
+         * @param {string} [endpointHost] Case-insensitive substring to match against the host part of cached cluster endpoints
+         * @param {boolean} [includeEndpoints] Whether to include cached user-visible endpoints in each cluster item
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listCluster: async (orgName: string, clusterDefinition?: string, environmentName?: string, environmentType?: EnvironmentType, tagKey?: string, tagValue?: string, tagKeys?: Array<string>, tagValues?: Array<string>, licenseId?: number, refClusterName?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        listCluster: async (orgName: string, clusterDefinition?: string, environmentName?: string, environmentType?: EnvironmentType, tagKey?: string, tagValue?: string, tagKeys?: Array<string>, tagValues?: Array<string>, licenseId?: number, refClusterName?: string, endpointHost?: string, includeEndpoints?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'orgName' is not null or undefined
             assertParamExists('listCluster', 'orgName', orgName)
             const localVarPath = `/api/v1/organizations/{orgName}/clusters`
@@ -8350,6 +8352,14 @@ export const SharedApiAxiosParamCreator = function (configuration?: Configuratio
                 localVarQueryParameter['refClusterName'] = refClusterName;
             }
 
+            if (endpointHost !== undefined) {
+                localVarQueryParameter['endpointHost'] = endpointHost;
+            }
+
+            if (includeEndpoints !== undefined) {
+                localVarQueryParameter['includeEndpoints'] = includeEndpoints;
+            }
+
 
     
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -18408,11 +18418,13 @@ export const SharedApiFp = function(configuration?: Configuration) {
          * @param {Array<string>} [tagValues] A list of tags\&#39; values corresponding to the tagKeys
          * @param {number} [licenseId] license id
          * @param {string} [refClusterName] list clusters referenced by this cluster
+         * @param {string} [endpointHost] Case-insensitive substring to match against the host part of cached cluster endpoints
+         * @param {boolean} [includeEndpoints] Whether to include cached user-visible endpoints in each cluster item
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listCluster(orgName: string, clusterDefinition?: string, environmentName?: string, environmentType?: EnvironmentType, tagKey?: string, tagValue?: string, tagKeys?: Array<string>, tagValues?: Array<string>, licenseId?: number, refClusterName?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClusterList>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.listCluster(orgName, clusterDefinition, environmentName, environmentType, tagKey, tagValue, tagKeys, tagValues, licenseId, refClusterName, options);
+        async listCluster(orgName: string, clusterDefinition?: string, environmentName?: string, environmentType?: EnvironmentType, tagKey?: string, tagValue?: string, tagKeys?: Array<string>, tagValues?: Array<string>, licenseId?: number, refClusterName?: string, endpointHost?: string, includeEndpoints?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClusterList>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listCluster(orgName, clusterDefinition, environmentName, environmentType, tagKey, tagValue, tagKeys, tagValues, licenseId, refClusterName, endpointHost, includeEndpoints, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['SharedApi.listCluster']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -22094,7 +22106,7 @@ export const SharedApiFactory = function (configuration?: Configuration, basePat
          * @throws {RequiredError}
          */
         listCluster(requestParameters: SharedApiListClusterRequest, options?: RawAxiosRequestConfig): AxiosPromise<ClusterList> {
-            return localVarFp.listCluster(requestParameters.orgName, requestParameters.clusterDefinition, requestParameters.environmentName, requestParameters.environmentType, requestParameters.tagKey, requestParameters.tagValue, requestParameters.tagKeys, requestParameters.tagValues, requestParameters.licenseId, requestParameters.refClusterName, options).then((request) => request(axios, basePath));
+            return localVarFp.listCluster(requestParameters.orgName, requestParameters.clusterDefinition, requestParameters.environmentName, requestParameters.environmentType, requestParameters.tagKey, requestParameters.tagValue, requestParameters.tagKeys, requestParameters.tagValues, requestParameters.licenseId, requestParameters.refClusterName, requestParameters.endpointHost, requestParameters.includeEndpoints, options).then((request) => request(axios, basePath));
         },
         /**
          * 
@@ -31298,6 +31310,20 @@ export interface SharedApiListClusterRequest {
      * @memberof SharedApiListCluster
      */
     readonly refClusterName?: string
+
+    /**
+     * Case-insensitive substring to match against the host part of cached cluster endpoints
+     * @type {string}
+     * @memberof SharedApiListCluster
+     */
+    readonly endpointHost?: string
+
+    /**
+     * Whether to include cached user-visible endpoints in each cluster item
+     * @type {boolean}
+     * @memberof SharedApiListCluster
+     */
+    readonly includeEndpoints?: boolean
 }
 
 /**
@@ -37923,7 +37949,7 @@ export class SharedApi extends BaseAPI implements SharedApiInterface {
      * @memberof SharedApi
      */
     public listCluster(requestParameters: SharedApiListClusterRequest, options?: RawAxiosRequestConfig) {
-        return SharedApiFp(this.configuration).listCluster(requestParameters.orgName, requestParameters.clusterDefinition, requestParameters.environmentName, requestParameters.environmentType, requestParameters.tagKey, requestParameters.tagValue, requestParameters.tagKeys, requestParameters.tagValues, requestParameters.licenseId, requestParameters.refClusterName, options).then((request) => request(this.axios, this.basePath));
+        return SharedApiFp(this.configuration).listCluster(requestParameters.orgName, requestParameters.clusterDefinition, requestParameters.environmentName, requestParameters.environmentType, requestParameters.tagKey, requestParameters.tagValue, requestParameters.tagKeys, requestParameters.tagValues, requestParameters.licenseId, requestParameters.refClusterName, requestParameters.endpointHost, requestParameters.includeEndpoints, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**

package/src/openapi/models/cluster-list-item.ts

@@ -16,6 +16,12 @@
 // May contain unused imports in some cases
 // @ts-ignore
 import type { ClusterType } from './cluster-type';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Endpoint } from './endpoint';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Tag } from './tag';
 
 /**
  * KubeBlocks cluster information
@@ -179,6 +185,24 @@ export interface ClusterListItem {
      * @memberof ClusterListItem
      */
     'orgName'?: string;
+    /**
+     * Name of project, it is the alias of environment namespace
+     * @type {string}
+     * @memberof ClusterListItem
+     */
+    'project'?: string;
+    /**
+     * Tags bound to the cluster
+     * @type {Array<Tag>}
+     * @memberof ClusterListItem
+     */
+    'tags'?: Array<Tag>;
+    /**
+     * Cached user-visible endpoints of the cluster; omitted unless includeEndpoints is true
+     * @type {Array<Endpoint>}
+     * @memberof ClusterListItem
+     */
+    'endpoints'?: Array<Endpoint>;
 }
 
 

package/src/openapi.yaml

@@ -1629,6 +1629,17 @@ paths:
           description: list clusters referenced by this cluster
           schema:
             type: string
+        - name: endpointHost
+          in: query
+          description: Case-insensitive substring to match against the host part of cached cluster endpoints
+          schema:
+            type: string
+        - name: includeEndpoints
+          in: query
+          description: Whether to include cached user-visible endpoints in each cluster item
+          schema:
+            type: boolean
+            default: false
       responses:
         '200':
           description: A successful response.
@@ -22201,6 +22212,88 @@ components:
         - Normal
         - DisasterRecovery
         - BlueGreenDeployment
+    tag:
+      description: tag info
+      properties:
+        id:
+          description: The id of the tag
+          format: int64
+          type: string
+        key:
+          description: the key of the tag
+          type: string
+        value:
+          description: The value corresponding to the key
+          type: string
+      required:
+        - id
+      type: object
+    endpointType:
+      description: Type of endpoint
+      type: string
+      enum:
+        - ClusterIP
+        - NodePort
+        - LoadBalancer
+        - PodIP
+        - HostNetwork
+        - PodFQDN
+    endpointNetworkType:
+      description: Network type of endpoint
+      type: string
+      enum:
+        - Internet
+        - Intranet
+    endpoint:
+      description: Endpoint is the information of cluster endpoints
+      properties:
+        title:
+          description: title of the endpoint
+          type: string
+        component:
+          description: Component type name
+          type: string
+        hosts:
+          description: Endpoint hosts
+          type: array
+          items:
+            type: string
+        port:
+          description: Endpoint port
+          type: integer
+          format: int32
+        type:
+          $ref: '#/components/schemas/endpointType'
+        networkType:
+          $ref: '#/components/schemas/endpointNetworkType'
+        serviceName:
+          description: Service name of endpoint
+          type: string
+        podService:
+          description: Pod service name of endpoint
+          type: boolean
+        portName:
+          description: Port name of endpoint
+          type: string
+        instances:
+          description: Endpoint backend instances
+          type: array
+          items:
+            type: string
+        mutable:
+          description: Whether the endpoint is mutable
+          type: boolean
+      required:
+        - title
+        - component
+        - hosts
+        - port
+        - type
+        - networkType
+        - serviceName
+        - portName
+        - mutable
+      type: object
     clusterListItem:
       description: KubeBlocks cluster information
       properties:
@@ -22307,6 +22400,20 @@ components:
         orgName:
           description: Org Name
           type: string
+        project:
+          description: Name of project, it is the alias of environment namespace
+          type: string
+        tags:
+          description: Tags bound to the cluster
+          items:
+            $ref: '#/components/schemas/tag'
+          type: array
+        endpoints:
+          description: Cached user-visible endpoints of the cluster; omitted unless includeEndpoints is true
+          items:
+            $ref: '#/components/schemas/endpoint'
+          type: array
+          x-omitempty: true
       required:
         - cloudProvider
         - createdAt
@@ -24512,22 +24619,6 @@ components:
             type: string
           rebuildInstanceOpsRequestName:
             type: string
-    tag:
-      description: tag info
-      properties:
-        id:
-          description: The id of the tag
-          format: int64
-          type: string
-        key:
-          description: the key of the tag
-          type: string
-        value:
-          description: The value corresponding to the key
-          type: string
-      required:
-        - id
-      type: object
     clusterTags:
       properties:
         clusterId:
@@ -24592,72 +24683,6 @@ components:
         - clusterId
         - items
       type: object
-    endpointType:
-      description: Type of endpoint
-      type: string
-      enum:
-        - ClusterIP
-        - NodePort
-        - LoadBalancer
-        - PodIP
-        - HostNetwork
-        - PodFQDN
-    endpointNetworkType:
-      description: Network type of endpoint
-      type: string
-      enum:
-        - Internet
-        - Intranet
-    endpoint:
-      description: Endpoint is the information of cluster endpoints
-      properties:
-        title:
-          description: title of the endpoint
-          type: string
-        component:
-          description: Component type name
-          type: string
-        hosts:
-          description: Endpoint hosts
-          type: array
-          items:
-            type: string
-        port:
-          description: Endpoint port
-          type: integer
-          format: int32
-        type:
-          $ref: '#/components/schemas/endpointType'
-        networkType:
-          $ref: '#/components/schemas/endpointNetworkType'
-        serviceName:
-          description: Service name of endpoint
-          type: string
-        podService:
-          description: Pod service name of endpoint
-          type: boolean
-        portName:
-          description: Port name of endpoint
-          type: string
-        instances:
-          description: Endpoint backend instances
-          type: array
-          items:
-            type: string
-        mutable:
-          description: Whether the endpoint is mutable
-          type: boolean
-      required:
-        - title
-        - component
-        - hosts
-        - port
-        - type
-        - networkType
-        - serviceName
-        - portName
-        - mutable
-      type: object
     endpointList:
       required:
         - items