From 3e0d0702cf3f8eaa8545c5dc74c7083963a3295e Mon Sep 17 00:00:00 2001 From: Kuruyia Date: Mon, 7 Oct 2024 14:54:19 +0200 Subject: [PATCH] docs: fix some inline code blocks --- .../security/m-delete-users/index.md | 9 +++-- .../security/update-profile/index.md | 10 +++--- .../request/introduction/index.md | 35 +++++++++---------- 3 files changed, 26 insertions(+), 28 deletions(-) diff --git a/doc/2/controllers/security/m-delete-users/index.md b/doc/2/controllers/security/m-delete-users/index.md index f0294da5..5ae833f1 100644 --- a/doc/2/controllers/security/m-delete-users/index.md +++ b/doc/2/controllers/security/m-delete-users/index.md @@ -20,11 +20,10 @@ Throws a partial error (error code 206) if one or more user deletions fail.
-| Property | Type | Description | -|--- |--- |--- | -| `ids` | 
List
| Array of user [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) | - -| `waitForRefresh` | 
bool

(`null`) | If set to `true`, Kuzzle will not respond until the users deletion is indexed | +| Property | Type | Description | +| ---------------- | -------------------- | --------------------------------------------------------------------------------------------- | +| `ids` | `List` | Array of user [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) | +| `waitForRefresh` | `bool`
(`null`) | If set to `true`, Kuzzle will not respond until the users deletion is indexed | ## Return diff --git a/doc/2/controllers/security/update-profile/index.md b/doc/2/controllers/security/update-profile/index.md index d1bf05f2..ef5e5456 100644 --- a/doc/2/controllers/security/update-profile/index.md +++ b/doc/2/controllers/security/update-profile/index.md @@ -18,11 +18,11 @@ Updates a security profile definition.
-| Property | Type | Description | -|--- |--- |--- | -| `id` | 
String
| Profile identifier | -| `policies` | 
List
| [Profile definition content](/core/2/guides/main-concepts/permissions#profiles) | -| `waitForRefresh` | 
bool

(`null`) | If set to `true`, Kuzzle will not respond until the created profile is indexed | +| Property | Type | Description | +| ---------------- | -------------------- | ------------------------------------------------------------------------------- | +| `id` | `String` | Profile identifier | +| `policies` | `List` | [Profile definition content](/core/2/guides/main-concepts/permissions#profiles) | +| `waitForRefresh` | `bool`
(`null`) | If set to `true`, Kuzzle will not respond until the created profile is indexed | ## Return diff --git a/doc/2/core-classes/request/introduction/index.md b/doc/2/core-classes/request/introduction/index.md index be91aa39..bc077ac4 100644 --- a/doc/2/core-classes/request/introduction/index.md +++ b/doc/2/core-classes/request/introduction/index.md @@ -10,26 +10,25 @@ order: 0 `KuzzleRequest` is a **serializable** class representing a raw Kuzzle request. - ## Properties -| Property | Type | Description | -|--- |--- |--- | -| `action` | 
String
| Executed Kuzzle API controller's action ` -| `body` | 
Map 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
| Volatile data | -| `from` | 
int

(`0`) | Offset of the first document to fetch | -| `size` | 
int

(`10`) | Maximum number of documents to retrieve per page | -| `scroll` | 
String

(`""`) | 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
| 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 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` | Volatile data | +| `from` | `int`
(`0`) | Offset of the first document to fetch | +| `size` | `int`
(`10`) | Maximum number of documents to retrieve per page | +| `scroll` | `String`
(`""`) | 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` | 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