Skip to content

Commit 3615c87

Browse files
committed
[API] Updates API source code docs
1 parent 8f9af95 commit 3615c87

File tree

9 files changed

+21
-7
lines changed

9 files changed

+21
-7
lines changed

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/indices/freeze.rb

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,11 @@ module Actions
3131
# @option arguments [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns.
3232
# @option arguments [Hash] :headers Custom HTTP headers
3333
#
34+
# *Deprecation notice*:
35+
# Frozen indices are deprecated because they provide no benefit given improvements in heap memory utilization. They will be removed in a future release.
36+
# Deprecated since version 7.14.0
37+
#
38+
#
3439
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/freeze-index-api.html
3540
#
3641
def freeze(arguments = {})

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/indices/unfreeze.rb

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,11 @@ module Actions
3131
# @option arguments [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns.
3232
# @option arguments [Hash] :headers Custom HTTP headers
3333
#
34+
# *Deprecation notice*:
35+
# Frozen indices are deprecated because they provide no benefit given improvements in heap memory utilization. They will be removed in a future release.
36+
# Deprecated since version 7.14.0
37+
#
38+
#
3439
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/unfreeze-index-api.html
3540
#
3641
def unfreeze(arguments = {})

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/rollup/rollup.rb

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,17 @@ module API
2121
module Rollup
2222
module Actions
2323
# Rollup an index
24+
# This functionality is Experimental and may be changed or removed
25+
# completely in a future release. Elastic will take a best effort approach
26+
# to fix any issues, but experimental features are not subject to the
27+
# support SLA of official GA features.
2428
#
2529
# @option arguments [String] :index The index to roll up (*Required*)
2630
# @option arguments [String] :rollup_index The name of the rollup index to create (*Required*)
2731
# @option arguments [Hash] :headers Custom HTTP headers
2832
# @option arguments [Hash] :body The rollup configuration (*Required*)
2933
#
30-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/rollup-api.html
34+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/xpack-rollup.html
3135
#
3236
def rollup(arguments = {})
3337
raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/saml_authenticate.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ module Actions
2525
# @option arguments [Hash] :headers Custom HTTP headers
2626
# @option arguments [Hash] :body The SAML response to authenticate (*Required*)
2727
#
28-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-saml-authenticate.html
28+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/security-api-saml-authenticate.html
2929
#
3030
def saml_authenticate(arguments = {})
3131
raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/saml_complete_logout.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ module Actions
2525
# @option arguments [Hash] :headers Custom HTTP headers
2626
# @option arguments [Hash] :body The logout response to verify (*Required*)
2727
#
28-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-saml-complete-logout.html
28+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/security-api-saml-complete-logout.html
2929
#
3030
def saml_complete_logout(arguments = {})
3131
raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/saml_invalidate.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ module Actions
2525
# @option arguments [Hash] :headers Custom HTTP headers
2626
# @option arguments [Hash] :body The LogoutRequest message (*Required*)
2727
#
28-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-saml-invalidate.html
28+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/security-api-saml-invalidate.html
2929
#
3030
def saml_invalidate(arguments = {})
3131
raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/saml_logout.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ module Actions
2525
# @option arguments [Hash] :headers Custom HTTP headers
2626
# @option arguments [Hash] :body The tokens to invalidate (*Required*)
2727
#
28-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-saml-logout.html
28+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/security-api-saml-logout.html
2929
#
3030
def saml_logout(arguments = {})
3131
raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/saml_prepare_authentication.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ module Actions
2525
# @option arguments [Hash] :headers Custom HTTP headers
2626
# @option arguments [Hash] :body The realm for which to create the authentication request, identified by either its name or the ACS URL (*Required*)
2727
#
28-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-saml-prepare-authentication.html
28+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/security-api-saml-prepare-authentication.html
2929
#
3030
def saml_prepare_authentication(arguments = {})
3131
raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/saml_service_provider_metadata.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ module Actions
2525
# @option arguments [String] :realm_name The name of the SAML realm to get the metadata for
2626
# @option arguments [Hash] :headers Custom HTTP headers
2727
#
28-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-saml-sp-metadata.html
28+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/security-api-saml-sp-metadata.html
2929
#
3030
def saml_service_provider_metadata(arguments = {})
3131
raise ArgumentError, "Required argument 'realm_name' missing" unless arguments[:realm_name]

0 commit comments

Comments
 (0)