Skip to content

Commit ba1f077

Browse files
KuruyiaKuruyia
committed
docs: fix some inline code blocks
1 parent 942a183 commit ba1f077

File tree

3 files changed

+83
-86
lines changed

3 files changed

+83
-86
lines changed

‎doc/1/controllers/collection/list/index.md

+25-27
Original file line numberDiff line numberDiff line change
@@ -22,32 +22,31 @@ public CompletableFuture<Map<String, Object>> list(
2222
final String index) throws NotConnectedException, InternalException
2323
```
2424

25-
26-
| Arguments | Type | Description |
27-
| --------- | ---------------------- | ------------- |
28-
| `index` | <pre>String</pre> | Index name |
25+
| Arguments | Type | Description |
26+
| --------- | -------- | ----------- |
27+
| `index` | `String` | Index name |
2928

3029
## Returns
3130

3231
Returns a `Map<String, Object>` containing the following properties:
3332

3433
| Property | Type | Description |
3534
| ------------- | ------------------- | ------------------------------------------------------------------ |
36-
| `type` | <pre>String</pre> | Types of returned collections <br/>(`all`, `realtime` or `stored`) |
37-
| `collections` | <pre>ArrayList<Object></pre> | List of collections |
38-
| `from` | <pre>Integer</pre> | Offset of the first result |
39-
| `size` | <pre>Integer</pre> | Maximum number of returned results |
35+
| `type` | `String` | Types of returned collections <br/>(`all`, `realtime` or `stored`) |
36+
| `collections` | `ArrayList<Object>` | List of collections |
37+
| `from` | `Integer` | Offset of the first result |
38+
| `size` | `Integer` | Maximum number of returned results |
4039

4140
Each object in the `collections` array contains the following properties:
4241

43-
| Property | Type | Description |
44-
| -------- | ----------------- | ---------------------------------------- |
45-
| `name` | <pre>String</pre> | Collection name |
46-
| `type` | <pre>String</pre> | Collection type (`realtime` or `stored`) |
42+
| Property | Type | Description |
43+
| -------- | -------- | ---------------------------------------- |
44+
| `name` | `String` | Collection name |
45+
| `type` | `String` | Collection type (`realtime` or `stored`) |
4746

4847
## Usage
4948

50-
<<< ./snippets/list-java.java
49+
\<\<\< ./snippets/list-java.java
5150

5251
:::
5352
::: tab Kotlin
@@ -58,32 +57,31 @@ Each object in the `collections` array contains the following properties:
5857
fun list(index: String): CompletableFuture<Map<String, Any?>>
5958
```
6059

61-
62-
| Arguments | Type | Description |
63-
| --------- | ---------------------- | ------------- |
64-
| `index` | <pre>String</pre> | Index name |
60+
| Arguments | Type | Description |
61+
| --------- | -------- | ----------- |
62+
| `index` | `String` | Index name |
6563

6664
## Returns
6765

6866
Returns a `Map<String, Any?>` containing the following properties:
6967

7068
| Property | Type | Description |
7169
| ------------- | ------------------- | ------------------------------------------------------------------ |
72-
| `type` | <pre>String</pre> | Types of returned collections <br/>(`all`, `realtime` or `stored`) |
73-
| `collections` | <pre>ArrayList<Object></pre> | List of collections |
74-
| `from` | <pre>Int</pre> | Offset of the first result |
75-
| `size` | <pre>Int</pre> | Maximum number of returned results |
70+
| `type` | `String` | Types of returned collections <br/>(`all`, `realtime` or `stored`) |
71+
| `collections` | `ArrayList<Object>` | List of collections |
72+
| `from` | `Int` | Offset of the first result |
73+
| `size` | `Int` | Maximum number of returned results |
7674

7775
Each object in the `collections` array contains the following properties:
7876

79-
| Property | Type | Description |
80-
| -------- | ----------------- | ---------------------------------------- |
81-
| `name` | <pre>String</pre> | Collection name |
82-
| `type` | <pre>String</pre> | Collection type (`realtime` or `stored`) |
77+
| Property | Type | Description |
78+
| -------- | -------- | ---------------------------------------- |
79+
| `name` | `String` | Collection name |
80+
| `type` | `String` | Collection type (`realtime` or `stored`) |
8381

8482
## Usage
8583

86-
<<< ./snippets/list-kotlin.kt
84+
\<\<\< ./snippets/list-kotlin.kt
8785

8886
:::
89-
::::
87+
::::

‎doc/1/controllers/collection/validate-specifications/index.md

+23-23
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ When the validation specification is not formatted correctly, a detailed error m
2727

2828
<br/>
2929

