elastics-client 1.1.11 → 1.2.0

data/lib/elastics/api_templates/cat_api.yml

@@ -0,0 +1,14 @@
+# These methods are available as Elastics.<method>(*vars)
+# you can get the updated full reference and usage example of these methods
+# by just doing in the console:
+# Elastics.doc
+
+cat:
+  - GET
+  -
+  -
+  - REFERENCES:
+      group: cat_api
+      api_name: Cat API
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/cat.html
+      notice: "You must pass the :path variable or you can pass it as a simple string argument: Elastics.cat('/path')"

data/lib/elastics/api_templates/cluster_api.yml

@@ -1,4 +1,4 @@
-# These methods are available as Elastics.<method>(variable_hash)
+# These methods are available as Elastics.<method>(*vars)
 # you can get the updated full reference and usage example of these methods
 # by just doing in the console:
 # Elastics.doc
@@ -7,88 +7,140 @@
 
 #-----------------------------------------------------------------------------#
 ### Health ###
-# http://www.elasticsearch.org/guide/reference/api/admin-cluster-health/
 
-# you can pass the params as the :params variable
 cluster_health:
   - GET
   - /_cluster/health/<<index>>
+  -
+  - REFERENCES:
+      group: cluster_api
+      api_name: Health
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html
+      notice: "You can pass the params as the :params variable."
 
 
 
 #-----------------------------------------------------------------------------#
 ### State ###
-# http://www.elasticsearch.org/guide/reference/api/admin-cluster-state/
 
-# you can pass the params as the :params variable
 cluster_state:
   - GET
-  - /_cluster/state
+  - /_cluster/state/<<metrics= _all >>/<<index>>
+  -
+  - REFERENCES:
+      group: cluster_api
+      api_name: State
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-state.html
+      notice: "You can pass the metrics as the :metrics variable."
 
 
 
 #-----------------------------------------------------------------------------#
-### Update Settings ###
-# http://www.elasticsearch.org/guide/reference/api/admin-cluster-update-settings/
+### Stats ###
 
-# you must pass the settings structure as the :data variable
-put_cluster_settings:
-  - PUT
-  - /_cluster/settings
+cluster_stats:
+  - GET
+  - /_cluster/stats
+  -
+  - REFERENCES:
+      group: cluster_api
+      api_name: Stats
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-stats.html
+      notice: "You can pass the params as the :params variable."
 
-get_cluster_settings:
+
+
+#-----------------------------------------------------------------------------#
+### Pending Cluster Tasks ###
+
+cluster_pending_tasks:
   - GET
-  - /_cluster/settings
+  - /_cluster/pending_tasks
+  -
+  - REFERENCES:
+      group: cluster_api
+      api_name: Pending Cluster Tasks
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-pending.html
+      notice: "You can pass the params as the :params variable."
 
 
 
 #-----------------------------------------------------------------------------#
-### Nodes Info ###
-# http://www.elasticsearch.org/guide/reference/api/admin-cluster-nodes-info/
-# http://www.elasticsearch.org/guide/reference/api/
+### Cluster Reroute ###
 
-# uses the _nodes shortcut
-cluster_nodes_info:
+cluster_reroute:
+  - POST
+  - /_cluster/reroute
+  -
+  - REFERENCES:
+      group: cluster_api
+      api_name: Cluster Reroute
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-reroute.html
+      notice: "You must pass the data structure as the :data variable."
+
+
+
+#-----------------------------------------------------------------------------#
+### Cluster Update Settings ###
+
+get_cluster_settings:
   - GET
-  - /_nodes/<<nodes= ~ >>/<<endpoint= ~ >>
+  - /_cluster/settings
+  -
+  - REFERENCES: &cluster_settings
+      api_name: Cluster Update Settings
+      api_url: http://www.elasticsearch.org/guide/reference/api/admin-cluster-update-settings
+
+put_cluster_settings:
+  - PUT
+  - /_cluster/settings
+  -
+  - REFERENCES:
+      group: cluster_api
+      <<: *cluster_settings
+      notice: "You must pass the data structure as the :data variable."
 
 
 
 #-----------------------------------------------------------------------------#
 ### Nodes Stats ###
-# http://www.elasticsearch.org/guide/reference/api/admin-cluster-nodes-stats/
 
 cluster_nodes_stats:
   - GET
