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.
Files changed (67) hide show
  1. package/dist/adminapi/apis/account-api.d.ts +145 -2
  2. package/dist/adminapi/apis/account-api.d.ts.map +1 -1
  3. package/dist/adminapi/apis/account-api.js +163 -5
  4. package/dist/adminapi/apis/account-api.js.map +1 -1
  5. package/dist/adminapi/apis/mongodb-api.d.ts +145 -2
  6. package/dist/adminapi/apis/mongodb-api.d.ts.map +1 -1
  7. package/dist/adminapi/apis/mongodb-api.js +163 -5
  8. package/dist/adminapi/apis/mongodb-api.js.map +1 -1
  9. package/dist/adminapi/apis/shared-api.d.ts +145 -2
  10. package/dist/adminapi/apis/shared-api.d.ts.map +1 -1
  11. package/dist/adminapi/apis/shared-api.js +163 -5
  12. package/dist/adminapi/apis/shared-api.js.map +1 -1
  13. package/dist/adminapi/models/alert-object.d.ts +13 -0
  14. package/dist/adminapi/models/alert-object.d.ts.map +1 -1
  15. package/dist/adminapi/models/index.d.ts +1 -0
  16. package/dist/adminapi/models/index.d.ts.map +1 -1
  17. package/dist/adminapi/models/index.js +1 -0
  18. package/dist/adminapi/models/index.js.map +1 -1
  19. package/dist/adminapi/models/mongo-rbaccapabilities.d.ts +6 -0
  20. package/dist/adminapi/models/mongo-rbaccapabilities.d.ts.map +1 -1
  21. package/dist/adminapi/models/object-type-enum.d.ts +23 -0
  22. package/dist/adminapi/models/object-type-enum.d.ts.map +1 -0
  23. package/dist/adminapi/models/object-type-enum.js +27 -0
  24. package/dist/adminapi/models/object-type-enum.js.map +1 -0
  25. package/dist/openapi/apis/account-api.d.ts +145 -2
  26. package/dist/openapi/apis/account-api.d.ts.map +1 -1
  27. package/dist/openapi/apis/account-api.js +163 -5
  28. package/dist/openapi/apis/account-api.js.map +1 -1
  29. package/dist/openapi/apis/mongodb-api.d.ts +145 -2
  30. package/dist/openapi/apis/mongodb-api.d.ts.map +1 -1
  31. package/dist/openapi/apis/mongodb-api.js +163 -5
  32. package/dist/openapi/apis/mongodb-api.js.map +1 -1
  33. package/dist/openapi/apis/shared-api.d.ts +145 -2
  34. package/dist/openapi/apis/shared-api.d.ts.map +1 -1
  35. package/dist/openapi/apis/shared-api.js +163 -5
  36. package/dist/openapi/apis/shared-api.js.map +1 -1
  37. package/dist/openapi/models/alert-object.d.ts +13 -0
  38. package/dist/openapi/models/alert-object.d.ts.map +1 -1
  39. package/dist/openapi/models/index.d.ts +1 -0
  40. package/dist/openapi/models/index.d.ts.map +1 -1
  41. package/dist/openapi/models/index.js +1 -0
  42. package/dist/openapi/models/index.js.map +1 -1
  43. package/dist/openapi/models/mongo-rbaccapabilities.d.ts +6 -0
  44. package/dist/openapi/models/mongo-rbaccapabilities.d.ts.map +1 -1
  45. package/dist/openapi/models/object-type-enum.d.ts +23 -0
  46. package/dist/openapi/models/object-type-enum.d.ts.map +1 -0
  47. package/dist/openapi/models/object-type-enum.js +27 -0
  48. package/dist/openapi/models/object-type-enum.js.map +1 -0
  49. package/package.json +1 -1
  50. package/src/adminapi/.openapi-generator/FILES +1 -0
  51. package/src/adminapi/apis/account-api.ts +256 -5
  52. package/src/adminapi/apis/mongodb-api.ts +256 -5
  53. package/src/adminapi/apis/shared-api.ts +256 -5
  54. package/src/adminapi/models/alert-object.ts +15 -0
  55. package/src/adminapi/models/index.ts +1 -0
  56. package/src/adminapi/models/mongo-rbaccapabilities.ts +6 -0
  57. package/src/adminapi/models/object-type-enum.ts +32 -0
  58. package/src/adminapi.yaml +140 -36
  59. package/src/openapi/.openapi-generator/FILES +1 -0
  60. package/src/openapi/apis/account-api.ts +256 -5
  61. package/src/openapi/apis/mongodb-api.ts +256 -5
  62. package/src/openapi/apis/shared-api.ts +256 -5
  63. package/src/openapi/models/alert-object.ts +15 -0
  64. package/src/openapi/models/index.ts +1 -0
  65. package/src/openapi/models/mongo-rbaccapabilities.ts +6 -0
  66. package/src/openapi/models/object-type-enum.ts +32 -0
  67. package/src/openapi.yaml +140 -36