30-
| Arguments | Type | Description |
31-
| ---------------- | -------------------------------------------- | -------------------------- |
32-
| `index` | <pre>String</pre> | Index name |
33-
| `collection` | <pre>String</pre> | Collection name |
34-
| `specifications` | <pre>Map<String, Object></pre> | Specifications to validate |
30+
| Arguments | Type | Description |
31+
| ---------------- | --------------------- | -------------------------- |
32+
| `index` | `String` | Index name |
33+
| `collection` | `String` | Collection name |
34+
| `specifications` | `Map<String, Object>` | Specifications to validate |
3535

3636
### specifications
3737

@@ -45,15 +45,15 @@ Returns a `Map<String, Object>` which contains information about the specificati
4545

4646
It contains the following properties:
4747

48-
| Property | Type | Description |
49-
| ------------- | ---------------------------- | ---------------------------- |
50-
| `valid` | <pre>Boolean</pre> | Specifications validity |
51-
| `details` | <pre>ArrayList<String></pre> | Specifications errors |
52-
| `description` | <pre>String</pre> | Global description of errors |
48+
| Property | Type | Description |
49+
| ------------- | ------------------- | ---------------------------- |
50+
| `valid` | `Boolean` | Specifications validity |
51+
| `details` | `ArrayList<String>` | Specifications errors |
52+
| `description` | `String` | Global description of errors |
5353

5454
## Usage
5555

56-
<<< ./snippets/validate-specifications-java.java
56+
\<\<\< ./snippets/validate-specifications-java.java
5757

