Skip to content

Commit d0ab528

Browse files
rolljeerolljee
authored
Merge pull request #752 from kuzzleio/docs/add-options-doc-to-controllers
docs: add options doc to controllers
2 parents bb01572 + e7b34aa commit d0ab528

File tree

241 files changed

+738
-295
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

241 files changed

+738
-295
lines changed

‎doc/7/controllers/auth/check-rights/index.md‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ Checks if the provided API request can be executed by the current logged user.
1515
---
1616

1717
```js
18-
checkRights(requestPayload)
18+
checkRights(requestPayload, [options])
1919
```
2020

2121
| Property | Type | Description |
2222
| ---------------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------- |
23-
| `requestPayload` | <pre>object</pre> | Contains a [RequestPayload](/core/2/api/payloads/request) |
24-
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre> | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
23+
| `requestPayload` | <pre>object</pre> | Contains a [RequestPayload](/core/2/api/payloads/request)
24+
| `options` | <pre>object</pre> | Query options |
2525

2626
## `requestPayload`
2727

@@ -31,7 +31,13 @@ The [RequestPayload](/core/2/api/payloads/request) must contains at least the fo
3131
- `action`: API action
3232

3333
---
34+
### options
3435

36+
| Property | Type<br />(default) | Description |
37+
| --- | --- | --- |
38+
| `queuable` | <pre>boolean</pre><br />(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again |
39+
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre><br/> (`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
40+
| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | <pre>boolean</pre> <br/>(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. <SinceBadge version="Kuzzle 2.31.0"/> |
3541
## Resolves
3642

3743
A boolean telling whether the provided request would have been allowed or not.

‎doc/7/controllers/auth/check-token/index.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,16 @@ checkToken([token]);
2222
| Property | Type | Description |
2323
| -------- | ----------------- | ----------- |
2424
| `token` | <pre>string</pre> | Optional authentication token |
25-
25+
| `options` | <pre>object</pre> | Query options |
2626
### options
2727

2828
Additional query options
2929

3030
| Property | Type<br/>(default) | Description |
3131
| ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
32-
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre> | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
32+
| `queuable` | <pre>boolean</pre><br />(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again |
33+
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre><br/> (`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
34+
| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | <pre>boolean</pre> <br/>(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. <SinceBadge version="Kuzzle 2.31.0"/> |
3335

3436
## Resolves
3537

‎doc/7/controllers/auth/create-api-key/index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,9 @@ Additional query options
3535
| `expiresIn` | <pre>string/number</pre><br />(`-1`) | Expiration duration |
3636
| `_id` | <pre>string</pre><br />(`null`) | API key unique ID |
3737
| `refresh` | <pre>boolean</pre><br />(`false`) | If set to `wait_for`, Kuzzle will not respond until the API key is indexed |
38+
| `queuable` | <pre>boolean</pre><br />(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again |
3839
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre><br/>(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
40+
| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | <pre>boolean</pre> <br/>(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. <SinceBadge version="Kuzzle 2.31.0"/> |
3941

4042
**Notes**:
4143
- `expiresIn`:

‎doc/7/controllers/auth/create-my-credentials/index.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,9 @@ Additional query options
2929

3030
| Property | Type<br/>(default) | Description |
3131
| ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
32-
| `queuable` | <pre>boolean</pre><br/>(`true`) | If true, queues the request during downtime, until connected to Kuzzle again |
33-
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre> | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
32+
| `queuable` | <pre>boolean</pre><br/>(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again |
33+
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre><br/> (`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
34+
| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | <pre>boolean</pre> <br/>(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. <SinceBadge version="Kuzzle 2.31.0"/> |
3435

3536
## Resolves
3637

‎doc/7/controllers/auth/credentials-exist/index.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,9 @@ Additional query options
2828

2929
| Property | Type<br/>(default) | Description |
3030
| ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
31-
| `queuable` | <pre>boolean</pre><br/>(`true`) | If true, queues the request during downtime, until connected to Kuzzle again |
32-
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre> | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
31+
| `queuable` | <pre>boolean</pre><br/>(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again |
32+
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre><br/> (`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
33+
| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | <pre>boolean</pre> <br/>(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. <SinceBadge version="Kuzzle 2.31.0"/> |
3334

3435
## Resolves
3536

‎doc/7/controllers/auth/delete-api-key/index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ Additional query options
3333
| Property | Type<br />(default) | Description |
3434
| --------- | --------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
3535
| `refresh` | <pre>boolean</pre><br />(`false`) | If set to `wait_for`, Kuzzle will not respond until the API key is indexed |
36+
| `queuable` | <pre>boolean</pre><br />(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again |
3637
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre><br/>(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
38+
| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | <pre>boolean</pre> <br/>(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. <SinceBadge version="Kuzzle 2.31.0"/> |
3739

3840
## Resolves
3941

‎doc/7/controllers/auth/delete-my-credentials/index.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,9 @@ Additional query options
3232

3333
| Property | Type<br/>(default) | Description |
3434
| ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
35-
| `queuable` | <pre>boolean</pre><br/>(`true`) | If true, queues the request during downtime, until connected to Kuzzle again |
36-
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre> | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
35+
| `queuable` | <pre>boolean</pre><br/>(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again |
36+
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre><br/> (`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
37+
| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | <pre>boolean</pre> <br/>(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. <SinceBadge version="Kuzzle 2.31.0"/> |
3738

3839
## Resolves
3940

‎doc/7/controllers/auth/get-current-user/index.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@ Additional query options
2727

2828
| Property | Type<br/>(default) | Description |
2929
| ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
30-
| `queuable` | <pre>boolean</pre><br/>(`true`) | If true, queues the request during downtime, until connected to Kuzzle again |
31-
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre> | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
30+
| `queuable` | <pre>boolean</pre><br/>(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again |
31+
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre><br/> (`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
32+
| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | <pre>boolean</pre> <br/>(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. <SinceBadge version="Kuzzle 2.31.0"/> |
3233

3334
## Resolves
3435

‎doc/7/controllers/auth/get-my-credentials/index.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,9 @@ Additional query options
3232

3333
| Property | Type<br/>(default) | Description |
3434
| ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
35-
| `queuable` | <pre>boolean</pre><br/>(`true`) | If true, queues the request during downtime, until connected to Kuzzle again |
36-
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre> | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
35+
| `queuable` | <pre>boolean</pre><br/>(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again |
36+
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre><br/> (`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
37+
| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | <pre>boolean</pre> <br/>(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. <SinceBadge version="Kuzzle 2.31.0"/> |
3738

3839
## Resolves
3940

‎doc/7/controllers/auth/get-my-rights/index.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ Additional query options
2828
| Property | Type<br/>(default) | Description |
2929
| ---------- | ------------------------------- | --------------------------------- |
3030
| `queuable` | <pre>boolean</pre><br/>(`true`) | Make this request queuable or not |
31-
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre> | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
31+
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre><br/> (`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
32+
| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | <pre>boolean</pre> <br/>(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. <SinceBadge version="Kuzzle 2.31.0"/> |
3233

3334
## Resolves
3435

0 commit comments

Comments
 (0)