Skip to content

Commit 80b66ea

Browse files
authored
Fix missing spacing in json blocks (#3112)
1 parent dc38fa1 commit 80b66ea

File tree

11 files changed

+140
-140
lines changed

11 files changed

+140
-140
lines changed

learn/configuration/configuring_index_settings_api.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,10 @@ Meilisearch will respond with a task object:
6262

6363
```json
6464
{
65-
"uid":1,
66-
"indexUid":"INDEX_NAME",
67-
"status":"succeeded",
68-
"type":"settingsUpdate",
65+
"uid": 1,
66+
"indexUid": "INDEX_NAME",
67+
"status": "succeeded",
68+
"type": "settingsUpdate",
6969
7070
}
7171
```

learn/filtering_and_sorting/search_with_facet_filters.mdx

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ First, create a new index using this <a id="downloadBooks" href="/assets/dataset
2424
"publisher": "Penguin Classics",
2525
"language": "English",
2626
"author": "Charles Dickens",
27-
"description":"Hard Times is a novel of social […] ",
27+
"description": "Hard Times is a novel of social […] ",
2828
"format": "Hardcover",
2929
"rating": 3
3030
}
@@ -46,29 +46,29 @@ The response returns all books matching the query. It also returns two fields yo
4646

4747
```json
4848
{
49-
"hits":[
49+
"hits": [
5050
5151
],
5252
53-
"facetDistribution":{
54-
"genres":{
55-
"Classics":6,
53+
"facetDistribution": {
54+
"genres": {
55+
"Classics": 6,
5656
5757
},
58-
"language":{
59-
"English":6,
60-
"French":1,
61-
"Spanish":1
58+
"language": {
59+
"English": 6,
60+
"French": 1,
61+
"Spanish": 1
6262
},
63-
"rating":{
64-
"2.5":1,
63+
"rating": {
64+
"2.5": 1,
6565
6666
}
6767
},
68-
"facetStats":{
69-
"rating":{
70-
"min":2.5,
71-
"max":4.7
68+
"facetStats": {
69+
"rating": {
70+
"min": 2.5,
71+
"max": 4.7
7272
}
7373
}
7474
}

learn/getting_started/primary_key.mdx

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -165,12 +165,12 @@ This error occurs when you add documents to an index for the first time and Meil
165165
"indexUid": "books",
166166
"status": "failed",
167167
"type": "documentAdditionOrUpdate",
168-
"canceledBy":null,
169-
"details":{
170-
"receivedDocuments":5,
171-
"indexedDocuments":5
168+
"canceledBy": null,
169+
"details": {
170+
"receivedDocuments": 5,
171+
"indexedDocuments": 5
172172
},
173-
"error":{
173+
"error": {
174174
"message": "The primary key inference failed as the engine found 2 fields ending with `id` in their names: 'id' and 'author_id'. Please specify the primary key manually using the `primaryKey` query parameter.",
175175
"code": "index_primary_key_multiple_candidates_found",
176176
"type": "invalid_request",
@@ -194,11 +194,11 @@ This error occurs when you add documents to an index for the first time and none
194194
"status": "failed",
195195
"type": "documentAdditionOrUpdate",
196196
"canceledBy": null,
197-
"details":{
197+
"details": {
198198
"receivedDocuments": 5,
199199
"indexedDocuments": null
200200
},
201-
"error":{
201+
"error": {
202202
"message": "The primary key inference failed as the engine did not find any field ending with `id` in its name. Please specify the primary key manually using the `primaryKey` query parameter.",
203203
"code": "index_primary_key_no_candidate_found",
204204
"type": "invalid_request",
@@ -217,16 +217,16 @@ This happens when your document id does not have the correct [format](#formattin
217217

218218
```json
219219
{
220-
"uid":1,
220+
"uid": 1,
221221
"indexUid": "books",
222222
"status": "failed",
223223
"type": "documentAdditionOrUpdate",
224224
"canceledBy": null,
225-
"details":{
226-
"receivedDocuments":5,
227-
"indexedDocuments":null
225+
"details": {
226+
"receivedDocuments": 5,
227+
"indexedDocuments": null
228228
},
229-
"error":{
229+
"error": {
230230
"message": "Document identifier `1@` is invalid. A document identifier can be of type integer or string, only composed of alphanumeric characters (a-z A-Z 0-9), hyphens (-) and underscores (_).",
231231
"code": "invalid_document_id",
232232
"type": "invalid_request",
@@ -245,16 +245,16 @@ This error occurs when your index already has a primary key, but one of the docu
245245

246246
```json
247247
{
248-
"uid":1,
248+
"uid": 1,
249249
"indexUid": "books",
250250
"status": "failed",
251251
"type": "documentAdditionOrUpdate",
252252
"canceledBy": null,
253-
"details":{
254-
"receivedDocuments":1,
255-
"indexedDocuments":null
253+
"details": {
254+
"receivedDocuments": 1,
255+
"indexedDocuments": null
256256
},
257-
"error":{
257+
"error": {
258258
"message": "Document doesn't have a `id` attribute: `{\"title\":\"Solaris\",\"author\":\"Stanislaw Lem\",\"genres\":[\"science fiction\"],\"price\":5.0.",
259259
"code": "missing_document_id",
260260
"type": "invalid_request",

learn/self_hosted/getting_started_with_self_hosted_meilisearch.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ If the document addition is successful, the response should look like this:
127127
"status": "succeeded",
128128
"type": "documentAdditionOrUpdate",
129129
"canceledBy": null,
130-
"details":{
130+
"details": {
131131
"receivedDocuments": 19547,
132132
"indexedDocuments": 19547
133133
},

reference/api/documents.mdx

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -58,32 +58,32 @@ Sending an empty payload (`--data-binary '{}'`) will return all documents in the
5858

5959
```json
6060
{
61-
"results":[
61+
"results": [
6262
{
63-
"title":"The Travels of Ibn Battuta",
64-
"genres":[
63+
"title": "The Travels of Ibn Battuta",
64+
"genres": [
6565
"Travel",
6666
"Adventure"
6767
],
68-
"language":"English",
69-
"rating":4.5
68+
"language": "English",
69+
"rating": 4.5
7070
},
7171
{
72-
"title":"Pride and Prejudice",
73-
"genres":[
72+
"title": "Pride and Prejudice",
73+
"genres": [
7474
"Classics",
7575
"Fiction",
7676
"Romance",
7777
"Literature"
7878
],
79-
"language":"English",
80-
"rating":4
79+
"language": "English",
80+
"rating": 4
8181
},
8282
8383
],
84-
"offset":0,
85-
"limit":3,
86-
"total":5
84+
"offset": 0,
85+
"limit": 3,
86+
"total": 5
8787
}
8888
```
8989

@@ -136,7 +136,7 @@ Using the query parameters `offset` and `limit`, you can browse through all your
136136

137137
```json
138138
{
139-
"results":[
139+
"results": [
140140
{
141141
"id": 364,
142142
"title": "Batman Returns",
@@ -150,7 +150,7 @@ Using the query parameters `offset` and `limit`, you can browse through all your
150150
},
151151
{
152152
"id": 13851,
153-
"title":" Batman: Gotham Knight",
153+
"title": " Batman: Gotham Knight",
154154
"overview": "A collection of key events mark Bruce Wayne's life as he journeys from beginner to Dark Knight.",
155155
"genres": [
156156
"Animation",

reference/api/facet_search.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,13 +57,13 @@ For example, searching for `Jane` will return `Jane Austen`, but searching for `
5757

5858
```json
5959
{
60-
"facetHits":[
60+
"facetHits": [
6161
{
62-
"value":"fiction",
63-
"count":7
62+
"value": "fiction",
63+
"count": 7
6464
}
6565
],
66-
"facetQuery":"fiction",
67-
"processingTimeMs":0
66+
"facetQuery": "fiction",
67+
"processingTimeMs": 0
6868
}
6969
```

reference/api/keys.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -213,9 +213,9 @@ Results can be paginated using the `offset` and `limit` query parameters.
213213
"updatedAt": "2021-08-11T10:00:00Z"
214214
}
215215
],
216-
"offset":0,
217-
"limit":3,
218-
"total":7
216+
"offset": 0,
217+
"limit": 3,
218+
"total": 7
219219
}
220220
```
221221

reference/api/multi_search.mdx

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -233,53 +233,53 @@ Each result in the `hits` array contains an additional `_federation` field with
233233

234234
```json
235235
{
236-
"results":[
236+
"results": [
237237
{
238-
"indexUid":"movies",
239-
"hits":[
238+
"indexUid": "movies",
239+
"hits": [
240240
{
241-
"id":13682,
242-
"title":"Pooh's Heffalump Movie",
241+
"id": 13682,
242+
"title": "Pooh's Heffalump Movie",
243243
244244
},
245245
246246
],
247-
"query":"pooh",
248-
"processingTimeMs":26,
249-
"limit":5,
250-
"offset":0,
251-
"estimatedTotalHits":22
247+
"query": "pooh",
248+
"processingTimeMs": 26,
249+
"limit": 5,
250+
"offset": 0,
251+
"estimatedTotalHits": 22
252252
},
253253
{
254-
"indexUid":"movies",
255-
"hits":[
254+
"indexUid": "movies",
255+
"hits": [
256256
{
257-
"id":12,
258-
"title":"Finding Nemo",
257+
"id": 12,
258+
"title": "Finding Nemo",
259259
260260
},
261261
262262
],
263-
"query":"nemo",
264-
"processingTimeMs":5,
265-
"limit":5,
266-
"offset":0,
267-
"estimatedTotalHits":11
263+
"query": "nemo",
264+
"processingTimeMs": 5,
265+
"limit": 5,
266+
"offset": 0,
267+
"estimatedTotalHits": 11
268268
},
269269
{
270-
"indexUid":"movie_ratings",
271-
"hits":[
270+
"indexUid": "movie_ratings",
271+
"hits": [
272272
{
273-
"id":"Us",
273+
"id": "Us",
274274
"director": "Jordan Peele",
275275
276276
}
277277
],
278-
"query":"Us",
279-
"processingTimeMs":0,
280-
"limit":20,
281-
"offset":0,
282-
"estimatedTotalHits":1
278+
"query": "Us",
279+
"processingTimeMs": 0,
280+
"limit": 20,
281+
"offset": 0,
282+
"estimatedTotalHits": 1
283283
}
284284
]
285285
}

reference/api/search.mdx

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -563,10 +563,10 @@ If an attribute used on `facets` has not been added to the `filterableAttributes
563563
```json
564564
{
565565
566-
"facetStats":{
567-
"rating":{
568-
"min":2.5,
569-
"max":4.7
566+
"facetStats": {
567+
"rating": {
568+
"min": 2.5,
569+
"max": 4.7
570570
}
571571
}
572572
@@ -586,25 +586,25 @@ The response shows the facet distribution for `genres` and `rating`. Since `rati
586586
```json
587587
{
588588
589-
"estimatedTotalHits":22,
590-
"query":"Batman",
591-
"facetDistribution":{
592-
"genres":{
593-
"Action":20,
594-
"Adventure":7,
589+
"estimatedTotalHits": 22,
590+
"query": "Batman",
591+
"facetDistribution": {
592+
"genres": {
593+
"Action": 20,
594+
"Adventure": 7,
595595
596-
"Thriller":3
596+
"Thriller": 3
597597
},
598-
"rating":{
599-
"2":1,
598+
"rating": {
599+
"2": 1,
600600
601-
"9.8":1
601+
"9.8": 1
602602
}
603603
},
604-
"facetStats":{
605-
"rating":{
606-
"min":2.0,
607-
"max":9.8
604+
"facetStats": {
605+
"rating": {
606+
"min": 2.0,
607+
"max": 9.8
608608
}
609609
}
610610
}

reference/api/settings.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -614,7 +614,7 @@ Partially update the faceting settings for an index. Any parameters not provided
614614
```
615615
{
616616
"maxValuesPerFacet": <Integer>,
617-
"sortFacetValuesBy":{
617+
"sortFacetValuesBy": {
618618
<String>: "count",
619619
<String>: "alpha"
620620
}

0 commit comments

Comments
 (0)