kuzzle 2.29.0 → 2.29.1-beta.1

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

@@ -1,90 +0,0 @@
-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/document/DocumentDeleteByQueryRequest"
-  responses:
-    200:
-      description: "Deletes documents matching the provided search query."
-      schema:
-        $ref: "#/components/document/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/components/document/exists.yaml

@@ -1,35 +0,0 @@
-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/document/DocumentExistsResponse"
-
-components:
-  schemas:
-    DocumentExistsResponse:
-      allOf:
-        - $ref: "#/components/ResponsePayload"
-        - type: "object"
-          properties:
-            result:
-              type: "boolean"

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

@@ -1,68 +0,0 @@
-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: _id
-      schema:
-        type: string
-      required: true
-  responses:
-    200:
-      description: "Gets a document."
-      schema:
-        $ref: "#/components/document/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/components/document/index.d.ts

@@ -1,24 +0,0 @@
-export declare const OpenApiDocumentCount: any;
-export declare const OpenApiDocumentCountComponent: any;
-export declare const OpenApiDocumentCreate: any;
-export declare const OpenApiDocumentCreateComponent: any;
-export declare const OpenApiDocumentCreateOrReplace: any;
-export declare const OpenApiDocumentCreateOrReplaceComponent: any;
-export declare const OpenApiDocumentGet: any;
-export declare const OpenApiDocumentGetComponent: any;
-export declare const OpenApiDocumentReplace: any;
-export declare const OpenApiDocumentReplaceComponent: any;
-export declare const OpenApiDocumentExists: any;
-export declare const OpenApiDocumentExistsComponent: any;
-export declare const OpenApiDocumentUpdate: any;
-export declare const OpenApiDocumentUpdateComponent: any;
-export declare const OpenApiDocumentScroll: any;
-export declare const OpenApiDocumentScrollComponent: any;
-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;
-export declare const OpenApiDocumentmCreateOrReplace: any;
-export declare const OpenApiDocumentmCreateOrReplaceComponent: any;

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

@@ -1,65 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpenApiDocumentmCreateOrReplaceComponent = exports.OpenApiDocumentmCreateOrReplace = 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");
-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, readYamlFile_1.readYamlFile)(__dirname + "/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, readYamlFile_1.readYamlFile)(__dirname + "/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, readYamlFile_1.readYamlFile)(__dirname + "/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, readYamlFile_1.readYamlFile)(__dirname + "/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, readYamlFile_1.readYamlFile)(__dirname + "/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, readYamlFile_1.readYamlFile)(__dirname + "/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, readYamlFile_1.readYamlFile)(__dirname + "/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, readYamlFile_1.readYamlFile)(__dirname + "/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, 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;
-// reading the description of the mCreateOrReplace action in the controller document.
-// The yaml objects are then stored in the variables below
-const mCreateOrReplaceObject = (0, readYamlFile_1.readYamlFile)(__dirname + "/mCreateOrReplace.yaml");
-exports.OpenApiDocumentmCreateOrReplace = mCreateOrReplaceObject.DocumentmCreateOrReplace;
-exports.OpenApiDocumentmCreateOrReplaceComponent = mCreateOrReplaceObject.components.schemas;
-//# sourceMappingURL=index.js.map

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

@@ -1,93 +0,0 @@
-DocumentmCreateOrReplace:
-  summary: "Creates or replaces multiple documents."
-  tags:
-    - document
-  parameters:
-    - in: path
-      name: index
-      schema:
-        type: string
-      required: true
-    - in: path
-      name: collection
-      schema:
-        type: string
-      required: true
-    - in: path
-      name: refresh
-      schema:
-        type: string
-      required: false
-    - in: path
-      name: silent
-      schema:
-        type: boolean
-      required: false
-    - in: path
-      name: _source
-      description: "if set to true, the response will include the document's source (default value true)"
-      schema:
-        type: boolean
-      required: false
-    - name: body
-      in: "body"
-      description: "Creates or replaces multiple documents."
-      required: true
-      schema:
-        $ref: "#/components/document/DocumentmCreateOrReplaceRequest"
-  responses:
-    200:
-      description: "Creates or replaces multiple documents."
-      schema:
-        $ref: "#/components/document/DocumentmCreateOrReplaceResponse"
-
-components:
-  schemas:
-    DocumentmCreateOrReplaceRequest:
-      allOf:
-        - type: "object"
-          properties:
-            documents:
-              type: "array"
-              items:
-                type: "object"
-                properties:
-                  _id:
-                    type: "string"
-                  body:
-                    type: "object"
-                    description: "document content"
-    DocumentmCreateOrReplaceResponse:
-      allOf:
-        - $ref: "#/components/ResponsePayload"
-        - type: "object"
-          properties:
-            result:
-              type: "object"
-              properties:
-                successes:
-                  type: "array"
-                  items:
-                    type: "object"
-                    properties:
-                      _id:
-                        type: "string"
-                      _source:
-                        type: "object"
-                        description: "document content"
-                      _version:
-                        type: "integer"
-                      created:
-                        type: "boolean"
-                errors:
-                  type: "array"
-                  items:
-                    type: "object"
-                    properties:
-                      document:
-                        type: "object"
-                        description: "document content"
-                      status:
-                        type: "integer"
-                      reason:
-                        type: "string"

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

@@ -1,66 +0,0 @@
-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/document/DocumentReplaceRequest"
-  responses:
-    200:
-      description: "Replaces the content of an existing document."
-      schema:
-        $ref: "#/components/document/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/components/document/scroll.yaml

@@ -1,49 +0,0 @@
-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/document/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"

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;