-  - /_nodes/<<nodes= ~ >>/stats/<<endpoint= ~ >>
+  - /_nodes/<<nodes= ~ >>/stats/<<stats= ~ >>
+  -
+  - REFERENCES:
+      group: cluster_api
+      api_name: Nodes Stats
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html
+      notice: "You can pass the params as the :params variable. You must pass the data structure as the :data variable."
 
 
 
 #-----------------------------------------------------------------------------#
-### Nodes Shutdown ###
-# http://www.elasticsearch.org/guide/reference/api/admin-cluster-nodes-shutdown/
+### Nodes Info ###
+
+cluster_nodes_info:
+  - GET
+  - /_nodes/<<nodes= ~ >>/<<info= ~ >>
+  -
+  - REFERENCES:
+      group: cluster_api
+      api_name: Nodes Info
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-info.html
+      notice: "This template uses the _nodes shortcut."
 
-cluster_nodes_shutdown:
-  - POST
-  - /_cluster/nodes/<<nodes= ~ >>/_shutdown
 
 
 
 #-----------------------------------------------------------------------------#
 ### Nodes Hot Threads ###
-# http://www.elasticsearch.org/guide/reference/api/admin-cluster-nodes-hot-threads/
 
 cluster_nodes_hot_threads:
   - GET
   - /_nodes/<<nodes= ~ >>/hot_threads
-
-
-
-#-----------------------------------------------------------------------------#
-### Cluster Reroute ###
-# http://www.elasticsearch.org/guide/reference/api/admin-cluster-reroute.html
-
-# you must pass the data structure as the :data variable
-cluster_reroute:
-  - POST
-  - /_cluster/reroute
+  -
+  - REFERENCES:
+      group: cluster_api
+      api_name: Nodes Hot Threads
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-hot-threads.html

data/lib/elastics/api_templates/document_api.yml

@@ -0,0 +1,154 @@
+# These methods are available as Elastics.<method>(*vars)
+# you can get the updated full reference and usage example of these methods
+# by just doing in the console:
+# Elastics.doc
+
+
+
+#-----------------------------------------------------------------------------#
+### Index API ###
+
+store:
+  - PUT
+  - /<<index>>/<<type>>/<<id>>
+  -
+  - REFERENCES: &index
+      group: document_api
+      api_name: Index API
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html
+      notice: "You must pass the :data variable."
+      aliases:
+        - :put_store
+
+post_store:
+  - POST
+  - /<<index>>/<<type>>
+  -
+  - REFERENCES:
+      <<: *index
+      notice: "The id is assigned by elasticsearch; you must pass the :data variable."
+
+
+
+#-----------------------------------------------------------------------------#
+### Get API ###
+
+get:
+  - GET
+  - /<<index>>/<<type>>/<<id>>
+  -
+  - &get
+    REFERENCES:
+      group: document_api
+      api_name: Get API
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html
+
+get_source:
+  - GET
+  - /<<index>>/<<type>>/<<id>>/_source
+  -
+  - *get
+
+
+
+#-----------------------------------------------------------------------------#
+### Delete ###
+
+delete: &delete
+  - DELETE
+  - /<<index>>/<<type>>/<<id>>
+  -
+  - REFERENCES:
+      group: document_api
+      api_name: Delete API
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete.html
+      notice: "You must pass the :data variable."
+      aliases:
+        - :remove
+
+
+
+#-----------------------------------------------------------------------------#
+### Update API ###
+
+update:
+  - POST
+  - /<<index>>/<<type>>/<<id>>/_update
+  -
+  - REFERENCES:
+      group: document_api
+      api_name: Update API
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update.html
+      notice: "You must pass script or doc and the other options as the :data variable."
+
+
+
+#-----------------------------------------------------------------------------#
+### Multi Get API ###
+
+multi_get_ids:
+  - GET
+  - /<<index>>/<<type>>/_mget
+  - ids: << ids >>
+  - REFERENCES: &multi_get
+      group: document_api
+      api_name: Multi Get API
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-get.html
+      notice: "You must pass the :ids array."
+      aliases:
+        - :multi_get
+
+multi_get_docs:
+  - GET
+  - /<<index>>/<<type>>/_mget
+  - docs: << docs >>
+  - REFERENCES:
+      <<: *multi_get
+      notice: "You must pass the :docs array."
+
+
+
+#-----------------------------------------------------------------------------#
+### Bulk API ###
+
+post_bulk_string:
+  - POST
+  - /_bulk
+  - << bulk_string >>
+  - REFERENCES:
+      group: document_api
+      api_name: Bulk API
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html
+      notice: "You must pass the :docs array."
+      aliases:
+        - :bulk
+
+
+
+#-----------------------------------------------------------------------------#
+### Term Vectors ###
+
+termvector:
+  - POST
+  - /<<index>>/<<type>>/<<id>>/_termvector
+  -
+  - REFERENCES:
+      group: document_api
+      api_name: Term Vectors
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-termvectors.html
+      notice: "You must pass the options as the :data variable."
+
+
+
+#-----------------------------------------------------------------------------#
+### Multi Termvectors API ###
+
+multi_termvectors:
+  - POST
+  - /<<index>>/<<type>>/_mtermvectors
+  - docs: <<docs= ~ >>
+  - REFERENCES:
+      group: document_api
+      api_name: Multi Termvectors API
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-termvectors.html
+      notice: "You must pass the docs array as the :docs variable or use the :data variable for the simplified request."

