<commit_before>Swagger for Elasticsearch [![Build Status](https://travis-ci.org/timschlechter/swagger-for-elasticsearch.svg?branch=master)](https://travis-ci.org/timschlechter/swagger-for-elasticsearch)
=========================
Provides [Swagger](http://swagger.io/) documentation for your Elasticsearch cluster.

__Note:__ This plugin does not aim to be the ultimate management tool for Elasticsearch, there are [far better plugins for doing this](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-plugins.html#known-plugins). It tries to make it easy to discover and learn about the APIs, and makes it possible to invoke/test APIs quickly.

### Features###
* Runtime generation of the documentation based on the [official specs](https://github.com/elastic/elasticsearch/tree/master/rest-api-spec), just install the plugin and go
* Automatically adapts to the version of your Elasticsearch installation. Support for Elasticsearch 0.90, 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7 and 2.0
* Includes a slightly modified version of [Swagger UI](https://github.com/swagger-api/swagger-ui) to make it easy to switch index/alias API's

Installation
------------
```
# Elasticsearch 2.0:
./bin/plugin --url https://github.com/timschlechter/swagger-for-elasticsearch/raw/master/dist/swagger-for-elasticsearch-2.0.0.zip --install swagger

# Elasticsearch 1.7.3 and below:
./bin/plugin --url https://github.com/timschlechter/swagger-for-elasticsearch/raw/master/dist/swagger-for-elasticsearch.zip --install swagger<commit_msg>Fixed install url in readme<commit_after>Swagger for Elasticsearch [![Build Status](https://travis-ci.org/timschlechter/swagger-for-elasticsearch.svg?branch=master)](https://travis-ci.org/timschlechter/swagger-for-elasticsearch)
=========================
Provides [Swagger](http://swagger.io/) documentation for your Elasticsearch cluster.

__Note:__ This plugin does not aim to be the ultimate management tool for Elasticsearch, there are [far better plugins for doing this](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-plugins.html#known-plugins). It tries to make it easy to discover and learn about the APIs, and makes it possible to invoke/test APIs quickly.

### Features###
* Runtime generation of the documentation based on the [official specs](https://github.com/elastic/elasticsearch/tree/master/rest-api-spec), just install the plugin and go
* Automatically adapts to the version of your Elasticsearch installation. Support for Elasticsearch 0.90, 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7 and 2.0
* Includes a slightly modified version of [Swagger UI](https://github.com/swagger-api/swagger-ui) to make it easy to switch index/alias API's

Installation
------------
```
# Elasticsearch 2.0:
sudo ./bin/plugin install https://github.com/timschlechter/swagger-for-elasticsearch/raw/master/dist/swagger-for-elasticsearch-2.0.0.zip

# Elasticsearch 1.7.3 and below:
./bin/plugin --url https://github.com/timschlechter/swagger-for-elasticsearch/raw/master/dist/swagger-for-elasticsearch.zip --install swagger
{'fraction_non_alphanumeric': 0.14123744735989635, 'fraction_numerical': 0.018788467768059605, 'mean_word_length': 4.782771535580524, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 12, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7333166', 'n_tokens_mistral': 929, 'n_tokens_neox': 913, 'n_words': 258}