Merge pull request #2424 from kuzzleio/2.20.0-proposal

# [2.20.0](https://github.com/kuzzleio/kuzzle/releases/tag/2.20.0) (2023-01-17) #### New features - [ [#2423](#2423) ] Add action to generate single use token ([Aschen](https://github.com/Aschen)) #### Enhancements - [ [#2413](#2413) ] Bump segfault handler to 1.4.2 ([Shiranuit](https://github.com/Shiranuit)) - [ [#2415](#2415) ] Add Inflector.snakeCase method ([Aschen](https://github.com/Aschen)) ---
kuzzleio · Jan 18, 2023 · d3b2cb1 · d3b2cb1
2 parents 8eef933 + 216f411
commit d3b2cb1
Show file tree

Hide file tree

Showing 659 changed files with 1,876 additions and 1,844 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -60,7 +60,7 @@ lib/types/Global.d.ts
 lib/types/Global.js
 lib/util/interfaces.js
 lib/util/mutex.js
-lib/util/inflector.js
+lib/util/Inflector.js
 lib/util/koncordeCompat.js
 lib/util/name-generator.js
 features/support/application/functional-tests-app.js

diff --git a/.gitignore b/.gitignore
@@ -199,7 +199,7 @@ lib/util/array.js
 lib/util/bufferedPassThrough.js
 lib/util/crypto.js
 lib/util/dump-collection.js
-lib/util/inflector.js
+lib/util/Inflector.js
 lib/util/interfaces.js
 lib/util/koncordeCompat.js
 lib/util/mutex.js

diff --git a/doc/2/.vuepress b/doc/2/.vuepress
@@ -1 +1 @@
-../framework/src/.vuepress
+../framework/src/.vuepress
diff --git a/doc/2/api/controllers/admin/dump/index.md b/doc/2/api/controllers/admin/dump/index.md
@@ -1,7 +1,7 @@
 ---
 code: true
 type: page
-title: dump
+title: dump | API | Core
 ---
 
 # dump

diff --git a/doc/2/api/controllers/admin/index.md b/doc/2/api/controllers/admin/index.md
@@ -1,6 +1,6 @@
 ---
 type: branch
-title: admin
+title: admin | API | Core
 description: API v2.x Admin controller
 code: true
 ---
diff --git a/doc/2/api/controllers/admin/load-fixtures/index.md b/doc/2/api/controllers/admin/load-fixtures/index.md
@@ -1,7 +1,7 @@
 ---
 code: true
 type: page
-title: loadFixtures
+title: loadFixtures | API | Core
 ---
 
 # loadFixtures

diff --git a/doc/2/api/controllers/admin/load-mappings/index.md b/doc/2/api/controllers/admin/load-mappings/index.md
@@ -1,7 +1,7 @@
 ---
 code: true
 type: page
-title: loadMappings
+title: loadMappings | API | Core
 ---
 
 # loadMappings

diff --git a/doc/2/api/controllers/admin/load-securities/index.md b/doc/2/api/controllers/admin/load-securities/index.md
@@ -1,7 +1,7 @@
 ---
 code: true
 type: page
-title: loadSecurities
+title: loadSecurities | API | Core
 ---
 
 # loadSecurities

diff --git a/doc/2/api/controllers/admin/reset-cache/index.md b/doc/2/api/controllers/admin/reset-cache/index.md
@@ -2,7 +2,7 @@
 type: page
 
 code: true
-title: resetCache
+title: resetCache | API | Core
 ---
 
 # resetCache

diff --git a/doc/2/api/controllers/admin/reset-database/index.md b/doc/2/api/controllers/admin/reset-database/index.md
@@ -2,7 +2,7 @@
 type: page
 
 code: true
-title: resetDatabase
+title: resetDatabase | API | Core
 ---
 
 # resetDatabase

diff --git a/doc/2/api/controllers/admin/reset-security/index.md b/doc/2/api/controllers/admin/reset-security/index.md
@@ -2,7 +2,7 @@
 type: page
 
 code: true
-title: resetSecurity
+title: resetSecurity | API | Core
 ---
 
 # resetSecurity

diff --git a/doc/2/api/controllers/admin/shutdown/index.md b/doc/2/api/controllers/admin/shutdown/index.md
@@ -2,7 +2,7 @@
 type: page
 
 code: true
-title: shutdown
+title: shutdown | API | Core
 ---
 
 # shutdown

diff --git a/doc/2/api/controllers/auth/check-rights/index.md b/doc/2/api/controllers/auth/check-rights/index.md
@@ -1,7 +1,7 @@
 ---
 code: true
 type: page
