History

Brian Murphy 8e742c2096 Indexed Scripts/Templates : Cleanup This contains several cleanups to the indexed scripts. Remove the unused FetchSourceContext from the Get request.. Add lang,_version,_id to the REST GET API. Removes the routing from GetIndexedScriptRequest since the script index is a single shard that is replicated across all nodes. Fix backward compatible template file reference Before 1.3.0 on disk scripts could be referenced by requesting ```` _search/template { "template" : "ondiskscript" } ```` This was broken in 1.3.0 by requiring ```` { "template" : { "file" : "ondiskscript" } } ```` This commit restores the previous behavior. Remove support for preference, realtime and refresh These parameters don't make sense anymore for indexed scripts as we always force the preference to _local and always refresh after a Put to the indexed scripts index. Closes #7568 Closes #7559 Closes #7647 Closes #7567		2014-09-19 11:59:08 +01:00
..
api	More Like This API: remove unused search_query_hint parameter	2014-09-11 17:34:54 +02:00
test	Indexed Scripts/Templates : Cleanup	2014-09-19 11:59:08 +01:00
utils	[UTIL] Fixed an error for the `--output` parameter in `thor api:spec:generate`	2013-12-05 17:36:54 +01:00
.gitignore	Initial commit (blank repository)	2013-05-23 17:56:22 +02:00
LICENSE.txt	[SETUP] Added README and LICENSE	2013-05-24 12:06:08 +02:00
README.markdown	Update README with full command to generate spec	2013-12-11 18:33:45 +00: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.elasticsearch.org/guide/reference/api/admin-indices-create-index/",
    "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://elasticsearch.org
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 2 license.