Skip to content

Commit 4515cdf

Browse files
authored
Fix collection:list documentation (#550)
What does this PR do? Grammar Fix DeprecatedBadge tags Other Changes Fix e2e tests like there: #547
1 parent f42a3d3 commit 4515cdf

File tree

8 files changed

+12
-15
lines changed

8 files changed

+12
-15
lines changed

doc/7/controllers/collection/list/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ Additional query options
3030
| Property | Type<br/>(default) | Description |
3131
|------------|---------------------------------|------------------------------------------------------------------------------|
3232
| `queuable` | <pre>boolean</pre><br/>(`true`) | If true, queues the request during downtime, until connected to Kuzzle again |
33-
| `from` | <pre>number</pre> <br/>(`0`) | Offset of the first result <DeprecatedBadge since="7.1.4"/> |
34-
| `size` | <pre>number</pre> <br/>(`10`) | Maximum number of returned results <DeprecatedBadge since="7.1.4"/> |
33+
| `from` | <pre>number</pre> <br/>(`0`) | Offset of the first result <DeprecatedBadge version="7.1.4"/> |
34+
| `size` | <pre>number</pre> <br/>(`10`) | Maximum number of returned results <DeprecatedBadge version="7.1.4"/> |
3535

3636
## Resolves
3737

@@ -41,8 +41,8 @@ Resolves to an object containing the following properties:
4141
|---------------|---------------------|--------------------------------------------------------------------|
4242
| `type` | <pre>string</pre> | Types of returned collections <br/>(`all`, `realtime` or `stored`) |
4343
| `collections` | <pre>object[]</pre> | List of collections |
44-
| `from` | <pre>number</pre> | Offset of the first result <DeprecatedBadge since="7.1.4"/> |
45-
| `size` | <pre>number</pre> | Maximum number of returned results <DeprecatedBadge since="7.1.4"/> |
44+
| `from` | <pre>number</pre> | Offset of the first result <DeprecatedBadge version="7.1.4"/> |
45+
| `size` | <pre>number</pre> | Maximum number of returned results <DeprecatedBadge version="7.1.4"/> |
4646

4747
Each object in the `collections` array contains the following properties:
4848

doc/7/controllers/collection/update/index.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,9 @@ const definition = {
5959
}
6060
};
6161
```
62-
6362
</SinceBadge>
6463

65-
66-
<DeprecatedBadge version="7.4.0">
64+
<DeprecatedBadge version="7.4.0" >
6765

6866
### definition
6967

@@ -88,7 +86,6 @@ More informations about database mappings [here](/core/2/guides/essentials/datab
8886

8987
</DeprecatedBadge>
9088

91-
9289
## Resolves
9390

9491
Resolve if the collection is successfully updated.

doc/7/controllers/security/search-api-keys/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
code: true
33
type: page
44
title: searchApiKeys
5-
description: Searches for an user API keys.
5+
description: Searches for a user API keys.
66
---
77

88
# searchApiKeys
@@ -11,7 +11,7 @@ description: Searches for an user API keys.
1111

1212
<SinceBadge version="Kuzzle 2.1.0" />
1313

14-
Searches for an user API keys.
14+
Searches for a user API keys.
1515

1616
<br />
1717

doc/7/controllers/security/search-api-keys/snippets/search-api-keys.test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: security#searchApiKeys
2-
description: Searches for an user API keys
2+
description: Searches for a user API keys
33
hooks:
44
before: >
55
curl --fail -H "Content-type: application/json" -d '{

doc/7/getting-started/.react-native/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"ios": "node_modules/.bin/expo-cli start --ios",
88
"web": "node_modules/.bin/expo-cli start --web",
99
"eject": "node_modules/.bin/expo-cli eject",
10-
"test": "node_modules/.bin/cypress run --record"
10+
"test": "node_modules/.bin/cypress run --record --key $CYPRESS_RECORD_KEY_DOC"
1111
},
1212
"dependencies": {
1313
"cypress": "^3.8.1",

doc/7/getting-started/.react/with-redux/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
"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",
1717
"start": "react-scripts start",
1818
"build": "react-scripts build",
19-
"test": "./node_modules/.bin/cypress run --record",
19+
"test": "./node_modules/.bin/cypress run --record --key $CYPRESS_RECORD_KEY_DOC",
2020
"eject": "react-scripts eject"
2121
},
2222
"eslintConfig": {

doc/7/getting-started/.vuejs/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"serve-with-vuex": "cd with-vuex && vue-cli-service serve",
1111
"build-with-vuex": "cd with-vuex && vue-cli-service build",
1212
"lint-with-vuex": "cd with-vuex && vue-cli-service lint",
13-
"test": "./node_modules/.bin/cypress run --record"
13+
"test": "./node_modules/.bin/cypress run --record --key $CYPRESS_RECORD_KEY_DOC"
1414
},
1515
"dependencies": {
1616
"core-js": "^2.6.5",

src/controllers/Security.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ class SecurityController extends BaseController {
6161
}
6262

6363
/**
64-
* Searches for an user API key.
64+
* Searches for a user API key.
6565
*
6666
* @param {String} userId - User kuid
6767
* @param {Object} [query] - Search query

0 commit comments

Comments
 (0)