data/lib/elastics/api_templates/elastics_additions.yml

@@ -0,0 +1,32 @@
+# These methods are available as Elastics.<method>(*vars)
+# you can get the updated full reference and usage example of these methods
+# by just doing in the console:
+# Elastics.doc
+
+
+
+#-----------------------------------------------------------------------------#
+### API additions ###
+
+match_all:
+  - GET
+  - /<<index>>/<<type>>/_search
+  - query:
+      match_all:
+        {}
+  - REFERENCES:
+      group: elastics_additions
+      notice: "Not a real API method, but handy."
+
+
+#-----------------------------------------------------------------------------#
+
+search_by_id:
+  - GET
+  - /<<index>>/<<type>>/_search
+  - query:
+      term:
+        _id: <<id>>
+  - REFERENCES:
+      group: elastics_additions
+      notice: "Get a document without using the get API and without raising any error if it is missing."

data/lib/elastics/api_templates/indices_api.yml

@@ -1,66 +1,27 @@
-# These methods are available as Elastics.<method>(variable_hash)
+# These methods are available as Elastics.<method>(*vars)
 # you can get the updated full reference and usage example of these methods
 # by just doing in the console:
 # Elastics.doc
 
 
 
-#-----------------------------------------------------------------------------#
-### Aliases ###
-# http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/
-
-# this is the generic interface allowing all options
-# you must pass the aliases API structure as :data variable
-post_index_aliases:
-  - POST
-  - /_aliases
-  - actions: <<actions>>
-
-get_index_aliases:
-  - GET
-  - /<<index>>/_aliases
-
-# this is the single index alias
-# you can pass other options as :data variable
-put_index_alias:
-  - PUT
-  - /<<index>>/_alias/<<alias>>
-
-delete_index_alias:
-  - DELETE
-  - /<<index>>/_alias/<<alias>>
-
-get_index_alias:
-  - GET
-  - /<<index>>/_alias/<<alias= '*' >>
-
-
-
-#-----------------------------------------------------------------------------#
-### Analyze ###
-# http://www.elasticsearch.org/guide/reference/api/admin-indices-analyze/
-
-# you can pass the text to analyze as the :data variable (or the param :text)
-# you can pass the parameters as the :params variable
-analyze_index:
-  - GET
-  - /<<index>>/_analyze
-
-
-
 #-----------------------------------------------------------------------------#
 ### Create Index ###
-# http://www.elasticsearch.org/guide/reference/api/admin-indices-create-index.html
 
-put_index: &create
+put_index:
   - PUT
   - /<<index>>
   - settings:
       number_of_shards: <<number_of_shards= 5 >>
       number_of_replicas: <<number_of_replicas= 1 >>
-
-# aliased
-create_index: *create
+  - &create_index
+    REFERENCES:
+      group: indices_api
+      api_name: Create Index
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html
+      notice: "You can also pass the complete data structure as :data variable, so passing settings, mappings, warmers, aliases, ..."
+      aliases:
+        - :create_index
 
 post_index:
   - POST
@@ -68,243 +29,447 @@ post_index:
   - settings:
       number_of_shards: <<number_of_shards= 5 >>
       number_of_replicas: <<number_of_replicas= 1 >>
+  - *create_index
 
 
 
 #-----------------------------------------------------------------------------#
 ### Delete Index ###
-# http://www.elasticsearch.org/guide/reference/api/delete.html
 
 delete_index:
   - DELETE
   - /<<index>>
