flex 0.4.2 → 1.0.1

data/lib/flex/api_templates/cluster_api.yml

@@ -0,0 +1,94 @@
+# These methods are available as Flex.<method>(variable_hash)
+# you can get the updated full reference and usage example of these methods
+# by just doing in the console:
+# >> Flex.doc
+
+
+
+#-----------------------------------------------------------------------------#
+### 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>>
+
+
+
+#-----------------------------------------------------------------------------#
+### 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
+
+
+
+#-----------------------------------------------------------------------------#
+### Update Settings ###
+# http://www.elasticsearch.org/guide/reference/api/admin-cluster-update-settings/
+
+# you must pass the settings structure as the :data variable
+put_cluster_settings:
+  - PUT
+  - /_cluster/settings
+
+get_cluster_settings:
+  - GET
+  - /_cluster/settings
+
+
+
+#-----------------------------------------------------------------------------#
+### Nodes Info ###
+# http://www.elasticsearch.org/guide/reference/api/admin-cluster-nodes-info/
+# http://www.elasticsearch.org/guide/reference/api/
+
+# uses the _nodes shortcut
+cluster_nodes_info:
+  - GET
+  - /_nodes/<<nodes= ~ >>/<<endpoint= ~ >>
+
+
+
+#-----------------------------------------------------------------------------#
+### Nodes Stats ###
+# http://www.elasticsearch.org/guide/reference/api/admin-cluster-nodes-stats/
+
+cluster_nodes_stats:
+  - GET
+  - /_nodes/<<nodes= ~ >>/stats/<<endpoint= ~ >>
+
+
+
+#-----------------------------------------------------------------------------#
+### Nodes Shutdown ###
+# http://www.elasticsearch.org/guide/reference/api/admin-cluster-nodes-shutdown/
+
+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

data/lib/flex/api_templates/core_api.yml

