History

Jason Tedor 95c4846e58 Fix race condition in cat shards test This commit fixes a test bug in the cat shards REST test. In particular, there was a race condition in the test that would cause the test to sometimes fail. The race condition is that some of the shards would go to state STARTED after the sync flush was issued. These shards would (correctly) show up in the output as having state started but without a sync_id. However, the expected output was written to only look for shards that have state STARTED and a sync_id, or shards that are still INITIALIZING or are UNASSIGNED and (of course) do not have a sync_id. The best approach here is to just simplify the test.		2015-11-13 12:16:22 -05:00
..
src/main/resources/rest-api-spec	Fix race condition in cat shards test	2015-11-13 12:16:22 -05:00
.gitignore	Initial commit (blank repository)	2013-05-23 17:56:22 +02:00
README.markdown	[API] changed all the links in json specs to the new site	2015-03-24 17:30:32 +01: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.

Utilities

The repository contains some utilities in the utils directory:

The thor api:generate:spec will generate the basic JSON specification from Java source code
The thor api:generate:code generates Ruby source code and tests from the specs, and can be extended to generate assets in another programming language

Run bundle install and then thor list in the utils folder.

The full command to generate the api spec is:

thor api:spec:generate --output=myfolder --elasticsearch=/path/to/es

License

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