Skip to content

Commit

Permalink
[API] Auto-generated API code - Updates source code documentation URL
Browse files Browse the repository at this point in the history
Co-authored-by: Fernando Briano <fernando@picandocodigo.net>
  • Loading branch information
elasticmachine and picandocodigo committed Dec 7, 2022
1 parent d4d4fa0 commit d0e40c7
Show file tree
Hide file tree
Showing 409 changed files with 409 additions and 409 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ module Actions
# @option arguments [String] :id The async search ID
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/async-search.html
#
def delete(arguments = {})
raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ module Actions
# @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/async-search.html
#
def get(arguments = {})
raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ module Actions
# @option arguments [String] :id The async search ID
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/async-search.html
#
def status(arguments = {})
raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ module Actions
# @option arguments [Hash] :headers Custom HTTP headers
# @option arguments [Hash] :body The search definition using the Query DSL
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/async-search.html
#
def submit(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ module Actions
# @option arguments [String] :name the name of the autoscaling policy
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-delete-autoscaling-policy.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/autoscaling-delete-autoscaling-policy.html
#
def delete_autoscaling_policy(arguments = {})
raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ module Actions
#
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-capacity.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/autoscaling-get-autoscaling-capacity.html
#
def get_autoscaling_capacity(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ module Actions
# @option arguments [String] :name the name of the autoscaling policy
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-policy.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/autoscaling-get-autoscaling-policy.html
#
def get_autoscaling_policy(arguments = {})
raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ module Actions
# @option arguments [Hash] :headers Custom HTTP headers
# @option arguments [Hash] :body the specification of the autoscaling policy (*Required*)
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-put-autoscaling-policy.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/autoscaling-put-autoscaling-policy.html
#
def put_autoscaling_policy(arguments = {})
raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
Expand Down
2 changes: 1 addition & 1 deletion elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ module Actions
# @option arguments [String|Array] :body The operation definition and data (action-data pairs), separated by newlines. Array of Strings, Header/Data pairs,
# or the conveniency "combined" format can be passed, refer to Elasticsearch::API::Utils.__bulkify documentation.
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/docs-bulk.html
#
def bulk(arguments = {})
raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ module Actions
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-alias.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-alias.html
#
def aliases(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-allocation.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-allocation.html
#
def allocation(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-compoentn-templates.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-compoentn-templates.html
#
def component_templates(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-count.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-count.html
#
def count(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-fielddata.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-fielddata.html
#
def fielddata(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-health.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-health.html
#
def health(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ module Actions
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat.html
#
def help(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ module Actions
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-indices.html
#
def indices(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-master.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-master.html
#
def master(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html
# @see http://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-dfanalytics.html
#
def ml_data_frame_analytics(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html
# @see http://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-datafeeds.html
#
def ml_datafeeds(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html
# @see http://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-anomaly-detectors.html
#
def ml_jobs(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-trained-model.html
#
def ml_trained_models(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-nodeattrs.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-nodeattrs.html
#
def nodeattrs(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ module Actions
# @option arguments [Boolean] :include_unloaded_segments If set to true segment stats will include stats for segments that are not currently loaded into memory
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-nodes.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-nodes.html
#
def nodes(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-pending-tasks.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-pending-tasks.html
#
def pending_tasks(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-plugins.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-plugins.html
#
def plugins(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-recovery.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-recovery.html
#
def recovery(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-repositories.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-repositories.html
#
def repositories(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-segments.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-segments.html
#
def segments(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-shards.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-shards.html
#
def shards(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-snapshots.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-snapshots.html
#
def snapshots(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/tasks.html
#
def tasks(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-templates.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-templates.html
#
def templates(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-thread-pool.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-thread-pool.html
#
def thread_pool(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cat-transforms.html
#
def transforms(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ module Actions
# Deprecated since version 7.0.0
#
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-scroll-api.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/clear-scroll-api.html
#
def clear_scroll(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ module Actions
# @option arguments [Hash] :headers Custom HTTP headers
# @option arguments [Hash] :body a point-in-time id to close
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/point-in-time-api.html
#
def close_point_in_time(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ module Actions
# @option arguments [Hash] :headers Custom HTTP headers
# @option arguments [Hash] :body The index, shard, and primary flag to explain. Empty means 'explain a randomly-chosen unassigned shard'
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-allocation-explain.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/cluster-allocation-explain.html
#
def allocation_explain(arguments = {})
arguments = arguments.clone
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ module Actions
# @option arguments [Time] :master_timeout Specify timeout for connection to master
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/indices-component-template.html
#
def delete_component_template(arguments = {})
raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ module Actions
# @option arguments [Time] :master_timeout Timeout for submitting request to master
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/voting-config-exclusions.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.6/voting-config-exclusions.html
#
def delete_voting_config_exclusions(arguments = {})
arguments = arguments.clone
Expand Down

0 comments on commit d0e40c7

Please sign in to comment.