History

Alan Woodward 09bf93dc2a Add intervals query (#36135 ) * Add IntervalQueryBuilder with support for match and combine intervals * Add relative intervals * feedback * YAML test - broekn * yaml test; begin to add block source * Add block; make disjunction its own source * WIP * Extract IntervalBuilder and add tests for it * Fix eq/hashcode in Disjunction * New yaml test * checkstyle * license headers * test fix * YAML format * YAML formatting again * yaml tests; javadoc * Add OR test -> requires fix from LUCENE-8586 * Add docs * Re-do API * Clint's API * Delete bash script * doc fixes * imports * docs * test fix * feedback * comma * docs fixes * Tidy up doc references to old rule		2018-12-14 15:14:00 +00:00
..
src/main/resources/rest-api-spec	Add intervals query (#36135 )	2018-12-14 15:14:00 +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	Auto skip license headers on no source (#35640 )	2018-11-20 13:02:33 +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").