kuzzle 2.16.11 → 2.17.2

package/lib/api/funnel.js

@@ -61,7 +61,7 @@ const SKIP_TOKEN_VERIF_ACTIONS = ['login', 'checkToken', 'logout'];
  * @param {Object} context
  */
 class PendingRequest {
-  constructor(request, fn, context) {
+  constructor (request, fn, context) {
     this.request = request;
     this.fn = fn;
     this.context = context;
@@ -132,7 +132,7 @@ class Funnel {
     return Bluebird.all(initPromises);
   }
 
-  loadDocumentEventAliases() {
+  loadDocumentEventAliases () {
     this.documentEventAliases = documentEventAliases;
     this.documentEventAliases.mirrorList = {};
 
@@ -223,13 +223,13 @@ class Funnel {
       throw error;
     }
 
-    if (!this.pendingRequestsById.has(request.internalId)) {
+    if (! this.pendingRequestsById.has(request.internalId)) {
       this.pendingRequestsById.set(
         request.internalId,
         new PendingRequest(request, fn, context));
       this.pendingRequestsQueue.push(request.internalId);
 
-      if (!this.overloaded) {
+      if (! this.overloaded) {
         this.overloaded = true;
 
         /*
@@ -262,23 +262,39 @@ class Funnel {
    * @returns {Number} -1: request delayed, 0: request processing, 1: error
    */
   execute (request, callback) {
-    if (!request.input.controller || !request.input.controller.length) {
+    if (! request.input.controller || ! request.input.controller.length) {
       callback(
         kerror.get('api', 'assert', 'missing_argument', 'controller'),
         request);
       return 1;
     }
 
-    if (!request.input.action || !request.input.action.length) {
+    if (! request.input.action || ! request.input.action.length) {
       callback(
         kerror.get('api', 'assert', 'missing_argument', 'action'),
         request);
       return 1;
     }
 
+    // If there is a body, retrieve the targets if any
+    const targets = request.getArray('targets', []);
+    /**
+     * Only index and collection as a pair or the targets parameter is allowed at the same time
+     * otherwise we throw an error because we don't know which one to use to verify the rights
+     */
+    if ( targets.length > 0
+      && (request.input.args.index
+        || request.input.args.collection)
+    ) {
+      callback(
+        kerror.get('api', 'assert', 'mutually_exclusive', 'index, collection', 'targets'),
+        request);
+      return 1;
+    }
+
     if (request.input.headers
       && has(request.input.headers, 'origin')
-      && !this._isOriginAuthorized(request.input.headers.origin)
+      && ! this._isOriginAuthorized(request.input.headers.origin)
     ) {
       debug('Reject request, unauthorized origin %s', request.input.headers.origin);
       return this._executeError(
@@ -292,7 +308,7 @@ class Funnel {
       const executing = this.throttle(req => {
         // if the connection is closed there is no need to execute the request
         // => discarding it
-        if (!global.kuzzle.router.isConnectionAlive(req.context)) {
+        if (! global.kuzzle.router.isConnectionAlive(req.context)) {
           debug('Client connection dead: dropping request: %a', req.input);
           callback(processError.get('connection_dropped'), req);
           return;
@@ -314,7 +330,7 @@ class Funnel {
                   return this.rateLimiter.isAllowed(_request);
                 })
                 .then(allowed => {
-                  if (!allowed) {
+                  if (! allowed) {
                     if (request.input.controller === 'auth' && request.input.action === 'login') {
                       throw processError.get('too_many_logins_requests');
                     }
@@ -346,7 +362,8 @@ class Funnel {
       }, this, request);
 
       return executing ? 0 : -1;
-    } catch (error) {
+    }
+    catch (error) {
       request.setError(error);
       callback(error, request);
       return 1;
@@ -374,11 +391,11 @@ class Funnel {
           // JSON.stringify(new NativeError()) === '{}'
           // i.e. Error, SyntaxError, TypeError, ReferenceError, etc.
           global.kuzzle.log.error(
-            err instanceof Error && !(err instanceof KuzzleError)
+            err instanceof Error && ! (err instanceof KuzzleError)
               ? `${err.message}\n${err.stack}`
               : err);
 
-          if (!this.lastDumpedErrors[errorType]
+          if (! this.lastDumpedErrors[errorType]
             || this.lastDumpedErrors[errorType] < now - handledErrors.minInterval
           ) {
             // simplify error message to use it in folder dump name
@@ -432,7 +449,7 @@ class Funnel {
         cookie = Cookie.parse(request.input.headers.cookie);
       }
       catch (error) {
-        throw kerror.get('security','cookie', 'invalid');
+        throw kerror.get('security', 'cookie', 'invalid');
       }
 
       // if cookie is present and not null, and a token is present we should throw because we don't know which one to use
@@ -546,7 +563,7 @@ class Funnel {
         responseData,
         { status: _request.status === 102 ? 200 : _request.status });
 
-      if (!this.isNativeController(_request.input.controller) && !_request.response.raw) {
+      if (! this.isNativeController(_request.input.controller) && ! _request.response.raw) {
         // check if the plugin response can be serialized
         try {
           JSON.stringify(responseData);
@@ -591,9 +608,9 @@ class Funnel {
       controller === 'document'
       && this.documentEventAliases.mirrorList[action]
       && ( prefix !== 'before'
-        || !this.documentEventAliases.notBefore.includes(action));
+        || ! this.documentEventAliases.notBefore.includes(action));
 
-    if (!mustTrigger) {
+    if (! mustTrigger) {
       return request;
     }
 
@@ -680,7 +697,7 @@ class Funnel {
         ? 'ms'
         : request.input.controller;
 
-    return`${event}:${prefix}${capitalize(request.input.action)}`;
+    return `${event}:${prefix}${capitalize(request.input.action)}`;
   }
 
   /**
@@ -823,10 +840,12 @@ class Funnel {
         try {
           if (this.throttle(pendingItem.fn, pendingItem.context, pendingItem.request)) {
             this.pendingRequestsQueue.shift();
-          } else {
+          }
+          else {
             break;
           }
-        } catch (error) {
+        }
+        catch (error) {
           break;
         }
       }
@@ -857,7 +876,7 @@ class Funnel {
    * @returns {KuzzleError}
    */
   _wrapError (request, error) {
-    if (!this.isNativeController(request) && !(error instanceof KuzzleError)) {
+    if (! this.isNativeController(request) && ! (error instanceof KuzzleError)) {
       return kerror.getFrom(
         error,
         'plugin',
@@ -877,6 +896,10 @@ class Funnel {
   _isOriginAuthorized (origin) {
     const httpConfig = global.kuzzle.config.http;
 
+    if (! origin) {
+      return true;
+    }
+
     if (global.kuzzle.config.internal.allowAllOrigins) {
       return true;
     }
@@ -916,7 +939,7 @@ function capitalize (string) {
 function doAction (controller, request) {
   const ret = controller[request.input.action](request);
 
-  if (!ret || typeof ret.then !== 'function') {
+  if (! ret || typeof ret.then !== 'function') {
     return kerror.reject(
       'plugin',
       'controller',

package/lib/api/httpRoutes.js

@@ -34,7 +34,8 @@ const {
   OpenApiDocumentGet,
   OpenApiDocumentCreate,
   OpenApiDocumentCreateOrReplace,
-} = require('./openapi/document');
+  OpenApiDocumentValidate,
+} = require('./openapi/components/document');
 
 
 const routes = [
@@ -53,6 +54,7 @@ const routes = [
   // We need to expose a GET method for "login" action in order to make authentication protocol like Oauth2 or CAS work:
   { verb: 'get', path: '/_login/:strategy', controller: 'auth', action: 'login' },
 
+  { verb: 'get', path: '/:index/:collection/_export', controller: 'document', action: 'export' },
   { verb: 'get', path: '/:index/:collection/_exists', controller: 'collection', action: 'exists' },
   { verb: 'get', path: '/:index/:collection/_mapping', controller: 'collection', action: 'getMapping' },
   { verb: 'get', path: '/:index/:collection/_search', controller: 'document', action: 'search' },
@@ -74,6 +76,7 @@ const routes = [
   { verb: 'get', path: '/:index/:collection/:_id', controller: 'document', action: 'get', openapi: OpenApiDocumentGet },
   { verb: 'get', path: '/:index/:collection/_mGet', controller: 'document', action: 'mGet' },
   { verb: 'get', path: '/:index/:collection/:_id/_exists', controller: 'document', action: 'exists', openapi: OpenApiDocumentExists },
+  { verb: 'get', path: '/:index/:collection/_mExists', controller: 'document', action: 'mExists' },
   { verb: 'get', path: '/_scroll/:scrollId', controller: 'document', action: 'scroll', openapi: OpenApiDocumentScroll },
 
   { verb: 'get', path: '/:index/_exists', controller: 'index', action: 'exists' },
@@ -104,6 +107,7 @@ const routes = [
   { verb: 'get', path: '/_adminExists', controller: 'server', action: 'adminExists' },
   { verb: 'get', path: '/_getAllStats', controller: 'server', action: 'getAllStats', deprecated: { since: 'auto-version', message: 'Use this route instead: http://kuzzle:7512/_metrics' } }, // @deprecated
   { verb: 'get', path: '/_getConfig', controller: 'server', action: 'getConfig' },
+  { verb: 'get', path: '/_capabilities', controller: 'server', action: 'capabilities' },
   { verb: 'get', path: '/_getLastStats', controller: 'server', action: 'getLastStats', deprecated: { since: 'auto-version', message: 'Use this route instead: http://kuzzle:7512/_metrics' } }, // @deprecated
   { verb: 'get', path: '/_getStats', controller: 'server', action: 'getStats', deprecated: { since: 'auto-version', message: 'Use this route instead: http://kuzzle:7512/_metrics' } }, // @deprecated
   { verb: 'get', path: '/', controller: 'server', action: 'info' },
@@ -171,7 +175,7 @@ const routes = [
   { verb: 'get', path: '/ms/_zscan/:_id', controller: 'ms', action: 'zscan' },
   { verb: 'get', path: '/ms/_zscore/:_id/:member', controller: 'ms', action: 'zscore' },
   { verb: 'get', path: '/ms/:_id', controller: 'ms', action: 'get' },
-  { verb: 'get', path: '/cluster/_status', controller:'cluster', action: 'status' },
+  { verb: 'get', path: '/cluster/_status', controller: 'cluster', action: 'status' },
 
 
   // POST
@@ -202,12 +206,13 @@ const routes = [
   { verb: 'post', path: '/:index/:collection/_create', controller: 'document', action: 'create', openapi: OpenApiDocumentCreate },
   { verb: 'post', path: '/:index/:collection/:_id/_create', controller: 'document', action: 'create' },
   { verb: 'post', path: '/:index/:collection/_publish', controller: 'realtime', action: 'publish' },
+  { verb: 'post', path: '/:index/:collection/_export', controller: 'document', action: 'export' },
   { verb: 'post', path: '/:index/:collection/_search', controller: 'document', action: 'search' },
   { verb: 'post', path: '/:index/:collection/_mGet', controller: 'document', action: 'mGet' },
   { verb: 'post', path: '/:index/:collection/_mCreate', controller: 'document', action: 'mCreate' },
   { verb: 'post', path: '/:index/:collection/_mUpsert', controller: 'document', action: 'mUpsert' },
-  { verb: 'post', path: '/:index/:collection/:_id/_upsert', controller: 'document', action: 'upsert'},
-  { verb: 'post', path: '/:index/:collection/_validate', controller: 'document', action: 'validate' },
+  { verb: 'post', path: '/:index/:collection/:_id/_upsert', controller: 'document', action: 'upsert' },
+  { verb: 'post', path: '/:index/:collection/_validate', controller: 'document', action: 'validate', openapi: OpenApiDocumentValidate },
 
   { verb: 'post', path: '/_createFirstAdmin/:_id', controller: 'security', action: 'createFirstAdmin' },
   { verb: 'post', path: '/_createFirstAdmin', controller: 'security', action: 'createFirstAdmin' },

package/lib/api/openapi/OpenApiManager.d.ts

@@ -0,0 +1,11 @@
+import { OpenApiDefinition } from '../../types/OpenApiDefinition';
+export declare class OpenApiManager {
+    kuzzleDefinition: OpenApiDefinition;
+    applicationDefinition: OpenApiDefinition;
+    /**
+     * @param applicationDefinition Application OpenApi definition
+     * @param pluginsManager PluginsManager instance
+     */
+    constructor(applicationDefinition: OpenApiDefinition, kuzzleRoutes: any[], pluginsRoutes: any[]);
+    registerAskEvents(): void;
+}

package/lib/api/openapi/OpenApiManager.js

@@ -0,0 +1,96 @@
+"use strict";
+/*
+ * Kuzzle, a backend software, self-hostable and ready to use
+ * to power modern apps
+ *
+ * Copyright 2015-2020 Kuzzle
+ * mailto: support AT kuzzle.io
+ * website: http://kuzzle.io
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenApiManager = void 0;
+const components_1 = require("./components");
+const package_json_1 = require("../../../package.json");
+const openApiGenerator_1 = require("./openApiGenerator");
+class OpenApiManager {
+    /**
+     * @param applicationDefinition Application OpenApi definition
+     * @param pluginsManager PluginsManager instance
+     */
+    constructor(applicationDefinition, kuzzleRoutes, pluginsRoutes) {
+        /* eslint-disable sort-keys */
+        this.kuzzleDefinition = {
+            swagger: '2.0',
+            info: {
+                title: 'Kuzzle API',
+                description: 'Kuzzle HTTP API definition',
+                contact: {
+                    name: 'Kuzzle team',
+                    url: 'https://kuzzle.io',
+                    email: 'support@kuzzle.io',
+                    discord: 'http://join.discord.kuzzle.io'
+                },
+                license: {
+                    name: 'Apache 2',
+                    url: 'http://opensource.org/licenses/apache2.0'
+                },
+                version: package_json_1.version
+            },
+            externalDocs: {
+                description: 'Kuzzle API Documentation',
+                url: 'https://docs.kuzzle.io/core/2/api/'
+            },
+            servers: [
+                {
+                    url: 'https://{baseUrl}:{port}',
+                    description: 'Kuzzle Base Url',
+                    variables: {
+                        baseUrl: { default: 'localhost' },
+                        port: { default: 7512 }
+                    },
+                }
+            ],
+            tags: [],
+            schemes: ['https', 'http'],
+            paths: {},
+            components: {
+                ...components_1.OpenApiPayloadsDefinitions,
+                document: {
+                    ...components_1.OpenApiDocumentCountComponent,
+                    ...components_1.OpenApiDocumentDeleteByQueryComponent,
+                    ...components_1.OpenApiDocumentDeleteComponent,
+                    ...components_1.OpenApiDocumentScrollComponent,
+                    ...components_1.OpenApiDocumentExistsComponent,
+                    ...components_1.OpenApiDocumentUpdateComponent,
+                    ...components_1.OpenApiDocumentReplaceComponent,
+                    ...components_1.OpenApiDocumentGetComponent,
+                    ...components_1.OpenApiDocumentCreateOrReplaceComponent,
+                    ...components_1.OpenApiDocumentCreateComponent,
+                    ...components_1.OpenApiDocumentValidateComponent,
+                }
+            }
+        };
+        this.applicationDefinition = applicationDefinition;
+        (0, openApiGenerator_1.generateOpenApi)(kuzzleRoutes, this.kuzzleDefinition);
+        (0, openApiGenerator_1.generateOpenApi)(pluginsRoutes, this.applicationDefinition);
+        this.registerAskEvents();
+    }
+    registerAskEvents() {
+        global.kuzzle.onAsk('core:api:openapi:kuzzle', () => this.kuzzleDefinition);
+        global.kuzzle.onAsk('core:api:openapi:app', () => this.applicationDefinition);
+    }
+}
+exports.OpenApiManager = OpenApiManager;
+//# sourceMappingURL=OpenApiManager.js.map

package/lib/api/openapi/{document → components/document}/count.yaml

@@ -16,12 +16,12 @@ DocumentCount:
       description: "Counts documents in a collection."
       required: true
       schema:
-        $ref: "#/components/schemas/DocumentCountRequest"
+        $ref: "#/components/document/DocumentCountRequest"
   responses:
     200:
       description: "Counts documents in a collection."
       schema:
-        $ref: "#/components/schemas/DocumentCountResponse"
+        $ref: "#/components/document/DocumentCountResponse"
 
 components:
   schemas:

package/lib/api/openapi/{document → components/document}/create.yaml

@@ -16,12 +16,12 @@ DocumentCreate:
       description: "Creates a new document in the persistent data storage."
       required: true
       schema:
-        $ref: "#/components/schemas/DocumentCreateRequest"
+        $ref: "#/components/document/DocumentCreateRequest"
   responses:
     200:
       description: "Creates a new document in the persistent data storage."
       schema:
-          $ref: "#/components/schemas/DocumentCreateResponse"
+          $ref: "#/components/document/DocumentCreateResponse"
 
 components:
   schemas:

package/lib/api/openapi/{document → components/document}/createOrReplace.yaml

@@ -28,12 +28,12 @@ DocumentCreateOrReplace:
       description: "Creates a new document in the persistent data storage, or replaces its content if it already exists."
       required: true
       schema:
-        $ref: "#/components/schemas/DocumentCreateOrReplaceRequest"
+        $ref: "#/components/document/DocumentCreateOrReplaceRequest"
   responses:
     200:
       description: "Creates a new document in the persistent data storage, or replaces its content if it already exists."
       schema:
-        $ref: "#/components/schemas/DocumentCreateOrReplaceResponse"
+        $ref: "#/components/document/DocumentCreateOrReplaceResponse"
 
 components:
   schemas:

package/lib/api/openapi/{document → components/document}/delete.yaml

@@ -40,7 +40,7 @@ DocumentDelete:
     200:
       description: "Deletes a document."
       schema:
-        $ref: "#/components/schemas/DocumentDeleteResponse"
+        $ref: "#/components/document/DocumentDeleteResponse"
 
 components:
   schemas:

package/lib/api/openapi/{document → components/document}/deleteByQuery.yaml

@@ -47,12 +47,12 @@ DocumentDeleteByQuery:
       description: "Deletes documents matching the provided search query."
       required: true
       schema:
-        $ref: "#/components/schemas/DocumentDeleteByQueryRequest"
+        $ref: "#/components/document/DocumentDeleteByQueryRequest"
   responses:
     200:
       description: "Deletes documents matching the provided search query."
       schema:
-        $ref: "#/components/schemas/DocumentDeleteByQueryResponse"
+        $ref: "#/components/document/DocumentDeleteByQueryResponse"
 
 components:
   schemas:

package/lib/api/openapi/{document → components/document}/exists.yaml

@@ -22,7 +22,7 @@ DocumentExists:
     200:
       description: "Checks if a document exists."
       schema:
-        $ref: "#/components/schemas/DocumentExistsResponse"
+        $ref: "#/components/document/DocumentExistsResponse"
 
 components:
   schemas:

package/lib/api/openapi/{document → components/document}/get.yaml

@@ -22,7 +22,7 @@ DocumentGet:
     200:
       description: "Gets a document."
       schema:
-          $ref: "#/components/schemas/DocumentGetResponse"
+          $ref: "#/components/document/DocumentGetResponse"
 
 components:
   schemas:

package/lib/api/openapi/{document → components/document}/index.d.ts

@@ -18,3 +18,5 @@ export declare const OpenApiDocumentDelete: any;
 export declare const OpenApiDocumentDeleteComponent: any;
 export declare const OpenApiDocumentDeleteByQuery: any;
 export declare const OpenApiDocumentDeleteByQueryComponent: any;
+export declare const OpenApiDocumentValidate: any;
+export declare const OpenApiDocumentValidateComponent: any;

package/lib/api/openapi/{document → components/document}/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpenApiDocumentDeleteByQueryComponent = exports.OpenApiDocumentDeleteByQuery = exports.OpenApiDocumentDeleteComponent = exports.OpenApiDocumentDelete = exports.OpenApiDocumentScrollComponent = exports.OpenApiDocumentScroll = exports.OpenApiDocumentUpdateComponent = exports.OpenApiDocumentUpdate = exports.OpenApiDocumentExistsComponent = exports.OpenApiDocumentExists = exports.OpenApiDocumentReplaceComponent = exports.OpenApiDocumentReplace = exports.OpenApiDocumentGetComponent = exports.OpenApiDocumentGet = exports.OpenApiDocumentCreateOrReplaceComponent = exports.OpenApiDocumentCreateOrReplace = exports.OpenApiDocumentCreateComponent = exports.OpenApiDocumentCreate = exports.OpenApiDocumentCountComponent = exports.OpenApiDocumentCount = void 0;
-const readYamlFile_1 = require("../../../util/readYamlFile");
+exports.OpenApiDocumentValidateComponent = exports.OpenApiDocumentValidate = exports.OpenApiDocumentDeleteByQueryComponent = exports.OpenApiDocumentDeleteByQuery = exports.OpenApiDocumentDeleteComponent = exports.OpenApiDocumentDelete = exports.OpenApiDocumentScrollComponent = exports.OpenApiDocumentScroll = exports.OpenApiDocumentUpdateComponent = exports.OpenApiDocumentUpdate = exports.OpenApiDocumentExistsComponent = exports.OpenApiDocumentExists = exports.OpenApiDocumentReplaceComponent = exports.OpenApiDocumentReplace = exports.OpenApiDocumentGetComponent = exports.OpenApiDocumentGet = exports.OpenApiDocumentCreateOrReplaceComponent = exports.OpenApiDocumentCreateOrReplace = exports.OpenApiDocumentCreateComponent = exports.OpenApiDocumentCreate = exports.OpenApiDocumentCountComponent = exports.OpenApiDocumentCount = void 0;
+const readYamlFile_1 = require("../../../../util/readYamlFile");
 // reading the description of the Count action in the controller document.
 // The yaml objects are then stored in the variables below
 const countObject = (0, readYamlFile_1.readYamlFile)(__dirname + '/count.yaml');
@@ -52,4 +52,9 @@ exports.OpenApiDocumentDeleteComponent = deleteObject.components.schemas;
 const deleteByQueryObject = (0, readYamlFile_1.readYamlFile)(__dirname + '/deleteByQuery.yaml');
 exports.OpenApiDocumentDeleteByQuery = deleteByQueryObject.DocumentDeleteByQuery;
 exports.OpenApiDocumentDeleteByQueryComponent = deleteByQueryObject.components.schemas;
+// reading the description of the Validate action in the controller document.
+// The yaml objects are then stored in the variables below
+const validateObject = (0, readYamlFile_1.readYamlFile)(__dirname + '/validate.yaml');
+exports.OpenApiDocumentValidate = validateObject.DocumentValidate;
+exports.OpenApiDocumentValidateComponent = validateObject.components.schemas;
 //# sourceMappingURL=index.js.map

package/lib/api/openapi/{document → components/document}/replace.yaml

@@ -35,12 +35,12 @@ DocumentReplace:
       description: "Replaces the content of an existing document."
       required: true
       schema:
-        $ref: "#/components/schemas/DocumentReplaceRequest"
+        $ref: "#/components/document/DocumentReplaceRequest"
   responses:
     200:
       description: "Replaces the content of an existing document."
       schema:
-        $ref: "#/components/schemas/DocumentReplaceResponse"
+        $ref: "#/components/document/DocumentReplaceResponse"
 
 components:
   schemas:

package/lib/api/openapi/{document → components/document}/scroll.yaml

@@ -19,7 +19,7 @@ DocumentScroll:
     200:
       description: "Moves a search cursor forward."
       schema:
-        $ref: "#/components/schemas/DocumentScrollResponse"
+        $ref: "#/components/document/DocumentScrollResponse"
 
 components:
   schemas:

package/lib/api/openapi/{document → components/document}/update.yaml

@@ -47,12 +47,12 @@ DocumentUpdate:
       description: "Updates a document content."
       required: true
       schema:
-        $ref: "#/components/schemas/DocumentUpdateRequest"
+        $ref: "#/components/document/DocumentUpdateRequest"
   responses:
     200:
       description: "Updates a document content."
       schema:
-        $ref: "#/components/schemas/DocumentUpdateResponse"
+        $ref: "#/components/document/DocumentUpdateResponse"
 
 components:
   schemas:

package/lib/api/openapi/components/document/validate.yaml

@@ -0,0 +1,42 @@
+DocumentValidate:
+  summary: "Validates data against existing validation rules."
+  tags:
+    - document
+  parameters:
+    - in: path
+      name: index
+      schema:
+        type: string
+    - in: path
+      name: collection
+      schema:
+        type: string
+    - in: body
+      name: "body"
+      description: "Document content to check."
+      required: true
+      schema:
+        $ref: "#/components/document/DocumentValidateRequest"
+  responses:
+    200:
+      description: "Returns the document validation status."
+      schema:
+        $ref: "#/components/document/DocumentValidateResponse"
+
+components:
+  schemas:
+    DocumentValidateRequest:
+      allOf:
+        - type: "object"
+          description: "document content"
+
+    DocumentValidateResponse:
+      allOf:
+        - $ref: "#/components/ResponsePayload"
+        - type: "object"
+          properties:
+            result:
+              type: "object"
+              properties:
+                valid:
+                  type: "boolean"

package/lib/api/openapi/components/index.d.ts

@@ -0,0 +1,2 @@
+export * from './document';
+export declare const OpenApiPayloadsDefinitions: any;

package/lib/api/openapi/components/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenApiPayloadsDefinitions = void 0;
+const readYamlFile_1 = require("../../../util/readYamlFile");
+__exportStar(require("./document"), exports);
+// Document definitions (reusable object for KuzzleRequest and KuzzleResponse)
+exports.OpenApiPayloadsDefinitions = (0, readYamlFile_1.readYamlFile)(__dirname + '/payloads.yaml').definitions;
+//# sourceMappingURL=index.js.map

package/lib/api/openapi/index.d.ts

@@ -1,2 +1 @@
-export * from './document';
-export declare const OpenApiPayloadsDefinitions: any;
+export * from './OpenApiManager';

package/lib/api/openapi/index.js

@@ -10,9 +10,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpenApiPayloadsDefinitions = void 0;
-const readYamlFile_1 = require("../../util/readYamlFile");
-__exportStar(require("./document"), exports);
-// Document definitions (reusable object for KuzzleRequest and KuzzleResponse)
-exports.OpenApiPayloadsDefinitions = (0, readYamlFile_1.readYamlFile)(__dirname + '/payloads.yaml').definitions;
+__exportStar(require("./OpenApiManager"), exports);
 //# sourceMappingURL=index.js.map

package/lib/api/openapi/openApiGenerator.d.ts

@@ -0,0 +1,7 @@
+import { JSONObject } from '../../../index';
+/**
+ * Generates JSON OpenApi object
+ *
+ * @returns {object} openApi object
+ */
+export declare function generateOpenApi(routes: JSONObject[], definition: JSONObject): JSONObject;