History

Simon Willnauer c4c4a3a504 Fix `_shrink` test to work under a mixed version cluster (#21262 ) today the `_shrink` tests do relocate all shards to a single node in the cluster. Yet, that is not always possible since the only node we can safely identify in the cluster is the master and if the master is a BWC node in such a cluster we won't be able to relocate shards that have a primary on the newer version nodes since allocation deciders forbid this. This change restricts allocation for that index when the index is created to restrict allocation to the master that guarantees that all primaries are on the same node which is sufficient for the `_shrink` API to run.		2016-11-02 17:09:30 +01:00
..
src/main/resources/rest-api-spec	Fix `_shrink` test to work under a mixed version cluster (#21262 )	2016-11-02 17:09:30 +01: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	Build: Add pom building and associated files to rest api spec jar (#20460 )	2016-09-13 14:05:52 -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").