Skip to content

Commit 510c91f

Browse files
committed
[API] Updates x-pack APIs
- Source code documentation updated - APIs promoted from experimental: - fleet.global_checkpoints - monitoring.bulk - searchable_snapshots.mount - searchable_snapshots.stats - security/clear_cached_service_tokens - security/create_service_token - security/delete_service_token - security/get_service_accounts - security/get_service_credentials - terms_enum
1 parent 961cf86 commit 510c91f

36 files changed

+64
-98
lines changed

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/ml_trained_models.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ module Actions
2424
#
2525
# @option arguments [String] :model_id The ID of the trained models stats to fetch
2626
# @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified)
27-
# @option arguments [Int] :from skips a number of trained models
28-
# @option arguments [Int] :size specifies a max number of trained models to get
27+
# @option arguments [Integer] :from skips a number of trained models
28+
# @option arguments [Integer] :size specifies a max number of trained models to get
2929
# @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
3030
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
3131
# @option arguments [List] :h Comma-separated list of column names to display

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/transforms.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ module Actions
2323
# Gets configuration and usage information about transforms.
2424
#
2525
# @option arguments [String] :transform_id The id of the transform for which to get stats. '_all' or '*' implies all transforms
26-
# @option arguments [Int] :from skips a number of transform configs, defaults to 0
27-
# @option arguments [Int] :size specifies a max number of transforms to get, defaults to 100
26+
# @option arguments [Integer] :from skips a number of transform configs, defaults to 0
27+
# @option arguments [Integer] :size specifies a max number of transforms to get, defaults to 100
2828
# @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)
2929
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
3030
# @option arguments [List] :h Comma-separated list of column names to display

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/get_transform.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ module Actions
2727
# SLA of official GA features.
2828
#
2929
# @option arguments [String] :transform_id The id or comma delimited list of id expressions of the transforms to get, '_all' or '*' implies get all transforms
30-
# @option arguments [Int] :from skips a number of transform configs, defaults to 0
31-
# @option arguments [Int] :size specifies a max number of transforms to get, defaults to 100
30+
# @option arguments [Integer] :from skips a number of transform configs, defaults to 0
31+
# @option arguments [Integer] :size specifies a max number of transforms to get, defaults to 100
3232
# @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)
3333
# @option arguments [Boolean] :exclude_generated Omits generated fields. Allows transform configurations to be easily copied between clusters and within the same cluster
3434
# @option arguments [Hash] :headers Custom HTTP headers

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/fleet/global_checkpoints.rb

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,6 @@ module API
2121
module Fleet
2222
module Actions
2323
# Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project.
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.
2824
#
2925
# @option arguments [String] :index The name of the index.
3026
# @option arguments [Boolean] :wait_for_advance Whether to wait for the global checkpoint to advance past the specified current checkpoints
@@ -33,7 +29,7 @@ module Actions
3329
# @option arguments [Time] :timeout Timeout to wait for global checkpoint to advance
3430
# @option arguments [Hash] :headers Custom HTTP headers
3531
#
36-
# @see [TODO]
32+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/get-global-checkpoints.html
3733
#
3834
def global_checkpoints(arguments = {})
3935
raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/explain_data_frame_analytics.rb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,11 @@ def explain_data_frame_analytics(arguments = {})
4141
Elasticsearch::API::HTTP_GET
4242
end
4343

44-
path = if _id
45-
"_ml/data_frame/analytics/#{Elasticsearch::API::Utils.__listify(_id)}/_explain"
46-
else
47-
"_ml/data_frame/analytics/_explain"
48-
end
44+
path = if _id
45+
"_ml/data_frame/analytics/#{Elasticsearch::API::Utils.__listify(_id)}/_explain"
46+
else
47+
"_ml/data_frame/analytics/_explain"
48+
end
4949
params = {}
5050

5151
body = arguments[:body]

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/find_file_structure.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ module Actions
2626
# to fix any issues, but experimental features are not subject to the
2727
# support SLA of official GA features.
2828
#
29-
# @option arguments [Int] :lines_to_sample How many lines of the file should be included in the analysis
30-
# @option arguments [Int] :line_merge_size_limit Maximum number of characters permitted in a single message when lines are merged to create messages.
29+
# @option arguments [Integer] :lines_to_sample How many lines of the file should be included in the analysis
30+
# @option arguments [Integer] :line_merge_size_limit Maximum number of characters permitted in a single message when lines are merged to create messages.
3131
# @option arguments [Time] :timeout Timeout after which the analysis will be aborted
3232
# @option arguments [String] :charset Optional parameter to specify the character set of the file
3333
# @option arguments [String] :format Optional parameter to specify the high level file format (options: ndjson, xml, delimited, semi_structured_text)

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/get_buckets.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ module Actions
2626
# @option arguments [String] :timestamp The timestamp of the desired single bucket result
2727
# @option arguments [Boolean] :expand Include anomaly records
2828
# @option arguments [Boolean] :exclude_interim Exclude interim results
29-
# @option arguments [Int] :from skips a number of buckets
30-
# @option arguments [Int] :size specifies a max number of buckets to get
29+
# @option arguments [Integer] :from skips a number of buckets
30+
# @option arguments [Integer] :size specifies a max number of buckets to get
3131
# @option arguments [String] :start Start time filter for buckets
3232
# @option arguments [String] :end End time filter for buckets
3333
# @option arguments [Double] :anomaly_score Filter for the most anomalous buckets

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/get_calendar_events.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ module Actions
2626
# @option arguments [String] :job_id Get events for the job. When this option is used calendar_id must be '_all'
2727
# @option arguments [String] :start Get events after this time
2828
# @option arguments [Date] :end Get events before this time
29-
# @option arguments [Int] :from Skips a number of events
30-
# @option arguments [Int] :size Specifies a max number of events to get
29+
# @option arguments [Integer] :from Skips a number of events
30+
# @option arguments [Integer] :size Specifies a max number of events to get
3131
# @option arguments [Hash] :headers Custom HTTP headers
3232
#
3333
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-get-calendar-event.html

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/get_calendars.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ module Actions
2323
# Retrieves configuration information for calendars.
2424
#
2525
# @option arguments [String] :calendar_id The ID of the calendar to fetch
26-
# @option arguments [Int] :from skips a number of calendars
27-
# @option arguments [Int] :size specifies a max number of calendars to get
26+
# @option arguments [Integer] :from skips a number of calendars
27+
# @option arguments [Integer] :size specifies a max number of calendars to get
2828
# @option arguments [Hash] :headers Custom HTTP headers
2929
# @option arguments [Hash] :body The from and size parameters optionally sent in the body
3030
#

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/get_categories.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ module Actions
2424
#
2525
# @option arguments [String] :job_id The name of the job
2626
# @option arguments [Long] :category_id The identifier of the category definition of interest
27-
# @option arguments [Int] :from skips a number of categories
28-
# @option arguments [Int] :size specifies a max number of categories to get
27+
# @option arguments [Integer] :from skips a number of categories
28+
# @option arguments [Integer] :size specifies a max number of categories to get
2929
# @option arguments [String] :partition_field_value Specifies the partition to retrieve categories for. This is optional, and should never be used for jobs where per-partition categorization is disabled.
3030
# @option arguments [Hash] :headers Custom HTTP headers
3131
# @option arguments [Hash] :body Category selection details if not provided in URI

0 commit comments

Comments
 (0)