kb-cloud-client-typescript 2.4.0-alpha.98 → 2.4.0-alpha.99
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.
- package/dist/adminapi/apis/account-api.d.ts +145 -2
- package/dist/adminapi/apis/account-api.d.ts.map +1 -1
- package/dist/adminapi/apis/account-api.js +163 -5
- package/dist/adminapi/apis/account-api.js.map +1 -1
- package/dist/adminapi/apis/mongodb-api.d.ts +145 -2
- package/dist/adminapi/apis/mongodb-api.d.ts.map +1 -1
- package/dist/adminapi/apis/mongodb-api.js +163 -5
- package/dist/adminapi/apis/mongodb-api.js.map +1 -1
- package/dist/adminapi/apis/shared-api.d.ts +145 -2
- package/dist/adminapi/apis/shared-api.d.ts.map +1 -1
- package/dist/adminapi/apis/shared-api.js +163 -5
- package/dist/adminapi/apis/shared-api.js.map +1 -1
- package/dist/adminapi/models/alert-object.d.ts +13 -0
- package/dist/adminapi/models/alert-object.d.ts.map +1 -1
- package/dist/adminapi/models/index.d.ts +1 -0
- package/dist/adminapi/models/index.d.ts.map +1 -1
- package/dist/adminapi/models/index.js +1 -0
- package/dist/adminapi/models/index.js.map +1 -1
- package/dist/adminapi/models/mongo-rbaccapabilities.d.ts +6 -0
- package/dist/adminapi/models/mongo-rbaccapabilities.d.ts.map +1 -1
- package/dist/adminapi/models/object-type-enum.d.ts +23 -0
- package/dist/adminapi/models/object-type-enum.d.ts.map +1 -0
- package/dist/adminapi/models/object-type-enum.js +27 -0
- package/dist/adminapi/models/object-type-enum.js.map +1 -0
- package/dist/openapi/apis/account-api.d.ts +145 -2
- package/dist/openapi/apis/account-api.d.ts.map +1 -1
- package/dist/openapi/apis/account-api.js +163 -5
- package/dist/openapi/apis/account-api.js.map +1 -1
- package/dist/openapi/apis/mongodb-api.d.ts +145 -2
- package/dist/openapi/apis/mongodb-api.d.ts.map +1 -1
- package/dist/openapi/apis/mongodb-api.js +163 -5
- package/dist/openapi/apis/mongodb-api.js.map +1 -1
- package/dist/openapi/apis/shared-api.d.ts +145 -2
- package/dist/openapi/apis/shared-api.d.ts.map +1 -1
- package/dist/openapi/apis/shared-api.js +163 -5
- package/dist/openapi/apis/shared-api.js.map +1 -1
- package/dist/openapi/models/alert-object.d.ts +13 -0
- package/dist/openapi/models/alert-object.d.ts.map +1 -1
- package/dist/openapi/models/index.d.ts +1 -0
- package/dist/openapi/models/index.d.ts.map +1 -1
- package/dist/openapi/models/index.js +1 -0
- package/dist/openapi/models/index.js.map +1 -1
- package/dist/openapi/models/mongo-rbaccapabilities.d.ts +6 -0
- package/dist/openapi/models/mongo-rbaccapabilities.d.ts.map +1 -1
- package/dist/openapi/models/object-type-enum.d.ts +23 -0
- package/dist/openapi/models/object-type-enum.d.ts.map +1 -0
- package/dist/openapi/models/object-type-enum.js +27 -0
- package/dist/openapi/models/object-type-enum.js.map +1 -0
- package/package.json +1 -1
- package/src/adminapi/.openapi-generator/FILES +1 -0
- package/src/adminapi/apis/account-api.ts +256 -5
- package/src/adminapi/apis/mongodb-api.ts +256 -5
- package/src/adminapi/apis/shared-api.ts +256 -5
- package/src/adminapi/models/alert-object.ts +15 -0
- package/src/adminapi/models/index.ts +1 -0
- package/src/adminapi/models/mongo-rbaccapabilities.ts +6 -0
- package/src/adminapi/models/object-type-enum.ts +32 -0
- package/src/adminapi.yaml +140 -36
- package/src/openapi/.openapi-generator/FILES +1 -0
- package/src/openapi/apis/account-api.ts +256 -5
- package/src/openapi/apis/mongodb-api.ts +256 -5
- package/src/openapi/apis/shared-api.ts +256 -5
- package/src/openapi/models/alert-object.ts +15 -0
- package/src/openapi/models/index.ts +1 -0
- package/src/openapi/models/mongo-rbaccapabilities.ts +6 -0
- package/src/openapi/models/object-type-enum.ts +32 -0
- package/src/openapi.yaml +140 -36
|
@@ -272,6 +272,8 @@ import type { MilvusRoleList } from '../models';
|
|
|
272
272
|
// @ts-ignore
|
|
273
273
|
import type { MilvusRoleRequest } from '../models';
|
|
274
274
|
// @ts-ignore
|
|
275
|
+
import type { MongoCollectionInfo } from '../models';
|
|
276
|
+
// @ts-ignore
|
|
275
277
|
import type { MongoRBACBindingChange } from '../models';
|
|
276
278
|
// @ts-ignore
|
|
277
279
|
import type { MongoRBACCapabilities } from '../models';
|
|
@@ -13243,6 +13245,100 @@ export const SharedApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
13243
13245
|
|
|
13244
13246
|
|
|
13245
13247
|
|
|
13248
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
13249
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
13250
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
13251
|
+
|
|
13252
|
+
return {
|
|
13253
|
+
url: toPathString(localVarUrlObj),
|
|
13254
|
+
options: localVarRequestOptions,
|
|
13255
|
+
};
|
|
13256
|
+
},
|
|
13257
|
+
/**
|
|
13258
|
+
* Lists existing collections, views and time-series collections in a database using the cluster management connection. Returns metadata, not document contents.
|
|
13259
|
+
* @summary List MongoDB cluster database objects
|
|
13260
|
+
* @param {string} orgName
|
|
13261
|
+
* @param {string} clusterName
|
|
13262
|
+
* @param {string} database
|
|
13263
|
+
* @param {*} [options] Override http request option.
|
|
13264
|
+
* @throws {RequiredError}
|
|
13265
|
+
*/
|
|
13266
|
+
mongoListClusterCollections: async (orgName: string, clusterName: string, database: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
13267
|
+
// verify required parameter 'orgName' is not null or undefined
|
|
13268
|
+
assertParamExists('mongoListClusterCollections', 'orgName', orgName)
|
|
13269
|
+
// verify required parameter 'clusterName' is not null or undefined
|
|
13270
|
+
assertParamExists('mongoListClusterCollections', 'clusterName', clusterName)
|
|
13271
|
+
// verify required parameter 'database' is not null or undefined
|
|
13272
|
+
assertParamExists('mongoListClusterCollections', 'database', database)
|
|
13273
|
+
const localVarPath = `/api/v1/data/mongodb/organizations/{orgName}/clusters/{clusterName}/databases/{database}/collections`
|
|
13274
|
+
.replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
|
|
13275
|
+
.replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)))
|
|
13276
|
+
.replace(`{${"database"}}`, encodeURIComponent(String(database)));
|
|
13277
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
13278
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
13279
|
+
let baseOptions;
|
|
13280
|
+
if (configuration) {
|
|
13281
|
+
baseOptions = configuration.baseOptions;
|
|
13282
|
+
}
|
|
13283
|
+
|
|
13284
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
13285
|
+
const localVarHeaderParameter = {} as any;
|
|
13286
|
+
const localVarQueryParameter = {} as any;
|
|
13287
|
+
|
|
13288
|
+
// authentication BearerToken required
|
|
13289
|
+
// http bearer authentication required
|
|
13290
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
13291
|
+
|
|
13292
|
+
// authentication DigestAuth required
|
|
13293
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
13294
|
+
|
|
13295
|
+
|
|
13296
|
+
|
|
13297
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
13298
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
13299
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
13300
|
+
|
|
13301
|
+
return {
|
|
13302
|
+
url: toPathString(localVarUrlObj),
|
|
13303
|
+
options: localVarRequestOptions,
|
|
13304
|
+
};
|
|
13305
|
+
},
|
|
13306
|
+
/**
|
|
13307
|
+
* Lists existing database names using the cluster management connection. Does not require a personal Workbench datasource.
|
|
13308
|
+
* @summary List MongoDB cluster databases
|
|
13309
|
+
* @param {string} orgName
|
|
13310
|
+
* @param {string} clusterName
|
|
13311
|
+
* @param {*} [options] Override http request option.
|
|
13312
|
+
* @throws {RequiredError}
|
|
13313
|
+
*/
|
|
13314
|
+
mongoListClusterDatabases: async (orgName: string, clusterName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
13315
|
+
// verify required parameter 'orgName' is not null or undefined
|
|
13316
|
+
assertParamExists('mongoListClusterDatabases', 'orgName', orgName)
|
|
13317
|
+
// verify required parameter 'clusterName' is not null or undefined
|
|
13318
|
+
assertParamExists('mongoListClusterDatabases', 'clusterName', clusterName)
|
|
13319
|
+
const localVarPath = `/api/v1/data/mongodb/organizations/{orgName}/clusters/{clusterName}/databases`
|
|
13320
|
+
.replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
|
|
13321
|
+
.replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)));
|
|
13322
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
13323
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
13324
|
+
let baseOptions;
|
|
13325
|
+
if (configuration) {
|
|
13326
|
+
baseOptions = configuration.baseOptions;
|
|
13327
|
+
}
|
|
13328
|
+
|
|
13329
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
13330
|
+
const localVarHeaderParameter = {} as any;
|
|
13331
|
+
const localVarQueryParameter = {} as any;
|
|
13332
|
+
|
|
13333
|
+
// authentication BearerToken required
|
|
13334
|
+
// http bearer authentication required
|
|
13335
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
13336
|
+
|
|
13337
|
+
// authentication DigestAuth required
|
|
13338
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
13339
|
+
|
|
13340
|
+
|
|
13341
|
+
|
|
13246
13342
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
13247
13343
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
13248
13344
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -13308,10 +13404,11 @@ export const SharedApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
13308
13404
|
* @param {string} orgName
|
|
13309
13405
|
* @param {string} clusterName
|
|
13310
13406
|
* @param {string} [database]
|
|
13407
|
+
* @param {boolean} [allDatabases] List accounts from all authentication databases. Overrides database; returns role memberships without effective privileges. Use the user detail endpoint for privileges. Requires viewUser and viewRole on the relevant databases.
|
|
13311
13408
|
* @param {*} [options] Override http request option.
|
|
13312
13409
|
* @throws {RequiredError}
|
|
13313
13410
|
*/
|
|
13314
|
-
mongoListRBACUsers: async (orgName: string, clusterName: string, database?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
13411
|
+
mongoListRBACUsers: async (orgName: string, clusterName: string, database?: string, allDatabases?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
13315
13412
|
// verify required parameter 'orgName' is not null or undefined
|
|
13316
13413
|
assertParamExists('mongoListRBACUsers', 'orgName', orgName)
|
|
13317
13414
|
// verify required parameter 'clusterName' is not null or undefined
|
|
@@ -13341,6 +13438,10 @@ export const SharedApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
13341
13438
|
localVarQueryParameter['database'] = database;
|
|
13342
13439
|
}
|
|
13343
13440
|
|
|
13441
|
+
if (allDatabases !== undefined) {
|
|
13442
|
+
localVarQueryParameter['allDatabases'] = allDatabases;
|
|
13443
|
+
}
|
|
13444
|
+
|
|
13344
13445
|
|
|
13345
13446
|
|
|
13346
13447
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -22823,6 +22924,35 @@ export const SharedApiFp = function(configuration?: Configuration) {
|
|
|
22823
22924
|
const localVarOperationServerBasePath = operationServerMap['SharedApi.mongoGetRBACUser']?.[localVarOperationServerIndex]?.url;
|
|
22824
22925
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
22825
22926
|
},
|
|
22927
|
+
/**
|
|
22928
|
+
* Lists existing collections, views and time-series collections in a database using the cluster management connection. Returns metadata, not document contents.
|
|
22929
|
+
* @summary List MongoDB cluster database objects
|
|
22930
|
+
* @param {string} orgName
|
|
22931
|
+
* @param {string} clusterName
|
|
22932
|
+
* @param {string} database
|
|
22933
|
+
* @param {*} [options] Override http request option.
|
|
22934
|
+
* @throws {RequiredError}
|
|
22935
|
+
*/
|
|
22936
|
+
async mongoListClusterCollections(orgName: string, clusterName: string, database: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MongoCollectionInfo>>> {
|
|
22937
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.mongoListClusterCollections(orgName, clusterName, database, options);
|
|
22938
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
22939
|
+
const localVarOperationServerBasePath = operationServerMap['SharedApi.mongoListClusterCollections']?.[localVarOperationServerIndex]?.url;
|
|
22940
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
22941
|
+
},
|
|
22942
|
+
/**
|
|
22943
|
+
* Lists existing database names using the cluster management connection. Does not require a personal Workbench datasource.
|
|
22944
|
+
* @summary List MongoDB cluster databases
|
|
22945
|
+
* @param {string} orgName
|
|
22946
|
+
* @param {string} clusterName
|
|
22947
|
+
* @param {*} [options] Override http request option.
|
|
22948
|
+
* @throws {RequiredError}
|
|
22949
|
+
*/
|
|
22950
|
+
async mongoListClusterDatabases(orgName: string, clusterName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>> {
|
|
22951
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.mongoListClusterDatabases(orgName, clusterName, options);
|
|
22952
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
22953
|
+
const localVarOperationServerBasePath = operationServerMap['SharedApi.mongoListClusterDatabases']?.[localVarOperationServerIndex]?.url;
|
|
22954
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
22955
|
+
},
|
|
22826
22956
|
/**
|
|
22827
22957
|
*
|
|
22828
22958
|
* @summary ListRBACRoles
|
|
@@ -22844,11 +22974,12 @@ export const SharedApiFp = function(configuration?: Configuration) {
|
|
|
22844
22974
|
* @param {string} orgName
|
|
22845
22975
|
* @param {string} clusterName
|
|
22846
22976
|
* @param {string} [database]
|
|
22977
|
+
* @param {boolean} [allDatabases] List accounts from all authentication databases. Overrides database; returns role memberships without effective privileges. Use the user detail endpoint for privileges. Requires viewUser and viewRole on the relevant databases.
|
|
22847
22978
|
* @param {*} [options] Override http request option.
|
|
22848
22979
|
* @throws {RequiredError}
|
|
22849
22980
|
*/
|
|
22850
|
-
async mongoListRBACUsers(orgName: string, clusterName: string, database?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MongoRBACUser>>> {
|
|
22851
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.mongoListRBACUsers(orgName, clusterName, database, options);
|
|
22981
|
+
async mongoListRBACUsers(orgName: string, clusterName: string, database?: string, allDatabases?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MongoRBACUser>>> {
|
|
22982
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.mongoListRBACUsers(orgName, clusterName, database, allDatabases, options);
|
|
22852
22983
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
22853
22984
|
const localVarOperationServerBasePath = operationServerMap['SharedApi.mongoListRBACUsers']?.[localVarOperationServerIndex]?.url;
|
|
22854
22985
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -26837,6 +26968,26 @@ export const SharedApiFactory = function (configuration?: Configuration, basePat
|
|
|
26837
26968
|
mongoGetRBACUser(requestParameters: SharedApiMongoGetRBACUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<MongoRBACUser> {
|
|
26838
26969
|
return localVarFp.mongoGetRBACUser(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, requestParameters.username, options).then((request) => request(axios, basePath));
|
|
26839
26970
|
},
|
|
26971
|
+
/**
|
|
26972
|
+
* Lists existing collections, views and time-series collections in a database using the cluster management connection. Returns metadata, not document contents.
|
|
26973
|
+
* @summary List MongoDB cluster database objects
|
|
26974
|
+
* @param {SharedApiMongoListClusterCollectionsRequest} requestParameters Request parameters.
|
|
26975
|
+
* @param {*} [options] Override http request option.
|
|
26976
|
+
* @throws {RequiredError}
|
|
26977
|
+
*/
|
|
26978
|
+
mongoListClusterCollections(requestParameters: SharedApiMongoListClusterCollectionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<MongoCollectionInfo>> {
|
|
26979
|
+
return localVarFp.mongoListClusterCollections(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, options).then((request) => request(axios, basePath));
|
|
26980
|
+
},
|
|
26981
|
+
/**
|
|
26982
|
+
* Lists existing database names using the cluster management connection. Does not require a personal Workbench datasource.
|
|
26983
|
+
* @summary List MongoDB cluster databases
|
|
26984
|
+
* @param {SharedApiMongoListClusterDatabasesRequest} requestParameters Request parameters.
|
|
26985
|
+
* @param {*} [options] Override http request option.
|
|
26986
|
+
* @throws {RequiredError}
|
|
26987
|
+
*/
|
|
26988
|
+
mongoListClusterDatabases(requestParameters: SharedApiMongoListClusterDatabasesRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>> {
|
|
26989
|
+
return localVarFp.mongoListClusterDatabases(requestParameters.orgName, requestParameters.clusterName, options).then((request) => request(axios, basePath));
|
|
26990
|
+
},
|
|
26840
26991
|
/**
|
|
26841
26992
|
*
|
|
26842
26993
|
* @summary ListRBACRoles
|
|
@@ -26855,7 +27006,7 @@ export const SharedApiFactory = function (configuration?: Configuration, basePat
|
|
|
26855
27006
|
* @throws {RequiredError}
|
|
26856
27007
|
*/
|
|
26857
27008
|
mongoListRBACUsers(requestParameters: SharedApiMongoListRBACUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<MongoRBACUser>> {
|
|
26858
|
-
return localVarFp.mongoListRBACUsers(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, options).then((request) => request(axios, basePath));
|
|
27009
|
+
return localVarFp.mongoListRBACUsers(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, requestParameters.allDatabases, options).then((request) => request(axios, basePath));
|
|
26859
27010
|
},
|
|
26860
27011
|
/**
|
|
26861
27012
|
*
|
|
@@ -30181,6 +30332,26 @@ export interface SharedApiInterface {
|
|
|
30181
30332
|
*/
|
|
30182
30333
|
mongoGetRBACUser(requestParameters: SharedApiMongoGetRBACUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<MongoRBACUser>;
|
|
30183
30334
|
|
|
30335
|
+
/**
|
|
30336
|
+
* Lists existing collections, views and time-series collections in a database using the cluster management connection. Returns metadata, not document contents.
|
|
30337
|
+
* @summary List MongoDB cluster database objects
|
|
30338
|
+
* @param {SharedApiMongoListClusterCollectionsRequest} requestParameters Request parameters.
|
|
30339
|
+
* @param {*} [options] Override http request option.
|
|
30340
|
+
* @throws {RequiredError}
|
|
30341
|
+
* @memberof SharedApiInterface
|
|
30342
|
+
*/
|
|
30343
|
+
mongoListClusterCollections(requestParameters: SharedApiMongoListClusterCollectionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<MongoCollectionInfo>>;
|
|
30344
|
+
|
|
30345
|
+
/**
|
|
30346
|
+
* Lists existing database names using the cluster management connection. Does not require a personal Workbench datasource.
|
|
30347
|
+
* @summary List MongoDB cluster databases
|
|
30348
|
+
* @param {SharedApiMongoListClusterDatabasesRequest} requestParameters Request parameters.
|
|
30349
|
+
* @param {*} [options] Override http request option.
|
|
30350
|
+
* @throws {RequiredError}
|
|
30351
|
+
* @memberof SharedApiInterface
|
|
30352
|
+
*/
|
|
30353
|
+
mongoListClusterDatabases(requestParameters: SharedApiMongoListClusterDatabasesRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
|
|
30354
|
+
|
|
30184
30355
|
/**
|
|
30185
30356
|
*
|
|
30186
30357
|
* @summary ListRBACRoles
|
|
@@ -38974,6 +39145,55 @@ export interface SharedApiMongoGetRBACUserRequest {
|
|
|
38974
39145
|
readonly username: string
|
|
38975
39146
|
}
|
|
38976
39147
|
|
|
39148
|
+
/**
|
|
39149
|
+
* Request parameters for mongoListClusterCollections operation in SharedApi.
|
|
39150
|
+
* @export
|
|
39151
|
+
* @interface SharedApiMongoListClusterCollectionsRequest
|
|
39152
|
+
*/
|
|
39153
|
+
export interface SharedApiMongoListClusterCollectionsRequest {
|
|
39154
|
+
/**
|
|
39155
|
+
*
|
|
39156
|
+
* @type {string}
|
|
39157
|
+
* @memberof SharedApiMongoListClusterCollections
|
|
39158
|
+
*/
|
|
39159
|
+
readonly orgName: string
|
|
39160
|
+
|
|
39161
|
+
/**
|
|
39162
|
+
*
|
|
39163
|
+
* @type {string}
|
|
39164
|
+
* @memberof SharedApiMongoListClusterCollections
|
|
39165
|
+
*/
|
|
39166
|
+
readonly clusterName: string
|
|
39167
|
+
|
|
39168
|
+
/**
|
|
39169
|
+
*
|
|
39170
|
+
* @type {string}
|
|
39171
|
+
* @memberof SharedApiMongoListClusterCollections
|
|
39172
|
+
*/
|
|
39173
|
+
readonly database: string
|
|
39174
|
+
}
|
|
39175
|
+
|
|
39176
|
+
/**
|
|
39177
|
+
* Request parameters for mongoListClusterDatabases operation in SharedApi.
|
|
39178
|
+
* @export
|
|
39179
|
+
* @interface SharedApiMongoListClusterDatabasesRequest
|
|
39180
|
+
*/
|
|
39181
|
+
export interface SharedApiMongoListClusterDatabasesRequest {
|
|
39182
|
+
/**
|
|
39183
|
+
*
|
|
39184
|
+
* @type {string}
|
|
39185
|
+
* @memberof SharedApiMongoListClusterDatabases
|
|
39186
|
+
*/
|
|
39187
|
+
readonly orgName: string
|
|
39188
|
+
|
|
39189
|
+
/**
|
|
39190
|
+
*
|
|
39191
|
+
* @type {string}
|
|
39192
|
+
* @memberof SharedApiMongoListClusterDatabases
|
|
39193
|
+
*/
|
|
39194
|
+
readonly clusterName: string
|
|
39195
|
+
}
|
|
39196
|
+
|
|
38977
39197
|
/**
|
|
38978
39198
|
* Request parameters for mongoListRBACRoles operation in SharedApi.
|
|
38979
39199
|
* @export
|
|
@@ -39028,6 +39248,13 @@ export interface SharedApiMongoListRBACUsersRequest {
|
|
|
39028
39248
|
* @memberof SharedApiMongoListRBACUsers
|
|
39029
39249
|
*/
|
|
39030
39250
|
readonly database?: string
|
|
39251
|
+
|
|
39252
|
+
/**
|
|
39253
|
+
* List accounts from all authentication databases. Overrides database; returns role memberships without effective privileges. Use the user detail endpoint for privileges. Requires viewUser and viewRole on the relevant databases.
|
|
39254
|
+
* @type {boolean}
|
|
39255
|
+
* @memberof SharedApiMongoListRBACUsers
|
|
39256
|
+
*/
|
|
39257
|
+
readonly allDatabases?: boolean
|
|
39031
39258
|
}
|
|
39032
39259
|
|
|
39033
39260
|
/**
|
|
@@ -45831,6 +46058,30 @@ export class SharedApi extends BaseAPI implements SharedApiInterface {
|
|
|
45831
46058
|
return SharedApiFp(this.configuration).mongoGetRBACUser(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, requestParameters.username, options).then((request) => request(this.axios, this.basePath));
|
|
45832
46059
|
}
|
|
45833
46060
|
|
|
46061
|
+
/**
|
|
46062
|
+
* Lists existing collections, views and time-series collections in a database using the cluster management connection. Returns metadata, not document contents.
|
|
46063
|
+
* @summary List MongoDB cluster database objects
|
|
46064
|
+
* @param {SharedApiMongoListClusterCollectionsRequest} requestParameters Request parameters.
|
|
46065
|
+
* @param {*} [options] Override http request option.
|
|
46066
|
+
* @throws {RequiredError}
|
|
46067
|
+
* @memberof SharedApi
|
|
46068
|
+
*/
|
|
46069
|
+
public mongoListClusterCollections(requestParameters: SharedApiMongoListClusterCollectionsRequest, options?: RawAxiosRequestConfig) {
|
|
46070
|
+
return SharedApiFp(this.configuration).mongoListClusterCollections(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, options).then((request) => request(this.axios, this.basePath));
|
|
46071
|
+
}
|
|
46072
|
+
|
|
46073
|
+
/**
|
|
46074
|
+
* Lists existing database names using the cluster management connection. Does not require a personal Workbench datasource.
|
|
46075
|
+
* @summary List MongoDB cluster databases
|
|
46076
|
+
* @param {SharedApiMongoListClusterDatabasesRequest} requestParameters Request parameters.
|
|
46077
|
+
* @param {*} [options] Override http request option.
|
|
46078
|
+
* @throws {RequiredError}
|
|
46079
|
+
* @memberof SharedApi
|
|
46080
|
+
*/
|
|
46081
|
+
public mongoListClusterDatabases(requestParameters: SharedApiMongoListClusterDatabasesRequest, options?: RawAxiosRequestConfig) {
|
|
46082
|
+
return SharedApiFp(this.configuration).mongoListClusterDatabases(requestParameters.orgName, requestParameters.clusterName, options).then((request) => request(this.axios, this.basePath));
|
|
46083
|
+
}
|
|
46084
|
+
|
|
45834
46085
|
/**
|
|
45835
46086
|
*
|
|
45836
46087
|
* @summary ListRBACRoles
|
|
@@ -45852,7 +46103,7 @@ export class SharedApi extends BaseAPI implements SharedApiInterface {
|
|
|
45852
46103
|
* @memberof SharedApi
|
|
45853
46104
|
*/
|
|
45854
46105
|
public mongoListRBACUsers(requestParameters: SharedApiMongoListRBACUsersRequest, options?: RawAxiosRequestConfig) {
|
|
45855
|
-
return SharedApiFp(this.configuration).mongoListRBACUsers(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, options).then((request) => request(this.axios, this.basePath));
|
|
46106
|
+
return SharedApiFp(this.configuration).mongoListRBACUsers(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, requestParameters.allDatabases, options).then((request) => request(this.axios, this.basePath));
|
|
45856
46107
|
}
|
|
45857
46108
|
|
|
45858
46109
|
/**
|
|
@@ -19,6 +19,9 @@ import type { AlertSeverity } from './alert-severity';
|
|
|
19
19
|
// May contain unused imports in some cases
|
|
20
20
|
// @ts-ignore
|
|
21
21
|
import type { AlertStatus } from './alert-status';
|
|
22
|
+
// May contain unused imports in some cases
|
|
23
|
+
// @ts-ignore
|
|
24
|
+
import type { ObjectTypeEnum } from './object-type-enum';
|
|
22
25
|
|
|
23
26
|
/**
|
|
24
27
|
* Alert object information
|
|
@@ -56,6 +59,18 @@ export interface AlertObject {
|
|
|
56
59
|
* @memberof AlertObject
|
|
57
60
|
*/
|
|
58
61
|
'clusterName'?: string;
|
|
62
|
+
/**
|
|
63
|
+
*
|
|
64
|
+
* @type {ObjectTypeEnum}
|
|
65
|
+
* @memberof AlertObject
|
|
66
|
+
*/
|
|
67
|
+
'objectType'?: ObjectTypeEnum;
|
|
68
|
+
/**
|
|
69
|
+
*
|
|
70
|
+
* @type {string}
|
|
71
|
+
* @memberof AlertObject
|
|
72
|
+
*/
|
|
73
|
+
'objectID'?: string | null;
|
|
59
74
|
/**
|
|
60
75
|
*
|
|
61
76
|
* @type {string}
|
|
@@ -686,6 +686,7 @@ export * from './object-privilege-spec';
|
|
|
686
686
|
export * from './object-privilege-subject';
|
|
687
687
|
export * from './object-privilege-subject-type';
|
|
688
688
|
export * from './object-privilege-target';
|
|
689
|
+
export * from './object-type-enum';
|
|
689
690
|
export * from './offline-instance';
|
|
690
691
|
export * from './offline-instance-list';
|
|
691
692
|
export * from './offset-reset-strategy';
|
|
@@ -23,6 +23,12 @@ import type { MongoRBACResourceCapability } from './mongo-rbacresource-capabilit
|
|
|
23
23
|
* @interface MongoRBACCapabilities
|
|
24
24
|
*/
|
|
25
25
|
export interface MongoRBACCapabilities {
|
|
26
|
+
/**
|
|
27
|
+
* Supports allDatabases on the account list endpoint.
|
|
28
|
+
* @type {boolean}
|
|
29
|
+
* @memberof MongoRBACCapabilities
|
|
30
|
+
*/
|
|
31
|
+
'allDatabaseUsers'?: boolean;
|
|
26
32
|
/**
|
|
27
33
|
*
|
|
28
34
|
* @type {string}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* KubeBlocks Cloud API
|
|
5
|
+
* 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: support@apecloud.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
* @enum {string}
|
|
21
|
+
*/
|
|
22
|
+
|
|
23
|
+
export const ObjectTypeEnum = {
|
|
24
|
+
cluster: 'cluster',
|
|
25
|
+
channel: 'channel',
|
|
26
|
+
unknown: 'unknown'
|
|
27
|
+
} as const;
|
|
28
|
+
|
|
29
|
+
export type ObjectTypeEnum = typeof ObjectTypeEnum[keyof typeof ObjectTypeEnum];
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
|
package/src/openapi.yaml
CHANGED
|
@@ -188,6 +188,12 @@ paths:
|
|
|
188
188
|
schema:
|
|
189
189
|
type: string
|
|
190
190
|
default: admin
|
|
191
|
+
- name: allDatabases
|
|
192
|
+
in: query
|
|
193
|
+
description: List accounts from all authentication databases. Overrides database; returns role memberships without effective privileges. Use the user detail endpoint for privileges. Requires viewUser and viewRole on the relevant databases.
|
|
194
|
+
schema:
|
|
195
|
+
type: boolean
|
|
196
|
+
default: false
|
|
191
197
|
responses:
|
|
192
198
|
'200':
|
|
193
199
|
description: Success
|
|
@@ -248,6 +254,89 @@ paths:
|
|
|
248
254
|
application/json:
|
|
249
255
|
schema:
|
|
250
256
|
$ref: '#/components/schemas/MongoRBACUserCreate'
|
|
257
|
+
/api/v1/data/mongodb/organizations/{orgName}/clusters/{clusterName}/databases:
|
|
258
|
+
get:
|
|
259
|
+
summary: List MongoDB cluster databases
|
|
260
|
+
description: Lists existing database names using the cluster management connection. Does not require a personal Workbench datasource.
|
|
261
|
+
operationId: mongoListClusterDatabases
|
|
262
|
+
tags:
|
|
263
|
+
- mongodb
|
|
264
|
+
- account
|
|
265
|
+
- shared
|
|
266
|
+
parameters:
|
|
267
|
+
- name: orgName
|
|
268
|
+
in: path
|
|
269
|
+
required: true
|
|
270
|
+
schema:
|
|
271
|
+
type: string
|
|
272
|
+
- name: clusterName
|
|
273
|
+
in: path
|
|
274
|
+
required: true
|
|
275
|
+
schema:
|
|
276
|
+
type: string
|
|
277
|
+
responses:
|
|
278
|
+
'200':
|
|
279
|
+
description: Database names, sorted; an empty result is an empty array.
|
|
280
|
+
content:
|
|
281
|
+
application/json:
|
|
282
|
+
schema:
|
|
283
|
+
type: array
|
|
284
|
+
items:
|
|
285
|
+
type: string
|
|
286
|
+
'400':
|
|
287
|
+
$ref: '#/components/responses/400'
|
|
288
|
+
'401':
|
|
289
|
+
$ref: '#/components/responses/401'
|
|
290
|
+
'403':
|
|
291
|
+
$ref: '#/components/responses/403'
|
|
292
|
+
'404':
|
|
293
|
+
$ref: '#/components/responses/404'
|
|
294
|
+
'500':
|
|
295
|
+
$ref: '#/components/responses/500'
|
|
296
|
+
/api/v1/data/mongodb/organizations/{orgName}/clusters/{clusterName}/databases/{database}/collections:
|
|
297
|
+
get:
|
|
298
|
+
summary: List MongoDB cluster database objects
|
|
299
|
+
description: Lists existing collections, views and time-series collections in a database using the cluster management connection. Returns metadata, not document contents.
|
|
300
|
+
operationId: mongoListClusterCollections
|
|
301
|
+
tags:
|
|
302
|
+
- mongodb
|
|
303
|
+
- account
|
|
304
|
+
- shared
|
|
305
|
+
parameters:
|
|
306
|
+
- name: orgName
|
|
307
|
+
in: path
|
|
308
|
+
required: true
|
|
309
|
+
schema:
|
|
310
|
+
type: string
|
|
311
|
+
- name: clusterName
|
|
312
|
+
in: path
|
|
313
|
+
required: true
|
|
314
|
+
schema:
|
|
315
|
+
type: string
|
|
316
|
+
- name: database
|
|
317
|
+
in: path
|
|
318
|
+
required: true
|
|
319
|
+
schema:
|
|
320
|
+
type: string
|
|
321
|
+
responses:
|
|
322
|
+
'200':
|
|
323
|
+
description: Database objects; an empty database returns an empty array.
|
|
324
|
+
content:
|
|
325
|
+
application/json:
|
|
326
|
+
schema:
|
|
327
|
+
type: array
|
|
328
|
+
items:
|
|
329
|
+
$ref: '#/components/schemas/MongoCollectionInfo'
|
|
330
|
+
'400':
|
|
331
|
+
$ref: '#/components/responses/400'
|
|
332
|
+
'401':
|
|
333
|
+
$ref: '#/components/responses/401'
|
|
334
|
+
'403':
|
|
335
|
+
$ref: '#/components/responses/403'
|
|
336
|
+
'404':
|
|
337
|
+
$ref: '#/components/responses/404'
|
|
338
|
+
'500':
|
|
339
|
+
$ref: '#/components/responses/500'
|
|
251
340
|
/api/v1/data/mongodb/organizations/{orgName}/clusters/{clusterName}/rbac/capabilities:
|
|
252
341
|
get:
|
|
253
342
|
summary: GetRBACCapabilities
|
|
@@ -24667,6 +24756,42 @@ components:
|
|
|
24667
24756
|
type: array
|
|
24668
24757
|
items:
|
|
24669
24758
|
$ref: '#/components/schemas/MongoRBACRoleRef'
|
|
24759
|
+
MongoCollectionCapabilities:
|
|
24760
|
+
type: object
|
|
24761
|
+
properties:
|
|
24762
|
+
canReadDocuments:
|
|
24763
|
+
type: boolean
|
|
24764
|
+
x-omitempty: false
|
|
24765
|
+
canWriteDocuments:
|
|
24766
|
+
type: boolean
|
|
24767
|
+
x-omitempty: false
|
|
24768
|
+
canManageIndexes:
|
|
24769
|
+
type: boolean
|
|
24770
|
+
x-omitempty: false
|
|
24771
|
+
canSetValidation:
|
|
24772
|
+
type: boolean
|
|
24773
|
+
x-omitempty: false
|
|
24774
|
+
canDrop:
|
|
24775
|
+
type: boolean
|
|
24776
|
+
x-omitempty: false
|
|
24777
|
+
MongoCollectionInfo:
|
|
24778
|
+
type: object
|
|
24779
|
+
properties:
|
|
24780
|
+
name:
|
|
24781
|
+
type: string
|
|
24782
|
+
description: collection or view name
|
|
24783
|
+
type:
|
|
24784
|
+
type: string
|
|
24785
|
+
description: collection type (collection or view)
|
|
24786
|
+
isSystem:
|
|
24787
|
+
type: boolean
|
|
24788
|
+
description: whether this is a MongoDB system collection
|
|
24789
|
+
x-omitempty: false
|
|
24790
|
+
capabilities:
|
|
24791
|
+
$ref: '#/components/schemas/MongoCollectionCapabilities'
|
|
24792
|
+
options:
|
|
24793
|
+
type: object
|
|
24794
|
+
description: collection options, including viewOn/pipeline when type is view
|
|
24670
24795
|
MongoRBACResourceCapability:
|
|
24671
24796
|
type: object
|
|
24672
24797
|
properties:
|
|
@@ -24683,6 +24808,9 @@ components:
|
|
|
24683
24808
|
MongoRBACCapabilities:
|
|
24684
24809
|
type: object
|
|
24685
24810
|
properties:
|
|
24811
|
+
allDatabaseUsers:
|
|
24812
|
+
type: boolean
|
|
24813
|
+
description: Supports allDatabases on the account list endpoint.
|
|
24686
24814
|
engineVersion:
|
|
24687
24815
|
type: string
|
|
24688
24816
|
resources:
|
|
@@ -33943,6 +34071,12 @@ components:
|
|
|
33943
34071
|
pageResult:
|
|
33944
34072
|
$ref: '#/components/schemas/pageResult'
|
|
33945
34073
|
description: AlertRuleList is a list of alert rules
|
|
34074
|
+
objectTypeEnum:
|
|
34075
|
+
type: string
|
|
34076
|
+
enum:
|
|
34077
|
+
- cluster
|
|
34078
|
+
- channel
|
|
34079
|
+
- unknown
|
|
33946
34080
|
alertStatus:
|
|
33947
34081
|
enum:
|
|
33948
34082
|
- resolved
|
|
@@ -33961,6 +34095,12 @@ components:
|
|
|
33961
34095
|
type: string
|
|
33962
34096
|
clusterName:
|
|
33963
34097
|
type: string
|
|
34098
|
+
objectType:
|
|
34099
|
+
$ref: '#/components/schemas/objectTypeEnum'
|
|
34100
|
+
nullable: true
|
|
34101
|
+
objectID:
|
|
34102
|
+
type: string
|
|
34103
|
+
nullable: true
|
|
33964
34104
|
objectName:
|
|
33965
34105
|
type: string
|
|
33966
34106
|
engine:
|
|
@@ -38466,42 +38606,6 @@ components:
|
|
|
38466
38606
|
isSystem:
|
|
38467
38607
|
type: boolean
|
|
38468
38608
|
x-omitempty: false
|
|
38469
|
-
MongoCollectionCapabilities:
|
|
38470
|
-
type: object
|
|
38471
|
-
properties:
|
|
38472
|
-
canReadDocuments:
|
|
38473
|
-
type: boolean
|
|
38474
|
-
x-omitempty: false
|
|
38475
|
-
canWriteDocuments:
|
|
38476
|
-
type: boolean
|
|
38477
|
-
x-omitempty: false
|
|
38478
|
-
canManageIndexes:
|
|
38479
|
-
type: boolean
|
|
38480
|
-
x-omitempty: false
|
|
38481
|
-
canSetValidation:
|
|
38482
|
-
type: boolean
|
|
38483
|
-
x-omitempty: false
|
|
38484
|
-
canDrop:
|
|
38485
|
-
type: boolean
|
|
38486
|
-
x-omitempty: false
|
|
38487
|
-
MongoCollectionInfo:
|
|
38488
|
-
type: object
|
|
38489
|
-
properties:
|
|
38490
|
-
name:
|
|
38491
|
-
type: string
|
|
38492
|
-
description: collection or view name
|
|
38493
|
-
type:
|
|
38494
|
-
type: string
|
|
38495
|
-
description: collection type (collection or view)
|
|
38496
|
-
isSystem:
|
|
38497
|
-
type: boolean
|
|
38498
|
-
description: whether this is a MongoDB system collection
|
|
38499
|
-
x-omitempty: false
|
|
38500
|
-
capabilities:
|
|
38501
|
-
$ref: '#/components/schemas/MongoCollectionCapabilities'
|
|
38502
|
-
options:
|
|
38503
|
-
type: object
|
|
38504
|
-
description: collection options, including viewOn/pipeline when type is view
|
|
38505
38609
|
MongoCollectionStats:
|
|
38506
38610
|
type: object
|
|
38507
38611
|
properties:
|