Merge pull request #270 from kuzzleio/2.1.0-proposal

# [2.1.0](https://github.com/kuzzleio/documentation/releases/tag/2.1.0) (2019-03-26) #### Bug fixes - [ [#251](#251) ] Fix ssl option name for android ([jenow](https://github.com/jenow)) #### New features - [ [#164](#164) ] KZL-861 Getting started with Webpack ([xbill82](https://github.com/xbill82)) #### Enhancements - [ [#252](#252) ] Add loading of fixtures mappings securities in admin controller ([Aschen](https://github.com/Aschen)) - [ [#253](#253) ] Plugin embedded sdk ([Aschen](https://github.com/Aschen)) - [ [#249](#249) ] Better example for SearchResult.next ([Aschen](https://github.com/Aschen)) #### Others - [ [#262](#262) ] [API] new auth:refreshToken API route documentation ([scottinet](https://github.com/scottinet)) - [ [#257](#257) ] KZL-1054 Fix Node.js SDK Getting Started subscription ([xbill82](https://github.com/xbill82)) - [ [#263](#263) ] [debug] Print standard output on an assertion error ([scottinet](https://github.com/scottinet)) ---
kuzzleio · Mar 26, 2019 · 2c6a5f6 · 2c6a5f6
2 parents 280e927 + 26683e2
commit 2c6a5f6
Show file tree

Hide file tree

Showing 22 changed files with 2,306 additions and 926 deletions.
diff --git a/index.js b/index.js
@@ -280,7 +280,7 @@ if (options.dev.enabled) {
   metalsmith
     .use(
       serve({
-        port: 3000,
+        port: parseInt(process.env.PORT) || 3000,
         verbose: false,
         host: 'localhost'
       })
@@ -318,4 +318,4 @@ if (!options.dev.enabled) {
     }
     log(ok + ' Build finished');
   });
-}
+}
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "kuzzleio-documentation",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Kuzzle Documentation",
   "main": "index.js",
   "scripts": {
@@ -19,76 +19,76 @@
   "author": "The Kuzzle Team <[email protected]>",
   "license": "Apache-2.0",
   "dependencies": {
-    "@babel/core": "^7.2.0",
-    "@babel/preset-env": "^7.2.0",
-    "babel-loader": "^8.0.4",
-    "bluebird": "^3.5.2",
+    "@babel/core": "^7.4.0",
+    "@babel/preset-env": "^7.4.2",
+    "babel-loader": "^8.0.5",
+    "bluebird": "^3.5.3",
     "cheerio": "^0.22.0",
-    "css-loader": "^2.0.0",
-    "express": "^4.16.3",
+    "css-loader": "^2.1.1",
+    "express": "^4.16.4",
     "fast-deepclone": "^1.0.1",
-    "handlebars": "^4.1.0",
-    "hoek": "^5.0.4",
+    "handlebars": "^4.1.1",
+    "hoek": "^6.1.2",
     "indent-string": "^3.2.0",
     "jquery": "^3.3.1",
     "jsonfile": "^5.0.0",
     "jstransformer-handlebars": "^1.1.0",
     "markdown-it": "^8.4.2",
-    "marked": "^0.5.1",
+    "marked": "^0.6.1",
     "metalsmith": "^2.3.0",
     "metalsmith-algolia": "^0.1.0",
     "metalsmith-ancestry": "^1.4.0",
-    "metalsmith-concat": "^6.0.1",
+    "metalsmith-concat": "6.0.1",
     "metalsmith-discover-partials": "^0.1.2",
     "metalsmith-gzip": "^1.1.0",
     "metalsmith-hbt-md": "^1.0.1",
-    "metalsmith-html-minifier": "^3.0.0",
+    "metalsmith-html-minifier": "^3.0.3",
     "metalsmith-inline-svg": "^0.1.4",
-    "metalsmith-layouts": "^2.2.0",
+    "metalsmith-layouts": "^2.3.0",
     "metalsmith-linkcheck": "^0.3.4",
     "metalsmith-livereload": "^0.1.0",
-    "metalsmith-markdown": "^1.0.1",
-    "metalsmith-metallic": "^2.0.2",
+    "metalsmith-markdown": "^1.2.0",
+    "metalsmith-metallic": "^2.0.3",
     "metalsmith-optipng": "0.0.2",
-    "metalsmith-permalinks": "^1.0.0",
+    "metalsmith-permalinks": "^2.2.0",
     "metalsmith-redirect": "^2.1.0",
     "metalsmith-relative-links": "^1.2.0",
-    "metalsmith-sass": "^1.5.1",
+    "metalsmith-sass": "^1.6.0",
     "metalsmith-serve": "0.0.7",
-    "metalsmith-sitemap": "^1.2.1",
+    "metalsmith-sitemap": "^1.2.2",
     "metalsmith-watch": "github:scottinet/metalsmith-watch",
     "metalsmith-webpack2": "^1.0.2",
     "minimatch": "^3.0.4",
     "mqtt": "^2.18.8",
-    "prettier": "^1.14.3",
+    "prettier": "^1.16.4",
     "read-yaml": "^1.1.0",
     "sanitize-filename": "^1.6.1",
     "sass-loader": "^7.1.0",
     "select2": "^4.0.6-rc.1",
     "uglifyjs-webpack-plugin": "^1.3.0",
-    "vue": "^2.5.21",
-    "vue-cool-select": "^1.5.1",
-    "vue-loader": "^15.4.2",
+    "vue": "^2.6.10",
+    "vue-cool-select": "^2.9.0",
+    "vue-loader": "^15.7.0",
     "vue-style-loader": "^4.1.2",
-    "vue-template-compiler": "^2.5.21",
-    "yargs": "^12.0.2"
+    "vue-template-compiler": "^2.6.10",
+    "yargs": "^13.2.2"
   },
   "devDependencies": {
-    "commander": "^2.18.0",
+    "commander": "^2.19.0",
     "ejs": "^2.6.1",
-    "eslint": "^5.6.0",
-    "eslint-plugin-html": "^5.0.0",
-    "eslint-plugin-import": "^2.14.0",
-    "eslint-plugin-node": "^7.0.1",
+    "eslint": "^5.15.3",
+    "eslint-plugin-html": "^5.0.3",
+    "eslint-plugin-import": "^2.16.0",
+    "eslint-plugin-node": "^8.0.1",
     "eslint-plugin-promise": "^4.0.1",
     "eslint-plugin-standard": "^4.0.0",
-    "eslint-scope": "^4.0.0",
+    "eslint-scope": "^4.0.3",
     "eslint-visitor-keys": "^1.0.0",
     "lodash": "^4.17.11",
-    "mocha": "^5.2.0",
-    "mock-require": "^3.0.2",
+    "mocha": "^6.0.2",
+    "mock-require": "^3.0.3",
     "should": "^13.2.3",
     "should-sinon": "0.0.6",
-    "sinon": "^6.3.4"
+    "sinon": "^7.3.0"
   }
 }
