replace docs links from dart/2 to dart/3

kuzzleio · Jun 22, 2021 · 3dd79e8 · 3dd79e8
1 parent 31bc494
commit 3dd79e8
Show file tree

Hide file tree

Showing 36 changed files with 47 additions and 47 deletions.
diff --git a/doc/3/controllers/auth/get-current-user/index.md b/doc/3/controllers/auth/get-current-user/index.md
@@ -17,7 +17,7 @@ Future<KuzzleUser> getCurrentUser()
 
 ## Return
 
-A [User](/sdk/dart/2/core-classes/user) representing the current user logged with the SDK.
+A [User](/sdk/dart/3/core-classes/user) representing the current user logged with the SDK.
 
 ## Usage
 

diff --git a/doc/3/controllers/auth/logout/index.md b/doc/3/controllers/auth/logout/index.md
@@ -17,7 +17,7 @@ Future<void> logout()
 
 ## Return
 
-A [Response](/sdk/dart/2/core-classes/response) object.
+A [Response](/sdk/dart/3/core-classes/response) object.
 
 ## Usage
 

diff --git a/doc/3/controllers/bulk/import/index.md b/doc/3/controllers/bulk/import/index.md
@@ -9,7 +9,7 @@ description: Creates, updates or deletes large amounts of documents as fast as p
 
 Creates, updates or deletes large amounts of documents as fast as possible.
 
-This route is faster than the `document:m*` routes family (e.g. [document:mCreate](/sdk/dart/2/controllers/document/m-create)), but no real-time notifications will be generated, even if some of the documents in the import match subscription filters.
+This route is faster than the `document:m*` routes family (e.g. [document:mCreate](/sdk/dart/3/controllers/document/m-create)), but no real-time notifications will be generated, even if some of the documents in the import match subscription filters.
 
 ## Arguments
 

diff --git a/doc/3/controllers/collection/search-specifications/index.md b/doc/3/controllers/collection/search-specifications/index.md
@@ -14,7 +14,7 @@ There is a limit on how many items can be returned by a single search query.
 That limit is by default set at 10000, and you can't get over it even with the from and size pagination options.
 
 :::info
-When processing a large number of items (i.e. more than 1000), it is advised to paginate the results using [SearchResult.next](/sdk/dart/2/core-classes/search-result/next) rather than increasing the size parameter.
+When processing a large number of items (i.e. more than 1000), it is advised to paginate the results using [SearchResult.next](/sdk/dart/3/core-classes/search-result/next) rather than increasing the size parameter.
 :::
 
 <br/>
@@ -49,7 +49,7 @@ An empty body matches all documents in the queried collection.
 
  ## Return
 
- Returns a [SearchResult](/sdk/dart/2/core-classes/search-result) object.
+ Returns a [SearchResult](/sdk/dart/3/core-classes/search-result) object.
 
 
 ## Usage

diff --git a/doc/3/controllers/document/search/index.md b/doc/3/controllers/document/search/index.md
@@ -15,7 +15,7 @@ That limit is by default set at 10000 documents, and you can't get over it even
 :::
 
 ::: info
-When processing a large number of documents (i.e. more than 1000), it is advised to paginate the results using [SearchResult.next](/sdk/dart/2/core-classes/search-result/next) rather than increasing the size parameter.
+When processing a large number of documents (i.e. more than 1000), it is advised to paginate the results using [SearchResult.next](/sdk/dart/3/core-classes/search-result/next) rather than increasing the size parameter.
 :::
 
 ::: warning
@@ -75,7 +75,7 @@ An empty body matches all documents in the queried collection.
 
 ## Return
 
-Returns a [SearchResult](/sdk/dart/2/core-classes/search-result) object.
+Returns a [SearchResult](/sdk/dart/3/core-classes/search-result) object.
 
 ## Usage
 

