kuzzleio · jenow · Nov 16, 2020 · Nov 12, 2020 · Nov 12, 2020 · Nov 13, 2020
diff --git a/.ci/doc/config.yml b/.ci/doc/config.yml
@@ -2,7 +2,7 @@
 
 snippets:
   mount: /mnt
-  path: '.doc/**/*.test.yml'
+  path: '.doc/**/snippets/*.test.yml'
   templates: /mnt/.ci/doc/templates
 
 runners:

diff --git a/.ci/doc/docker-compose.yml b/.ci/doc/docker-compose.yml
@@ -2,32 +2,29 @@ version: '3'
 
 services:
   kuzzle:
-    image: kuzzleio/kuzzle:1
+    image: kuzzleio/kuzzle:2
     ports:
       - '7512:7512'
-      - '1883:1883'
     cap_add:
       - SYS_PTRACE
     depends_on:
       - redis
       - elasticsearch
     container_name: kuzzle
     environment:
-      - kuzzle_services__db__client__host=http://elasticsearch:9200
+      - kuzzle_services__storageEngine__client__node=http://elasticsearch:9200
       - kuzzle_services__internalCache__node__host=redis
       - kuzzle_services__memoryStorage__node__host=redis
-      - NODE_END=production
+      - kuzzle_services__storageEngine__commonMapping__dynamic=true
+      - NODE_ENV=production
 
   redis:
     image: redis:5
 
   elasticsearch:
-    image: kuzzleio/elasticsearch:5.6.10
+    image: kuzzleio/elasticsearch:7
     ulimits:
       nofile: 65536
-    environment:
-      - cluster.name=kuzzle
-      - 'ES_JAVA_OPTS=-Xms256m -Xmx256m'
 
   doc-tests:
     image: kuzzleio/snippets-tests
@@ -48,6 +45,7 @@ services:
     image: golang:alpine
     volumes:
       - ../..:/mnt
+      - ../..:/go/src/github.com/kuzzleio/sdk-go
       - snippets:/var/snippets
     command: >
       ash -c '
@@ -59,7 +57,6 @@ services:
          github.com/gorilla/websocket \
          golang.org/x/tools/cmd/goimports \
          golang.org/x/lint/golint;
-        go get github.com/kuzzleio/sdk-go;
         touch /tmp/runner_ready_to_lint;
         touch /tmp/runner_is_ready;
         tail -f /dev/null

diff --git a/.doc/3/controllers/auth/check-token/snippets/check-token.test.yml b/.doc/3/controllers/auth/check-token/snippets/check-token.test.yml
@@ -7,4 +7,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/auth/create-my-credentials/snippets/create-my-credentials.test.yml b/.doc/3/controllers/auth/create-my-credentials/snippets/create-my-credentials.test.yml
@@ -7,4 +7,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/auth/credentials-exist/snippets/credentials-exist.test.yml b/.doc/3/controllers/auth/credentials-exist/snippets/credentials-exist.test.yml
@@ -7,4 +7,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/auth/delete-my-credentials/snippets/delete-my-credentials.test.yml b/.doc/3/controllers/auth/delete-my-credentials/snippets/delete-my-credentials.test.yml
@@ -6,4 +6,4 @@ hooks:
 template: default
 expected: Success
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/auth/get-current-user/snippets/get-current-user.test.yml b/.doc/3/controllers/auth/get-current-user/snippets/get-current-user.test.yml
@@ -7,4 +7,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/auth/get-my-credentials/snippets/get-my-credentials.test.yml b/.doc/3/controllers/auth/get-my-credentials/snippets/get-my-credentials.test.yml
@@ -7,4 +7,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/auth/get-my-rights/snippets/get-my-rights.test.yml b/.doc/3/controllers/auth/get-my-rights/snippets/get-my-rights.test.yml
@@ -7,4 +7,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/auth/get-strategies/snippets/get-strategies.test.yml b/.doc/3/controllers/auth/get-strategies/snippets/get-strategies.test.yml
@@ -7,4 +7,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/auth/login/snippets/login.test.yml b/.doc/3/controllers/auth/login/snippets/login.test.yml
@@ -8,4 +8,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/auth/logout/snippets/logout.test.yml b/.doc/3/controllers/auth/logout/snippets/logout.test.yml
@@ -7,4 +7,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/auth/update-my-credentials/snippets/update-my-credentials.test.yml b/.doc/3/controllers/auth/update-my-credentials/snippets/update-my-credentials.test.yml
@@ -7,4 +7,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/auth/update-self/snippets/update-self.test.yml b/.doc/3/controllers/auth/update-self/snippets/update-self.test.yml
@@ -7,4 +7,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/auth/validate-my-credentials/snippets/validate-my-credentials.test.yml b/.doc/3/controllers/auth/validate-my-credentials/snippets/validate-my-credentials.test.yml
@@ -7,4 +7,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/collection/create/snippets/create.test.yml b/.doc/3/controllers/collection/create/snippets/create.test.yml
@@ -7,4 +7,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/collection/delete-specifications/snippets/delete-specifications.test.yml b/.doc/3/controllers/collection/delete-specifications/snippets/delete-specifications.test.yml
@@ -7,4 +7,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/collection/exists/snippets/exists.test.yml b/.doc/3/controllers/collection/exists/snippets/exists.test.yml
@@ -7,4 +7,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/collection/get-mapping/snippets/get-mapping.test.yml b/.doc/3/controllers/collection/get-mapping/snippets/get-mapping.test.yml
@@ -7,4 +7,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/collection/get-specifications/snippets/get-specifications.test.yml b/.doc/3/controllers/collection/get-specifications/snippets/get-specifications.test.yml
@@ -1,10 +1,14 @@
 name: collection#getSpecifications
 description: Returns the validation specifications
 hooks:
