Add document:upsert

doc/2/controllers/document/upsert/index.md

@@ -17,7 +17,7 @@ Applies partial changes to a document. If the document doesn't already exist, a
     String index,
     String collection,
     String id,
-    Map<String, dynamic> body, {
+    Map<String, dynamic> changes, {
     bool waitForRefresh = false,
     int retryOnConflict,
     bool source,
@@ -29,22 +29,15 @@ Applies partial changes to a document. If the document doesn't already exist, a
 | `index`      | <pre>String</pre> | Index name                                |
 | `collection` | <pre>String</pre> | Collection name                           |
 | `id`         | <pre>String</pre> | Document ID                               |
-| `body`       | <pre>Map<String, dynamic></pre> | Partial content of the document to update and fields to add to the document if it gets created |
-
-### Body properties
-
-
-| Argument           | Type<br/>(default)              | Description                                                                        |
-| ----------------- | ------------------------------- | ---------------------------------------------------------------------------------- |
-| `changes`         | <pre>Map<String, dynamic></pre>    | partial changes to apply to the document |
-| `defaults` | <pre>Map<String, dynamic></pre><br/>(`{}`)        | (optional) fields to add to the document if it gets created    |
+| `changes`       | <pre>Map<String, dynamic></pre> | Partial content of the document to update |
 
 ### Options
 
 Additional query options
 
 | Options           | Type<br/>(default)              | Description                                                                        |
 | ----------------- | ------------------------------- | ---------------------------------------------------------------------------------- |
+| `defaults` | <pre>Map<String, dynamic></pre><br/>(`{}`)  | (optional) fields to add to the document if it gets created  |
 | `waitForRefresh`         | <pre>bool</pre><br/>(`""`)    | If set to `true`, waits for the change to be reflected for `search` (up to 1s) |
 | `retryOnConflict` | <pre>int</pre><br/>(`10`)        | The number of times the database layer should retry in case of version conflict    |
 | `source`          | <pre>bool</pre><br/>(`false`)| If true, returns the updated document inside the response

lib/src/controllers/document.dart

@@ -347,7 +347,7 @@ class DocumentController extends KuzzleController {
   ///
   /// Optional
   ///
-  /// **[refresh]**: if set to wait_for, Kuzzle will not respond
+  /// **[waitForRefresh]**: if set to wait_for, Kuzzle will not respond
   /// until the update is indexed \\\
   /// **[retryOnConflict]**: conflicts may occur if the same document gets updated multiple times within a short timespan, in a database cluster. You can set the retryOnConflict optional argument (with a retry count), to tell Kuzzle to retry the failing updates the specified amount of times before rejecting the request with an error. \\\
   /// **[source]**: if set to true Kuzzle will return the updated document body in the response \\\
@@ -419,22 +419,24 @@ class DocumentController extends KuzzleController {
   ///
   /// **[index]**: index name \\\
   /// **[collection]**: collection name \\\
-  /// **[uid]**: unique identifier of the document to update \\\
-  /// **[body]**: Partial changes to apply to the document
+  /// **[id]**: unique identifier of the document to update \\\
+  /// **[changes]**: Partial changes to apply to the document
   /// and Fields to add to the document if it gets created (optional)
 
   ///
   /// Optional
   ///
-  /// **[refresh]**: if set to wait_for, Kuzzle will not respond
+  /// **[defaults]**: Fields to add to the document if it gets created
+  /// **[waitForRefresh]**: if set to wait_for, Kuzzle will not respond
   /// until the update is indexed \\\
   /// **[retryOnConflict]**: conflicts may occur if the same document gets updated multiple times within a short timespan, in a database cluster. You can set the retryOnConflict optional argument (with a retry count), to tell Kuzzle to retry the failing updates the specified amount of times before rejecting the request with an error. \\\
   /// **[source]**: if set to true Kuzzle will return the updated document body in the response \\\
   Future<Map<String, dynamic>> upsert(
     String index,
     String collection,
     String id,
-    Map<String, dynamic> body, {
+    Map<String, dynamic> changes, {
+    Map<String, dynamic> defaults,
     bool waitForRefresh = false,
     int retryOnConflict,
     bool source,
@@ -445,7 +447,8 @@ class DocumentController extends KuzzleController {
       index: index,
       collection: collection,
       uid: id,
-      body: body,
+      body: changes,
+      defaults: defaults,
       waitForRefresh: waitForRefresh,
       source: source,
       retryOnConflict: retryOnConflict,

lib/src/kuzzle/request.dart

@@ -30,6 +30,7 @@ class KuzzleRequest {
       this.scope,
       this.state,
       this.source,
+      this.defaults,
       this.userId,
       this.users,
       this.verb,
@@ -67,6 +68,7 @@ class KuzzleRequest {
     users = request.users;
     verb = request.verb;
     source = request.source;
+    defaults = request.defaults;
     includeKuzzleMeta = request.includeKuzzleMeta;
   }
 
@@ -105,6 +107,7 @@ class KuzzleRequest {
     users = data['users'] as String;
     verb = data['verb'] as String;
     source = data['source'] as bool;
+    defaults = data['defaults'] as Map<String, dynamic>;
     includeKuzzleMeta = data['includeKuzzleMeta'] as bool;
   }
 
@@ -200,7 +203,9 @@ class KuzzleRequest {
     if (source != null) {
       map['source'] = source;
     }
-
+    if (defaults != null) {
+      map['defaults'] = defaults;
+    }
     if (includeKuzzleMeta != null) {
       map['includeKuzzleMeta'] = includeKuzzleMeta;
     }
@@ -235,6 +240,7 @@ class KuzzleRequest {
   int retryOnConflict;
   bool reset;
   bool source;
+  Map<String, dynamic> defaults;
   String scope;
   String state;
   String userId;