kuzzle 2.16.0 → 2.16.1

package/lib/api/httpRoutes.js

@@ -34,7 +34,7 @@ const {
   OpenApiDocumentGet,
   OpenApiDocumentCreate,
   OpenApiDocumentCreateOrReplace,
-} = require('../api/openapi/documents/document');
+} = require('./openapi/document');
 
 
 const routes = [

package/lib/api/openApiGenerator.js

@@ -26,7 +26,7 @@ exports.generateOpenApi = void 0;
  */
 const lodash_1 = __importDefault(require("lodash"));
 const package_json_1 = require("./../../package.json");
-const document_1 = require("./openapi/documents/document");
+const document_1 = require("./openapi/document");
 const inflector_1 = require("./../util/inflector");
 const routeUrlMatch = /:([^/]*)/g;
 /**

package/lib/api/openapi/document/count.yaml

@@ -0,0 +1,47 @@
+DocumentCount:
+  summary: "Counts documents in a collection."
+  tags:
+    - document
+  parameters:
+    - in: path
+      name: index
+      schema:
+        type: string
+    - in: path
+      name: collection
+      schema:
+        type: string
+    - in: body
+      name: "body"
+      description: "Counts documents in a collection."
+      required: true
+      schema:
+        $ref: "#/components/schemas/DocumentCountRequest"
+  responses:
+    200:
+      description: "Counts documents in a collection."
+      schema:
+        $ref: "#/components/schemas/DocumentCountResponse"
+
+components:
+  schemas:
+    DocumentCountRequest:
+      allOf:
+        - type: "object"
+          properties:
+            query:
+              type: "object"
+              properties:
+                match_all:
+                  type: "object"
+
+    DocumentCountResponse:
+      allOf:
+        - $ref: "#/components/ResponsePayload"
+        - type: "object"
+          properties:
+            result:
+              type: "object"
+              properties:
+                count:
+                  type: "integer"

package/lib/api/openapi/document/create.yaml

@@ -0,0 +1,46 @@
+DocumentCreate:
+  summary: "Creates a new document in the persistent data storage."
+  tags:
+    - document
+  parameters:
+    - in: path
+      name: index
+      schema:
+        type: string
+    - in: path
+      name: collection
+      schema:
+        type: string
+    - name: body
+      in: "body"
+      description: "Creates a new document in the persistent data storage."
+      required: true
+      schema:
+        $ref: "#/components/schemas/DocumentCreateRequest"
+  responses:
+    200:
+      description: "Creates a new document in the persistent data storage."
+      schema:
+          $ref: "#/components/schemas/DocumentCreateResponse"
+
+components:
+  schemas:
+    DocumentCreateRequest:
+      allOf:
+        - type: "object"
+          description: "document content"
+    DocumentCreateResponse:
+      allOf:
+        - $ref: "#/components/ResponsePayload"
+        - type: "object"
+          properties:
+            result:
+              type: "object"
+              properties:
+                _id:
+                  type: "string"
+                  description: "documentId"
+                _version:
+                  type: "integer"
+                _sources:
+                  type: "object"

package/lib/api/openapi/document/createOrReplace.yaml

@@ -0,0 +1,61 @@
+DocumentCreateOrReplace:
+  summary: "Creates a new document in the persistent data storage, or replaces its content if it already exists."
+  tags:
+    - document
+  parameters:
+    - in: path
+      name: index
+      schema:
+        type: string
+      required: true
+    - in: path
+      name: collection
+      schema:
+        type: string
+      required: true
+    - in: path
+      name: _id
+      schema:
+        type: integer
+      required: true
+    - in: path
+      name: refresh
+      schema:
+        type: string
+      required: false
+    - name: body
+      in: "body"
+      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"
+  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"
+
+components:
+  schemas:
+    DocumentCreateOrReplaceRequest:
+      allOf:
+        - type: "object"
+          description: "document content"
+    DocumentCreateOrReplaceResponse:
+      allOf:
+        - $ref: "#/components/ResponsePayload"
+        - type: "object"
+          properties:
+            result:
+              type: "object"
+              properties:
+                _id:
+                  type: "string"
+                  description: "documentId"
+                _version:
+                  type: "integer"
+                _sources:
+                  type: "object"
+                  description: "document content"
+                created:
+                  type: "boolean"

package/lib/api/openapi/document/delete.yaml

@@ -0,0 +1,67 @@
+DocumentDelete:
+  summary: "Deletes a document."
+  tags:
+    - document
+  parameters:
+    - in: path
+      name: index
+      schema:
+        type: string
+      required: true
+    - in: path
+      name: collection
+      schema:
+        type: string
+      required: true
+    - in: path
+      name: documentId
+      schema:
+        type: string
+      required: true
+    - in: path
+      name: refresh
+      schema:
+        type: string
+      description: " if set to wait_for, Kuzzle will not respond until the deletion has been indexed"
+      required: false
+    - in: path
+      name: source
+      schema:
+        type: boolean
+      description: "if set to true Kuzzle will return the deleted document body in the response."
+      required: false
+    - in: path
+      name: silent
+      schema:
+        type: boolean
+      description: "if set, then Kuzzle will not generate notifications. Available since 2.9.2"
+      required: false
+  responses:
+    200:
+      description: "Deletes a document."
+      schema:
+        $ref: "#/components/schemas/DocumentDeleteResponse"
+
+components:
+  schemas:
+    DocumentDeleteRequest:
+      allOf:
+        - type: "object"
+          properties:
+            _id:
+              type: "string"
+              description: "documentId"
+            refresh:
+              type: "string"
+              description: " if set to wait_for, Kuzzle will not respond until the created/replaced document is indexed"
+    DocumentDeleteResponse:
+      allOf:
+        - $ref: "#/components/ResponsePayload"
+        - type: "object"
+          properties:
+            result:
+              type: "object"
+              properties:
+                _id:
+                  type: "string"
+                  description: "documentId"

package/lib/api/openapi/document/deleteByQuery.yaml

@@ -0,0 +1,90 @@
+DocumentDeleteByQuery:
+  summary: "Deletes documents matching the provided search query."
+  tags:
+    - document
+  parameters:
+    - in: path
+      name: index
+      schema:
+        type: string
+      required: true
+    - in: path
+      name: collection
+      schema:
+        type: string
+      required: true
+    - in: path
+      name: documentId
+      schema:
+        type: string
+      required: true
+    - in: path
+      name: refresh
+      schema:
+        type: string
+      description: " if set to wait_for, Kuzzle will not respond until the deletion has been indexed"
+      required: false
+    - in: path
+      name: source
+      schema:
+        type: boolean
+      description: "if set to true Kuzzle will return the deleted document body in the response."
+      required: false
+    - in: path
+      name: silent
+      schema:
+        type: boolean
+      description: "if set, then Kuzzle will not generate notifications. Available since 2.9.2"
+      required: false
+    - in: path
+      name: lang
+      schema:
+        type: string
+      description: "specify the query language to use. By default, it's elasticsearch but koncorde can also be used."
+      required: false
+    - name: body
+      in: "body"
+      description: "Deletes documents matching the provided search query."
+      required: true
+      schema:
+        $ref: "#/components/schemas/DocumentDeleteByQueryRequest"
+  responses:
+    200:
+      description: "Deletes documents matching the provided search query."
+      schema:
+        $ref: "#/components/schemas/DocumentDeleteByQueryResponse"
+
+components:
+  schemas:
+    DocumentDeleteByQueryRequest:
+      allOf:
+        - type: "object"
+          properties:
+            body:
+              type: "object"
+              properties:
+                query:
+                  type: "object"
+                  description: "documents matching this search query will be deleted. Uses the ElasticSearch Query DSL syntax."
+    DocumentDeleteByQueryResponse:
+      allOf:
+        - $ref: "#/components/ResponsePayload"
+        - type: "object"
+          properties:
+            result:
+              type: "object"
+              properties:
+                documents:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      _id:
+                        type: string
+                      _source:
+                        type: object
+                        description: Document content, Present only if 'source' parameter is set to true.
+                ids:
+                  type: "array"
+                  items:
+                    type: "string"

package/lib/api/openapi/document/exists.yaml

@@ -0,0 +1,35 @@
+DocumentExists:
+  summary: "Checks if a document exists."
+  tags:
+    - document
+  parameters:
+    - in: path
+      name: index
+      schema:
+        type: string
+      required: true
+    - in: path
+      name: collection
+      schema:
+        type: string
+      required: true
+    - in: path
+      name: _id
+      schema:
+        type: integer
+      required: true
+  responses:
+    200:
+      description: "Checks if a document exists."
+      schema:
+        $ref: "#/components/schemas/DocumentExistsResponse"
+
+components:
+  schemas:
+    DocumentExistsResponse:
+      allOf:
+        - $ref: "#/components/ResponsePayload"
+        - type: "object"
+          properties:
+            result:
+              type: "boolean"

package/lib/api/openapi/document/get.yaml

@@ -0,0 +1,68 @@
+DocumentGet:
+  summary: "Gets a document."
+  tags:
+    - document
+  parameters:
+    - in: path
+      name: index
+      schema:
+        type: string
+      required: true
+    - in: path
+      name: collection
+      schema:
+        type: string
+      required: true
+    - in: path
+      name: documentId
+      schema:
+        type: string
+      required: true
+  responses:
+    200:
+      description: "Gets a document."
+      schema:
+          $ref: "#/components/schemas/DocumentGetResponse"
+
+components:
+  schemas:
+    DocumentGetResponse:
+      allOf:
+        - $ref: "#/components/ResponsePayload"
+        - type: "object"
+          properties:
+            result:
+              type: "object"
+              properties:
+                _id:
+                  type: "string"
+                  description: "documentId"
+                _version:
+                  type: "integer"
+                _sources:
+                  type: "object"
+                  description: "document content"
+                  properties:
+                    name:
+                      type: "object"
+                      properties:
+                        first:
+                          type: "string"
+                        last:
+                          type: "string"
+                    _kuzzle_info:
+                      type: "object"
+                      description: "Information about the Kuzzle documents"
+                      properties:
+                        author:
+                          type: string
+                        createdAt:
+                          type: integer
+                        updatedAt:
+                          type:
+                            - integer
+                            - null
+                        updater:
+                          type:
+                            - integer
+                            - null

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

@@ -1,57 +1,57 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DefinitionsDocument = 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 tools_1 = require("../tools");
+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, tools_1.readYamlFile)('./lib/api/openapi/documents/count.yaml');
+const countObject = (0, readYamlFile_1.readYamlFile)('./lib/api/openapi/document/count.yaml');
 exports.OpenApiDocumentCount = countObject.DocumentCount;
 exports.OpenApiDocumentCountComponent = countObject.components.schemas;
 // reading the description of the Create action in the controller document.
 // The yaml objects are then stored in the variables below
-const createObject = (0, tools_1.readYamlFile)('./lib/api/openapi/documents/create.yaml');
+const createObject = (0, readYamlFile_1.readYamlFile)('./lib/api/openapi/document/create.yaml');
 exports.OpenApiDocumentCreate = createObject.DocumentCreate;
 exports.OpenApiDocumentCreateComponent = createObject.components.schemas;
 // reading the description of the CreateOrReplace action in the controller document.
 // The yaml objects are then stored in the variables below
-const createOrReplaceObject = (0, tools_1.readYamlFile)('./lib/api/openapi/documents/createOrReplace.yaml');
+const createOrReplaceObject = (0, readYamlFile_1.readYamlFile)('./lib/api/openapi/document/createOrReplace.yaml');
 exports.OpenApiDocumentCreateOrReplace = createOrReplaceObject.DocumentCreateOrReplace;
 exports.OpenApiDocumentCreateOrReplaceComponent = createOrReplaceObject.components.schemas;
 // reading the description of the Get action in the controller document.
 // The yaml objects are then stored in the variables below
-const getObject = (0, tools_1.readYamlFile)('./lib/api/openapi/documents/get.yaml');
+const getObject = (0, readYamlFile_1.readYamlFile)('./lib/api/openapi/document/get.yaml');
 exports.OpenApiDocumentGet = getObject.DocumentGet;
 exports.OpenApiDocumentGetComponent = getObject.components.schemas;
 // reading the description of the Replace action in the controller document.
 // The yaml objects are then stored in the variables below
-const replaceObject = (0, tools_1.readYamlFile)('./lib/api/openapi/documents/replace.yaml');
+const replaceObject = (0, readYamlFile_1.readYamlFile)('./lib/api/openapi/document/replace.yaml');
 exports.OpenApiDocumentReplace = replaceObject.DocumentReplace;
 exports.OpenApiDocumentReplaceComponent = replaceObject.components.schemas;
 // reading the description of the Exists action in the controller document.
 // The yaml objects are then stored in the variables below
-const existsObject = (0, tools_1.readYamlFile)('./lib/api/openapi/documents/exists.yaml');
+const existsObject = (0, readYamlFile_1.readYamlFile)('./lib/api/openapi/document/exists.yaml');
 exports.OpenApiDocumentExists = existsObject.DocumentExists;
 exports.OpenApiDocumentExistsComponent = existsObject.components.schemas;
 // reading the description of the Update action in the controller document.
 // The yaml objects are then stored in the variables below
-const updateObject = (0, tools_1.readYamlFile)('./lib/api/openapi/documents/update.yaml');
+const updateObject = (0, readYamlFile_1.readYamlFile)('./lib/api/openapi/document/update.yaml');
 exports.OpenApiDocumentUpdate = updateObject.DocumentUpdate;
 exports.OpenApiDocumentUpdateComponent = updateObject.components.schemas;
 // reading the description of the Scroll action in the controller document.
 // The yaml objects are then stored in the variables below
-const scrollObject = (0, tools_1.readYamlFile)('./lib/api/openapi/documents/scroll.yaml');
+const scrollObject = (0, readYamlFile_1.readYamlFile)('./lib/api/openapi/document/scroll.yaml');
 exports.OpenApiDocumentScroll = scrollObject.DocumentScroll;
 exports.OpenApiDocumentScrollComponent = scrollObject.components.schemas;
 // reading the description of the Delete action in the controller document.
 // The yaml objects are then stored in the variables below
-const deleteObject = (0, tools_1.readYamlFile)('./lib/api/openapi/documents/delete.yaml');
+const deleteObject = (0, readYamlFile_1.readYamlFile)('./lib/api/openapi/document/delete.yaml');
 exports.OpenApiDocumentDelete = deleteObject.DocumentDelete;
 exports.OpenApiDocumentDeleteComponent = deleteObject.components.schemas;
 // reading the description of the DeleteByQuery action in the controller document.
 // The yaml objects are then stored in the variables below
-const deleteByQueryObject = (0, tools_1.readYamlFile)('./lib/api/openapi/documents/deleteByQuery.yaml');
+const deleteByQueryObject = (0, readYamlFile_1.readYamlFile)('./lib/api/openapi/document/deleteByQuery.yaml');
 exports.OpenApiDocumentDeleteByQuery = deleteByQueryObject.DocumentDeleteByQuery;
 exports.OpenApiDocumentDeleteByQueryComponent = deleteByQueryObject.components.schemas;
 // Document definitions (reusable object for KuzzleRequest and KuzzleResponse)
-exports.DefinitionsDocument = (0, tools_1.readYamlFile)('./lib/api/openapi/payloads.yaml').definitions;
-//# sourceMappingURL=document.js.map
+exports.DefinitionsDocument = (0, readYamlFile_1.readYamlFile)('./lib/api/openapi/payloads.yaml').definitions;
+//# sourceMappingURL=index.js.map

package/lib/api/openapi/document/replace.yaml

@@ -0,0 +1,66 @@
+DocumentReplace:
+  summary: "Replaces the content of an existing document."
+  tags:
+    - document
+  parameters:
+    - in: path
+      name: index
+      schema:
+        type: string
+      required: true
+    - in: path
+      name: collection
+      schema:
+        type: string
+      required: true
+    - in: path
+      name: documentId
+      schema:
+        type: string
+      required: true
+    - in: path
+      name: refresh
+      schema:
+        type: string
+      description: " if set to wait_for, Kuzzle will not respond until the deletion has been indexed"
+      required: false
+    - in: path
+      name: silent
+      schema:
+        type: boolean
+      description: "if set, then Kuzzle will not generate notifications. Available since 2.9.2"
+      required: false
+    - name: body
+      in: "body"
+      description: "Replaces the content of an existing document."
+      required: true
+      schema:
+        $ref: "#/components/schemas/DocumentReplaceRequest"
+  responses:
+    200:
+      description: "Replaces the content of an existing document."
+      schema:
+        $ref: "#/components/schemas/DocumentReplaceResponse"
+
+components:
+  schemas:
+    DocumentReplaceRequest:
+      allOf:
+        - type: "object"
+          description: "new document content"
+    DocumentReplaceResponse:
+      allOf:
+        - $ref: "#/components/ResponsePayload"
+        - type: "object"
+          properties:
+            result:
+              type: "object"
+              properties:
+                _id:
+                  type: "string"
+                  description: "documentId"
+                _version:
+                  type: "integer"
+                _sources:
+                  type: "object"
+                  description: "new document content"

package/lib/api/openapi/document/scroll.yaml

@@ -0,0 +1,49 @@
+DocumentScroll:
+  summary: "Moves a search cursor forward."
+  tags:
+    - document
+  parameters:
+    - in: path
+      name: "scrollId"
+      schema:
+        type: integer
+      description: "cursor unique identifier, obtained by either a search or a scroll query"
+      required: true
+    - in: path
+      name: "scroll"
+      schema:
+        type: integer
+      description: "refresh the cursor duration, using the time to live syntax."
+      required: false
+  responses:
+    200:
+      description: "Moves a search cursor forward."
+      schema:
+        $ref: "#/components/schemas/DocumentScrollResponse"
+
+components:
+  schemas:
+    DocumentScrollResponse:
+      allOf:
+        - $ref: "#/components/ResponsePayload"
+        - type: "object"
+          properties:
+            result:
+              type: "object"
+              properties:
+                scrollId:
+                  type: "string"
+                total:
+                  type: "integer"
+                hits:
+                  type: "array"
+                  items:
+                    type: "object"
+                    properties:
+                      _id:
+                        type: "string"
+                      _score:
+                        type: "integer"
+                      _source:
+                        type: "object"
+                        description: "document content"