-  before: "curl -X POST kuzzle:7512/nyc-open-data/_create && curl -X PUT kuzzle:7512/nyc-open-data/yellow-taxi && curl -X PUT -H \"Content-Type: application/json\" -d '{\"nyc-open-data\": {\"yellow-taxi\": {\"strict\": false,\"fields\": {\"license\": {\"type\": \"string\"}}}}}' kuzzle:7512/_specifications"
+  before: |
+    curl -X DELETE kuzzle:7512/nyc-open-data
+    curl -X POST kuzzle:7512/nyc-open-data/_create
+    curl -X PUT kuzzle:7512/nyc-open-data/yellow-taxi
+    curl -X PUT -H "Content-Type: application/json" -d '{"strict": false, "fields": {"license": {"type": "string"} } }' kuzzle:7512/nyc-open-data/yellow-taxi/_specifications
   after:
 template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/collection/list/snippets/list.test.yml b/.doc/3/controllers/collection/list/snippets/list.test.yml
@@ -7,4 +7,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/collection/refresh/index.md b/.doc/3/controllers/collection/refresh/index.md
@@ -0,0 +1,40 @@
+---
+code: true
+type: page
+title: refresh
+description: Forces an Elasticsearch search index update
+---
+
+# refresh
+
+Refreshes a collection to reindex the written and deleted documents so they are available in search results.
+
+:::info
+A refresh operation comes with some performance costs.
+
+From the [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/docs-refresh.html):
+> "While a refresh is much lighter than a commit, it still has a performance cost. A manual refresh can be useful when writing tests, but don’t do a manual refresh every time you index a document in production; it will hurt your performance. Instead, your application needs to be aware of the near real-time nature of Elasticsearch and make allowances for it."
+
+:::
+
+<br/>
+
+## Arguments
+
+```go
+Refresh(index string, collection string, options types.QueryOptions) error
+```
+
+| Arguments    | Type            | Description
+| ------------ | --------------- | -------------------------------------- |
+| `index`      | <pre>string</pre>          | Index name                             |
+| `collection` | <pre>string</pre>          | Collection name                        |
+| `options`    | <pre>QueryOptions</pre>    | Query options                          |
+
+## Resolves
+
+Resolves when the refresh has been done.
+
+## Usage
+
+<<< ./snippets/refresh.go
diff --git a/.doc/3/controllers/collection/refresh/snippets/refresh.go b/.doc/3/controllers/collection/refresh/snippets/refresh.go
@@ -0,0 +1,7 @@
+err := kuzzle.Collection.Refresh("nyc-open-data", "yellow-taxi", nil)
+
+if err != nil {
+  log.Fatal(err)
+} else {
+  fmt.Println("Success")
+}
diff --git a/.doc/3/controllers/collection/refresh/snippets/refresh.test.yml b/.doc/3/controllers/collection/refresh/snippets/refresh.test.yml
@@ -0,0 +1,12 @@
+name: collection#refresh
+description: Refresh a collection
+hooks:
+  before: |
+    curl -X POST kuzzle:7512/nyc-open-data/_create
+    curl -X PUT kuzzle:7512/nyc-open-data/yellow-taxi
+  after:
+template: default
+expected: Success
+
+sdk: go
+version: 3
diff --git a/.doc/3/controllers/collection/search-specifications/snippets/search-specifications.test.yml b/.doc/3/controllers/collection/search-specifications/snippets/search-specifications.test.yml
@@ -21,4 +21,4 @@ hooks:
 template: default
 expected: Successfully retrieved 1 specifications
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/collection/truncate/snippets/truncate.test.yml b/.doc/3/controllers/collection/truncate/snippets/truncate.test.yml
@@ -7,4 +7,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/collection/update-mapping/snippets/update-mapping.test.yml b/.doc/3/controllers/collection/update-mapping/snippets/update-mapping.test.yml
@@ -7,4 +7,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/collection/update-specifications/snippets/update-specifications.test.yml b/.doc/3/controllers/collection/update-specifications/snippets/update-specifications.test.yml
@@ -1,10 +1,13 @@
 name: collection#updateSpecifications
 description: Update the validation specifications
 hooks:
