diff --git a/.travis.yml b/.travis.yml index 03d625456..689635470 100644 --- a/.travis.yml +++ b/.travis.yml @@ -119,20 +119,20 @@ jobs: CYPRESS_RETRIES=5 npm run test:e2e fi - # - stage: Tests - # name: Dead link check - # language: node_js - # node_js: 12 - # if: type = pull_request OR type = push AND branch =~ /^master|[0-9]+-(dev|stable|beta)$/ OR type = cron - - # before_script: - # - npm ci - # - npm run doc-prepare - # - $(npm bin)/kuzdoc iterate-repos:install --repos_path doc/framework/.repos/ - # - $(npm bin)/kuzdoc framework:link -d /sdk/js/7/ -v 7 - # script: - # - gem install typhoeus - # - cd doc/framework/ && HYDRA_MAX_CONCURRENCY=20 travis_retry ruby .ci/dead-links.rb -p src/sdk/js/7/ + - stage: Tests + name: Dead link check + language: node_js + node_js: 12 + if: type = pull_request OR type = push AND branch =~ /^master|[0-9]+-(dev|stable|beta)$/ OR type = cron + + before_script: + - npm ci + - npm run doc-prepare + - $(npm bin)/kuzdoc iterate-repos:install --repos_path doc/framework/.repos/ + - $(npm bin)/kuzdoc framework:link -d /sdk/js/7/ -v 7 + script: + - gem install typhoeus + - cd doc/framework/ && HYDRA_MAX_CONCURRENCY=20 travis_retry ruby .ci/dead-links.rb -p src/sdk/js/7/ - stage: Deployment Doc Dev name: Deploy next-docs.kuzzle.io diff --git a/doc/7/controllers/auth/login/index.md b/doc/7/controllers/auth/login/index.md index b3ceb10fd..3e29f6cb4 100644 --- a/doc/7/controllers/auth/login/index.md +++ b/doc/7/controllers/auth/login/index.md @@ -29,16 +29,16 @@ login(strategy, [credentials], [expiresIn]); ### strategy -The name of the [authentication strategy](/core/2/guides/kuzzle-depth/authentication) used to log the user in. +The name of the [authentication strategy](/core/2/guides/main-concepts/authentication#local-strategy) used to log the user in. Depending on the chosen authentication strategy, additional credential arguments may be required. The API request example in this page provides the necessary arguments for the [`local` authentication plugin](https://github.com/kuzzleio/kuzzle-plugin-auth-passport-local). -Check the appropriate [authentication plugin](/core/2/plugins/guides/strategies/overview) documentation to get the list of additional arguments to provide. +Check the appropriate [authentication plugin](/core/2/guides/write-plugins/integrate-authentication-strategy) documentation to get the list of additional arguments to provide. ### expiresIn - The default value for the `expiresIn` option is defined at server level, in Kuzzle's [configuration file](/core/2/guides/essentials/configuration). + The default value for the `expiresIn` option is defined at server level, in Kuzzle's [configuration file](/core/2/guides/advanced/configuration). ## Resolves diff --git a/doc/7/controllers/auth/refresh-token/index.md b/doc/7/controllers/auth/refresh-token/index.md index c97064b50..43a3d632e 100644 --- a/doc/7/controllers/auth/refresh-token/index.md +++ b/doc/7/controllers/auth/refresh-token/index.md @@ -40,7 +40,7 @@ Additional query options ### expiresIn -The default value for the `expiresIn` option is defined at server level, in Kuzzle's [configuration file](/core/2/guides/essentials/configuration). +The default value for the `expiresIn` option is defined at server level, in Kuzzle's [configuration file](/core/2/guides/advanced/configuration). ## Resolves @@ -48,7 +48,7 @@ The `refreshToken` action resolves to a token object with the following properti | Property | Type | Description | |--------------|---------|-------------| -| `_id` |
string
| User unique identifier ([kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid)) | +| `_id` |
string
| User unique identifier ([kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid)) | | `expiresAt` |
number
| Expiration timestamp in Epoch-millis format (UTC) | | `jwt` |
string
| Authentication token | | `ttl` |
number
| Time to live of the authentication token, in milliseconds | diff --git a/doc/7/controllers/bulk/delete-by-query/index.md b/doc/7/controllers/bulk/delete-by-query/index.md index 8a44b45a3..b3c8a5d4a 100644 --- a/doc/7/controllers/bulk/delete-by-query/index.md +++ b/doc/7/controllers/bulk/delete-by-query/index.md @@ -10,7 +10,7 @@ Deletes documents matching the provided search query. This is a low level route intended to bypass Kuzzle actions on document deletion, notably: - check document write limit - - trigger [realtime notifications](/core/2/guides/essentials/real-time) + - trigger [realtime notifications](/core/2/guides/main-concepts/realtime-engine) --- diff --git a/doc/7/controllers/bulk/mWrite/index.md b/doc/7/controllers/bulk/mWrite/index.md index d8c2a2344..6860365e2 100644 --- a/doc/7/controllers/bulk/mWrite/index.md +++ b/doc/7/controllers/bulk/mWrite/index.md @@ -14,9 +14,9 @@ description: Creates or replaces multiple documents directly into the storage en Creates or replaces multiple documents directly into the storage engine. This is a low level route intended to bypass Kuzzle actions on document creation, notably: - - check [document validity](/core/2/guides/essentials/data-validation), - - add [kuzzle metadata](/core/2/guides/essentials/document-metadata), - - trigger [realtime notifications](/core/2/guides/essentials/real-time) (unless asked otherwise) + - check [document validity](/core/2/guides/advanced/data-validation), + - add [kuzzle metadata](/core/2/guides/main-concepts/data-storage#kuzzle-metadata), + - trigger [realtime notifications](/core/2/guides/main-concepts/realtime-engine) (unless asked otherwise)
diff --git a/doc/7/controllers/bulk/write/index.md b/doc/7/controllers/bulk/write/index.md index e51071943..c89f5d3a9 100644 --- a/doc/7/controllers/bulk/write/index.md +++ b/doc/7/controllers/bulk/write/index.md @@ -14,9 +14,9 @@ description: Creates or replaces a document directly into the storage engine. Creates or replaces a document directly into the storage engine. This is a low level route intended to bypass Kuzzle actions on document creation, notably: - - check [document validity](/core/2/guides/essentials/data-validation), - - add [kuzzle metadata](/core/2/guides/essentials/document-metadata), - - trigger [realtime notifications](/core/2/guides/essentials/real-time) (unless asked otherwise). + - check [document validity](/core/2/guides/advanced/data-validation), + - add [kuzzle metadata](/core/2/guides/main-concepts/data-storage#kuzzle-metadata), + - trigger [realtime notifications](/core/2/guides/main-concepts/realtime-engine) (unless asked otherwise).
diff --git a/doc/7/controllers/collection/create/index.md b/doc/7/controllers/collection/create/index.md index 4346f2a6d..b9139db08 100644 --- a/doc/7/controllers/collection/create/index.md +++ b/doc/7/controllers/collection/create/index.md @@ -7,10 +7,10 @@ description: Create a new collection # create -Creates a new [collection](/core/2/guides/essentials/store-access-data) in the provided index. +Creates a new [collection](/core/2/guides/main-concepts/data-storage) in the provided index. You can also provide an optional data mapping that allow you to exploit the full capabilities of our -persistent data storage layer, [ElasticSearch](https://www.elastic.co/elastic-stack) (check here the [mapping capabilities of ElasticSearch](/core/2/guides/essentials/database-mappings/)). +persistent data storage layer, [ElasticSearch](https://www.elastic.co/elastic-stack) (check here the [mapping capabilities of ElasticSearch](/core/2/guides/main-concepts/data-storage)). This method will only update the mapping if the collection already exists. @@ -38,7 +38,7 @@ create(index, collection, [definition], [options]); ### definition An object containings: - - [collection mappings](/core/2/guides/essentials/database-mappings). + - [collection mappings](/core/2/guides/main-concepts/data-storage). - Elasticsearch [index settings](https://www.elastic.co/guide/en/elasticsearch/reference/7.5/index-modules.html#index-modules-settings) The mapping must have a root field `properties` that contain the mapping definition: @@ -84,7 +84,7 @@ const mappings = { }; ``` -More informations about database mappings [here](/core/2/guides/essentials/database-mappings). +More informations about database mappings [here](/core/2/guides/main-concepts/data-storage). diff --git a/doc/7/controllers/collection/get-mapping/index.md b/doc/7/controllers/collection/get-mapping/index.md index c01a9177e..aa59cf001 100644 --- a/doc/7/controllers/collection/get-mapping/index.md +++ b/doc/7/controllers/collection/get-mapping/index.md @@ -30,7 +30,7 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | ---------------------------------------------------------------------------- | | `queuable` |
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| `includeKuzzleMeta` |
boolean

(`true`) | If true, the returned mappings will contain [Kuzzle metadata](/core/2/guides/essentials/document-metadata/) | +| `includeKuzzleMeta` |
boolean

(`true`) | If true, the returned mappings will contain [Kuzzle metadata](/core/2/guides/main-concepts/data-storage#kuzzle-metadata) | ## Resolves diff --git a/doc/7/controllers/collection/update-mapping/index.md b/doc/7/controllers/collection/update-mapping/index.md index 343f955ea..7110089f9 100644 --- a/doc/7/controllers/collection/update-mapping/index.md +++ b/doc/7/controllers/collection/update-mapping/index.md @@ -12,9 +12,9 @@ description: Update the collection mapping __Use [collection:update](/sdk/js/7/controllers/collection/update/) instead.__ -You can define the collection [dynamic mapping policy](/core/2/guides/essentials/database-mappings#dynamic-mapping-policy) by setting the `dynamic` field to the desired value. +You can define the collection [dynamic mapping policy](/core/2/guides/main-concepts/data-storage#mappings-dynamic-policy) by setting the `dynamic` field to the desired value. -You can define [collection additional metadata](/core/2/guides/essentials/database-mappings#collection-metadata) within the `_meta` root field. +You can define [collection additional metadata](/core/2/guides/main-concepts/data-storage#mappings-metadata) within the `_meta` root field.
@@ -50,7 +50,7 @@ const mapping = { }; ``` -More informations about database mappings [here](/core/2/guides/essentials/database-mappings). +More informations about database mappings [here](/core/2/guides/main-concepts/data-storage). ### options diff --git a/doc/7/controllers/collection/update-specifications/index.md b/doc/7/controllers/collection/update-specifications/index.md index b7947f2d7..f108e45c9 100644 --- a/doc/7/controllers/collection/update-specifications/index.md +++ b/doc/7/controllers/collection/update-specifications/index.md @@ -30,7 +30,7 @@ updateSpecifications(index, collection, specifications, [options]); An object representing the specifications. -This object must follow the [Specification Structure](/core/2/guides/essentials/data-validation): +This object must follow the [Specification Structure](/core/2/guides/advanced/data-validation): ```js { diff --git a/doc/7/controllers/collection/update/index.md b/doc/7/controllers/collection/update/index.md index 39f3d23db..91be06b82 100644 --- a/doc/7/controllers/collection/update/index.md +++ b/doc/7/controllers/collection/update/index.md @@ -9,9 +9,9 @@ description: Update the collection mapping -You can define the collection [dynamic mapping policy](/core/2/guides/essentials/database-mappings#dynamic-mapping-policy) by setting the `dynamic` field to the desired value. +You can define the collection [dynamic mapping policy](/core/2/guides/main-concepts/data-storage#mappings-dynamic-policy) by setting the `dynamic` field to the desired value. -You can define [collection additional metadata](/core/2/guides/essentials/database-mappings#collection-metadata) within the `_meta` root field. +You can define [collection additional metadata](/core/2/guides/main-concepts/data-storage#mappings-metadata) within the `_meta` root field. @@ -38,7 +38,7 @@ update(index, collection, definition); ### definition An object containing: - - [collection mappings](/core/2/guides/essentials/database-mappings). + - [collection mappings](/core/2/guides/main-concepts/data-storage). - Elasticsearch [index settings](https://www.elastic.co/guide/en/elasticsearch/reference/7.5/index-modules.html#index-modules-settings) @@ -82,7 +82,7 @@ const mappings = { }; ``` -More informations about database mappings [here](/core/2/guides/essentials/database-mappings). +More informations about database mappings [here](/core/2/guides/main-concepts/data-storage). diff --git a/doc/7/controllers/collection/validate-specifications/index.md b/doc/7/controllers/collection/validate-specifications/index.md index f10474abe..0f32378a1 100644 --- a/doc/7/controllers/collection/validate-specifications/index.md +++ b/doc/7/controllers/collection/validate-specifications/index.md @@ -30,7 +30,7 @@ validateSpecifications(index, collection, specifications, [options]); An object representing the specifications. -This object must follow the [Specification Structure](/core/2/guides/cookbooks/datavalidation): +This object must follow the [Specification Structure](/core/2/guides/advanced/data-validation): ```js { diff --git a/doc/7/controllers/realtime/subscribe/index.md b/doc/7/controllers/realtime/subscribe/index.md index 0b83b2741..b67d549c6 100644 --- a/doc/7/controllers/realtime/subscribe/index.md +++ b/doc/7/controllers/realtime/subscribe/index.md @@ -7,7 +7,7 @@ description: Subscribe to real-time notifications # subscribe -Subscribes by providing a set of filters: messages, document changes and, optionally, user events matching the provided filters will generate [real-time notifications](/core/2/api/essentials/notifications), sent to you in real-time by Kuzzle. +Subscribes by providing a set of filters: messages, document changes and, optionally, user events matching the provided filters will generate [real-time notifications](/core/2/api/payloads/notifications), sent to you in real-time by Kuzzle.
@@ -21,7 +21,7 @@ subscribe(index, collection, filters, callback, [options]); | ------------ | ------------------- | ------------------------------------------------------------- | | `index` |
string
| Index name | | `collection` |
string
| Collection name | -| `filters` |
object
| Set of filters following [Koncorde syntax](/core/2/guides/cookbooks/realtime-api) | +| `filters` |
object
| Set of filters following [Koncorde syntax](/core/2/api/koncorde-filters-syntax) | | `callback` |
function
| Callback function to handle notifications | | `options` |
object
| Query options | @@ -39,7 +39,7 @@ Additional subscription options. | `scope` |
string

(`all`) | Subscribe to document entering or leaving the scope
Possible values: `all`, `in`, `out`, `none` | | `users` |
string

(`none`) | Subscribe to users entering or leaving the room
Possible values: `all`, `in`, `out`, `none` | | `subscribeToSelf` |
boolean

(`true`) | Subscribe to notifications fired by our own queries | -| `volatile` |
object

(`null`) | subscription information, used in [user join/leave notifications](/core/2/api/essentials/volatile-data) | +| `volatile` |
object

(`null`) | subscription information, used in [user join/leave notifications](/core/2/guides/main-concepts/api#volatile-data) | ## Resolves diff --git a/doc/7/controllers/security/create-api-key/index.md b/doc/7/controllers/security/create-api-key/index.md index ae4722cb0..75060c716 100644 --- a/doc/7/controllers/security/create-api-key/index.md +++ b/doc/7/controllers/security/create-api-key/index.md @@ -23,7 +23,7 @@ createApiKey(userId, description, [options]); | Property | Type | Description | | --- | --- | --- | -| `userId` |
string
| User [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid) | +| `userId` |
string
| User [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) | | `description` |
string
| API key description | | `options` |
object
| Additional options | diff --git a/doc/7/controllers/security/create-credentials/index.md b/doc/7/controllers/security/create-credentials/index.md index b7bef61e4..05bcbf901 100644 --- a/doc/7/controllers/security/create-credentials/index.md +++ b/doc/7/controllers/security/create-credentials/index.md @@ -20,7 +20,7 @@ createCredentials(strategy, kuid, credentials, [options]); | Property | Type | Description | | --- | --- | --- | | `strategy` |
string
| Strategy to use | -| `kuid` |
string
| User [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid) | +| `kuid` |
string
| User [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) | | `credentials` |
object
| New credentials | | `options` |
object
| Query options | diff --git a/doc/7/controllers/security/create-first-admin/index.md b/doc/7/controllers/security/create-first-admin/index.md index bdf66e7ae..e297538e8 100644 --- a/doc/7/controllers/security/create-first-admin/index.md +++ b/doc/7/controllers/security/create-first-admin/index.md @@ -19,7 +19,7 @@ createFirstAdmin(kuid, body, [options]); | Property | Type | Description | | --- | --- | --- | -| `kuid` |
string
| Administrator [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid) | +| `kuid` |
string
| Administrator [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) | | `body` |
object
| Administrator content & credentials | | `options` |
object
| Query options | diff --git a/doc/7/controllers/security/create-or-replace-profile/index.md b/doc/7/controllers/security/create-or-replace-profile/index.md index 44d577449..4fbcf1cd3 100644 --- a/doc/7/controllers/security/create-or-replace-profile/index.md +++ b/doc/7/controllers/security/create-or-replace-profile/index.md @@ -27,7 +27,7 @@ createOrReplaceProfile(id, body, [options]); | Property | Type | Description | | --- | --- | --- | -| `policies` |
object
| [Profile content](/core/2/guides/essentials/security#defining-profiles) | +| `policies` |
object
| [Profile content](/core/2/guides/main-concepts/permissions#profiles) | ### options diff --git a/doc/7/controllers/security/create-or-replace-role/index.md b/doc/7/controllers/security/create-or-replace-role/index.md index bf64d6c04..037a5709e 100644 --- a/doc/7/controllers/security/create-or-replace-role/index.md +++ b/doc/7/controllers/security/create-or-replace-role/index.md @@ -27,7 +27,7 @@ createOrReplaceRole(id, body, [options]); | Property | Type | Description | | --- | --- | --- | -| `controllers` |
object
| [Role definition](/core/2/guides/essentials/security#defining-roles) | +| `controllers` |
object
| [Role definition](/core/2/guides/main-concepts/permissions#roles) | ### options diff --git a/doc/7/controllers/security/create-profile/index.md b/doc/7/controllers/security/create-profile/index.md index 0dbb38180..2129ae5e2 100644 --- a/doc/7/controllers/security/create-profile/index.md +++ b/doc/7/controllers/security/create-profile/index.md @@ -20,7 +20,7 @@ createProfile(id, profile, [options]); | Property | Type | Description | |--- |--- |--- | | `id` |
string
| Profile identifier | -| `profile` |
object
| [Profile definition content](/core/2/guides/essentials/security#defining-profiles) | +| `profile` |
object
| [Profile definition content](/core/2/guides/main-concepts/permissions#profiles) | | `options` |
object
| Query options | ### options diff --git a/doc/7/controllers/security/create-restricted-user/index.md b/doc/7/controllers/security/create-restricted-user/index.md index 36fc030a2..55dddd391 100644 --- a/doc/7/controllers/security/create-restricted-user/index.md +++ b/doc/7/controllers/security/create-restricted-user/index.md @@ -10,7 +10,7 @@ description: Creates a new user in Kuzzle, with a preset list of security profil Creates a new user in Kuzzle, with a preset list of security profiles. The list of security profiles attributed to restricted users is fixed, and must be configured in the -[Kuzzle configuration file](/core/2/guides/essentials/configuration). +[Kuzzle configuration file](/core/2/guides/advanced/configuration). This method allows users with limited rights to create other accounts, but blocks them from creating accounts with unwanted privileges (e.g. an anonymous user creating his own account). @@ -25,7 +25,7 @@ createRestrictedUser(body, [kuid], [options]); | Property | Type | Description | |--- |--- |--- | | `body` |
object
| User content & credentials | -| `kuid` |
string
| User [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid). If not provided, a random kuid is automatically generated | +| `kuid` |
string
| User [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid). If not provided, a random kuid is automatically generated | | `options` |
object
| Query options | diff --git a/doc/7/controllers/security/create-role/index.md b/doc/7/controllers/security/create-role/index.md index ec6414b8a..93c99c35a 100644 --- a/doc/7/controllers/security/create-role/index.md +++ b/doc/7/controllers/security/create-role/index.md @@ -27,7 +27,7 @@ createRole(id, body, [options]); | Property | Type | Description | | --- | --- | --- | -| `controllers` |
object
| [Role definition](/core/2/guides/essentials/security#defining-roles) | +| `controllers` |
object
| [Role definition](/core/2/guides/main-concepts/permissions#roles) | ### options diff --git a/doc/7/controllers/security/create-user/index.md b/doc/7/controllers/security/create-user/index.md index 29424e1e8..601067e7e 100644 --- a/doc/7/controllers/security/create-user/index.md +++ b/doc/7/controllers/security/create-user/index.md @@ -19,7 +19,7 @@ createUser(kuid, body, [options]); | Property | Type | Description | |--- |--- |--- | -| `kuid` |
string
| User [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid) | +| `kuid` |
string
| User [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) | | `body` |
object
| User content & credentials | | `options` |
object
| Query options | diff --git a/doc/7/controllers/security/delete-api-key/index.md b/doc/7/controllers/security/delete-api-key/index.md index 003482cf6..9664e2b2e 100644 --- a/doc/7/controllers/security/delete-api-key/index.md +++ b/doc/7/controllers/security/delete-api-key/index.md @@ -23,7 +23,7 @@ deleteApiKey(userId, id, [options]); | Property | Type | Description | | --- | --- | --- | -| `userId` |
string
| User [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid) | +| `userId` |
string
| User [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) | | `id` |
string
| API key unique ID | | `options` |
object
| Additional options | diff --git a/doc/7/controllers/security/delete-credentials/index.md b/doc/7/controllers/security/delete-credentials/index.md index f3f85b54a..ffac9f9d1 100644 --- a/doc/7/controllers/security/delete-credentials/index.md +++ b/doc/7/controllers/security/delete-credentials/index.md @@ -20,7 +20,7 @@ deleteCredentials(strategy, kuid, [options]); | Property | Type | Description | | --- | --- | --- | | `strategy` |
string
| Strategy to use | -| `kuid` |
string
| User [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid) | +| `kuid` |
string
| User [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) | | `options` |
object
| Query options | ### options diff --git a/doc/7/controllers/security/delete-user/index.md b/doc/7/controllers/security/delete-user/index.md index fb0aa3728..a1bf0a4f1 100644 --- a/doc/7/controllers/security/delete-user/index.md +++ b/doc/7/controllers/security/delete-user/index.md @@ -19,7 +19,7 @@ deleteUser(kuid, [options]); | Property | Type | Description | | --- | --- | --- | -| `kuid` |
string
| User [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid) | +| `kuid` |
string
| User [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) | | `options` |
object
| Query options | ### options diff --git a/doc/7/controllers/security/get-credentials-by-id/index.md b/doc/7/controllers/security/get-credentials-by-id/index.md index 0896e1eea..cc10ce88a 100644 --- a/doc/7/controllers/security/get-credentials-by-id/index.md +++ b/doc/7/controllers/security/get-credentials-by-id/index.md @@ -9,10 +9,10 @@ description: Gets credential information for the user identified by the strategy Gets credential information for the user identified by the strategy's unique user identifier `userId`. -The returned object will vary depending on the strategy (see [getById plugin function](/core/2/plugins/guides/strategies#optional-getbyid)), and can be empty. +The returned object will vary depending on the strategy (see [getById plugin function](/core/2/guides/write-plugins/integrate-authentication-strategy#optional-getbyid)), and can be empty. **Note**: the user identifier to use depends on the specified strategy. -If you wish to get credential information using a [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid) identifier, use the [getCredentials](sdk/js/6/controllers/security/get-credentials) action instead. +If you wish to get credential information using a [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) identifier, use the [getCredentials](sdk/js/6/controllers/security/get-credentials) action instead.
@@ -25,7 +25,7 @@ getCredentialsById(strategy, id, [options]); | Property | Type | Description | | --- | --- | --- | | `strategy` |
string
| Strategy identifier | -| `id` |
string
| Credential identifier (this is **not** the [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid)) | +| `id` |
string
| Credential identifier (this is **not** the [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid)) | | `options` |
object
| Query options | ### options diff --git a/doc/7/controllers/security/get-credentials/index.md b/doc/7/controllers/security/get-credentials/index.md index 539f624b7..54c5b2fd4 100644 --- a/doc/7/controllers/security/get-credentials/index.md +++ b/doc/7/controllers/security/get-credentials/index.md @@ -20,7 +20,7 @@ getCredentials(strategy, kuid, [options]); | Property | Type | Description | | --- | --- | --- | | `strategy` |
string
| Strategy identifier | -| `kuid` |
string
| User [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid) | +| `kuid` |
string
| User [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) | | `options` |
object
| Query options | ### options diff --git a/doc/7/controllers/security/get-user-rights/index.md b/doc/7/controllers/security/get-user-rights/index.md index 5c9d6ce6d..052f294b6 100644 --- a/doc/7/controllers/security/get-user-rights/index.md +++ b/doc/7/controllers/security/get-user-rights/index.md @@ -19,7 +19,7 @@ getUserRights(kui, [options]); | Property | Type | Description | |--- |--- |--- | -| `kuid` |
string
| User [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid) | +| `kuid` |
string
| User [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) | | `options` |
object
| Query options | ### options diff --git a/doc/7/controllers/security/get-user/index.md b/doc/7/controllers/security/get-user/index.md index ffd97f152..545160489 100644 --- a/doc/7/controllers/security/get-user/index.md +++ b/doc/7/controllers/security/get-user/index.md @@ -19,7 +19,7 @@ getUser(kuid, [options]); | Property | Type | Description | |--- |--- |--- | -| `kuid` |
string
| User [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid) | +| `kuid` |
string
| User [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) | | `options` |
object
| Query options | ### options diff --git a/doc/7/controllers/security/has-credentials/index.md b/doc/7/controllers/security/has-credentials/index.md index 482abeb37..72cb74532 100644 --- a/doc/7/controllers/security/has-credentials/index.md +++ b/doc/7/controllers/security/has-credentials/index.md @@ -20,7 +20,7 @@ hasCredentials(strategy, kuid, [options]); | Property | Type | Description | |--- |--- |--- | | `strategy` |
string
| Strategy identifier | -| `kuid` |
string
| User [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid) | +| `kuid` |
string
| User [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) | | `options` |
object
| Query options | ### options diff --git a/doc/7/controllers/security/m-delete-users/index.md b/doc/7/controllers/security/m-delete-users/index.md index 8207c2eb2..a584780e9 100644 --- a/doc/7/controllers/security/m-delete-users/index.md +++ b/doc/7/controllers/security/m-delete-users/index.md @@ -21,7 +21,7 @@ mDeleteUsers(kuids, [options]); | Property | Type | Description | |--- |--- |--- | -| `kuids` |
array<string>
| Array of user [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid) | +| `kuids` |
array<string>
| Array of user [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) | | `options` |
object
| Query options | ### options diff --git a/doc/7/controllers/security/replace-user/index.md b/doc/7/controllers/security/replace-user/index.md index ebf4d16ee..4bd8a4180 100644 --- a/doc/7/controllers/security/replace-user/index.md +++ b/doc/7/controllers/security/replace-user/index.md @@ -19,7 +19,7 @@ replaceUser(kuid, body, [options]); | Property | Type | Description | |--- |--- |--- | -| `kuid` |
string
| User [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid) | +| `kuid` |
string
| User [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) | | `body` |
object
| User content | | `options` |
object
| Query options | diff --git a/doc/7/controllers/security/update-credentials/index.md b/doc/7/controllers/security/update-credentials/index.md index 5e6e1aba7..ceb56cef7 100644 --- a/doc/7/controllers/security/update-credentials/index.md +++ b/doc/7/controllers/security/update-credentials/index.md @@ -20,7 +20,7 @@ updateCredentials(strategy, kuid, credentials, [options]); | Property | Type | Description | | --- | --- | --- | | `strategy` |
string
| Strategy to use | -| `kuid` |
string
| User [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid) | +| `kuid` |
string
| User [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) | | `credentials` |
object
| New credentials | | `options` |
object
| Query options | diff --git a/doc/7/controllers/security/update-profile-mapping/index.md b/doc/7/controllers/security/update-profile-mapping/index.md index beac6c4d9..290080f0c 100644 --- a/doc/7/controllers/security/update-profile-mapping/index.md +++ b/doc/7/controllers/security/update-profile-mapping/index.md @@ -19,7 +19,7 @@ updateProfileMapping(mapping, [options]); | Property | Type | Description | |--- |--- |--- | -| `mapping` |
object
| Profile collection [mapping definition](/core/2/guides/essentials/database-mappings) | +| `mapping` |
object
| Profile collection [mapping definition](/core/2/guides/main-concepts/data-storage) | | `options` |
object
| Query options | ### options diff --git a/doc/7/controllers/security/update-profile/index.md b/doc/7/controllers/security/update-profile/index.md index 2e7fb5a15..a314cd334 100644 --- a/doc/7/controllers/security/update-profile/index.md +++ b/doc/7/controllers/security/update-profile/index.md @@ -20,7 +20,7 @@ updateProfile(id, profile, [options]); | Property | Type | Description | |--- |--- |--- | | `id` |
string
| Profile identifier | -| `profile` |
object
| [Profile definition content](/core/2/guides/essentials/security#defining-profiles) | +| `profile` |
object
| [Profile definition content](/core/2/guides/main-concepts/permissions#profiles) | | `options` |
object
| Query options | ### options diff --git a/doc/7/controllers/security/update-role-mapping/index.md b/doc/7/controllers/security/update-role-mapping/index.md index fe2db68ce..1ba7e49e0 100644 --- a/doc/7/controllers/security/update-role-mapping/index.md +++ b/doc/7/controllers/security/update-role-mapping/index.md @@ -19,7 +19,7 @@ updateRoleMapping(mapping, [options]); | Property | Type | Description | |--- |--- |--- | -| `mapping` |
object
| Role collection [mapping definition](/core/2/guides/essentials/database-mappings) | +| `mapping` |
object
| Role collection [mapping definition](/core/2/guides/main-concepts/data-storage) | | `options` |
object
| Query options | ### options diff --git a/doc/7/controllers/security/update-role/index.md b/doc/7/controllers/security/update-role/index.md index 78aaddf90..d13ffcb2e 100644 --- a/doc/7/controllers/security/update-role/index.md +++ b/doc/7/controllers/security/update-role/index.md @@ -29,7 +29,7 @@ updateRole(id, body, [options]); | Property | Type | Description | | --- | --- | --- | -| `controllers` |
object
| [Role definition](/core/2/guides/essentials/security#defining-roles) | +| `controllers` |
object
| [Role definition](/core/2/guides/main-concepts/permissions#roles) | ### options diff --git a/doc/7/controllers/security/update-user-mapping/index.md b/doc/7/controllers/security/update-user-mapping/index.md index 1372d2c9b..5504daff5 100644 --- a/doc/7/controllers/security/update-user-mapping/index.md +++ b/doc/7/controllers/security/update-user-mapping/index.md @@ -19,7 +19,7 @@ updateUserMapping(mapping, [options]); | Property | Type | Description | |--- |--- |--- | -| `mapping` |
object
| User collection [mapping definition](/core/2/guides/essentials/database-mappings) | +| `mapping` |
object
| User collection [mapping definition](/core/2/guides/main-concepts/data-storage) | | `options` |
object
| Query options | ### options diff --git a/doc/7/controllers/security/update-user/index.md b/doc/7/controllers/security/update-user/index.md index cb421d01b..d88df2e52 100644 --- a/doc/7/controllers/security/update-user/index.md +++ b/doc/7/controllers/security/update-user/index.md @@ -19,7 +19,7 @@ updateUser(kuid, body, [options]); | Property | Type | Description | |--- |--- |--- | -| `kuid` |
string
| User [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid) | +| `kuid` |
string
| User [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) | | `body` |
object
| User content | | `options` |
object
| Query options | diff --git a/doc/7/controllers/security/validate-credentials/index.md b/doc/7/controllers/security/validate-credentials/index.md index aac0b8834..d677e8a3b 100644 --- a/doc/7/controllers/security/validate-credentials/index.md +++ b/doc/7/controllers/security/validate-credentials/index.md @@ -20,7 +20,7 @@ validateCredentials(strategy, kuid, credentials, [options]); | Property | Type | Description | |--- |--- |--- | | `strategy` |
string
| Strategy identifier | -| `kuid` |
string
| User [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid) | +| `kuid` |
string
| User [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) | | `credentials` |
object
| New credentials | | `options` |
object
| Query options | diff --git a/doc/7/core-classes/base-controller/query/index.md b/doc/7/core-classes/base-controller/query/index.md index 21b4cf88c..9b5769b1e 100644 --- a/doc/7/core-classes/base-controller/query/index.md +++ b/doc/7/core-classes/base-controller/query/index.md @@ -7,7 +7,7 @@ description: Wrapper around the Kuzzle.query method # query -Base method used to send queries to a Kuzzle controller, following the [API Documentation](/core/2/api/essentials/connecting-to-kuzzle). +Base method used to send queries to a Kuzzle controller, following the [API Documentation](/core/2/api). This method injects the controller name into the the request and forwards it to the original [Kuzzle.query](/sdk/js/7/core-classes/kuzzle/query) method. @@ -52,4 +52,4 @@ Additional query options ## Resolves -Resolve to the raw Kuzzle API response. See the [API Documentation](/core/2/api/essentials/connecting-to-kuzzle). \ No newline at end of file +Resolve to the raw Kuzzle API response. See the [API Documentation](/core/2/api). \ No newline at end of file diff --git a/doc/7/core-classes/kuzzle-error/introduction/index.md b/doc/7/core-classes/kuzzle-error/introduction/index.md index 9ec909920..10e2dc44e 100644 --- a/doc/7/core-classes/kuzzle-error/introduction/index.md +++ b/doc/7/core-classes/kuzzle-error/introduction/index.md @@ -10,4 +10,4 @@ order: 0 Inherits from the standard `Error` class. -The KuzzleError class represents an [error response from Kuzzle API](/core/2/api/essentials/error-handling). +The KuzzleError class represents an [error response from Kuzzle API](/core/2/api/payloads/error). diff --git a/doc/7/core-classes/kuzzle/introduction/index.md b/doc/7/core-classes/kuzzle/introduction/index.md index 4900118bc..f6c0436fd 100644 --- a/doc/7/core-classes/kuzzle/introduction/index.md +++ b/doc/7/core-classes/kuzzle/introduction/index.md @@ -31,6 +31,6 @@ The following protocols are available in the SDK: ## Volatile data -You can tell the Kuzzle SDK to attach a set of "volatile" data to each request. You can set it as an object contained in the `volatile` field of the Kuzzle constructor. The response to a request containing volatile data will contain the same data in its `volatile` field. This can be useful, for example, in real-time notifications for [user join/leave notifications](/core/2/api/essentials/volatile-data) to provide additional informations about the client who sent the request. +You can tell the Kuzzle SDK to attach a set of "volatile" data to each request. You can set it as an object contained in the `volatile` field of the Kuzzle constructor. The response to a request containing volatile data will contain the same data in its `volatile` field. This can be useful, for example, in real-time notifications for [user join/leave notifications](/core/2/guides/main-concepts/api#volatile-data) to provide additional informations about the client who sent the request. Note that you can also set volatile data on a per-request basis (on requests that accept a `volatile` field in their `options` argument). In this case, per-request volatile data will be merged with the global `volatile` object set in the constructor. Per-request fields will override global ones. diff --git a/doc/7/core-classes/kuzzle/properties/index.md b/doc/7/core-classes/kuzzle/properties/index.md index f93acc87d..6e17e1451 100644 --- a/doc/7/core-classes/kuzzle/properties/index.md +++ b/doc/7/core-classes/kuzzle/properties/index.md @@ -51,7 +51,7 @@ The returned (or resolved) array must contain objects, each with the following p | Property | Type | Description | |---|---|---| -| `query` |
object
| Object representing the request that is about to be sent to Kuzzle, following the [Kuzzle API](/core/2/api/essentials/query-syntax) format | +| `query` |
object
| Object representing the request that is about to be sent to Kuzzle, following the [Kuzzle API](/core/2/guides/main-concepts/querying) format | | `reject` |
function
| A [Promise.reject](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/reject) function | | `resolve` |
function
| A [Promise.resolve](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/resolve) function | @@ -63,7 +63,7 @@ The `queueFilter` property must be set with a function of the following form: boolean queueFilter(request) ``` -The `request` argument is an object representing the request that is about to be sent to Kuzzle, following the [Kuzzle API](/core/2/api/essentials/query-syntax) format. +The `request` argument is an object representing the request that is about to be sent to Kuzzle, following the [Kuzzle API](/core/2/guides/main-concepts/querying) format. ### queueMaxSize diff --git a/doc/7/core-classes/profile/introduction/index.md b/doc/7/core-classes/profile/introduction/index.md index ad1ceaf9b..5a65323f6 100644 --- a/doc/7/core-classes/profile/introduction/index.md +++ b/doc/7/core-classes/profile/introduction/index.md @@ -10,4 +10,4 @@ order: 0 This class represents a Kuzzle Profile. -Refer to the [Security guide](/core/2/guides/essentials/security#defining-profiles) for more information about profiles. +Refer to the [Security guide](/core/2/guides/main-concepts/permissions#profiles) for more information about profiles. diff --git a/doc/7/core-classes/role/introduction/index.md b/doc/7/core-classes/role/introduction/index.md index 2dc8bf95b..9b6a079f0 100644 --- a/doc/7/core-classes/role/introduction/index.md +++ b/doc/7/core-classes/role/introduction/index.md @@ -10,4 +10,4 @@ order: 0 This class represents a Kuzzle Role. -Refer to the [Security guide](/core/2/guides/essentials/security#defining-roles) for more information about roles. \ No newline at end of file +Refer to the [Security guide](/core/2/guides/main-concepts/permissions#roles) for more information about roles. \ No newline at end of file diff --git a/doc/7/core-classes/user/introduction/index.md b/doc/7/core-classes/user/introduction/index.md index bf12cfe08..e2a2d3978 100644 --- a/doc/7/core-classes/user/introduction/index.md +++ b/doc/7/core-classes/user/introduction/index.md @@ -10,7 +10,7 @@ order: 0 This class represents a Kuzzle User. -Refer to the [Security guide](/core/2/guides/essentials/security) for more information about users. +Refer to the [Security guide](/core/2/guides/main-concepts/permissions) for more information about users. The following methods return a `User` object: diff --git a/doc/7/core-classes/user/properties/index.md b/doc/7/core-classes/user/properties/index.md index a5895d350..10f509314 100644 --- a/doc/7/core-classes/user/properties/index.md +++ b/doc/7/core-classes/user/properties/index.md @@ -21,4 +21,4 @@ The `content` property is an object containing, alongside custom defined values, | Property | Type | Description | |--- |--- |--- | | `profileIds` |
string[]
| Profiles IDs for this user | -| `_kuzzle_info` |
object
| [Kuzzle metadata](/core/2/guides/essentials/document-metadata) | +| `_kuzzle_info` |
object
| [Kuzzle metadata](/core/2/guides/main-concepts/data-storage#kuzzle-metadata) | diff --git a/doc/7/essentials/error-handling/index.md b/doc/7/essentials/error-handling/index.md index fa56caac4..09fd31cf4 100644 --- a/doc/7/essentials/error-handling/index.md +++ b/doc/7/essentials/error-handling/index.md @@ -19,7 +19,7 @@ All SDK methods return a promise, that can be rejected with a `KuzzleError` valu | `code` |
string
| Error unique code | -You can find a detailed list of possible errors messages and statuses in the [documentation API](/core/2/api/essentials/error-handling). +You can find a detailed list of possible errors messages and statuses in the [documentation API](/core/2/api/errors/types). #### Example with a promise chain diff --git a/doc/7/essentials/events/index.md b/doc/7/essentials/events/index.md index d5fe554df..3976b8b6a 100644 --- a/doc/7/essentials/events/index.md +++ b/doc/7/essentials/events/index.md @@ -26,7 +26,7 @@ Triggered when Kuzzle discards a request, typically if no connection is establis **Callback arguments:** -`@param {object} request`: the discarded [request](/core/2/api/essentials/query-syntax) +`@param {object} request`: the discarded [request](/core/2/guides/main-concepts/querying) ## disconnected @@ -65,7 +65,7 @@ Triggered whenever a request is removed from the offline queue. **Callback arguments:** -`@param {object} request`: the [request](/core/2/api/essentials/query-syntax) removed from the queue +`@param {object} request`: the [request](/core/2/guides/main-concepts/querying) removed from the queue ## offlineQueuePush @@ -77,7 +77,7 @@ Triggered whenever a request is added to the offline queue. | Property | Type | Description | | --------- | ----------------- | ------------------------------------------------------------------ | -| `request` |
object
| [Request](/core/2/api/essentials/query-syntax) added to the queue | +| `request` |
object
| [Request](/core/2/guides/main-concepts/querying) added to the queue | ## queryError diff --git a/doc/7/essentials/extend-sdk/index.md b/doc/7/essentials/extend-sdk/index.md index d32773605..2c68f585c 100644 --- a/doc/7/essentials/extend-sdk/index.md +++ b/doc/7/essentials/extend-sdk/index.md @@ -12,7 +12,7 @@ order: 410 It is possible to extend the SDK's API by adding new controllers. -These controllers correspond to [custom controllers created in a plugin](/core/2/plugins/guides/controllers). Thus, it is possible to use the actions of a core plugin in the SDK in the same way as the other actions of the Kuzzle API. +These controllers correspond to [custom controllers created in a plugin](/core/2/guides/write-plugins/old-guides/controllers). Thus, it is possible to use the actions of a core plugin in the SDK in the same way as the other actions of the Kuzzle API. ## Define a custom SDK controller @@ -36,7 +36,7 @@ this.controllers = { } ``` -Then the constructor of the custom SDK controller must specify its name as follows (see [how to query a custom API route](/core/2/plugins/guides/controllers#querying-plugins-controllers) documentation): +Then the constructor of the custom SDK controller must specify its name as follows (see [how to query a custom API route](/core/2/guides/write-plugins/old-guides/controllers#querying-plugins-controllers) documentation): ```js const { BaseController } = require('kuzzle-sdk'); diff --git a/doc/7/essentials/realtime-notifications/index.md b/doc/7/essentials/realtime-notifications/index.md index 86583db0d..3bcf55608 100644 --- a/doc/7/essentials/realtime-notifications/index.md +++ b/doc/7/essentials/realtime-notifications/index.md @@ -12,7 +12,7 @@ The [realtime.subscribe](/sdk/js/7/controllers/realtime) method takes a callback ## Document & messages -These notifications represent [documents changes & messages](/core/2/api/essentials/notifications#documents-changes-messages). +These notifications represent [documents changes & messages](/core/2/api/payloads/notifications#document-notification). | Property | Type | Description | | ------------ | ----------------- | ----------------------------------------------------------------------------------------------------- | @@ -26,7 +26,7 @@ These notifications represent [documents changes & messages](/core/2/api/essenti | `scope` |
string
| `in`: document enters (or stays) in the scope
`out`: document leaves the scope | | `timestamp` |
number
| Timestamp of the event, in Epoch-millis format | | `type` |
string
| `document`: Notification type | -| `volatile` |
object
| Request [volatile data](/core/2/api/essentials/volatile-data) | +| `volatile` |
object
| Request [volatile data](/core/2/guides/main-concepts/api#volatile-data) | The `result` object is the notification content, and it has the following structure: @@ -37,7 +37,7 @@ The `result` object is the notification content, and it has the following struct ## User -These notifications represent [user events](/core/2/api/essentials/notifications#user-notification). +These notifications represent [user events](/core/2/api/payloads/notifications#user-notification). | Property | Type | Description | | ------------ | ----------------- | ----------------------------------------------------------------------------------------------------- | @@ -51,7 +51,7 @@ These notifications represent [user events](/core/2/api/essentials/notifications | `timestamp` |
number
| Timestamp of the event, in Epoch-millis format | | `type` |
string
| `user`: Notification type | | `user` |
string
| `in`: a new user has subscribed to the same filters
`out`: a user cancelled a shared subscription | -| `volatile` |
object
| Request [volatile data](/core/2/api/essentials/volatile-data) | +| `volatile` |
object
| Request [volatile data](/core/2/guides/main-concepts/api#volatile-data) | The `result` object is the notification content, and it has the following structure: @@ -61,7 +61,7 @@ The `result` object is the notification content, and it has the following struct ## Server -These notifications represent [server events](/core/2/api/essentials/notifications#server-notification). +These notifications represent [server events](/core/2/api/payloads/notifications#server-notification). | Property | Type | Value | | --------- | ----------------- | ------------------------------------------------------------------ | diff --git a/doc/7/getting-started/node-js/index.md b/doc/7/getting-started/node-js/index.md index ac0350c1f..4a535ba6f 100644 --- a/doc/7/getting-started/node-js/index.md +++ b/doc/7/getting-started/node-js/index.md @@ -13,7 +13,7 @@ It will walk you through creating scripts that can **store** documents in Kuzzle You are going to write an application that **stores** documents in Kuzzle Server and subscribe to **real time notifications** for each created document. -To follow this tutorial, you must have a Kuzzle Server up and running. Follow these instructions if this is not already the case: [Running Kuzzle](/core/2/guides/getting-started/running-kuzzle). +To follow this tutorial, you must have a Kuzzle Server up and running. Follow these instructions if this is not already the case: [Running Kuzzle](/core/2/guides/getting-started/run-kuzzle). :::info @@ -136,7 +136,7 @@ Now in another terminal, launch the `create.js` file from the previous section. node create.js ``` -This creates a new document in Kuzzle which, in turn, triggers a [document notification](/core/2/api/essentials/notifications#documents-changes-messages) sent to the `subscribe.js` program. +This creates a new document in Kuzzle which, in turn, triggers a [document notification](/core/2/api/payloads/notifications#document-notification) sent to the `subscribe.js` program. Check the `subscribe.js` terminal: a new message is printed everytime a document is created using the `create.js` code. ```bash @@ -152,6 +152,6 @@ Congratulations! You have just set up your first pub/sub communication! Now that you're more familiar with Kuzzle, dive even deeper to learn how to leverage its full capabilities: - discover what this SDK has to offer by browsing other sections of this documentation -- learn how to use [Koncorde](/core/2/guides/cookbooks/realtime-api) to create incredibly fine-grained and blazing-fast subscriptions +- learn how to use [Koncorde](/core/2/api/koncorde-filters-syntax) to create incredibly fine-grained and blazing-fast subscriptions - learn how to perform a [basic authentication](/sdk/js/7/controllers/auth/login) -- follow our guide to learn how to [manage users, and how to set up fine-grained access control](/core/2/guides/essentials/security) +- follow our guide to learn how to [manage users, and how to set up fine-grained access control](/core/2/guides/main-concepts/permissions) diff --git a/doc/7/getting-started/raw-web/index.md b/doc/7/getting-started/raw-web/index.md index bd39ab8e4..371819a4c 100644 --- a/doc/7/getting-started/raw-web/index.md +++ b/doc/7/getting-started/raw-web/index.md @@ -10,7 +10,7 @@ order: 100 This tutorial explains how to use **Kuzzle** with the **Javascript SDK** in a **browser**. -To follow this tutorial, you must have a Kuzzle Server up and running (you'll need to know the hostname of the machine running it). If this is not already the case, take a look at [how to run Kuzzle](/core/2/guides/getting-started/running-kuzzle). +To follow this tutorial, you must have a Kuzzle Server up and running (you'll need to know the hostname of the machine running it). If this is not already the case, take a look at [how to run Kuzzle](/core/2/guides/getting-started/run-kuzzle). Before proceeding, make sure your system has **Node.js** version 8 or higher ([download page](https://nodejs.org/en/download/)) installed. @@ -124,7 +124,7 @@ New document successfully created! ``` :::success -You have now successfully stored your first document into Kuzzle. Check our [Admin Console Guide](/core/2/guides/essentials/admin-console) to see how to browse your collection and confirm that your document was saved. +You have now successfully stored your first document into Kuzzle. Check our [Admin Console Guide](http://next-console.kuzzle.io) to see how to browse your collection and confirm that your document was saved. ::: @@ -148,7 +148,7 @@ The code in the `subscribe.html` page is now running endlessly, waiting for noti Now go back to the other tab and reload `create.html`. -This creates a new document in Kuzzle which, in turn, triggers a [document notification](/core/2/api/essentials/notifications#documents-changes-messages) sent to the `subscribe.html` tab. Check the `subscribe.html` tab: a new message is printed everytime a document is created using the `create.html` code. +This creates a new document in Kuzzle which, in turn, triggers a [document notification](/core/2/api/payloads/notifications#document-notification) sent to the `subscribe.html` tab. Check the `subscribe.html` tab: a new message is printed everytime a document is created using the `create.html` code. ``` New driver Sirkis with id AWccRe3-DfukVhSzMdUo has B license. @@ -163,6 +163,6 @@ Congratulations! You have just set up your first pub/sub communication! Now that you're more familiar with Kuzzle, dive even deeper to learn how to leverage its full capabilities: - discover what this SDK has to offer by browsing other sections of this documentation -- learn how to use [Koncorde](/core/2/guides/cookbooks/realtime-api) to create incredibly fine-grained and blazing-fast subscriptions +- learn how to use [Koncorde](/core/2/api/koncorde-filters-syntax) to create incredibly fine-grained and blazing-fast subscriptions - learn how to perform a [basic authentication](/sdk/js/7/controllers/auth/login) -- follow our guide to learn how to [manage users, and how to set up fine-grained access control](/core/2/guides/essentials/security) +- follow our guide to learn how to [manage users, and how to set up fine-grained access control](/core/2/guides/main-concepts/permissions) diff --git a/doc/7/getting-started/react-native/index.md b/doc/7/getting-started/react-native/index.md index 0bf8809c2..dde41aeae 100644 --- a/doc/7/getting-started/react-native/index.md +++ b/doc/7/getting-started/react-native/index.md @@ -15,7 +15,7 @@ This section deals with **Kuzzle V2** (+ **Javascript SDK 7**) and **React Nativ ## Requirements - **Node.js** >= 12.0.0 ([install here](https://nodejs.org/en/download/)) -- **Running Kuzzle V2 Stack** ([instructions here](/core/2/guides/getting-started/running-kuzzle)) +- **Running Kuzzle V2 Stack** ([instructions here](/core/2/guides/getting-started/run-kuzzle)) - **Expo CLI** ([install here](https://docs.expo.io/get-started/installation)) "[Expo](https://docs.expo.io/versions/latest/) is a framework and a platform for universal React applications. It is a set of tools and services built around React Native and native platforms that help you develop, build, deploy, and quickly iterate on iOS, Android, and web apps from the same JavaScript/TypeScript codebase." @@ -196,7 +196,7 @@ You can now add new messages to Kuzzle and receive the creation notification to Now that you're more familiar with Kuzzle, dive even deeper to learn how to leverage its full capabilities: - discover what this SDK has to offer by browsing other sections of this documentation -- learn more about Kuzzle [realtime engine](/core/2/guides/essentials/real-time) -- follow our guide to learn how to [manage users, and how to set up fine-grained access control](/core/2/guides/essentials/security) -- lean how to use Kuzzle [Admin Console](/core/2/guides/essentials/admin-console) to manage your users and data +- learn more about Kuzzle [realtime engine](/core/2/guides/main-concepts/realtime-engine) +- follow our guide to learn how to [manage users, and how to set up fine-grained access control](/core/2/guides/main-concepts/permissions) +- lean how to use Kuzzle [Admin Console](http://next-console.kuzzle.io) to manage your users and data - learn how to perform a [basic authentication](/sdk/js/7/controllers/auth/login) diff --git a/doc/7/getting-started/react/standalone/index.md b/doc/7/getting-started/react/standalone/index.md index 4812366f3..2e37264bc 100644 --- a/doc/7/getting-started/react/standalone/index.md +++ b/doc/7/getting-started/react/standalone/index.md @@ -15,7 +15,7 @@ This tutorial will help you get started with **Kuzzle V2** (+ **Javascript SDK 7 - **Node.js** >= 12.0.0 ([install here](https://nodejs.org/en/download/)) - **Create React App** ([install here](https://github.com/facebook/create-react-app)) -- **Running Kuzzle V2 Stack** ([instructions here](/core/2/guides/getting-started/running-kuzzle)) +- **Running Kuzzle V2 Stack** ([instructions here](/core/2/guides/getting-started/run-kuzzle)) ## Prepare your environment @@ -116,7 +116,7 @@ You can now send new messages to Kuzzle and receive the notifications of message Now that you are more familiar with Kuzzle, dive even deeper to learn how to leverage its full capabilities: - Discover what this SDK has to offer by browsing other sections of this documentation -- Learn more about Kuzzle [realtime engine](/core/2/guides/essentials/real-time) -- Lean how to use Kuzzle [Admin Console](/core/2/guides/essentials/admin-console) to manage your users and data -- Learn how to use [Koncorde](/core/2/guides/cookbooks/realtime-api/introduction) to create incredibly fine-grained and blazing-fast subscriptions -- Follow our guide to learn how to [manage users, and how to set up fine-grained access control](/core/2/guides/essentials/security) +- Learn more about Kuzzle [realtime engine](/core/2/guides/main-concepts/realtime-engine) +- Lean how to use Kuzzle [Admin Console](http://next-console.kuzzle.io) to manage your users and data +- Learn how to use [Koncorde](/core/2/api/koncorde-filters-syntax) to create incredibly fine-grained and blazing-fast subscriptions +- Follow our guide to learn how to [manage users, and how to set up fine-grained access control](/core/2/guides/main-concepts/permissions) diff --git a/doc/7/getting-started/react/with-redux/index.md b/doc/7/getting-started/react/with-redux/index.md index 58a92bb62..83a3b923a 100644 --- a/doc/7/getting-started/react/with-redux/index.md +++ b/doc/7/getting-started/react/with-redux/index.md @@ -15,7 +15,7 @@ This section deals with **Kuzzle V2** (+ **Javascript SDK 7**) and **React** (wi - **Node.js** >= 8.0.0 ([install here](https://nodejs.org/en/download/)) - **Create React App** ([install here](https://github.com/facebook/create-react-app)) -- **Running Kuzzle V2 Stack** ([instructions here](/core/2/guides/getting-started/running-kuzzle)) +- **Running Kuzzle V2 Stack** ([instructions here](/core/2/guides/getting-started/run-kuzzle)) ## Prepare your environment @@ -164,6 +164,6 @@ You can now add new messages to Kuzzle and receive the notification of the creat Now that you're more familiar with Kuzzle with React, you can: - discover what this SDK has to offer by browsing other sections of this documentation -- learn how to use [Koncorde](/core/2/guides/cookbooks/realtime-api/introduction) to create incredibly fine-grained and blazing-fast subscriptions -- learn more about Kuzzle [realtime engine](/core/2/guides/essentials/real-time) -- follow our guide to learn how to [manage users, and how to set up fine-grained access control](/core/2/guides/essentials/security) +- learn how to use [Koncorde](/core/2/api/koncorde-filters-syntax) to create incredibly fine-grained and blazing-fast subscriptions +- learn more about Kuzzle [realtime engine](/core/2/guides/main-concepts/realtime-engine) +- follow our guide to learn how to [manage users, and how to set up fine-grained access control](/core/2/guides/main-concepts/permissions) diff --git a/doc/7/getting-started/vuejs/standalone/index.md b/doc/7/getting-started/vuejs/standalone/index.md index 2d289b8da..1745a4997 100644 --- a/doc/7/getting-started/vuejs/standalone/index.md +++ b/doc/7/getting-started/vuejs/standalone/index.md @@ -16,7 +16,7 @@ This section deals with **Kuzzle V2** (+ **Javascript SDK 7**) and **VueJS**. We - **Node.js** >= 8.0.0 ([install here](https://nodejs.org/en/download/)) - **Vue CLI** ([install here](https://cli.vuejs.org/guide/installation.html)) -- **Running Kuzzle V2 Stack** ([instructions here](/core/2/guides/getting-started/running-kuzzle)) +- **Running Kuzzle V2 Stack** ([instructions here](/core/2/guides/getting-started/run-kuzzle)) ## Prepare your environment @@ -115,7 +115,7 @@ You can now add new messages to Kuzzle and receive the creation notification to Now that you're more familiar with Kuzzle, dive even deeper to learn how to leverage its full capabilities: - discover what this SDK has to offer by browsing other sections of this documentation -- learn more about Kuzzle [realtime engine](/core/2/guides/essentials/real-time) -- follow our guide to learn how to [manage users, and how to set up fine-grained access control](/core/2/guides/essentials/security) -- lean how to use Kuzzle [Admin Console](/core/2/guides/essentials/admin-console) to manage your users and data +- learn more about Kuzzle [realtime engine](/core/2/guides/main-concepts/realtime-engine) +- follow our guide to learn how to [manage users, and how to set up fine-grained access control](/core/2/guides/main-concepts/permissions) +- lean how to use Kuzzle [Admin Console](http://next-console.kuzzle.io) to manage your users and data - learn how to perform a [basic authentication](/sdk/js/7/controllers/auth/login) diff --git a/doc/7/getting-started/webpack/index.md b/doc/7/getting-started/webpack/index.md index f97e10cbf..5bfb97876 100644 --- a/doc/7/getting-started/webpack/index.md +++ b/doc/7/getting-started/webpack/index.md @@ -17,7 +17,7 @@ Having trouble? Get in touch with us on [Discord](http://join.discord.kuzzle.io) ## Running Kuzzle -Before going through this tutorial, you should have a Kuzzle server running. Please refer to the [Running Kuzzle Tutorial](/core/2/guides/getting-started/running-kuzzle) if you don't have one yet. +Before going through this tutorial, you should have a Kuzzle server running. Please refer to the [Running Kuzzle Tutorial](/core/2/guides/getting-started/run-kuzzle) if you don't have one yet. ## Fun with the SDK @@ -152,7 +152,7 @@ New document successfully created! ::: success You have now successfully stored your first document into Kuzzle. Click -[here](/core/2/guides/essentials/admin-console) to see how you can use the +[here](http://next-console.kuzzle.io) to see how you can use the [**Kuzzle Admin Console**](http://console.kuzzle.io) to browse your collection and confirm that your document was saved. ::: @@ -207,6 +207,6 @@ Having trouble? Get in touch with us on [Discord!](http://join.discord.kuzzle.io Now that you're more familiar with Kuzzle, dive even deeper to learn how to leverage its full capabilities: - take a look at the [SDK Reference](/sdk/js/7) -- learn how to use [Koncorde](/core/2/guides/cookbooks/realtime-api) to create incredibly fine-grained and blazing-fast subscriptions -- follow our guide to learn how to implement [basic authentication](/core/2/guides/essentials/user-authentication#local-strategy) -- follow our guide to learn how to implement [manage users and setup fine-grained access control](/core/2/guides/essentials/security) +- learn how to use [Koncorde](/core/2/api/koncorde-filters-syntax) to create incredibly fine-grained and blazing-fast subscriptions +- follow our guide to learn how to implement [basic authentication](/core/2/guides/main-concepts/authentication#local-strategy) +- follow our guide to learn how to implement [manage users and setup fine-grained access control](/core/2/guides/main-concepts/permissions) diff --git a/src/KuzzleError.ts b/src/KuzzleError.ts index 0590650d1..659367274 100644 --- a/src/KuzzleError.ts +++ b/src/KuzzleError.ts @@ -3,7 +3,7 @@ /** * Standard Kuzzle error. * - * @see https://docs.kuzzle.io/core/2/api/essentials/error-handling/ + * @see https://docs.kuzzle.io/core/2/api/errors/types/ */ export class KuzzleError extends Error { /** diff --git a/src/controllers/Collection.ts b/src/controllers/Collection.ts index 6f1374b22..522db6a4d 100644 --- a/src/controllers/Collection.ts +++ b/src/controllers/Collection.ts @@ -13,7 +13,7 @@ export class CollectionController extends BaseController { * the full capabilities of our persistent data storage layer. * * @see https://docs.kuzzle.io/sdk/js/7/controllers/collection/create/ - * @see https://docs.kuzzle.io/core/2/guides/essentials/database-mappings/ + * @see https://docs.kuzzle.io/core/2/guides/main-concepts/data-storage * * @param index Index name * @param collection Collection name @@ -292,7 +292,7 @@ export class CollectionController extends BaseController { * the full capabilities of our persistent data storage layer. * * @see https://docs.kuzzle.io/sdk/js/7/controllers/collection/update/ - * @see https://docs.kuzzle.io/core/2/guides/essentials/database-mappings/ + * @see https://docs.kuzzle.io/core/2/guides/main-concepts/data-storage * * @param index Index name * @param collection Collection name diff --git a/src/controllers/Realtime.ts b/src/controllers/Realtime.ts index 202a30eba..602f499e8 100644 --- a/src/controllers/Realtime.ts +++ b/src/controllers/Realtime.ts @@ -124,7 +124,7 @@ export class RealtimeController extends BaseController { * * @param index Index name * @param collection Collection name - * @param filters Optional subscription filters (@see https://docs.kuzzle.io/core/2/guides/cookbooks/realtime-api) + * @param filters Optional subscription filters (@see https://docs.kuzzle.io/core/2/api/koncorde-filters-syntax) * @param callback Callback function to handle notifications * @param options Additional options * - `scope` Subscribe to document entering or leaving the scope. (default: 'all') diff --git a/src/utils/interfaces.ts b/src/utils/interfaces.ts index 4f2c532c5..5a669cd1b 100644 --- a/src/utils/interfaces.ts +++ b/src/utils/interfaces.ts @@ -10,7 +10,7 @@ export interface JSONObject { /** * Kuzzle API request * - * @see https://docs.kuzzle.io/core/2/api/essentials/query-syntax/#other-protocols + * @see https://docs.kuzzle.io/core/2/guides/main-concepts/querying#other-protocols */ export interface KuzzleRequest extends JSONObject { controller?: string; @@ -63,7 +63,7 @@ export interface KuzzleResponse extends JSONObject { * } * } * - * @see https://docs.kuzzle.io/core/2/guides/essentials/security/#defining-profiles + * @see https://docs.kuzzle.io/core/2/guides/main-concepts/permissions#profiles */ export interface ProfilePolicy { /** @@ -110,7 +110,7 @@ export interface ProfilePolicy { * } * } * - * @see https://docs.kuzzle.io/core/2/guides/essentials/security#defining-roles + * @see https://docs.kuzzle.io/core/2/guides/main-concepts/permissions#roles */ export interface RoleRightsDefinition { /** @@ -163,7 +163,7 @@ export interface ApiKey { /** * Kuzzle metadata - * @see https://docs.kuzzle.io/core/2/guides/essentials/document-metadata/ + * @see https://docs.kuzzle.io/core/2/guides/main-concepts/data-storage#kuzzle-metadata */ export interface KuzzleMetadata { _kuzzle_info: { @@ -234,13 +234,13 @@ export interface MappingsProperties { /** * Properties types definition * - * @see https://docs.kuzzle.io/core/2/guides/essentials/database-mappings/#properties-types-definition + * @see https://docs.kuzzle.io/core/2/guides/main-concepts/data-storage#properties-types-definition */ properties?: MappingsProperties, /** * Dynamic mapping policy * - * @see https://docs.kuzzle.io/core/2/guides/essentials/database-mappings/#dynamic-mapping-policy + * @see https://docs.kuzzle.io/core/2/guides/main-concepts/data-storage#mappings-dynamic-policy */ dynamic?: 'true' | 'false' | 'strict' | boolean } @@ -248,25 +248,25 @@ export interface MappingsProperties { /** * Collection mappings definition * - * @see https://docs.kuzzle.io/core/2/guides/essentials/database-mappings/ + * @see https://docs.kuzzle.io/core/2/guides/main-concepts/data-storage */ export interface CollectionMappings { /** * Collection metadata * - * @see https://docs.kuzzle.io/core/2/guides/essentials/database-mappings/#collection-metadata + * @see https://docs.kuzzle.io/core/2/guides/main-concepts/data-storage#collection-metadata */ _meta?: JSONObject; /** * Properties types definition * - * @see https://docs.kuzzle.io/core/2/guides/essentials/database-mappings/#properties-types-definition + * @see https://docs.kuzzle.io/core/2/guides/main-concepts/data-storage#properties-types-definition */ properties?: MappingsProperties, /** * Dynamic mapping policy * - * @see https://docs.kuzzle.io/core/2/guides/essentials/database-mappings/#dynamic-mapping-policy + * @see https://docs.kuzzle.io/core/2/guides/main-concepts/data-storage#mappings-dynamic-policy */ dynamic?: 'true' | 'false' | 'strict' | boolean, } @@ -323,7 +323,7 @@ export interface BaseNotification extends Notification { timestamp: number; /** * Request volatile data - * @see https://docs.kuzzle.io/core/2/guides/essentials/volatile-data/ + * @see https://docs.kuzzle.io/core/2/guides/main-concepts/api#volatile-data/ */ volatile: JSONObject; }