+  -
+  - REFERENCES:
+      group: indices_api
+      api_name: Delete Index
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-index.html
+
+
+
+#-----------------------------------------------------------------------------#
+### Get Index ###
+
+get_index:
+  - GET
+  - /<<index>>/<<features= ~ >>
+  -
+  - REFERENCES:
+      group: indices_api
+      api_name: Get Index
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html
+
+
+
+#-----------------------------------------------------------------------------#
+### Indices Exists ###
+
+indices_exists:
+  - HEAD
+  - /<<index>>
+  -
+  - REFERENCES:
+      group: indices_api
+      api_name: Indices Exists
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-exists.html
+      aliases:
+        - :index_exists
+        - :exist?
 
 
 
 #-----------------------------------------------------------------------------#
 ### Open/Close Index ###
-# http://www.elasticsearch.org/guide/reference/api/admin-indices-open-close/
 
 close_index:
   - POST
   - /<<index>>/_close
+  -
+  - &open_close_index
+    REFERENCES:
+      group: indices_api
+      api_name: Open/Close Index
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-open-close.html
 
 open_index:
   - POST
   - /<<index>>/_open
+  -
+  - *open_close_index
 
 
 
 #-----------------------------------------------------------------------------#
-### Get Settings ###
-# http://www.elasticsearch.org/guide/reference/api/admin-indices-get-settings.html
-
-get_index_settings: &get_index_settings
-  - GET
-  - /<<index>>/_settings
-
-# alias
-get_settings: *get_index_settings
+### Put Mappings ###
 
-# you should pass the settings structure as the :data variable
-put_index_settings:
+put_index_mapping:
   - PUT
-  - /<<index>>/_settings
+  - /<<index>>/_mapping/<<type>>
+  - <<type>>:
+      properties: <<properties>>
+  - REFERENCES:
+      group: indices_api
+      api_name: Put Mappings
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-mapping.html
+      aliases:
+        - :put_mappings
 
 
 
 #-----------------------------------------------------------------------------#
 ### Get Mappings ###
-# http://www.elasticsearch.org/guide/reference/api/admin-indices-get-mapping.html
 
-get_index_mapping: &get_index_mapping
+get_index_mapping:
   - GET
-  - /<<index>>/<<type>>/_mapping
-
-# alias
-get_mapping: *get_index_mapping
+  - /<<index>>/_mapping/<<type>>
+  -
+  - REFERENCES:
+      group: indices_api
+      api_name: Get Mappings
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-mapping.html
 
 
 
 #-----------------------------------------------------------------------------#
-### Put Mappings ###
-# http://www.elasticsearch.org/guide/reference/api/admin-indices-put-mapping.html
+### Get Field Mappings ###
+
+get_field_mapping:
+  - GET
+  - /<<index>>/_mapping/<<type>>/field/<<field>>
+  -
+  - REFERENCES:
+      group: indices_api
+      api_name: Get Field Mappings
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-field-mapping.html
 
-put_index_mapping: &put_index_mapping
-  - PUT
-  - /<<index>>/<<type>>/_mapping
-  - <<type>>:
-      properties: <<properties>>
 
-# alias
-put_mapping: *put_index_mapping
+
+#-----------------------------------------------------------------------------#
+### Types Exists ###
+
+types_exists: &types_exists
+  - HEAD
+  - /<<index>>/<<type>>
+  -
+  - REFERENCES:
+      group: indices_api
+      api_name: Types Exists
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-types-exists.html
+      aliases:
+        - :type_exists
 
 
 
 #-----------------------------------------------------------------------------#
 ### Delete Mappings ###
-# http://www.elasticsearch.org/guide/reference/api/admin-indices-delete-mapping.html
 
 delete_index_mapping: &delete_index_mapping
   - DELETE
   - /<<index>>/<<type>>
-
-# alias
-delete_mapping: *delete_index_mapping
+  -
+  - REFERENCES:
+      group: indices_api
+      api_name: Delete Mappings
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-mapping.html
 
 
 
 #-----------------------------------------------------------------------------#
-### Refresh ###
-# http://www.elasticsearch.org/guide/reference/api/admin-indices-refresh.html
+### Index Aliases ###
 
-refresh_index:
+# generic index aliases
+
+get_index_aliases:
+  - GET
+  - /<<index>>/_aliases
+  -
+  - REFERENCES: &index_aliases
+      group: indices_api
+      api_name: Index Aliases
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
+
+post_index_aliases:
   - POST
