kuzzle 2.16.0 → 2.16.1

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

@@ -0,0 +1,78 @@
+DocumentUpdate:
+  summary: "Updates a document content."
+  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: 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
+    - in: path
+      name: source
+      schema:
+        type: boolean
+      required: false
+      description: "if set to true Kuzzle will return the entire updated document body in the response."
+    - in: path
+      name: retryOnConflict
+      schema:
+        type: integer
+      description: "conflicts may occur if the same document gets updated multiple times within a short timespan, in a database cluster. You can set the retryOnConflict optional argument (with a retry count), to tell Kuzzle to retry the failing updates the specified amount of times before rejecting the request with an error."
+      required: false
+    - name: body
+      in: "body"
+      description: "Updates a document content."
+      required: true
+      schema:
+        $ref: "#/components/schemas/DocumentUpdateRequest"
+  responses:
+    200:
+      description: "Updates a document content."
+      schema:
+        $ref: "#/components/schemas/DocumentUpdateResponse"
+
+components:
+  schemas:
+    DocumentUpdateRequest:
+      allOf:
+        - type: "object"
+          description: "document changes"
+    DocumentUpdateResponse:
+      allOf:
+        - $ref: "#/components/ResponsePayload"
+        - type: "object"
+          properties:
+            result:
+              type: "object"
+              properties:
+                _id:
+                  type: "string"
+                  description: "documentId"
+                _version:
+                  type: "integer"
+                _source:
+                  type: string
+                  description: "partial or entire document"

package/lib/api/openapi/payloads.yaml

@@ -0,0 +1,32 @@
+definitions:
+  RequestPayload:
+    type: "object"
+    properties:
+      controller:
+        type: "string"
+        enum: "document"
+      action:
+        type: "string"
+        enum: "foo"
+      index:
+        type: "string"
+      collection:
+        type: "string"
+  ResponsePayload:
+    type: "object"
+    properties:
+      status:
+        type: "integer"
+      error:
+        type: "object"
+      index:
+        type: "string"
+      collection:
+        type: "string"
+      controller:
+        type: "string"
+      action:
+        type: "string"
+      requestId:
+        type: "integer"
+        description: "unique request identifie"

package/lib/{api/openapi/tools.d.ts → util/readYamlFile.d.ts}

@@ -1,2 +1,2 @@
-import { JSONObject } from 'kuzzle-sdk';
+import { JSONObject } from '../../index';
 export declare function readYamlFile(path: string): JSONObject;

package/lib/{api/openapi/tools.js → util/readYamlFile.js}

@@ -7,4 +7,4 @@ function readYamlFile(path) {
     return (0, js_yaml_1.load)((0, fs_1.readFileSync)(path, 'utf-8'));
 }
 exports.readYamlFile = readYamlFile;
-//# sourceMappingURL=tools.js.map
+//# sourceMappingURL=readYamlFile.js.map

package/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "kuzzle",
-  "version": "2.16.0",
+  "version": "2.16.1",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kuzzle",
   "author": "The Kuzzle Team <support@kuzzle.io>",
-  "version": "2.16.0",
+  "version": "2.16.1",
   "description": "Kuzzle is an open-source solution that handles all the data management through a secured API, with a large choice of protocols.",
   "bin": {
     "kuzzle": "bin/start-kuzzle-server"
@@ -118,31 +118,16 @@
   },
   "license": "Apache-2.0",
   "files": [
-    "bin/**/*.js",
-    "bin/**/*.d.ts",
     "lib/**/*.js",
     "lib/**/*.d.ts",
     "lib/**/*.json",
     "lib/**/*.proto",
-    "plugins/kuzzle-plugin-cluster/*.js",
-    "plugins/kuzzle-plugin-cluster/*.d.ts",
-    "plugins/kuzzle-plugin-cluster/*.json",
-    "plugins/kuzzle-plugin-cluster/LICENSE.md",
-    "plugins/kuzzle-plugin-cluster/README.md",
-    "plugins/kuzzle-plugin-cluster/.keep",
-    "protocols/**/*.js",
-    "protocols/**/*.d.ts",
-    "protocols/**/*.json",
-    "protocols/**/LICENSE.md",
-    "protocols/**/README.md",
-    "protocols/**/.keep",
+    "lib/**/*.yaml",
     "package.json",
     "package-lock.json",
     "index.js",
     "index.d.ts",
-    ".kuzzlerc.sample",
     "LICENSE.md",
-    "CONTRIBUTING.md",
     "README.md"
   ]
 }