History

Brian Murphy e79b7086de Indexed Scripts/Templates: Add support for storing/deleting/getting scripts/template from an index. This change allow elasticsearch users to store scripts and templates in an index for use at search time. Scripts/Templates are stored in the .scripts index. The type of the events is set to the script language. Templates use the mustache language so their type is be "mustache". Adds the concept of a script type to calls to the ScriptService types are INDEXED,INLINE,FILE. If a script type of INDEXED is supplied the script will be attempted to be loaded from the indexed, FILE will look in the file cache and INLINE will treat the supplied script argument as the literal script. REST endpoints are provided to do CRUD operations as is a java client library. All query dsl points have been upgraded to allow passing in of explicit script ids and script file names. Backwards compatible behavior has been preserved so this shouldn't break any existing querys that expect to pass in a filename as the script/template name. The ScriptService will check the disk cache before parsing the script. Closes #5921 #5637 #5484		2014-07-14 14:37:55 +01:00
..
api	Indexed Scripts/Templates: Add support for storing/deleting/getting scripts/template from an index.	2014-07-14 14:37:55 +01:00
test	Indexed Scripts/Templates: Add support for storing/deleting/getting scripts/template from an index.	2014-07-14 14:37:55 +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.