@sfxcode/nuxt-mongocamp-server 1.7.0 → 1.8.0
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/README.md +8 -0
- package/dist/module.json +1 -1
- package/dist/module.mjs +1 -1
- package/dist/runtime/api/.openapi-generator/FILES +18 -0
- package/dist/runtime/api/apis/AdminApi.d.ts +1 -1
- package/dist/runtime/api/apis/ApplicationApi.d.ts +1 -1
- package/dist/runtime/api/apis/AuthApi.d.ts +1 -1
- package/dist/runtime/api/apis/BucketApi.d.ts +1 -1
- package/dist/runtime/api/apis/CollectionApi.d.ts +58 -2
- package/dist/runtime/api/apis/CollectionApi.js +183 -0
- package/dist/runtime/api/apis/DatabaseApi.d.ts +1 -1
- package/dist/runtime/api/apis/DocumentApi.d.ts +47 -2
- package/dist/runtime/api/apis/DocumentApi.js +145 -0
- package/dist/runtime/api/apis/FileApi.d.ts +1 -1
- package/dist/runtime/api/apis/IndexApi.d.ts +19 -2
- package/dist/runtime/api/apis/IndexApi.js +52 -0
- package/dist/runtime/api/apis/JobsApi.d.ts +1 -1
- package/dist/runtime/api/apis/SystemApi.d.ts +1 -1
- package/dist/runtime/api/docs/CollectionApi.md +253 -1
- package/dist/runtime/api/docs/CopyRequest.md +40 -0
- package/dist/runtime/api/docs/CopyResponse.md +38 -0
- package/dist/runtime/api/docs/DocumentApi.md +196 -5
- package/dist/runtime/api/docs/FieldInfo.md +36 -0
- package/dist/runtime/api/docs/FieldTypeCount.md +36 -0
- package/dist/runtime/api/docs/ImportResponse.md +42 -0
- package/dist/runtime/api/docs/IndexApi.md +78 -0
- package/dist/runtime/api/docs/IndexCreateRequest.md +2 -0
- package/dist/runtime/api/docs/IndexInfo.md +54 -0
- package/dist/runtime/api/docs/IndexKey.md +36 -0
- package/dist/runtime/api/docs/IndexOptionsRequest.md +10 -0
- package/dist/runtime/api/docs/RenameRequest.md +36 -0
- package/dist/runtime/api/docs/RenameResponse.md +34 -0
- package/dist/runtime/api/models/BucketInformation.d.ts +1 -1
- package/dist/runtime/api/models/ClusterInformation.d.ts +1 -1
- package/dist/runtime/api/models/ClusterMemberInformation.d.ts +1 -1
- package/dist/runtime/api/models/CollectionPermission.d.ts +1 -1
- package/dist/runtime/api/models/CollectionStatus.d.ts +1 -1
- package/dist/runtime/api/models/CollectionSummary.d.ts +1 -1
- package/dist/runtime/api/models/CopyRequest.d.ts +50 -0
- package/dist/runtime/api/models/CopyRequest.js +32 -0
- package/dist/runtime/api/models/CopyResponse.d.ts +44 -0
- package/dist/runtime/api/models/CopyResponse.js +32 -0
- package/dist/runtime/api/models/CountResponse.d.ts +1 -1
- package/dist/runtime/api/models/DatabaseInfo.d.ts +1 -1
- package/dist/runtime/api/models/DeleteResponse.d.ts +1 -1
- package/dist/runtime/api/models/ErrorDescription.d.ts +1 -1
- package/dist/runtime/api/models/FieldInfo.d.ts +39 -0
- package/dist/runtime/api/models/FieldInfo.js +32 -0
- package/dist/runtime/api/models/FieldTypeCount.d.ts +38 -0
- package/dist/runtime/api/models/FieldTypeCount.js +29 -0
- package/dist/runtime/api/models/FileInformation.d.ts +1 -1
- package/dist/runtime/api/models/Grant.d.ts +1 -1
- package/dist/runtime/api/models/ImportResponse.d.ts +57 -0
- package/dist/runtime/api/models/ImportResponse.js +41 -0
- package/dist/runtime/api/models/IndexCreateRequest.d.ts +9 -2
- package/dist/runtime/api/models/IndexCreateRequest.js +9 -4
- package/dist/runtime/api/models/IndexCreateResponse.d.ts +1 -1
- package/dist/runtime/api/models/IndexDropResponse.d.ts +1 -1
- package/dist/runtime/api/models/IndexInfo.d.ts +99 -0
- package/dist/runtime/api/models/IndexInfo.js +54 -0
- package/dist/runtime/api/models/IndexKey.d.ts +38 -0
- package/dist/runtime/api/models/IndexKey.js +29 -0
- package/dist/runtime/api/models/IndexOptionsRequest.d.ts +37 -1
- package/dist/runtime/api/models/IndexOptionsRequest.js +12 -2
- package/dist/runtime/api/models/IndexUsage.d.ts +1 -1
- package/dist/runtime/api/models/InsertError.d.ts +1 -1
- package/dist/runtime/api/models/InsertResponse.d.ts +1 -1
- package/dist/runtime/api/models/JobConfig.d.ts +1 -1
- package/dist/runtime/api/models/JobInformation.d.ts +1 -1
- package/dist/runtime/api/models/JsonSchema.d.ts +1 -1
- package/dist/runtime/api/models/JsonSchemaDefinition.d.ts +1 -1
- package/dist/runtime/api/models/JsonValueAny.d.ts +1 -1
- package/dist/runtime/api/models/JsonValueBoolean.d.ts +1 -1
- package/dist/runtime/api/models/JsonValueString.d.ts +1 -1
- package/dist/runtime/api/models/Login.d.ts +1 -1
- package/dist/runtime/api/models/LoginResult.d.ts +1 -1
- package/dist/runtime/api/models/MongoAggregateRequest.d.ts +1 -1
- package/dist/runtime/api/models/MongoCampConfiguration.d.ts +1 -1
- package/dist/runtime/api/models/MongoFindRequest.d.ts +1 -1
- package/dist/runtime/api/models/MongoIndex.d.ts +1 -1
- package/dist/runtime/api/models/PasswordUpdateRequest.d.ts +1 -1
- package/dist/runtime/api/models/PipelineStage.d.ts +1 -1
- package/dist/runtime/api/models/RenameRequest.d.ts +38 -0
- package/dist/runtime/api/models/RenameRequest.js +28 -0
- package/dist/runtime/api/models/RenameResponse.d.ts +32 -0
- package/dist/runtime/api/models/RenameResponse.js +26 -0
- package/dist/runtime/api/models/Role.d.ts +1 -1
- package/dist/runtime/api/models/SchemaAnalysis.d.ts +1 -1
- package/dist/runtime/api/models/SchemaAnalysisField.d.ts +1 -1
- package/dist/runtime/api/models/SchemaAnalysisFieldType.d.ts +1 -1
- package/dist/runtime/api/models/SearchRequest.d.ts +1 -1
- package/dist/runtime/api/models/SettingsResponse.d.ts +1 -1
- package/dist/runtime/api/models/UpdateFileInformationRequest.d.ts +1 -1
- package/dist/runtime/api/models/UpdateRequest.d.ts +1 -1
- package/dist/runtime/api/models/UpdateResponse.d.ts +1 -1
- package/dist/runtime/api/models/UpdateRoleRequest.d.ts +1 -1
- package/dist/runtime/api/models/UserInformation.d.ts +1 -1
- package/dist/runtime/api/models/UserProfile.d.ts +1 -1
- package/dist/runtime/api/models/Version.d.ts +1 -1
- package/dist/runtime/api/models/index.d.ts +9 -0
- package/dist/runtime/api/models/index.js +9 -0
- package/dist/runtime/api/runtime.d.ts +1 -1
- package/package.json +2 -2
|
@@ -2,6 +2,7 @@ import * as runtime from "../runtime.js";
|
|
|
2
2
|
import {
|
|
3
3
|
CountResponseFromJSON,
|
|
4
4
|
DeleteResponseFromJSON,
|
|
5
|
+
ImportResponseFromJSON,
|
|
5
6
|
InsertResponseFromJSON,
|
|
6
7
|
MongoFindRequestToJSON,
|
|
7
8
|
SearchRequestToJSON,
|
|
@@ -186,6 +187,79 @@ export class DocumentApi extends runtime.BaseAPI {
|
|
|
186
187
|
const response = await this.deleteManyRaw(requestParameters, initOverrides);
|
|
187
188
|
return await response.value();
|
|
188
189
|
}
|
|
190
|
+
/**
|
|
191
|
+
* Creates request options for exportDocuments without sending the request
|
|
192
|
+
*/
|
|
193
|
+
async exportDocumentsRequestOpts(requestParameters) {
|
|
194
|
+
if (requestParameters["collectionName"] == null) {
|
|
195
|
+
throw new runtime.RequiredError(
|
|
196
|
+
"collectionName",
|
|
197
|
+
'Required parameter "collectionName" was null or undefined when calling exportDocuments().'
|
|
198
|
+
);
|
|
199
|
+
}
|
|
200
|
+
const queryParameters = {};
|
|
201
|
+
if (requestParameters["format"] != null) {
|
|
202
|
+
queryParameters["format"] = requestParameters["format"];
|
|
203
|
+
}
|
|
204
|
+
if (requestParameters["filter"] != null) {
|
|
205
|
+
queryParameters["filter"] = requestParameters["filter"];
|
|
206
|
+
}
|
|
207
|
+
if (requestParameters["sort"] != null) {
|
|
208
|
+
queryParameters["sort"] = requestParameters["sort"];
|
|
209
|
+
}
|
|
210
|
+
if (requestParameters["projection"] != null) {
|
|
211
|
+
queryParameters["projection"] = requestParameters["projection"];
|
|
212
|
+
}
|
|
213
|
+
if (requestParameters["limit"] != null) {
|
|
214
|
+
queryParameters["limit"] = requestParameters["limit"];
|
|
215
|
+
}
|
|
216
|
+
if (requestParameters["extendedJson"] != null) {
|
|
217
|
+
queryParameters["extendedJson"] = requestParameters["extendedJson"];
|
|
218
|
+
}
|
|
219
|
+
const headerParameters = {};
|
|
220
|
+
if (this.configuration && (this.configuration.username !== void 0 || this.configuration.password !== void 0)) {
|
|
221
|
+
headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
|
|
222
|
+
}
|
|
223
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
224
|
+
const token = this.configuration.accessToken;
|
|
225
|
+
const tokenString = await token("httpAuth", []);
|
|
226
|
+
if (tokenString) {
|
|
227
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
228
|
+
}
|
|
229
|
+
}
|
|
230
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
231
|
+
headerParameters["X-AUTH-APIKEY"] = await this.configuration.apiKey("X-AUTH-APIKEY");
|
|
232
|
+
}
|
|
233
|
+
let urlPath = `/mongodb/collections/{collectionName}/documents/export`;
|
|
234
|
+
urlPath = urlPath.replace(`{${"collectionName"}}`, encodeURIComponent(String(requestParameters["collectionName"])));
|
|
235
|
+
return {
|
|
236
|
+
path: urlPath,
|
|
237
|
+
method: "GET",
|
|
238
|
+
headers: headerParameters,
|
|
239
|
+
query: queryParameters
|
|
240
|
+
};
|
|
241
|
+
}
|
|
242
|
+
/**
|
|
243
|
+
* Download the documents of a Collection as a stream: ndjson (one JSON document per line), json (one array) or csv (a header line, nested values as JSON, a text with a comma, a quote or a line break in quotes). The documents are written while the database delivers them, the memory of the server does not depend on the size of the Collection. The columns of a csv export are the fields of `projection`, by default the fields of the first 1000 documents. With extendedJson the types of the values are explicit. A failure while the stream is running ends the stream, the status is 200 by then.
|
|
244
|
+
* Export Documents of a Collection
|
|
245
|
+
*/
|
|
246
|
+
async exportDocumentsRaw(requestParameters, initOverrides) {
|
|
247
|
+
const requestOptions = await this.exportDocumentsRequestOpts(requestParameters);
|
|
248
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
249
|
+
if (this.isJsonMime(response.headers.get("content-type"))) {
|
|
250
|
+
return new runtime.JSONApiResponse(response);
|
|
251
|
+
} else {
|
|
252
|
+
return new runtime.TextApiResponse(response);
|
|
253
|
+
}
|
|
254
|
+
}
|
|
255
|
+
/**
|
|
256
|
+
* Download the documents of a Collection as a stream: ndjson (one JSON document per line), json (one array) or csv (a header line, nested values as JSON, a text with a comma, a quote or a line break in quotes). The documents are written while the database delivers them, the memory of the server does not depend on the size of the Collection. The columns of a csv export are the fields of `projection`, by default the fields of the first 1000 documents. With extendedJson the types of the values are explicit. A failure while the stream is running ends the stream, the status is 200 by then.
|
|
257
|
+
* Export Documents of a Collection
|
|
258
|
+
*/
|
|
259
|
+
async exportDocuments(requestParameters, initOverrides) {
|
|
260
|
+
const response = await this.exportDocumentsRaw(requestParameters, initOverrides);
|
|
261
|
+
return await response.value();
|
|
262
|
+
}
|
|
189
263
|
/**
|
|
190
264
|
* Creates request options for find without sending the request
|
|
191
265
|
*/
|
|
@@ -209,6 +283,9 @@ export class DocumentApi extends runtime.BaseAPI {
|
|
|
209
283
|
if (requestParameters["page"] != null) {
|
|
210
284
|
queryParameters["page"] = requestParameters["page"];
|
|
211
285
|
}
|
|
286
|
+
if (requestParameters["extendedJson"] != null) {
|
|
287
|
+
queryParameters["extendedJson"] = requestParameters["extendedJson"];
|
|
288
|
+
}
|
|
212
289
|
const headerParameters = {};
|
|
213
290
|
headerParameters["Content-Type"] = "application/json";
|
|
214
291
|
if (this.configuration && (this.configuration.username !== void 0 || this.configuration.password !== void 0)) {
|
|
@@ -268,6 +345,9 @@ export class DocumentApi extends runtime.BaseAPI {
|
|
|
268
345
|
);
|
|
269
346
|
}
|
|
270
347
|
const queryParameters = {};
|
|
348
|
+
if (requestParameters["extendedJson"] != null) {
|
|
349
|
+
queryParameters["extendedJson"] = requestParameters["extendedJson"];
|
|
350
|
+
}
|
|
271
351
|
const headerParameters = {};
|
|
272
352
|
if (this.configuration && (this.configuration.username !== void 0 || this.configuration.password !== void 0)) {
|
|
273
353
|
headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
|
|
@@ -309,6 +389,65 @@ export class DocumentApi extends runtime.BaseAPI {
|
|
|
309
389
|
const response = await this.getDocumentRaw(requestParameters, initOverrides);
|
|
310
390
|
return await response.value();
|
|
311
391
|
}
|
|
392
|
+
/**
|
|
393
|
+
* Creates request options for importDocuments without sending the request
|
|
394
|
+
*/
|
|
395
|
+
async importDocumentsRequestOpts(requestParameters) {
|
|
396
|
+
if (requestParameters["collectionName"] == null) {
|
|
397
|
+
throw new runtime.RequiredError(
|
|
398
|
+
"collectionName",
|
|
399
|
+
'Required parameter "collectionName" was null or undefined when calling importDocuments().'
|
|
400
|
+
);
|
|
401
|
+
}
|
|
402
|
+
if (requestParameters["body"] == null) {
|
|
403
|
+
throw new runtime.RequiredError(
|
|
404
|
+
"body",
|
|
405
|
+
'Required parameter "body" was null or undefined when calling importDocuments().'
|
|
406
|
+
);
|
|
407
|
+
}
|
|
408
|
+
const queryParameters = {};
|
|
409
|
+
const headerParameters = {};
|
|
410
|
+
headerParameters["Content-Type"] = "text/plain";
|
|
411
|
+
if (this.configuration && (this.configuration.username !== void 0 || this.configuration.password !== void 0)) {
|
|
412
|
+
headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
|
|
413
|
+
}
|
|
414
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
415
|
+
const token = this.configuration.accessToken;
|
|
416
|
+
const tokenString = await token("httpAuth", []);
|
|
417
|
+
if (tokenString) {
|
|
418
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
419
|
+
}
|
|
420
|
+
}
|
|
421
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
422
|
+
headerParameters["X-AUTH-APIKEY"] = await this.configuration.apiKey("X-AUTH-APIKEY");
|
|
423
|
+
}
|
|
424
|
+
let urlPath = `/mongodb/collections/{collectionName}/documents/import`;
|
|
425
|
+
urlPath = urlPath.replace(`{${"collectionName"}}`, encodeURIComponent(String(requestParameters["collectionName"])));
|
|
426
|
+
return {
|
|
427
|
+
path: urlPath,
|
|
428
|
+
method: "POST",
|
|
429
|
+
headers: headerParameters,
|
|
430
|
+
query: queryParameters,
|
|
431
|
+
body: requestParameters["body"]
|
|
432
|
+
};
|
|
433
|
+
}
|
|
434
|
+
/**
|
|
435
|
+
* Store the documents of the request body: one JSON document per line (NDJSON, as written by the export). A line is read like a document in the body of an insert (Extended JSON wrappers, dates). The body is read as a stream and the documents are stored in batches without ordering, a line that cannot be stored does not stop the others: the answer counts what was read, stored and failed and names the first failed lines (`errors`, `index` is the number of the line). The size of the body is limited by IMPORT_MAX_BYTES (413 above), there is no time limit.
|
|
436
|
+
* Import Documents into a Collection
|
|
437
|
+
*/
|
|
438
|
+
async importDocumentsRaw(requestParameters, initOverrides) {
|
|
439
|
+
const requestOptions = await this.importDocumentsRequestOpts(requestParameters);
|
|
440
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
441
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => ImportResponseFromJSON(jsonValue));
|
|
442
|
+
}
|
|
443
|
+
/**
|
|
444
|
+
* Store the documents of the request body: one JSON document per line (NDJSON, as written by the export). A line is read like a document in the body of an insert (Extended JSON wrappers, dates). The body is read as a stream and the documents are stored in batches without ordering, a line that cannot be stored does not stop the others: the answer counts what was read, stored and failed and names the first failed lines (`errors`, `index` is the number of the line). The size of the body is limited by IMPORT_MAX_BYTES (413 above), there is no time limit.
|
|
445
|
+
* Import Documents into a Collection
|
|
446
|
+
*/
|
|
447
|
+
async importDocuments(requestParameters, initOverrides) {
|
|
448
|
+
const response = await this.importDocumentsRaw(requestParameters, initOverrides);
|
|
449
|
+
return await response.value();
|
|
450
|
+
}
|
|
312
451
|
/**
|
|
313
452
|
* Creates request options for insert without sending the request
|
|
314
453
|
*/
|
|
@@ -450,6 +589,9 @@ export class DocumentApi extends runtime.BaseAPI {
|
|
|
450
589
|
if (requestParameters["page"] != null) {
|
|
451
590
|
queryParameters["page"] = requestParameters["page"];
|
|
452
591
|
}
|
|
592
|
+
if (requestParameters["extendedJson"] != null) {
|
|
593
|
+
queryParameters["extendedJson"] = requestParameters["extendedJson"];
|
|
594
|
+
}
|
|
453
595
|
const headerParameters = {};
|
|
454
596
|
if (this.configuration && (this.configuration.username !== void 0 || this.configuration.password !== void 0)) {
|
|
455
597
|
headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
|
|
@@ -513,6 +655,9 @@ export class DocumentApi extends runtime.BaseAPI {
|
|
|
513
655
|
if (requestParameters["page"] != null) {
|
|
514
656
|
queryParameters["page"] = requestParameters["page"];
|
|
515
657
|
}
|
|
658
|
+
if (requestParameters["extendedJson"] != null) {
|
|
659
|
+
queryParameters["extendedJson"] = requestParameters["extendedJson"];
|
|
660
|
+
}
|
|
516
661
|
const headerParameters = {};
|
|
517
662
|
headerParameters["Content-Type"] = "application/json";
|
|
518
663
|
if (this.configuration && (this.configuration.username !== void 0 || this.configuration.password !== void 0)) {
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* mongocamp-library
|
|
3
3
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.8.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* mongocamp-library
|
|
3
3
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.8.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime.js';
|
|
13
|
-
import type { IndexCreateRequest, IndexCreateResponse, IndexDropResponse, IndexOptionsRequest, IndexUsage, MongoIndex } from '../models/index.js';
|
|
13
|
+
import type { IndexCreateRequest, IndexCreateResponse, IndexDropResponse, IndexInfo, IndexOptionsRequest, IndexUsage, MongoIndex } from '../models/index.js';
|
|
14
14
|
export interface CreateExpiringIndexRequest {
|
|
15
15
|
collectionName: string;
|
|
16
16
|
fieldName: string;
|
|
@@ -47,6 +47,9 @@ export interface IndexRequest {
|
|
|
47
47
|
collectionName: string;
|
|
48
48
|
indexName: string;
|
|
49
49
|
}
|
|
50
|
+
export interface IndexDetailsRequest {
|
|
51
|
+
collectionName: string;
|
|
52
|
+
}
|
|
50
53
|
export interface IndexStatsRequest {
|
|
51
54
|
collectionName: string;
|
|
52
55
|
}
|
|
@@ -155,6 +158,20 @@ export declare class IndexApi extends runtime.BaseAPI {
|
|
|
155
158
|
* Index for Collection
|
|
156
159
|
*/
|
|
157
160
|
index(requestParameters: IndexRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MongoIndex>;
|
|
161
|
+
/**
|
|
162
|
+
* Creates request options for indexDetails without sending the request
|
|
163
|
+
*/
|
|
164
|
+
indexDetailsRequestOpts(requestParameters: IndexDetailsRequest): Promise<runtime.RequestOpts>;
|
|
165
|
+
/**
|
|
166
|
+
* All Indices of the given Collection as the database reports them: the keys in the order of the index (`direction` is 1, -1 or the type of the key, a text index lists its fields), unique, sparse, hidden, partial filter, collation, weights, default language and expiration.
|
|
167
|
+
* Indices with details for Collection
|
|
168
|
+
*/
|
|
169
|
+
indexDetailsRaw(requestParameters: IndexDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<IndexInfo>>>;
|
|
170
|
+
/**
|
|
171
|
+
* All Indices of the given Collection as the database reports them: the keys in the order of the index (`direction` is 1, -1 or the type of the key, a text index lists its fields), unique, sparse, hidden, partial filter, collation, weights, default language and expiration.
|
|
172
|
+
* Indices with details for Collection
|
|
173
|
+
*/
|
|
174
|
+
indexDetails(requestParameters: IndexDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<IndexInfo>>;
|
|
158
175
|
/**
|
|
159
176
|
* Creates request options for indexStats without sending the request
|
|
160
177
|
*/
|
|
@@ -3,6 +3,7 @@ import {
|
|
|
3
3
|
IndexCreateRequestToJSON,
|
|
4
4
|
IndexCreateResponseFromJSON,
|
|
5
5
|
IndexDropResponseFromJSON,
|
|
6
|
+
IndexInfoFromJSON,
|
|
6
7
|
IndexOptionsRequestToJSON,
|
|
7
8
|
IndexUsageFromJSON,
|
|
8
9
|
MongoIndexFromJSON
|
|
@@ -441,6 +442,57 @@ export class IndexApi extends runtime.BaseAPI {
|
|
|
441
442
|
const response = await this.indexRaw(requestParameters, initOverrides);
|
|
442
443
|
return await response.value();
|
|
443
444
|
}
|
|
445
|
+
/**
|
|
446
|
+
* Creates request options for indexDetails without sending the request
|
|
447
|
+
*/
|
|
448
|
+
async indexDetailsRequestOpts(requestParameters) {
|
|
449
|
+
if (requestParameters["collectionName"] == null) {
|
|
450
|
+
throw new runtime.RequiredError(
|
|
451
|
+
"collectionName",
|
|
452
|
+
'Required parameter "collectionName" was null or undefined when calling indexDetails().'
|
|
453
|
+
);
|
|
454
|
+
}
|
|
455
|
+
const queryParameters = {};
|
|
456
|
+
const headerParameters = {};
|
|
457
|
+
if (this.configuration && (this.configuration.username !== void 0 || this.configuration.password !== void 0)) {
|
|
458
|
+
headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
|
|
459
|
+
}
|
|
460
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
461
|
+
const token = this.configuration.accessToken;
|
|
462
|
+
const tokenString = await token("httpAuth", []);
|
|
463
|
+
if (tokenString) {
|
|
464
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
465
|
+
}
|
|
466
|
+
}
|
|
467
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
468
|
+
headerParameters["X-AUTH-APIKEY"] = await this.configuration.apiKey("X-AUTH-APIKEY");
|
|
469
|
+
}
|
|
470
|
+
let urlPath = `/mongodb/collections/{collectionName}/index/details`;
|
|
471
|
+
urlPath = urlPath.replace(`{${"collectionName"}}`, encodeURIComponent(String(requestParameters["collectionName"])));
|
|
472
|
+
return {
|
|
473
|
+
path: urlPath,
|
|
474
|
+
method: "GET",
|
|
475
|
+
headers: headerParameters,
|
|
476
|
+
query: queryParameters
|
|
477
|
+
};
|
|
478
|
+
}
|
|
479
|
+
/**
|
|
480
|
+
* All Indices of the given Collection as the database reports them: the keys in the order of the index (`direction` is 1, -1 or the type of the key, a text index lists its fields), unique, sparse, hidden, partial filter, collation, weights, default language and expiration.
|
|
481
|
+
* Indices with details for Collection
|
|
482
|
+
*/
|
|
483
|
+
async indexDetailsRaw(requestParameters, initOverrides) {
|
|
484
|
+
const requestOptions = await this.indexDetailsRequestOpts(requestParameters);
|
|
485
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
486
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(IndexInfoFromJSON));
|
|
487
|
+
}
|
|
488
|
+
/**
|
|
489
|
+
* All Indices of the given Collection as the database reports them: the keys in the order of the index (`direction` is 1, -1 or the type of the key, a text index lists its fields), unique, sparse, hidden, partial filter, collation, weights, default language and expiration.
|
|
490
|
+
* Indices with details for Collection
|
|
491
|
+
*/
|
|
492
|
+
async indexDetails(requestParameters, initOverrides) {
|
|
493
|
+
const response = await this.indexDetailsRaw(requestParameters, initOverrides);
|
|
494
|
+
return await response.value();
|
|
495
|
+
}
|
|
444
496
|
/**
|
|
445
497
|
* Creates request options for indexStats without sending the request
|
|
446
498
|
*/
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* mongocamp-library
|
|
3
3
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.8.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* mongocamp-library
|
|
3
3
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.8.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -6,21 +6,24 @@ All URIs are relative to *http://localhost*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
| [**aggregate**](CollectionApi.md#aggregate) | **POST** /mongodb/collections/{collectionName}/aggregate | Aggregate in Collection |
|
|
8
8
|
| [**clearCollection**](CollectionApi.md#clearcollection) | **DELETE** /mongodb/collections/{collectionName}/clear | Clear Collection |
|
|
9
|
+
| [**copyCollection**](CollectionApi.md#copycollection) | **POST** /mongodb/collections/{collectionName}/copy | Copy Collection |
|
|
9
10
|
| [**deleteCollection**](CollectionApi.md#deletecollection) | **DELETE** /mongodb/collections/{collectionName} | Delete Collection |
|
|
10
11
|
| [**distinct**](CollectionApi.md#distinct) | **POST** /mongodb/collections/{collectionName}/distinct/{field} | Distinct in Collection |
|
|
11
12
|
| [**getCollectionFields**](CollectionApi.md#getcollectionfields) | **GET** /mongodb/collections/{collectionName}/fields | Collection Fields |
|
|
12
13
|
| [**getCollectionInformation**](CollectionApi.md#getcollectioninformation) | **GET** /mongodb/collections/{collectionName} | Collection Information |
|
|
14
|
+
| [**getFieldDetails**](CollectionApi.md#getfielddetails) | **GET** /mongodb/collections/{collectionName}/fields/detail | Fields of a Collection with types |
|
|
13
15
|
| [**getJsonSchema**](CollectionApi.md#getjsonschema) | **GET** /mongodb/collections/{collectionName}/schema | Collection Fields |
|
|
14
16
|
| [**getSchemaAnalysis**](CollectionApi.md#getschemaanalysis) | **GET** /mongodb/collections/{collectionName}/schema/analysis | Collection Fields |
|
|
15
17
|
| [**listCollectionInformation**](CollectionApi.md#listcollectioninformation) | **GET** /mongodb/collections/info | Information of all Collections |
|
|
16
18
|
| [**listCollections**](CollectionApi.md#listcollections) | **GET** /mongodb/collections | List of Collections |
|
|
17
19
|
| [**listCollectionsByDatabase**](CollectionApi.md#listcollectionsbydatabase) | **GET** /mongodb/databases/{databaseName}/collections | List of Collections |
|
|
20
|
+
| [**renameCollection**](CollectionApi.md#renamecollection) | **POST** /mongodb/collections/{collectionName}/rename | Rename Collection |
|
|
18
21
|
|
|
19
22
|
|
|
20
23
|
|
|
21
24
|
## aggregate
|
|
22
25
|
|
|
23
|
-
> Array<{ [key: string]: any; }> aggregate(collectionName, mongoAggregateRequest, rowsPerPage, page, filter)
|
|
26
|
+
> Array<{ [key: string]: any; }> aggregate(collectionName, mongoAggregateRequest, rowsPerPage, page, filter, extendedJson)
|
|
24
27
|
|
|
25
28
|
Aggregate in Collection
|
|
26
29
|
|
|
@@ -59,6 +62,8 @@ async function example() {
|
|
|
59
62
|
page: 1,
|
|
60
63
|
// string | Filter Query like on the list of documents, applied as the first stage of the pipeline. Not possible for a pipeline that starts with $geoNear, $search or $vectorSearch. (optional)
|
|
61
64
|
filter: filter_example,
|
|
65
|
+
// string | relaxed or canonical: the documents with the types of their values as MongoDB Extended JSON ({\"$oid\": ...}, {\"$date\": ...}, {\"$numberDecimal\": ...}, canonical also {\"$numberInt\": ...}, {\"$numberLong\": ...} and {\"$numberDouble\": ...}). Without the parameter the documents are returned as before. (optional)
|
|
66
|
+
extendedJson: extendedJson_example,
|
|
62
67
|
} satisfies AggregateRequest;
|
|
63
68
|
|
|
64
69
|
try {
|
|
@@ -83,6 +88,7 @@ example().catch(console.error);
|
|
|
83
88
|
| **rowsPerPage** | `number` | Count elements per page | [Optional] [Defaults to `undefined`] |
|
|
84
89
|
| **page** | `number` | Requested page of the ResultSets | [Optional] [Defaults to `undefined`] |
|
|
85
90
|
| **filter** | `string` | Filter Query like on the list of documents, applied as the first stage of the pipeline. Not possible for a pipeline that starts with $geoNear, $search or $vectorSearch. | [Optional] [Defaults to `undefined`] |
|
|
91
|
+
| **extendedJson** | `string` | relaxed or canonical: the documents with the types of their values as MongoDB Extended JSON ({\"$oid\": ...}, {\"$date\": ...}, {\"$numberDecimal\": ...}, canonical also {\"$numberInt\": ...}, {\"$numberLong\": ...} and {\"$numberDouble\": ...}). Without the parameter the documents are returned as before. | [Optional] [Defaults to `undefined`] |
|
|
86
92
|
|
|
87
93
|
### Return type
|
|
88
94
|
|
|
@@ -185,6 +191,87 @@ example().catch(console.error);
|
|
|
185
191
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
186
192
|
|
|
187
193
|
|
|
194
|
+
## copyCollection
|
|
195
|
+
|
|
196
|
+
> CopyResponse copyCollection(collectionName, copyRequest)
|
|
197
|
+
|
|
198
|
+
Copy Collection
|
|
199
|
+
|
|
200
|
+
Copy a Collection in the database, optionally only the documents that match a Lucene filter, with its indices (withIndexes, true by default). The target is a name in the database of the Collection. The read grant for the Collection and the write grant for the target are needed. An existing target is a conflict (409), unless dropTarget is true and the user has the administrate grant for it: it is replaced when the copy is complete. The copy is made in one request, a big collection takes its time.
|
|
201
|
+
|
|
202
|
+
### Example
|
|
203
|
+
|
|
204
|
+
```ts
|
|
205
|
+
import {
|
|
206
|
+
Configuration,
|
|
207
|
+
CollectionApi,
|
|
208
|
+
} from '';
|
|
209
|
+
import type { CopyCollectionRequest } from '';
|
|
210
|
+
|
|
211
|
+
async function example() {
|
|
212
|
+
console.log("🚀 Testing SDK...");
|
|
213
|
+
const config = new Configuration({
|
|
214
|
+
// To configure HTTP basic authorization: httpAuth1
|
|
215
|
+
username: "YOUR USERNAME",
|
|
216
|
+
password: "YOUR PASSWORD",
|
|
217
|
+
// Configure HTTP bearer authorization: httpAuth
|
|
218
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
219
|
+
// To configure API key authorization: apiKeyAuth
|
|
220
|
+
apiKey: "YOUR API KEY",
|
|
221
|
+
});
|
|
222
|
+
const api = new CollectionApi(config);
|
|
223
|
+
|
|
224
|
+
const body = {
|
|
225
|
+
// string | The name of your MongoDb Collection
|
|
226
|
+
collectionName: collectionName_example,
|
|
227
|
+
// CopyRequest
|
|
228
|
+
copyRequest: {"target":"copyOfCollection","filter":"type:company","withIndexes":true,"dropTarget":false},
|
|
229
|
+
} satisfies CopyCollectionRequest;
|
|
230
|
+
|
|
231
|
+
try {
|
|
232
|
+
const data = await api.copyCollection(body);
|
|
233
|
+
console.log(data);
|
|
234
|
+
} catch (error) {
|
|
235
|
+
console.error(error);
|
|
236
|
+
}
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
// Run the test
|
|
240
|
+
example().catch(console.error);
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
### Parameters
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
| Name | Type | Description | Notes |
|
|
247
|
+
|------------- | ------------- | ------------- | -------------|
|
|
248
|
+
| **collectionName** | `string` | The name of your MongoDb Collection | [Defaults to `undefined`] |
|
|
249
|
+
| **copyRequest** | [CopyRequest](CopyRequest.md) | | |
|
|
250
|
+
|
|
251
|
+
### Return type
|
|
252
|
+
|
|
253
|
+
[**CopyResponse**](CopyResponse.md)
|
|
254
|
+
|
|
255
|
+
### Authorization
|
|
256
|
+
|
|
257
|
+
[httpAuth1](../README.md#httpAuth1), [httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
|
|
258
|
+
|
|
259
|
+
### HTTP request headers
|
|
260
|
+
|
|
261
|
+
- **Content-Type**: `application/json`
|
|
262
|
+
- **Accept**: `application/json`, `text/plain`
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
### HTTP response details
|
|
266
|
+
| Status code | Description | Response headers |
|
|
267
|
+
|-------------|-------------|------------------|
|
|
268
|
+
| **200** | | - |
|
|
269
|
+
| **400** | Invalid value for: body | - |
|
|
270
|
+
| **0** | | * x-error-code - Error Code <br> * x-error-message - Message of the MongoCampException <br> * x-error-additional-info - Additional information for the MongoCampException <br> |
|
|
271
|
+
|
|
272
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
273
|
+
|
|
274
|
+
|
|
188
275
|
## deleteCollection
|
|
189
276
|
|
|
190
277
|
> JsonValueBoolean deleteCollection(collectionName)
|
|
@@ -511,6 +598,90 @@ example().catch(console.error);
|
|
|
511
598
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
512
599
|
|
|
513
600
|
|
|
601
|
+
## getFieldDetails
|
|
602
|
+
|
|
603
|
+
> Array<FieldInfo> getFieldDetails(collectionName, sampleSize, depth)
|
|
604
|
+
|
|
605
|
+
Fields of a Collection with types
|
|
606
|
+
|
|
607
|
+
All fields of a collection as a flat list, one entry per path (`address.city`, `tags[]` for the elements of an array) with the types of the values and how often every type was found in the analysed documents.
|
|
608
|
+
|
|
609
|
+
### Example
|
|
610
|
+
|
|
611
|
+
```ts
|
|
612
|
+
import {
|
|
613
|
+
Configuration,
|
|
614
|
+
CollectionApi,
|
|
615
|
+
} from '';
|
|
616
|
+
import type { GetFieldDetailsRequest } from '';
|
|
617
|
+
|
|
618
|
+
async function example() {
|
|
619
|
+
console.log("🚀 Testing SDK...");
|
|
620
|
+
const config = new Configuration({
|
|
621
|
+
// To configure HTTP basic authorization: httpAuth1
|
|
622
|
+
username: "YOUR USERNAME",
|
|
623
|
+
password: "YOUR PASSWORD",
|
|
624
|
+
// Configure HTTP bearer authorization: httpAuth
|
|
625
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
626
|
+
// To configure API key authorization: apiKeyAuth
|
|
627
|
+
apiKey: "YOUR API KEY",
|
|
628
|
+
});
|
|
629
|
+
const api = new CollectionApi(config);
|
|
630
|
+
|
|
631
|
+
const body = {
|
|
632
|
+
// string | The name of your MongoDb Collection
|
|
633
|
+
collectionName: collectionName_example,
|
|
634
|
+
// number | Number of documents that are analysed, 1000 by default. A greater sample is more exact and slower on big collections. (optional)
|
|
635
|
+
sampleSize: 1000,
|
|
636
|
+
// number | How deep should the objects extracted (optional)
|
|
637
|
+
depth: 56,
|
|
638
|
+
} satisfies GetFieldDetailsRequest;
|
|
639
|
+
|
|
640
|
+
try {
|
|
641
|
+
const data = await api.getFieldDetails(body);
|
|
642
|
+
console.log(data);
|
|
643
|
+
} catch (error) {
|
|
644
|
+
console.error(error);
|
|
645
|
+
}
|
|
646
|
+
}
|
|
647
|
+
|
|
648
|
+
// Run the test
|
|
649
|
+
example().catch(console.error);
|
|
650
|
+
```
|
|
651
|
+
|
|
652
|
+
### Parameters
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
| Name | Type | Description | Notes |
|
|
656
|
+
|------------- | ------------- | ------------- | -------------|
|
|
657
|
+
| **collectionName** | `string` | The name of your MongoDb Collection | [Defaults to `undefined`] |
|
|
658
|
+
| **sampleSize** | `number` | Number of documents that are analysed, 1000 by default. A greater sample is more exact and slower on big collections. | [Optional] [Defaults to `1000`] |
|
|
659
|
+
| **depth** | `number` | How deep should the objects extracted | [Optional] [Defaults to `3`] |
|
|
660
|
+
|
|
661
|
+
### Return type
|
|
662
|
+
|
|
663
|
+
[**Array<FieldInfo>**](FieldInfo.md)
|
|
664
|
+
|
|
665
|
+
### Authorization
|
|
666
|
+
|
|
667
|
+
[httpAuth1](../README.md#httpAuth1), [httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
|
|
668
|
+
|
|
669
|
+
### HTTP request headers
|
|
670
|
+
|
|
671
|
+
- **Content-Type**: Not defined
|
|
672
|
+
- **Accept**: `application/json`, `text/plain`
|
|
673
|
+
|
|
674
|
+
|
|
675
|
+
### HTTP response details
|
|
676
|
+
| Status code | Description | Response headers |
|
|
677
|
+
|-------------|-------------|------------------|
|
|
678
|
+
| **200** | | - |
|
|
679
|
+
| **400** | Invalid value for: query parameter sampleSize, Invalid value for: query parameter depth | - |
|
|
680
|
+
| **0** | | * x-error-code - Error Code <br> * x-error-message - Message of the MongoCampException <br> * x-error-additional-info - Additional information for the MongoCampException <br> |
|
|
681
|
+
|
|
682
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
683
|
+
|
|
684
|
+
|
|
514
685
|
## getJsonSchema
|
|
515
686
|
|
|
516
687
|
> JsonSchema getJsonSchema(collectionName, sampleSize, deepth)
|
|
@@ -901,3 +1072,84 @@ example().catch(console.error);
|
|
|
901
1072
|
|
|
902
1073
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
903
1074
|
|
|
1075
|
+
|
|
1076
|
+
## renameCollection
|
|
1077
|
+
|
|
1078
|
+
> RenameResponse renameCollection(collectionName, renameRequest)
|
|
1079
|
+
|
|
1080
|
+
Rename Collection
|
|
1081
|
+
|
|
1082
|
+
Rename a Collection in the database, with its Documents and Indices. The target is a name in the database of the Collection. The administrate grant for the Collection and the write grant for the target are needed. An existing target is a conflict (409), unless dropTarget is true and the user has the administrate grant for it: it is replaced then.
|
|
1083
|
+
|
|
1084
|
+
### Example
|
|
1085
|
+
|
|
1086
|
+
```ts
|
|
1087
|
+
import {
|
|
1088
|
+
Configuration,
|
|
1089
|
+
CollectionApi,
|
|
1090
|
+
} from '';
|
|
1091
|
+
import type { RenameCollectionRequest } from '';
|
|
1092
|
+
|
|
1093
|
+
async function example() {
|
|
1094
|
+
console.log("🚀 Testing SDK...");
|
|
1095
|
+
const config = new Configuration({
|
|
1096
|
+
// To configure HTTP basic authorization: httpAuth1
|
|
1097
|
+
username: "YOUR USERNAME",
|
|
1098
|
+
password: "YOUR PASSWORD",
|
|
1099
|
+
// Configure HTTP bearer authorization: httpAuth
|
|
1100
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1101
|
+
// To configure API key authorization: apiKeyAuth
|
|
1102
|
+
apiKey: "YOUR API KEY",
|
|
1103
|
+
});
|
|
1104
|
+
const api = new CollectionApi(config);
|
|
1105
|
+
|
|
1106
|
+
const body = {
|
|
1107
|
+
// string | The name of your MongoDb Collection
|
|
1108
|
+
collectionName: collectionName_example,
|
|
1109
|
+
// RenameRequest
|
|
1110
|
+
renameRequest: {"target":"newName","dropTarget":false},
|
|
1111
|
+
} satisfies RenameCollectionRequest;
|
|
1112
|
+
|
|
1113
|
+
try {
|
|
1114
|
+
const data = await api.renameCollection(body);
|
|
1115
|
+
console.log(data);
|
|
1116
|
+
} catch (error) {
|
|
1117
|
+
console.error(error);
|
|
1118
|
+
}
|
|
1119
|
+
}
|
|
1120
|
+
|
|
1121
|
+
// Run the test
|
|
1122
|
+
example().catch(console.error);
|
|
1123
|
+
```
|
|
1124
|
+
|
|
1125
|
+
### Parameters
|
|
1126
|
+
|
|
1127
|
+
|
|
1128
|
+
| Name | Type | Description | Notes |
|
|
1129
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1130
|
+
| **collectionName** | `string` | The name of your MongoDb Collection | [Defaults to `undefined`] |
|
|
1131
|
+
| **renameRequest** | [RenameRequest](RenameRequest.md) | | |
|
|
1132
|
+
|
|
1133
|
+
### Return type
|
|
1134
|
+
|
|
1135
|
+
[**RenameResponse**](RenameResponse.md)
|
|
1136
|
+
|
|
1137
|
+
### Authorization
|
|
1138
|
+
|
|
1139
|
+
[httpAuth1](../README.md#httpAuth1), [httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
|
|
1140
|
+
|
|
1141
|
+
### HTTP request headers
|
|
1142
|
+
|
|
1143
|
+
- **Content-Type**: `application/json`
|
|
1144
|
+
- **Accept**: `application/json`, `text/plain`
|
|
1145
|
+
|
|
1146
|
+
|
|
1147
|
+
### HTTP response details
|
|
1148
|
+
| Status code | Description | Response headers |
|
|
1149
|
+
|-------------|-------------|------------------|
|
|
1150
|
+
| **200** | | - |
|
|
1151
|
+
| **400** | Invalid value for: body | - |
|
|
1152
|
+
| **0** | | * x-error-code - Error Code <br> * x-error-message - Message of the MongoCampException <br> * x-error-additional-info - Additional information for the MongoCampException <br> |
|
|
1153
|
+
|
|
1154
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1155
|
+
|