History

Nik Everett 78ab6c5b7f [reindex] Dynamic throttle! This allows the user to update the reindex throttle on the fly, with changes that speed up the throttling being applied immediately and changes that slow down the throttling being applied during the next batch. This means that if a user throttles reindex in such a way that it tries to sleep for 16 years and then realizes that they've done something wrong then they can change the throttle and reindex will wake up again. We don't apply slow downs immediately so we never get in danger of losing the scan context. Also, if reindex is canceled while it is sleeping (how it honor throttling) then it'll immediately wake up and cancel itself.		2016-03-30 16:40:42 -04:00
..
src/main/resources/rest-api-spec	[reindex] Dynamic throttle!	2016-03-30 16:40:42 -04:00
.gitignore	Initial commit (blank repository)	2013-05-23 17:56:22 +02:00
README.markdown	Remove reference to utils for generating REST docs	2016-03-30 13:36:51 +02:00
build.gradle	Switch build system to Gradle	2015-10-29 11:40:19 -07:00

README.markdown

Elasticsearch REST API JSON specification

This repository contains a collection of JSON files which describe the Elasticsearch HTTP API.

Their purpose is to formalize and standardize the API, to facilitate development of libraries and integrations.

Example for the "Create Index" API:

{
  "indices.create": {
    "documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html",
    "methods": ["PUT", "POST"],
    "url": {
      "path": "/{index}",
      "paths": ["/{index}"],
      "parts": {
        "index": {
          "type" : "string",
          "required" : true,
          "description" : "The name of the index"
        }
      },
      "params": {
        "timeout": {
          "type" : "time",
          "description" : "Explicit operation timeout"
        }
      }
    },
    "body": {
      "description" : "The configuration for the index (`settings` and `mappings`)"
    }
  }
}

The specification contains:

The name of the API (indices.create), which usually corresponds to the client calls
Link to the documentation at http://elastic.co
List of HTTP methods for the endpoint
URL specification: path, parts, parameters
Whether body is allowed for the endpoint or not and its description

The methods and url.paths elements list all possible HTTP methods and URLs for the endpoint; it is the responsibility of the developer to use this information for a sensible API on the target platform.

License

This software is licensed under the Apache License, version 2 ("ALv2").