History

Colin Goodheart-Smithe 4cbbe3ed93 Fixes DocStats to not report index size < -1 (#27863 ) Previously to this change when DocStats are added together (for example when adding the index size of all primary shards for an index) we naively added the `totalSizeInBytes` together. This worked most of the time but not when the index size on one or multiple shards was reported to be `-1` (no value). This change improves the logic by considering if the current value or the value to be added is `-1`: * If the current and new value are both `-1` the value remains at `-1` * If the current value is `-1` and the new value is not `-1`, current value is changed to be equal to the new value * If the current value is not `-1` and the new value is `-1` the new value is ignored and the current value is not changed * If both the current and new values are not `-1` the current value is changed to be equal to the sum of the current and new values. The change also re-enables the failing rollover YAML test that was failing due to this bug.		2017-12-20 14:45:09 +00:00
..
src/main/resources/rest-api-spec	Fixes DocStats to not report index size < -1 (#27863 )	2017-12-20 14:45:09 +00: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").