Skip to content

Commit 8a269a6

Browse files
add overview
1 parent e5f0624 commit 8a269a6

File tree

2 files changed

+73
-58
lines changed

2 files changed

+73
-58
lines changed

docs.json

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,21 @@
157157
"anchors": [
158158
{
159159
"anchor": "Open API",
160-
"openapi": "openapi.json"
160+
"groups": [
161+
{
162+
"group": "test",
163+
"pages": [
164+
"learn/getting_started/cloud_quick_start"
165+
]
166+
},
167+
{
168+
"group": "Endpoints",
169+
"openapi": {
170+
"source": "openapi.json",
171+
"directory": "endpoints"
172+
}
173+
}
174+
]
161175
},
162176
{
163177
"anchor": "Learn",

openapi.json

Lines changed: 58 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -20,60 +20,6 @@
2020
}
2121
],
2222
"paths": {
23-
"/dumps": {
24-
"post": {
25-
"tags": [
26-
"Dumps"
27-
],
28-
"summary": "Create a dump",
29-
"description": "Triggers a dump creation process. Once the process is complete, a dump is created in the\n[dump directory](https://www.meilisearch.com/docs/learn/self_hosted/configure_meilisearch_at_launch#dump-directory).\nIf the dump directory does not exist yet, it will be created.",
30-
"operationId": "create_dump",
31-
"responses": {
32-
"202": {
33-
"description": "Dump is being created",
34-
"content": {
35-
"application/json": {
36-
"schema": {
37-
"$ref": "#/components/schemas/SummarizedTaskView"
38-
},
39-
"example": {
40-
"taskUid": 0,
41-
"indexUid": null,
42-
"status": "enqueued",
43-
"type": "DumpCreation",
44-
"enqueuedAt": "2021-01-01T09:39:00.000000Z"
45-
}
46-
}
47-
}
48-
},
49-
"401": {
50-
"description": "The authorization header is missing",
51-
"content": {
52-
"application/json": {
53-
"schema": {
54-
"$ref": "#/components/schemas/ResponseError"
55-
},
56-
"example": {
57-
"message": "The Authorization header is missing. It must use the bearer authorization method.",
58-
"code": "missing_authorization_header",
59-
"type": "auth",
60-
"link": "https://docs.meilisearch.com/errors#missing_authorization_header"
61-
}
62-
}
63-
}
64-
}
65-
},
66-
"security": [
67-
{
68-
"Bearer": [
69-
"dumps.create",
70-
"dumps.*",
71-
"*"
72-
]
73-
}
74-
]
75-
}
76-
},
7723
"/batches": {
7824
"get": {
7925
"tags": [
@@ -375,7 +321,7 @@
375321
"/batches/{batchUid}": {
376322
"get": {
377323
"tags": [
378-
"Batches"
324+
"Batch number 2"
379325
],
380326
"summary": "Get one batch",
381327
"description": "Get a single batch.",
@@ -454,6 +400,60 @@
454400
]
455401
}
456402
},
403+
"/dumps": {
404+
"post": {
405+
"tags": [
406+
"Dumps1"
407+
],
408+
"summary": "Create a dumppty",
409+
"description": "Triggers a dump creation process. Once the process is complete, a dump is created in the\n[dump directory](https://www.meilisearch.com/docs/learn/self_hosted/configure_meilisearch_at_launch#dump-directory).\nIf the dump directory does not exist yet, it will be created.",
410+
"operationId": "create_dump",
411+
"responses": {
412+
"202": {
413+
"description": "Dump is being created",
414+
"content": {
415+
"application/json": {
416+
"schema": {
417+
"$ref": "#/components/schemas/SummarizedTaskView"
418+
},
419+
"example": {
420+
"taskUid": 0,
421+
"indexUid": null,
422+
"status": "enqueued",
423+
"type": "DumpCreation",
424+
"enqueuedAt": "2021-01-01T09:39:00.000000Z"
425+
}
426+
}
427+
}
428+
},
429+
"401": {
430+
"description": "The authorization header is missing",
431+
"content": {
432+
"application/json": {
433+
"schema": {
434+
"$ref": "#/components/schemas/ResponseError"
435+
},
436+
"example": {
437+
"message": "The Authorization header is missing. It must use the bearer authorization method.",
438+
"code": "missing_authorization_header",
439+
"type": "auth",
440+
"link": "https://docs.meilisearch.com/errors#missing_authorization_header"
441+
}
442+
}
443+
}
444+
}
445+
},
446+
"security": [
447+
{
448+
"Bearer": [
449+
"dumps.create",
450+
"dumps.*",
451+
"*"
452+
]
453+
}
454+
]
455+
}
456+
},
457457

458458
"/experimental-features": {
459459
"get": {
@@ -14848,10 +14848,11 @@
1484814848
}
1484914849
},
1485014850
{
14851-
"name": "Dumps",
14851+
"name": "Dumps2",
1485214852
"description": "The `dumps` route allows the creation of database dumps.\nDumps are `.dump` files that can be used to launch Meilisearch. Dumps are compatible between Meilisearch versions.\nCreating a dump is also referred to as exporting it, whereas launching Meilisearch with a dump is referred to as importing it.\nDuring a [dump export](https://www.meilisearch.com/docs/reference/api/dump#create-a-dump), all indexes of the current instance are\nexported—together with their documents and settings—and saved as a single `.dump` file. During a dump import,\nall indexes contained in the indicated `.dump` file are imported along with their associated documents and settings.\nAny existing index with the same uid as an index in the dump file will be overwritten.\nDump imports are [performed at launch](https://www.meilisearch.com/docs/learn/advanced/dumps#importing-a-dump) using an option.",
1485314853
"externalDocs": {
14854-
"url": "https://www.meilisearch.com/docs/reference/api/dump"
14854+
"url": "https://www.meilisearch.com/docs/reference/api/dump",
14855+
"description": "lorem ipsum"
1485514856
}
1485614857
},
1485714858
{

0 commit comments

Comments
 (0)