History

Jason Tedor d0765d0761 Merge branch 'master' into feature/seq_no * master: (192 commits) [TEST] Fix rare OBOE in AbstractBytesReferenceTestCase Reindex from remote Rename writeThrowable to writeException Start transport client round-robin randomly Reword Refresh API reference (#19270) Update fielddata.asciidoc Fix stored_fields message Add missing footer notes in mapper size docs Remote BucketStreams Add doc values support to the _size field in the mapper-size plugin Bump version to 5.0.0-alpha5. Update refresh.asciidoc Update shrink-index.asciidoc Change Debian repository for Vagrant debian-8 box [TEST] fix test to account for internal empyt reference optimization Upgrade to netty 3.10.6.Final (#19235) [TEST] fix histogram test when extended bounds overlaps data Remove redundant modifier Simplify TcpTransport interface by reducing send code to a single send method (#19223) Fix style violation in InstallPluginCommand.java ...		2016-07-05 22:01:07 -04:00
..
src/main/resources/rest-api-spec	Merge branch 'master' into feature/seq_no	2016-07-05 22:01:07 -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	Enable installing the rest-api-spec artifact	2016-04-13 11:26:47 -04: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").