rest-api-spec.api.clear_scroll.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

Elasticsearch subproject :rest-api-spec

There is a newer version: 8.16.0

{
  "clear_scroll":{
    "documentation":{
      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-scroll-api.html",
      "description":"Explicitly clears the search context for a scroll."
    },
    "stability":"stable",
    "visibility":"public",
    "headers":{
      "accept": [ "application/json"],
      "content_type": ["application/json","text/plain"]
    },
    "url":{
      "paths":[
        {
          "path":"/_search/scroll",
          "methods":[
            "DELETE"
          ]
        },
        {
          "path":"/_search/scroll/{scroll_id}",
          "methods":[
            "DELETE"
          ],
          "parts":{
            "scroll_id":{
              "type":"list",
              "description":"A comma-separated list of scroll IDs to clear",
              "deprecated":true
            }
          },
          "deprecated":{
            "version":"7.0.0",
            "description":"A scroll id can be quite large and should be specified as part of the body"
          }
        }
      ]
    },
    "params":{},
    "body":{
      "description":"A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter"
    }
  }
}