rest-api-spec.api.rollup.rollup_search.json Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of rest-api-spec Show documentation
Show all versions of rest-api-spec Show documentation
Elasticsearch subproject :rest-api-spec
{
"rollup.rollup_search":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-search.html",
"description":"Enables searching rolled-up data using the standard query DSL."
},
"stability":"experimental",
"visibility":"public",
"headers":{
"accept": [ "application/json"],
"content_type": ["application/json"]
},
"url":{
"paths":[
{
"path":"/{index}/_rollup_search",
"methods":[
"GET",
"POST"
],
"parts":{
"index":{
"type":"list",
"description":"The indices or index-pattern(s) (containing rollup or regular data) that should be searched"
}
}
},
{
"path":"/{index}/{type}/_rollup_search",
"methods":[
"GET",
"POST"
],
"parts":{
"index":{
"type":"list",
"description":"The indices or index-pattern(s) (containing rollup or regular data) that should be searched"
},
"type":{
"type":"string",
"required":false,
"description":"The doc type inside the index",
"deprecated":true
}
},
"deprecated":{
"version":"7.0.0",
"description":"Specifying types in urls has been deprecated"
}
}
]
},
"params":{
"typed_keys":{
"type":"boolean",
"description":"Specify whether aggregation and suggester names should be prefixed by their respective types in the response"
},
"rest_total_hits_as_int":{
"type":"boolean",
"description":"Indicates whether hits.total should be rendered as an integer or an object in the rest search response",
"default":false
}
},
"body":{
"description":"The search request body",
"required":true
}
}
}