@@ -284,6 +284,8 @@ import type { MilvusRoleList } from '../models';
284
284
  // @ts-ignore
285
285
  import type { MilvusRoleRequest } from '../models';
286
286
  // @ts-ignore
287
+ import type { MongoCollectionInfo } from '../models';
288
+ // @ts-ignore
287
289
  import type { MongoRBACBindingChange } from '../models';
288
290
  // @ts-ignore
289
291
  import type { MongoRBACCapabilities } from '../models';
@@ -13326,6 +13328,100 @@ export const SharedApiAxiosParamCreator = function (configuration?: Configuratio
13326
13328
 
13327
13329
 
13328
13330
 
13331
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
13332
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
13333
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
13334
+
13335
+ return {
13336
+ url: toPathString(localVarUrlObj),
13337
+ options: localVarRequestOptions,
13338
+ };
13339
+ },
13340
+ /**
13341
+ * Lists existing collections, views and time-series collections in a database using the cluster management connection. Returns metadata, not document contents.
13342
+ * @summary List MongoDB cluster database objects
13343
+ * @param {string} orgName
13344
+ * @param {string} clusterName
13345
+ * @param {string} database
13346
+ * @param {*} [options] Override http request option.
13347
+ * @throws {RequiredError}
13348
+ */
13349
+ mongoListClusterCollections: async (orgName: string, clusterName: string, database: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13350
+ // verify required parameter 'orgName' is not null or undefined
13351
+ assertParamExists('mongoListClusterCollections', 'orgName', orgName)
13352
+ // verify required parameter 'clusterName' is not null or undefined
13353
+ assertParamExists('mongoListClusterCollections', 'clusterName', clusterName)
13354
+ // verify required parameter 'database' is not null or undefined
13355
+ assertParamExists('mongoListClusterCollections', 'database', database)
13356
+ const localVarPath = `/admin/v1/data/mongodb/organizations/{orgName}/clusters/{clusterName}/databases/{database}/collections`
13357
+ .replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
13358
+ .replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)))
13359
+ .replace(`{${"database"}}`, encodeURIComponent(String(database)));
13360
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
13361
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
13362
+ let baseOptions;
13363
+ if (configuration) {
13364
+ baseOptions = configuration.baseOptions;
13365
+ }
13366
+
13367
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
13368
+ const localVarHeaderParameter = {} as any;
13369
+ const localVarQueryParameter = {} as any;
13370
+
13371
+ // authentication BearerToken required
13372
+ // http bearer authentication required
13373
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
13374
+
13375
+ // authentication DigestAuth required
13376
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
13377
+
13378
+
13379
+
13380
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
13381
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
13382
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
13383
+
13384
+ return {
13385
+ url: toPathString(localVarUrlObj),
13386
+ options: localVarRequestOptions,
13387
+ };
13388
+ },
13389
+ /**
13390
+ * Lists existing database names using the cluster management connection. Does not require a personal Workbench datasource.
13391
+ * @summary List MongoDB cluster databases
13392
+ * @param {string} orgName
13393
+ * @param {string} clusterName
13394
+ * @param {*} [options] Override http request option.
13395
+ * @throws {RequiredError}
13396
+ */
13397
+ mongoListClusterDatabases: async (orgName: string, clusterName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13398
+ // verify required parameter 'orgName' is not null or undefined
13399
+ assertParamExists('mongoListClusterDatabases', 'orgName', orgName)
13400
+ // verify required parameter 'clusterName' is not null or undefined
13401
+ assertParamExists('mongoListClusterDatabases', 'clusterName', clusterName)
13402
+ const localVarPath = `/admin/v1/data/mongodb/organizations/{orgName}/clusters/{clusterName}/databases`
13403
+ .replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
13404
+ .replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)));
13405
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
13406
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
13407
+ let baseOptions;
13408
+ if (configuration) {
13409
+ baseOptions = configuration.baseOptions;
13410
+ }
13411
+
13412
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
13413
+ const localVarHeaderParameter = {} as any;
13414
+ const localVarQueryParameter = {} as any;
13415
+
13416
+ // authentication BearerToken required
13417
+ // http bearer authentication required
13418
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
13419
+
13420
+ // authentication DigestAuth required
13421
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
13422
+
13423
+
13424
+
13329
13425
  setSearchParams(localVarUrlObj, localVarQueryParameter);