-  - /<<index>>/_refresh
+  - /_aliases
+  - actions: <<actions>>
+  - REFERENCES:
+      <<: *index_aliases
+      notice: "This is the generic interface allowing all the options. You can pass the :actions array or the aliases API structure as the :data variable."
 
 
+# single index alias
 
-#-----------------------------------------------------------------------------#
-### Optimize ###
-# http://www.elasticsearch.org/guide/reference/api/admin-indices-optimize/
+delete_index_alias:
+  - DELETE
+  - /<<index>>/_alias/<<alias>>
+  -
+  - REFERENCES: *index_aliases
 
-# you can pass the parameters as the :params variable
-optimize_index:
-  - POST
-  - /<<index>>/_optimize
+get_index_alias:
+  - GET
+  - /<<index>>/_alias/<<alias= '*' >>
+  -
+  - REFERENCES: *index_aliases
+
+put_index_alias:
+  - PUT
+  - /<<index>>/_alias/<<alias>>
+  -
+  - REFERENCES:
+      <<: *index_aliases
+      notice: "This is the single index alias. You can pass other options as the :data variable."
 
 
 
 #-----------------------------------------------------------------------------#
-### Flush ###
-# http://www.elasticsearch.org/guide/reference/api/admin-indices-flush/
+### Update Indices Settings ###
 
-# you can pass the parameters as the :params variable
-flush_index:
-  - POST
-  - /<<index>>/_flush
+update_index_settings:
+  - PUT
+  - /<<index>>/_settings
+  -
+  - REFERENCES:
+      group: indices_api
+      api_name: Update Indices Settings
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html
+      notice: "You can pass the settings structure as the :data variable."
+      aliases:
+       - :put_index_settings
 
 
 
 #-----------------------------------------------------------------------------#
-### Snapshot ###
-# http://www.elasticsearch.org/guide/reference/api/admin-indices-gateway-snapshot/
+### Get Indices Settings ###
+
+get_index_settings:
+  - GET
+  - /<<index>>/_settings
+  -
+  - REFERENCES:
+      group: indices_api
+      api_name: Get Indices Settings
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-settings.html
+      aliases:
+        - :get_settings
 
-gateway_snapshot:
-  - POST
-  - /<<index>>/_gateway/snapshot
 
 
 
 #-----------------------------------------------------------------------------#
-### Update Settings ###
-# http://www.elasticsearch.org/guide/reference/api/admin-indices-update-settings/
+### Analyze ###
 
-# you can pass the settings structure as the :data variable
-update_index_settings:
-  - PUT
-  - /<<index>>/_settings
+analyze_index:
+  - GET
+  - /<<index>>/_analyze
+  -
+  - REFERENCES:
+      group: indices_api
+      api_name: Analyze
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-analyze.html
+      notice: "You can pass the text to analyze as the :data variable (or the param :text). You can pass the parameters as the :params variable."
 
 
 
 #-----------------------------------------------------------------------------#
-### Templates ###
-# http://www.elasticsearch.org/guide/reference/api/admin-indices-templates/
-
-# you must pass the data structure as :data variable
-put_index_template:
-  - PUT
-  - /_template/<<template>>
+### Index Templates ###
 
 delete_index_template:
   - DELETE
   - /_template/<<template>>
+  -
+  - REFERENCES: &index_template
+      group: indices_api
+      api_name: Index Templates
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html
 
 get_index_template:
   - GET
+  - /_template/<<template= ~ >>
+  -
+  - REFERENCES: *index_template
+
+index_template_exists:
+  - HEAD
+  - /_template/<<template>>
+  -
+  - REFERENCES: *index_template
+
+put_index_template:
+  - PUT
   - /_template/<<template>>
+  -
+  - REFERENCES:
+      <<: *index_template
+      notice: "You must pass the template structure as the :data variable."
 
 
 
 #-----------------------------------------------------------------------------#
 ### Warmers ###
-# http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/
 
-# you must pass the warmer structure as the :data variable
+delete_index_warmer:
+  - DELETE
+  - /<<index>>/_warmer/<<warmer>>
+  -
+  - REFERENCES: &warmers
+      group: indices_api
+      api_name: Warmers
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-warmers.html
+
 put_index_warmer:
   - PUT
   - /<<index>>/<<type>>/_warmer/<<warmer>>
