History

Jason Tedor 5dd476feb5 Skip bad request REST test on pre-6.0 This commit adds a skip for the bad request REST test on pre-6.0 nodes. Previously, a request for /_(.*) where $1 is not an existing endpoint would return a 404. This is because the request would be treated as a get index request for an index named _$1. However, an index can never start with "_" so logic was added to detect this and return a 400 instead as this should be treated as a bad request. During the mixed-cluster BWC tests, a node running pre-6.0 code will still return a 404 though. Therefore, this test needs to skipped in such a mixed-cluster scenario.		2017-09-18 06:46:10 -04:00
..
src/main/resources/rest-api-spec	Skip bad request REST test on pre-6.0	2017-09-18 06:46:10 -04:00
.gitignore	…
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").