@@ -8,7 +8,14 @@ The `/indexes` route allows you to create, manage, and delete your indexes.
8
8
9
9
<RouteHighlighter method =" GET " route =" /indexes " />
10
10
11
- List all [ indexes] ( /learn/core_concepts/indexes.md ) .
11
+ List all [ indexes] ( /learn/core_concepts/indexes.md ) . Results can be paginated by using the ` offset ` and ` limit ` query parameters.
12
+
13
+ #### Query parameters
14
+
15
+ | Query parameter | Description | Default value |
16
+ | ------------------------ | --------------------------- | :-----------: |
17
+ | ** offset** | Number of indexes to skip | 0 |
18
+ | ** limit** | Number of indexes to return | 20 |
12
19
13
20
### Example
14
21
@@ -17,29 +24,31 @@ List all [indexes](/learn/core_concepts/indexes.md).
17
24
#### Response: ` 200 Ok `
18
25
19
26
``` json
20
- [
21
- {
22
- "uid" : " books" ,
23
- "name" : " books" ,
24
- "createdAt" : " 2022-03-08T10:00:27.377346Z" ,
25
- "updatedAt" : " 2022-03-08T10:00:27.391209Z" ,
26
- "primaryKey" : " id"
27
- },
28
- {
29
- "uid" : " meteorites" ,
30
- "name" : " meteorites" ,
31
- "createdAt" : " 2022-03-08T10:00:44.518768Z" ,
32
- "updatedAt" : " 2022-03-08T10:00:44.582083Z" ,
33
- "primaryKey" : " id"
34
- },
35
- {
36
- "uid" : " movies" ,
37
- "name" : " movies" ,
38
- "createdAt" : " 2022-02-10T07:45:15.628261Z" ,
39
- "updatedAt" : " 2022-02-21T15:28:43.496574Z" ,
40
- "primaryKey" : " id"
41
- }
42
- ]
27
+ {
28
+ "results" : [
29
+ {
30
+ "uid" : " books" ,
31
+ "createdAt" : " 2022-03-08T10:00:27.377346Z" ,
32
+ "updatedAt" : " 2022-03-08T10:00:27.391209Z" ,
33
+ "primaryKey" : " id"
34
+ },
35
+ {
36
+ "uid" : " meteorites" ,
37
+ "createdAt" : " 2022-03-08T10:00:44.518768Z" ,
38
+ "updatedAt" : " 2022-03-08T10:00:44.582083Z" ,
39
+ "primaryKey" : " id"
40
+ },
41
+ {
42
+ "uid" : " movies" ,
43
+ "createdAt" : " 2022-02-10T07:45:15.628261Z" ,
44
+ "updatedAt" : " 2022-02-21T15:28:43.496574Z" ,
45
+ "primaryKey" : " id"
46
+ }
47
+ ],
48
+ "offset" : 0 ,
49
+ "limit" : 3 ,
50
+ "total" : 5
51
+ }
43
52
```
44
53
45
54
## Get one index
@@ -57,7 +66,6 @@ Get information about an [index](/learn/core_concepts/indexes.md). The index [`u
57
66
``` json
58
67
{
59
68
"uid" : " movies" ,
60
- "name" : " movies" ,
61
69
"createdAt" : " 2022-02-10T07:45:15.628261Z" ,
62
70
"updatedAt" : " 2022-02-21T15:28:43.496574Z" ,
63
71
"primaryKey" : " id"
0 commit comments