-
-delete_index_warmer:
-  - DELETE
-  - /<<index>>/_warmer/<<warmer= ~ >>
+  -
+  - REFERENCES:
+      <<: *warmers
+      notice: "You must pass the warmer structure as the :data variable."
 
 get_index_warmer:
   - GET
   - /<<index>>/_warmer/<<warmer= ~ >>
+  -
+  - REFERENCES: *warmers
 
 
 
 #-----------------------------------------------------------------------------#
-### Stats ###
-# http://www.elasticsearch.org/guide/reference/api/admin-indices-stats.html
+### Status ###
 
-index_stats: &index_stats
+index_status:
   - GET
-  - /<<index>>/_stats/<<endpoint= ~ >>/<<names= ~ >>
-
-# alias
-stats: *index_stats
+  - /<<index>>/_status
+  -
+  - REFERENCES:
+      group: indices_api
+      api_name: Status
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-status.html
 
 
 
 #-----------------------------------------------------------------------------#
-### Status ###
-# http://www.elasticsearch.org/guide/reference/api/admin-indices-status/
+### Stats ###
 
-index_status:
+index_stats:
   - GET
-  - /<<index>>/_status
+  - /<<index>>/_stats/<<stats= ~ >>
+  -
+  - REFERENCES:
+      group: indices_api
+      api_name: Stats
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-stats.html
 
 
 
 #-----------------------------------------------------------------------------#
 ### Segments ###
-# http://www.elasticsearch.org/guide/reference/api/admin-indices-segments/
 
 index_segments:
   - GET
   - /<<index>>/_segments
+  -
+  - REFERENCES:
+      group: indices_api
+      api_name: Segments
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-segments.html
+
+
+
+#-----------------------------------------------------------------------------#
+### Recovery ###
+
+index_recovery:
+  - GET
+  - /<<index>>/_recovery
+  -
+  - REFERENCES:
+      group: indices_api
+      api_name: Recovery
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-recovery.html
 
 
 
 #-----------------------------------------------------------------------------#
 ### Clear Cache ###
-#http://www.elasticsearch.org/guide/reference/api/admin-indices-clearcache/
 
 index_clearcache:
   - POST
   - /<<index>>/_cache/clear
+  -
+  - REFERENCES:
+      group: indices_api
+      api_name: Recovery
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-clearcache.html
 
 
 
 #-----------------------------------------------------------------------------#
-### Indices Exists ###
-# http://www.elasticsearch.org/guide/reference/api/admin-indices-indices-exists.html
+### Flush ###
 
-indices_exists: &exist
-  - HEAD
-  - /<<index>>
+flush_index:
+  - POST
+  - /<<index>>/_flush
+  -
+  - REFERENCES:
+      group: indices_api
+      api_name: Flush
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-flush.html
+      notice: "You can pass the parameters as the :params variable."
 
-# aliased
-exist?: *exist
+
+
+#-----------------------------------------------------------------------------#
+### Synced Flush ###
+
+synced_flush_index:
+  - POST
+  - /<<index>>/_flush/synced
+  -
+  - REFERENCES:
+      group: indices_api
+      api_name: Synced Flush
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-synced-flush.html
+      notice: "You can pass the parameters as the :params variable."
 
 
 
 #-----------------------------------------------------------------------------#
-### Types Exists ###
-# http://www.elasticsearch.org/guide/reference/api/admin-indices-types-exists/
+### Refresh ###
 
-types_exists:
-  - HEAD
-  - /<<index>>/<<type>>
+refresh_index:
+  - POST
+  - /<<index>>/_refresh
+  -
+  - REFERENCES:
+      group: indices_api
+      api_name: Refresh
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-refresh.html
+
+
+
+#-----------------------------------------------------------------------------#
+### Optimize ###
+
+optimize_index:
+  - POST
+  - /<<index>>/_optimize
+  -
+  - REFERENCES:
+      group: indices_api
+      api_name: Optimize
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-optimize.html
+      notice: "You can pass the parameters as the :params variable."
+
+
+
+#-----------------------------------------------------------------------------#
+### Upgrade ###
+
+upgrade_index:
+  - POST
+  - /<<index>>/_upgrade
+  -
+  - REFERENCES:
+      group: indices_api
+      api_name: Upgrade
+      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-upgrade.html
+      notice: "You can pass the parameters as the :params variable."