diff --git a/doc/3/controllers/realtime/subscribe/index.md b/doc/3/controllers/realtime/subscribe/index.md
@@ -37,7 +37,7 @@ Future<String> subscribe(String index, String collection,
 ### handler
 
 Handler function that will be called each time a new notification is received.
-The hanlder will receive a [KuzzleResponse](/sdk/dart/2/essentials/realtime-notifications) as its only argument.
+The hanlder will receive a [KuzzleResponse](/sdk/dart/3/essentials/realtime-notifications) as its only argument.
 
 ## Return
 

diff --git a/doc/3/controllers/security/create-first-admin/index.md b/doc/3/controllers/security/create-first-admin/index.md
@@ -30,7 +30,7 @@ Future<KuzzleUser> createFirstAdmin(
 The `body` property must contain two `Map<String, dynamic>`:
 - `content`: Administrator additional information. Can be left empty.
 Any other attribute can be added. 
-Make sure to [update the user mapping](/sdk/dart/2/controllers/security/update-user-mapping) collection to match your custom attributes.
+Make sure to [update the user mapping](/sdk/dart/3/controllers/security/update-user-mapping) collection to match your custom attributes.
 - `credentials`: Describe how the new administrator can be authenticated. This object must contain one or more 
 properties, named after the target authentication strategy to use. Each one of these properties are objects
 containing the credentials information, corresponding to that authentication strategy.

diff --git a/doc/3/controllers/security/create-or-replace-profile/index.md b/doc/3/controllers/security/create-or-replace-profile/index.md
@@ -27,7 +27,7 @@ Future<KuzzleProfile> createOrReplaceProfile(
 
 ## Return
 
-A [`Profile`](/sdk/dart/2/core-classes/profile/introduction) object representing the updated/created profile.
+A [`Profile`](/sdk/dart/3/core-classes/profile/introduction) object representing the updated/created profile.
 
 ## Usage
 

diff --git a/doc/3/controllers/security/create-or-replace-role/index.md b/doc/3/controllers/security/create-or-replace-role/index.md
@@ -28,7 +28,7 @@ Future<KuzzleRole> createOrReplaceRole(
 
 ## Return
 
-A [`Role`](/sdk/dart/2/core-classes/role) object representing the created/replaced role.
+A [`Role`](/sdk/dart/3/core-classes/role) object representing the created/replaced role.
 
 ## Usage
 

diff --git a/doc/3/controllers/security/create-profile/index.md b/doc/3/controllers/security/create-profile/index.md
@@ -27,7 +27,7 @@ Future<KuzzleProfile> createProfile(
 
 ## Return
 
-A [`Profile`](/sdk/dart/2/core-classes/profile/introduction) object representing the created profile.
+A [`Profile`](/sdk/dart/3/core-classes/profile/introduction) object representing the created profile.
 
 ## Usage
 

diff --git a/doc/3/controllers/security/create-role/index.md b/doc/3/controllers/security/create-role/index.md
@@ -27,7 +27,7 @@ Future<KuzzleRole> createRole(String id, Map<String, dynamic> controllers,
 
 ## Return
 
-A [`Role`](/sdk/dart/2/core-classes/role) object representing the created/replaced role.
+A [`Role`](/sdk/dart/3/core-classes/role) object representing the created/replaced role.
 
 ## Usage
 

diff --git a/doc/3/controllers/security/create-user/index.md b/doc/3/controllers/security/create-user/index.md
@@ -34,7 +34,7 @@ If the `kuid` is `null`, Kuzzle will generate an ID.
 The `body` property must contain two objects:
 - `content`: Contains the list of profile ids to attach the user to and potential additional information. At least the `profileIds` must be supplied.
 Any other attribute can be added. 
-Make sure to [update the user mapping](/sdk/dart/2/controllers/security/update-user-mapping) collection to match your custom attributes.
+Make sure to [update the user mapping](/sdk/dart/3/controllers/security/update-user-mapping) collection to match your custom attributes.
 - `credentials`: Describes how the new administrator can be authenticated. This object must contain one or more 
 properties, named after the target authentication strategy to use. Each one of these properties are objects
 containing the credentials information, corresponding to that authentication strategy.

diff --git a/doc/3/controllers/security/get-profile/index.md b/doc/3/controllers/security/get-profile/index.md
@@ -23,7 +23,7 @@ Future<KuzzleProfile> getProfile(String id)
 
 ## Return
 
-The retrieved [`Profile`](/sdk/dart/2/core-classes/profile/introduction) object.
+The retrieved [`Profile`](/sdk/dart/3/core-classes/profile/introduction) object.
 
 ## Usage
 

diff --git a/doc/3/controllers/security/get-role/index.md b/doc/3/controllers/security/get-role/index.md
@@ -23,7 +23,7 @@ Future<KuzzleRole> getRole(String id)
 
 ## Return
 
-The retrieved [`Role`](/sdk/dart/2/core-classes/role) object.
+The retrieved [`Role`](/sdk/dart/3/core-classes/role) object.
 
 ## Usage
 

diff --git a/doc/3/controllers/security/m-get-profiles/index.md b/doc/3/controllers/security/m-get-profiles/index.md
@@ -23,7 +23,7 @@ Future<List<KuzzleProfile>> mGetProfiles(List<String> ids)
 
 ## Return
 
-An List of retrieved [`Profile`](/sdk/dart/2/core-classes/profile/introduction) objects.
+An List of retrieved [`Profile`](/sdk/dart/3/core-classes/profile/introduction) objects.
 
 ## Usage
 

diff --git a/doc/3/controllers/security/m-get-roles/index.md b/doc/3/controllers/security/m-get-roles/index.md
@@ -24,7 +24,7 @@ Future<List<KuzzleRole>> mGetRoles(
 
 ## Resolves
 
-A List of retrieved [`Role`](/sdk/dart/2/core-classes/role/introduction) objects.
+A List of retrieved [`Role`](/sdk/dart/3/core-classes/role/introduction) objects.
 
 ## Usage
 

diff --git a/doc/3/controllers/security/m-get-users/index.md b/doc/3/controllers/security/m-get-users/index.md
@@ -28,7 +28,7 @@ You can set the `verb` option to `POST` to force the SDK to use the POST API ins
 
 ## Returns
 
-An array of retrieved [`User`](/sdk/dart/2/core-classes/user/introduction) objects.
+An array of retrieved [`User`](/sdk/dart/3/core-classes/user/introduction) objects.
 
 ## Usage
 

diff --git a/doc/3/controllers/security/replace-user/index.md b/doc/3/controllers/security/replace-user/index.md
@@ -35,7 +35,7 @@ Future<KuzzleUser> replaceUser(String id,
 **other properties**
 
 The body can be extended with any custom information. 
-Make sure to [update the user mapping](/sdk/dart/2/controllers/security/update-user-mapping) collection to match your custom attributes.
+Make sure to [update the user mapping](/sdk/dart/3/controllers/security/update-user-mapping) collection to match your custom attributes.
 
 example:
 

diff --git a/doc/3/controllers/security/search-api-keys/index.md b/doc/3/controllers/security/search-api-keys/index.md
@@ -44,7 +44,7 @@ If left empty, the result will return all available API keys for the user.
 
 ## Returns
 
-Returns a [SearchResult](/sdk/dart/2/core-classes/search-result) object.
+Returns a [SearchResult](/sdk/dart/3/core-classes/search-result) object.
 
 ## Usage
 

diff --git a/doc/3/controllers/security/search-profiles/index.md b/doc/3/controllers/security/search-profiles/index.md
@@ -37,7 +37,7 @@ Future<ProfileSearchResult> searchProfiles(
 
 ## Return
 
-A [`ProfileSearchResult`](sdk/dart/2/core-classes/search-result) object containing the retrieved [`Profile`](/sdk/dart/2/core-classes/profile) objects.
+A [`ProfileSearchResult`](sdk/dart/2/core-classes/search-result) object containing the retrieved [`Profile`](/sdk/dart/3/core-classes/profile) objects.
 
 ## Usage
 

diff --git a/doc/3/controllers/security/search-roles/index.md b/doc/3/controllers/security/search-roles/index.md
@@ -32,7 +32,7 @@ Future<RoleSearchResult> searchRoles(
 
 ## Return
 
-A [`RoleSearchResult`](sdk/dart/2/core-classes/search-result) object containing the retrieved [`Role`](/sdk/dart/2/core-classes/role) objects.
+A [`RoleSearchResult`](sdk/dart/2/core-classes/search-result) object containing the retrieved [`Role`](/sdk/dart/3/core-classes/role) objects.
 
 ## Usage
 

diff --git a/doc/3/controllers/security/search-users/index.md b/doc/3/controllers/security/search-users/index.md
@@ -47,7 +47,7 @@ If left empty, the result will return all available users.
 
 ## Return
 
-A [`UserSearchResult`](sdk/dart/2/core-classes/search-result) object containing the retrieved [`User`](/sdk/dart/2/core-classes/user) objects.
+A [`UserSearchResult`](sdk/dart/2/core-classes/search-result) object containing the retrieved [`User`](/sdk/dart/3/core-classes/user) objects.
 
 ## Usage
 

diff --git a/doc/3/controllers/security/update-profile/index.md b/doc/3/controllers/security/update-profile/index.md
@@ -26,7 +26,7 @@ Updates a security profile definition.
 
 ## Return
 
-A [`Profile`](/sdk/dart/2/core-classes/profile/introduction) object representing the updated profile.
+A [`Profile`](/sdk/dart/3/core-classes/profile/introduction) object representing the updated profile.
 
 ## Usage
 

diff --git a/doc/3/controllers/security/update-role/index.md b/doc/3/controllers/security/update-role/index.md
@@ -35,7 +35,7 @@ Future<KuzzleRole> updateRole(String id, Map<String, dynamic> controllers,
 
 ## Return
 
-A [`Role`](/sdk/dart/2/core-classes/role) object representing the updated role.
+A [`Role`](/sdk/dart/3/core-classes/role) object representing the updated role.
 
 ## Usage
 

diff --git a/doc/3/controllers/security/update-user/index.md b/doc/3/controllers/security/update-user/index.md
@@ -28,7 +28,7 @@ Future<KuzzleUser> updateUser(String id, Map<String, dynamic> body,
 
 The `body` contains the list of profile ids to attach the user to and potential additional information.  
 Any other attribute can be added. 
-Make sure to [update the user mapping](/sdk/dart/2/controllers/security/update-user-mapping) collection to match your custom attributes.
+Make sure to [update the user mapping](/sdk/dart/3/controllers/security/update-user-mapping) collection to match your custom attributes.
 
 Example: 
 

diff --git a/doc/3/core-classes/kuzzle/constructor/index.md b/doc/3/core-classes/kuzzle/constructor/index.md
@@ -42,7 +42,7 @@ Kuzzle(
 The protocol used to connect to the Kuzzle instance.
 It can be one of the following available protocols:
 
-- [WebSocket](/sdk/dart/2/protocols/websocket)
+- [WebSocket](/sdk/dart/3/protocols/websocket)
 
 ## Return
 

diff --git a/doc/3/core-classes/kuzzle/query/index.md b/doc/3/core-classes/kuzzle/query/index.md
@@ -24,7 +24,7 @@ This is a low-level method, exposed to allow advanced SDK users to bypass high-l
 
 | Argument  | Type              | Description            |
 | --------- | ----------------- | ---------------------- |
-| `request` | <pre>[KuzzleRequest](/sdk/dart/2/core-classes/request)</pre> | API request    |
+| `request` | <pre>[KuzzleRequest](/sdk/dart/3/core-classes/request)</pre> | API request    |
 | `volatile`   | <pre>Map<String, dynamic></pre> | Additional information to send to Kuzzle |
 | `queueable`   | <pre>bool</pre> | If true, queues the request during downtime, until connected to Kuzzle again |
 
@@ -45,7 +45,7 @@ The following properties are the most common.
 
 ## Returns
 
-Returns a [KuzzleResponse](/sdk/dart/2/core-classes/response) object which represents a raw Kuzzle API response. See the [API Documentation](/core/2/api).
+Returns a [KuzzleResponse](/sdk/dart/3/core-classes/response) object which represents a raw Kuzzle API response. See the [API Documentation](/core/2/api).
 
 ## Usage
 

diff --git a/doc/3/core-classes/profile/getRoles/index.md b/doc/3/core-classes/profile/getRoles/index.md
@@ -17,7 +17,7 @@ getRoles();
 
 ## Resolve
 
-Resolves to an array of [Role](/sdk/dart/2/core-classes/role).
+Resolves to an array of [Role](/sdk/dart/3/core-classes/role).
 
 ## Usage
 

diff --git a/doc/3/core-classes/response/introduction/index.md b/doc/3/core-classes/response/introduction/index.md
@@ -18,7 +18,7 @@ order: 0
 | `action` | <pre>String</pre> | Executed Kuzzle API controller's action |
 | `collection` | <pre>String</pre> | Impacted collection |
 | `controller` | <pre>String</pre> | Executed Kuzzle API controller |
-| `error` | <pre>[KuzzleError](/sdk/dart/2/core-classes/kuzzle-error)</pre> | Error object (null if the request finished successfully) |
+| `error` | <pre>[KuzzleError](/sdk/dart/3/core-classes/kuzzle-error)</pre> | Error object (null if the request finished successfully) |
 | `index` | <pre>String</pre> | Impacted index |
 | `protocol` | <pre>String</pre> | Network protocol at the origin of the real-time notification |
 | `requestId` | <pre>String</pre> | Request unique identifier |

diff --git a/doc/3/core-classes/search-result/introduction/index.md b/doc/3/core-classes/search-result/introduction/index.md
@@ -11,8 +11,8 @@ order: 1
 This class represents a paginated search result.  
 
 It can be returned by the following methods:
- - [document:search](/sdk/dart/2/controllers/document/search)
- - [collection:searchSpecifications](/sdk/dart/2/controllers/collection/search-specifications)
+ - [document:search](/sdk/dart/3/controllers/document/search)
+ - [collection:searchSpecifications](/sdk/dart/3/controllers/collection/search-specifications)
 
 ## Properties
 

diff --git a/doc/3/core-classes/user/getProfiles/index.md b/doc/3/core-classes/user/getProfiles/index.md
@@ -17,7 +17,7 @@ getProfiles();
 
 ## Resolve
 
-Resolves to a List of [Profile](/sdk/dart/2/core-classes/profile).
+Resolves to a List of [Profile](/sdk/dart/3/core-classes/profile).
 
 ## Usage
 

diff --git a/doc/3/core-classes/user/introduction/index.md b/doc/3/core-classes/user/introduction/index.md
@@ -14,5 +14,5 @@ Refer to the [Security guide](/core/2/guides/main-concepts/permissions) for more
 
 The following methods return a `User` object:
 
-- [auth:getCurrentUser](/sdk/dart/2/controllers/auth/get-current-user)
-- [auth:updateSelf](/sdk/dart/2/controllers/auth/update-self)
+- [auth:getCurrentUser](/sdk/dart/3/controllers/auth/get-current-user)
+- [auth:updateSelf](/sdk/dart/3/controllers/auth/update-self)
diff --git a/doc/3/essentials/network-loss-resilience/index.md b/doc/3/essentials/network-loss-resilience/index.md
@@ -14,6 +14,6 @@ The Kuzzle Dart SDK provides tools that allow it to be used with an unstable net
 
 The Kuzzle Dart SDK can automatically reconnect in case of a network disconnection and it can renew realtime subscriptions if there are any.
 
-To control the auto reconnection feature with WebSocket (enabled by default), refer to the `autoReconnect` option of the [WebSocketProtocol](/sdk/dart/2/protocols/websocket) object.
+To control the auto reconnection feature with WebSocket (enabled by default), refer to the `autoReconnect` option of the [WebSocketProtocol](/sdk/dart/3/protocols/websocket) object.
 
-To control the auto resubscription (enabled by default), refer to the `autoResubscribe` option of the [subscribe](/sdk/dart/2/controllers/realtime/subscribe) object.
+To control the auto resubscription (enabled by default), refer to the `autoResubscribe` option of the [subscribe](/sdk/dart/3/controllers/realtime/subscribe) object.
diff --git a/doc/3/essentials/realtime-notifications/index.md b/doc/3/essentials/realtime-notifications/index.md
@@ -8,7 +8,7 @@ order: 300
 
 # Notifications
 
-The [RealtimeController.subscribe](/sdk/dart/2/controllers/realtime/subscribe) method takes a handler argument, called with a [KuzzleResponse](/sdk/dart/2/core-classes/response) object, whose content of the `Result` property depends on the type of notification received.
+The [RealtimeController.subscribe](/sdk/dart/3/controllers/realtime/subscribe) method takes a handler argument, called with a [KuzzleResponse](/sdk/dart/3/core-classes/response) object, whose content of the `Result` property depends on the type of notification received.
 
 ## Document & messages
 

diff --git a/doc/3/getting-started/flutter/index.md b/doc/3/getting-started/flutter/index.md
@@ -8,7 +8,7 @@ order: 0
 
 # Getting Started with Kuzzle and Flutter
 
-This section deals with **Kuzzle v2**, the **Dart SDK v2** and **Flutter**. We will create **documents** in Kuzzle and subscribe to [document notifications](/sdk/dart/2/essentials/realtime-notifications#document-messages) to develop a realtime chat.
+This section deals with **Kuzzle v2**, the **Dart SDK v2** and **Flutter**. We will create **documents** in Kuzzle and subscribe to [document notifications](/sdk/dart/3/essentials/realtime-notifications#document-messages) to develop a realtime chat.
 
 ## Requirements
 
@@ -60,7 +60,7 @@ In our _chat.dart_ let's import the sdk:
 
 <<< ./snippets/chat.dart.snippet:1[dart]
 
-Then we will [establish the connection](/sdk/dart/2/core-classes/kuzzle/connect) to kuzzle and create, if they don't [exist](/sdk/dart/2/controllers/index/exists/), the [index](/sdk/dart/2/controllers/index/create) and [collection](/sdk/dart/2/controllers/collection/create) of our chat. We will also fetch messages sorted by creation date, and  subscribe to the same collection to receive new messages in realtime.
+Then we will [establish the connection](/sdk/dart/3/core-classes/kuzzle/connect) to kuzzle and create, if they don't [exist](/sdk/dart/3/controllers/index/exists/), the [index](/sdk/dart/3/controllers/index/create) and [collection](/sdk/dart/3/controllers/collection/create) of our chat. We will also fetch messages sorted by creation date, and  subscribe to the same collection to receive new messages in realtime.
 
 ### Create index and collection
 
@@ -71,7 +71,7 @@ So first let's write a method which will create the index/collection if it does
 
 ### Get existing messages
 
-The method _fetchMessage()_ will [search](/sdk/dart/2/controllers/document/search) for the first hundred newest messages.
+The method _fetchMessage()_ will [search](/sdk/dart/3/controllers/document/search) for the first hundred newest messages.
 It will then update the state of the widget to store those messages in the `messages` variable.
 
 <<< ./snippets/chat.dart.snippet:3[dart]
@@ -125,7 +125,7 @@ _chat.dart:_
 
 <<< ./snippets/chat.dart.snippet:9[dart]
 
-For this we simply [create](/sdk/dart/2/controllers/document/create) a document in our `messages` collection with a `username` and a `value`. Once this document is created it will trigger a notification to all clients who subscribed to this collection and receive the message.
+For this we simply [create](/sdk/dart/3/controllers/document/create) a document in our `messages` collection with a `username` and a `value`. Once this document is created it will trigger a notification to all clients who subscribed to this collection and receive the message.
 
 ## Where do we go from here?
 
@@ -135,4 +135,4 @@ Now that you're more familiar with Kuzzle, dive even deeper to learn how to leve
 - 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/dart/2/controllers/auth/login)
+- learn how to perform a [basic authentication](/sdk/dart/3/controllers/auth/login)
diff --git a/doc/3/protocols/http/introduction/index.md b/doc/3/protocols/http/introduction/index.md
@@ -11,7 +11,7 @@ order: 0
 The Http protocol can be used by an instance of the SDK to communicate with your Kuzzle server.
 
 ::: info
-This protocol does not allow to use the [real-time notifications](/sdk/dart/2/essentials/realtime-notifications).
+This protocol does not allow to use the [real-time notifications](/sdk/dart/3/essentials/realtime-notifications).
 
-If you need real-time features, then you have to use the [WebSocket](/sdk/dart/2/protocols/websocket) protocol.
+If you need real-time features, then you have to use the [WebSocket](/sdk/dart/3/protocols/websocket) protocol.
 :::