-title: checkRights
+title: checkRights | API | Core
 ---
 
 # checkRights

diff --git a/doc/2/api/controllers/auth/check-token/index.md b/doc/2/api/controllers/auth/check-token/index.md
@@ -1,7 +1,7 @@
 ---
 code: true
 type: page
-title: checkToken
+title: checkToken | API | Core
 ---
 
 # checkToken

diff --git a/doc/2/api/controllers/auth/create-api-key/index.md b/doc/2/api/controllers/auth/create-api-key/index.md
@@ -1,7 +1,7 @@
 ---
 code: true
 type: page
-title: createApiKey
+title: createApiKey | API | Core
 ---
 
 # createApiKey

diff --git a/doc/2/api/controllers/auth/create-my-credentials/index.md b/doc/2/api/controllers/auth/create-my-credentials/index.md
@@ -1,7 +1,7 @@
 ---
 code: true
 type: page
-title: createMyCredentials
+title: createMyCredentials | API | Core
 ---
 
 # createMyCredentials

diff --git a/doc/2/api/controllers/auth/create-token/index.md b/doc/2/api/controllers/auth/create-token/index.md
@@ -0,0 +1,89 @@
+---
+code: true
+type: page
+title: createToken | API | Core
+---
+
+# createToken
+
+<SinceBadge version="2.20.0"/>
+
+Creates a token for the currently loggued user.
+
+::: info
+It is not possible to create token that does not expire to prevent memory leaks.
+For this you should use [auth:createApiKey](/core/2/api/controllers/auth/create-api-key) instead.
+:::
+
+---
+
+## Query Syntax
+
+### HTTP
+
+```http
+URL: http://kuzzle:7512/_createToken[&expiresIn=900][&singleUse]
+Method: POST
+Body:
+```
+
+```js
+{
+}
+```
+
+### Other protocols
+
+```js
+{
+  "controller": "auth",
+  "action": "createToken",
+
+
+  // optional arguments
+  "singleUse": true,
+  "expiresIn": 900
+}
+```
+
+---
+
+## Arguments
+
+### Optional
+
+- `expiresIn`: set the expiration duration (`-1` by default)
+  - if a raw number is provided (not enclosed between quotes), then the expiration delay is in milliseconds. Example: `86400000`
+  - if this value is a string, then its content is parsed by the [ms](https://www.npmjs.com/package/ms) library. Examples: `"6d"`, `"10h"`
+- `singleUse`: if set to `true`, then the token can be used only once
+
+---
+
+## Body properties
+
+---
+
+## Response
+
+Returns an object containing the token:
+
+- `expiresAt`: expiration date in UNIX micro-timestamp format
+- `ttl`: original ttl
+- `token`: authentication token associated with this API key
+- `singleUse`: `true` if single use token
+
+```js
+{
+  "status": 200,
+  "error": null,
+  "controller": "auth",
+  "action": "createToken",
+  "requestId": "<unique request identifier>",
+  "result": {
+    "expiresAt": -1,
+    "ttl": -1,
+    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiJNeSIsImlhdCI6MTU3MzE4NTkzNSwiZXhwIjoxNTczMTg1OTM0fQ.08qAnSD03V0N1OcviGVUAZEjjv4DxULTgoQQwojn1PA",
+    "singleUse": true,
+  }
+}
+```
diff --git a/doc/2/api/controllers/auth/credentials-exists/index.md b/doc/2/api/controllers/auth/credentials-exists/index.md
@@ -1,7 +1,7 @@
 ---
 code: true
 type: page
-title: credentialsExist
+title: credentialsExist | API | Core
 ---
 
 # credentialsExist

diff --git a/doc/2/api/controllers/auth/delete-api-key/index.md b/doc/2/api/controllers/auth/delete-api-key/index.md
@@ -1,7 +1,7 @@
 ---
 code: true
 type: page
-title: deleteApiKey
+title: deleteApiKey | API | Core
 ---
 
 # deleteApiKey

diff --git a/doc/2/api/controllers/auth/delete-my-credentials/index.md b/doc/2/api/controllers/auth/delete-my-credentials/index.md
@@ -1,7 +1,7 @@
 ---
 code: true
 type: page
-title: deleteMyCredentials
+title: deleteMyCredentials | API | Core
 ---
 
 # deleteMyCredentials

diff --git a/doc/2/api/controllers/auth/get-current-user/index.md b/doc/2/api/controllers/auth/get-current-user/index.md
@@ -1,7 +1,7 @@
 ---
 code: true
 type: page
-title: getCurrentUser
+title: getCurrentUser | API | Core
 ---
 
 # getCurrentUser

diff --git a/doc/2/api/controllers/auth/get-my-credentials/index.md b/doc/2/api/controllers/auth/get-my-credentials/index.md
@@ -1,7 +1,7 @@
 ---
 code: true
 type: page
-title: getMyCredentials
+title: getMyCredentials | API | Core
 ---
 
 # getMyCredentials

diff --git a/doc/2/api/controllers/auth/get-my-rights/index.md b/doc/2/api/controllers/auth/get-my-rights/index.md
@@ -1,7 +1,7 @@
 ---
 code: true
 type: page
-title: getMyRights
+title: getMyRights | API | Core
 ---
 
 # getMyRights

diff --git a/doc/2/api/controllers/auth/get-strategies/index.md b/doc/2/api/controllers/auth/get-strategies/index.md
@@ -1,7 +1,7 @@
 ---
 code: true
 type: page
-title: getStrategies
+title: getStrategies | API | Core
 ---
 
 # getStrategies

diff --git a/doc/2/api/controllers/auth/index.md b/doc/2/api/controllers/auth/index.md
@@ -1,5 +1,5 @@
 ---
 type: branch
 code: true
-title: auth
+title: auth | API | Core
 ---
diff --git a/doc/2/api/controllers/auth/login/index.md b/doc/2/api/controllers/auth/login/index.md
@@ -1,7 +1,7 @@
 ---
 code: true
 type: page
-title: login
+title: login | API | Core
 ---
 
 # login

diff --git a/doc/2/api/controllers/auth/logout/index.md b/doc/2/api/controllers/auth/logout/index.md
@@ -1,7 +1,7 @@
 ---
 code: true
 type: page
-title: logout
+title: logout | API | Core
 ---
 
 # logout

diff --git a/doc/2/api/controllers/auth/refresh-token/index.md b/doc/2/api/controllers/auth/refresh-token/index.md
@@ -1,7 +1,7 @@
 ---
 code: true
 type: page
-title: refreshToken
+title: refreshToken | API | Core
 ---
 
 # refreshToken

diff --git a/doc/2/api/controllers/auth/search-api-keys/index.md b/doc/2/api/controllers/auth/search-api-keys/index.md
@@ -1,7 +1,7 @@
 ---
 code: true
 type: page
-title: searchApiKeys
+title: searchApiKeys | API | Core
 ---
 
 # searchApiKeys

diff --git a/doc/2/api/controllers/auth/update-my-credentials/index.md b/doc/2/api/controllers/auth/update-my-credentials/index.md
@@ -1,7 +1,7 @@
 ---
 code: true
 type: page
-title: updateMyCredentials
+title: updateMyCredentials | API | Core
 ---
 
 # updateMyCredentials

diff --git a/doc/2/api/controllers/auth/update-self/index.md b/doc/2/api/controllers/auth/update-self/index.md
@@ -1,7 +1,7 @@
 ---
 code: true
 type: page
-title: updateSelf
+title: updateSelf | API | Core
 ---
 
 # updateSelf

diff --git a/doc/2/api/controllers/auth/validate-my-credentials/index.md b/doc/2/api/controllers/auth/validate-my-credentials/index.md
@@ -1,7 +1,7 @@
 ---
 code: true
 type: page
-title: validateMyCredentials
+title: validateMyCredentials | API | Core
 ---
 
 # validateMyCredentials

diff --git a/doc/2/api/controllers/bulk/delete-by-query/index.md b/doc/2/api/controllers/bulk/delete-by-query/index.md
@@ -1,7 +1,7 @@
 ---
 code: true
 type: page
-title: deleteByQuery
+title: deleteByQuery | API | Core
 ---
 
 # deleteByQuery

diff --git a/doc/2/api/controllers/bulk/import/index.md b/doc/2/api/controllers/bulk/import/index.md
@@ -1,7 +1,7 @@
 ---
 code: true
 type: page
-title: import
+title: import | API | Core
 ---
 
 # import

diff --git a/doc/2/api/controllers/bulk/index.md b/doc/2/api/controllers/bulk/index.md
@@ -1,5 +1,5 @@
 ---
 type: branch
 code: true
-title: bulk
+title: bulk | API | Core
 ---
diff --git a/doc/2/api/controllers/bulk/m-write/index.md b/doc/2/api/controllers/bulk/m-write/index.md
@@ -1,7 +1,7 @@
 ---
 code: true
 type: page
-title: mWrite
+title: mWrite | API | Core
 ---
 
 # mWrite
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		../framework/src/.vuepress
		../framework/src/.vuepress