diff --git a/src/api/1/controller-admin/load-fixtures/index.md b/src/api/1/controller-admin/load-fixtures/index.md
@@ -0,0 +1,84 @@
+---
+layout: full.html.hbs
+title: loadFixtures
+---
+
+# loadFixtures
+
+{{{since "1.7.0"}}}
+
+Load fixtures into the storage layer.
+
+**Notes:**
+
+* The fixtures can contain any number of index and collection configurations.
+* Each collection contains an array of data to load, just like the [bulk:import API]({{ site_base_path }}api/1/controller-bulk/import/).
+* If an index or collection does not exist, the load will fail.
+* Fixtures are loaded sequentially, one index/collection pair at a time. If a failure occurs, Kuzzle immediately interrupts the sequence, without rollbacking the previously loaded fixtures.
+
+---
+
+## Query Syntax
+
+### HTTP
+
+```http
+URL: http://kuzzle:7512/admin/_loadFixtures[?refresh=wait_for]
+Method: POST
+Body:
+```
+
+```js
+{
+  "index-name": {
+    "collection-name": [
+      {"create": { "_id": "uniq-id-123456" }},
+      {"field": "value", "field2": "value", "field...", "value"}
+    ]
+  }
+}
+```
+
+
+### Other protocols
+
+
+```js
+{
+  "controller": "admin",
+  "action": "loadFixtures",
+  "body": {
+    "index-name": {
+      "collection-name": [
+        {"create": { "_id": "uniq-id-123456" }},
+        {"field": "value", "field2": "value", "field...", "value"}
+      ]
+    }
+  }
+}
+```
+
+## Arguments
+
+### Optional:
+
+* `refresh`: if set to `wait_for`, Kuzzle will not respond until the fixtures are loaded
+
+---
+
+## Response
+
+Returns a confirmation that the command is being executed.
+
+```js
+{
+  "requestId": "d16d5e8c-464a-4589-938f-fd84f46080b9",
+  "status": 200,
+  "error": null,
+  "controller": "admin",
+  "action": "loadFixtures",
+  "collection": null,
+  "index": null,
+  "result": { "acknowledge": true }
+}
+```
diff --git a/src/api/1/controller-admin/load-mappings/index.md b/src/api/1/controller-admin/load-mappings/index.md
@@ -0,0 +1,89 @@
+---
+layout: full.html.hbs
+title: loadMappings
+---
+
+# loadMappings
+
+{{{since "1.7.0"}}}
+
+Apply mappings to the storage layer.
+
+**Notes:**
+
+* The mapping can contain any number of index and collection configurations.
+* Field definitions follow the [Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/5.6/mapping.html) mapping format.
+* If an index or collection does not exist, it will be created automatically.
+* Mappings are loaded sequentially, one index/collection pair at a time. If a failure occurs, Kuzzle immediately interrupts the sequence.
+
+---
+
+## Query Syntax
+
+### HTTP
+
+```http
+URL: http://kuzzle:7512/admin/_loadMappings[?refresh=wait_for]
+Method: POST
+Body:
+```
+
+```js
+{
+  "index-name": {
+    "collection-name": {
+      "properties": {
+        "field1": {},
+        "field2": {},
+        "field...": {}
+      }
+    }
+  }
+}
+```
+
+### Other protocols
+
+
+```js
+{
+  "controller": "admin",
+  "action": "loadMappings",
+  "body": {
+    "index-name": {
+      "collection-name": {
+        "properties": {
+          "field1": {},
+          "field2": {},
+          "field...": {}
+        }
+      }
+    }
+  }
+}
+```
+
+## Arguments
+
+### Optional:
+
+* `refresh`: if set to `wait_for`, Kuzzle will respond only once the mappings are loaded
+
+---
+
+## Response
+
+Returns a confirmation that the command is being executed.
+
+```js
+{
+  "requestId": "d16d5e8c-464a-4589-938f-fd84f46080b9",
+  "status": 200,
+  "error": null,
+  "controller": "admin",
+  "action": "loadMappings",
+  "collection": null,
+  "index": null,
+  "result": { "acknowledge": true }
+}
+```