File tree 3 files changed +61
-55
lines changed
openapi_spec/paths/indexes
3 files changed +61
-55
lines changed Original file line number Diff line number Diff line change @@ -12,33 +12,31 @@ post:
12
12
content :
13
13
application/json :
14
14
schema :
15
- allOf :
16
- - $ref : " ../../schemas/SearchParams.yml"
17
- - type : object
18
- properties :
19
- requests :
20
- type : array
21
- items :
22
- title : operation
15
+ type : object
16
+ properties :
17
+ requests :
18
+ type : array
19
+ items :
20
+ title : operation
21
+ type : object
22
+ additionalProperties : false
23
+ properties :
24
+ action :
25
+ type : string
26
+ enum :
27
+ - " addObject"
28
+ - " updateObject"
29
+ - " partialUpdateObject"
30
+ - " partialUpdateObjectNoCreate"
31
+ - " deleteObject"
32
+ - " delete"
33
+ - " clear"
34
+ description : type of operation
35
+ body :
23
36
type : object
24
- additionalProperties : false
25
- properties :
26
- action :
27
- type : string
28
- enum :
29
- - " addObject"
30
- - " updateObject"
31
- - " partialUpdateObject"
32
- - " partialUpdateObjectNoCreate"
33
- - " deleteObject"
34
- - " delete"
35
- - " clear"
36
- description : type of operation
37
- body :
38
- type : object
39
- # this could be a long oneOf with every possibilities
40
- additionalProperties : true
41
- description : arguments to the operation (depends on the type of the operation)
37
+ # this could be a long oneOf with every possibilities
38
+ additionalProperties : true
39
+ description : arguments to the operation (depends on the type of the operation)
42
40
responses :
43
41
" 200 " :
44
42
description : OK
Original file line number Diff line number Diff line change 24
24
type : object
25
25
additionalProperties : false
26
26
properties :
27
+ createdAt :
28
+ type : string
27
29
taskID :
28
- type : number
30
+ type : integer
29
31
objectID :
30
32
type : string
31
33
" 400 " :
Original file line number Diff line number Diff line change @@ -11,35 +11,41 @@ post:
11
11
content :
12
12
application/json :
13
13
schema :
14
- type : array
15
- items :
16
- title : multipleQueries
17
- type : object
18
- additionalProperties : false
19
- properties :
20
- indexName :
21
- type : string
22
- example : products
23
- description : The Algolia index name
24
- query :
25
- type : string
26
- description : The query to search for
27
- type :
28
- type : string
29
- enum : [default, facet]
30
- default : default
31
- description : Perform a search query with `default`, will search for facet values if `facet` is given
32
- facet :
33
- type : string
34
- description : The `facet` name
35
- params :
14
+ type : object
15
+ additionalProperties : false
16
+ properties :
17
+ requests :
18
+ type : array
19
+ items :
20
+ title : multipleQueries
36
21
type : object
37
- additionalProperties : true
38
- description : A key-value mapping of additional search parameters
39
- example :
40
- filters : " in_stock:true"
41
- required :
42
- - indexName
22
+ additionalProperties : false
23
+ properties :
24
+ indexName :
25
+ type : string
26
+ example : products
27
+ description : The Algolia index name
28
+ query :
29
+ type : string
30
+ description : The query to search for
31
+ type :
32
+ type : string
33
+ enum : [default, facet]
34
+ default : default
35
+ description : Perform a search query with `default`, will search for facet values if `facet` is given
36
+ facet :
37
+ type : string
38
+ description : The `facet` name
39
+ params :
40
+ type : string
41
+ description : A query string of search parameters
42
+ required :
43
+ - indexName
44
+ strategy :
45
+ type : string
46
+ enum : ["none", "stopIfEnoughMatches"]
47
+ required :
48
+ - requests
43
49
responses :
44
50
" 200 " :
45
51
description : OK
You can’t perform that action at this time.
0 commit comments