History

Jason Tedor 533412e36f Improve cat thread pool API Today, when listing thread pools via the cat thread pool API, thread pools are listed in a column-delimited format. This is unfriendly to command-line tools, and inconsistent with other cat APIs. Instead, thread pools should be listed in a row-delimited format. Additionally, the cat thread pool API is limited to a fixed list of thread pools that excludes certain built-in thread pools as well as all custom thread pools. These thread pools should be available via the cat thread pool API. This commit improves the cat thread pool API by listing all thread pools (built-in or custom), and by listing them in a row-delimited format. Finally, for each node, the output thread pools are sorted by thread pool name. Relates #19721		2016-08-03 23:02:13 -04:00
..
src/main/resources/rest-api-spec	Improve cat thread pool API	2016-08-03 23:02:13 -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").