History

Christoph Büscher 2f0e0b2426 Allow indices.get_mapping response parsing without types (#37492 ) This change adds deprecation warning to the indices.get_mapping API in case the "inlcude_type_name" parameter is set to "true" and changes the parsing code in GetMappingsResponse to parse the type-less response instead of the one containing types. As a consequence the HLRC client doesn't need to force "include_type_name=true" any more and the GetMappingsResponseTests can be adapted to the new format as well. Also removing some "include_type_name" parameters in yaml test and docs where not necessary.		2019-01-18 09:33:36 +01:00
..
src/main/resources/rest-api-spec	Allow indices.get_mapping response parsing without types (#37492 )	2019-01-18 09:33:36 +01: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	Converting randomized testing to create a separate unitTest task instead of replacing the builtin test task (#36311 )	2018-12-19 08:25:20 +02: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").