Merge pull request #550 from kuzzleio/1.4.2-proposal

Release 1.4.2
kuzzleio · Nov 7, 2018 · a50af8d · a50af8d
2 parents 276664c + 2b8e7ce
commit a50af8d
Show file tree

Hide file tree

Showing 235 changed files with 619 additions and 621 deletions.
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": "1.4.1",
+  "version": "1.4.2",
   "description": "Kuzzle Documentation",
   "main": "index.js",
   "scripts": {

diff --git a/src/api-documentation/controller-admin/dump.md b/src/api-documentation/controller-admin/dump.md
@@ -14,8 +14,8 @@ title: dump
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/admin/_dump[?refresh=wait_for]`  
-</br><b>Method:</b> `POST`
+<b>URL:</b> <code>http://kuzzle:7512/admin/_dump[?refresh=wait_for]</code>  
+<br><b>Method:</b> <code>POST</code>
 </p>
 </blockquote>
 

diff --git a/src/api-documentation/controller-admin/reset-cache.md b/src/api-documentation/controller-admin/reset-cache.md
@@ -14,9 +14,8 @@ title: resetCache
 
 <blockquote class="js">
 <p>
-<b>URL:</b> http://kuzzle:7512/admin/_resetCache?database=[internalCache|memoryStorage]
-</br>
-<b>Method:</b> POST
+<b>URL:</b> <code>http://kuzzle:7512/admin/_resetCache?database=[internalCache|memoryStorage]</code>
+<br><b>Method:</b> <code>POST</code>
 </p>
 </blockquote>
 

diff --git a/src/api-documentation/controller-admin/reset-database.md b/src/api-documentation/controller-admin/reset-database.md
@@ -14,8 +14,8 @@ title: resetDatabase
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/admin/_resetDatabase`  
-</br><b>Method:</b> `POST`
+<b>URL:</b> <code>http://kuzzle:7512/admin/_resetDatabase</code>  
+<br><b>Method:</b> <code>POST</code>
 </p>
 </blockquote>
 

diff --git a/src/api-documentation/controller-admin/reset-kuzzle-data.md b/src/api-documentation/controller-admin/reset-kuzzle-data.md
@@ -14,8 +14,8 @@ title: resetKuzzleData
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/admin/_resetKuzzleData`  
-</br><b>Method:</b> `POST`
+<b>URL:</b> <code>http://kuzzle:7512/admin/_resetKuzzleData</code>  
+<br><b>Method:</b> <code>POST</code>
 </p>
 </blockquote>
 

diff --git a/src/api-documentation/controller-admin/reset-security.md b/src/api-documentation/controller-admin/reset-security.md
@@ -14,8 +14,8 @@ title: resetSecurity
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/admin/_resetSecurity`  
-</br><b>Method:</b> `POST`
+<b>URL:</b> <code>http://kuzzle:7512/admin/_resetSecurity</code>  
+<br><b>Method:</b> <code>POST</code>
 </p>
 </blockquote>
 

diff --git a/src/api-documentation/controller-admin/shutdown.md b/src/api-documentation/controller-admin/shutdown.md
@@ -14,8 +14,8 @@ title: shutdown
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/admin/_shutdown`  
-</br><b>Method:</b> `POST`
+<b>URL:</b> <code>http://kuzzle:7512/admin/_shutdown</code>  
+<br><b>Method:</b> <code>POST</code>
 </p>
 </blockquote>
 

diff --git a/src/api-documentation/controller-auth/check-token.md b/src/api-documentation/controller-auth/check-token.md
@@ -13,9 +13,9 @@ title: checkToken
 
 <blockquote class="js">
 <p>
-  <b>URL:</b> `http://kuzzle:7512/_checkToken`  
-  </br><b>Method:</b> `POST`  
-  **Body:**  
+  <b>URL:</b> <code>http://kuzzle:7512/_checkToken</code>  
+<br>  <b>Method:</b> <code>POST</code>  
+<br>  <b>Body:</b>  
 </p>
 </blockquote>
 

diff --git a/src/api-documentation/controller-auth/create-my-credentials.md b/src/api-documentation/controller-auth/create-my-credentials.md
@@ -13,10 +13,10 @@ title: createMyCredentials
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/credentials/<strategy>/_me/_create`  
-</br><b>Method:</b> `POST`  
-**Headers:** `Authorization: "Bearer <encrypted_jwt_token>"`  
-**Body**
+<b>URL:</b> <code>http://kuzzle:7512/credentials/&lt;strategy&gt;/_me/_create</code>  
+<br><b>Method:</b> <code>POST</code>  
+<br><b>Headers:</b> <code>Authorization: "Bearer &lt;encrypted_jwt_token&gt;"</code>  
+<br><b>Body</b>
 </p>
 </blockquote>
 

diff --git a/src/api-documentation/controller-auth/credentials-exists.md b/src/api-documentation/controller-auth/credentials-exists.md
@@ -13,9 +13,9 @@ title: credentialsExist
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/credentials/<strategy>/_me/_exists`  
-</br><b>Method:</b> `GET`  
-**Headers:** `Authorization: "Bearer <encrypted_jwt_token>"`
+<b>URL:</b> <code>http://kuzzle:7512/credentials/&lt;strategy&gt;/_me/_exists</code>  
+<br><b>Method:</b> <code>GET</code>  
+<br><b>Headers:</b> <code>Authorization: "Bearer &lt;encrypted_jwt_token&gt;"</code>
 </p>
 </blockquote>
 

diff --git a/src/api-documentation/controller-auth/delete-my-credentials.md b/src/api-documentation/controller-auth/delete-my-credentials.md
@@ -13,9 +13,9 @@ title: deleteMyCredentials
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/credentials/<strategy>/_me`  
-</br><b>Method:</b> `DELETE`  
-**Headers:** `Authorization: "Bearer <encrypted_jwt_token>"`
+<b>URL:</b> <code>http://kuzzle:7512/credentials/&lt;strategy&gt;/_me</code>  
+<br><b>Method:</b> <code>DELETE</code>  
+<br><b>Headers:</b> <code>Authorization: "Bearer &lt;encrypted_jwt_token&gt;"</code>
 </p>
 </blockquote>
 

diff --git a/src/api-documentation/controller-auth/get-current-user.md b/src/api-documentation/controller-auth/get-current-user.md
@@ -13,9 +13,9 @@ title: getCurrentUser
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/users/_me`  
-</br><b>Method:</b> `GET`  
-**Headers:** `Authorization: "Bearer <encrypted_jwt_token>"`
+<b>URL:</b> <code>http://kuzzle:7512/users/_me</code>  
+<br><b>Method:</b> <code>GET</code>  
+<br><b>Headers:</b> <code>Authorization: "Bearer &lt;encrypted_jwt_token&gt;"</code>
 </p>
 </blockquote>
 

diff --git a/src/api-documentation/controller-auth/get-my-credentials.md b/src/api-documentation/controller-auth/get-my-credentials.md
@@ -13,9 +13,9 @@ title: getMyCredentials
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/credentials/<strategy>/_me`  
-</br><b>Method:</b> `GET`  
-**Headers:** `Authorization: "Bearer <encrypted_jwt_token>"`
+<b>URL:</b> <code>http://kuzzle:7512/credentials/&lt;strategy&gt;/_me</code>  
+<br><b>Method:</b> <code>GET</code>  
+<br><b>Headers:</b> <code>Authorization: "Bearer &lt;encrypted_jwt_token&gt;"</code>
 </p>
 </blockquote>
 

diff --git a/src/api-documentation/controller-auth/get-my-rights.md b/src/api-documentation/controller-auth/get-my-rights.md
@@ -13,9 +13,9 @@ title: getMyRights
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/users/_me/_rights`  
-</br><b>Method:</b> `GET`  
-**Headers:** `Authorization: "Bearer <encrypted_jwt_token>"`
+<b>URL:</b> <code>http://kuzzle:7512/users/_me/_rights</code>  
+<br><b>Method:</b> <code>GET</code>  
+<br><b>Headers:</b> <code>Authorization: "Bearer &lt;encrypted_jwt_token&gt;"</code>
 </p>
 </blockquote>
 

diff --git a/src/api-documentation/controller-auth/get-strategies.md b/src/api-documentation/controller-auth/get-strategies.md
@@ -13,8 +13,8 @@ title: getStrategies
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/strategies`  
-</br><b>Method:</b> `GET`
+<b>URL:</b> <code>http://kuzzle:7512/strategies</code>  
+<br><b>Method:</b> <code>GET</code>
 </p>
 </blockquote>
 

diff --git a/src/api-documentation/controller-auth/login.md b/src/api-documentation/controller-auth/login.md
@@ -13,9 +13,9 @@ title: login
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/_login/<strategy>[?expiresIn=<expiresIn>]`  
-</br><b>Method:</b> `POST`  
-**Body:**
+<b>URL:</b> <code>http://kuzzle:7512/_login/&lt;strategy&gt;[?expiresIn=&lt;expiresIn&gt;]</code>  
+<br><b>Method:</b> <code>POST</code>  
+<br><b>Body:</b>
 </p>
 </blockquote>
 

diff --git a/src/api-documentation/controller-auth/logout.md b/src/api-documentation/controller-auth/logout.md
@@ -13,9 +13,9 @@ title: logout
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/_logout`  
-</br><b>Method:</b> `POST`  
-**Headers:** `Authorization: "Bearer <json_web_token>"`
+<b>URL:</b> <code>http://kuzzle:7512/_logout</code>  
+<br><b>Method:</b> <code>POST</code>  
+<br><b>Headers:</b> <code>Authorization: "Bearer &lt;json_web_token&gt;"</code>
 </p>
 </blockquote>
 

diff --git a/src/api-documentation/controller-auth/update-my-credentials.md b/src/api-documentation/controller-auth/update-my-credentials.md
@@ -13,10 +13,10 @@ title: updateMyCredentials
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/credentials/<strategy>/_me/_update`  
-</br><b>Method:</b> `PUT`  
-**Headers:** `Authorization: "Bearer <encrypted_jwt_token>"`  
-**Body**
+<b>URL:</b> <code>http://kuzzle:7512/credentials/&lt;strategy&gt;/_me/_update</code>  
+<br><b>Method:</b> <code>PUT</code>  
+<br><b>Headers:</b> <code>Authorization: "Bearer &lt;encrypted_jwt_token&gt;"</code>  
+<br><b>Body</b>
 </p>
 </blockquote>
 

diff --git a/src/api-documentation/controller-auth/update-self.md b/src/api-documentation/controller-auth/update-self.md
@@ -13,10 +13,10 @@ title: updateSelf
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/_updateSelf`  
-</br><b>Method:</b> `PUT`  
-**Headers:** `Authorization: "Bearer <encrypted_jwt_token>"`  
-**Body**
+<b>URL:</b> <code>http://kuzzle:7512/_updateSelf</code>  
+<br><b>Method:</b> <code>PUT</code>  
+<br><b>Headers:</b> <code>Authorization: "Bearer &lt;encrypted_jwt_token&gt;"</code>  
+<br><b>Body</b>
 </p>
 </blockquote>
 

diff --git a/src/api-documentation/controller-auth/validate-my-credentials.md b/src/api-documentation/controller-auth/validate-my-credentials.md
@@ -13,10 +13,10 @@ title: validateMyCredentials
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/credentials/<strategy>/_me/_validate`  
-</br><b>Method:</b> `POST`  
-**Headers:** `Authorization: "Bearer <encrypted_jwt_token>"`  
-**Body**
+<b>URL:</b> <code>http://kuzzle:7512/credentials/&lt;strategy&gt;/_me/_validate</code>  
+<br><b>Method:</b> <code>POST</code>  
+<br><b>Headers:</b> <code>Authorization: "Bearer &lt;encrypted_jwt_token&gt;"</code>  
+<br><b>Body</b>
 </p>
 </blockquote>
 

diff --git a/src/api-documentation/controller-bulk/import.md b/src/api-documentation/controller-bulk/import.md
@@ -17,9 +17,9 @@ title: import
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/<index>/<collection>/_bulk`  
-</br><b>Method:</b> `POST`  
-**Body:**
+<b>URL:</b> <code>http://kuzzle:7512/&lt;index&gt;/&lt;collection&gt;/_bulk</code>  
+<br><b>Method:</b> <code>POST</code>  
+<br><b>Body:</b>
 </p>
 </blockquote>
 
@@ -78,7 +78,7 @@ title: import
   "requestId": "<unique request identifier>",
   "result": {
     // The list of executed queries, with their status
-    "hits": [
+    "items": [
       {
         "create": {
           "_id": "<documentId>",
@@ -116,9 +116,9 @@ If a subset of the documents fail to save, the client will receive a <a href="{{
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/_bulk`  
-</br><b>Method:</b> `POST`  
-**Body:**
+<b>URL:</b> <code>http://kuzzle:7512/_bulk</code>  
+<br><b>Method:</b> <code>POST</code>  
+<br><b>Body:</b>
 </p>
 </blockquote>
 
@@ -175,7 +175,7 @@ If a subset of the documents fail to save, the client will receive a <a href="{{
   "requestId": "<unique request identifier>",
   "result": {
     // The list of executed queries, with their status
-    "hits": [
+    "items": [
       {
         "create": {
           "_id": "<documentId>",

diff --git a/src/api-documentation/controller-collection/create.md b/src/api-documentation/controller-collection/create.md
@@ -13,9 +13,9 @@ title: create
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/<index>/<collection>`  
-</br><b>Method:</b> `PUT`  
-**Body:**  
+<b>URL:</b> <code>http://kuzzle:7512/&lt;index&gt;/&lt;collection&gt;</code>  
+<br><b>Method:</b> <code>PUT</code>  
+<br><b>Body:</b>  
 </p>
 </blockquote>
 

diff --git a/src/api-documentation/controller-collection/delete-specifications.md b/src/api-documentation/controller-collection/delete-specifications.md
@@ -13,8 +13,8 @@ title: deleteSpecifications
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/<index>/<collection>/_specifications`  
-</br><b>Method:</b> `DELETE`
+<b>URL:</b> <code>http://kuzzle:7512/&lt;index&gt;/&lt;collection&gt;/_specifications</code>  
+<br><b>Method:</b> <code>DELETE</code>
 </p>
 </blockquote>
 

diff --git a/src/api-documentation/controller-collection/exists.md b/src/api-documentation/controller-collection/exists.md
@@ -13,8 +13,8 @@ title: exists
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/<index>/<collection>/_exists`  
-</br><b>Method:</b> `GET`
+<b>URL:</b> <code>http://kuzzle:7512/&lt;index&gt;/&lt;collection&gt;/_exists</code>  
+<br><b>Method:</b> <code>GET</code>
 </p>
 </blockquote>
 

diff --git a/src/api-documentation/controller-collection/get-mapping.md b/src/api-documentation/controller-collection/get-mapping.md
@@ -13,8 +13,8 @@ title: getMapping
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/<index>/<collection>/_mapping`  
-</br><b>Method:</b> `GET`
+<b>URL:</b> <code>http://kuzzle:7512/&lt;index&gt;/&lt;collection&gt;/_mapping</code>  
+<br><b>Method:</b> <code>GET</code>
 </p>
 </blockquote>
 

diff --git a/src/api-documentation/controller-collection/get-specifications.md b/src/api-documentation/controller-collection/get-specifications.md
@@ -13,8 +13,8 @@ title: getSpecifications
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/<index>/<collection>/_specifications`  
-</br><b>Method:</b> `GET`
+<b>URL:</b> <code>http://kuzzle:7512/&lt;index&gt;/&lt;collection&gt;/_specifications</code>  
+<br><b>Method:</b> <code>GET</code>
 </p>
 </blockquote>
 

diff --git a/src/api-documentation/controller-collection/list.md b/src/api-documentation/controller-collection/list.md
@@ -13,8 +13,8 @@ title: list
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/<index>/_list[?type=<all|stored|realtime>][&from=0][&size=42]`  
-</br><b>Method:</b> `GET`
+<b>URL:</b> <code>http://kuzzle:7512/&lt;index&gt;/_list[?type=&lt;all|stored|realtime&gt;][&from=0][&size=42]</code>  
+<br><b>Method:</b> <code>GET</code>
 </p>
 </blockquote>
 

diff --git a/src/api-documentation/controller-collection/scroll-specifications.md b/src/api-documentation/controller-collection/scroll-specifications.md
@@ -13,8 +13,8 @@ title: scrollSpecifications
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/validations/_scroll/<scrollId>[?scroll=<time to live>]`  
-</br><b>Method:</b> `GET`
+<b>URL:</b> <code>http://kuzzle:7512/validations/_scroll/&lt;scrollId&gt;[?scroll=&lt;time to live&gt;]</code>  
+<br><b>Method:</b> <code>GET</code>
 </p>
 </blockquote>
 

diff --git a/src/api-documentation/controller-collection/search-specifications.md b/src/api-documentation/controller-collection/search-specifications.md
@@ -13,9 +13,9 @@ title: searchSpecifications
 
 <blockquote class="js">
 <p>
-<b>URL:</b> `http://kuzzle:7512/validations/_search[?from=0][&size=10][&scroll=<time to live>]`  
-</br><b>Method:</b> `POST`  
-**Body**
+<b>URL:</b> <code>http://kuzzle:7512/validations/_search[?from=0][&size=10][&scroll=&lt;time to live&gt;]</code>  
+<br><b>Method:</b> <code>POST</code>  
+<br><b>Body</b>
 </p>
 </blockquote>