diff --git a/docs/overlays/elasticsearch-openapi-overlays.yaml b/docs/overlays/elasticsearch-openapi-overlays.yaml index 009f05466b..db6d229871 100644 --- a/docs/overlays/elasticsearch-openapi-overlays.yaml +++ b/docs/overlays/elasticsearch-openapi-overlays.yaml @@ -392,6 +392,63 @@ actions: examples: indicesLegacyPutTemplateRequestExample1: $ref: "../../specification/indices/put_template/indicesPutTemplateRequestExample1.yaml" +## Examples for licensing + - target: "$.paths['/_license/basic_status']['get']" + description: "Add example for get basic status response" + update: + responses: + 200: + content: + application/json: + examples: + getBasicStatusResponseExample1: + $ref: "../../specification/license/get_basic_status/GetBasicLicenseStatusResponseExample1.yaml" + - target: "$.paths['/_license/trial_status']['get']" + description: "Add example for get trial status response" + update: + responses: + 200: + content: + application/json: + examples: + getLicenseResponseExample1: + $ref: "../../specification/license/get_trial_status/GetTrialLicenseStatusResponseExample1.yaml" + - target: "$.paths['/_license/start_basic']['post']" + description: "Add example for start basic response" + update: + responses: + 200: + content: + application/json: + examples: + startBasicLicenseResponseExample1: + $ref: "../../specification/license/post_start_basic/StartBasicLicenseResponseExample1.yaml" + - target: "$.paths['/_license/start_trial']['post']" + description: "Add example for start trial response" + update: + responses: + 200: + content: + application/json: + examples: + startTrialLicenseResponseExample1: + $ref: "../../specification/license/post_start_trial/StartTrialLicenseResponseExample1.yaml" + - target: "$.components['requestBodies']['license.post']" + description: "Add examples for update license request" + update: + content: + application/json: + examples: + updateLicenseRequestExample1: + $ref: "../../specification/license/post/PostLicenseRequestExample1.yaml" + - target: "$.components['responses']['license.post#200']" + description: "Add examples for update license response" + update: + content: + application/json: + examples: + clusterHealthResponseExample1: + $ref: "../../specification/license/post/PostLicenseResponseExample1.yaml" ## Examples for search applications - target: "$.paths['/_application/search_application/{name}/_render_query']['post']" description: "Add examples for render search application query operation" @@ -402,10 +459,5 @@ actions: examples: renderSearchApplicationQueryRequestExample1: $ref: "../../specification/search_application/render_query/SearchApplicationsRenderQueryRequestExample1.yaml" - responses: - 200: - content: - application/json: - examples: renderSearchApplicationQueryResponseExample1: $ref: "../../specification/search_application/render_query/SearchApplicationsRenderQueryResponseExample1.yaml" diff --git a/docs/overlays/elasticsearch-shared-overlays.yaml b/docs/overlays/elasticsearch-shared-overlays.yaml index 5be56c4137..b1a76afb98 100644 --- a/docs/overlays/elasticsearch-shared-overlays.yaml +++ b/docs/overlays/elasticsearch-shared-overlays.yaml @@ -1351,3 +1351,14 @@ actions: examples: indicesRolloverResponseExample1: $ref: "../../specification/indices/rollover/indicesRolloverResponseExample1.yaml" +## Examples for licensing + - target: "$.paths['/_license']['get']" + description: "Add example for get license response" + update: + responses: + 200: + content: + application/json: + examples: + getLicenseResponseExample1: + $ref: "../../specification/license/get/GetLicenseResponseExample1.yaml" \ No newline at end of file diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index c1e6e5b60c..541d6e135b 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -2602,7 +2602,7 @@ { "in": "path", "name": "index", - "description": "The name of the follower index", + "description": "The name of the follower index.", "required": true, "deprecated": false, "schema": { @@ -2613,7 +2613,7 @@ { "in": "query", "name": "wait_for_active_shards", - "description": "Sets the number of shard copies that must be active before returning. Defaults to 0. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)", + "description": "Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be\nactive.\nA shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the\nremote Lucene segment files to the follower index.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:WaitForActiveShards" @@ -2627,43 +2627,60 @@ "schema": { "type": "object", "properties": { + "data_stream_name": { + "description": "If the leader index is part of a data stream, the name to which the local data stream for the followed index should be renamed.", + "type": "string" + }, "leader_index": { "$ref": "#/components/schemas/_types:IndexName" }, "max_outstanding_read_requests": { + "description": "The maximum number of outstanding reads requests from the remote cluster.", "type": "number" }, "max_outstanding_write_requests": { + "description": "The maximum number of outstanding write requests on the follower.", "type": "number" }, "max_read_request_operation_count": { + "description": "The maximum number of operations to pull per read from the remote cluster.", "type": "number" }, "max_read_request_size": { - "type": "string" + "$ref": "#/components/schemas/_types:ByteSize" }, "max_retry_delay": { "$ref": "#/components/schemas/_types:Duration" }, "max_write_buffer_count": { + "description": "The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be\ndeferred until the number of queued operations goes below the limit.", "type": "number" }, "max_write_buffer_size": { - "type": "string" + "$ref": "#/components/schemas/_types:ByteSize" }, "max_write_request_operation_count": { + "description": "The maximum number of operations per bulk write request executed on the follower.", "type": "number" }, "max_write_request_size": { - "type": "string" + "$ref": "#/components/schemas/_types:ByteSize" }, "read_poll_timeout": { "$ref": "#/components/schemas/_types:Duration" }, "remote_cluster": { + "description": "The remote cluster containing the leader index.", "type": "string" + }, + "settings": { + "$ref": "#/components/schemas/indices._types:IndexSettings" } - } + }, + "required": [ + "leader_index", + "remote_cluster" + ] } } }, @@ -12016,18 +12033,11 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "data_retention": { - "$ref": "#/components/schemas/_types:Duration" - }, - "downsampling": { - "$ref": "#/components/schemas/indices._types:DataStreamLifecycleDownsampling" - } - } + "$ref": "#/components/schemas/indices._types:DataStreamLifecycle" } } - } + }, + "required": true }, "responses": { "200": { @@ -26968,7 +26978,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/search_application._types:SearchApplication" + "$ref": "#/components/schemas/search_application._types:SearchApplicationParameters" } } }, @@ -27186,7 +27196,7 @@ "results": { "type": "array", "items": { - "$ref": "#/components/schemas/search_application.list:SearchApplicationListItem" + "$ref": "#/components/schemas/search_application._types:SearchApplication" } } }, @@ -54326,1153 +54336,350 @@ } } }, - "ccr.follow_info:FollowerIndex": { + "indices._types:IndexSettings": { "type": "object", "properties": { - "follower_index": { - "$ref": "#/components/schemas/_types:IndexName" + "index": { + "$ref": "#/components/schemas/indices._types:IndexSettings" }, - "leader_index": { - "$ref": "#/components/schemas/_types:IndexName" + "mode": { + "type": "string" }, - "parameters": { - "$ref": "#/components/schemas/ccr.follow_info:FollowerIndexParameters" + "routing_path": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] }, - "remote_cluster": { - "$ref": "#/components/schemas/_types:Name" + "soft_deletes": { + "$ref": "#/components/schemas/indices._types:SoftDeletes" }, - "status": { - "$ref": "#/components/schemas/ccr.follow_info:FollowerIndexStatus" - } - }, - "required": [ - "follower_index", - "leader_index", - "remote_cluster", - "status" - ] - }, - "ccr.follow_info:FollowerIndexParameters": { - "type": "object", - "properties": { - "max_outstanding_read_requests": { - "type": "number" + "sort": { + "$ref": "#/components/schemas/indices._types:IndexSegmentSort" }, - "max_outstanding_write_requests": { - "type": "number" + "number_of_shards": { + "oneOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] }, - "max_read_request_operation_count": { + "number_of_replicas": { + "oneOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "number_of_routing_shards": { "type": "number" }, - "max_read_request_size": { + "check_on_startup": { + "$ref": "#/components/schemas/indices._types:IndexCheckOnStartup" + }, + "codec": { "type": "string" }, - "max_retry_delay": { - "$ref": "#/components/schemas/_types:Duration" + "routing_partition_size": { + "$ref": "#/components/schemas/_spec_utils:Stringifiedinteger" }, - "max_write_buffer_count": { - "type": "number" + "load_fixed_bitset_filters_eagerly": { + "type": "boolean" }, - "max_write_buffer_size": { + "hidden": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "string" + } + ] + }, + "auto_expand_replicas": { "type": "string" }, - "max_write_request_operation_count": { - "type": "number" + "merge": { + "$ref": "#/components/schemas/indices._types:Merge" }, - "max_write_request_size": { - "type": "string" + "search": { + "$ref": "#/components/schemas/indices._types:SettingsSearch" }, - "read_poll_timeout": { + "refresh_interval": { "$ref": "#/components/schemas/_types:Duration" - } - }, - "required": [ - "max_outstanding_read_requests", - "max_outstanding_write_requests", - "max_read_request_operation_count", - "max_read_request_size", - "max_retry_delay", - "max_write_buffer_count", - "max_write_buffer_size", - "max_write_request_operation_count", - "max_write_request_size", - "read_poll_timeout" - ] - }, - "ccr.follow_info:FollowerIndexStatus": { - "type": "string", - "enum": [ - "active", - "paused" - ] - }, - "ccr._types:FollowIndexStats": { - "type": "object", - "properties": { - "index": { - "$ref": "#/components/schemas/_types:IndexName" }, - "shards": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ccr._types:ShardStats" - } - } - }, - "required": [ - "index", - "shards" - ] - }, - "ccr._types:ShardStats": { - "type": "object", - "properties": { - "bytes_read": { + "max_result_window": { "type": "number" }, - "failed_read_requests": { + "max_inner_result_window": { "type": "number" }, - "failed_write_requests": { + "max_rescore_window": { "type": "number" }, - "fatal_exception": { - "$ref": "#/components/schemas/_types:ErrorCause" + "max_docvalue_fields_search": { + "type": "number" }, - "follower_aliases_version": { - "$ref": "#/components/schemas/_types:VersionNumber" + "max_script_fields": { + "type": "number" }, - "follower_global_checkpoint": { + "max_ngram_diff": { "type": "number" }, - "follower_index": { - "type": "string" + "max_shingle_diff": { + "type": "number" }, - "follower_mapping_version": { - "$ref": "#/components/schemas/_types:VersionNumber" + "blocks": { + "$ref": "#/components/schemas/indices._types:IndexSettingBlocks" }, - "follower_max_seq_no": { - "$ref": "#/components/schemas/_types:SequenceNumber" + "max_refresh_listeners": { + "type": "number" }, - "follower_settings_version": { - "$ref": "#/components/schemas/_types:VersionNumber" + "analyze": { + "$ref": "#/components/schemas/indices._types:SettingsAnalyze" }, - "last_requested_seq_no": { - "$ref": "#/components/schemas/_types:SequenceNumber" + "highlight": { + "$ref": "#/components/schemas/indices._types:SettingsHighlight" }, - "leader_global_checkpoint": { + "max_terms_count": { "type": "number" }, - "leader_index": { - "type": "string" + "max_regex_length": { + "type": "number" }, - "leader_max_seq_no": { - "$ref": "#/components/schemas/_types:SequenceNumber" + "routing": { + "$ref": "#/components/schemas/indices._types:IndexRouting" }, - "operations_read": { - "type": "number" + "gc_deletes": { + "$ref": "#/components/schemas/_types:Duration" }, - "operations_written": { - "type": "number" + "default_pipeline": { + "$ref": "#/components/schemas/_types:PipelineName" }, - "outstanding_read_requests": { - "type": "number" + "final_pipeline": { + "$ref": "#/components/schemas/_types:PipelineName" }, - "outstanding_write_requests": { - "type": "number" + "lifecycle": { + "$ref": "#/components/schemas/indices._types:IndexSettingsLifecycle" }, - "read_exceptions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ccr._types:ReadException" - } + "provided_name": { + "$ref": "#/components/schemas/_types:Name" }, - "remote_cluster": { - "type": "string" + "creation_date": { + "$ref": "#/components/schemas/_spec_utils:StringifiedEpochTimeUnitMillis" }, - "shard_id": { - "type": "number" + "creation_date_string": { + "$ref": "#/components/schemas/_types:DateTime" }, - "successful_read_requests": { - "type": "number" + "uuid": { + "$ref": "#/components/schemas/_types:Uuid" }, - "successful_write_requests": { + "version": { + "$ref": "#/components/schemas/indices._types:IndexVersioning" + }, + "verified_before_close": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "string" + } + ] + }, + "format": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + } + ] + }, + "max_slices_per_scroll": { "type": "number" }, - "time_since_last_read": { - "$ref": "#/components/schemas/_types:Duration" + "translog": { + "$ref": "#/components/schemas/indices._types:Translog" }, - "time_since_last_read_millis": { - "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + "query_string": { + "$ref": "#/components/schemas/indices._types:SettingsQueryString" }, - "total_read_remote_exec_time": { - "$ref": "#/components/schemas/_types:Duration" + "priority": { + "oneOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] }, - "total_read_remote_exec_time_millis": { - "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + "top_metrics_max_size": { + "type": "number" }, - "total_read_time": { - "$ref": "#/components/schemas/_types:Duration" + "analysis": { + "$ref": "#/components/schemas/indices._types:IndexSettingsAnalysis" }, - "total_read_time_millis": { - "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + "settings": { + "$ref": "#/components/schemas/indices._types:IndexSettings" }, - "total_write_time": { - "$ref": "#/components/schemas/_types:Duration" + "time_series": { + "$ref": "#/components/schemas/indices._types:IndexSettingsTimeSeries" }, - "total_write_time_millis": { - "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + "queries": { + "$ref": "#/components/schemas/indices._types:Queries" }, - "write_buffer_operation_count": { - "type": "number" + "similarity": { + "description": "Configure custom similarity settings to customize how search results are scored.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/indices._types:SettingsSimilarity" + } }, - "write_buffer_size_in_bytes": { - "$ref": "#/components/schemas/_types:ByteSize" + "mapping": { + "$ref": "#/components/schemas/indices._types:MappingLimitSettings" + }, + "indexing.slowlog": { + "$ref": "#/components/schemas/indices._types:IndexingSlowlogSettings" + }, + "indexing_pressure": { + "$ref": "#/components/schemas/indices._types:IndexingPressure" + }, + "store": { + "$ref": "#/components/schemas/indices._types:Storage" } - }, - "required": [ - "bytes_read", - "failed_read_requests", - "failed_write_requests", - "follower_aliases_version", - "follower_global_checkpoint", - "follower_index", - "follower_mapping_version", - "follower_max_seq_no", - "follower_settings_version", - "last_requested_seq_no", - "leader_global_checkpoint", - "leader_index", - "leader_max_seq_no", - "operations_read", - "operations_written", - "outstanding_read_requests", - "outstanding_write_requests", - "read_exceptions", - "remote_cluster", - "shard_id", - "successful_read_requests", - "successful_write_requests", - "time_since_last_read_millis", - "total_read_remote_exec_time_millis", - "total_read_time_millis", - "total_write_time_millis", - "write_buffer_operation_count", - "write_buffer_size_in_bytes" - ] + } }, - "ccr._types:ReadException": { + "indices._types:SoftDeletes": { "type": "object", "properties": { - "exception": { - "$ref": "#/components/schemas/_types:ErrorCause" - }, - "from_seq_no": { - "$ref": "#/components/schemas/_types:SequenceNumber" + "enabled": { + "description": "Indicates whether soft deletes are enabled on the index.", + "type": "boolean" }, - "retries": { - "type": "number" + "retention_lease": { + "$ref": "#/components/schemas/indices._types:RetentionLease" } - }, - "required": [ - "exception", - "from_seq_no", - "retries" - ] - }, - "_types:Uuid": { - "type": "string" + } }, - "ccr.get_auto_follow_pattern:AutoFollowPattern": { + "indices._types:RetentionLease": { "type": "object", "properties": { - "name": { - "$ref": "#/components/schemas/_types:Name" - }, - "pattern": { - "$ref": "#/components/schemas/ccr.get_auto_follow_pattern:AutoFollowPatternSummary" + "period": { + "$ref": "#/components/schemas/_types:Duration" } }, "required": [ - "name", - "pattern" + "period" ] }, - "ccr.get_auto_follow_pattern:AutoFollowPatternSummary": { + "indices._types:IndexSegmentSort": { "type": "object", "properties": { - "active": { - "type": "boolean" - }, - "remote_cluster": { - "description": "The remote cluster containing the leader indices to match against.", - "type": "string" - }, - "follow_index_pattern": { - "$ref": "#/components/schemas/_types:IndexPattern" + "field": { + "$ref": "#/components/schemas/_types:Fields" }, - "leader_index_patterns": { - "$ref": "#/components/schemas/_types:IndexPatterns" + "order": { + "oneOf": [ + { + "$ref": "#/components/schemas/indices._types:SegmentSortOrder" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices._types:SegmentSortOrder" + } + } + ] }, - "leader_index_exclusion_patterns": { - "$ref": "#/components/schemas/_types:IndexPatterns" + "mode": { + "oneOf": [ + { + "$ref": "#/components/schemas/indices._types:SegmentSortMode" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices._types:SegmentSortMode" + } + } + ] }, - "max_outstanding_read_requests": { - "description": "The maximum number of outstanding reads requests from the remote cluster.", - "type": "number" + "missing": { + "oneOf": [ + { + "$ref": "#/components/schemas/indices._types:SegmentSortMissing" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices._types:SegmentSortMissing" + } + } + ] } - }, - "required": [ - "active", - "remote_cluster", - "leader_index_patterns", - "leader_index_exclusion_patterns", - "max_outstanding_read_requests" + } + }, + "indices._types:SegmentSortOrder": { + "type": "string", + "enum": [ + "asc", + "ASC", + "desc", + "DESC" ] }, - "_types:IndexPattern": { - "type": "string" + "indices._types:SegmentSortMode": { + "type": "string", + "enum": [ + "min", + "MIN", + "max", + "MAX" + ] }, - "_types:IndexPatterns": { - "type": "array", - "items": { - "$ref": "#/components/schemas/_types:IndexPattern" - } + "indices._types:SegmentSortMissing": { + "type": "string", + "enum": [ + "_last", + "_first" + ] }, - "ccr.stats:AutoFollowStats": { - "type": "object", - "properties": { - "auto_followed_clusters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ccr.stats:AutoFollowedCluster" - } - }, - "number_of_failed_follow_indices": { - "type": "number" - }, - "number_of_failed_remote_cluster_state_requests": { - "type": "number" - }, - "number_of_successful_follow_indices": { - "type": "number" - }, - "recent_auto_follow_errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/_types:ErrorCause" - } - } - }, - "required": [ - "auto_followed_clusters", - "number_of_failed_follow_indices", - "number_of_failed_remote_cluster_state_requests", - "number_of_successful_follow_indices", - "recent_auto_follow_errors" - ] - }, - "ccr.stats:AutoFollowedCluster": { - "type": "object", - "properties": { - "cluster_name": { - "$ref": "#/components/schemas/_types:Name" - }, - "last_seen_metadata_version": { - "$ref": "#/components/schemas/_types:VersionNumber" - }, - "time_since_last_check_millis": { - "$ref": "#/components/schemas/_types:DurationValueUnitMillis" - } - }, - "required": [ - "cluster_name", - "last_seen_metadata_version", - "time_since_last_check_millis" - ] - }, - "ccr.stats:FollowStats": { - "type": "object", - "properties": { - "indices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ccr._types:FollowIndexStats" - } - } - }, - "required": [ - "indices" - ] - }, - "_types:ScrollIds": { - "oneOf": [ - { - "$ref": "#/components/schemas/_types:ScrollId" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/_types:ScrollId" - } - } - ] - }, - "cluster.allocation_explain:Decision": { - "type": "string", - "enum": [ - "yes", - "no", - "worse_balance", - "throttled", - "awaiting_info", - "allocation_delayed", - "no_valid_shard_copy", - "no_attempt" - ] - }, - "cluster.allocation_explain:AllocationDecision": { - "type": "object", - "properties": { - "decider": { - "type": "string" - }, - "decision": { - "$ref": "#/components/schemas/cluster.allocation_explain:AllocationExplainDecision" - }, - "explanation": { - "type": "string" - } - }, - "required": [ - "decider", - "decision", - "explanation" - ] - }, - "cluster.allocation_explain:AllocationExplainDecision": { - "type": "string", - "enum": [ - "NO", - "YES", - "THROTTLE", - "ALWAYS" - ] - }, - "cluster.allocation_explain:ClusterInfo": { - "type": "object", - "properties": { - "nodes": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/cluster.allocation_explain:NodeDiskUsage" - } - }, - "shard_sizes": { - "type": "object", - "additionalProperties": { - "type": "number" - } - }, - "shard_data_set_sizes": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "shard_paths": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "reserved_sizes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/cluster.allocation_explain:ReservedSize" - } - } - }, - "required": [ - "nodes", - "shard_sizes", - "shard_paths", - "reserved_sizes" - ] - }, - "cluster.allocation_explain:NodeDiskUsage": { - "type": "object", - "properties": { - "node_name": { - "$ref": "#/components/schemas/_types:Name" - }, - "least_available": { - "$ref": "#/components/schemas/cluster.allocation_explain:DiskUsage" - }, - "most_available": { - "$ref": "#/components/schemas/cluster.allocation_explain:DiskUsage" - } - }, - "required": [ - "node_name", - "least_available", - "most_available" - ] - }, - "cluster.allocation_explain:DiskUsage": { - "type": "object", - "properties": { - "path": { - "type": "string" - }, - "total_bytes": { - "type": "number" - }, - "used_bytes": { - "type": "number" - }, - "free_bytes": { - "type": "number" - }, - "free_disk_percent": { - "type": "number" - }, - "used_disk_percent": { - "type": "number" - } - }, - "required": [ - "path", - "total_bytes", - "used_bytes", - "free_bytes", - "free_disk_percent", - "used_disk_percent" - ] - }, - "cluster.allocation_explain:ReservedSize": { - "type": "object", - "properties": { - "node_id": { - "$ref": "#/components/schemas/_types:Id" - }, - "path": { - "type": "string" - }, - "total": { - "type": "number" - }, - "shards": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "node_id", - "path", - "total", - "shards" - ] - }, - "cluster.allocation_explain:CurrentNode": { - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/_types:Id" - }, - "name": { - "$ref": "#/components/schemas/_types:Name" - }, - "roles": { - "$ref": "#/components/schemas/_types:NodeRoles" - }, - "attributes": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "transport_address": { - "$ref": "#/components/schemas/_types:TransportAddress" - }, - "weight_ranking": { - "type": "number" - } - }, - "required": [ - "id", - "name", - "roles", - "attributes", - "transport_address", - "weight_ranking" - ] - }, - "_types:NodeRoles": { - "description": "* @doc_id node-roles", - "type": "array", - "items": { - "$ref": "#/components/schemas/_types:NodeRole" - } - }, - "_types:NodeRole": { - "type": "string", - "enum": [ - "master", - "data", - "data_cold", - "data_content", - "data_frozen", - "data_hot", - "data_warm", - "client", - "ingest", - "ml", - "voting_only", - "transform", - "remote_cluster_client", - "coordinating_only" - ] - }, - "_types:TransportAddress": { - "type": "string" - }, - "cluster.allocation_explain:NodeAllocationExplanation": { - "type": "object", - "properties": { - "deciders": { - "type": "array", - "items": { - "$ref": "#/components/schemas/cluster.allocation_explain:AllocationDecision" - } - }, - "node_attributes": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "node_decision": { - "$ref": "#/components/schemas/cluster.allocation_explain:Decision" - }, - "node_id": { - "$ref": "#/components/schemas/_types:Id" - }, - "node_name": { - "$ref": "#/components/schemas/_types:Name" - }, - "roles": { - "$ref": "#/components/schemas/_types:NodeRoles" - }, - "store": { - "$ref": "#/components/schemas/cluster.allocation_explain:AllocationStore" - }, - "transport_address": { - "$ref": "#/components/schemas/_types:TransportAddress" - }, - "weight_ranking": { - "type": "number" - } - }, - "required": [ - "deciders", - "node_attributes", - "node_decision", - "node_id", - "node_name", - "roles", - "transport_address", - "weight_ranking" - ] - }, - "cluster.allocation_explain:AllocationStore": { - "type": "object", - "properties": { - "allocation_id": { - "type": "string" - }, - "found": { - "type": "boolean" - }, - "in_sync": { - "type": "boolean" - }, - "matching_size_in_bytes": { - "type": "number" - }, - "matching_sync_id": { - "type": "boolean" - }, - "store_exception": { - "type": "string" - } - }, - "required": [ - "allocation_id", - "found", - "in_sync", - "matching_size_in_bytes", - "matching_sync_id", - "store_exception" - ] - }, - "cluster.allocation_explain:UnassignedInformation": { - "type": "object", - "properties": { - "at": { - "$ref": "#/components/schemas/_types:DateTime" - }, - "last_allocation_status": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/cluster.allocation_explain:UnassignedInformationReason" - }, - "details": { - "type": "string" - }, - "failed_allocation_attempts": { - "type": "number" - }, - "delayed": { - "type": "boolean" - }, - "allocation_status": { - "type": "string" - } - }, - "required": [ - "at", - "reason" - ] - }, - "cluster.allocation_explain:UnassignedInformationReason": { - "type": "string", - "enum": [ - "INDEX_CREATED", - "CLUSTER_RECOVERED", - "INDEX_REOPENED", - "DANGLING_INDEX_IMPORTED", - "NEW_INDEX_RESTORED", - "EXISTING_INDEX_RESTORED", - "REPLICA_ADDED", - "ALLOCATION_FAILED", - "NODE_LEFT", - "REROUTE_CANCELLED", - "REINITIALIZED", - "REALLOCATED_REPLICA", - "PRIMARY_FAILED", - "FORCED_EMPTY_PRIMARY", - "MANUAL_ALLOCATION" - ] - }, - "cluster._types:ComponentTemplate": { - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/_types:Name" - }, - "component_template": { - "$ref": "#/components/schemas/cluster._types:ComponentTemplateNode" - } - }, - "required": [ - "name", - "component_template" - ] - }, - "cluster._types:ComponentTemplateNode": { - "type": "object", - "properties": { - "template": { - "$ref": "#/components/schemas/cluster._types:ComponentTemplateSummary" - }, - "version": { - "$ref": "#/components/schemas/_types:VersionNumber" - }, - "_meta": { - "$ref": "#/components/schemas/_types:Metadata" - } - }, - "required": [ - "template" - ] - }, - "cluster._types:ComponentTemplateSummary": { - "type": "object", - "properties": { - "_meta": { - "$ref": "#/components/schemas/_types:Metadata" - }, - "version": { - "$ref": "#/components/schemas/_types:VersionNumber" - }, - "settings": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/indices._types:IndexSettings" - } - }, - "mappings": { - "$ref": "#/components/schemas/_types.mapping:TypeMapping" - }, - "aliases": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/indices._types:AliasDefinition" - } - }, - "lifecycle": { - "$ref": "#/components/schemas/indices._types:DataStreamLifecycleWithRollover" - } - } - }, - "indices._types:IndexSettings": { - "type": "object", - "properties": { - "index": { - "$ref": "#/components/schemas/indices._types:IndexSettings" - }, - "mode": { - "type": "string" - }, - "routing_path": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "soft_deletes": { - "$ref": "#/components/schemas/indices._types:SoftDeletes" - }, - "sort": { - "$ref": "#/components/schemas/indices._types:IndexSegmentSort" - }, - "number_of_shards": { - "oneOf": [ - { - "type": "number" - }, - { - "type": "string" - } - ] - }, - "number_of_replicas": { - "oneOf": [ - { - "type": "number" - }, - { - "type": "string" - } - ] - }, - "number_of_routing_shards": { - "type": "number" - }, - "check_on_startup": { - "$ref": "#/components/schemas/indices._types:IndexCheckOnStartup" - }, - "codec": { - "type": "string" - }, - "routing_partition_size": { - "$ref": "#/components/schemas/_spec_utils:Stringifiedinteger" - }, - "load_fixed_bitset_filters_eagerly": { - "type": "boolean" - }, - "hidden": { - "oneOf": [ - { - "type": "boolean" - }, - { - "type": "string" - } - ] - }, - "auto_expand_replicas": { - "type": "string" - }, - "merge": { - "$ref": "#/components/schemas/indices._types:Merge" - }, - "search": { - "$ref": "#/components/schemas/indices._types:SettingsSearch" - }, - "refresh_interval": { - "$ref": "#/components/schemas/_types:Duration" - }, - "max_result_window": { - "type": "number" - }, - "max_inner_result_window": { - "type": "number" - }, - "max_rescore_window": { - "type": "number" - }, - "max_docvalue_fields_search": { - "type": "number" - }, - "max_script_fields": { - "type": "number" - }, - "max_ngram_diff": { - "type": "number" - }, - "max_shingle_diff": { - "type": "number" - }, - "blocks": { - "$ref": "#/components/schemas/indices._types:IndexSettingBlocks" - }, - "max_refresh_listeners": { - "type": "number" - }, - "analyze": { - "$ref": "#/components/schemas/indices._types:SettingsAnalyze" - }, - "highlight": { - "$ref": "#/components/schemas/indices._types:SettingsHighlight" - }, - "max_terms_count": { - "type": "number" - }, - "max_regex_length": { - "type": "number" - }, - "routing": { - "$ref": "#/components/schemas/indices._types:IndexRouting" - }, - "gc_deletes": { - "$ref": "#/components/schemas/_types:Duration" - }, - "default_pipeline": { - "$ref": "#/components/schemas/_types:PipelineName" - }, - "final_pipeline": { - "$ref": "#/components/schemas/_types:PipelineName" - }, - "lifecycle": { - "$ref": "#/components/schemas/indices._types:IndexSettingsLifecycle" - }, - "provided_name": { - "$ref": "#/components/schemas/_types:Name" - }, - "creation_date": { - "$ref": "#/components/schemas/_spec_utils:StringifiedEpochTimeUnitMillis" - }, - "creation_date_string": { - "$ref": "#/components/schemas/_types:DateTime" - }, - "uuid": { - "$ref": "#/components/schemas/_types:Uuid" - }, - "version": { - "$ref": "#/components/schemas/indices._types:IndexVersioning" - }, - "verified_before_close": { - "oneOf": [ - { - "type": "boolean" - }, - { - "type": "string" - } - ] - }, - "format": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - } - ] - }, - "max_slices_per_scroll": { - "type": "number" - }, - "translog": { - "$ref": "#/components/schemas/indices._types:Translog" - }, - "query_string": { - "$ref": "#/components/schemas/indices._types:SettingsQueryString" - }, - "priority": { - "oneOf": [ - { - "type": "number" - }, - { - "type": "string" - } - ] - }, - "top_metrics_max_size": { - "type": "number" - }, - "analysis": { - "$ref": "#/components/schemas/indices._types:IndexSettingsAnalysis" - }, - "settings": { - "$ref": "#/components/schemas/indices._types:IndexSettings" - }, - "time_series": { - "$ref": "#/components/schemas/indices._types:IndexSettingsTimeSeries" - }, - "queries": { - "$ref": "#/components/schemas/indices._types:Queries" - }, - "similarity": { - "description": "Configure custom similarity settings to customize how search results are scored.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/indices._types:SettingsSimilarity" - } - }, - "mapping": { - "$ref": "#/components/schemas/indices._types:MappingLimitSettings" - }, - "indexing.slowlog": { - "$ref": "#/components/schemas/indices._types:IndexingSlowlogSettings" - }, - "indexing_pressure": { - "$ref": "#/components/schemas/indices._types:IndexingPressure" - }, - "store": { - "$ref": "#/components/schemas/indices._types:Storage" - } - } - }, - "indices._types:SoftDeletes": { - "type": "object", - "properties": { - "enabled": { - "description": "Indicates whether soft deletes are enabled on the index.", - "type": "boolean" - }, - "retention_lease": { - "$ref": "#/components/schemas/indices._types:RetentionLease" - } - } - }, - "indices._types:RetentionLease": { - "type": "object", - "properties": { - "period": { - "$ref": "#/components/schemas/_types:Duration" - } - }, - "required": [ - "period" - ] - }, - "indices._types:IndexSegmentSort": { - "type": "object", - "properties": { - "field": { - "$ref": "#/components/schemas/_types:Fields" - }, - "order": { - "oneOf": [ - { - "$ref": "#/components/schemas/indices._types:SegmentSortOrder" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/indices._types:SegmentSortOrder" - } - } - ] - }, - "mode": { - "oneOf": [ - { - "$ref": "#/components/schemas/indices._types:SegmentSortMode" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/indices._types:SegmentSortMode" - } - } - ] - }, - "missing": { - "oneOf": [ - { - "$ref": "#/components/schemas/indices._types:SegmentSortMissing" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/indices._types:SegmentSortMissing" - } - } - ] - } - } - }, - "indices._types:SegmentSortOrder": { - "type": "string", - "enum": [ - "asc", - "ASC", - "desc", - "DESC" - ] - }, - "indices._types:SegmentSortMode": { - "type": "string", - "enum": [ - "min", - "MIN", - "max", - "MAX" - ] - }, - "indices._types:SegmentSortMissing": { - "type": "string", - "enum": [ - "_last", - "_first" - ] - }, - "indices._types:IndexCheckOnStartup": { - "type": "string", - "enum": [ - "true", - "false", - "checksum" - ] - }, - "_spec_utils:Stringifiedinteger": { - "description": "Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior\nis used to capture this behavior while keeping the semantics of the field type.\n\nDepending on the target language, code generators can keep the union or remove it and leniently parse\nstrings to the target type.", - "oneOf": [ - { - "type": "number" - }, - { - "type": "string" - } - ] - }, - "indices._types:Merge": { + "indices._types:IndexCheckOnStartup": { + "type": "string", + "enum": [ + "true", + "false", + "checksum" + ] + }, + "_spec_utils:Stringifiedinteger": { + "description": "Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior\nis used to capture this behavior while keeping the semantics of the field type.\n\nDepending on the target language, code generators can keep the union or remove it and leniently parse\nstrings to the target type.", + "oneOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "indices._types:Merge": { "type": "object", "properties": { "scheduler": { @@ -55741,6 +54948,9 @@ } ] }, + "_types:Uuid": { + "type": "string" + }, "indices._types:IndexVersioning": { "type": "object", "properties": { @@ -59994,451 +59204,1244 @@ "end_time": { "$ref": "#/components/schemas/_types:DateTime" }, - "start_time": { - "$ref": "#/components/schemas/_types:DateTime" + "start_time": { + "$ref": "#/components/schemas/_types:DateTime" + } + } + }, + "indices._types:Queries": { + "type": "object", + "properties": { + "cache": { + "$ref": "#/components/schemas/indices._types:CacheQueries" + } + } + }, + "indices._types:CacheQueries": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "required": [ + "enabled" + ] + }, + "indices._types:SettingsSimilarity": { + "discriminator": { + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/indices._types:SettingsSimilarityBm25" + }, + { + "$ref": "#/components/schemas/indices._types:SettingsSimilarityBoolean" + }, + { + "$ref": "#/components/schemas/indices._types:SettingsSimilarityDfi" + }, + { + "$ref": "#/components/schemas/indices._types:SettingsSimilarityDfr" + }, + { + "$ref": "#/components/schemas/indices._types:SettingsSimilarityIb" + }, + { + "$ref": "#/components/schemas/indices._types:SettingsSimilarityLmd" + }, + { + "$ref": "#/components/schemas/indices._types:SettingsSimilarityLmj" + }, + { + "$ref": "#/components/schemas/indices._types:SettingsSimilarityScripted" + } + ] + }, + "indices._types:SettingsSimilarityBm25": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "BM25" + ] + }, + "b": { + "type": "number" + }, + "discount_overlaps": { + "type": "boolean" + }, + "k1": { + "type": "number" + } + }, + "required": [ + "type" + ] + }, + "indices._types:SettingsSimilarityBoolean": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "boolean" + ] + } + }, + "required": [ + "type" + ] + }, + "indices._types:SettingsSimilarityDfi": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "DFI" + ] + }, + "independence_measure": { + "$ref": "#/components/schemas/_types:DFIIndependenceMeasure" + } + }, + "required": [ + "type", + "independence_measure" + ] + }, + "_types:DFIIndependenceMeasure": { + "type": "string", + "enum": [ + "standardized", + "saturated", + "chisquared" + ] + }, + "indices._types:SettingsSimilarityDfr": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "DFR" + ] + }, + "after_effect": { + "$ref": "#/components/schemas/_types:DFRAfterEffect" + }, + "basic_model": { + "$ref": "#/components/schemas/_types:DFRBasicModel" + }, + "normalization": { + "$ref": "#/components/schemas/_types:Normalization" + } + }, + "required": [ + "type", + "after_effect", + "basic_model", + "normalization" + ] + }, + "_types:DFRAfterEffect": { + "type": "string", + "enum": [ + "no", + "b", + "l" + ] + }, + "_types:DFRBasicModel": { + "type": "string", + "enum": [ + "be", + "d", + "g", + "if", + "in", + "ine", + "p" + ] + }, + "_types:Normalization": { + "type": "string", + "enum": [ + "no", + "h1", + "h2", + "h3", + "z" + ] + }, + "indices._types:SettingsSimilarityIb": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "IB" + ] + }, + "distribution": { + "$ref": "#/components/schemas/_types:IBDistribution" + }, + "lambda": { + "$ref": "#/components/schemas/_types:IBLambda" + }, + "normalization": { + "$ref": "#/components/schemas/_types:Normalization" + } + }, + "required": [ + "type", + "distribution", + "lambda", + "normalization" + ] + }, + "_types:IBDistribution": { + "type": "string", + "enum": [ + "ll", + "spl" + ] + }, + "_types:IBLambda": { + "type": "string", + "enum": [ + "df", + "ttf" + ] + }, + "indices._types:SettingsSimilarityLmd": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "LMDirichlet" + ] + }, + "mu": { + "type": "number" + } + }, + "required": [ + "type" + ] + }, + "indices._types:SettingsSimilarityLmj": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "LMJelinekMercer" + ] + }, + "lambda": { + "type": "number" + } + }, + "required": [ + "type" + ] + }, + "indices._types:SettingsSimilarityScripted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "scripted" + ] + }, + "script": { + "$ref": "#/components/schemas/_types:Script" + }, + "weight_script": { + "$ref": "#/components/schemas/_types:Script" + } + }, + "required": [ + "type", + "script" + ] + }, + "indices._types:MappingLimitSettings": { + "type": "object", + "properties": { + "coerce": { + "type": "boolean" + }, + "total_fields": { + "$ref": "#/components/schemas/indices._types:MappingLimitSettingsTotalFields" + }, + "depth": { + "$ref": "#/components/schemas/indices._types:MappingLimitSettingsDepth" + }, + "nested_fields": { + "$ref": "#/components/schemas/indices._types:MappingLimitSettingsNestedFields" + }, + "nested_objects": { + "$ref": "#/components/schemas/indices._types:MappingLimitSettingsNestedObjects" + }, + "field_name_length": { + "$ref": "#/components/schemas/indices._types:MappingLimitSettingsFieldNameLength" + }, + "dimension_fields": { + "$ref": "#/components/schemas/indices._types:MappingLimitSettingsDimensionFields" + }, + "ignore_malformed": { + "type": "boolean" + } + } + }, + "indices._types:MappingLimitSettingsTotalFields": { + "type": "object", + "properties": { + "limit": { + "description": "The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit.\nThe limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance\ndegradations and memory issues, especially in clusters with a high load or few resources.", + "oneOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "ignore_dynamic_beyond_limit": { + "description": "This setting determines what happens when a dynamically mapped field would exceed the total fields limit. When set\nto false (the default), the index request of the document that tries to add a dynamic field to the mapping will fail\nwith the message Limit of total fields [X] has been exceeded. When set to true, the index request will not fail.\nInstead, fields that would exceed the limit are not added to the mapping, similar to dynamic: false.\nThe fields that were not added to the mapping will be added to the _ignored field.", + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "string" + } + ] + } + } + }, + "indices._types:MappingLimitSettingsDepth": { + "type": "object", + "properties": { + "limit": { + "description": "The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined\nat the root object level, then the depth is 1. If there is one object mapping, then the depth is 2, etc.", + "type": "number" + } + } + }, + "indices._types:MappingLimitSettingsNestedFields": { + "type": "object", + "properties": { + "limit": { + "description": "The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when\narrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this\nsetting limits the number of unique nested types per index.", + "type": "number" + } + } + }, + "indices._types:MappingLimitSettingsNestedObjects": { + "type": "object", + "properties": { + "limit": { + "description": "The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps\nto prevent out of memory errors when a document contains too many nested objects.", + "type": "number" + } + } + }, + "indices._types:MappingLimitSettingsFieldNameLength": { + "type": "object", + "properties": { + "limit": { + "description": "Setting for the maximum length of a field name. This setting isn’t really something that addresses mappings explosion but\nmight still be useful if you want to limit the field length. It usually shouldn’t be necessary to set this setting. The\ndefault is okay unless a user starts to add a huge number of fields with really long names. Default is `Long.MAX_VALUE` (no limit).", + "type": "number" + } + } + }, + "indices._types:MappingLimitSettingsDimensionFields": { + "type": "object", + "properties": { + "limit": { + "description": "[preview] This functionality is in technical preview and may be changed or removed in a future release.\nElastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.", + "type": "number" + } + } + }, + "indices._types:IndexingSlowlogSettings": { + "type": "object", + "properties": { + "level": { + "type": "string" + }, + "source": { + "type": "number" + }, + "reformat": { + "type": "boolean" + }, + "threshold": { + "$ref": "#/components/schemas/indices._types:IndexingSlowlogTresholds" + } + } + }, + "indices._types:IndexingSlowlogTresholds": { + "type": "object", + "properties": { + "index": { + "$ref": "#/components/schemas/indices._types:SlowlogTresholdLevels" + } + } + }, + "indices._types:IndexingPressure": { + "type": "object", + "properties": { + "memory": { + "$ref": "#/components/schemas/indices._types:IndexingPressureMemory" + } + }, + "required": [ + "memory" + ] + }, + "indices._types:IndexingPressureMemory": { + "type": "object", + "properties": { + "limit": { + "description": "Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded,\nthe node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit,\nthe node will reject new replica operations. Defaults to 10% of the heap.", + "type": "number" + } + } + }, + "indices._types:Storage": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/indices._types:StorageType" + }, + "allow_mmap": { + "description": "You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap.\nThis is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This\nsetting is useful, for example, if you are in an environment where you can not control the ability to create a lot\nof memory maps so you need disable the ability to use memory-mapping.", + "type": "boolean" + } + }, + "required": [ + "type" + ] + }, + "indices._types:StorageType": { + "anyOf": [ + { + "type": "string", + "enum": [ + "fs", + "niofs", + "mmapfs", + "hybridfs" + ] + }, + { + "type": "string" + } + ] + }, + "ccr.follow_info:FollowerIndex": { + "type": "object", + "properties": { + "follower_index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "leader_index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "parameters": { + "$ref": "#/components/schemas/ccr.follow_info:FollowerIndexParameters" + }, + "remote_cluster": { + "$ref": "#/components/schemas/_types:Name" + }, + "status": { + "$ref": "#/components/schemas/ccr.follow_info:FollowerIndexStatus" + } + }, + "required": [ + "follower_index", + "leader_index", + "remote_cluster", + "status" + ] + }, + "ccr.follow_info:FollowerIndexParameters": { + "type": "object", + "properties": { + "max_outstanding_read_requests": { + "description": "The maximum number of outstanding reads requests from the remote cluster.", + "type": "number" + }, + "max_outstanding_write_requests": { + "description": "The maximum number of outstanding write requests on the follower.", + "type": "number" + }, + "max_read_request_operation_count": { + "description": "The maximum number of operations to pull per read from the remote cluster.", + "type": "number" + }, + "max_read_request_size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "max_retry_delay": { + "$ref": "#/components/schemas/_types:Duration" + }, + "max_write_buffer_count": { + "description": "The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be\ndeferred until the number of queued operations goes below the limit.", + "type": "number" + }, + "max_write_buffer_size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "max_write_request_operation_count": { + "description": "The maximum number of operations per bulk write request executed on the follower.", + "type": "number" + }, + "max_write_request_size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "read_poll_timeout": { + "$ref": "#/components/schemas/_types:Duration" } } }, - "indices._types:Queries": { - "type": "object", - "properties": { - "cache": { - "$ref": "#/components/schemas/indices._types:CacheQueries" - } - } + "ccr.follow_info:FollowerIndexStatus": { + "type": "string", + "enum": [ + "active", + "paused" + ] }, - "indices._types:CacheQueries": { + "ccr._types:FollowIndexStats": { "type": "object", "properties": { - "enabled": { - "type": "boolean" + "index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "shards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ccr._types:ShardStats" + } } }, "required": [ - "enabled" + "index", + "shards" ] }, - "indices._types:SettingsSimilarity": { - "discriminator": { - "propertyName": "type" - }, - "oneOf": [ - { - "$ref": "#/components/schemas/indices._types:SettingsSimilarityBm25" + "ccr._types:ShardStats": { + "type": "object", + "properties": { + "bytes_read": { + "type": "number" }, - { - "$ref": "#/components/schemas/indices._types:SettingsSimilarityBoolean" + "failed_read_requests": { + "type": "number" }, - { - "$ref": "#/components/schemas/indices._types:SettingsSimilarityDfi" + "failed_write_requests": { + "type": "number" }, - { - "$ref": "#/components/schemas/indices._types:SettingsSimilarityDfr" + "fatal_exception": { + "$ref": "#/components/schemas/_types:ErrorCause" }, - { - "$ref": "#/components/schemas/indices._types:SettingsSimilarityIb" + "follower_aliases_version": { + "$ref": "#/components/schemas/_types:VersionNumber" }, - { - "$ref": "#/components/schemas/indices._types:SettingsSimilarityLmd" + "follower_global_checkpoint": { + "type": "number" }, - { - "$ref": "#/components/schemas/indices._types:SettingsSimilarityLmj" + "follower_index": { + "type": "string" }, - { - "$ref": "#/components/schemas/indices._types:SettingsSimilarityScripted" + "follower_mapping_version": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "follower_max_seq_no": { + "$ref": "#/components/schemas/_types:SequenceNumber" + }, + "follower_settings_version": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "last_requested_seq_no": { + "$ref": "#/components/schemas/_types:SequenceNumber" + }, + "leader_global_checkpoint": { + "type": "number" + }, + "leader_index": { + "type": "string" + }, + "leader_max_seq_no": { + "$ref": "#/components/schemas/_types:SequenceNumber" + }, + "operations_read": { + "type": "number" + }, + "operations_written": { + "type": "number" + }, + "outstanding_read_requests": { + "type": "number" + }, + "outstanding_write_requests": { + "type": "number" + }, + "read_exceptions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ccr._types:ReadException" + } + }, + "remote_cluster": { + "type": "string" + }, + "shard_id": { + "type": "number" + }, + "successful_read_requests": { + "type": "number" + }, + "successful_write_requests": { + "type": "number" + }, + "time_since_last_read": { + "$ref": "#/components/schemas/_types:Duration" + }, + "time_since_last_read_millis": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + }, + "total_read_remote_exec_time": { + "$ref": "#/components/schemas/_types:Duration" + }, + "total_read_remote_exec_time_millis": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + }, + "total_read_time": { + "$ref": "#/components/schemas/_types:Duration" + }, + "total_read_time_millis": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + }, + "total_write_time": { + "$ref": "#/components/schemas/_types:Duration" + }, + "total_write_time_millis": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + }, + "write_buffer_operation_count": { + "type": "number" + }, + "write_buffer_size_in_bytes": { + "$ref": "#/components/schemas/_types:ByteSize" } + }, + "required": [ + "bytes_read", + "failed_read_requests", + "failed_write_requests", + "follower_aliases_version", + "follower_global_checkpoint", + "follower_index", + "follower_mapping_version", + "follower_max_seq_no", + "follower_settings_version", + "last_requested_seq_no", + "leader_global_checkpoint", + "leader_index", + "leader_max_seq_no", + "operations_read", + "operations_written", + "outstanding_read_requests", + "outstanding_write_requests", + "read_exceptions", + "remote_cluster", + "shard_id", + "successful_read_requests", + "successful_write_requests", + "time_since_last_read_millis", + "total_read_remote_exec_time_millis", + "total_read_time_millis", + "total_write_time_millis", + "write_buffer_operation_count", + "write_buffer_size_in_bytes" ] }, - "indices._types:SettingsSimilarityBm25": { + "ccr._types:ReadException": { "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "BM25" - ] - }, - "b": { - "type": "number" + "exception": { + "$ref": "#/components/schemas/_types:ErrorCause" }, - "discount_overlaps": { - "type": "boolean" + "from_seq_no": { + "$ref": "#/components/schemas/_types:SequenceNumber" }, - "k1": { + "retries": { "type": "number" } }, "required": [ - "type" + "exception", + "from_seq_no", + "retries" ] }, - "indices._types:SettingsSimilarityBoolean": { + "ccr.get_auto_follow_pattern:AutoFollowPattern": { "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "boolean" - ] + "name": { + "$ref": "#/components/schemas/_types:Name" + }, + "pattern": { + "$ref": "#/components/schemas/ccr.get_auto_follow_pattern:AutoFollowPatternSummary" } }, "required": [ - "type" + "name", + "pattern" ] }, - "indices._types:SettingsSimilarityDfi": { + "ccr.get_auto_follow_pattern:AutoFollowPatternSummary": { "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "DFI" - ] + "active": { + "type": "boolean" }, - "independence_measure": { - "$ref": "#/components/schemas/_types:DFIIndependenceMeasure" + "remote_cluster": { + "description": "The remote cluster containing the leader indices to match against.", + "type": "string" + }, + "follow_index_pattern": { + "$ref": "#/components/schemas/_types:IndexPattern" + }, + "leader_index_patterns": { + "$ref": "#/components/schemas/_types:IndexPatterns" + }, + "leader_index_exclusion_patterns": { + "$ref": "#/components/schemas/_types:IndexPatterns" + }, + "max_outstanding_read_requests": { + "description": "The maximum number of outstanding reads requests from the remote cluster.", + "type": "number" } }, "required": [ - "type", - "independence_measure" + "active", + "remote_cluster", + "leader_index_patterns", + "leader_index_exclusion_patterns", + "max_outstanding_read_requests" ] }, - "_types:DFIIndependenceMeasure": { - "type": "string", - "enum": [ - "standardized", - "saturated", - "chisquared" - ] + "_types:IndexPattern": { + "type": "string" }, - "indices._types:SettingsSimilarityDfr": { + "_types:IndexPatterns": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:IndexPattern" + } + }, + "ccr.stats:AutoFollowStats": { "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "DFR" - ] + "auto_followed_clusters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ccr.stats:AutoFollowedCluster" + } }, - "after_effect": { - "$ref": "#/components/schemas/_types:DFRAfterEffect" + "number_of_failed_follow_indices": { + "type": "number" }, - "basic_model": { - "$ref": "#/components/schemas/_types:DFRBasicModel" + "number_of_failed_remote_cluster_state_requests": { + "type": "number" }, - "normalization": { - "$ref": "#/components/schemas/_types:Normalization" + "number_of_successful_follow_indices": { + "type": "number" + }, + "recent_auto_follow_errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:ErrorCause" + } } }, "required": [ - "type", - "after_effect", - "basic_model", - "normalization" + "auto_followed_clusters", + "number_of_failed_follow_indices", + "number_of_failed_remote_cluster_state_requests", + "number_of_successful_follow_indices", + "recent_auto_follow_errors" ] }, - "_types:DFRAfterEffect": { - "type": "string", - "enum": [ - "no", - "b", - "l" + "ccr.stats:AutoFollowedCluster": { + "type": "object", + "properties": { + "cluster_name": { + "$ref": "#/components/schemas/_types:Name" + }, + "last_seen_metadata_version": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "time_since_last_check_millis": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + } + }, + "required": [ + "cluster_name", + "last_seen_metadata_version", + "time_since_last_check_millis" ] }, - "_types:DFRBasicModel": { - "type": "string", - "enum": [ - "be", - "d", - "g", - "if", - "in", - "ine", - "p" + "ccr.stats:FollowStats": { + "type": "object", + "properties": { + "indices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ccr._types:FollowIndexStats" + } + } + }, + "required": [ + "indices" ] }, - "_types:Normalization": { + "_types:ScrollIds": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types:ScrollId" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:ScrollId" + } + } + ] + }, + "cluster.allocation_explain:Decision": { "type": "string", "enum": [ + "yes", "no", - "h1", - "h2", - "h3", - "z" + "worse_balance", + "throttled", + "awaiting_info", + "allocation_delayed", + "no_valid_shard_copy", + "no_attempt" ] }, - "indices._types:SettingsSimilarityIb": { + "cluster.allocation_explain:AllocationDecision": { "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "IB" - ] - }, - "distribution": { - "$ref": "#/components/schemas/_types:IBDistribution" + "decider": { + "type": "string" }, - "lambda": { - "$ref": "#/components/schemas/_types:IBLambda" + "decision": { + "$ref": "#/components/schemas/cluster.allocation_explain:AllocationExplainDecision" }, - "normalization": { - "$ref": "#/components/schemas/_types:Normalization" + "explanation": { + "type": "string" } }, "required": [ - "type", - "distribution", - "lambda", - "normalization" + "decider", + "decision", + "explanation" ] }, - "_types:IBDistribution": { + "cluster.allocation_explain:AllocationExplainDecision": { "type": "string", "enum": [ - "ll", - "spl" + "NO", + "YES", + "THROTTLE", + "ALWAYS" ] }, - "_types:IBLambda": { - "type": "string", - "enum": [ - "df", - "ttf" + "cluster.allocation_explain:ClusterInfo": { + "type": "object", + "properties": { + "nodes": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/cluster.allocation_explain:NodeDiskUsage" + } + }, + "shard_sizes": { + "type": "object", + "additionalProperties": { + "type": "number" + } + }, + "shard_data_set_sizes": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "shard_paths": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "reserved_sizes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/cluster.allocation_explain:ReservedSize" + } + } + }, + "required": [ + "nodes", + "shard_sizes", + "shard_paths", + "reserved_sizes" ] }, - "indices._types:SettingsSimilarityLmd": { + "cluster.allocation_explain:NodeDiskUsage": { "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "LMDirichlet" - ] + "node_name": { + "$ref": "#/components/schemas/_types:Name" }, - "mu": { - "type": "number" + "least_available": { + "$ref": "#/components/schemas/cluster.allocation_explain:DiskUsage" + }, + "most_available": { + "$ref": "#/components/schemas/cluster.allocation_explain:DiskUsage" } }, "required": [ - "type" + "node_name", + "least_available", + "most_available" ] }, - "indices._types:SettingsSimilarityLmj": { + "cluster.allocation_explain:DiskUsage": { "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "LMJelinekMercer" - ] + "path": { + "type": "string" + }, + "total_bytes": { + "type": "number" + }, + "used_bytes": { + "type": "number" + }, + "free_bytes": { + "type": "number" + }, + "free_disk_percent": { + "type": "number" }, - "lambda": { + "used_disk_percent": { "type": "number" } }, "required": [ - "type" + "path", + "total_bytes", + "used_bytes", + "free_bytes", + "free_disk_percent", + "used_disk_percent" ] }, - "indices._types:SettingsSimilarityScripted": { + "cluster.allocation_explain:ReservedSize": { "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "scripted" - ] + "node_id": { + "$ref": "#/components/schemas/_types:Id" }, - "script": { - "$ref": "#/components/schemas/_types:Script" + "path": { + "type": "string" }, - "weight_script": { - "$ref": "#/components/schemas/_types:Script" + "total": { + "type": "number" + }, + "shards": { + "type": "array", + "items": { + "type": "string" + } } }, "required": [ - "type", - "script" + "node_id", + "path", + "total", + "shards" ] }, - "indices._types:MappingLimitSettings": { + "cluster.allocation_explain:CurrentNode": { "type": "object", "properties": { - "coerce": { - "type": "boolean" - }, - "total_fields": { - "$ref": "#/components/schemas/indices._types:MappingLimitSettingsTotalFields" - }, - "depth": { - "$ref": "#/components/schemas/indices._types:MappingLimitSettingsDepth" - }, - "nested_fields": { - "$ref": "#/components/schemas/indices._types:MappingLimitSettingsNestedFields" + "id": { + "$ref": "#/components/schemas/_types:Id" }, - "nested_objects": { - "$ref": "#/components/schemas/indices._types:MappingLimitSettingsNestedObjects" + "name": { + "$ref": "#/components/schemas/_types:Name" }, - "field_name_length": { - "$ref": "#/components/schemas/indices._types:MappingLimitSettingsFieldNameLength" + "roles": { + "$ref": "#/components/schemas/_types:NodeRoles" }, - "dimension_fields": { - "$ref": "#/components/schemas/indices._types:MappingLimitSettingsDimensionFields" + "attributes": { + "type": "object", + "additionalProperties": { + "type": "string" + } }, - "ignore_malformed": { - "type": "boolean" - } - } - }, - "indices._types:MappingLimitSettingsTotalFields": { - "type": "object", - "properties": { - "limit": { - "description": "The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit.\nThe limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance\ndegradations and memory issues, especially in clusters with a high load or few resources.", - "oneOf": [ - { - "type": "number" - }, - { - "type": "string" - } - ] + "transport_address": { + "$ref": "#/components/schemas/_types:TransportAddress" }, - "ignore_dynamic_beyond_limit": { - "description": "This setting determines what happens when a dynamically mapped field would exceed the total fields limit. When set\nto false (the default), the index request of the document that tries to add a dynamic field to the mapping will fail\nwith the message Limit of total fields [X] has been exceeded. When set to true, the index request will not fail.\nInstead, fields that would exceed the limit are not added to the mapping, similar to dynamic: false.\nThe fields that were not added to the mapping will be added to the _ignored field.", - "oneOf": [ - { - "type": "boolean" - }, - { - "type": "string" - } - ] - } - } - }, - "indices._types:MappingLimitSettingsDepth": { - "type": "object", - "properties": { - "limit": { - "description": "The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined\nat the root object level, then the depth is 1. If there is one object mapping, then the depth is 2, etc.", + "weight_ranking": { "type": "number" } - } + }, + "required": [ + "id", + "name", + "roles", + "attributes", + "transport_address", + "weight_ranking" + ] }, - "indices._types:MappingLimitSettingsNestedFields": { - "type": "object", - "properties": { - "limit": { - "description": "The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when\narrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this\nsetting limits the number of unique nested types per index.", - "type": "number" - } + "_types:NodeRoles": { + "description": "* @doc_id node-roles", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:NodeRole" } }, - "indices._types:MappingLimitSettingsNestedObjects": { - "type": "object", - "properties": { - "limit": { - "description": "The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps\nto prevent out of memory errors when a document contains too many nested objects.", - "type": "number" - } - } + "_types:NodeRole": { + "type": "string", + "enum": [ + "master", + "data", + "data_cold", + "data_content", + "data_frozen", + "data_hot", + "data_warm", + "client", + "ingest", + "ml", + "voting_only", + "transform", + "remote_cluster_client", + "coordinating_only" + ] }, - "indices._types:MappingLimitSettingsFieldNameLength": { + "_types:TransportAddress": { + "type": "string" + }, + "cluster.allocation_explain:NodeAllocationExplanation": { "type": "object", "properties": { - "limit": { - "description": "Setting for the maximum length of a field name. This setting isn’t really something that addresses mappings explosion but\nmight still be useful if you want to limit the field length. It usually shouldn’t be necessary to set this setting. The\ndefault is okay unless a user starts to add a huge number of fields with really long names. Default is `Long.MAX_VALUE` (no limit).", + "deciders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/cluster.allocation_explain:AllocationDecision" + } + }, + "node_attributes": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "node_decision": { + "$ref": "#/components/schemas/cluster.allocation_explain:Decision" + }, + "node_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "node_name": { + "$ref": "#/components/schemas/_types:Name" + }, + "roles": { + "$ref": "#/components/schemas/_types:NodeRoles" + }, + "store": { + "$ref": "#/components/schemas/cluster.allocation_explain:AllocationStore" + }, + "transport_address": { + "$ref": "#/components/schemas/_types:TransportAddress" + }, + "weight_ranking": { "type": "number" } - } + }, + "required": [ + "deciders", + "node_attributes", + "node_decision", + "node_id", + "node_name", + "roles", + "transport_address", + "weight_ranking" + ] }, - "indices._types:MappingLimitSettingsDimensionFields": { + "cluster.allocation_explain:AllocationStore": { "type": "object", "properties": { - "limit": { - "description": "[preview] This functionality is in technical preview and may be changed or removed in a future release.\nElastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.", + "allocation_id": { + "type": "string" + }, + "found": { + "type": "boolean" + }, + "in_sync": { + "type": "boolean" + }, + "matching_size_in_bytes": { "type": "number" + }, + "matching_sync_id": { + "type": "boolean" + }, + "store_exception": { + "type": "string" } - } + }, + "required": [ + "allocation_id", + "found", + "in_sync", + "matching_size_in_bytes", + "matching_sync_id", + "store_exception" + ] }, - "indices._types:IndexingSlowlogSettings": { + "cluster.allocation_explain:UnassignedInformation": { "type": "object", "properties": { - "level": { + "at": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "last_allocation_status": { "type": "string" }, - "source": { + "reason": { + "$ref": "#/components/schemas/cluster.allocation_explain:UnassignedInformationReason" + }, + "details": { + "type": "string" + }, + "failed_allocation_attempts": { "type": "number" }, - "reformat": { + "delayed": { "type": "boolean" }, - "threshold": { - "$ref": "#/components/schemas/indices._types:IndexingSlowlogTresholds" + "allocation_status": { + "type": "string" } - } + }, + "required": [ + "at", + "reason" + ] }, - "indices._types:IndexingSlowlogTresholds": { - "type": "object", - "properties": { - "index": { - "$ref": "#/components/schemas/indices._types:SlowlogTresholdLevels" - } - } + "cluster.allocation_explain:UnassignedInformationReason": { + "type": "string", + "enum": [ + "INDEX_CREATED", + "CLUSTER_RECOVERED", + "INDEX_REOPENED", + "DANGLING_INDEX_IMPORTED", + "NEW_INDEX_RESTORED", + "EXISTING_INDEX_RESTORED", + "REPLICA_ADDED", + "ALLOCATION_FAILED", + "NODE_LEFT", + "REROUTE_CANCELLED", + "REINITIALIZED", + "REALLOCATED_REPLICA", + "PRIMARY_FAILED", + "FORCED_EMPTY_PRIMARY", + "MANUAL_ALLOCATION" + ] }, - "indices._types:IndexingPressure": { + "cluster._types:ComponentTemplate": { "type": "object", "properties": { - "memory": { - "$ref": "#/components/schemas/indices._types:IndexingPressureMemory" + "name": { + "$ref": "#/components/schemas/_types:Name" + }, + "component_template": { + "$ref": "#/components/schemas/cluster._types:ComponentTemplateNode" } }, "required": [ - "memory" + "name", + "component_template" ] }, - "indices._types:IndexingPressureMemory": { - "type": "object", - "properties": { - "limit": { - "description": "Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded,\nthe node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit,\nthe node will reject new replica operations. Defaults to 10% of the heap.", - "type": "number" - } - } - }, - "indices._types:Storage": { + "cluster._types:ComponentTemplateNode": { "type": "object", "properties": { - "type": { - "$ref": "#/components/schemas/indices._types:StorageType" + "template": { + "$ref": "#/components/schemas/cluster._types:ComponentTemplateSummary" }, - "allow_mmap": { - "description": "You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap.\nThis is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This\nsetting is useful, for example, if you are in an environment where you can not control the ability to create a lot\nof memory maps so you need disable the ability to use memory-mapping.", - "type": "boolean" + "version": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "_meta": { + "$ref": "#/components/schemas/_types:Metadata" } }, "required": [ - "type" + "template" ] }, - "indices._types:StorageType": { - "anyOf": [ - { - "type": "string", - "enum": [ - "fs", - "niofs", - "mmapfs", - "hybridfs" - ] + "cluster._types:ComponentTemplateSummary": { + "type": "object", + "properties": { + "_meta": { + "$ref": "#/components/schemas/_types:Metadata" }, - { - "type": "string" + "version": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "settings": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/indices._types:IndexSettings" + } + }, + "mappings": { + "$ref": "#/components/schemas/_types.mapping:TypeMapping" + }, + "aliases": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/indices._types:AliasDefinition" + } + }, + "lifecycle": { + "$ref": "#/components/schemas/indices._types:DataStreamLifecycleWithRollover" } - ] + } }, "_types.mapping:TypeMapping": { "type": "object", @@ -62917,6 +62920,56 @@ } }, "indices._types:DataStreamLifecycleWithRollover": { + "allOf": [ + { + "$ref": "#/components/schemas/indices._types:DataStreamLifecycle" + }, + { + "type": "object", + "properties": { + "rollover": { + "$ref": "#/components/schemas/indices._types:DataStreamLifecycleRolloverConditions" + } + } + } + ] + }, + "indices._types:DataStreamLifecycleRolloverConditions": { + "type": "object", + "properties": { + "min_age": { + "$ref": "#/components/schemas/_types:Duration" + }, + "max_age": { + "type": "string" + }, + "min_docs": { + "type": "number" + }, + "max_docs": { + "type": "number" + }, + "min_size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "max_size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "min_primary_shard_size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "max_primary_shard_size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "min_primary_shard_docs": { + "type": "number" + }, + "max_primary_shard_docs": { + "type": "number" + } + } + }, + "indices._types:DataStreamLifecycle": { "type": "object", "properties": { "data_retention": { @@ -62925,8 +62978,9 @@ "downsampling": { "$ref": "#/components/schemas/indices._types:DataStreamLifecycleDownsampling" }, - "rollover": { - "$ref": "#/components/schemas/indices._types:DataStreamLifecycleRolloverConditions" + "enabled": { + "description": "If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream.", + "type": "boolean" } } }, @@ -62971,41 +63025,6 @@ "fixed_interval" ] }, - "indices._types:DataStreamLifecycleRolloverConditions": { - "type": "object", - "properties": { - "min_age": { - "$ref": "#/components/schemas/_types:Duration" - }, - "max_age": { - "type": "string" - }, - "min_docs": { - "type": "number" - }, - "max_docs": { - "type": "number" - }, - "min_size": { - "$ref": "#/components/schemas/_types:ByteSize" - }, - "max_size": { - "$ref": "#/components/schemas/_types:ByteSize" - }, - "min_primary_shard_size": { - "$ref": "#/components/schemas/_types:ByteSize" - }, - "max_primary_shard_size": { - "$ref": "#/components/schemas/_types:ByteSize" - }, - "min_primary_shard_docs": { - "type": "number" - }, - "max_primary_shard_docs": { - "type": "number" - } - } - }, "_types:Level": { "type": "string", "enum": [ @@ -63689,17 +63708,6 @@ "_types:DataStreamName": { "type": "string" }, - "indices._types:DataStreamLifecycle": { - "type": "object", - "properties": { - "data_retention": { - "$ref": "#/components/schemas/_types:Duration" - }, - "downsampling": { - "$ref": "#/components/schemas/indices._types:DataStreamLifecycleDownsampling" - } - } - }, "cluster.remote_info:ClusterRemoteInfo": { "discriminator": { "propertyName": "mode" @@ -69030,7 +69038,7 @@ "$ref": "#/components/schemas/_types:DataStreamName" }, "lifecycle": { - "$ref": "#/components/schemas/indices._types:DataStreamLifecycle" + "$ref": "#/components/schemas/indices._types:DataStreamLifecycleWithRollover" } }, "required": [ @@ -83433,11 +83441,30 @@ ] }, "search_application._types:SearchApplication": { + "allOf": [ + { + "$ref": "#/components/schemas/search_application._types:SearchApplicationParameters" + }, + { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/_types:Name" + }, + "updated_at_millis": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + } + }, + "required": [ + "name", + "updated_at_millis" + ] + } + ] + }, + "search_application._types:SearchApplicationParameters": { "type": "object", "properties": { - "name": { - "$ref": "#/components/schemas/_types:Name" - }, "indices": { "description": "Indices that are part of the Search Application.", "type": "array", @@ -83445,9 +83472,6 @@ "$ref": "#/components/schemas/_types:IndexName" } }, - "updated_at_millis": { - "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" - }, "analytics_collection_name": { "$ref": "#/components/schemas/_types:Name" }, @@ -83456,9 +83480,7 @@ } }, "required": [ - "name", - "indices", - "updated_at_millis" + "indices" ] }, "search_application._types:SearchApplicationTemplate": { @@ -83494,32 +83516,6 @@ "name" ] }, - "search_application.list:SearchApplicationListItem": { - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/_types:Name" - }, - "indices": { - "description": "Indices that are part of the Search Application", - "type": "array", - "items": { - "$ref": "#/components/schemas/_types:IndexName" - } - }, - "updated_at_millis": { - "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" - }, - "analytics_collection_name": { - "$ref": "#/components/schemas/_types:Name" - } - }, - "required": [ - "name", - "indices", - "updated_at_millis" - ] - }, "search_application.put_behavioral_analytics:AnalyticsAcknowledgeResponseBase": { "allOf": [ { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index b619907319..208515827f 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -7048,18 +7048,11 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "data_retention": { - "$ref": "#/components/schemas/_types:Duration" - }, - "downsampling": { - "$ref": "#/components/schemas/indices._types:DataStreamLifecycleDownsampling" - } - } + "$ref": "#/components/schemas/indices._types:DataStreamLifecycle" } } - } + }, + "required": true }, "responses": { "200": { @@ -16469,7 +16462,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/search_application._types:SearchApplication" + "$ref": "#/components/schemas/search_application._types:SearchApplicationParameters" } } }, @@ -16687,7 +16680,7 @@ "results": { "type": "array", "items": { - "$ref": "#/components/schemas/search_application.list:SearchApplicationListItem" + "$ref": "#/components/schemas/search_application._types:SearchApplication" } } }, @@ -42898,6 +42891,56 @@ } }, "indices._types:DataStreamLifecycleWithRollover": { + "allOf": [ + { + "$ref": "#/components/schemas/indices._types:DataStreamLifecycle" + }, + { + "type": "object", + "properties": { + "rollover": { + "$ref": "#/components/schemas/indices._types:DataStreamLifecycleRolloverConditions" + } + } + } + ] + }, + "indices._types:DataStreamLifecycleRolloverConditions": { + "type": "object", + "properties": { + "min_age": { + "$ref": "#/components/schemas/_types:Duration" + }, + "max_age": { + "type": "string" + }, + "min_docs": { + "type": "number" + }, + "max_docs": { + "type": "number" + }, + "min_size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "max_size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "min_primary_shard_size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "max_primary_shard_size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "min_primary_shard_docs": { + "type": "number" + }, + "max_primary_shard_docs": { + "type": "number" + } + } + }, + "indices._types:DataStreamLifecycle": { "type": "object", "properties": { "data_retention": { @@ -42906,8 +42949,9 @@ "downsampling": { "$ref": "#/components/schemas/indices._types:DataStreamLifecycleDownsampling" }, - "rollover": { - "$ref": "#/components/schemas/indices._types:DataStreamLifecycleRolloverConditions" + "enabled": { + "description": "If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream.", + "type": "boolean" } } }, @@ -42952,41 +42996,6 @@ "fixed_interval" ] }, - "indices._types:DataStreamLifecycleRolloverConditions": { - "type": "object", - "properties": { - "min_age": { - "$ref": "#/components/schemas/_types:Duration" - }, - "max_age": { - "type": "string" - }, - "min_docs": { - "type": "number" - }, - "max_docs": { - "type": "number" - }, - "min_size": { - "$ref": "#/components/schemas/_types:ByteSize" - }, - "max_size": { - "$ref": "#/components/schemas/_types:ByteSize" - }, - "min_primary_shard_size": { - "$ref": "#/components/schemas/_types:ByteSize" - }, - "max_primary_shard_size": { - "$ref": "#/components/schemas/_types:ByteSize" - }, - "min_primary_shard_docs": { - "type": "number" - }, - "max_primary_shard_docs": { - "type": "number" - } - } - }, "_types:ClusterInfoTargets": { "oneOf": [ { @@ -43330,17 +43339,6 @@ "_types:DataStreamName": { "type": "string" }, - "indices._types:DataStreamLifecycle": { - "type": "object", - "properties": { - "data_retention": { - "$ref": "#/components/schemas/_types:Duration" - }, - "downsampling": { - "$ref": "#/components/schemas/indices._types:DataStreamLifecycleDownsampling" - } - } - }, "_types:Result": { "type": "string", "enum": [ @@ -45394,7 +45392,7 @@ "$ref": "#/components/schemas/_types:DataStreamName" }, "lifecycle": { - "$ref": "#/components/schemas/indices._types:DataStreamLifecycle" + "$ref": "#/components/schemas/indices._types:DataStreamLifecycleWithRollover" } }, "required": [ @@ -54117,11 +54115,30 @@ ] }, "search_application._types:SearchApplication": { + "allOf": [ + { + "$ref": "#/components/schemas/search_application._types:SearchApplicationParameters" + }, + { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/_types:Name" + }, + "updated_at_millis": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + } + }, + "required": [ + "name", + "updated_at_millis" + ] + } + ] + }, + "search_application._types:SearchApplicationParameters": { "type": "object", "properties": { - "name": { - "$ref": "#/components/schemas/_types:Name" - }, "indices": { "description": "Indices that are part of the Search Application.", "type": "array", @@ -54129,9 +54146,6 @@ "$ref": "#/components/schemas/_types:IndexName" } }, - "updated_at_millis": { - "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" - }, "analytics_collection_name": { "$ref": "#/components/schemas/_types:Name" }, @@ -54140,9 +54154,7 @@ } }, "required": [ - "name", - "indices", - "updated_at_millis" + "indices" ] }, "search_application._types:SearchApplicationTemplate": { @@ -54178,32 +54190,6 @@ "name" ] }, - "search_application.list:SearchApplicationListItem": { - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/_types:Name" - }, - "indices": { - "description": "Indices that are part of the Search Application", - "type": "array", - "items": { - "$ref": "#/components/schemas/_types:IndexName" - } - }, - "updated_at_millis": { - "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" - }, - "analytics_collection_name": { - "$ref": "#/components/schemas/_types:Name" - } - }, - "required": [ - "name", - "indices", - "updated_at_millis" - ] - }, "search_application.put_behavioral_analytics:AnalyticsAcknowledgeResponseBase": { "allOf": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index a6f3ca165d..838ceab4d1 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -7563,7 +7563,7 @@ "name": "Request", "namespace": "indices.put_data_lifecycle" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -9414,7 +9414,8 @@ } }, "description": "Start a trial.\nStart a 30-day trial, which gives access to all subscription features.\n\nNOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version.\nFor example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension.\n\nTo check the status of your trial, use the get trial status API.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trial.html", + "docId": "start-trial", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/start-trial.html", "name": "license.post_start_trial", "privileges": { "cluster": [ @@ -104329,8 +104330,21 @@ "kind": "properties", "properties": [ { - "name": "leader_index", + "description": "If the leader index is part of a data stream, the name to which the local data stream for the followed index should be renamed.", + "name": "data_stream_name", "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The name of the index in the leader cluster to follow.", + "name": "leader_index", + "required": true, "type": { "kind": "instance_of", "type": { @@ -104340,6 +104354,7 @@ } }, { + "description": "The maximum number of outstanding reads requests from the remote cluster.", "name": "max_outstanding_read_requests", "required": false, "type": { @@ -104351,39 +104366,43 @@ } }, { + "description": "The maximum number of outstanding write requests on the follower.", "name": "max_outstanding_write_requests", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { + "description": "The maximum number of operations to pull per read from the remote cluster.", "name": "max_read_request_operation_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { + "description": "The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.", "name": "max_read_request_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } }, { + "description": "The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when\nretrying.", "name": "max_retry_delay", "required": false, "type": { @@ -104395,50 +104414,55 @@ } }, { + "description": "The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be\ndeferred until the number of queued operations goes below the limit.", "name": "max_write_buffer_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { + "description": "The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will\nbe deferred until the total bytes of queued operations goes below the limit.", "name": "max_write_buffer_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } }, { + "description": "The maximum number of operations per bulk write request executed on the follower.", "name": "max_write_request_operation_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { + "description": "The maximum total bytes of operations per bulk write request executed on the follower.", "name": "max_write_request_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } }, { + "description": "The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index.\nWhen the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics.\nThen the follower will immediately attempt to read from the leader again.", "name": "read_poll_timeout", "required": false, "type": { @@ -104450,8 +104474,9 @@ } }, { + "description": "The remote cluster containing the leader index.", "name": "remote_cluster", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { @@ -104459,6 +104484,18 @@ "namespace": "_builtins" } } + }, + { + "description": "Settings to override from the leader index.", + "name": "settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexSettings", + "namespace": "indices._types" + } + } } ] }, @@ -104475,7 +104512,7 @@ }, "path": [ { - "description": "The name of the follower index", + "description": "The name of the follower index.", "name": "index", "required": true, "type": { @@ -104489,7 +104526,7 @@ ], "query": [ { - "description": "Sets the number of shard copies that must be active before returning. Defaults to 0. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)", + "description": "Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be\nactive.\nA shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the\nremote Lucene segment files to the follower index.", "name": "wait_for_active_shards", "required": false, "type": { @@ -104501,7 +104538,7 @@ } } ], - "specLocation": "ccr/follow/CreateFollowIndexRequest.ts#L25-L54" + "specLocation": "ccr/follow/CreateFollowIndexRequest.ts#L26-L113" }, { "kind": "response", @@ -104622,19 +104659,21 @@ }, "properties": [ { + "description": "The maximum number of outstanding reads requests from the remote cluster.", "name": "max_outstanding_read_requests", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { + "description": "The maximum number of outstanding write requests on the follower.", "name": "max_outstanding_write_requests", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -104644,8 +104683,9 @@ } }, { + "description": "The maximum number of operations to pull per read from the remote cluster.", "name": "max_read_request_operation_count", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -104655,19 +104695,21 @@ } }, { + "description": "The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.", "name": "max_read_request_size", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } }, { + "description": "The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when\nretrying.", "name": "max_retry_delay", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -104677,8 +104719,9 @@ } }, { + "description": "The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be\ndeferred until the number of queued operations goes below the limit.", "name": "max_write_buffer_count", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -104688,19 +104731,21 @@ } }, { + "description": "The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will\nbe deferred until the total bytes of queued operations goes below the limit.", "name": "max_write_buffer_size", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } }, { + "description": "The maximum number of operations per bulk write request executed on the follower.", "name": "max_write_request_operation_count", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -104710,19 +104755,21 @@ } }, { + "description": "The maximum total bytes of operations per bulk write request executed on the follower.", "name": "max_write_request_size", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } }, { + "description": "The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index.\nWhen the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics.\nThen the follower will immediately attempt to read from the leader again.", "name": "read_poll_timeout", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -104732,7 +104779,7 @@ } } ], - "specLocation": "ccr/follow_info/types.ts#L37-L48" + "specLocation": "ccr/follow_info/types.ts#L37-L83" }, { "kind": "enum", @@ -124760,6 +124807,7 @@ }, "properties": [ { + "description": "If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely.", "name": "data_retention", "required": false, "type": { @@ -124771,6 +124819,7 @@ } }, { + "description": "The downsampling configuration to execute for the managed backing index after rollover.", "name": "downsampling", "required": false, "type": { @@ -124780,9 +124829,22 @@ "namespace": "indices._types" } } + }, + { + "description": "If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream.", + "name": "enabled", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } ], - "specLocation": "indices/_types/DataStreamLifecycle.ts#L25-L31" + "specLocation": "indices/_types/DataStreamLifecycle.ts#L25-L45" }, { "kind": "interface", @@ -124927,40 +124989,22 @@ } } ], - "specLocation": "indices/_types/DataStreamLifecycle.ts#L57-L69" + "specLocation": "indices/_types/DataStreamLifecycle.ts#L60-L72" }, { "kind": "interface", "description": "Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions,\nif asked.", + "inherits": { + "type": { + "name": "DataStreamLifecycle", + "namespace": "indices._types" + } + }, "name": { "name": "DataStreamLifecycleWithRollover", "namespace": "indices._types" }, "properties": [ - { - "description": "If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely.", - "name": "data_retention", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The downsampling configuration to execute for the managed backing index after rollover.", - "name": "downsampling", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DataStreamLifecycleDownsampling", - "namespace": "indices._types" - } - } - }, { "description": "The conditions which will trigger the rollover of a backing index as configured by the cluster setting `cluster.lifecycle.default.rollover`.\nThis property is an implementation detail and it will only be retrieved when the query param `include_defaults` is set to true.\nThe contents of this field are subject to change.", "name": "rollover", @@ -124974,7 +125018,7 @@ } } ], - "specLocation": "indices/_types/DataStreamLifecycle.ts#L33-L55" + "specLocation": "indices/_types/DataStreamLifecycle.ts#L47-L58" }, { "kind": "interface", @@ -133146,7 +133190,7 @@ "type": { "kind": "instance_of", "type": { - "name": "DataStreamLifecycle", + "name": "DataStreamLifecycleWithRollover", "namespace": "indices._types" } } @@ -134740,33 +134784,15 @@ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "description": "If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely.", - "name": "data_retention", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "If defined, every backing index will execute the configured downsampling configuration after the backing\nindex is not the data stream write index anymore.", - "name": "downsampling", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DataStreamLifecycleDownsampling", - "namespace": "indices._types" - } - } + "kind": "value", + "codegenName": "lifecycle", + "value": { + "kind": "instance_of", + "type": { + "name": "DataStreamLifecycle", + "namespace": "indices._types" } - ] + } }, "description": "Update data stream lifecycles.\nUpdate the data stream lifecycle of the specified data streams.", "inherits": { @@ -134834,7 +134860,7 @@ } } ], - "specLocation": "indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts#L25-L77" + "specLocation": "indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts#L25-L68" }, { "kind": "response", @@ -150396,7 +150422,7 @@ } } ], - "specLocation": "license/post_start_trial/StartTrialLicenseRequest.ts#L22-L39" + "specLocation": "license/post_start_trial/StartTrialLicenseRequest.ts#L22-L40" }, { "kind": "response", @@ -188394,13 +188420,19 @@ }, { "kind": "interface", + "inherits": { + "type": { + "name": "SearchApplicationParameters", + "namespace": "search_application._types" + } + }, "name": { "name": "SearchApplication", "namespace": "search_application._types" }, "properties": [ { - "description": "Search Application name.", + "description": "Search Application name", "name": "name", "required": true, "type": { @@ -188411,21 +188443,6 @@ } } }, - { - "description": "Indices that are part of the Search Application.", - "name": "indices", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } - } - }, { "description": "Last time the Search Application was updated.", "name": "updated_at_millis", @@ -188446,6 +188463,31 @@ "namespace": "_types" } } + } + ], + "specLocation": "search_application/_types/SearchApplication.ts#L24-L33" + }, + { + "kind": "interface", + "name": { + "name": "SearchApplicationParameters", + "namespace": "search_application._types" + }, + "properties": [ + { + "description": "Indices that are part of the Search Application.", + "name": "indices", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + } }, { "description": "Analytics collection associated to the Search Application.", @@ -188472,7 +188514,7 @@ } } ], - "specLocation": "search_application/_types/SearchApplication.ts#L24-L45" + "specLocation": "search_application/_types/SearchApplicationParameters.ts#L23-L36" }, { "kind": "interface", @@ -188494,7 +188536,7 @@ } } ], - "specLocation": "search_application/_types/SearchApplication.ts#L47-L52" + "specLocation": "search_application/_types/SearchApplicationTemplate.ts#L22-L27" }, { "kind": "request", @@ -188811,8 +188853,8 @@ "value": { "kind": "instance_of", "type": { - "name": "SearchApplicationListItem", - "namespace": "search_application.list" + "name": "SearchApplication", + "namespace": "search_application._types" } } } @@ -188823,77 +188865,7 @@ "name": "Response", "namespace": "search_application.list" }, - "specLocation": "search_application/list/SearchApplicationsListResponse.ts#L24-L29" - }, - { - "kind": "interface", - "name": { - "name": "SearchApplicationListItem", - "namespace": "search_application.list" - }, - "properties": [ - { - "description": "Search Application name", - "name": "name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - }, - { - "description": "Indices that are part of the Search Application", - "name": "indices", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } - } - }, - { - "description": "Last time the Search Application was updated", - "name": "updated_at_millis", - "required": true, - "type": { - "kind": "instance_of", - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "type": { - "name": "EpochTime", - "namespace": "_types" - } - } - }, - { - "description": "Analytics collection associated to the Search Application", - "name": "analytics_collection_name", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - } - ], - "specLocation": "search_application/list/SearchApplicationsListResponse.ts#L31-L48" + "specLocation": "search_application/list/SearchApplicationsListResponse.ts#L23-L28" }, { "kind": "request", @@ -188906,7 +188878,7 @@ "value": { "kind": "instance_of", "type": { - "name": "SearchApplication", + "name": "SearchApplicationParameters", "namespace": "search_application._types" } } diff --git a/output/typescript/types.ts b/output/typescript/types.ts index aaa65f7045..255c6a5de6 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -8802,18 +8802,20 @@ export interface CcrFollowRequest extends RequestBase { index: IndexName wait_for_active_shards?: WaitForActiveShards body?: { - leader_index?: IndexName + data_stream_name?: string + leader_index: IndexName max_outstanding_read_requests?: long - max_outstanding_write_requests?: long - max_read_request_operation_count?: long - max_read_request_size?: string + max_outstanding_write_requests?: integer + max_read_request_operation_count?: integer + max_read_request_size?: ByteSize max_retry_delay?: Duration - max_write_buffer_count?: long - max_write_buffer_size?: string - max_write_request_operation_count?: long - max_write_request_size?: string + max_write_buffer_count?: integer + max_write_buffer_size?: ByteSize + max_write_request_operation_count?: integer + max_write_request_size?: ByteSize read_poll_timeout?: Duration - remote_cluster?: string + remote_cluster: string + settings?: IndicesIndexSettings } } @@ -8832,16 +8834,16 @@ export interface CcrFollowInfoFollowerIndex { } export interface CcrFollowInfoFollowerIndexParameters { - max_outstanding_read_requests: integer - max_outstanding_write_requests: integer - max_read_request_operation_count: integer - max_read_request_size: string - max_retry_delay: Duration - max_write_buffer_count: integer - max_write_buffer_size: string - max_write_request_operation_count: integer - max_write_request_size: string - read_poll_timeout: Duration + max_outstanding_read_requests?: long + max_outstanding_write_requests?: integer + max_read_request_operation_count?: integer + max_read_request_size?: ByteSize + max_retry_delay?: Duration + max_write_buffer_count?: integer + max_write_buffer_size?: ByteSize + max_write_request_operation_count?: integer + max_write_request_size?: ByteSize + read_poll_timeout?: Duration } export type CcrFollowInfoFollowerIndexStatus = 'active' | 'paused' @@ -10996,6 +10998,7 @@ export interface IndicesDataStreamIndex { export interface IndicesDataStreamLifecycle { data_retention?: Duration downsampling?: IndicesDataStreamLifecycleDownsampling + enabled?: boolean } export interface IndicesDataStreamLifecycleDownsampling { @@ -11015,9 +11018,7 @@ export interface IndicesDataStreamLifecycleRolloverConditions { max_primary_shard_docs?: long } -export interface IndicesDataStreamLifecycleWithRollover { - data_retention?: Duration - downsampling?: IndicesDataStreamLifecycleDownsampling +export interface IndicesDataStreamLifecycleWithRollover extends IndicesDataStreamLifecycle { rollover?: IndicesDataStreamLifecycleRolloverConditions } @@ -11883,7 +11884,7 @@ export type IndicesGetAliasResponse = Record +} + +export interface SearchApplicationSearchApplicationParameters { + indices: IndexName[] analytics_collection_name?: Name template?: SearchApplicationSearchApplicationTemplate } @@ -17722,20 +17723,13 @@ export interface SearchApplicationListRequest extends RequestBase { export interface SearchApplicationListResponse { count: long - results: SearchApplicationListSearchApplicationListItem[] -} - -export interface SearchApplicationListSearchApplicationListItem { - name: Name - indices: IndexName[] - updated_at_millis: EpochTime - analytics_collection_name?: Name + results: SearchApplicationSearchApplication[] } export interface SearchApplicationPutRequest extends RequestBase { name: Name create?: boolean - body?: SearchApplicationSearchApplication + body?: SearchApplicationSearchApplicationParameters } export interface SearchApplicationPutResponse { diff --git a/specification/license/get/GetLicenseResponseExample1.yaml b/specification/license/get/GetLicenseResponseExample1.yaml new file mode 100644 index 0000000000..937d67fc6e --- /dev/null +++ b/specification/license/get/GetLicenseResponseExample1.yaml @@ -0,0 +1,11 @@ +# summary: licensing/get-license.asciidoc:61 +description: A successful response from `GET /_license`. +# type: response +# response_code: '' +value: + "{\n \"license\" : {\n \"status\" : \"active\",\n \"uid\" : \"cbff45e7-c553-41f7-ae4f-9205eabd80xx\"\ + ,\n \"type\" : \"trial\",\n \"issue_date\" : \"2018-10-20T22:05:12.332Z\"\ + ,\n \"issue_date_in_millis\" : 1540073112332,\n \"expiry_date\" : \"2018-11-19T22:05:12.332Z\"\ + ,\n \"expiry_date_in_millis\" : 1542665112332,\n \"max_nodes\" : 1000,\n \ + \ \"max_resource_units\" : null,\n \"issued_to\" : \"test\",\n \"issuer\"\ + \ : \"elasticsearch\",\n \"start_date_in_millis\" : -1\n }\n}" diff --git a/specification/license/get_basic_status/GetBasicLicenseStatusResponseExample1.yaml b/specification/license/get_basic_status/GetBasicLicenseStatusResponseExample1.yaml new file mode 100644 index 0000000000..e6ed67a9d9 --- /dev/null +++ b/specification/license/get_basic_status/GetBasicLicenseStatusResponseExample1.yaml @@ -0,0 +1,6 @@ +# summary: licensing/get-basic-status.asciidoc:42 +description: A successful response from `GET /_license/basic_status`. +# type: response +# response_code: 200 +value: + eligible_to_start_basic: true diff --git a/specification/license/get_trial_status/GetTrialLicenseStatusResponseExample1.yaml b/specification/license/get_trial_status/GetTrialLicenseStatusResponseExample1.yaml new file mode 100644 index 0000000000..ce0ad02ed5 --- /dev/null +++ b/specification/license/get_trial_status/GetTrialLicenseStatusResponseExample1.yaml @@ -0,0 +1,6 @@ +# summary: licensing/get-trial-status.asciidoc:47 +description: A successful response from `GET /_license/trial_status`. +# type: response +# response_code: 200 +value: + eligible_to_start_trial: true diff --git a/specification/license/post/PostLicenseRequestExample1.yaml b/specification/license/post/PostLicenseRequestExample1.yaml new file mode 100644 index 0000000000..b31c86f423 --- /dev/null +++ b/specification/license/post/PostLicenseRequestExample1.yaml @@ -0,0 +1,11 @@ +# summary: licensing/update-license.asciidoc:63 +# method_request: PUT _license +description: > + Run `PUT _license` to update to a basic license. NOTE: These values are invalid; you must substitute the appropriate contents from your license file. +# type: request +value: + "{\n \"licenses\": [\n {\n \"uid\":\"893361dc-9749-4997-93cb-802e3d7fa4xx\"\ + ,\n \"type\":\"basic\",\n \"issue_date_in_millis\":1411948800000,\n \ + \ \"expiry_date_in_millis\":1914278399999,\n \"max_nodes\":1,\n \"\ + issued_to\":\"issuedTo\",\n \"issuer\":\"issuer\",\n \"signature\":\"\ + xx\"\n }\n ]\n}" diff --git a/specification/license/post/PostLicenseResponseExample1.yaml b/specification/license/post/PostLicenseResponseExample1.yaml new file mode 100644 index 0000000000..e6e7d909f1 --- /dev/null +++ b/specification/license/post/PostLicenseResponseExample1.yaml @@ -0,0 +1,15 @@ +# summary: licensing/get-trial-status.asciidoc:47 +description: If you update to a basic license and you previously had a license with more features, you receive this type of response. You must re-submit the API request and set the `acknowledge` parameter to `true`. +# type: response +# response_code: 200 +value: + acknowledged: false + license_status: valid + acknowledge: + message: '"""This license update requires acknowledgement. To acknowledge the license, please read the following messages and update the license again, this time with the "acknowledge=true" parameter:"""' + watcher: + - Watcher will be disabled + logstash: + - Logstash will no longer poll for centrally-managed pipelines + security: + - The following X-Pack security functionality will be disabled ... diff --git a/specification/license/post_start_basic/StartBasicLicenseResponseExample1.yaml b/specification/license/post_start_basic/StartBasicLicenseResponseExample1.yaml new file mode 100644 index 0000000000..805a87b14c --- /dev/null +++ b/specification/license/post_start_basic/StartBasicLicenseResponseExample1.yaml @@ -0,0 +1,7 @@ +# summary: +description: A successful response from `POST /_license/start_basic?acknowledge=true`. If you currently have a license with more features than a basic license and you start a basic license, you must pass the acknowledge parameter. +# type: response +# response_code: 200 +value: + basic_was_started: true + acknowledged: true diff --git a/specification/license/post_start_trial/StartTrialLicenseRequest.ts b/specification/license/post_start_trial/StartTrialLicenseRequest.ts index 5c722aec81..989ae9f846 100644 --- a/specification/license/post_start_trial/StartTrialLicenseRequest.ts +++ b/specification/license/post_start_trial/StartTrialLicenseRequest.ts @@ -30,6 +30,7 @@ import { RequestBase } from '@_types/Base' * @rest_spec_name license.post_start_trial * @availability stack since=6.1.0 stability=stable * @cluster_privileges manage + * @doc_id start-trial */ export interface Request extends RequestBase { query_parameters: { diff --git a/specification/license/post_start_trial/StartTrialLicenseResponseExample1.yaml b/specification/license/post_start_trial/StartTrialLicenseResponseExample1.yaml new file mode 100644 index 0000000000..105dcc1ae5 --- /dev/null +++ b/specification/license/post_start_trial/StartTrialLicenseResponseExample1.yaml @@ -0,0 +1,7 @@ +# summary: +description: A successful response from `POST /_license/start_trial?acknowledge=true`. +# type: response +# response_code: 200 +value: + trial_was_started: true + acknowledged: true