History

Ali Beyad 577d2a6a1d Adds cluster state size to /_cluster/state response (#23440 ) This commit adds the size of the cluster state to the response for the get cluster state API call (GET /_cluster/state). The size that is returned is the size of the full cluster state in bytes when compressed. This is the same size of the full cluster state when serialized to transmit over the network. Specifying the ?human flag displays the compressed size in a more human friendly manner. Note that even if the cluster state request filters items from the cluster state (so a subset of the cluster state is returned), the size that is returned is the compressed size of the entire cluster state. Closes #3415		2017-03-02 14:20:29 -05:00
..
src/main/resources/rest-api-spec	Adds cluster state size to /_cluster/state response (#23440 )	2017-03-02 14:20:29 -05: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").