13330
13426
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
13331
13427
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -13391,10 +13487,11 @@ export const SharedApiAxiosParamCreator = function (configuration?: Configuratio
13391
13487
  * @param {string} orgName
13392
13488
  * @param {string} clusterName
13393
13489
  * @param {string} [database]
13490
+ * @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.
13394
13491
  * @param {*} [options] Override http request option.
13395
13492
  * @throws {RequiredError}
13396
13493
  */
13397
- mongoListRBACUsers: async (orgName: string, clusterName: string, database?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13494
+ mongoListRBACUsers: async (orgName: string, clusterName: string, database?: string, allDatabases?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13398
13495
  // verify required parameter 'orgName' is not null or undefined
13399
13496
  assertParamExists('mongoListRBACUsers', 'orgName', orgName)
13400
13497
  // verify required parameter 'clusterName' is not null or undefined
@@ -13424,6 +13521,10 @@ export const SharedApiAxiosParamCreator = function (configuration?: Configuratio
13424
13521
  localVarQueryParameter['database'] = database;
13425
13522
  }
13426
13523
 
13524
+ if (allDatabases !== undefined) {
13525
+ localVarQueryParameter['allDatabases'] = allDatabases;
13526
+ }
13527
+
13427
13528
 
13428
13529
 
13429
13530
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -22794,6 +22895,35 @@ export const SharedApiFp = function(configuration?: Configuration) {
22794
22895
  const localVarOperationServerBasePath = operationServerMap['SharedApi.mongoGetRBACUser']?.[localVarOperationServerIndex]?.url;
22795
22896
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
22796
22897
  },
22898
+ /**
22899
+ * Lists existing collections, views and time-series collections in a database using the cluster management connection. Returns metadata, not document contents.
22900
+ * @summary List MongoDB cluster database objects
22901
+ * @param {string} orgName
22902
+ * @param {string} clusterName
22903
+ * @param {string} database
22904
+ * @param {*} [options] Override http request option.
22905
+ * @throws {RequiredError}
22906
+ */
22907
+ async mongoListClusterCollections(orgName: string, clusterName: string, database: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MongoCollectionInfo>>> {
22908
+ const localVarAxiosArgs = await localVarAxiosParamCreator.mongoListClusterCollections(orgName, clusterName, database, options);
22909
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
22910
+ const localVarOperationServerBasePath = operationServerMap['SharedApi.mongoListClusterCollections']?.[localVarOperationServerIndex]?.url;
22911
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
22912
+ },
22913
+ /**
22914
+ * Lists existing database names using the cluster management connection. Does not require a personal Workbench datasource.
22915
+ * @summary List MongoDB cluster databases
22916
+ * @param {string} orgName
22917
+ * @param {string} clusterName
22918
+ * @param {*} [options] Override http request option.
22919
+ * @throws {RequiredError}
22920
+ */
22921
+ async mongoListClusterDatabases(orgName: string, clusterName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>> {
22922
+ const localVarAxiosArgs = await localVarAxiosParamCreator.mongoListClusterDatabases(orgName, clusterName, options);
22923
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
22924
+ const localVarOperationServerBasePath = operationServerMap['SharedApi.mongoListClusterDatabases']?.[localVarOperationServerIndex]?.url;
22925
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
22926
+ },
22797
22927
  /**
22798
22928
  *
22799
22929
  * @summary ListRBACRoles
@@ -22815,11 +22945,12 @@ export const SharedApiFp = function(configuration?: Configuration) {
22815
22945
  * @param {string} orgName
22816
22946
  * @param {string} clusterName
22817
22947
  * @param {string} [database]
22948
+ * @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.
22818
22949
  * @param {*} [options] Override http request option.
22819
22950
  * @throws {RequiredError}
22820
22951
  */
22821
- async mongoListRBACUsers(orgName: string, clusterName: string, database?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MongoRBACUser>>> {
22822
- const localVarAxiosArgs = await localVarAxiosParamCreator.mongoListRBACUsers(orgName, clusterName, database, options);
22952
+ async mongoListRBACUsers(orgName: string, clusterName: string, database?: string, allDatabases?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MongoRBACUser>>> {
22953
+ const localVarAxiosArgs = await localVarAxiosParamCreator.mongoListRBACUsers(orgName, clusterName, database, allDatabases, options);
22823
22954
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
22824
22955
  const localVarOperationServerBasePath = operationServerMap['SharedApi.mongoListRBACUsers']?.[localVarOperationServerIndex]?.url;
22825
22956
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -26812,6 +26943,26 @@ export const SharedApiFactory = function (configuration?: Configuration, basePat
26812
26943
  mongoGetRBACUser(requestParameters: SharedApiMongoGetRBACUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<MongoRBACUser> {
26813
26944
  return localVarFp.mongoGetRBACUser(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, requestParameters.username, options).then((request) => request(axios, basePath));
26814
26945
  },
26946
+ /**
26947
+ * Lists existing collections, views and time-series collections in a database using the cluster management connection. Returns metadata, not document contents.
26948
+ * @summary List MongoDB cluster database objects
26949
+ * @param {SharedApiMongoListClusterCollectionsRequest} requestParameters Request parameters.
26950
+ * @param {*} [options] Override http request option.
26951
+ * @throws {RequiredError}
26952
+ */
26953
+ mongoListClusterCollections(requestParameters: SharedApiMongoListClusterCollectionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<MongoCollectionInfo>> {
26954
+ return localVarFp.mongoListClusterCollections(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, options).then((request) => request(axios, basePath));
26955
+ },
26956
+ /**
26957
+ * Lists existing database names using the cluster management connection. Does not require a personal Workbench datasource.
26958
+ * @summary List MongoDB cluster databases
26959
+ * @param {SharedApiMongoListClusterDatabasesRequest} requestParameters Request parameters.
26960
+ * @param {*} [options] Override http request option.
26961
+ * @throws {RequiredError}
26962
+ */
26963
+ mongoListClusterDatabases(requestParameters: SharedApiMongoListClusterDatabasesRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>> {
26964
+ return localVarFp.mongoListClusterDatabases(requestParameters.orgName, requestParameters.clusterName, options).then((request) => request(axios, basePath));
26965
+ },
26815
26966
  /**
26816
26967
  *
26817
26968
  * @summary ListRBACRoles
@@ -26830,7 +26981,7 @@ export const SharedApiFactory = function (configuration?: Configuration, basePat
26830
26981
  * @throws {RequiredError}
26831
26982
  */
26832
26983
  mongoListRBACUsers(requestParameters: SharedApiMongoListRBACUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<MongoRBACUser>> {
26833
- return localVarFp.mongoListRBACUsers(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, options).then((request) => request(axios, basePath));
26984
+ return localVarFp.mongoListRBACUsers(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, requestParameters.allDatabases, options).then((request) => request(axios, basePath));
26834
26985
  },
26835
26986
  /**
26836
26987
  *
@@ -30174,6 +30325,26 @@ export interface SharedApiInterface {
30174
30325
  */
30175
30326
  mongoGetRBACUser(requestParameters: SharedApiMongoGetRBACUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<MongoRBACUser>;
30176
30327
 
30328
+ /**
30329
+ * Lists existing collections, views and time-series collections in a database using the cluster management connection. Returns metadata, not document contents.
30330
+ * @summary List MongoDB cluster database objects
30331
+ * @param {SharedApiMongoListClusterCollectionsRequest} requestParameters Request parameters.
30332
+ * @param {*} [options] Override http request option.
30333
+ * @throws {RequiredError}
30334
+ * @memberof SharedApiInterface
30335
+ */
30336
+ mongoListClusterCollections(requestParameters: SharedApiMongoListClusterCollectionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<MongoCollectionInfo>>;
30337
+
30338
+ /**
30339
+ * Lists existing database names using the cluster management connection. Does not require a personal Workbench datasource.
30340
+ * @summary List MongoDB cluster databases
30341
+ * @param {SharedApiMongoListClusterDatabasesRequest} requestParameters Request parameters.
30342
+ * @param {*} [options] Override http request option.
30343
+ * @throws {RequiredError}
30344
+ * @memberof SharedApiInterface
30345
+ */
30346
+ mongoListClusterDatabases(requestParameters: SharedApiMongoListClusterDatabasesRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
30347
+
30177
30348
  /**
30178
30349
  *
30179
30350
  * @summary ListRBACRoles
@@ -38776,6 +38947,55 @@ export interface SharedApiMongoGetRBACUserRequest {
38776
38947
  readonly username: string
38777
38948
  }
38778
38949
 
38950
+ /**
38951
+ * Request parameters for mongoListClusterCollections operation in SharedApi.
38952
+ * @export
38953
+ * @interface SharedApiMongoListClusterCollectionsRequest
38954
+ */
38955
+ export interface SharedApiMongoListClusterCollectionsRequest {
38956
+ /**
38957
+ *
38958
+ * @type {string}
38959
+ * @memberof SharedApiMongoListClusterCollections
38960
+ */
38961
+ readonly orgName: string
38962
+
38963
+ /**
38964
+ *
38965
+ * @type {string}
38966
+ * @memberof SharedApiMongoListClusterCollections
38967
+ */
38968
+ readonly clusterName: string
38969
+
38970
+ /**
38971
+ *
38972
+ * @type {string}
38973
+ * @memberof SharedApiMongoListClusterCollections
38974
+ */
38975
+ readonly database: string
38976
+ }
38977
+
38978
+ /**
38979
+ * Request parameters for mongoListClusterDatabases operation in SharedApi.
38980
+ * @export
38981
+ * @interface SharedApiMongoListClusterDatabasesRequest
38982
+ */
38983
+ export interface SharedApiMongoListClusterDatabasesRequest {
38984
+ /**
38985
+ *
38986
+ * @type {string}
38987
+ * @memberof SharedApiMongoListClusterDatabases
38988
+ */
38989
+ readonly orgName: string
38990
+
38991
+ /**
38992
+ *
38993
+ * @type {string}
38994
+ * @memberof SharedApiMongoListClusterDatabases
38995
+ */
38996
+ readonly clusterName: string
38997
+ }
38998
+
38779
38999
  /**
38780
39000
  * Request parameters for mongoListRBACRoles operation in SharedApi.
38781
39001
  * @export
@@ -38830,6 +39050,13 @@ export interface SharedApiMongoListRBACUsersRequest {
38830
39050
  * @memberof SharedApiMongoListRBACUsers
38831
39051
  */
38832
39052
  readonly database?: string
39053
+
39054
+ /**
39055
+ * 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.
39056
+ * @type {boolean}
39057
+ * @memberof SharedApiMongoListRBACUsers
39058
+ */
39059
+ readonly allDatabases?: boolean
38833
39060
  }
38834
39061
 
38835
39062
  /**
@@ -45614,6 +45841,30 @@ export class SharedApi extends BaseAPI implements SharedApiInterface {
45614
45841
  return SharedApiFp(this.configuration).mongoGetRBACUser(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, requestParameters.username, options).then((request) => request(this.axios, this.basePath));
45615
45842
  }
45616
45843
 
45844
+ /**
45845
+ * Lists existing collections, views and time-series collections in a database using the cluster management connection. Returns metadata, not document contents.
45846
+ * @summary List MongoDB cluster database objects
45847
+ * @param {SharedApiMongoListClusterCollectionsRequest} requestParameters Request parameters.
45848
+ * @param {*} [options] Override http request option.
45849
+ * @throws {RequiredError}
45850
+ * @memberof SharedApi
45851
+ */
45852
+ public mongoListClusterCollections(requestParameters: SharedApiMongoListClusterCollectionsRequest, options?: RawAxiosRequestConfig) {
45853
+ return SharedApiFp(this.configuration).mongoListClusterCollections(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, options).then((request) => request(this.axios, this.basePath));
45854
+ }
45855
+
45856
+ /**
45857
+ * Lists existing database names using the cluster management connection. Does not require a personal Workbench datasource.
45858
+ * @summary List MongoDB cluster databases
45859
+ * @param {SharedApiMongoListClusterDatabasesRequest} requestParameters Request parameters.
45860
+ * @param {*} [options] Override http request option.
45861
+ * @throws {RequiredError}
45862
+ * @memberof SharedApi
45863
+ */
45864
+ public mongoListClusterDatabases(requestParameters: SharedApiMongoListClusterDatabasesRequest, options?: RawAxiosRequestConfig) {
45865
+ return SharedApiFp(this.configuration).mongoListClusterDatabases(requestParameters.orgName, requestParameters.clusterName, options).then((request) => request(this.axios, this.basePath));
45866
+ }
45867
+
45617
45868
  /**
45618
45869
  *
45619
45870
  * @summary ListRBACRoles
@@ -45635,7 +45886,7 @@ export class SharedApi extends BaseAPI implements SharedApiInterface {
45635
45886
  * @memberof SharedApi
45636
45887
  */
45637
45888
  public mongoListRBACUsers(requestParameters: SharedApiMongoListRBACUsersRequest, options?: RawAxiosRequestConfig) {
45638
- return SharedApiFp(this.configuration).mongoListRBACUsers(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, options).then((request) => request(this.axios, this.basePath));
45889
+ return SharedApiFp(this.configuration).mongoListRBACUsers(requestParameters.orgName, requestParameters.clusterName, requestParameters.database, requestParameters.allDatabases, options).then((request) => request(this.axios, this.basePath));
45639
45890
  }
45640
45891
 
45641
45892
  /**
@@ -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}
@@ -780,6 +780,7 @@ export * from './object-privilege-spec';
780
780
  export * from './object-privilege-subject';
781
781
  export * from './object-privilege-subject-type';
782
782
  export * from './object-privilege-target';
783
+ export * from './object-type-enum';
783
784
  export * from './offline-instance';
784
785
  export * from './offline-instance-list';
785
786
  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
+ * Admin API
5
+ * The Admin API is used to manage the ApeCloud platform.
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/adminapi.yaml CHANGED
@@ -150,6 +150,12 @@ paths:
150
150
  schema:
151
151
  type: string
152
152
  default: admin
153
+ - name: allDatabases
154
+ in: query
155
+ 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.
156
+ schema:
157
+ type: boolean
158
+ default: false
153
159
  responses:
154
160
  '200':
155
161
  description: Success
@@ -210,6 +216,89 @@ paths:
210
216
  application/json:
211
217
  schema:
212
218
  $ref: '#/components/schemas/MongoRBACUserCreate'
219
+ /admin/v1/data/mongodb/organizations/{orgName}/clusters/{clusterName}/databases:
220
+ get:
221
+ summary: List MongoDB cluster databases
222
+ description: Lists existing database names using the cluster management connection. Does not require a personal Workbench datasource.
223
+ operationId: mongoListClusterDatabases
224
+ tags:
225
+ - mongodb
226
+ - account
227
+ - shared
228
+ parameters:
229
+ - name: orgName
230
+ in: path
231
+ required: true
232
+ schema:
233
+ type: string
234
+ - name: clusterName
235
+ in: path
236
+ required: true
237
+ schema:
238
+ type: string
239
+ responses:
240
+ '200':
241
+ description: Database names, sorted; an empty result is an empty array.
242
+ content:
243
+ application/json:
244
+ schema:
245
+ type: array
246
+ items:
247
+ type: string
248
+ '400':
249
+ $ref: '#/components/responses/400'
250
+ '401':
251
+ $ref: '#/components/responses/401'
252
+ '403':
253
+ $ref: '#/components/responses/403'
254
+ '404':
255
+ $ref: '#/components/responses/404'
256
+ '500':
257
+ $ref: '#/components/responses/500'
258
+ /admin/v1/data/mongodb/organizations/{orgName}/clusters/{clusterName}/databases/{database}/collections:
259
+ get:
260
+ summary: List MongoDB cluster database objects
261
+ description: Lists existing collections, views and time-series collections in a database using the cluster management connection. Returns metadata, not document contents.
262
+ operationId: mongoListClusterCollections
263
+ tags:
264
+ - mongodb
265
+ - account
266
+ - shared
267
+ parameters:
268
+ - name: orgName
269
+ in: path
270
+ required: true
271
+ schema:
272
+ type: string
273
+ - name: clusterName
274
+ in: path
275
+ required: true
276
+ schema:
277
+ type: string
278
+ - name: database
279
+ in: path
280
+ required: true
281
+ schema:
282
+ type: string
283
+ responses:
284
+ '200':
285
+ description: Database objects; an empty database returns an empty array.
286
+ content:
287
+ application/json:
288
+ schema:
289
+ type: array
290
+ items:
291
+ $ref: '#/components/schemas/MongoCollectionInfo'
292
+ '400':
293
+ $ref: '#/components/responses/400'
294
+ '401':
295
+ $ref: '#/components/responses/401'
296
+ '403':
297
+ $ref: '#/components/responses/403'
298
+ '404':
299
+ $ref: '#/components/responses/404'
300
+ '500':
301
+ $ref: '#/components/responses/500'
213
302
  /admin/v1/data/mongodb/organizations/{orgName}/clusters/{clusterName}/rbac/capabilities:
214
303
  get:
215
304
  summary: GetRBACCapabilities
@@ -29938,6 +30027,42 @@ components:
29938
30027
  type: array
29939
30028
  items:
29940
30029
  $ref: '#/components/schemas/MongoRBACRoleRef'
30030
+ MongoCollectionCapabilities:
30031
+ type: object
30032
+ properties:
30033
+ canReadDocuments:
30034
+ type: boolean
30035
+ x-omitempty: false
30036
+ canWriteDocuments:
30037
+ type: boolean
30038
+ x-omitempty: false
30039
+ canManageIndexes:
30040
+ type: boolean
30041
+ x-omitempty: false
30042
+ canSetValidation:
30043
+ type: boolean
30044
+ x-omitempty: false
30045
+ canDrop:
30046
+ type: boolean
30047
+ x-omitempty: false
30048
+ MongoCollectionInfo:
30049
+ type: object
30050
+ properties:
30051
+ name:
30052
+ type: string
30053
+ description: collection or view name
30054
+ type:
30055
+ type: string
30056
+ description: collection type (collection or view)
30057
+ isSystem:
30058
+ type: boolean
30059
+ description: whether this is a MongoDB system collection
30060
+ x-omitempty: false
30061
+ capabilities:
30062
+ $ref: '#/components/schemas/MongoCollectionCapabilities'
30063
+ options:
30064
+ type: object
30065
+ description: collection options, including viewOn/pipeline when type is view
29941
30066
  MongoRBACResourceCapability:
29942
30067
  type: object
29943
30068
  properties:
@@ -29954,6 +30079,9 @@ components:
29954
30079
  MongoRBACCapabilities:
29955
30080
  type: object
29956
30081
  properties:
30082
+ allDatabaseUsers:
30083
+ type: boolean
30084
+ description: Supports allDatabases on the account list endpoint.
29957
30085
  engineVersion:
29958
30086
  type: string
29959
30087
  resources:
@@ -35814,42 +35942,6 @@ components:
35814
35942
  isSystem:
35815
35943
  type: boolean
35816
35944
  x-omitempty: false
35817
- MongoCollectionCapabilities:
35818
- type: object
35819
- properties:
35820
- canReadDocuments:
35821
- type: boolean
35822
- x-omitempty: false
35823
- canWriteDocuments:
35824
- type: boolean
35825
- x-omitempty: false
35826
- canManageIndexes:
35827
- type: boolean
35828
- x-omitempty: false
35829
- canSetValidation:
35830
- type: boolean
35831
- x-omitempty: false
35832
- canDrop:
35833
- type: boolean
35834
- x-omitempty: false
35835
- MongoCollectionInfo:
35836
- type: object
35837
- properties:
35838
- name:
35839
- type: string
35840
- description: collection or view name
35841
- type:
35842
- type: string
35843
- description: collection type (collection or view)
35844
- isSystem:
35845
- type: boolean
35846
- description: whether this is a MongoDB system collection
35847
- x-omitempty: false
35848
- capabilities:
35849
- $ref: '#/components/schemas/MongoCollectionCapabilities'
35850
- options:
35851
- type: object
35852
- description: collection options, including viewOn/pipeline when type is view
35853
35945
  MongoCollectionStats:
35854
35946
  type: object
35855
35947
  properties:
@@ -40631,6 +40723,12 @@ components:
40631
40723
  type: integer
40632
40724
  info:
40633
40725
  type: integer
40726
+ objectTypeEnum:
40727
+ type: string
40728
+ enum:
40729
+ - cluster
40730
+ - channel
40731
+ - unknown
40634
40732
  alertStatus:
40635
40733
  enum:
40636
40734
  - resolved
@@ -40649,6 +40747,12 @@ components:
40649
40747
  type: string
40650
40748
  clusterName:
40651
40749
  type: string
40750
+ objectType:
40751
+ $ref: '#/components/schemas/objectTypeEnum'
40752
+ nullable: true
40753
+ objectID:
40754
+ type: string
40755
+ nullable: true
40652
40756
  objectName:
40653
40757
  type: string
40654
40758
  engine:
@@ -781,6 +781,7 @@ models/object-privilege-spec.ts
781
781
  models/object-privilege-subject-type.ts
782
782
  models/object-privilege-subject.ts
783
783
  models/object-privilege-target.ts
784
+ models/object-type-enum.ts
784
785
  models/offline-instance-list.ts
785
786
  models/offline-instance.ts
786
787
  models/offset-reset-strategy.ts