@@ -0,0 +1,202 @@
+# These methods are available as Flex.<method>(variable_hash)
+# you can get the updated full reference and usage example of these methods
+# by just doing in the console:
+# >> Flex.doc
+
+
+
+#-----------------------------------------------------------------------------#
+### Index ###
+# http://www.elasticsearch.org/guide/reference/api/index_/
+
+# You must pass the :data variable
+store: &store
+  - PUT
+  - /<<index>>/<<type>>/<<id>>
+
+# alias for symmetry with post_store
+put_store: *store
+
+# id is assigned by ES; you must pass :data
+post_store:
+  - POST
+  - /<<index>>/<<type>>
+
+
+
+#-----------------------------------------------------------------------------#
+### Delete ###
+# http://www.elasticsearch.org/guide/reference/api/delete/
+
+delete: &delete
+  - DELETE
+  - /<<index>>/<<type>>/<<id>>
+
+remove: *delete
+
+
+
+#-----------------------------------------------------------------------------#
+### Get ###
+# http://www.elasticsearch.org/guide/reference/api/get.html
+
+get:
+  - GET
+  - /<<index>>/<<type>>/<<id>>
+
+get_source:
+  - GET
+  - /<<index>>/<<type>>/<<id>>/_source
+
+
+
+#-----------------------------------------------------------------------------#
+### Multi Get ###
+# http://www.elasticsearch.org/guide/reference/api/multi-get.html
+
+multi_get:
+  - GET
+  - /<<index>>/<<type>>/_mget
+  - ids: << ids >>
+
+
+
+#-----------------------------------------------------------------------------#
+### Update ###
+# http://www.elasticsearch.org/guide/reference/api/update/
+
+# you must pass script or doc and the other options as the :data variable
+update:
+  - POST
+  - /<<index>>/<<type>>/<<id>>/_update
+
+
+
+#-----------------------------------------------------------------------------#
+### Search ###
+# The search api is covered by the templating system
+
+
+
+#-----------------------------------------------------------------------------#
+### Multi Search ###
+# the Multi Search api is covered by the YourClass.multi_search method
+# added by the Flex::Templates module
+
+
+
+#-----------------------------------------------------------------------------#
+### Percolate ###
+# http://www.elasticsearch.org/guide/reference/api/percolate.html
+
+# You must pass the the document (and additional queries) as :data variable
+percolate:
+  - GET
+  - /<<index>>/<<type>>/_percolate
+
+# You must pass the the query (and additional fields) as :data variable
+put_percolator:
+  - PUT
+  - /_percolator/<<index>>/<<percolator>>
+
+# http://www.elasticsearch.org/guide/reference/api/percolate.html
+delete_percolator:
+  - DELETE
+  - /_percolator/<<index>>/<<percolator>>
+
+
+
+#-----------------------------------------------------------------------------#
+### Bulk ###
+# http://www.elasticsearch.org/guide/reference/api/bulk.html
+
+post_bulk_string: &bulk
+  - POST
+  - /_bulk
+  - << bulk_string >>
+
+# Deprecated alias for backward compatibility
+bulk: *bulk
+
+
+
+#-----------------------------------------------------------------------------#
+### Count ###
+# http://www.elasticsearch.org/guide/reference/api/count.html
+
+count:
+  - GET
+  - /<<index>>/<<type>>/_count
+  # pass :data structure if you need
+
+
+
+#-----------------------------------------------------------------------------#
+### Delete by query ###
+# http://www.elasticsearch.org/guide/reference/api/delete-by-query.html
+
+delete_by_query:
+  - DELETE
+  - /<<index>>/<<type>>/_query
+  # pass :data variable query if you need
+
+
+
+#-----------------------------------------------------------------------------#
+### More Like This ###
+# http://www.elasticsearch.org/guide/reference/api/more-like-this.html
+
+# You can pass the search API (facets, from/to and so on) as :data variable
+more_like_this: &mlt
+  - GET
+  - /<<index>>/<<type>>/<<id>>/_mlt
+
+# aliased
+mlt: *mlt
+
+
+
+#-----------------------------------------------------------------------------#
+### Validate ###
+# http://www.elasticsearch.org/guide/reference/api/validate/
+
+# you must pass the query to validate as the :data variable
+# you can pass the parameters as the :params variable
+validate:
+  - GET
+  - /<<index>>/<<type>>/_validate/query
+
+
+
+#-----------------------------------------------------------------------------#
+### Explain ###
+# http://www.elasticsearch.org/guide/reference/api/explain/
+
+# you must pass the query to explain as the :data variable
+# you can pass the parameters as the :params variable
+explain:
+  - GET
+  - /<<index>>/<<type>>/<<id>>/_explain
+
+
+
+#-----------------------------------------------------------------------------#
+### Flex additions ###
+
+# not a real API method, but handy
+match_all:
+  - GET
+  - /<<index>>/<<type>>/_search
+  - query:
+      match_all: {}
+
+
+
+#-----------------------------------------------------------------------------#
+# get a document without using the get API (which doesn't support fields '*')
+search_by_id:
+  - GET
+  - /<<index>>/<<type>>/_search
+  - query:
+      term:
+        _id: <<id>>

data/lib/flex/api_templates/indices_api.yml

