From 12c1136a05f46d1958cbea4c17c252636efaf4a0 Mon Sep 17 00:00:00 2001 From: Yoann Abbes Date: Tue, 13 Oct 2020 14:17:48 +0200 Subject: [PATCH 1/2] Fix documentation --- doc/7/controllers/collection/list/index.md | 8 ++++---- doc/7/controllers/collection/update/index.md | 5 +---- doc/7/controllers/security/search-api-keys/index.md | 4 ++-- .../search-api-keys/snippets/search-api-keys.test.yml | 2 +- src/controllers/Security.js | 2 +- 5 files changed, 9 insertions(+), 12 deletions(-) diff --git a/doc/7/controllers/collection/list/index.md b/doc/7/controllers/collection/list/index.md index 753557a25..9da6c0348 100644 --- a/doc/7/controllers/collection/list/index.md +++ b/doc/7/controllers/collection/list/index.md @@ -30,8 +30,8 @@ Additional query options | Property | Type
(default) | Description | |------------|---------------------------------|------------------------------------------------------------------------------| | `queuable` | 
boolean

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

(`0`) | Offset of the first result | -| `size` | 
number

(`10`) | Maximum number of returned results | +| `from` | 
number

(`0`) | Offset of the first result | +| `size` | 
number

(`10`) | Maximum number of returned results | ## Resolves @@ -41,8 +41,8 @@ Resolves to an object containing the following properties: |---------------|---------------------|--------------------------------------------------------------------| | `type` | 
string
| Types of returned collections
(`all`, `realtime` or `stored`) | | `collections` | 
object[]
| List of collections | -| `from` | 
number
| Offset of the first result | -| `size` | 
number
| Maximum number of returned results | +| `from` | 
number
| Offset of the first result | +| `size` | 
number
| Maximum number of returned results | Each object in the `collections` array contains the following properties: diff --git a/doc/7/controllers/collection/update/index.md b/doc/7/controllers/collection/update/index.md index c39bc0e6b..39f3d23db 100644 --- a/doc/7/controllers/collection/update/index.md +++ b/doc/7/controllers/collection/update/index.md @@ -59,11 +59,9 @@ const definition = { } }; ``` - - - + ### definition @@ -88,7 +86,6 @@ More informations about database mappings [here](/core/2/guides/essentials/datab - ## Resolves Resolve if the collection is successfully updated. diff --git a/doc/7/controllers/security/search-api-keys/index.md b/doc/7/controllers/security/search-api-keys/index.md index b812fd0f4..f60305202 100644 --- a/doc/7/controllers/security/search-api-keys/index.md +++ b/doc/7/controllers/security/search-api-keys/index.md @@ -2,7 +2,7 @@ code: true type: page title: searchApiKeys -description: Searches for an user API keys. +description: Searches for a user API keys. --- # searchApiKeys @@ -11,7 +11,7 @@ description: Searches for an user API keys. -Searches for an user API keys. +Searches for a user API keys.
diff --git a/doc/7/controllers/security/search-api-keys/snippets/search-api-keys.test.yml b/doc/7/controllers/security/search-api-keys/snippets/search-api-keys.test.yml index b6029ecbc..829f8342a 100644 --- a/doc/7/controllers/security/search-api-keys/snippets/search-api-keys.test.yml +++ b/doc/7/controllers/security/search-api-keys/snippets/search-api-keys.test.yml @@ -1,5 +1,5 @@ name: security#searchApiKeys -description: Searches for an user API keys +description: Searches for a user API keys hooks: before: > curl --fail -H "Content-type: application/json" -d '{ diff --git a/src/controllers/Security.js b/src/controllers/Security.js index 26e5b24aa..40198576b 100644 --- a/src/controllers/Security.js +++ b/src/controllers/Security.js @@ -61,7 +61,7 @@ class SecurityController extends BaseController { } /** - * Searches for an user API key. + * Searches for a user API key. * * @param {String} userId - User kuid * @param {Object} [query] - Search query From cbdd920a7fd45a794cfef7fd283ee30289009c58 Mon Sep 17 00:00:00 2001 From: Yoann Abbes Date: Tue, 13 Oct 2020 15:11:46 +0200 Subject: [PATCH 2/2] Fix e2e test --- doc/7/getting-started/.react-native/package.json | 2 +- doc/7/getting-started/.react/with-redux/package.json | 2 +- doc/7/getting-started/.vuejs/package.json | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/7/getting-started/.react-native/package.json b/doc/7/getting-started/.react-native/package.json index 2715fc54b..270fbb877 100644 --- a/doc/7/getting-started/.react-native/package.json +++ b/doc/7/getting-started/.react-native/package.json @@ -7,7 +7,7 @@ "ios": "node_modules/.bin/expo-cli start --ios", "web": "node_modules/.bin/expo-cli start --web", "eject": "node_modules/.bin/expo-cli eject", - "test": "node_modules/.bin/cypress run --record" + "test": "node_modules/.bin/cypress run --record --key $CYPRESS_RECORD_KEY_DOC" }, "dependencies": { "cypress": "^3.8.1", diff --git a/doc/7/getting-started/.react/with-redux/package.json b/doc/7/getting-started/.react/with-redux/package.json index 2d4661e8f..6266aaee7 100644 --- a/doc/7/getting-started/.react/with-redux/package.json +++ b/doc/7/getting-started/.react/with-redux/package.json @@ -16,7 +16,7 @@ "postinstall": "if [ ! -f ../../../../../dist/kuzzle.js ]; then npm run build --prefix ../../../../../;fi && rm -rf ./node_modules/kuzzle-sdk/* && rsync -r --exclude 'getting-started' ../../../../../ ./node_modules/kuzzle-sdk", "start": "react-scripts start", "build": "react-scripts build", - "test": "./node_modules/.bin/cypress run --record", + "test": "./node_modules/.bin/cypress run --record --key $CYPRESS_RECORD_KEY_DOC", "eject": "react-scripts eject" }, "eslintConfig": { diff --git a/doc/7/getting-started/.vuejs/package.json b/doc/7/getting-started/.vuejs/package.json index d0c39fd37..55f01cfe4 100644 --- a/doc/7/getting-started/.vuejs/package.json +++ b/doc/7/getting-started/.vuejs/package.json @@ -10,7 +10,7 @@ "serve-with-vuex": "cd with-vuex && vue-cli-service serve", "build-with-vuex": "cd with-vuex && vue-cli-service build", "lint-with-vuex": "cd with-vuex && vue-cli-service lint", - "test": "./node_modules/.bin/cypress run --record" + "test": "./node_modules/.bin/cypress run --record --key $CYPRESS_RECORD_KEY_DOC" }, "dependencies": { "core-js": "^2.6.5",