5858
:::
5959
::: tab Kotlin
@@ -70,11 +70,11 @@ fun validateSpecifications(
7070

7171
<br/>
7272

73-
| Arguments | Type | Description |
74-
| ---------------- | -------------------------------------------- | -------------------------- |
75-
| `index` | <pre>String</pre> | Index name |
76-
| `collection` | <pre>String</pre> | Collection name |
77-
| `specifications` | <pre>Map<String, Any?></pre> | Specifications to validate |
73+
| Arguments | Type | Description |
74+
| ---------------- | ------------------- | -------------------------- |
75+
| `index` | `String` | Index name |
76+
| `collection` | `String` | Collection name |
77+
| `specifications` | `Map<String, Any?>` | Specifications to validate |
7878

7979
### specifications
8080

@@ -88,15 +88,15 @@ Returns a `Map<String, Any?>` which contains information about the specification
8888

8989
It contains the following properties:
9090

91-
| Property | Type | Description |
92-
| ------------- | ---------------------------- | ---------------------------- |
93-
| `valid` | <pre>Boolean</pre> | Specifications validity |
94-
| `details` | <pre>ArrayList<String></pre> | Specifications errors |
95-
| `description` | <pre>String</pre> | Global description of errors
91+
| Property | Type | Description |
92+
| ------------- | ------------------- | ---------------------------- |
93+
| `valid` | `Boolean` | Specifications validity |
94+
| `details` | `ArrayList<String>` | Specifications errors |
95+
| `description` | `String` | Global description of errors |
9696

9797
## Usage
9898

99-
<<< ./snippets/validate-specifications-kotlin.kt
99+
\<\<\< ./snippets/validate-specifications-kotlin.kt
100100

101101
:::
102-
::::
102+
::::

‎doc/1/core-classes/kuzzle/query/index.md

+35-36
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,15 @@ public CompletableFuture<Response> query(
4646

4747
<br/>
4848

49-
| Argument | Type | Description |
50-
| -------- | ------------------------ | ----------- |
51-
| `query` | <pre>Map<String, Object> | API request |
49+
| Argument | Type | Description |
50+
| -------- | --------------------- | ----------- |
51+
| `query` | `Map<String, Object>` | API request |
5252

5353
<SinceBadge version="1.2.3"/>
5454

55-
| Argument | Type | Description |
56-
| -------- | ------------------------------------------------------------------------------------------- | ----------- |
57-
| `query` | <pre>Map<String, Object><br>or String<br>or RawJson<br>or RequestPayload<br>or Object</pre> | API request |
55+
| Argument | Type | Description |
56+
| -------- | ------------------------------------------------------------------------ | ----------- |
57+
| `query` | `Map<String, Object>`, `String`, `RawJson`, `RequestPayload` or `Object` | API request |
5858

5959
::: info
6060
Calling query with a `String` or `RawJson` makes no differences, and will be interpreted as raw json strings.
@@ -74,25 +74,24 @@ This will avoid the deserialization + reserialization slowdown
7474
All properties necessary for the Kuzzle API can be added in the query object.
7575
The following properties are the most common.
7676

77-
| Property | Type | Description |
78-
| ------------ | --------------------------------------------------------- | ---------------------------------------- |
79-
| `controller` | <pre>String</pre> | Controller name (mandatory) |
80-
| `action` | <pre>String</pre> | Action name (mandatory) |
81-
| `body` | <pre>Map<String, Object><br>or RawJson<br>or Object</pre> | Query body for this action |
82-
| `index` | <pre>String</pre> | Index name for this action |
83-
| `collection` | <pre>String</pre> | Collection name for this action |
84-
| `_id` | <pre>String</pre> | id for this action |
85-
| `volatile` | <pre>Map<String, Object><br>or RawJson<br>or Object</pre> | Additional information to send to Kuzzle |
86-
| `headers` | <pre>Map<String, Object></pre> | Optionnal headers to send (HTTP Only) |
87-
77+
| Property | Type | Description |
78+
| ------------ | -------------------------------------------- | ---------------------------------------- |
79+
| `controller` | `String` | Controller name (mandatory) |
80+
| `action` | `String` | Action name (mandatory) |
81+
| `body` | `Map<String, Object>`, `RawJson` or `Object` | Query body for this action |
82+
| `index` | `String` | Index name for this action |
83+
| `collection` | `String` | Collection name for this action |
84+
| `_id` | `String` | id for this action |
85+
| `volatile` | `Map<String, Object>`, `RawJson` or `Object` | Additional information to send to Kuzzle |
86+
| `headers` | `Map<String, Object>` | Optionnal headers to send (HTTP Only) |
8887

8988
## Returns
9089

9190
Returns a [Response](/sdk/jvm/1/core-classes/response) object which represents a raw Kuzzle API response. See the [API Documentation](/core/2/api).
9291

9392
## Usage
9493

95-
<<< ./snippets/query-java.java
94+
\<\<\< ./snippets/query-java.java
9695

9796
:::
9897
::: tab Kotlin
@@ -114,15 +113,15 @@ fun query(query: Any): CompletableFuture<Response>
114113

115114
<br/>
116115

117-
| Argument | Type | Description |
118-
| -------- | ----------------------- | ----------- |
119-
| `query` | <pre>Map<String?, Any?> | API request |
116+
| Argument | Type | Description |
117+
| -------- | ------------------------ | ----------- |
118+
| `query` | `Map<String?, Any?>` | API request |
120119

121120
<SinceBadge version="1.2.3"/>
122121

123-
| Argument | Type | Description |
124-
| -------- | --------------------------------------------------------------------------------------- | ----------- |
125-
| `query` | <pre>Map<String?, Any?><br>or RawJson<br>or String<br>or RequestPayload<br>or Any</pre> | API request |
122+
| Argument | Type | Description |
123+
| -------- | -------------------------------------------------------------------- | ----------- |
124+
| `query` | `Map<String?, Any?>`, `RawJson`, `String`, `RequestPayload` or `Any` | API request |
126125

127126
::: info
128127
Calling query with a `String` or `RawJson` makes no differences, and will be interpreted as raw json strings.
@@ -142,24 +141,24 @@ This will avoid the deserialization + reserialization slowdown
142141
All properties necessary for the Kuzzle API can be added in the query object.
143142
The following properties are the most common.
144143

145-
| Property | Type | Description |
146-
| ------------ | ---------------------------------------------------- | ---------------------------------------- |
147-
| `controller` | <pre>String</pre> | Controller name (mandatory) |
148-
| `action` | <pre>String</pre> | Action name (mandatory) |
149-
| `body` | <pre>Map<String, Any?><br>or RawJson<br>or Any</pre> | Query body for this action |
150-
| `index` | <pre>String</pre> | Index name for this action |
151-
| `collection` | <pre>String</pre> | Collection name for this action |
152-
| `_id` | <pre>String</pre> | id for this action |
153-
| `volatile` | <pre>Map<String, Any?><br>or RawJson<br>or Any</pre> | Additional information to send to Kuzzle |
154-
| `headers` | <pre>Map<String, Any?></pre> | Optionnal headers to send (HTTP Only) |
144+
| Property | Type | Description |
145+
| ------------ | ----------------------------------------- | ---------------------------------------- |
146+
| `controller` | `String` | Controller name (mandatory) |
147+
| `action` | `String` | Action name (mandatory) |
148+
| `body` | `Map<String, Object>`, `RawJson` or `Any` | Query body for this action |
149+
| `index` | `String` | Index name for this action |
150+
| `collection` | `String` | Collection name for this action |
151+
| `_id` | `String` | id for this action |
152+
| `volatile` | `Map<String, Object>`, `RawJson` or `Any` | Additional information to send to Kuzzle |
153+
| `headers` | `Map<String, Any?>` | Optionnal headers to send (HTTP Only) |
155154

156155
## Returns
157156

158157
Returns a [Response](/sdk/jvm/1/core-classes/response) object which represents a raw Kuzzle API response. See the [API Documentation](/core/2/api).
159158

160159
## Usage
161160

162-
<<< ./snippets/query-kotlin.kt
161+
\<\<\< ./snippets/query-kotlin.kt
163162

164163
:::
165-
::::
164+
::::

0 commit comments

Comments
 (0)