@@ -0,0 +1,304 @@
+# These methods are available as Flex.<method>(variable_hash)
+# you can get the updated full reference and usage example of these methods
+# by just doing in the console:
+# >> Flex.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
+
+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>>
+  - settings:
+      number_of_shards: <<number_of_shards= 5 >>
+      number_of_replicas: <<number_of_replicas= 1 >>
+
+# aliased
+create_index: *create
+
+post_index:
+  - POST
+  - /<<index>>
+  - settings:
+      number_of_shards: <<number_of_shards= 5 >>
+      number_of_replicas: <<number_of_replicas= 1 >>
+
+
+
+#-----------------------------------------------------------------------------#
+### Delete Index ###
+# http://www.elasticsearch.org/guide/reference/api/delete.html
+
+delete_index:
+  - DELETE
+  - /<<index>>
+
+
+
+#-----------------------------------------------------------------------------#
+### Open/Close Index ###
+# http://www.elasticsearch.org/guide/reference/api/admin-indices-open-close/
+
+close_index:
+  - POST
+  - /<<index>>/_close
+
+open_index:
+  - POST
+  - /<<index>>/_open
+
+
+
+#-----------------------------------------------------------------------------#
+### 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
+
+
+
+#-----------------------------------------------------------------------------#
+### Get Mappings ###
+# http://www.elasticsearch.org/guide/reference/api/admin-indices-get-mapping.html
+
+get_index_mapping: &get_index_mapping
+  - GET
+  - /<<index>>/<<type>>/_mapping
+
+# alias
+get_mapping: *get_index_mapping
+
+
+
+#-----------------------------------------------------------------------------#
+### Put Mappings ###
+# http://www.elasticsearch.org/guide/reference/api/admin-indices-put-mapping.html
+
+put_index_mapping: &put_index_mapping
+  - PUT
+  - /<<index>>/<<type>>/_mapping
+  - <<type>>:
+      properties: <<properties>>
+
+# alias
+put_mapping: *put_index_mapping
+
+
+
+#-----------------------------------------------------------------------------#
+### 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
+
+
+
+#-----------------------------------------------------------------------------#
+### Refresh ###
+# http://www.elasticsearch.org/guide/reference/api/admin-indices-refresh.html
+
+refresh_index:
+  - POST
+  - /<<index>>/_refresh
+
+
+
+#-----------------------------------------------------------------------------#
+### Optimize ###
+# http://www.elasticsearch.org/guide/reference/api/admin-indices-optimize/
+
+# you can pass the parameters as the :params variable
+optimize_index:
+  - POST
+  - /<<index>>/_optimize
+
+
+
+#-----------------------------------------------------------------------------#
+### Flush ###
+# http://www.elasticsearch.org/guide/reference/api/admin-indices-flush/
+
+# you can pass the parameters as the :params variable
+flush_index:
+  - POST
+  - /<<index>>/_flush
+
+
+
+#-----------------------------------------------------------------------------#
+### Snapshot ###
+# http://www.elasticsearch.org/guide/reference/api/admin-indices-gateway-snapshot/
+
+gateway_snapshot:
+  - POST
+  - /<<index>>/_gateway/snapshot
+
+
+
+#-----------------------------------------------------------------------------#
+### Update Settings ###
+# http://www.elasticsearch.org/guide/reference/api/admin-indices-update-settings/
+
+# you can pass the settings structure as the :data variable
+update_index_settings:
+  - PUT
+  - /<<index>>/_settings
+
+
+
+#-----------------------------------------------------------------------------#
+### 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>>
+
+delete_index_template:
+  - DELETE
+  - /_template/<<template>>
+
+get_index_template:
+  - GET
+  - /_template/<<template>>
+
+
+
+#-----------------------------------------------------------------------------#
+### Warmers ###
+# http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/
+
+# you must pass the warmer structure as the :data variable
+put_index_warmer:
+  - PUT
+  - /<<index>>/<<type>>/_warmer/<<warmer>>
+
+delete_index_warmer:
+  - DELETE
+  - /<<index>>/_warmer/<<warmer= ~ >>
+
+get_index_warmer:
+  - GET
+  - /<<index>>/_warmer/<<warmer= ~ >>
+
+
+
+#-----------------------------------------------------------------------------#
+### Stats ###
+# http://www.elasticsearch.org/guide/reference/api/admin-indices-stats.html
+
+index_stats: &index_stats
+  - GET
+  - /<<index>>/_stats/<<endpoint= ~ >>/<<names= ~ >>
+
+# alias
+stats: *index_stats
+
+
+
+#-----------------------------------------------------------------------------#
+### Status ###
+# http://www.elasticsearch.org/guide/reference/api/admin-indices-status/
+
+index_status:
+  - GET
+  - /<<index>>/_status
+
+
+
+#-----------------------------------------------------------------------------#
+### Segments ###
+# http://www.elasticsearch.org/guide/reference/api/admin-indices-segments/
+
+index_segments:
+  - GET
+  - /<<index>>/_segments
+
+
+
+#-----------------------------------------------------------------------------#
+### Clear Cache ###
+#http://www.elasticsearch.org/guide/reference/api/admin-indices-clearcache/
+
+index_clearcache:
+  - POST
+  - /<<index>>/_cache/clear
+
+
+
+#-----------------------------------------------------------------------------#
+### Indices Exists ###
+# http://www.elasticsearch.org/guide/reference/api/admin-indices-indices-exists.html
+
+indices_exists: &exist
+  - HEAD
+  - /<<index>>
+
+# aliased
+exist?: *exist
+
+
+
+#-----------------------------------------------------------------------------#
+### Types Exists ###
+# http://www.elasticsearch.org/guide/reference/api/admin-indices-types-exists/
+
+types_exists:
+  - HEAD
+  - /<<index>>/<<type>>