# 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



#-----------------------------------------------------------------------------#
### Create Index ###

put_index:
  - PUT
  - /<<index>>
  - settings:
      number_of_shards: <<number_of_shards= 5 >>
      number_of_replicas: <<number_of_replicas= 1 >>
  - &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
  - /<<index>>
  - settings:
      number_of_shards: <<number_of_shards= 5 >>
      number_of_replicas: <<number_of_replicas= 1 >>
  - *create_index



#-----------------------------------------------------------------------------#
### Delete Index ###

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 ###

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



#-----------------------------------------------------------------------------#
### Put Mappings ###

put_index_mapping:
  - PUT
  - /<<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 ###

get_index_mapping:
  - GET
  - /<<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



#-----------------------------------------------------------------------------#
### 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



#-----------------------------------------------------------------------------#
### 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 ###

delete_index_mapping: &delete_index_mapping
  - DELETE
  - /<<index>>/<<type>>
  -
  - REFERENCES:
      group: indices_api
      api_name: Delete Mappings
      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-mapping.html



#-----------------------------------------------------------------------------#
### Index Aliases ###

# 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
  - /_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

delete_index_alias:
  - DELETE
  - /<<index>>/_alias/<<alias>>
  -
  - REFERENCES: *index_aliases

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."



#-----------------------------------------------------------------------------#
### Update Indices Settings ###

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



#-----------------------------------------------------------------------------#
### 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




#-----------------------------------------------------------------------------#
### Analyze ###

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."



#-----------------------------------------------------------------------------#
### 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 ###

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>>
  -
  - REFERENCES:
      <<: *warmers
      notice: "You must pass the warmer structure as the :data variable."

get_index_warmer:
  - GET
  - /<<index>>/_warmer/<<warmer= ~ >>
  -
  - REFERENCES: *warmers



#-----------------------------------------------------------------------------#
### Status ###

index_status:
  - GET
  - /<<index>>/_status
  -
  - REFERENCES:
      group: indices_api
      api_name: Status
      api_url: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-status.html



#-----------------------------------------------------------------------------#
### Stats ###

index_stats:
  - GET
  - /<<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 ###

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 ###

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



#-----------------------------------------------------------------------------#
### Flush ###

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."



#-----------------------------------------------------------------------------#
### 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."



#-----------------------------------------------------------------------------#
### Refresh ###

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."