Skip to content

Commit b181431

Browse files
committed
[API] Updates source code documentation
1 parent 161d6d9 commit b181431

File tree

10 files changed

+14
-15
lines changed

10 files changed

+14
-15
lines changed

elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ module Actions
3636
# @option arguments [Hash] :headers Custom HTTP headers
3737
# @option arguments [Hash] :body request body
3838
#
39-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-rest.html
39+
# @see https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql-rest
4040
#
4141
def query(arguments = {})
4242
request_opts = { endpoint: arguments[:endpoint] || 'esql.query' }

elasticsearch-api/lib/elasticsearch/api/actions/fleet/msearch.rb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ module Actions
4646
# @option arguments [Array<Integer>] :wait_for_checkpoints A comma separated list of checkpoints. When configured, the search API will only be executed on a shard
4747
# after the relevant checkpoint has become visible for search. Defaults to an empty list which will cause
4848
# Elasticsearch to immediately execute the search. Server default: [].
49-
# @option arguments [Boolean] :allow_partial_search_results If true, returns partial results if there are shard request timeouts or {https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-replication.html#shard-failures shard failures}. If false, returns
50-
# an error with no partial results. Defaults to the configured cluster setting +search.default_allow_partial_results+
51-
# which is true by default.
49+
# @option arguments [Boolean] :allow_partial_search_results If true, returns partial results if there are shard request timeouts or shard failures.
50+
# If false, returns an error with no partial results.
51+
# Defaults to the configured cluster setting +search.default_allow_partial_results+, which is true by default.
5252
# @option arguments [Hash] :headers Custom HTTP headers
5353
# @option arguments [Hash] :body searches
5454
#

elasticsearch-api/lib/elasticsearch/api/actions/fleet/search.rb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,9 @@ module Actions
7575
# @option arguments [Array<Integer>] :wait_for_checkpoints A comma separated list of checkpoints. When configured, the search API will only be executed on a shard
7676
# after the relevant checkpoint has become visible for search. Defaults to an empty list which will cause
7777
# Elasticsearch to immediately execute the search. Server default: [].
78-
# @option arguments [Boolean] :allow_partial_search_results If true, returns partial results if there are shard request timeouts or {https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-replication.html#shard-failures shard failures}. If false, returns
79-
# an error with no partial results. Defaults to the configured cluster setting +search.default_allow_partial_results+
80-
# which is true by default.
78+
# @option arguments [Boolean] :allow_partial_search_results If true, returns partial results if there are shard request timeouts or shard failures.
79+
# If false, returns an error with no partial results.
80+
# Defaults to the configured cluster setting +search.default_allow_partial_results+, which is true by default.
8181
# @option arguments [Hash] :headers Custom HTTP headers
8282
# @option arguments [Hash] :body request body
8383
#

elasticsearch-api/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ module Actions
2727
#
2828
# @option arguments [Hash] :headers Custom HTTP headers
2929
#
30-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/geoip-processor.html
30+
# @see https://www.elastic.co/docs/reference/enrich-processor/geoip-processor
3131
#
3232
def geo_ip_stats(arguments = {})
3333
request_opts = { endpoint: arguments[:endpoint] || 'ingest.geo_ip_stats' }

elasticsearch-api/lib/elasticsearch/api/actions/ingest/processor_grok.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ module Actions
2929
#
3030
# @option arguments [Hash] :headers Custom HTTP headers
3131
#
32-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html
32+
# @see https://www.elastic.co/docs/reference/enrich-processor/grok-processor
3333
#
3434
def processor_grok(arguments = {})
3535
request_opts = { endpoint: arguments[:endpoint] || 'ingest.processor_grok' }

elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_pipeline.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ module Actions
3232
# @option arguments [Hash] :headers Custom HTTP headers
3333
# @option arguments [Hash] :body request body
3434
#
35-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html
35+
# @see https://www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines
3636
#
3737
def put_pipeline(arguments = {})
3838
request_opts = { endpoint: arguments[:endpoint] || 'ingest.put_pipeline' }

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ module Actions
4545
# @option arguments [Hash] :headers Custom HTTP headers
4646
# @option arguments [Hash] :body request body
4747
#
48-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/knn-search-api.html
48+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-knn-search
4949
#
5050
def knn_search(arguments = {})
5151
request_opts = { endpoint: arguments[:endpoint] || 'knn_search' }

elasticsearch-api/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,7 @@ module Actions
3131
# to fix any issues, but experimental features are not subject to the
3232
# support SLA of official GA features.
3333
#
34-
# @option arguments [String, Array] :node_id Comma-separated list of node IDs or names used to limit returned information.
35-
# All the nodes selective options are explained {https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes here}. (*Required*)
34+
# @option arguments [String, Array] :node_id Comma-separated list of node IDs or names used to limit returned information. (*Required*)
3635
# @option arguments [Hash] :headers Custom HTTP headers
3736
#
3837
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-get-repositories-metering-info

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ module Actions
3535
# @option arguments [Hash] :headers Custom HTTP headers
3636
# @option arguments [Hash] :body request body
3737
#
38-
# @see https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-execute-api.html
38+
# @see https://www.elastic.co/docs/reference/scripting-languages/painless/painless-api-examples
3939
#
4040
def scripts_painless_execute(arguments = {})
4141
request_opts = { endpoint: arguments[:endpoint] || 'scripts_painless_execute' }

elasticsearch-api/lib/elasticsearch/api/version.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@
1818
module Elasticsearch
1919
module API
2020
VERSION = '9.0.0'.freeze
21-
ES_SPECIFICATION_COMMIT = 'f22adb6578817d606ea57d9de89c789e7979cf1c'.freeze
21+
ES_SPECIFICATION_COMMIT = '55d1444f19ce33e5a7a318e51ccc638a7901959c'.freeze
2222
end
2323
end

0 commit comments

Comments
 (0)