kuzzle 2.29.0 → 2.29.1-beta.2

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

@@ -1,78 +0,0 @@
-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/document/DocumentUpdateRequest"
-  responses:
-    200:
-      description: "Updates a document content."
-      schema:
-        $ref: "#/components/document/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/components/document/validate.yaml

@@ -1,42 +0,0 @@
-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

@@ -1,3 +0,0 @@
-export * from "./document";
-export * from "./security";
-export declare const OpenApiPayloadsDefinitions: any;

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

@@ -1,23 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (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);
-__exportStar(require("./security"), 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/components/payloads.yaml

@@ -1,32 +0,0 @@
-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/components/security/index.d.ts

@@ -1,2 +0,0 @@
-export declare const OpenApiSecurityUpsertUser: any;
-export declare const OpenApiSecurityUpsertUserComponent: any;

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

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpenApiSecurityUpsertUserComponent = exports.OpenApiSecurityUpsertUser = void 0;
-const readYamlFile_1 = require("../../../../util/readYamlFile");
-// reading the description of the UpsertUser action in the controller security.
-// The yaml objects are then stored in the variables below
-const upsertUserObject = (0, readYamlFile_1.readYamlFile)(__dirname + "/upsertUser.yaml");
-exports.OpenApiSecurityUpsertUser = upsertUserObject.SecurityUpsertUser;
-exports.OpenApiSecurityUpsertUserComponent = upsertUserObject.components.schemas;
-//# sourceMappingURL=index.js.map

package/lib/api/openapi/components/security/upsertUser.yaml

@@ -1,58 +0,0 @@
-SecurityUpsertUser:
-  summary: "Update or create a user."
-  tags:
-    - user
-  parameters:
-    - 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: retryOnConflict
-      schema:
-        type: integer
-      description: "conflicts may occur if the same user 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: content
-      in: "body"
-      description: "Updates a user content."
-      required: true
-      schema:
-        $ref: "#/components/security/SecurityUpsertUserRequest"
-  responses:
-    200:
-      description: "Updates or creates a user."
-      schema:
-        $ref: "#/components/security/SecurityUpsertUserResponse"
-
-components:
-  schemas:
-    SecurityUpsertUserRequest:
-      allOf:
-        - type: "object"
-          description: "user changes"
-    SecurityUpsertUserResponse:
-      allOf:
-        - $ref: "#/components/ResponsePayload"
-        - type: "object"
-          properties:
-            result:
-              type: "object"
-              properties:
-                _id:
-                  type: "string"
-                  description: "userId"
-                _version:
-                  type: "integer"
-                _source:
-                  type: "object"
-                  description: ' (optional) actualized user content. This property appears only if the "source" option is set to true'
-                created:
-                  type: "boolean"