-  before: curl -X POST kuzzle:7512/nyc-open-data/_create && curl -X PUT kuzzle:7512/nyc-open-data/green-taxi
+  before: |
+    curl -X DELETE kuzzle:7512:/nyc-open-data
+    curl -X POST kuzzle:7512/nyc-open-data/_create
+    curl -X PUT kuzzle:7512/nyc-open-data/green-taxi
   after: curl -X DELETE kuzzle:7512/nyc-open-data/yellow-taxi/_specifications
 template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.../controllers/collection/validate-specifications/snippets/validate-specifications.test.yml b/.../controllers/collection/validate-specifications/snippets/validate-specifications.test.yml
@@ -7,4 +7,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/document/count/snippets/count.test.yml b/.doc/3/controllers/document/count/snippets/count.test.yml
@@ -12,11 +12,11 @@ hooks:
     for i in 1 2 3 4 5; do
       curl -H "Content-type: application/json" -d '{}' kuzzle:7512/nyc-open-data/yellow-taxi/_create
     done
-    curl -XPOST kuzzle:7512/nyc-open-data/_refresh
+    curl -X POST kuzzle:7512/nyc-open-data/yellow-taxi/_refresh
   after: |
     curl -XDELETE kuzzle:7512/nyc-open-data
 template: default
 expected: Found 5 documents matching licence:valid
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/document/create/snippets/create.test.yml b/.doc/3/controllers/document/create/snippets/create.test.yml
@@ -11,4 +11,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/document/createOrReplace/snippets/create-or-replace.test.yml b/.doc/3/controllers/document/createOrReplace/snippets/create-or-replace.test.yml
@@ -11,4 +11,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/document/delete/snippets/delete.test.yml b/.doc/3/controllers/document/delete/snippets/delete.test.yml
@@ -12,4 +12,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/document/deleteByQuery/snippets/delete-by-query.test.yml b/.doc/3/controllers/document/deleteByQuery/snippets/delete-by-query.test.yml
@@ -14,11 +14,11 @@ hooks:
       curl -H "Content-type: application/json" -d '{"capacity": 7}' kuzzle:7512/nyc-open-data/yellow-taxi/_create
     done
 
-    curl -XPOST kuzzle:7512/nyc-open-data/_refresh
+    curl -XPOST kuzzle:7512/nyc-open-data/yellow-taxi/_refresh
   after: |
     curl -XDELETE kuzzle:7512/nyc-open-data
 template: default
 expected: Successfully deleted 5 documents
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/document/get/snippets/get.test.yml b/.doc/3/controllers/document/get/snippets/get.test.yml
@@ -11,4 +11,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/document/mCreate/snippets/m-create.test.yml b/.doc/3/controllers/document/mCreate/snippets/m-create.test.yml
@@ -11,4 +11,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/document/mCreateOrReplace/snippets/m-create-or-replace.test.yml b/.doc/3/controllers/document/mCreateOrReplace/snippets/m-create-or-replace.test.yml
@@ -11,4 +11,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/document/mDelete/snippets/m-delete.go b/.doc/3/controllers/document/mDelete/snippets/m-delete.go
@@ -14,10 +14,17 @@ kuzzle.Document.Create(
 	json.RawMessage(`{}`),
 	nil)
 
-deleted, err := kuzzle.Document.MDelete("nyc-open-data", "yellow-taxi", ids, nil)
+
+deletedJSON, err := kuzzle.Document.MDelete("nyc-open-data", "yellow-taxi", ids, nil)
 
 if err != nil {
   log.Fatal(err)
 } else {
-  fmt.Printf("Successfully deleted %d documents", len(deleted))
+	type deletedResult struct {
+		Successes []json.RawMessage `json:"successes"`
+		Errors 	  []json.RawMessage `json:"errors"`
+	}
+	var deleted deletedResult
+	json.Unmarshal(deletedJSON, &deleted)
+  	fmt.Printf("Successfully deleted %d documents", len(deleted.Successes))
 }
diff --git a/.doc/3/controllers/document/mDelete/snippets/m-delete.test.yml b/.doc/3/controllers/document/mDelete/snippets/m-delete.test.yml
@@ -11,4 +11,4 @@ template: default
 expected: Successfully deleted 2 documents
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/document/mGet/snippets/m-get.test.yml b/.doc/3/controllers/document/mGet/snippets/m-get.test.yml
@@ -11,4 +11,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/document/mReplace/snippets/m-replace.test.yml b/.doc/3/controllers/document/mReplace/snippets/m-replace.test.yml
@@ -11,4 +11,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3
diff --git a/.doc/3/controllers/document/mUpdate/snippets/m-update.test.yml b/.doc/3/controllers/document/mUpdate/snippets/m-update.test.yml
@@ -11,4 +11,4 @@ template: default
 expected: Success
 
 sdk: go
-version: 1
+version: 3