Skip to content

Commit 3fa78e0

Browse files
committed
[API][DOCS] Streamlines api source code documentation based on specificiation/generator updates.
Improves type definitions for parameters in source code documentation.
1 parent fae4bf9 commit 3fa78e0

File tree

512 files changed

+575
-783
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

512 files changed

+575
-783
lines changed

elasticsearch-api/lib/elasticsearch/api/actions/async_search/delete.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ module Actions
3030
# @option arguments [String] :id A unique identifier for the async search. (*Required*)
3131
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
3232
# when they occur.
33-
# @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response
33+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
3434
# returned by Elasticsearch.
3535
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
3636
# For example `"exists_time": "1h"` for humans and

elasticsearch-api/lib/elasticsearch/api/actions/async_search/get.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ module Actions
3838
# By default no timeout is set meaning that the currently available results will be returned without any additional wait.
3939
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
4040
# when they occur.
41-
# @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response
41+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
4242
# returned by Elasticsearch.
4343
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
4444
# For example `"exists_time": "1h"` for humans and

elasticsearch-api/lib/elasticsearch/api/actions/async_search/status.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ module Actions
3333
# Ongoing async searches and any saved search results are deleted after this period. Server default: 5d.
3434
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
3535
# when they occur.
36-
# @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response
36+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
3737
# returned by Elasticsearch.
3838
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
3939
# For example `"exists_time": "1h"` for humans and

elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,10 @@ module Actions
7474
# @option arguments [String] :q Query in the Lucene query string syntax
7575
# @option arguments [Integer] :size Number of hits to return (default: 10)
7676
# @option arguments [Integer] :from Starting offset (default: 0)
77-
# @option arguments [String] :sort A comma-separated list of <field>:<direction> pairs
77+
# @option arguments [String, Array<String>] :sort A comma-separated list of <field>:<direction> pairs
7878
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
7979
# when they occur.
80-
# @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response
80+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
8181
# returned by Elasticsearch.
8282
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
8383
# For example `"exists_time": "1h"` for humans and

elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ module Actions
141141
# @option arguments [Boolean] :require_data_stream If `true`, the request's actions must target a data stream (existing or to be created).
142142
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
143143
# when they occur.
144-
# @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response
144+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
145145
# returned by Elasticsearch.
146146
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
147147
# For example `"exists_time": "1h"` for humans and

elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ module Actions
4545
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
4646
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
4747
# when they occur.
48-
# @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response
48+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
4949
# returned by Elasticsearch.
5050
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
5151
# For example `"exists_time": "1h"` for humans and

elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ module Actions
4444
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
4545
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
4646
# when they occur.
47-
# @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response
47+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
4848
# returned by Elasticsearch.
4949
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
5050
# For example `"exists_time": "1h"` for humans and

elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ module Actions
4747
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
4848
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
4949
# when they occur.
50-
# @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response
50+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
5151
# returned by Elasticsearch.
5252
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
5353
# For example `"exists_time": "1h"` for humans and

elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ module Actions
4242
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
4343
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
4444
# when they occur.
45-
# @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response
45+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
4646
# returned by Elasticsearch.
4747
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
4848
# For example `"exists_time": "1h"` for humans and

elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ module Actions
4141
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
4242
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
4343
# when they occur.
44-
# @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response
44+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
4545
# returned by Elasticsearch.
4646
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
4747
# For example `"exists_time": "1h"` for humans and

0 commit comments

Comments
 (0)