Skip to content

Commit

Permalink
docs: fix some inline code blocks
Browse files Browse the repository at this point in the history
  • Loading branch information
Kuruyia committed Oct 7, 2024
1 parent c635b9c commit 3e0d070
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 28 deletions.
9 changes: 4 additions & 5 deletions doc/2/controllers/security/m-delete-users/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,10 @@ Throws a partial error (error code 206) if one or more user deletions fail.

<br />

| Property | Type | Description |
|--- |--- |--- |
| `ids` | <pre>List<String></pre> | Array of user [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) |

| `waitForRefresh` | <pre>bool</pre><br />(`null`) | If set to `true`, Kuzzle will not respond until the users deletion is indexed |
| Property | Type | Description |
| ---------------- | -------------------- | --------------------------------------------------------------------------------------------- |
| `ids` | `List<String>` | Array of user [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) |
| `waitForRefresh` | `bool`<br />(`null`) | If set to `true`, Kuzzle will not respond until the users deletion is indexed |

## Return

Expand Down
10 changes: 5 additions & 5 deletions doc/2/controllers/security/update-profile/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ Updates a security profile definition.

<br />

| Property | Type | Description |
|--- |--- |--- |
| `id` | <pre>String</pre> | Profile identifier |
| `policies` | <pre>List<dynamic></pre> | [Profile definition content](/core/2/guides/main-concepts/permissions#profiles) |
| `waitForRefresh` | <pre>bool</pre><br />(`null`) | If set to `true`, Kuzzle will not respond until the created profile is indexed |
| Property | Type | Description |
| ---------------- | -------------------- | ------------------------------------------------------------------------------- |
| `id` | `String` | Profile identifier |
| `policies` | `List<dynamic>` | [Profile definition content](/core/2/guides/main-concepts/permissions#profiles) |
| `waitForRefresh` | `bool`<br />(`null`) | If set to `true`, Kuzzle will not respond until the created profile is indexed |

## Return

Expand Down
35 changes: 17 additions & 18 deletions doc/2/core-classes/request/introduction/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,25 @@ order: 0

`KuzzleRequest` is a **serializable** class representing a raw Kuzzle request.


## Properties

| Property | Type | Description |
|--- |--- |--- |
| `action` | <pre>String</pre> | Executed Kuzzle API controller's action `
| `body` | <pre>Map<String, dynamic> body</pre> |
| `collection` | <pre>String</pre> | Impacted collection |
| `controller` | <pre>String</pre> | Executed Kuzzle API controller |
| `index` | <pre>String</pre> | Impacted index |
| `jwt` | <pre>String</pre> | Authentication token |
| `lang` | <pre>String</pre> | ES lang |
| `requestId` | <pre>String</pre> | Request unique identifier |
| `waitForRefresh` | <pre>bool</pre> | If set to `true`, Kuzzle will wait for the persistence layer to finish indexing |
| `volatile` | <pre>Map<String, dynamic></pre> | Volatile data |
| `from` | <pre>int</pre><br/>(`0`) | Offset of the first document to fetch |
| `size` | <pre>int</pre><br/>(`10`) | Maximum number of documents to retrieve per page |
| `scroll` | <pre>String</pre><br/>(`""`) | When set, gets a forward-only cursor having its ttl set to the given value (ie `1s`; cf [elasticsearch time limits](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/common-options.html#time-units)) |
| `scrollId` | <pre>String</pre> | The scrollId if using scroll option |
| `sort` | <pre>List<dynamic></pre> | Contains a list of fields, used to [sort search results](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/search-request-sort.html), in order of importance. |
| Property | Type | Description |
| ---------------- | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `action` | `String` | Executed Kuzzle API controller's action |
| `body` | `Map<String, dynamic> body` | |
| `collection` | `String` | Impacted collection |
| `controller` | `String` | Executed Kuzzle API controller |
| `index` | `String` | Impacted index |
| `jwt` | `String` | Authentication token |
| `lang` | `String` | ES lang |
| `requestId` | `String` | Request unique identifier |
| `waitForRefresh` | `bool` | If set to `true`, Kuzzle will wait for the persistence layer to finish indexing |
| `volatile` | `Map<String, dynamic>` | Volatile data |
| `from` | `int`<br/>(`0`) | Offset of the first document to fetch |
| `size` | `int`<br/>(`10`) | Maximum number of documents to retrieve per page |
| `scroll` | `String`<br/>(`""`) | When set, gets a forward-only cursor having its ttl set to the given value (ie `1s`; cf [elasticsearch time limits](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/common-options.html#time-units)) |
| `scrollId` | `String` | The scrollId if using scroll option |
| `sort` | `List<dynamic>` | Contains a list of fields, used to [sort search results](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/search-request-sort.html), in order of importance. |

## Overrided operators

Expand Down

0 comments on commit 3e0d070

Please sign in to comment.