From e806b1ae6079652273d16f67059b8fc81828554f Mon Sep 17 00:00:00 2001 From: Fedele Mantuano Date: Fri, 4 Sep 2015 22:27:57 +0200 Subject: [PATCH] Moved comments in README.md --- plugins/elasticsearch/README.md | 15 ++++++++++++- .../elasticsearch/elasticsearch.plugin.zsh | 22 ------------------- 2 files changed, 14 insertions(+), 23 deletions(-) diff --git a/plugins/elasticsearch/README.md b/plugins/elasticsearch/README.md index 2fae0a68c..d9c89c672 100644 --- a/plugins/elasticsearch/README.md +++ b/plugins/elasticsearch/README.md @@ -1,13 +1,21 @@ elasticsearch ======= This plugin makes easy to use Elasticsearch API and it also offering autocomplete for common APIs. -There are `GET`, `HEAD`, `DELETE`, `PUT` and `POST` commands. +There are [`GET`](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html), +[`HEAD`](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html), +[`DELETE`](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete.html), +[`PUT`](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update.html) and +[`POST`](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update.html) commands. Examples usage: - `GET _cluster/health` +- `GET _nodes/stats` +- `GET _stats/fielddata?fields=*` +- `GET _nodes/stats/indices/fielddata?fields=*` - `GET _cat` - `DELETE twitter` +You should install [`json_reformat`](http://dev.man-online.org/package/main/yajl-tools/) to format json output. Aliases ------- @@ -16,3 +24,8 @@ Aliases - `alias ecs='GET _cluster/state'`: Allows to get a comprehensive state information of the whole cluster - `alias ens='GET _nodes/stats'`: Allows to retrieve all of the cluster nodes statistics - `alias esf='GET _stats/fielddata'`: Field data memory usage on index level + +Author +------- + +Fedele Mantuano (**Twitter**: [@fedelemantuano](https://twitter.com/fedelemantuano)) diff --git a/plugins/elasticsearch/elasticsearch.plugin.zsh b/plugins/elasticsearch/elasticsearch.plugin.zsh index aa97f80a7..60dc0e05f 100644 --- a/plugins/elasticsearch/elasticsearch.plugin.zsh +++ b/plugins/elasticsearch/elasticsearch.plugin.zsh @@ -1,25 +1,3 @@ -# ------------------------------------------------------------------------------ -# Description -# ----------- -# -# You can use Elastichsearch GET API like in Marvel sense console: -# GET / -# GET _cluster/health -# GET _nodes/stats -# GET _stats/fielddata?fields=* -# GET _nodes/stats/indices/fielddata?fields=* -# -# You have do install json_reformat (http://dev.man-online.org/package/main/yajl-tools/) -# to format json -# -# ------------------------------------------------------------------------------ -# Author -# ------- -# -# * Fedele Mantuano (Twitter: @fedelemantuano) -# -# ------------------------------------------------------------------------------ - alias ech='GET _cluster/health' alias ecs='GET _cluster/state' alias ens='GET _nodes/stats'