diff --git a/compiler-rs/clients_schema_to_openapi/src/schemas.rs b/compiler-rs/clients_schema_to_openapi/src/schemas.rs index aad4849082..cd8003c35c 100644 --- a/compiler-rs/clients_schema_to_openapi/src/schemas.rs +++ b/compiler-rs/clients_schema_to_openapi/src/schemas.rs @@ -242,12 +242,28 @@ impl<'a> TypesAndComponents<'a> { } fn convert_property(&mut self, prop: &Property) -> anyhow::Result> { - let mut result = self.convert_value_of(&prop.typ)?; - // TODO: how can we just wrap a reference so that we can add docs? - if let ReferenceOr::Item(ref mut schema) = &mut result { - self.fill_data_with_prop(&mut schema.schema_data, prop)?; - } - Ok(result) + let result = self.convert_value_of(&prop.typ)?; + + // OpenAPI 3.0 doesn't allow adding summary and description to a reference. The recommended workaround + // is to use a schema with a single `allOf` - see https://github.com/OAI/OpenAPI-Specification/issues/1514 + // + // OpenAPI 3.1 added summary and description for a `$ref` have been added to avoid the workaround + // https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#reference-object + + let mut schema = match result { + ReferenceOr::Item(schema) => schema, + reference @ ReferenceOr::Reference { reference: _ } => Schema { + schema_kind: SchemaKind::AllOf { + all_of: vec![reference] + }, + schema_data: Default::default(), + } + }; + + // Add docs & other properties + self.fill_data_with_prop(&mut schema.schema_data, prop)?; + + Ok(ReferenceOr::Item(schema)) } fn convert_properties<'b>( diff --git a/compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib.js b/compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib.js index 706ad37970..1264153823 100644 --- a/compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib.js +++ b/compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib.js @@ -23,18 +23,9 @@ function getStringFromWasm0(ptr, len) { return cachedTextDecoder.decode(getUint8ArrayMemory0().subarray(ptr, ptr + len)); } -const heap = new Array(128).fill(undefined); - -heap.push(undefined, null, true, false); - -let heap_next = heap.length; - -function addHeapObject(obj) { - if (heap_next === heap.length) heap.push(heap.length + 1); - const idx = heap_next; - heap_next = heap[idx]; - - heap[idx] = obj; +function addToExternrefTable0(obj) { + const idx = wasm.__externref_table_alloc(); + wasm.__wbindgen_export_3.set(idx, obj); return idx; } @@ -42,7 +33,8 @@ function handleError(f, args) { try { return f.apply(this, args); } catch (e) { - wasm.__wbindgen_exn_store(addHeapObject(e)); + const idx = addToExternrefTable0(e); + wasm.__wbindgen_exn_store(idx); } } @@ -111,33 +103,25 @@ function getDataViewMemory0() { return cachedDataViewMemory0; } -function getObject(idx) { return heap[idx]; } - -function dropObject(idx) { - if (idx < 132) return; - heap[idx] = heap_next; - heap_next = idx; -} - -function takeObject(idx) { - const ret = getObject(idx); - dropObject(idx); - return ret; -} - function isLikeNone(x) { return x === undefined || x === null; } function passArrayJsValueToWasm0(array, malloc) { const ptr = malloc(array.length * 4, 4) >>> 0; - const mem = getDataViewMemory0(); for (let i = 0; i < array.length; i++) { - mem.setUint32(ptr + 4 * i, addHeapObject(array[i]), true); + const add = addToExternrefTable0(array[i]); + getDataViewMemory0().setUint32(ptr + 4 * i, add, true); } WASM_VECTOR_LEN = array.length; return ptr; } + +function takeFromExternrefTable0(idx) { + const value = wasm.__wbindgen_export_3.get(idx); + wasm.__externref_table_dealloc(idx); + return value; +} /** * Convert schema.json to OpenAPI. The `cwd` argument is the current directory to be used * if not the system-defined one, as is the case when running with `npm rum --prefix compiler` @@ -145,20 +129,13 @@ function passArrayJsValueToWasm0(array, malloc) { * @param {string | null} [cwd] */ module.exports.convert_schema_to_openapi = function(args, cwd) { - try { - const retptr = wasm.__wbindgen_add_to_stack_pointer(-16); - const ptr0 = passArrayJsValueToWasm0(args, wasm.__wbindgen_malloc); - const len0 = WASM_VECTOR_LEN; - var ptr1 = isLikeNone(cwd) ? 0 : passStringToWasm0(cwd, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc); - var len1 = WASM_VECTOR_LEN; - wasm.convert_schema_to_openapi(retptr, ptr0, len0, ptr1, len1); - var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true); - var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true); - if (r1) { - throw takeObject(r0); - } - } finally { - wasm.__wbindgen_add_to_stack_pointer(16); + const ptr0 = passArrayJsValueToWasm0(args, wasm.__wbindgen_malloc); + const len0 = WASM_VECTOR_LEN; + var ptr1 = isLikeNone(cwd) ? 0 : passStringToWasm0(cwd, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc); + var len1 = WASM_VECTOR_LEN; + const ret = wasm.convert_schema_to_openapi(ptr0, len0, ptr1, len1); + if (ret[1]) { + throw takeFromExternrefTable0(ret[0]); } }; @@ -221,7 +198,7 @@ module.exports.__wbg_measure_fb7825c11612c823 = function() { return handleError( module.exports.__wbg_new_8a6f238a6ece86ea = function() { const ret = new Error(); - return addHeapObject(ret); + return ret; }; module.exports.__wbg_readFileSync_691af69453e7d4ec = function(arg0, arg1, arg2, arg3, arg4) { @@ -233,7 +210,7 @@ module.exports.__wbg_readFileSync_691af69453e7d4ec = function(arg0, arg1, arg2, }; module.exports.__wbg_stack_0ed75d68575b0f3c = function(arg0, arg1) { - const ret = getObject(arg1).stack; + const ret = arg1.stack; const ptr1 = passStringToWasm0(ret, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc); const len1 = WASM_VECTOR_LEN; getDataViewMemory0().setInt32(arg0 + 4 * 1, len1, true); @@ -244,12 +221,19 @@ module.exports.__wbg_writeFileSync_d2c5ed0808e00dc9 = function(arg0, arg1, arg2, writeFileSync(getStringFromWasm0(arg0, arg1), getStringFromWasm0(arg2, arg3)); }; -module.exports.__wbindgen_object_drop_ref = function(arg0) { - takeObject(arg0); +module.exports.__wbindgen_init_externref_table = function() { + const table = wasm.__wbindgen_export_3; + const offset = table.grow(4); + table.set(0, undefined); + table.set(offset + 0, undefined); + table.set(offset + 1, null); + table.set(offset + 2, true); + table.set(offset + 3, false); + ; }; module.exports.__wbindgen_string_get = function(arg0, arg1) { - const obj = getObject(arg1); + const obj = arg1; const ret = typeof(obj) === 'string' ? obj : undefined; var ptr1 = isLikeNone(ret) ? 0 : passStringToWasm0(ret, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc); var len1 = WASM_VECTOR_LEN; @@ -259,7 +243,7 @@ module.exports.__wbindgen_string_get = function(arg0, arg1) { module.exports.__wbindgen_string_new = function(arg0, arg1) { const ret = getStringFromWasm0(arg0, arg1); - return addHeapObject(ret); + return ret; }; module.exports.__wbindgen_throw = function(arg0, arg1) { @@ -274,3 +258,5 @@ const wasmInstance = new WebAssembly.Instance(wasmModule, imports); wasm = wasmInstance.exports; module.exports.__wasm = wasm; +wasm.__wbindgen_start(); + diff --git a/compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm b/compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm index 95a9fea96f..7dc834a35a 100644 Binary files a/compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm and b/compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm differ diff --git a/compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm.d.ts b/compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm.d.ts index f9645942c4..2d4f44aee3 100644 --- a/compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm.d.ts +++ b/compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm.d.ts @@ -1,9 +1,12 @@ /* tslint:disable */ /* eslint-disable */ export const memory: WebAssembly.Memory; -export const convert_schema_to_openapi: (a: number, b: number, c: number, d: number, e: number) => void; +export const convert_schema_to_openapi: (a: number, b: number, c: number, d: number) => [number, number]; export const __wbindgen_free: (a: number, b: number, c: number) => void; export const __wbindgen_exn_store: (a: number) => void; +export const __externref_table_alloc: () => number; +export const __wbindgen_export_3: WebAssembly.Table; export const __wbindgen_malloc: (a: number, b: number) => number; export const __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number; -export const __wbindgen_add_to_stack_pointer: (a: number) => number; +export const __externref_table_dealloc: (a: number) => void; +export const __wbindgen_start: () => void; diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 2635ea9e0e..072a1aba28 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -3324,13 +3324,28 @@ "type": "string" }, "follow_index_pattern": { - "$ref": "#/components/schemas/_types.IndexPattern" + "description": "The name of follower index. The template {{leader_index}} can be used to derive the name of the follower index from the name of the leader index. When following a data stream, use {{leader_index}}; CCR does not support changes to the names of a follower data stream’s backing indices.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexPattern" + } + ] }, "leader_index_patterns": { - "$ref": "#/components/schemas/_types.IndexPatterns" + "description": "An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexPatterns" + } + ] }, "leader_index_exclusion_patterns": { - "$ref": "#/components/schemas/_types.IndexPatterns" + "description": "An array of simple index patterns that can be used to exclude indices from being auto-followed. Indices in the remote cluster whose names are matching one or more leader_index_patterns and one or more leader_index_exclusion_patterns won’t be followed.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexPatterns" + } + ] }, "max_outstanding_read_requests": { "description": "The maximum number of outstanding reads requests from the remote cluster.", @@ -3350,7 +3365,13 @@ "type": "number" }, "read_poll_timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again.", + "default": "1m", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "max_read_request_operation_count": { "description": "The maximum number of operations to pull per read from the remote cluster.", @@ -3358,10 +3379,22 @@ "type": "number" }, "max_read_request_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.", + "default": "32mb", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "max_retry_delay": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying.", + "default": "500ms", + "allOf": [ + { + "$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 deferred until the number of queued operations goes below the limit.", @@ -3369,7 +3402,13 @@ "type": "number" }, "max_write_buffer_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit.", + "default": "512mb", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "max_write_request_operation_count": { "description": "The maximum number of operations per bulk write request executed on the follower.", @@ -3377,7 +3416,13 @@ "type": "number" }, "max_write_request_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The maximum total bytes of operations per bulk write request executed on the follower.", + "default": "9223372036854775807b", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] } }, "required": [ @@ -3533,7 +3578,12 @@ "type": "string" }, "leader_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The name of the index in the leader cluster to follow.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "max_outstanding_read_requests": { "description": "The maximum number of outstanding reads requests from the remote cluster.", @@ -3548,34 +3598,64 @@ "type": "number" }, "max_read_request_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "max_retry_delay": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when\nretrying.", + "allOf": [ + { + "$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" + "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.", + "allOf": [ + { + "$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" + "description": "The maximum total bytes of operations per bulk write request executed on the follower.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "read_poll_timeout": { - "$ref": "#/components/schemas/_types.Duration" + "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.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "remote_cluster": { "description": "The remote cluster containing the leader index.", "type": "string" }, "settings": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "description": "Settings to override from the leader index.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] } }, "required": [ @@ -3834,10 +3914,18 @@ "type": "string" }, "follower_index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "follower_index_uuid": { - "$ref": "#/components/schemas/_types.Uuid" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Uuid" + } + ] }, "leader_remote_cluster": { "type": "string" @@ -3863,7 +3951,11 @@ "type": "object", "properties": { "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] } }, "required": [ @@ -4156,7 +4248,11 @@ "type": "string" }, "max_retry_delay": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "max_write_buffer_count": { "type": "number" @@ -4171,7 +4267,11 @@ "type": "string" }, "read_poll_timeout": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } } }, @@ -4250,10 +4350,20 @@ "type": "object", "properties": { "auto_follow_stats": { - "$ref": "#/components/schemas/ccr.stats.AutoFollowStats" + "description": "Statistics for the auto-follow coordinator.", + "allOf": [ + { + "$ref": "#/components/schemas/ccr.stats.AutoFollowStats" + } + ] }, "follow_stats": { - "$ref": "#/components/schemas/ccr.stats.FollowStats" + "description": "Shard-level statistics for follower indices.", + "allOf": [ + { + "$ref": "#/components/schemas/ccr.stats.FollowStats" + } + ] } }, "required": [ @@ -4578,7 +4688,12 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The ID of the point-in-time.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] } }, "required": [ @@ -5500,13 +5615,25 @@ "type": "object", "properties": { "cluster_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "http": { - "$ref": "#/components/schemas/nodes._types.Http" + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.Http" + } + ] }, "ingest": { - "$ref": "#/components/schemas/nodes._types.Ingest" + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.Ingest" + } + ] }, "thread_pool": { "type": "object", @@ -5515,7 +5642,11 @@ } }, "script": { - "$ref": "#/components/schemas/nodes._types.Scripting" + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.Scripting" + } + ] } }, "required": [ @@ -6012,7 +6143,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -6335,7 +6470,11 @@ "type": "string" }, "index_name": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "is_native": { "type": "boolean" @@ -6363,10 +6502,18 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] } }, "required": [ @@ -6417,7 +6564,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -6821,13 +6972,26 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The id of the associated connector", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "job_type": { - "$ref": "#/components/schemas/connector._types.SyncJobType" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.SyncJobType" + } + ] }, "trigger_method": { - "$ref": "#/components/schemas/connector._types.SyncJobTriggerMethod" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.SyncJobTriggerMethod" + } + ] } }, "required": [ @@ -6852,7 +7016,11 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] } }, "required": [ @@ -6912,10 +7080,20 @@ "type": "number" }, "last_seen": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The timestamp to use in the `last_seen` property for the connector sync job.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "The connector-specific metadata.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "total_document_count": { "description": "The total number of documents in the target index after the sync job finished.", @@ -6989,7 +7167,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -7062,7 +7244,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -7115,7 +7301,11 @@ "type": "object", "properties": { "configuration": { - "$ref": "#/components/schemas/connector._types.ConnectorConfiguration" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.ConnectorConfiguration" + } + ] }, "values": { "type": "object", @@ -7146,7 +7336,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -7231,7 +7425,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -7284,7 +7482,11 @@ "type": "object", "properties": { "features": { - "$ref": "#/components/schemas/connector._types.ConnectorFeatures" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.ConnectorFeatures" + } + ] } }, "required": [ @@ -7312,7 +7514,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -7377,7 +7583,11 @@ } }, "advanced_snippet": { - "$ref": "#/components/schemas/connector._types.FilteringAdvancedSnippet" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FilteringAdvancedSnippet" + } + ] } } }, @@ -7402,7 +7612,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -7455,7 +7669,11 @@ "type": "object", "properties": { "validation": { - "$ref": "#/components/schemas/connector._types.FilteringRulesValidation" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FilteringRulesValidation" + } + ] } }, "required": [ @@ -7475,7 +7693,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -7555,7 +7777,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -7632,7 +7858,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -7704,7 +7934,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -7752,7 +7986,11 @@ "type": "object", "properties": { "pipeline": { - "$ref": "#/components/schemas/connector._types.IngestPipelineParams" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.IngestPipelineParams" + } + ] } }, "required": [ @@ -7777,7 +8015,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -7829,7 +8071,11 @@ "type": "object", "properties": { "scheduling": { - "$ref": "#/components/schemas/connector._types.SchedulingConfiguration" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.SchedulingConfiguration" + } + ] } }, "required": [ @@ -7857,7 +8103,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -7934,7 +8184,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -7986,7 +8240,11 @@ "type": "object", "properties": { "status": { - "$ref": "#/components/schemas/connector._types.ConnectorStatus" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.ConnectorStatus" + } + ] } }, "required": [ @@ -8011,7 +8269,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -9582,10 +9844,20 @@ "type": "number" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "The documents to delete specified with Query DSL.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "slice": { - "$ref": "#/components/schemas/_types.SlicedScroll" + "description": "Slice the request manually using the provided slice ID and total number of slices.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SlicedScroll" + } + ] } } }, @@ -9647,32 +9919,64 @@ "type": "number" }, "retries": { - "$ref": "#/components/schemas/_types.Retries" + "description": "The number of retries attempted by delete by query.\n`bulk` is the number of bulk actions retried.\n`search` is the number of search actions retried.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Retries" + } + ] }, "slice_id": { "type": "number" }, "task": { - "$ref": "#/components/schemas/_types.TaskId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TaskId" + } + ] }, "throttled": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "throttled_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The number of milliseconds the request slept to conform to `requests_per_second`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "throttled_until": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "throttled_until_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "This field should always be equal to zero in a `_delete_by_query` response.\nIt has meaning only when using the task API, where it indicates the next time (in milliseconds since epoch) a throttled request will be run again in order to conform to `requests_per_second`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "timed_out": { "description": "If `true`, some requests run during the delete by query operation timed out.", "type": "boolean" }, "took": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The number of milliseconds from start to end of the whole operation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "total": { "description": "The number of documents that were successfully processed.", @@ -9795,13 +10099,21 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "found": { "type": "boolean" }, "script": { - "$ref": "#/components/schemas/_types.StoredScript" + "allOf": [ + { + "$ref": "#/components/schemas/_types.StoredScript" + } + ] } }, "required": [ @@ -10030,13 +10342,28 @@ "type": "object", "properties": { "geo_match": { - "$ref": "#/components/schemas/enrich._types.Policy" + "description": "Matches enrich data to incoming documents based on a `geo_shape` query.", + "allOf": [ + { + "$ref": "#/components/schemas/enrich._types.Policy" + } + ] }, "match": { - "$ref": "#/components/schemas/enrich._types.Policy" + "description": "Matches enrich data to incoming documents based on a `term` query.", + "allOf": [ + { + "$ref": "#/components/schemas/enrich._types.Policy" + } + ] }, "range": { - "$ref": "#/components/schemas/enrich._types.Policy" + "description": "Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query.", + "allOf": [ + { + "$ref": "#/components/schemas/enrich._types.Policy" + } + ] } } }, @@ -10171,10 +10498,18 @@ "type": "object", "properties": { "status": { - "$ref": "#/components/schemas/enrich.execute_policy.ExecuteEnrichPolicyStatus" + "allOf": [ + { + "$ref": "#/components/schemas/enrich.execute_policy.ExecuteEnrichPolicyStatus" + } + ] }, "task": { - "$ref": "#/components/schemas/_types.TaskId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TaskId" + } + ] } } } @@ -10419,7 +10754,12 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Identifier for the search.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "is_partial": { "description": "If true, the search request is still executing. If false, the search is completed.", @@ -10430,10 +10770,20 @@ "type": "boolean" }, "start_time_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "For a running search shows a timestamp when the eql search started, in milliseconds since the Unix epoch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "expiration_time_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "Shows a timestamp when the eql search will be expired, in milliseconds since the Unix epoch. When this time is reached, the search and its results are deleted, even if the search is still ongoing.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "completion_status": { "description": "For a completed search shows the http status code of the completed search.", @@ -10650,7 +11000,12 @@ "type": "boolean" }, "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "locale": { "type": "string" @@ -10686,10 +11041,22 @@ "type": "boolean" }, "wait_for_completion_timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The period to wait for the request to finish.\nBy default, the request waits for 1 second for the query results.\nIf the query completes during this period, results are returned\nOtherwise, a query ID is returned that can later be used to retrieve the results.", + "default": "1s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "keep_alive": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The period for which the query and its results are stored in the cluster.\nThe default period is five days.\nWhen this period expires, the query and its results are deleted, even if the query is still ongoing.\nIf the `keep_on_completion` parameter is false, Elasticsearch only stores async queries that do not complete within the period set by the `wait_for_completion_timeout` parameter, regardless of this value.", + "default": "5d", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "keep_on_completion": { "description": "Indicates whether the query and its results are stored in the cluster.\nIf false, the query and its results are stored in the cluster only if the request does not complete during the period set by the `wait_for_completion_timeout` parameter.", @@ -10949,7 +11316,11 @@ "type": "number" }, "node": { - "$ref": "#/components/schemas/_types.NodeId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] }, "start_time_millis": { "type": "number" @@ -10961,7 +11332,11 @@ "type": "string" }, "coordinating_node": { - "$ref": "#/components/schemas/_types.NodeId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] }, "data_nodes": { "type": "array", @@ -11097,7 +11472,12 @@ "type": "boolean" }, "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "locale": { "type": "string" @@ -12924,7 +13304,11 @@ "type": "object", "properties": { "policy": { - "$ref": "#/components/schemas/ilm._types.Policy" + "allOf": [ + { + "$ref": "#/components/schemas/ilm._types.Policy" + } + ] } } }, @@ -13166,7 +13550,11 @@ "type": "object", "properties": { "operation_mode": { - "$ref": "#/components/schemas/_types.LifecycleOperationMode" + "allOf": [ + { + "$ref": "#/components/schemas/_types.LifecycleOperationMode" + } + ] } }, "required": [ @@ -13272,7 +13660,12 @@ } }, "migrated_indices": { - "$ref": "#/components/schemas/_types.Indices" + "description": "The indices that were migrated to tier preference routing.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "migrated_legacy_templates": { "description": "The legacy index templates that were updated to not contain custom routing settings for the provided data attribute.", @@ -13353,10 +13746,20 @@ "type": "object", "properties": { "current_step": { - "$ref": "#/components/schemas/ilm.move_to_step.StepKey" + "description": "The step that the index is expected to be in.", + "allOf": [ + { + "$ref": "#/components/schemas/ilm.move_to_step.StepKey" + } + ] }, "next_step": { - "$ref": "#/components/schemas/ilm.move_to_step.StepKey" + "description": "The step that you want to run.", + "allOf": [ + { + "$ref": "#/components/schemas/ilm.move_to_step.StepKey" + } + ] } }, "required": [ @@ -14625,10 +15028,20 @@ } }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "description": "Mapping for fields in the index. If specified, this mapping can include:\n- Field names\n- Field data types\n- Mapping parameters", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "settings": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "description": "Configuration options for the index.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] } } }, @@ -14661,7 +15074,11 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "shards_acknowledged": { "type": "boolean" @@ -15608,10 +16025,20 @@ "type": "object", "properties": { "data_retention": { - "$ref": "#/components/schemas/_types.Duration" + "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.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "downsampling": { - "$ref": "#/components/schemas/indices._types.DataStreamLifecycleDownsampling" + "description": "The downsampling configuration to execute for the managed backing index after rollover.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamLifecycleDownsampling" + } + ] }, "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.", @@ -15870,7 +16297,12 @@ "type": "object", "properties": { "failure_store": { - "$ref": "#/components/schemas/indices._types.DataStreamFailureStore" + "description": "If defined, it will update the failure store configuration of every data stream resolved by the name expression.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamFailureStore" + } + ] } } } @@ -17254,10 +17686,20 @@ } }, "last_run_duration_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The duration of the last data stream lifecycle execution.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "time_between_starts_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The time that passed between the start of the last two data stream lifecycle executions.\nThis value should amount approximately to `data_streams.lifecycle.poll_interval`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } }, "required": [ @@ -18013,10 +18455,18 @@ "type": "object", "properties": { "start_time": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "start_time_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "complete": { "type": "boolean" @@ -19627,7 +20077,11 @@ } }, "template": { - "$ref": "#/components/schemas/indices.simulate_template.Template" + "allOf": [ + { + "$ref": "#/components/schemas/indices.simulate_template.Template" + } + ] } }, "required": [ @@ -20498,7 +20952,12 @@ ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.TaskSettings" + "description": "Optional task settings", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskSettings" + } + ] } }, "required": [ @@ -20861,10 +21320,20 @@ "type": "object", "properties": { "service": { - "$ref": "#/components/schemas/inference._types.Ai21ServiceType" + "description": "The type of service supported for the specified task type. In this case, `ai21`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.Ai21ServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.Ai21ServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `ai21` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.Ai21ServiceSettings" + } + ] } }, "required": [ @@ -20955,16 +21424,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.AlibabaCloudServiceType" + "description": "The type of service supported for the specified task type. In this case, `alibabacloud-ai-search`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AlibabaCloudServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.AlibabaCloudServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `alibabacloud-ai-search` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AlibabaCloudServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.AlibabaCloudTaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AlibabaCloudTaskSettings" + } + ] } }, "required": [ @@ -21067,16 +21559,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.AmazonBedrockServiceType" + "description": "The type of service supported for the specified task type. In this case, `amazonbedrock`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AmazonBedrockServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.AmazonBedrockServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `amazonbedrock` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AmazonBedrockServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.AmazonBedrockTaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AmazonBedrockTaskSettings" + } + ] } }, "required": [ @@ -21169,16 +21684,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.AmazonSageMakerServiceType" + "description": "The type of service supported for the specified task type. In this case, `amazon_sagemaker`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AmazonSageMakerServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.AmazonSageMakerServiceSettings" + "description": "Settings used to install the inference model.\nThese settings are specific to the `amazon_sagemaker` service and `service_settings.api` you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AmazonSageMakerServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.AmazonSageMakerTaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type and `service_settings.api` you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AmazonSageMakerTaskSettings" + } + ] } }, "required": [ @@ -21286,16 +21824,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.AnthropicServiceType" + "description": "The type of service supported for the specified task type. In this case, `anthropic`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AnthropicServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.AnthropicServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `watsonxai` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AnthropicServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.AnthropicTaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AnthropicTaskSettings" + } + ] } }, "required": [ @@ -21382,16 +21943,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.AzureAiStudioServiceType" + "description": "The type of service supported for the specified task type. In this case, `azureaistudio`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AzureAiStudioServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.AzureAiStudioServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `openai` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AzureAiStudioServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.AzureAiStudioTaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AzureAiStudioTaskSettings" + } + ] } }, "required": [ @@ -21489,16 +22073,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.AzureOpenAIServiceType" + "description": "The type of service supported for the specified task type. In this case, `azureopenai`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AzureOpenAIServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.AzureOpenAIServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `azureopenai` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AzureOpenAIServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.AzureOpenAITaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AzureOpenAITaskSettings" + } + ] } }, "required": [ @@ -21591,16 +22198,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.CohereServiceType" + "description": "The type of service supported for the specified task type. In this case, `cohere`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CohereServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.CohereServiceSettings" + "description": "Settings used to install the inference model.\nThese settings are specific to the `cohere` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CohereServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.CohereTaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CohereTaskSettings" + } + ] } }, "required": [ @@ -21688,16 +22318,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.CustomServiceType" + "description": "The type of service supported for the specified task type. In this case, `custom`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CustomServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.CustomServiceSettings" + "description": "Settings used to install the inference model.\nThese settings are specific to the `custom` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CustomServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.CustomTaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CustomTaskSettings" + } + ] } }, "required": [ @@ -21805,13 +22458,31 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.DeepSeekServiceType" + "description": "The type of service supported for the specified task type. In this case, `deepseek`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.DeepSeekServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.DeepSeekServiceSettings" + "description": "Settings used to install the inference model.\nThese settings are specific to the `deepseek` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.DeepSeekServiceSettings" + } + ] } }, "required": [ @@ -21892,16 +22563,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.ElasticsearchServiceType" + "description": "The type of service supported for the specified task type. In this case, `elasticsearch`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.ElasticsearchServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.ElasticsearchServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `elasticsearch` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.ElasticsearchServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.ElasticsearchTaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.ElasticsearchTaskSettings" + } + ] } }, "required": [ @@ -22020,13 +22714,31 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.ElserServiceType" + "description": "The type of service supported for the specified task type. In this case, `elser`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.ElserServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.ElserServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `elser` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.ElserServiceSettings" + } + ] } }, "required": [ @@ -22126,13 +22838,31 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.GoogleAiServiceType" + "description": "The type of service supported for the specified task type. In this case, `googleaistudio`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.GoogleAiServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.GoogleAiStudioServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `googleaistudio` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.GoogleAiStudioServiceSettings" + } + ] } }, "required": [ @@ -22220,16 +22950,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.GoogleVertexAIServiceType" + "description": "The type of service supported for the specified task type. In this case, `googlevertexai`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.GoogleVertexAIServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.GoogleVertexAIServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `googlevertexai` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.GoogleVertexAIServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.GoogleVertexAITaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.GoogleVertexAITaskSettings" + } + ] } }, "required": [ @@ -22322,16 +23075,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.HuggingFaceServiceType" + "description": "The type of service supported for the specified task type. In this case, `hugging_face`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.HuggingFaceServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.HuggingFaceServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `hugging_face` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.HuggingFaceServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.HuggingFaceTaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.HuggingFaceTaskSettings" + } + ] } }, "required": [ @@ -22424,16 +23200,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.JinaAIServiceType" + "description": "The type of service supported for the specified task type. In this case, `jinaai`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.JinaAIServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.JinaAIServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `jinaai` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.JinaAIServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.JinaAITaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.JinaAITaskSettings" + } + ] } }, "required": [ @@ -22526,13 +23325,31 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.LlamaServiceType" + "description": "The type of service supported for the specified task type. In this case, `llama`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.LlamaServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.LlamaServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `llama` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.LlamaServiceSettings" + } + ] } }, "required": [ @@ -22627,13 +23444,31 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.MistralServiceType" + "description": "The type of service supported for the specified task type. In this case, `mistral`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.MistralServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.MistralServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `mistral` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.MistralServiceSettings" + } + ] } }, "required": [ @@ -22720,16 +23555,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.OpenAIServiceType" + "description": "The type of service supported for the specified task type. In this case, `openai`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.OpenAIServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.OpenAIServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `openai` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.OpenAIServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.OpenAITaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.OpenAITaskSettings" + } + ] } }, "required": [ @@ -22822,16 +23680,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.VoyageAIServiceType" + "description": "The type of service supported for the specified task type. In this case, `voyageai`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.VoyageAIServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.VoyageAIServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `voyageai` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.VoyageAIServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.VoyageAITaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.VoyageAITaskSettings" + } + ] } }, "required": [ @@ -22924,10 +23805,20 @@ "type": "object", "properties": { "service": { - "$ref": "#/components/schemas/inference._types.WatsonxServiceType" + "description": "The type of service supported for the specified task type. In this case, `watsonxai`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.WatsonxServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.WatsonxServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `watsonxai` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.WatsonxServiceSettings" + } + ] } }, "required": [ @@ -23021,7 +23912,12 @@ ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.TaskSettings" + "description": "Task settings for the individual inference request.\nThese settings are specific to the task type you specified and override the task settings specified when initializing the service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskSettings" + } + ] } }, "required": [ @@ -23138,7 +24034,12 @@ ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.TaskSettings" + "description": "Optional task settings", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskSettings" + } + ] } }, "required": [ @@ -23235,7 +24136,12 @@ ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.TaskSettings" + "description": "Optional task settings", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskSettings" + } + ] } }, "required": [ @@ -23324,7 +24230,12 @@ ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.TaskSettings" + "description": "Optional task settings", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskSettings" + } + ] } }, "required": [ @@ -23449,19 +24360,38 @@ "type": "object", "properties": { "cluster_name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The responding cluster's name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "cluster_uuid": { - "$ref": "#/components/schemas/_types.Uuid" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Uuid" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The responding node's name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "tagline": { "type": "string" }, "version": { - "$ref": "#/components/schemas/_types.ElasticsearchVersionInfo" + "description": "The running version of Elasticsearch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ElasticsearchVersionInfo" + } + ] } }, "required": [ @@ -23593,10 +24523,20 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The provider-assigned name of the IP geolocation database to download.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "maxmind": { - "$ref": "#/components/schemas/ingest._types.Maxmind" + "description": "The configuration necessary to identify which IP geolocation provider to use to download the database, as well as any provider-specific configuration necessary for such downloading.\nAt present, the only supported provider is maxmind, and the maxmind provider requires that an account_id (string) is configured.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.Maxmind" + } + ] } }, "required": [ @@ -23948,7 +24888,12 @@ "type": "object", "properties": { "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "description": { "description": "Description of the ingest pipeline.", @@ -23969,7 +24914,12 @@ } }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "deprecated": { "description": "Marks this ingest pipeline as deprecated.\nWhen a deprecated ingest pipeline is referenced as the default or final pipeline when creating or updating a non-deprecated index template, Elasticsearch will emit a deprecation warning.", @@ -24098,7 +25048,12 @@ "type": "object", "properties": { "stats": { - "$ref": "#/components/schemas/ingest.geo_ip_stats.GeoIpDownloadStatistics" + "description": "Download statistics for all GeoIP2 databases.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest.geo_ip_stats.GeoIpDownloadStatistics" + } + ] }, "nodes": { "description": "Downloaded GeoIP2 databases for each node.", @@ -24408,7 +25363,11 @@ "type": "object", "properties": { "license": { - "$ref": "#/components/schemas/license.get.LicenseInformation" + "allOf": [ + { + "$ref": "#/components/schemas/license.get.LicenseInformation" + } + ] } }, "required": [ @@ -24699,7 +25658,11 @@ "type": "string" }, "type": { - "$ref": "#/components/schemas/license._types.LicenseType" + "allOf": [ + { + "$ref": "#/components/schemas/license._types.LicenseType" + } + ] }, "acknowledge": { "type": "object", @@ -24800,7 +25763,11 @@ "type": "boolean" }, "type": { - "$ref": "#/components/schemas/license._types.LicenseType" + "allOf": [ + { + "$ref": "#/components/schemas/license._types.LicenseType" + } + ] } }, "required": [ @@ -25259,7 +26226,11 @@ } }, "migration_status": { - "$ref": "#/components/schemas/migration.get_feature_upgrade_status.MigrationStatus" + "allOf": [ + { + "$ref": "#/components/schemas/migration.get_feature_upgrade_status.MigrationStatus" + } + ] } }, "required": [ @@ -25460,7 +26431,13 @@ "type": "boolean" }, "timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Refer to the description for the `timeout` query parameter.", + "default": "30m", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } } } @@ -25588,14 +26565,24 @@ "type": "object", "properties": { "calendar_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "A string that uniquely identifies a calendar.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "description": { "description": "A description of the calendar.", "type": "string" }, "job_ids": { - "$ref": "#/components/schemas/_types.Ids" + "description": "A list of anomaly detection job identifiers or group names.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Ids" + } + ] } }, "required": [ @@ -25795,14 +26782,24 @@ "type": "object", "properties": { "calendar_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "A string that uniquely identifies a calendar.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "description": { "description": "A description of the calendar.", "type": "string" }, "job_ids": { - "$ref": "#/components/schemas/_types.Ids" + "description": "A list of anomaly detection job identifiers or group names.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Ids" + } + ] } }, "required": [ @@ -25862,14 +26859,24 @@ "type": "object", "properties": { "calendar_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "A string that uniquely identifies a calendar.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "description": { "description": "A description of the calendar.", "type": "string" }, "job_ids": { - "$ref": "#/components/schemas/_types.Ids" + "description": "A list of anomaly detection job identifiers or group names.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Ids" + } + ] } }, "required": [ @@ -25966,17 +26973,32 @@ "type": "boolean" }, "analysis": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer" + "description": "The analysis configuration, which contains the information necessary to\nperform one of the following types of analysis: classification, outlier\ndetection, or regression.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer" + } + ] }, "analyzed_fields": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields" + "description": "Specifies `includes` and/or `excludes` patterns to select which fields\nwill be included in the analysis. The patterns specified in `excludes`\nare applied last, therefore `excludes` takes precedence. In other words,\nif the same field is specified in both `includes` and `excludes`, then\nthe field will not be included in the analysis. If `analyzed_fields` is\nnot set, only the relevant fields will be included. For example, all the\nnumeric fields for outlier detection.\nThe supported fields vary for each type of analysis. Outlier detection\nrequires numeric or `boolean` data to analyze. The algorithms don’t\nsupport missing values therefore fields that have data types other than\nnumeric or boolean are ignored. Documents where included fields contain\nmissing values, null values, or an array are also ignored. Therefore the\n`dest` index may contain documents that don’t have an outlier score.\nRegression supports fields that are numeric, `boolean`, `text`,\n`keyword`, and `ip` data types. It is also tolerant of missing values.\nFields that are supported are included in the analysis, other fields are\nignored. Documents where included fields contain an array with two or\nmore values are also ignored. Documents in the `dest` index that don’t\ncontain a results field are not included in the regression analysis.\nClassification supports fields that are numeric, `boolean`, `text`,\n`keyword`, and `ip` data types. It is also tolerant of missing values.\nFields that are supported are included in the analysis, other fields are\nignored. Documents where included fields contain an array with two or\nmore values are also ignored. Documents in the `dest` index that don’t\ncontain a results field are not included in the classification analysis.\nClassification analysis can be improved by mapping ordinal variable\nvalues to a single number. For example, in case of age ranges, you can\nmodel the values as `0-14 = 0`, `15-24 = 1`, `25-34 = 2`, and so on.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields" + } + ] }, "description": { "description": "A description of the job.", "type": "string" }, "dest": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsDestination" + "description": "The destination configuration.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsDestination" + } + ] }, "max_num_threads": { "description": "The maximum number of threads to be used by the analysis. Using more\nthreads may decrease the time necessary to complete the analysis at the\ncost of using more CPU. Note that the process may use additional threads\nfor operational functionality other than the analysis itself.", @@ -25984,7 +27006,11 @@ "type": "number" }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "model_memory_limit": { "description": "The approximate maximum amount of memory resources that are permitted for\nanalytical processing. If your `elasticsearch.yml` file contains an\n`xpack.ml.max_model_memory_limit` setting, an error occurs when you try\nto create data frame analytics jobs that have `model_memory_limit` values\ngreater than that setting.", @@ -25992,13 +27018,28 @@ "type": "string" }, "source": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource" + "description": "The configuration of how to source the analysis data.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource" + } + ] }, "headers": { - "$ref": "#/components/schemas/_types.HttpHeaders" + "x-state": "Generally available; Added in 8.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.HttpHeaders" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "x-state": "Generally available; Added in 7.16.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] } }, "required": [ @@ -26026,43 +27067,79 @@ "type": "object", "properties": { "authorization": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsAuthorization" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsAuthorization" + } + ] }, "allow_lazy_start": { "type": "boolean" }, "analysis": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer" + } + ] }, "analyzed_fields": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields" + } + ] }, "create_time": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "description": { "type": "string" }, "dest": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsDestination" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsDestination" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "max_num_threads": { "type": "number" }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "model_memory_limit": { "type": "string" }, "source": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] } }, "required": [ @@ -26262,35 +27339,81 @@ } }, "chunking_config": { - "$ref": "#/components/schemas/ml._types.ChunkingConfig" + "description": "Datafeeds might be required to search over long time periods, for several months or years.\nThis search is split into time chunks in order to ensure the load on Elasticsearch is managed.\nChunking configuration controls how the size of these time chunks are calculated;\nit is an advanced configuration option.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ChunkingConfig" + } + ] }, "delayed_data_check_config": { - "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig" + "description": "Specifies whether the datafeed checks for missing data and the size of the window.\nThe datafeed can optionally search over indices that have already been read in an effort to determine whether\nany data has subsequently been added to the index. If missing data is found, it is a good indication that the\n`query_delay` is set too low and the data is being indexed after the datafeed has passed that moment in time.\nThis check runs only on real-time datafeeds.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig" + } + ] }, "frequency": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The interval at which scheduled queries are made while the datafeed runs in real time.\nThe default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible\nfraction of the bucket span. When `frequency` is shorter than the bucket span, interim results for the last\n(partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses\naggregations, this value must be divisible by the interval of the date histogram aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "indices": { - "$ref": "#/components/schemas/_types.Indices" + "description": "An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the master\nnodes and the machine learning nodes must have the `remote_cluster_client` role.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "indices_options": { - "$ref": "#/components/schemas/_types.IndicesOptions" + "description": "Specifies index expansion options that are used during search", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndicesOptions" + } + ] }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Identifier for the anomaly detection job.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "max_empty_searches": { "description": "If a real-time datafeed has never seen any data (including during any initial training period), it automatically\nstops and closes the associated job after this many real-time searches return no documents. In other words,\nit stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no\nend time that sees no data remains started until it is explicitly stopped. By default, it is not set.", "type": "number" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an\nElasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this\nobject is passed verbatim to Elasticsearch.", + "default": "{\"match_all\": {\"boost\": 1}}", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "query_delay": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might\nnot be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default\nvalue is randomly selected between `60s` and `120s`. This randomness improves the query performance\nwhen there are multiple jobs running on the same node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "description": "Specifies runtime fields for the datafeed search.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "script_fields": { "description": "Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.\nThe detector configuration objects in a job can contain functions that use these script fields.", @@ -26305,7 +27428,12 @@ "type": "number" }, "headers": { - "$ref": "#/components/schemas/_types.HttpHeaders" + "x-state": "Generally available; Added in 8.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.HttpHeaders" + } + ] } } }, @@ -26334,19 +27462,39 @@ } }, "authorization": { - "$ref": "#/components/schemas/ml._types.DatafeedAuthorization" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DatafeedAuthorization" + } + ] }, "chunking_config": { - "$ref": "#/components/schemas/ml._types.ChunkingConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ChunkingConfig" + } + ] }, "delayed_data_check_config": { - "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig" + } + ] }, "datafeed_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "frequency": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "indices": { "type": "array", @@ -26355,22 +27503,42 @@ } }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "indices_options": { - "$ref": "#/components/schemas/_types.IndicesOptions" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndicesOptions" + } + ] }, "max_empty_searches": { "type": "number" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "query_delay": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "script_fields": { "type": "object", @@ -26623,7 +27791,11 @@ "type": "string" }, "filter_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "items": { "type": "array", @@ -26755,10 +27927,22 @@ "type": "object", "properties": { "duration": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Refer to the description for the `duration` query parameter.", + "default": "1d", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "expires_in": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Refer to the description for the `expires_in` query parameter.", + "default": "14d", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "max_model_memory": { "description": "Refer to the description for the `max_model_memory` query parameter.", @@ -26788,7 +27972,11 @@ "type": "boolean" }, "forecast_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] } }, "required": [ @@ -26980,16 +28168,36 @@ "type": "boolean" }, "analysis_config": { - "$ref": "#/components/schemas/ml._types.AnalysisConfig" + "description": "Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AnalysisConfig" + } + ] }, "analysis_limits": { - "$ref": "#/components/schemas/ml._types.AnalysisLimits" + "description": "Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AnalysisLimits" + } + ] }, "background_persist_interval": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the `background_persist_interval` value too low.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "custom_settings": { - "$ref": "#/components/schemas/ml._types.CustomSettings" + "description": "Advanced configuration option. Contains custom meta data about the job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.CustomSettings" + } + ] }, "daily_model_snapshot_retention_after_days": { "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to `model_snapshot_retention_days`.", @@ -26997,17 +28205,32 @@ "type": "number" }, "data_description": { - "$ref": "#/components/schemas/ml._types.DataDescription" + "description": "Defines the format of the input data when you send data to the job by using the post data API. Note that when configure a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataDescription" + } + ] }, "datafeed_config": { - "$ref": "#/components/schemas/ml._types.DatafeedConfig" + "description": "Defines a datafeed for the anomaly detection job. If Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DatafeedConfig" + } + ] }, "description": { "description": "A description of the job.", "type": "string" }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "groups": { "description": "A list of job groups. A job can belong to no groups or many.", @@ -27017,7 +28240,12 @@ } }, "model_plot_config": { - "$ref": "#/components/schemas/ml._types.ModelPlotConfig" + "description": "This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ModelPlotConfig" + } + ] }, "model_snapshot_retention_days": { "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted.", @@ -27029,7 +28257,13 @@ "type": "number" }, "results_index_name": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "A text string that affects the name of the machine learning results index. By default, the job generates an index named `.ml-anomalies-shared`.", + "default": "shared", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "results_retention_days": { "description": "Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever.", @@ -27063,28 +28297,56 @@ "type": "boolean" }, "analysis_config": { - "$ref": "#/components/schemas/ml._types.AnalysisConfigRead" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AnalysisConfigRead" + } + ] }, "analysis_limits": { - "$ref": "#/components/schemas/ml._types.AnalysisLimits" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AnalysisLimits" + } + ] }, "background_persist_interval": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "create_time": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "custom_settings": { - "$ref": "#/components/schemas/ml._types.CustomSettings" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.CustomSettings" + } + ] }, "daily_model_snapshot_retention_after_days": { "type": "number" }, "data_description": { - "$ref": "#/components/schemas/ml._types.DataDescription" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataDescription" + } + ] }, "datafeed_config": { - "$ref": "#/components/schemas/ml._types.Datafeed" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Datafeed" + } + ] }, "description": { "type": "string" @@ -27096,7 +28358,11 @@ } }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "job_type": { "type": "string" @@ -27105,10 +28371,18 @@ "type": "string" }, "model_plot_config": { - "$ref": "#/components/schemas/ml._types.ModelPlotConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ModelPlotConfig" + } + ] }, "model_snapshot_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "model_snapshot_retention_days": { "type": "number" @@ -27495,24 +28769,45 @@ "type": "string" }, "definition": { - "$ref": "#/components/schemas/ml.put_trained_model.Definition" + "description": "The inference definition for the model. If definition is specified, then\ncompressed_definition cannot be specified.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.Definition" + } + ] }, "description": { "description": "A human-readable description of the inference trained model.", "type": "string" }, "inference_config": { - "$ref": "#/components/schemas/ml._types.InferenceConfigCreateContainer" + "description": "The default configuration for inference. This can be either a regression\nor classification configuration. It must match the underlying\ndefinition.trained_model's target_type. For pre-packaged models such as\nELSER the config is not required.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.InferenceConfigCreateContainer" + } + ] }, "input": { - "$ref": "#/components/schemas/ml.put_trained_model.Input" + "description": "The input field names for the model definition.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.Input" + } + ] }, "metadata": { "description": "An object map that contains metadata about the model.", "type": "object" }, "model_type": { - "$ref": "#/components/schemas/ml._types.TrainedModelType" + "description": "The model type.", + "default": "tree_ensemble", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelType" + } + ] }, "model_size_bytes": { "description": "The estimated memory usage in bytes to keep the trained model in memory.\nThis property is supported only if defer_definition_decompression is true\nor the model definition is not supplied.", @@ -27530,7 +28825,13 @@ } }, "prefix_strings": { - "$ref": "#/components/schemas/ml._types.TrainedModelPrefixStrings" + "description": "Optional prefix strings applied at inference", + "x-state": "Generally available; Added in 8.12.0", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelPrefixStrings" + } + ] } } } @@ -27760,7 +29061,12 @@ "type": "object", "properties": { "analysis_config": { - "$ref": "#/components/schemas/ml._types.AnalysisConfig" + "description": "For a list of the properties that you can specify in the\n`analysis_config` component of the body of this API.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AnalysisConfig" + } + ] }, "max_bucket_cardinality": { "description": "Estimates of the highest cardinality in a single bucket that is observed\nfor influencer fields over the time period that the job analyzes data.\nTo produce a good answer, values must be provided for all influencer\nfields. Providing values for fields that are not listed as `influencers`\nhas no effect on the estimation.", @@ -27838,13 +29144,28 @@ "type": "object", "properties": { "evaluation": { - "$ref": "#/components/schemas/ml._types.DataframeEvaluationContainer" + "description": "Defines the type of evaluation you want to perform.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeEvaluationContainer" + } + ] }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "Defines the `index` in which the evaluation will be performed.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "A query clause that retrieves a subset of data from the source index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } }, "required": [ @@ -27892,13 +29213,28 @@ "type": "object", "properties": { "classification": { - "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummary" + "description": "Evaluation results for a classification analysis.\nIt outputs a prediction that identifies to which of the classes each document belongs.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummary" + } + ] }, "outlier_detection": { - "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeOutlierDetectionSummary" + "description": "Evaluation results for an outlier detection analysis.\nIt outputs the probability that each document is an outlier.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeOutlierDetectionSummary" + } + ] }, "regression": { - "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeRegressionSummary" + "description": "Evaluation results for a regression analysis which outputs a prediction of values.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeRegressionSummary" + } + ] } } }, @@ -28116,20 +29452,40 @@ "type": "object", "properties": { "advance_time": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "Refer to the description for the `advance_time` query parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "calc_interim": { "description": "Refer to the description for the `calc_interim` query parameter.", "type": "boolean" }, "end": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "Refer to the description for the `end` query parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "skip_time": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "Refer to the description for the `skip_time` query parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "start": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "Refer to the description for the `start` query parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] } } }, @@ -29837,7 +31193,12 @@ } }, "inference_config": { - "$ref": "#/components/schemas/ml._types.InferenceConfigUpdateContainer" + "description": "The inference configuration updates to apply on the API call", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.InferenceConfigUpdateContainer" + } + ] } }, "required": [ @@ -29903,16 +31264,28 @@ "type": "object", "properties": { "defaults": { - "$ref": "#/components/schemas/ml.info.Defaults" + "allOf": [ + { + "$ref": "#/components/schemas/ml.info.Defaults" + } + ] }, "limits": { - "$ref": "#/components/schemas/ml.info.Limits" + "allOf": [ + { + "$ref": "#/components/schemas/ml.info.Limits" + } + ] }, "upgrade_mode": { "type": "boolean" }, "native_code": { - "$ref": "#/components/schemas/ml.info.NativeCode" + "allOf": [ + { + "$ref": "#/components/schemas/ml.info.NativeCode" + } + ] } }, "required": [ @@ -29973,7 +31346,13 @@ "type": "object", "properties": { "timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Refer to the description for the `timeout` query parameter.", + "default": "30m", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } } }, @@ -29998,7 +31377,12 @@ "type": "boolean" }, "node": { - "$ref": "#/components/schemas/_types.NodeId" + "description": "The ID of the node that the job was started on. In serverless this will be the \"serverless\".\nIf the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] } }, "required": [ @@ -30088,7 +31472,11 @@ "type": "object", "properties": { "job_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "processed_record_count": { "type": "number" @@ -30121,25 +31509,49 @@ "type": "number" }, "earliest_record_timestamp": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "latest_record_timestamp": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "last_data_time": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "latest_empty_bucket_timestamp": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "latest_sparse_bucket_timestamp": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "input_record_count": { "type": "number" }, "log_time": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] } }, "required": [ @@ -30720,7 +32132,11 @@ "type": "object", "properties": { "model": { - "$ref": "#/components/schemas/ml._types.ModelSnapshot" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ModelSnapshot" + } + ] } }, "required": [ @@ -30834,7 +32250,12 @@ "type": "boolean" }, "node": { - "$ref": "#/components/schemas/_types.NodeId" + "description": "The ID of the node that the job was started on. If the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string.\nThe node ID of the node the job has been assigned to, or\nan empty string if it hasn't been assigned to a node. In\nserverless if the job has been assigned to run then the\nnode ID will be \"serverless\".", + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] } }, "required": [ @@ -30913,13 +32334,29 @@ "type": "object", "properties": { "end": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "Refer to the description for the `end` query parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "start": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "Refer to the description for the `start` query parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Refer to the description for the `timeout` query parameter.", + "default": "20s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } } }, @@ -30941,7 +32378,12 @@ "type": "object", "properties": { "node": { - "$ref": "#/components/schemas/_types.NodeIds" + "description": "The ID of the node that the job was started on. In serverless this will be the \"serverless\".\nIf the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeIds" + } + ] }, "started": { "description": "For a successful response, this value is always `true`. On failure, an exception is returned instead.", @@ -31075,7 +32517,12 @@ "type": "object", "properties": { "adaptive_allocations": { - "$ref": "#/components/schemas/ml._types.AdaptiveAllocationsSettings" + "description": "Adaptive allocations configuration. When enabled, the number of allocations\nis set based on the current load.\nIf adaptive_allocations is enabled, do not set the number of allocations manually.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AdaptiveAllocationsSettings" + } + ] } } } @@ -31091,7 +32538,11 @@ "type": "object", "properties": { "assignment": { - "$ref": "#/components/schemas/ml._types.TrainedModelAssignment" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelAssignment" + } + ] } }, "required": [ @@ -31259,7 +32710,13 @@ "type": "boolean" }, "timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Refer to the description for the `timeout` query parameter.", + "default": "20s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } } }, @@ -31438,16 +32895,28 @@ "type": "object", "properties": { "authorization": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsAuthorization" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsAuthorization" + } + ] }, "allow_lazy_start": { "type": "boolean" }, "analysis": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer" + } + ] }, "analyzed_fields": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields" + } + ] }, "create_time": { "type": "number" @@ -31456,10 +32925,18 @@ "type": "string" }, "dest": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsDestination" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsDestination" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "max_num_threads": { "type": "number" @@ -31468,10 +32945,18 @@ "type": "string" }, "source": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] } }, "required": [ @@ -31574,13 +33059,28 @@ } }, "chunking_config": { - "$ref": "#/components/schemas/ml._types.ChunkingConfig" + "description": "Datafeeds might search over long time periods, for several months or years. This search is split into time\nchunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of\nthese time chunks are calculated; it is an advanced configuration option.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ChunkingConfig" + } + ] }, "delayed_data_check_config": { - "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig" + "description": "Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally\nsearch over indices that have already been read in an effort to determine whether any data has subsequently been\nadded to the index. If missing data is found, it is a good indication that the `query_delay` is set too low and\nthe data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time\ndatafeeds.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig" + } + ] }, "frequency": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The interval at which scheduled queries are made while the datafeed runs in real time. The default value is\neither the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket\nspan. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are\nwritten then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value\nmust be divisible by the interval of the date histogram aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "indices": { "description": "An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine\nlearning nodes must have the `remote_cluster_client` role.", @@ -31590,23 +33090,48 @@ } }, "indices_options": { - "$ref": "#/components/schemas/_types.IndicesOptions" + "description": "Specifies index expansion options that are used during search.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndicesOptions" + } + ] }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "max_empty_searches": { "description": "If a real-time datafeed has never seen any data (including during any initial training period), it automatically\nstops and closes the associated job after this many real-time searches return no documents. In other words,\nit stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no\nend time that sees no data remains started until it is explicitly stopped. By default, it is not set.", "type": "number" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an\nElasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this\nobject is passed verbatim to Elasticsearch. Note that if you change the query, the analyzed data is also\nchanged. Therefore, the time required to learn might be long and the understandability of the results is\nunpredictable. If you want to make significant changes to the source data, it is recommended that you\nclone the job and datafeed and make the amendments in the clone. Let both run in parallel and close one\nwhen you are satisfied with the results of the job.", + "default": "{\"match_all\": {\"boost\": 1}}", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "query_delay": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might\nnot be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default\nvalue is randomly selected between `60s` and `120s`. This randomness improves the query performance\nwhen there are multiple jobs running on the same node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "description": "Specifies runtime fields for the datafeed search.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "script_fields": { "description": "Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.\nThe detector configuration objects in a job can contain functions that use these script fields.", @@ -31641,7 +33166,11 @@ "type": "object", "properties": { "authorization": { - "$ref": "#/components/schemas/ml._types.DatafeedAuthorization" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DatafeedAuthorization" + } + ] }, "aggregations": { "type": "object", @@ -31650,16 +33179,32 @@ } }, "chunking_config": { - "$ref": "#/components/schemas/ml._types.ChunkingConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ChunkingConfig" + } + ] }, "delayed_data_check_config": { - "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig" + } + ] }, "datafeed_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "frequency": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "indices": { "type": "array", @@ -31668,22 +33213,42 @@ } }, "indices_options": { - "$ref": "#/components/schemas/_types.IndicesOptions" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndicesOptions" + } + ] }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "max_empty_searches": { "type": "number" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "query_delay": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "script_fields": { "type": "object", @@ -31787,7 +33352,11 @@ "type": "string" }, "filter_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "items": { "type": "array", @@ -31848,10 +33417,19 @@ "type": "boolean" }, "analysis_limits": { - "$ref": "#/components/schemas/ml._types.AnalysisMemoryLimit" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AnalysisMemoryLimit" + } + ] }, "background_persist_interval": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Advanced configuration option. The time between each periodic persistence\nof the model.\nThe default value is a randomized value between 3 to 4 hours, which\navoids all jobs persisting at exactly the same time. The smallest allowed\nvalue is 1 hour.\nFor very large models (several GB), persistence could take 10-20 minutes,\nso do not set the value too low.\nIf the job is open when you make the update, you must stop the datafeed,\nclose the job, then reopen the job and restart the datafeed for the\nchanges to take effect.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "custom_settings": { "description": "Advanced configuration option. Contains custom meta data about the job.\nFor example, it can contain custom URL information as shown in Adding\ncustom URLs to machine learning results.", @@ -31871,10 +33449,18 @@ "type": "string" }, "model_plot_config": { - "$ref": "#/components/schemas/ml._types.ModelPlotConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ModelPlotConfig" + } + ] }, "model_prune_window": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "daily_model_snapshot_retention_after_days": { "description": "Advanced configuration option, which affects the automatic removal of old\nmodel snapshots for this job. It specifies a period of time (in days)\nafter which only the first snapshot per day is retained. This period is\nrelative to the timestamp of the most recent snapshot for this job. Valid\nvalues range from 0 to `model_snapshot_retention_days`. For jobs created\nbefore version 7.8.0, the default value matches\n`model_snapshot_retention_days`.", @@ -31909,7 +33495,12 @@ } }, "per_partition_categorization": { - "$ref": "#/components/schemas/ml._types.PerPartitionCategorization" + "description": "Settings related to how categorization interacts with partition fields.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.PerPartitionCategorization" + } + ] } } }, @@ -31935,19 +33526,39 @@ "type": "boolean" }, "analysis_config": { - "$ref": "#/components/schemas/ml._types.AnalysisConfigRead" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AnalysisConfigRead" + } + ] }, "analysis_limits": { - "$ref": "#/components/schemas/ml._types.AnalysisLimits" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AnalysisLimits" + } + ] }, "background_persist_interval": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "create_time": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "finished_time": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "custom_settings": { "type": "object", @@ -31959,10 +33570,18 @@ "type": "number" }, "data_description": { - "$ref": "#/components/schemas/ml._types.DataDescription" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataDescription" + } + ] }, "datafeed_config": { - "$ref": "#/components/schemas/ml._types.Datafeed" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Datafeed" + } + ] }, "description": { "type": "string" @@ -31974,19 +33593,35 @@ } }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "job_type": { "type": "string" }, "job_version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "model_plot_config": { - "$ref": "#/components/schemas/ml._types.ModelPlotConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ModelPlotConfig" + } + ] }, "model_snapshot_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "model_snapshot_retention_days": { "type": "number" @@ -31995,7 +33630,11 @@ "type": "number" }, "results_index_name": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "results_retention_days": { "type": "number" @@ -32099,7 +33738,11 @@ "type": "boolean" }, "model": { - "$ref": "#/components/schemas/ml._types.ModelSnapshot" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ModelSnapshot" + } + ] } }, "required": [ @@ -32163,7 +33806,12 @@ "type": "number" }, "adaptive_allocations": { - "$ref": "#/components/schemas/ml._types.AdaptiveAllocationsSettings" + "description": "Adaptive allocations configuration. When enabled, the number of allocations\nis set based on the current load.\nIf adaptive_allocations is enabled, do not set the number of allocations manually.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AdaptiveAllocationsSettings" + } + ] } } }, @@ -32185,7 +33833,11 @@ "type": "object", "properties": { "assignment": { - "$ref": "#/components/schemas/ml._types.TrainedModelAssignment" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelAssignment" + } + ] } }, "required": [ @@ -32266,7 +33918,12 @@ "type": "object", "properties": { "node": { - "$ref": "#/components/schemas/_types.NodeId" + "description": "The ID of the node that the upgrade task was started on if it is still running. In serverless this will be the \"serverless\".", + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] }, "completed": { "description": "When true, this means the task is complete. When false, it is still running.", @@ -33944,7 +35601,12 @@ "type": "object", "properties": { "index_filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Filter indices if the provided query rewrites to `match_none` on every shard.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } } } @@ -33960,10 +35622,19 @@ "type": "object", "properties": { "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "description": "Shards used to create the PIT", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] } }, "required": [ @@ -34180,7 +35851,12 @@ "type": "object", "properties": { "type": { - "$ref": "#/components/schemas/query_rules._types.QueryRuleType" + "description": "The type of rule.", + "allOf": [ + { + "$ref": "#/components/schemas/query_rules._types.QueryRuleType" + } + ] }, "criteria": { "description": "The criteria that must be met for the rule to be applied.\nIf multiple criteria are specified for a rule, all criteria must be met for the rule to be applied.", @@ -34197,7 +35873,12 @@ ] }, "actions": { - "$ref": "#/components/schemas/query_rules._types.QueryRuleActions" + "description": "The actions to take when the rule is matched.\nThe format of this action depends on the rule type.", + "allOf": [ + { + "$ref": "#/components/schemas/query_rules._types.QueryRuleActions" + } + ] }, "priority": { "type": "number" @@ -34228,7 +35909,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -34413,7 +36098,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -34905,23 +36594,44 @@ "type": "object", "properties": { "conflicts": { - "$ref": "#/components/schemas/_types.Conflicts" + "description": "Indicates whether to continue reindexing even when there are conflicts.", + "default": "abort", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Conflicts" + } + ] }, "dest": { - "$ref": "#/components/schemas/_global.reindex.Destination" + "description": "The destination you are copying to.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.reindex.Destination" + } + ] }, "max_docs": { "description": "The maximum number of documents to reindex.\nBy default, all documents are reindexed.\nIf it is a value less then or equal to `scroll_size`, a scroll will not be used to retrieve the results for the operation.\n\nIf `conflicts` is set to `proceed`, the reindex operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query.", "type": "number" }, "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "The script to run to update the document source or metadata when reindexing.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "size": { "type": "number" }, "source": { - "$ref": "#/components/schemas/_global.reindex.Source" + "description": "The source you are copying from.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.reindex.Source" + } + ] } }, "required": [ @@ -35032,7 +36742,12 @@ "type": "number" }, "retries": { - "$ref": "#/components/schemas/_types.Retries" + "description": "The number of retries attempted by reindex.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Retries" + } + ] }, "requests_per_second": { "description": "The number of requests per second effectively run during the reindex.", @@ -35042,20 +36757,39 @@ "type": "number" }, "task": { - "$ref": "#/components/schemas/_types.TaskId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TaskId" + } + ] }, "throttled_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The number of milliseconds the request slept to conform to `requests_per_second`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "throttled_until_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "This field should always be equal to zero in a reindex response.\nIt has meaning only when using the task API, where it indicates the next time (in milliseconds since epoch) that a throttled request will be run again in order to conform to `requests_per_second`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "timed_out": { "description": "If any of the requests that ran during the reindex timed out, it is `true`.", "type": "boolean" }, "took": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The total milliseconds the entire operation took.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "total": { "description": "The number of documents that were successfully processed.", @@ -35311,7 +37045,12 @@ "type": "string" }, "groups": { - "$ref": "#/components/schemas/rollup._types.Groupings" + "description": "Defines the grouping fields and aggregations that are defined for this rollup job. These fields will then be\navailable later for aggregating into buckets. These aggs and fields can be used in any combination. Think of\nthe groups configuration as defining a set of tools that can later be used in aggregations to partition the\ndata. Unlike raw data, we have to think ahead to which fields and aggregations might be used. Rollups provide\nenough flexibility that you simply need to determine which fields are needed, not in what order they are needed.", + "allOf": [ + { + "$ref": "#/components/schemas/rollup._types.Groupings" + } + ] }, "index_pattern": { "description": "The index or index pattern to roll up. Supports wildcard-style patterns (`logstash-*`). The job attempts to\nrollup the entire index or index-pattern.", @@ -35329,13 +37068,28 @@ "type": "number" }, "rollup_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The index that contains the rollup results. The index can be shared with other rollup jobs. The data is stored so that it doesn’t interfere with unrelated jobs.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Time to wait for the request to complete.", + "default": "20s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "headers": { - "$ref": "#/components/schemas/_types.HttpHeaders" + "allOf": [ + { + "$ref": "#/components/schemas/_types.HttpHeaders" + } + ] } }, "required": [ @@ -36582,7 +38336,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -37896,10 +39654,20 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The name of the index contained in the snapshot whose data is to be mounted.\nIf no `renamed_index` is specified, this name will also be used to create the new index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "renamed_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The name of the index that will be created.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "index_settings": { "description": "The settings that should be added to the index when it is mounted.", @@ -37939,7 +39707,11 @@ "type": "object", "properties": { "snapshot": { - "$ref": "#/components/schemas/searchable_snapshots.mount.MountedSnapshot" + "allOf": [ + { + "$ref": "#/components/schemas/searchable_snapshots.mount.MountedSnapshot" + } + ] } }, "required": [ @@ -38035,7 +39807,12 @@ "type": "string" }, "grant_type": { - "$ref": "#/components/schemas/security._types.GrantType" + "description": "The type of grant.", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.GrantType" + } + ] }, "password": { "description": "The user's password.\nIf you specify the `password` grant type, this parameter is required.\nIt is not valid with other grant types.", @@ -38104,10 +39881,18 @@ "type": "object", "properties": { "api_key": { - "$ref": "#/components/schemas/security.authenticate.AuthenticateApiKey" + "allOf": [ + { + "$ref": "#/components/schemas/security.authenticate.AuthenticateApiKey" + } + ] }, "authentication_realm": { - "$ref": "#/components/schemas/security._types.RealmInfo" + "allOf": [ + { + "$ref": "#/components/schemas/security._types.RealmInfo" + } + ] }, "email": { "oneOf": [ @@ -38132,10 +39917,18 @@ ] }, "lookup_realm": { - "$ref": "#/components/schemas/security._types.RealmInfo" + "allOf": [ + { + "$ref": "#/components/schemas/security._types.RealmInfo" + } + ] }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "roles": { "type": "array", @@ -38144,7 +39937,11 @@ } }, "username": { - "$ref": "#/components/schemas/_types.Username" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Username" + } + ] }, "enabled": { "type": "boolean" @@ -38153,7 +39950,12 @@ "type": "string" }, "token": { - "$ref": "#/components/schemas/security.authenticate.Token" + "x-state": "Generally available; Added in 7.14.0", + "allOf": [ + { + "$ref": "#/components/schemas/security.authenticate.Token" + } + ] } }, "required": [ @@ -38294,7 +40096,12 @@ } }, "errors": { - "$ref": "#/components/schemas/security._types.BulkError" + "description": "Present if any updates resulted in errors", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.BulkError" + } + ] } } }, @@ -38393,7 +40200,12 @@ } }, "errors": { - "$ref": "#/components/schemas/security._types.BulkError" + "description": "Present if any deletes resulted in errors", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.BulkError" + } + ] } } }, @@ -38442,7 +40254,12 @@ "type": "object", "properties": { "expiration": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Expiration time for the API keys.\nBy default, API keys never expire.\nThis property can be omitted to leave the value unchanged.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "ids": { "description": "The API key identifiers.", @@ -38459,7 +40276,12 @@ ] }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Arbitrary nested metadata to associate with the API keys.\nWithin the `metadata` object, top-level keys beginning with an underscore (`_`) are reserved for system usage.\nAny information specified with this parameter fully replaces metadata previously associated with the API key.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "role_descriptors": { "description": "The role descriptors to assign to the API keys.\nAn API key's effective permissions are an intersection of its assigned privileges and the point-in-time snapshot of permissions of the owner user.\nYou can assign new privileges by specifying them in this parameter.\nTo remove assigned privileges, supply the `role_descriptors` parameter as an empty object `{}`.\nIf an API key has no assigned privileges, it inherits the owner user's full permissions.\nThe snapshot of the owner's permissions is always updated, whether you supply the `role_descriptors` parameter.\nThe structure of a role descriptor is the same as the request for the create API keys API.", @@ -38496,7 +40318,11 @@ "type": "object", "properties": { "errors": { - "$ref": "#/components/schemas/security._types.BulkError" + "allOf": [ + { + "$ref": "#/components/schemas/security._types.BulkError" + } + ] }, "noops": { "type": "array", @@ -38687,10 +40513,18 @@ "type": "object", "properties": { "_nodes": { - "$ref": "#/components/schemas/_types.NodeStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeStatistics" + } + ] }, "cluster_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "nodes": { "type": "object", @@ -38748,10 +40582,18 @@ "type": "object", "properties": { "_nodes": { - "$ref": "#/components/schemas/_types.NodeStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeStatistics" + } + ] }, "cluster_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "nodes": { "type": "object", @@ -38826,10 +40668,18 @@ "type": "object", "properties": { "_nodes": { - "$ref": "#/components/schemas/_types.NodeStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeStatistics" + } + ] }, "cluster_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "nodes": { "type": "object", @@ -38887,10 +40737,18 @@ "type": "object", "properties": { "_nodes": { - "$ref": "#/components/schemas/_types.NodeStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeStatistics" + } + ] }, "cluster_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "nodes": { "type": "object", @@ -38974,10 +40832,18 @@ "type": "object", "properties": { "_nodes": { - "$ref": "#/components/schemas/_types.NodeStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeStatistics" + } + ] }, "cluster_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "nodes": { "type": "object", @@ -39219,7 +41085,11 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "ids": { "description": "A list of API key ids.\nThis parameter cannot be used with any of `name`, `realm_name`, or `username`.", @@ -39229,7 +41099,12 @@ } }, "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "An API key name.\nThis parameter cannot be used with any of `ids`, `realm_name` or `username`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "owner": { "description": "Query API keys owned by the currently authenticated user.\nThe `realm_name` or `username` parameters cannot be specified when this parameter is set to `true` as they are assumed to be the currently authenticated ones.\n\nNOTE: At least one of `ids`, `name`, `username`, and `realm_name` must be specified if `owner` is `false`.", @@ -39241,7 +41116,12 @@ "type": "string" }, "username": { - "$ref": "#/components/schemas/_types.Username" + "description": "The username of a user.\nThis parameter cannot be used with either `ids` or `name` or when `owner` flag is set to `true`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Username" + } + ] } } }, @@ -39359,16 +41239,36 @@ "type": "object", "properties": { "access": { - "$ref": "#/components/schemas/security._types.Access" + "description": "The access to be granted to this API key.\nThe access is composed of permissions for cross-cluster search and cross-cluster replication.\nAt least one of them must be specified.\n\nNOTE: No explicit privileges should be specified for either search or replication access.\nThe creation process automatically converts the access specification to a role descriptor which has relevant privileges assigned accordingly.", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.Access" + } + ] }, "expiration": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Expiration time for the API key.\nBy default, API keys never expire.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Arbitrary metadata that you want to associate with the API key.\nIt supports nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "Specifies the name for this API key.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] } }, "required": [ @@ -39399,13 +41299,28 @@ "type": "string" }, "expiration": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "Expiration in milliseconds for the API key.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Unique ID for this API key.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "Specifies the name for this API key.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "encoded": { "description": "API key credentials which is the base64-encoding of\nthe UTF-8 representation of `id` and `api_key` joined\nby a colon (`:`).", @@ -39705,7 +41620,11 @@ "type": "string" }, "authentication": { - "$ref": "#/components/schemas/security.delegate_pki.Authentication" + "allOf": [ + { + "$ref": "#/components/schemas/security.delegate_pki.Authentication" + } + ] } }, "required": [ @@ -40582,7 +42501,11 @@ "type": "object", "properties": { "token": { - "$ref": "#/components/schemas/security.enroll_kibana.Token" + "allOf": [ + { + "$ref": "#/components/schemas/security.enroll_kibana.Token" + } + ] }, "http_ca": { "description": "The CA certificate used to sign the node certificates that Elasticsearch uses for TLS on the HTTP layer.\nThe certificate is returned as a Base64 encoded string of the ASN.1 DER encoding of the certificate.", @@ -41048,7 +42971,12 @@ } }, "nodes_credentials": { - "$ref": "#/components/schemas/security.get_service_credentials.NodesCredentials" + "description": "Service account credentials collected from all nodes of the cluster.", + "allOf": [ + { + "$ref": "#/components/schemas/security.get_service_credentials.NodesCredentials" + } + ] } }, "required": [ @@ -41106,13 +43034,28 @@ "type": "object", "properties": { "security": { - "$ref": "#/components/schemas/security._types.SecuritySettings" + "description": "Settings for the index used for most security configuration, including native realm users and roles configured with the API.", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.SecuritySettings" + } + ] }, "security-profile": { - "$ref": "#/components/schemas/security._types.SecuritySettings" + "description": "Settings for the index used to store profile information.", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.SecuritySettings" + } + ] }, "security-tokens": { - "$ref": "#/components/schemas/security._types.SecuritySettings" + "description": "Settings for the index used to store tokens.", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.SecuritySettings" + } + ] } }, "required": [ @@ -41169,13 +43112,28 @@ "type": "object", "properties": { "security": { - "$ref": "#/components/schemas/security._types.SecuritySettings" + "description": "Settings for the index used for most security configuration, including native realm users and roles configured with the API.", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.SecuritySettings" + } + ] }, "security-profile": { - "$ref": "#/components/schemas/security._types.SecuritySettings" + "description": "Settings for the index used to store profile information.", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.SecuritySettings" + } + ] }, "security-tokens": { - "$ref": "#/components/schemas/security._types.SecuritySettings" + "description": "Settings for the index used to store tokens.", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.SecuritySettings" + } + ] } } }, @@ -41237,14 +43195,24 @@ "type": "object", "properties": { "grant_type": { - "$ref": "#/components/schemas/security.get_token.AccessTokenGrantType" + "description": "The type of grant.\nSupported grant types are: `password`, `_kerberos`, `client_credentials`, and `refresh_token`.", + "allOf": [ + { + "$ref": "#/components/schemas/security.get_token.AccessTokenGrantType" + } + ] }, "scope": { "description": "The scope of the token.\nCurrently tokens are only issued for a scope of FULL regardless of the value sent with the request.", "type": "string" }, "password": { - "$ref": "#/components/schemas/_types.Password" + "description": "The user's password.\nIf you specify the `password` grant type, this parameter is required.\nThis parameter is not valid with any other supported grant type.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Password" + } + ] }, "kerberos_ticket": { "description": "The base64 encoded kerberos ticket.\nIf you specify the `_kerberos` grant type, this parameter is required.\nThis parameter is not valid with any other supported grant type.", @@ -41255,7 +43223,12 @@ "type": "string" }, "username": { - "$ref": "#/components/schemas/_types.Username" + "description": "The username that identifies the user.\nIf you specify the `password` grant type, this parameter is required.\nThis parameter is not valid with any other supported grant type.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Username" + } + ] } } }, @@ -41302,7 +43275,11 @@ "type": "string" }, "authentication": { - "$ref": "#/components/schemas/security.get_token.AuthenticatedUser" + "allOf": [ + { + "$ref": "#/components/schemas/security.get_token.AuthenticatedUser" + } + ] } }, "required": [ @@ -41358,10 +43335,20 @@ "type": "string" }, "realm_name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The name of an authentication realm.\nThis parameter cannot be used with either `refresh_token` or `token`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "username": { - "$ref": "#/components/schemas/_types.Username" + "description": "The username of a user.\nThis parameter cannot be used with either `refresh_token` or `token`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Username" + } + ] } } }, @@ -41629,7 +43616,11 @@ } }, "errors": { - "$ref": "#/components/schemas/security.get_user_profile.GetUserProfileErrors" + "allOf": [ + { + "$ref": "#/components/schemas/security.get_user_profile.GetUserProfileErrors" + } + ] } }, "required": [ @@ -41693,23 +43684,48 @@ "type": "object", "properties": { "api_key": { - "$ref": "#/components/schemas/security.grant_api_key.GrantApiKey" + "description": "The API key.", + "allOf": [ + { + "$ref": "#/components/schemas/security.grant_api_key.GrantApiKey" + } + ] }, "grant_type": { - "$ref": "#/components/schemas/security.grant_api_key.ApiKeyGrantType" + "description": "The type of grant. Supported grant types are: `access_token`, `password`.", + "allOf": [ + { + "$ref": "#/components/schemas/security.grant_api_key.ApiKeyGrantType" + } + ] }, "access_token": { "description": "The user's access token.\nIf you specify the `access_token` grant type, this parameter is required.\nIt is not valid with other grant types.", "type": "string" }, "username": { - "$ref": "#/components/schemas/_types.Username" + "description": "The user name that identifies the user.\nIf you specify the `password` grant type, this parameter is required.\nIt is not valid with other grant types.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Username" + } + ] }, "password": { - "$ref": "#/components/schemas/_types.Password" + "description": "The user's password.\nIf you specify the `password` grant type, this parameter is required.\nIt is not valid with other grant types.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Password" + } + ] }, "run_as": { - "$ref": "#/components/schemas/_types.Username" + "description": "The name of the user to be impersonated.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Username" + } + ] } }, "required": [ @@ -41745,13 +43761,25 @@ "type": "string" }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "expiration": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "encoded": { "type": "string" @@ -42438,7 +44466,12 @@ "type": "string" }, "ids": { - "$ref": "#/components/schemas/_types.Ids" + "description": "A JSON array with all the valid SAML Request Ids that the caller of the API has for the current user.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Ids" + } + ] }, "realm": { "description": "The name of the realm that should authenticate the SAML response. Useful in cases where many SAML realms are defined.", @@ -42539,7 +44572,12 @@ "type": "string" }, "ids": { - "$ref": "#/components/schemas/_types.Ids" + "description": "A JSON array with all the valid SAML Request Ids that the caller of the API has for the current user.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Ids" + } + ] }, "query_string": { "description": "If the SAML IdP sends the logout response with the HTTP-Redirect binding, this field must be set to the query string of the redirect URI.", @@ -42813,7 +44851,12 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "A unique identifier for the SAML Request to be stored by the caller of the API.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "realm": { "description": "The name of the Elasticsearch realm that was used to construct the authentication request.", @@ -42999,10 +45042,20 @@ } }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Arbitrary metadata that you want to associate with the API key.\nIt supports a nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.\nWhen specified, this value fully replaces the metadata previously associated with the API key.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "expiration": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The expiration time for the API key.\nBy default, API keys never expire.\nThis property can be omitted to leave the expiration unchanged.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } } }, @@ -43090,13 +45143,28 @@ "type": "object", "properties": { "access": { - "$ref": "#/components/schemas/security._types.Access" + "description": "The access to be granted to this API key.\nThe access is composed of permissions for cross cluster search and cross cluster replication.\nAt least one of them must be specified.\nWhen specified, the new access assignment fully replaces the previously assigned access.", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.Access" + } + ] }, "expiration": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The expiration time for the API key.\nBy default, API keys never expire. This property can be omitted to leave the value unchanged.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Arbitrary metadata that you want to associate with the API key.\nIt supports nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.\nWhen specified, this information fully replaces metadata previously associated with the API key.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] } }, "required": [ @@ -43301,7 +45369,12 @@ "type": "object", "properties": { "type": { - "$ref": "#/components/schemas/shutdown._types.Type" + "description": "Valid values are restart, remove, or replace.\nUse restart when you need to temporarily shut down a node to perform an upgrade, make configuration changes, or perform other maintenance.\nBecause the node is expected to rejoin the cluster, data is not migrated off of the node.\nUse remove when you need to permanently remove a node from the cluster.\nThe node is not marked ready for shutdown until data is migrated off of the node Use replace to do a 1:1 replacement of a node with another node.\nCertain allocation decisions will be ignored (such as disk watermarks) in the interest of true replacement of the source node with the target node.\nDuring a replace-type shutdown, rollover and index creation may result in unassigned shards, and shrink may fail until the replacement is complete.", + "allOf": [ + { + "$ref": "#/components/schemas/shutdown._types.Type" + } + ] }, "reason": { "description": "A human-readable reason that the node is being shut down.\nThis field provides information for other cluster operators; it does not affect the shut down process.", @@ -43646,20 +45719,40 @@ "type": "object", "properties": { "config": { - "$ref": "#/components/schemas/slm._types.Configuration" + "description": "Configuration for each snapshot created by the policy.", + "allOf": [ + { + "$ref": "#/components/schemas/slm._types.Configuration" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "Name automatically assigned to each snapshot created by the policy. Date math is supported. To prevent conflicting snapshot names, a UUID is automatically appended to each snapshot name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "repository": { "description": "Repository used to store snapshots created by this policy. This repository must exist prior to the policy’s creation. You can create a repository using the snapshot repository API.", "type": "string" }, "retention": { - "$ref": "#/components/schemas/slm._types.Retention" + "description": "Retention rules used to retain and delete snapshots created by the policy.", + "allOf": [ + { + "$ref": "#/components/schemas/slm._types.Retention" + } + ] }, "schedule": { - "$ref": "#/components/schemas/watcher._types.CronExpression" + "description": "Periodic or absolute schedule at which the policy creates snapshots. SLM applies schedule changes immediately.", + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.CronExpression" + } + ] } } }, @@ -43809,7 +45902,11 @@ "type": "object", "properties": { "snapshot_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] } }, "required": [ @@ -43955,10 +46052,18 @@ "type": "object", "properties": { "retention_deletion_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "retention_deletion_time_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "retention_failed": { "type": "number" @@ -44059,7 +46164,11 @@ "type": "object", "properties": { "operation_mode": { - "$ref": "#/components/schemas/_types.LifecycleOperationMode" + "allOf": [ + { + "$ref": "#/components/schemas/_types.LifecycleOperationMode" + } + ] } }, "required": [ @@ -44247,7 +46356,12 @@ "type": "object", "properties": { "results": { - "$ref": "#/components/schemas/snapshot.cleanup_repository.CleanupRepositoryResults" + "description": "Statistics for cleanup operations.", + "allOf": [ + { + "$ref": "#/components/schemas/snapshot.cleanup_repository.CleanupRepositoryResults" + } + ] } }, "required": [ @@ -45149,16 +47263,36 @@ "type": "number" }, "coordinating_node": { - "$ref": "#/components/schemas/snapshot.repository_analyze.SnapshotNodeInfo" + "description": "The node that coordinated the analysis and performed the final cleanup.", + "allOf": [ + { + "$ref": "#/components/schemas/snapshot.repository_analyze.SnapshotNodeInfo" + } + ] }, "delete_elapsed": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The time it took to delete all the blobs in the container.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "delete_elapsed_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "description": "The time it took to delete all the blobs in the container, in nanoseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "details": { - "$ref": "#/components/schemas/snapshot.repository_analyze.DetailsInfo" + "description": "A description of every read and write operation performed during the test.", + "allOf": [ + { + "$ref": "#/components/schemas/snapshot.repository_analyze.DetailsInfo" + } + ] }, "early_read_node_count": { "description": "The limit on the number of nodes on which early read operations were performed after writing each blob.", @@ -45172,20 +47306,40 @@ } }, "listing_elapsed": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The time it took to retrieve a list of all the blobs in the container.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "listing_elapsed_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "description": "The time it took to retrieve a list of all the blobs in the container, in nanoseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "max_blob_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The limit on the size of a blob written during the test.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "max_blob_size_bytes": { "description": "The limit, in bytes, on the size of a blob written during the test.", "type": "number" }, "max_total_data_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The limit on the total size of all blob written during the test.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "max_total_data_size_bytes": { "description": "The limit, in bytes, on the total size of all blob written during the test.", @@ -45208,7 +47362,12 @@ "type": "number" }, "summary": { - "$ref": "#/components/schemas/snapshot.repository_analyze.SummaryInfo" + "description": "A collection of statistics that summarize the results of the test.", + "allOf": [ + { + "$ref": "#/components/schemas/snapshot.repository_analyze.SummaryInfo" + } + ] } }, "required": [ @@ -45464,10 +47623,20 @@ "type": "boolean" }, "index_settings": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "description": "Index settings to add or change in restored indices, including backing indices.\nYou can't use this option to change `index.number_of_shards`.\n\nFor data streams, this option applies only to restored backing indices.\nNew backing indices are configured using the data stream's matching index template.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] }, "indices": { - "$ref": "#/components/schemas/_types.Indices" + "description": "A comma-separated list of indices and data streams to restore.\nIt supports a multi-target syntax.\nThe default behavior is all regular indices and regular data streams in the snapshot.\n\nYou can't use this parameter to restore system indices or system data streams.\nUse `feature_states` instead.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "partial": { "description": "If `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available.\n\nIf true, it allows restoring a partial snapshot of indices with unavailable shards.\nOnly shards that were successfully included in the snapshot will be restored.\nAll missing shards will be recreated as empty.", @@ -45514,7 +47683,11 @@ "type": "boolean" }, "snapshot": { - "$ref": "#/components/schemas/snapshot.restore.SnapshotRestore" + "allOf": [ + { + "$ref": "#/components/schemas/snapshot.restore.SnapshotRestore" + } + ] } } } @@ -45881,7 +48054,12 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Identifier for the search.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-ID` HTTP header.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "is_running": { "description": "If `true`, the search is still running.\nIf `false`, the search has finished.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header.", @@ -45960,7 +48138,12 @@ "type": "object", "properties": { "expiration_time_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The timestamp, in milliseconds since the Unix epoch, when Elasticsearch will delete the search and its results, even if the search is still running.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "id": { "description": "The identifier for the search.", @@ -45975,10 +48158,20 @@ "type": "boolean" }, "start_time_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The timestamp, in milliseconds since the Unix epoch, when the search started.\nThe API returns this property only for running searches.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "completion_status": { - "$ref": "#/components/schemas/_types.uint" + "description": "The HTTP status code for the search.\nThe API returns this property only for completed searches.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] } }, "required": [ @@ -46307,10 +48500,20 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "description": "The update operation result.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] }, "reload_analyzers_details": { - "$ref": "#/components/schemas/indices.reload_search_analyzers.ReloadResult" + "description": "Updating a synonyms set can reload the associated analyzers in case refresh is set to true.\nThis information is the analyzers reloading result.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.reload_search_analyzers.ReloadResult" + } + ] } }, "required": [ @@ -46477,7 +48680,15 @@ "type": "object", "properties": { "synonyms": { - "$ref": "#/components/schemas/synonyms._types.SynonymString" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/text-analysis/analysis-synonym-graph-tokenfilter#analysis-synonym-graph-define-synonyms" + }, + "description": "The synonym rule information definition, which must be in Solr format.", + "allOf": [ + { + "$ref": "#/components/schemas/synonyms._types.SynonymString" + } + ] } }, "required": [ @@ -46792,13 +49003,21 @@ "type": "boolean" }, "task": { - "$ref": "#/components/schemas/tasks._types.TaskInfo" + "allOf": [ + { + "$ref": "#/components/schemas/tasks._types.TaskInfo" + } + ] }, "response": { "type": "object" }, "error": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] } }, "required": [ @@ -47440,7 +49659,11 @@ "type": "string" }, "ecs_compatibility": { - "$ref": "#/components/schemas/text_structure._types.EcsCompatibilityType" + "allOf": [ + { + "$ref": "#/components/schemas/text_structure._types.EcsCompatibilityType" + } + ] }, "field_stats": { "type": "object", @@ -47449,10 +49672,18 @@ } }, "format": { - "$ref": "#/components/schemas/text_structure._types.FormatType" + "allOf": [ + { + "$ref": "#/components/schemas/text_structure._types.FormatType" + } + ] }, "grok_pattern": { - "$ref": "#/components/schemas/_types.GrokPattern" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GrokPattern" + } + ] }, "java_timestamp_formats": { "type": "array", @@ -47467,10 +49698,18 @@ } }, "ingest_pipeline": { - "$ref": "#/components/schemas/ingest._types.PipelineConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.PipelineConfig" + } + ] }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "multiline_start_pattern": { "type": "string" @@ -47488,7 +49727,11 @@ "type": "string" }, "timestamp_field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -47862,7 +50105,12 @@ "type": "number" }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "description": "Some suitable mappings for an index into which the data could be ingested.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "quote": { "type": "string" @@ -47892,7 +50140,11 @@ } }, "grok_pattern": { - "$ref": "#/components/schemas/_types.GrokPattern" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GrokPattern" + } + ] }, "multiline_start_pattern": { "type": "string" @@ -47915,13 +50167,22 @@ } }, "timestamp_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field considered most likely to be the primary timestamp of each document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "should_trim_fields": { "type": "boolean" }, "ingest_pipeline": { - "$ref": "#/components/schemas/ingest._types.PipelineConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.PipelineConfig" + } + ] } }, "required": [ @@ -48107,35 +50368,81 @@ "type": "object", "properties": { "dest": { - "$ref": "#/components/schemas/transform._types.Destination" + "description": "The destination for the transform.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Destination" + } + ] }, "description": { "description": "Free text description of the transform.", "type": "string" }, "frequency": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The interval between checks for changes in the source indices when the transform is running continuously. Also\ndetermines the retry interval in the event of transient failures while the transform is searching or indexing.\nThe minimum value is `1s` and the maximum is `1h`.", + "default": "1m", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "latest": { - "$ref": "#/components/schemas/transform._types.Latest" + "description": "The latest method transforms the data by finding the latest document for each unique key.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Latest" + } + ] }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Defines optional transform metadata.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "pivot": { - "$ref": "#/components/schemas/transform._types.Pivot" + "description": "The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields\nand the aggregation to reduce the data.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Pivot" + } + ] }, "retention_policy": { - "$ref": "#/components/schemas/transform._types.RetentionPolicyContainer" + "description": "Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the\ndestination index.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.RetentionPolicyContainer" + } + ] }, "settings": { - "$ref": "#/components/schemas/transform._types.Settings" + "description": "Defines optional transform settings.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Settings" + } + ] }, "source": { - "$ref": "#/components/schemas/transform._types.Source" + "description": "The source of the data for the transform.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Source" + } + ] }, "sync": { - "$ref": "#/components/schemas/transform._types.SyncContainer" + "description": "Defines the properties transforms require to run continuously.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.SyncContainer" + } + ] } }, "required": [ @@ -48863,26 +51170,57 @@ "type": "object", "properties": { "dest": { - "$ref": "#/components/schemas/transform._types.Destination" + "description": "The destination for the transform.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Destination" + } + ] }, "description": { "description": "Free text description of the transform.", "type": "string" }, "frequency": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is 1s and the maximum is 1h.", + "default": "1m", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Defines optional transform metadata.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "source": { - "$ref": "#/components/schemas/transform._types.Source" + "description": "The source of the data for the transform.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Source" + } + ] }, "settings": { - "$ref": "#/components/schemas/transform._types.Settings" + "description": "Defines optional transform settings.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Settings" + } + ] }, "sync": { - "$ref": "#/components/schemas/transform._types.SyncContainer" + "description": "Defines the properties transforms require to run continuously.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.SyncContainer" + } + ] }, "retention_policy": { "description": "Defines a retention policy for the transform. Data that meets the defined\ncriteria is deleted from the destination index.", @@ -48917,7 +51255,11 @@ "type": "object", "properties": { "authorization": { - "$ref": "#/components/schemas/ml._types.TransformAuthorization" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TransformAuthorization" + } + ] }, "create_time": { "type": "number" @@ -48926,37 +51268,81 @@ "type": "string" }, "dest": { - "$ref": "#/components/schemas/_global.reindex.Destination" + "allOf": [ + { + "$ref": "#/components/schemas/_global.reindex.Destination" + } + ] }, "frequency": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "latest": { - "$ref": "#/components/schemas/transform._types.Latest" + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Latest" + } + ] }, "pivot": { - "$ref": "#/components/schemas/transform._types.Pivot" + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Pivot" + } + ] }, "retention_policy": { - "$ref": "#/components/schemas/transform._types.RetentionPolicyContainer" + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.RetentionPolicyContainer" + } + ] }, "settings": { - "$ref": "#/components/schemas/transform._types.Settings" + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Settings" + } + ] }, "source": { - "$ref": "#/components/schemas/_global.reindex.Source" + "allOf": [ + { + "$ref": "#/components/schemas/_global.reindex.Source" + } + ] }, "sync": { - "$ref": "#/components/schemas/transform._types.SyncContainer" + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.SyncContainer" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] } }, "required": [ @@ -49251,7 +51637,12 @@ "type": "boolean" }, "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "The script to run to update the document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "scripted_upsert": { "description": "If `true`, run the script whether or not the document exists.", @@ -49259,7 +51650,13 @@ "type": "boolean" }, "_source": { - "$ref": "#/components/schemas/_global.search._types.SourceConfig" + "description": "If `false`, turn off source retrieval.\nYou can also specify a comma-separated list of the fields you want to retrieve.", + "default": "true", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.SourceConfig" + } + ] }, "upsert": { "description": "If the document does not already exist, the contents of 'upsert' are inserted as a new document.\nIf the document exists, the 'script' is run.", @@ -49708,16 +52105,37 @@ "type": "number" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "The documents to update using the Query DSL.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "The script to run to update the document source or metadata when updating.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "slice": { - "$ref": "#/components/schemas/_types.SlicedScroll" + "description": "Slice the request manually using the provided slice ID and total number of slices.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SlicedScroll" + } + ] }, "conflicts": { - "$ref": "#/components/schemas/_types.Conflicts" + "description": "The preferred behavior when update by query hits version conflicts: `abort` or `proceed`.", + "default": "abort", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Conflicts" + } + ] } } }, @@ -49778,17 +52196,31 @@ "type": "number" }, "retries": { - "$ref": "#/components/schemas/_types.Retries" + "description": "The number of retries attempted by update by query.\n`bulk` is the number of bulk actions retried.\n`search` is the number of search actions retried.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Retries" + } + ] }, "task": { - "$ref": "#/components/schemas/_types.TaskId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TaskId" + } + ] }, "timed_out": { "description": "If true, some requests timed out during the update by query.", "type": "boolean" }, "took": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The number of milliseconds from start to end of the whole operation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "total": { "description": "The number of documents that were successfully processed.", @@ -49803,16 +52235,34 @@ "type": "number" }, "throttled": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "throttled_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The number of milliseconds the request slept to conform to `requests_per_second`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "throttled_until": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "throttled_until_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "This field should always be equal to zero in an _update_by_query response.\nIt only has meaning when using the task API, where it indicates the next time (in milliseconds since epoch) a throttled request will be run again in order to conform to `requests_per_second`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } } } @@ -50171,22 +52621,42 @@ "type": "boolean" }, "_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "status": { - "$ref": "#/components/schemas/watcher._types.WatchStatus" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.WatchStatus" + } + ] }, "watch": { - "$ref": "#/components/schemas/watcher._types.Watch" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.Watch" + } + ] }, "_primary_term": { "type": "number" }, "_seq_no": { - "$ref": "#/components/schemas/_types.SequenceNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SequenceNumber" + } + ] }, "_version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] } }, "required": [ @@ -50324,10 +52794,18 @@ "type": "boolean" }, "_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] } }, "required": [ @@ -50522,7 +53000,11 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] } }, "required": [ @@ -50885,13 +53367,25 @@ "type": "object", "properties": { "build": { - "$ref": "#/components/schemas/xpack.info.BuildInformation" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.BuildInformation" + } + ] }, "features": { - "$ref": "#/components/schemas/xpack.info.Features" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Features" + } + ] }, "license": { - "$ref": "#/components/schemas/xpack.info.MinimalLicenseInformation" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.MinimalLicenseInformation" + } + ] }, "tagline": { "type": "string" @@ -50952,88 +53446,201 @@ "type": "object", "properties": { "aggregate_metric": { - "$ref": "#/components/schemas/xpack.usage.Base" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Base" + } + ] }, "analytics": { - "$ref": "#/components/schemas/xpack.usage.Analytics" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Analytics" + } + ] }, "archive": { - "$ref": "#/components/schemas/xpack.usage.Archive" + "x-state": "Generally available; Added in 8.2.0", + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Archive" + } + ] }, "watcher": { - "$ref": "#/components/schemas/xpack.usage.Watcher" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Watcher" + } + ] }, "ccr": { - "$ref": "#/components/schemas/xpack.usage.Ccr" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Ccr" + } + ] }, "data_frame": { - "$ref": "#/components/schemas/xpack.usage.Base" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Base" + } + ] }, "data_science": { - "$ref": "#/components/schemas/xpack.usage.Base" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Base" + } + ] }, "data_streams": { - "$ref": "#/components/schemas/xpack.usage.DataStreams" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.DataStreams" + } + ] }, "data_tiers": { - "$ref": "#/components/schemas/xpack.usage.DataTiers" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.DataTiers" + } + ] }, "enrich": { - "$ref": "#/components/schemas/xpack.usage.Base" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Base" + } + ] }, "eql": { - "$ref": "#/components/schemas/xpack.usage.Eql" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Eql" + } + ] }, "flattened": { - "$ref": "#/components/schemas/xpack.usage.Flattened" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Flattened" + } + ] }, "graph": { - "$ref": "#/components/schemas/xpack.usage.Base" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Base" + } + ] }, "health_api": { - "$ref": "#/components/schemas/xpack.usage.HealthStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.HealthStatistics" + } + ] }, "ilm": { - "$ref": "#/components/schemas/xpack.usage.Ilm" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Ilm" + } + ] }, "logstash": { - "$ref": "#/components/schemas/xpack.usage.Base" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Base" + } + ] }, "ml": { - "$ref": "#/components/schemas/xpack.usage.MachineLearning" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.MachineLearning" + } + ] }, "monitoring": { - "$ref": "#/components/schemas/xpack.usage.Monitoring" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Monitoring" + } + ] }, "rollup": { - "$ref": "#/components/schemas/xpack.usage.Base" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Base" + } + ] }, "runtime_fields": { - "$ref": "#/components/schemas/xpack.usage.RuntimeFieldTypes" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.RuntimeFieldTypes" + } + ] }, "spatial": { - "$ref": "#/components/schemas/xpack.usage.Base" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Base" + } + ] }, "searchable_snapshots": { - "$ref": "#/components/schemas/xpack.usage.SearchableSnapshots" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.SearchableSnapshots" + } + ] }, "security": { - "$ref": "#/components/schemas/xpack.usage.Security" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Security" + } + ] }, "slm": { - "$ref": "#/components/schemas/xpack.usage.Slm" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Slm" + } + ] }, "sql": { - "$ref": "#/components/schemas/xpack.usage.Sql" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Sql" + } + ] }, "transform": { - "$ref": "#/components/schemas/xpack.usage.Base" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Base" + } + ] }, "vectors": { - "$ref": "#/components/schemas/xpack.usage.Vector" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Vector" + } + ] }, "voting_only": { - "$ref": "#/components/schemas/xpack.usage.Base" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Base" + } + ] } }, "required": [ @@ -51125,7 +53732,11 @@ "type": "object", "properties": { "response": { - "$ref": "#/components/schemas/async_search._types.AsyncSearch" + "allOf": [ + { + "$ref": "#/components/schemas/async_search._types.AsyncSearch" + } + ] } }, "required": [ @@ -51145,7 +53756,11 @@ } }, "_clusters": { - "$ref": "#/components/schemas/_types.ClusterStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ClusterStatistics" + } + ] }, "fields": { "type": "object", @@ -51154,7 +53769,11 @@ } }, "hits": { - "$ref": "#/components/schemas/_global.search._types.HitsMetadata" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.HitsMetadata" + } + ] }, "max_score": { "type": "number" @@ -51164,16 +53783,33 @@ "type": "number" }, "profile": { - "$ref": "#/components/schemas/_global.search._types.Profile" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.Profile" + } + ] }, "pit_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_scroll_id": { - "$ref": "#/components/schemas/_types.ScrollId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScrollId" + } + ] }, "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "description": "Indicates how many shards have run the query.\nNote that in order for shard results to be included in the search response, they need to be reduced first.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] }, "suggest": { "type": "object", @@ -51440,7 +54076,11 @@ "type": "object", "properties": { "meta": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] } } }, @@ -51469,7 +54109,11 @@ "type": "object", "properties": { "values": { - "$ref": "#/components/schemas/_types.aggregations.Percentiles" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.Percentiles" + } + ] } }, "required": [ @@ -51893,7 +54537,11 @@ ] }, "std_deviation_bounds": { - "$ref": "#/components/schemas/_types.aggregations.StandardDeviationBounds" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.StandardDeviationBounds" + } + ] }, "sum_of_squares_as_string": { "type": "string" @@ -51911,7 +54559,11 @@ "type": "string" }, "std_deviation_bounds_as_string": { - "$ref": "#/components/schemas/_types.aggregations.StandardDeviationBoundsAsString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.StandardDeviationBoundsAsString" + } + ] } }, "required": [ @@ -52055,7 +54707,11 @@ "type": "object", "properties": { "bounds": { - "$ref": "#/components/schemas/_types.GeoBounds" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoBounds" + } + ] } } } @@ -52105,10 +54761,18 @@ "type": "object", "properties": { "top_left": { - "$ref": "#/components/schemas/_types.GeoLocation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoLocation" + } + ] }, "bottom_right": { - "$ref": "#/components/schemas/_types.GeoLocation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoLocation" + } + ] } }, "required": [ @@ -52157,7 +54821,11 @@ "type": "object", "properties": { "geohash": { - "$ref": "#/components/schemas/_types.GeoHash" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoHash" + } + ] } }, "required": [ @@ -52171,10 +54839,18 @@ "type": "object", "properties": { "top_right": { - "$ref": "#/components/schemas/_types.GeoLocation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoLocation" + } + ] }, "bottom_left": { - "$ref": "#/components/schemas/_types.GeoLocation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoLocation" + } + ] } }, "required": [ @@ -52205,7 +54881,11 @@ "type": "number" }, "location": { - "$ref": "#/components/schemas/_types.GeoLocation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoLocation" + } + ] } }, "required": [ @@ -52233,7 +54913,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsHistogramBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsHistogramBucket" + } + ] } }, "required": [ @@ -52311,7 +54995,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsDateHistogramBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsDateHistogramBucket" + } + ] } }, "required": [ @@ -52349,7 +55037,11 @@ "type": "string" }, "key": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] } }, "required": [ @@ -52378,7 +55070,11 @@ "type": "object", "properties": { "interval": { - "$ref": "#/components/schemas/_types.DurationLarge" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationLarge" + } + ] } }, "required": [ @@ -52410,7 +55106,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsVariableWidthHistogramBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsVariableWidthHistogramBucket" + } + ] } }, "required": [ @@ -52509,7 +55209,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsStringTermsBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsStringTermsBucket" + } + ] } }, "required": [ @@ -52544,7 +55248,11 @@ "type": "object", "properties": { "key": { - "$ref": "#/components/schemas/_types.FieldValue" + "allOf": [ + { + "$ref": "#/components/schemas/_types.FieldValue" + } + ] } }, "required": [ @@ -52627,7 +55335,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsLongTermsBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsLongTermsBucket" + } + ] } }, "required": [ @@ -52712,7 +55424,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsDoubleTermsBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsDoubleTermsBucket" + } + ] } }, "required": [ @@ -52797,7 +55513,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsVoid" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsVoid" + } + ] } }, "required": [ @@ -52847,7 +55567,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsLongRareTermsBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsLongRareTermsBucket" + } + ] } }, "required": [ @@ -52914,7 +55638,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsStringRareTermsBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsStringRareTermsBucket" + } + ] } }, "required": [ @@ -53006,7 +55734,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsMultiTermsBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsMultiTermsBucket" + } + ] } }, "required": [ @@ -53187,7 +55919,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsGeoHashGridBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsGeoHashGridBucket" + } + ] } }, "required": [ @@ -53222,7 +55958,11 @@ "type": "object", "properties": { "key": { - "$ref": "#/components/schemas/_types.GeoHash" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoHash" + } + ] } }, "required": [ @@ -53250,7 +55990,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsGeoTileGridBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsGeoTileGridBucket" + } + ] } }, "required": [ @@ -53285,7 +56029,11 @@ "type": "object", "properties": { "key": { - "$ref": "#/components/schemas/_types.GeoTile" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoTile" + } + ] } }, "required": [ @@ -53317,7 +56065,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsGeoHexGridBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsGeoHexGridBucket" + } + ] } }, "required": [ @@ -53352,7 +56104,11 @@ "type": "object", "properties": { "key": { - "$ref": "#/components/schemas/_types.GeoHexCell" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoHexCell" + } + ] } }, "required": [ @@ -53384,7 +56140,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsRangeBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsRangeBucket" + } + ] } }, "required": [ @@ -53479,7 +56239,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsIpRangeBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsIpRangeBucket" + } + ] } }, "required": [ @@ -53545,7 +56309,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsIpPrefixBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsIpPrefixBucket" + } + ] } }, "required": [ @@ -53619,7 +56387,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsFiltersBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsFiltersBucket" + } + ] } }, "required": [ @@ -53679,7 +56451,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsAdjacencyMatrixBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsAdjacencyMatrixBucket" + } + ] } }, "required": [ @@ -53760,7 +56536,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsSignificantLongTermsBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsSignificantLongTermsBucket" + } + ] } }, "required": [ @@ -53866,7 +56646,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsSignificantStringTermsBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsSignificantStringTermsBucket" + } + ] } }, "required": [ @@ -53948,7 +56732,11 @@ "type": "object", "properties": { "after_key": { - "$ref": "#/components/schemas/_types.aggregations.CompositeAggregateKey" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CompositeAggregateKey" + } + ] } } } @@ -53969,7 +56757,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsCompositeBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsCompositeBucket" + } + ] } }, "required": [ @@ -54004,7 +56796,11 @@ "type": "object", "properties": { "key": { - "$ref": "#/components/schemas/_types.aggregations.CompositeAggregateKey" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CompositeAggregateKey" + } + ] } }, "required": [ @@ -54032,7 +56828,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsFrequentItemSetsBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsFrequentItemSetsBucket" + } + ] } }, "required": [ @@ -54105,7 +56905,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsTimeSeriesBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsTimeSeriesBucket" + } + ] } }, "required": [ @@ -54179,7 +56983,11 @@ "type": "object", "properties": { "hits": { - "$ref": "#/components/schemas/_global.search._types.HitsMetadata" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.HitsMetadata" + } + ] } }, "required": [ @@ -54228,7 +57036,11 @@ "type": "object", "properties": { "relation": { - "$ref": "#/components/schemas/_global.search._types.TotalHitsRelation" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.TotalHitsRelation" + } + ] }, "value": { "type": "number" @@ -54250,10 +57062,18 @@ "type": "object", "properties": { "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_score": { "oneOf": [ @@ -54267,7 +57087,11 @@ ] }, "_explanation": { - "$ref": "#/components/schemas/_global.explain.Explanation" + "allOf": [ + { + "$ref": "#/components/schemas/_global.explain.Explanation" + } + ] }, "fields": { "type": "object", @@ -54307,7 +57131,11 @@ ] }, "_nested": { - "$ref": "#/components/schemas/_global.search._types.NestedIdentity" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.NestedIdentity" + } + ] }, "_ignored": { "type": "array", @@ -54340,16 +57168,28 @@ "type": "number" }, "_seq_no": { - "$ref": "#/components/schemas/_types.SequenceNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SequenceNumber" + } + ] }, "_primary_term": { "type": "number" }, "_version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "sort": { - "$ref": "#/components/schemas/_types.SortResults" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortResults" + } + ] } }, "required": [ @@ -54406,7 +57246,11 @@ "type": "object", "properties": { "hits": { - "$ref": "#/components/schemas/_global.search._types.HitsMetadata" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.HitsMetadata" + } + ] } }, "required": [ @@ -54417,13 +57261,21 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "offset": { "type": "number" }, "_nested": { - "$ref": "#/components/schemas/_global.search._types.NestedIdentity" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.NestedIdentity" + } + ] } }, "required": [ @@ -54456,7 +57308,11 @@ "type": "object", "properties": { "value": { - "$ref": "#/components/schemas/_types.FieldValue" + "allOf": [ + { + "$ref": "#/components/schemas/_types.FieldValue" + } + ] }, "feature_importance": { "type": "array", @@ -54516,7 +57372,11 @@ "type": "object", "properties": { "class_name": { - "$ref": "#/components/schemas/_types.FieldValue" + "allOf": [ + { + "$ref": "#/components/schemas/_types.FieldValue" + } + ] }, "class_probability": { "type": "number" @@ -54841,7 +57701,11 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "count": { "type": "number" @@ -54894,7 +57758,11 @@ "type": "string" }, "geometry": { - "$ref": "#/components/schemas/_types.GeoLine" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoLine" + } + ] }, "properties": { "type": "object" @@ -54973,19 +57841,31 @@ "type": "object", "properties": { "status": { - "$ref": "#/components/schemas/_types.ClusterSearchStatus" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ClusterSearchStatus" + } + ] }, "indices": { "type": "string" }, "took": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "timed_out": { "type": "boolean" }, "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] }, "failures": { "type": "array", @@ -55021,13 +57901,28 @@ "type": "object", "properties": { "failed": { - "$ref": "#/components/schemas/_types.uint" + "description": "The number of shards the operation or search attempted to run on but failed.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "successful": { - "$ref": "#/components/schemas/_types.uint" + "description": "The number of shards the operation or search succeeded on.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "total": { - "$ref": "#/components/schemas/_types.uint" + "description": "The number of shards the operation or search will run on overall.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "failures": { "type": "array", @@ -55036,7 +57931,11 @@ } }, "skipped": { - "$ref": "#/components/schemas/_types.uint" + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] } }, "required": [ @@ -55052,13 +57951,21 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "node": { "type": "string" }, "reason": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] }, "shard": { "type": "number" @@ -55097,7 +58004,11 @@ "type": "string" }, "caused_by": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] }, "root_cause": { "type": "array", @@ -55143,19 +58054,35 @@ "type": "string" }, "dfs": { - "$ref": "#/components/schemas/_global.search._types.DfsProfile" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.DfsProfile" + } + ] }, "fetch": { - "$ref": "#/components/schemas/_global.search._types.FetchProfile" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.FetchProfile" + } + ] }, "id": { "type": "string" }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "node_id": { - "$ref": "#/components/schemas/_types.NodeId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] }, "searches": { "type": "array", @@ -55181,19 +58108,31 @@ "type": "object", "properties": { "breakdown": { - "$ref": "#/components/schemas/_global.search._types.AggregationBreakdown" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.AggregationBreakdown" + } + ] }, "description": { "type": "string" }, "time_in_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "type": { "type": "string" }, "debug": { - "$ref": "#/components/schemas/_global.search._types.AggregationProfileDebug" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.AggregationProfileDebug" + } + ] }, "children": { "type": "array", @@ -55301,7 +58240,11 @@ "type": "string" }, "delegate_debug": { - "$ref": "#/components/schemas/_global.search._types.AggregationProfileDebug" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.AggregationProfileDebug" + } + ] }, "chars_fetched": { "type": "number" @@ -55401,7 +58344,11 @@ "type": "object", "properties": { "statistics": { - "$ref": "#/components/schemas/_global.search._types.DfsStatisticsProfile" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.DfsStatisticsProfile" + } + ] }, "knn": { "type": "array", @@ -55421,13 +58368,25 @@ "type": "string" }, "time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "time_in_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "breakdown": { - "$ref": "#/components/schemas/_global.search._types.DfsStatisticsBreakdown" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.DfsStatisticsBreakdown" + } + ] }, "debug": { "type": "object", @@ -55526,13 +58485,25 @@ "type": "string" }, "time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "time_in_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "breakdown": { - "$ref": "#/components/schemas/_global.search._types.KnnQueryProfileBreakdown" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.KnnQueryProfileBreakdown" + } + ] }, "debug": { "type": "object", @@ -55651,10 +58622,18 @@ "type": "string" }, "time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "time_in_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "children": { "type": "array", @@ -55679,13 +58658,25 @@ "type": "string" }, "time_in_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "breakdown": { - "$ref": "#/components/schemas/_global.search._types.FetchProfileBreakdown" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.FetchProfileBreakdown" + } + ] }, "debug": { - "$ref": "#/components/schemas/_global.search._types.FetchProfileDebug" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.FetchProfileDebug" + } + ] }, "children": { "type": "array", @@ -55782,7 +58773,11 @@ "type": "string" }, "time_in_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "children": { "type": "array", @@ -55801,13 +58796,21 @@ "type": "object", "properties": { "breakdown": { - "$ref": "#/components/schemas/_global.search._types.QueryBreakdown" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.QueryBreakdown" + } + ] }, "description": { "type": "string" }, "time_in_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "type": { "type": "string" @@ -55982,10 +58985,18 @@ "type": "string" }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "_routing": { - "$ref": "#/components/schemas/_types.Routing" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "_score": { "type": "number" @@ -56143,7 +59154,11 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "is_partial": { "description": "When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards.\nWhile the query is running, `is_partial` is always set to `true`.", @@ -56154,22 +59169,48 @@ "type": "boolean" }, "expiration_time": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "Indicates when the async search will expire.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "expiration_time_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "start_time": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "start_time_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "completion_time": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "Indicates when the async search completed.\nIt is present only when the search has completed.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "completion_time_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] } }, "required": [ @@ -56199,10 +59240,20 @@ "type": "object", "properties": { "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "description": "The number of shards that have run the query so far.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] }, "_clusters": { - "$ref": "#/components/schemas/_types.ClusterStatistics" + "description": "Metadata about clusters involved in the cross-cluster search.\nIt is not shown for local-only searches.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ClusterStatistics" + } + ] }, "completion_status": { "description": "If the async search completed, this field shows the status code of the search.\nFor example, `200` indicates that the async search was successfully completed.\n`503` indicates that the async search was completed with an error.", @@ -56323,7 +59374,11 @@ } }, "meta": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] } } }, @@ -56331,238 +59386,856 @@ "type": "object", "properties": { "adjacency_matrix": { - "$ref": "#/components/schemas/_types.aggregations.AdjacencyMatrixAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-adjacency-matrix-aggregation" + }, + "description": "A bucket aggregation returning a form of adjacency matrix.\nThe request provides a collection of named filter expressions, similar to the `filters` aggregation.\nEach bucket in the response represents a non-empty cell in the matrix of intersecting filters.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.AdjacencyMatrixAggregation" + } + ] }, "auto_date_histogram": { - "$ref": "#/components/schemas/_types.aggregations.AutoDateHistogramAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-autodatehistogram-aggregation" + }, + "description": "A multi-bucket aggregation similar to the date histogram, except instead of providing an interval to use as the width of each bucket, a target number of buckets is provided.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.AutoDateHistogramAggregation" + } + ] }, "avg": { - "$ref": "#/components/schemas/_types.aggregations.AverageAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-avg-aggregation" + }, + "description": "A single-value metrics aggregation that computes the average of numeric values that are extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.AverageAggregation" + } + ] }, "avg_bucket": { - "$ref": "#/components/schemas/_types.aggregations.AverageBucketAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-avg-bucket-aggregation" + }, + "description": "A sibling pipeline aggregation which calculates the mean value of a specified metric in a sibling aggregation.\nThe specified metric must be numeric and the sibling aggregation must be a multi-bucket aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.AverageBucketAggregation" + } + ] }, "boxplot": { - "$ref": "#/components/schemas/_types.aggregations.BoxplotAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-boxplot-aggregation" + }, + "description": "A metrics aggregation that computes a box plot of numeric values extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BoxplotAggregation" + } + ] }, "bucket_script": { - "$ref": "#/components/schemas/_types.aggregations.BucketScriptAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-script-aggregation" + }, + "description": "A parent pipeline aggregation which runs a script which can perform per bucket computations on metrics in the parent multi-bucket aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketScriptAggregation" + } + ] }, "bucket_selector": { - "$ref": "#/components/schemas/_types.aggregations.BucketSelectorAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-selector-aggregation" + }, + "description": "A parent pipeline aggregation which runs a script to determine whether the current bucket will be retained in the parent multi-bucket aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketSelectorAggregation" + } + ] }, "bucket_sort": { - "$ref": "#/components/schemas/_types.aggregations.BucketSortAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-sort-aggregation" + }, + "description": "A parent pipeline aggregation which sorts the buckets of its parent multi-bucket aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketSortAggregation" + } + ] }, "bucket_count_ks_test": { - "$ref": "#/components/schemas/_types.aggregations.BucketKsAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-count-ks-test-aggregation" + }, + "description": "A sibling pipeline aggregation which runs a two sample Kolmogorov–Smirnov test (\"K-S test\") against a provided distribution and the distribution implied by the documents counts in the configured sibling aggregation.", + "x-state": "Technical preview", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketKsAggregation" + } + ] }, "bucket_correlation": { - "$ref": "#/components/schemas/_types.aggregations.BucketCorrelationAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-correlation-aggregation" + }, + "description": "A sibling pipeline aggregation which runs a correlation function on the configured sibling multi-bucket aggregation.", + "x-state": "Technical preview", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketCorrelationAggregation" + } + ] }, "cardinality": { - "$ref": "#/components/schemas/_types.aggregations.CardinalityAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-cardinality-aggregation" + }, + "description": "A single-value metrics aggregation that calculates an approximate count of distinct values.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CardinalityAggregation" + } + ] }, "categorize_text": { - "$ref": "#/components/schemas/_types.aggregations.CategorizeTextAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-categorize-text-aggregation" + }, + "description": "A multi-bucket aggregation that groups semi-structured text into buckets.", + "x-state": "Technical preview", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CategorizeTextAggregation" + } + ] }, "children": { - "$ref": "#/components/schemas/_types.aggregations.ChildrenAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-children-aggregation" + }, + "description": "A single bucket aggregation that selects child documents that have the specified type, as defined in a `join` field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ChildrenAggregation" + } + ] }, "composite": { - "$ref": "#/components/schemas/_types.aggregations.CompositeAggregation" + "description": "A multi-bucket aggregation that creates composite buckets from different sources.\nUnlike the other multi-bucket aggregations, you can use the `composite` aggregation to paginate *all* buckets from a multi-level aggregation efficiently.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CompositeAggregation" + } + ] }, "cumulative_cardinality": { - "$ref": "#/components/schemas/_types.aggregations.CumulativeCardinalityAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-cumulative-cardinality-aggregation" + }, + "description": "A parent pipeline aggregation which calculates the cumulative cardinality in a parent `histogram` or `date_histogram` aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CumulativeCardinalityAggregation" + } + ] }, "cumulative_sum": { - "$ref": "#/components/schemas/_types.aggregations.CumulativeSumAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-cumulative-sum-aggregation" + }, + "description": "A parent pipeline aggregation which calculates the cumulative sum of a specified metric in a parent `histogram` or `date_histogram` aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CumulativeSumAggregation" + } + ] }, "date_histogram": { - "$ref": "#/components/schemas/_types.aggregations.DateHistogramAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-datehistogram-aggregation" + }, + "description": "A multi-bucket values source based aggregation that can be applied on date values or date range values extracted from the documents.\nIt dynamically builds fixed size (interval) buckets over the values.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.DateHistogramAggregation" + } + ] }, "date_range": { - "$ref": "#/components/schemas/_types.aggregations.DateRangeAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-daterange-aggregation" + }, + "description": "A multi-bucket value source based aggregation that enables the user to define a set of date ranges - each representing a bucket.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.DateRangeAggregation" + } + ] }, "derivative": { - "$ref": "#/components/schemas/_types.aggregations.DerivativeAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-derivative-aggregation" + }, + "description": "A parent pipeline aggregation which calculates the derivative of a specified metric in a parent `histogram` or `date_histogram` aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.DerivativeAggregation" + } + ] }, "diversified_sampler": { - "$ref": "#/components/schemas/_types.aggregations.DiversifiedSamplerAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-diversified-sampler-aggregation" + }, + "description": "A filtering aggregation used to limit any sub aggregations' processing to a sample of the top-scoring documents.\nSimilar to the `sampler` aggregation, but adds the ability to limit the number of matches that share a common value.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.DiversifiedSamplerAggregation" + } + ] }, "extended_stats": { - "$ref": "#/components/schemas/_types.aggregations.ExtendedStatsAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-extendedstats-aggregation" + }, + "description": "A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ExtendedStatsAggregation" + } + ] }, "extended_stats_bucket": { - "$ref": "#/components/schemas/_types.aggregations.ExtendedStatsBucketAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-extended-stats-bucket-aggregation" + }, + "description": "A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ExtendedStatsBucketAggregation" + } + ] }, "frequent_item_sets": { - "$ref": "#/components/schemas/_types.aggregations.FrequentItemSetsAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-frequent-item-sets-aggregation" + }, + "description": "A bucket aggregation which finds frequent item sets, a form of association rules mining that identifies items that often occur together.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.FrequentItemSetsAggregation" + } + ] }, "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filter-aggregation" + }, + "description": "A single bucket aggregation that narrows the set of documents to those that match a query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "filters": { - "$ref": "#/components/schemas/_types.aggregations.FiltersAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filters-aggregation" + }, + "description": "A multi-bucket aggregation where each bucket contains the documents that match a query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.FiltersAggregation" + } + ] }, "geo_bounds": { - "$ref": "#/components/schemas/_types.aggregations.GeoBoundsAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geobounds-aggregation" + }, + "description": "A metric aggregation that computes the geographic bounding box containing all values for a Geopoint or Geoshape field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GeoBoundsAggregation" + } + ] }, "geo_centroid": { - "$ref": "#/components/schemas/_types.aggregations.GeoCentroidAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geocentroid-aggregation" + }, + "description": "A metric aggregation that computes the weighted centroid from all coordinate values for geo fields.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GeoCentroidAggregation" + } + ] }, "geo_distance": { - "$ref": "#/components/schemas/_types.aggregations.GeoDistanceAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geodistance-aggregation" + }, + "description": "A multi-bucket aggregation that works on `geo_point` fields.\nEvaluates the distance of each document value from an origin point and determines the buckets it belongs to, based on ranges defined in the request.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GeoDistanceAggregation" + } + ] }, "geohash_grid": { - "$ref": "#/components/schemas/_types.aggregations.GeoHashGridAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geohashgrid-aggregation" + }, + "description": "A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid.\nEach cell is labeled using a geohash which is of user-definable precision.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GeoHashGridAggregation" + } + ] }, "geo_line": { - "$ref": "#/components/schemas/_types.aggregations.GeoLineAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geo-line" + }, + "description": "Aggregates all `geo_point` values within a bucket into a `LineString` ordered by the chosen sort field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GeoLineAggregation" + } + ] }, "geotile_grid": { - "$ref": "#/components/schemas/_types.aggregations.GeoTileGridAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geotilegrid-aggregation" + }, + "description": "A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid.\nEach cell corresponds to a map tile as used by many online map sites.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GeoTileGridAggregation" + } + ] }, "geohex_grid": { - "$ref": "#/components/schemas/_types.aggregations.GeohexGridAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geohexgrid-aggregation" + }, + "description": "A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid.\nEach cell corresponds to a H3 cell index and is labeled using the H3Index representation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GeohexGridAggregation" + } + ] }, "global": { - "$ref": "#/components/schemas/_types.aggregations.GlobalAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-global-aggregation" + }, + "description": "Defines a single bucket of all the documents within the search execution context.\nThis context is defined by the indices and the document types you’re searching on, but is not influenced by the search query itself.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GlobalAggregation" + } + ] }, "histogram": { - "$ref": "#/components/schemas/_types.aggregations.HistogramAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-histogram-aggregation" + }, + "description": "A multi-bucket values source based aggregation that can be applied on numeric values or numeric range values extracted from the documents.\nIt dynamically builds fixed size (interval) buckets over the values.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.HistogramAggregation" + } + ] }, "ip_range": { - "$ref": "#/components/schemas/_types.aggregations.IpRangeAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-iprange-aggregation" + }, + "description": "A multi-bucket value source based aggregation that enables the user to define a set of IP ranges - each representing a bucket.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.IpRangeAggregation" + } + ] }, "ip_prefix": { - "$ref": "#/components/schemas/_types.aggregations.IpPrefixAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-ipprefix-aggregation" + }, + "description": "A bucket aggregation that groups documents based on the network or sub-network of an IP address.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.IpPrefixAggregation" + } + ] }, "inference": { - "$ref": "#/components/schemas/_types.aggregations.InferenceAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-inference-bucket-aggregation" + }, + "description": "A parent pipeline aggregation which loads a pre-trained model and performs inference on the collated result fields from the parent bucket aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.InferenceAggregation" + } + ] }, "line": { - "$ref": "#/components/schemas/_types.aggregations.GeoLineAggregation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GeoLineAggregation" + } + ] }, "matrix_stats": { - "$ref": "#/components/schemas/_types.aggregations.MatrixStatsAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-matrix-stats-aggregation" + }, + "description": "A numeric aggregation that computes the following statistics over a set of document fields: `count`, `mean`, `variance`, `skewness`, `kurtosis`, `covariance`, and `covariance`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MatrixStatsAggregation" + } + ] }, "max": { - "$ref": "#/components/schemas/_types.aggregations.MaxAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-max-aggregation" + }, + "description": "A single-value metrics aggregation that returns the maximum value among the numeric values extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MaxAggregation" + } + ] }, "max_bucket": { - "$ref": "#/components/schemas/_types.aggregations.MaxBucketAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-max-bucket-aggregation" + }, + "description": "A sibling pipeline aggregation which identifies the bucket(s) with the maximum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MaxBucketAggregation" + } + ] }, "median_absolute_deviation": { - "$ref": "#/components/schemas/_types.aggregations.MedianAbsoluteDeviationAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-median-absolute-deviation-aggregation" + }, + "description": "A single-value aggregation that approximates the median absolute deviation of its search results.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MedianAbsoluteDeviationAggregation" + } + ] }, "min": { - "$ref": "#/components/schemas/_types.aggregations.MinAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-min-aggregation" + }, + "description": "A single-value metrics aggregation that returns the minimum value among numeric values extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MinAggregation" + } + ] }, "min_bucket": { - "$ref": "#/components/schemas/_types.aggregations.MinBucketAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-min-bucket-aggregation" + }, + "description": "A sibling pipeline aggregation which identifies the bucket(s) with the minimum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MinBucketAggregation" + } + ] }, "missing": { - "$ref": "#/components/schemas/_types.aggregations.MissingAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-missing-aggregation" + }, + "description": "A field data based single bucket aggregation, that creates a bucket of all documents in the current document set context that are missing a field value (effectively, missing a field or having the configured NULL value set).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MissingAggregation" + } + ] }, "moving_avg": { - "$ref": "#/components/schemas/_types.aggregations.MovingAverageAggregation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MovingAverageAggregation" + } + ] }, "moving_percentiles": { - "$ref": "#/components/schemas/_types.aggregations.MovingPercentilesAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-moving-percentiles-aggregation" + }, + "description": "Given an ordered series of percentiles, \"slides\" a window across those percentiles and computes cumulative percentiles.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MovingPercentilesAggregation" + } + ] }, "moving_fn": { - "$ref": "#/components/schemas/_types.aggregations.MovingFunctionAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-movfn-aggregation" + }, + "description": "Given an ordered series of data, \"slides\" a window across the data and runs a custom script on each window of data.\nFor convenience, a number of common functions are predefined such as `min`, `max`, and moving averages.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MovingFunctionAggregation" + } + ] }, "multi_terms": { - "$ref": "#/components/schemas/_types.aggregations.MultiTermsAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-multi-terms-aggregation" + }, + "description": "A multi-bucket value source based aggregation where buckets are dynamically built - one per unique set of values.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MultiTermsAggregation" + } + ] }, "nested": { - "$ref": "#/components/schemas/_types.aggregations.NestedAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-nested-aggregation" + }, + "description": "A special single bucket aggregation that enables aggregating nested documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.NestedAggregation" + } + ] }, "normalize": { - "$ref": "#/components/schemas/_types.aggregations.NormalizeAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-normalize-aggregation" + }, + "description": "A parent pipeline aggregation which calculates the specific normalized/rescaled value for a specific bucket value.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.NormalizeAggregation" + } + ] }, "parent": { - "$ref": "#/components/schemas/_types.aggregations.ParentAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-parent-aggregation" + }, + "description": "A special single bucket aggregation that selects parent documents that have the specified type, as defined in a `join` field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ParentAggregation" + } + ] }, "percentile_ranks": { - "$ref": "#/components/schemas/_types.aggregations.PercentileRanksAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-percentile-rank-aggregation" + }, + "description": "A multi-value metrics aggregation that calculates one or more percentile ranks over numeric values extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.PercentileRanksAggregation" + } + ] }, "percentiles": { - "$ref": "#/components/schemas/_types.aggregations.PercentilesAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-percentile-aggregation" + }, + "description": "A multi-value metrics aggregation that calculates one or more percentiles over numeric values extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.PercentilesAggregation" + } + ] }, "percentiles_bucket": { - "$ref": "#/components/schemas/_types.aggregations.PercentilesBucketAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-percentiles-bucket-aggregation" + }, + "description": "A sibling pipeline aggregation which calculates percentiles across all bucket of a specified metric in a sibling aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.PercentilesBucketAggregation" + } + ] }, "range": { - "$ref": "#/components/schemas/_types.aggregations.RangeAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-range-aggregation" + }, + "description": "A multi-bucket value source based aggregation that enables the user to define a set of ranges - each representing a bucket.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.RangeAggregation" + } + ] }, "rare_terms": { - "$ref": "#/components/schemas/_types.aggregations.RareTermsAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-rare-terms-aggregation" + }, + "description": "A multi-bucket value source based aggregation which finds \"rare\" terms — terms that are at the long-tail of the distribution and are not frequent.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.RareTermsAggregation" + } + ] }, "rate": { - "$ref": "#/components/schemas/_types.aggregations.RateAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-rate-aggregation" + }, + "description": "Calculates a rate of documents or a field in each bucket.\nCan only be used inside a `date_histogram` or `composite` aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.RateAggregation" + } + ] }, "reverse_nested": { - "$ref": "#/components/schemas/_types.aggregations.ReverseNestedAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-reverse-nested-aggregation" + }, + "description": "A special single bucket aggregation that enables aggregating on parent documents from nested documents.\nShould only be defined inside a `nested` aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ReverseNestedAggregation" + } + ] }, "random_sampler": { - "$ref": "#/components/schemas/_types.aggregations.RandomSamplerAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-random-sampler-aggregation" + }, + "description": "A single bucket aggregation that randomly includes documents in the aggregated results.\nSampling provides significant speed improvement at the cost of accuracy.", + "x-state": "Technical preview; Added in 8.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.RandomSamplerAggregation" + } + ] }, "sampler": { - "$ref": "#/components/schemas/_types.aggregations.SamplerAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-sampler-aggregation" + }, + "description": "A filtering aggregation used to limit any sub aggregations' processing to a sample of the top-scoring documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.SamplerAggregation" + } + ] }, "scripted_metric": { - "$ref": "#/components/schemas/_types.aggregations.ScriptedMetricAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-scripted-metric-aggregation" + }, + "description": "A metric aggregation that uses scripts to provide a metric output.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ScriptedMetricAggregation" + } + ] }, "serial_diff": { - "$ref": "#/components/schemas/_types.aggregations.SerialDifferencingAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-serialdiff-aggregation" + }, + "description": "An aggregation that subtracts values in a time series from themselves at different time lags or periods.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.SerialDifferencingAggregation" + } + ] }, "significant_terms": { - "$ref": "#/components/schemas/_types.aggregations.SignificantTermsAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significantterms-aggregation" + }, + "description": "Returns interesting or unusual occurrences of terms in a set.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.SignificantTermsAggregation" + } + ] }, "significant_text": { - "$ref": "#/components/schemas/_types.aggregations.SignificantTextAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significanttext-aggregation" + }, + "description": "Returns interesting or unusual occurrences of free-text terms in a set.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.SignificantTextAggregation" + } + ] }, "stats": { - "$ref": "#/components/schemas/_types.aggregations.StatsAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-stats-aggregation" + }, + "description": "A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.StatsAggregation" + } + ] }, "stats_bucket": { - "$ref": "#/components/schemas/_types.aggregations.StatsBucketAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-stats-bucket-aggregation" + }, + "description": "A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.StatsBucketAggregation" + } + ] }, "string_stats": { - "$ref": "#/components/schemas/_types.aggregations.StringStatsAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-string-stats-aggregation" + }, + "description": "A multi-value metrics aggregation that computes statistics over string values extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.StringStatsAggregation" + } + ] }, "sum": { - "$ref": "#/components/schemas/_types.aggregations.SumAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-sum-aggregation" + }, + "description": "A single-value metrics aggregation that sums numeric values that are extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.SumAggregation" + } + ] }, "sum_bucket": { - "$ref": "#/components/schemas/_types.aggregations.SumBucketAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-sum-bucket-aggregation" + }, + "description": "A sibling pipeline aggregation which calculates the sum of a specified metric across all buckets in a sibling aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.SumBucketAggregation" + } + ] }, "terms": { - "$ref": "#/components/schemas/_types.aggregations.TermsAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-terms-aggregation" + }, + "description": "A multi-bucket value source based aggregation where buckets are dynamically built - one per unique value.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsAggregation" + } + ] }, "time_series": { - "$ref": "#/components/schemas/_types.aggregations.TimeSeriesAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-time-series-aggregation" + }, + "description": "The time series aggregation queries data created using a time series index.\nThis is typically data such as metrics or other data streams with a time component, and requires creating an index using the time series mode.", + "x-state": "Technical preview", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TimeSeriesAggregation" + } + ] }, "top_hits": { - "$ref": "#/components/schemas/_types.aggregations.TopHitsAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-top-hits-aggregation" + }, + "description": "A metric aggregation that returns the top matching documents per bucket.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TopHitsAggregation" + } + ] }, "t_test": { - "$ref": "#/components/schemas/_types.aggregations.TTestAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-ttest-aggregation" + }, + "description": "A metrics aggregation that performs a statistical hypothesis test in which the test statistic follows a Student’s t-distribution under the null hypothesis on numeric values extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TTestAggregation" + } + ] }, "top_metrics": { - "$ref": "#/components/schemas/_types.aggregations.TopMetricsAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-top-metrics" + }, + "description": "A metric aggregation that selects metrics from the document with the largest or smallest sort value.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TopMetricsAggregation" + } + ] }, "value_count": { - "$ref": "#/components/schemas/_types.aggregations.ValueCountAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-valuecount-aggregation" + }, + "description": "A single-value metrics aggregation that counts the number of values that are extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ValueCountAggregation" + } + ] }, "weighted_avg": { - "$ref": "#/components/schemas/_types.aggregations.WeightedAverageAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-weight-avg-aggregation" + }, + "description": "A single-value metrics aggregation that computes the weighted average of numeric values that are extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.WeightedAverageAggregation" + } + ] }, "variable_width_histogram": { - "$ref": "#/components/schemas/_types.aggregations.VariableWidthHistogramAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-variablewidthhistogram-aggregation" + }, + "description": "A multi-bucket aggregation similar to the histogram, except instead of providing an interval to use as the width of each bucket, a target number of buckets is provided.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.VariableWidthHistogramAggregation" + } + ] } }, "minProperties": 1, @@ -56601,10 +60274,26 @@ "type": "object", "properties": { "bool": { - "$ref": "#/components/schemas/_types.query_dsl.BoolQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-bool-query" + }, + "description": "matches documents matching boolean combinations of other queries.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.BoolQuery" + } + ] }, "boosting": { - "$ref": "#/components/schemas/_types.query_dsl.BoostingQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-boosting-query" + }, + "description": "Returns documents matching a `positive` query while reducing the relevance score of documents that also match a `negative` query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.BoostingQuery" + } + ] }, "common": { "deprecated": true, @@ -56616,22 +60305,71 @@ "maxProperties": 1 }, "combined_fields": { - "$ref": "#/components/schemas/_types.query_dsl.CombinedFieldsQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-combined-fields-query" + }, + "description": "The `combined_fields` query supports searching multiple text fields as if their contents had been indexed into one combined field.", + "x-state": "Generally available; Added in 7.13.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.CombinedFieldsQuery" + } + ] }, "constant_score": { - "$ref": "#/components/schemas/_types.query_dsl.ConstantScoreQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-constant-score-query" + }, + "description": "Wraps a filter query and returns every matching document with a relevance score equal to the `boost` parameter value.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ConstantScoreQuery" + } + ] }, "dis_max": { - "$ref": "#/components/schemas/_types.query_dsl.DisMaxQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-dis-max-query" + }, + "description": "Returns documents matching one or more wrapped queries, called query clauses or clauses.\nIf a returned document matches multiple query clauses, the `dis_max` query assigns the document the highest relevance score from any matching clause, plus a tie breaking increment for any additional matching subqueries.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.DisMaxQuery" + } + ] }, "distance_feature": { - "$ref": "#/components/schemas/_types.query_dsl.DistanceFeatureQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-distance-feature-query" + }, + "description": "Boosts the relevance score of documents closer to a provided origin date or point.\nFor example, you can use this query to give more weight to documents closer to a certain date or location.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.DistanceFeatureQuery" + } + ] }, "exists": { - "$ref": "#/components/schemas/_types.query_dsl.ExistsQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-exists-query" + }, + "description": "Returns documents that contain an indexed value for a field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ExistsQuery" + } + ] }, "function_score": { - "$ref": "#/components/schemas/_types.query_dsl.FunctionScoreQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-function-score-query" + }, + "description": "The `function_score` enables you to modify the score of documents that are retrieved by a query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.FunctionScoreQuery" + } + ] }, "fuzzy": { "externalDocs": { @@ -56646,10 +60384,26 @@ "maxProperties": 1 }, "geo_bounding_box": { - "$ref": "#/components/schemas/_types.query_dsl.GeoBoundingBoxQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-bounding-box-query" + }, + "description": "Matches geo_point and geo_shape values that intersect a bounding box.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.GeoBoundingBoxQuery" + } + ] }, "geo_distance": { - "$ref": "#/components/schemas/_types.query_dsl.GeoDistanceQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-distance-query" + }, + "description": "Matches `geo_point` and `geo_shape` values within a given distance of a geopoint.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.GeoDistanceQuery" + } + ] }, "geo_grid": { "description": "Matches `geo_point` and `geo_shape` values that intersect a grid cell from a GeoGrid aggregation.", @@ -56661,19 +60415,56 @@ "maxProperties": 1 }, "geo_polygon": { - "$ref": "#/components/schemas/_types.query_dsl.GeoPolygonQuery" + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.GeoPolygonQuery" + } + ] }, "geo_shape": { - "$ref": "#/components/schemas/_types.query_dsl.GeoShapeQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-shape-query" + }, + "description": "Filter documents indexed using either the `geo_shape` or the `geo_point` type.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.GeoShapeQuery" + } + ] }, "has_child": { - "$ref": "#/components/schemas/_types.query_dsl.HasChildQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-has-child-query" + }, + "description": "Returns parent documents whose joined child documents match a provided query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.HasChildQuery" + } + ] }, "has_parent": { - "$ref": "#/components/schemas/_types.query_dsl.HasParentQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-has-parent-query" + }, + "description": "Returns child documents whose joined parent document matches a provided query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.HasParentQuery" + } + ] }, "ids": { - "$ref": "#/components/schemas/_types.query_dsl.IdsQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-ids-query" + }, + "description": "Returns documents based on their IDs.\nThis query uses document IDs stored in the `_id` field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IdsQuery" + } + ] }, "intervals": { "externalDocs": { @@ -56688,7 +60479,15 @@ "maxProperties": 1 }, "knn": { - "$ref": "#/components/schemas/_types.KnnQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-knn-query" + }, + "description": "Finds the k nearest vectors to a query vector, as measured by a similarity\nmetric. knn query finds nearest vectors through approximate search on indexed\ndense_vectors.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.KnnQuery" + } + ] }, "match": { "externalDocs": { @@ -56703,7 +60502,15 @@ "maxProperties": 1 }, "match_all": { - "$ref": "#/components/schemas/_types.query_dsl.MatchAllQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query" + }, + "description": "Matches all documents, giving them all a `_score` of 1.0.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.MatchAllQuery" + } + ] }, "match_bool_prefix": { "externalDocs": { @@ -56718,7 +60525,15 @@ "maxProperties": 1 }, "match_none": { - "$ref": "#/components/schemas/_types.query_dsl.MatchNoneQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query#query-dsl-match-none-query" + }, + "description": "Matches no documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.MatchNoneQuery" + } + ] }, "match_phrase": { "externalDocs": { @@ -56745,22 +60560,70 @@ "maxProperties": 1 }, "more_like_this": { - "$ref": "#/components/schemas/_types.query_dsl.MoreLikeThisQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-mlt-query" + }, + "description": "Returns documents that are \"like\" a given set of documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.MoreLikeThisQuery" + } + ] }, "multi_match": { - "$ref": "#/components/schemas/_types.query_dsl.MultiMatchQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-match-query" + }, + "description": "Enables you to search for a provided text, number, date or boolean value across multiple fields.\nThe provided text is analyzed before matching.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.MultiMatchQuery" + } + ] }, "nested": { - "$ref": "#/components/schemas/_types.query_dsl.NestedQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-nested-query" + }, + "description": "Wraps another query to search nested fields.\nIf an object matches the search, the nested query returns the root parent document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.NestedQuery" + } + ] }, "parent_id": { - "$ref": "#/components/schemas/_types.query_dsl.ParentIdQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-parent-id-query" + }, + "description": "Returns child documents joined to a specific parent document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ParentIdQuery" + } + ] }, "percolate": { - "$ref": "#/components/schemas/_types.query_dsl.PercolateQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-percolate-query" + }, + "description": "Matches queries stored in an index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.PercolateQuery" + } + ] }, "pinned": { - "$ref": "#/components/schemas/_types.query_dsl.PinnedQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-pinned-query" + }, + "description": "Promotes selected documents to rank higher than those matching a given query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.PinnedQuery" + } + ] }, "prefix": { "externalDocs": { @@ -56775,7 +60638,15 @@ "maxProperties": 1 }, "query_string": { - "$ref": "#/components/schemas/_types.query_dsl.QueryStringQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-query-string-query" + }, + "description": "Returns documents based on a provided query string, using a parser with a strict syntax.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryStringQuery" + } + ] }, "range": { "externalDocs": { @@ -56790,7 +60661,15 @@ "maxProperties": 1 }, "rank_feature": { - "$ref": "#/components/schemas/_types.query_dsl.RankFeatureQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-rank-feature-query" + }, + "description": "Boosts the relevance score of documents based on the numeric value of a `rank_feature` or `rank_features` field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.RankFeatureQuery" + } + ] }, "regexp": { "externalDocs": { @@ -56805,43 +60684,141 @@ "maxProperties": 1 }, "rule": { - "$ref": "#/components/schemas/_types.query_dsl.RuleQuery" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.RuleQuery" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.query_dsl.ScriptQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-script-query" + }, + "description": "Filters documents based on a provided script.\nThe script query is typically used in a filter context.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ScriptQuery" + } + ] }, "script_score": { - "$ref": "#/components/schemas/_types.query_dsl.ScriptScoreQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-script-score-query" + }, + "description": "Uses a script to provide a custom score for returned documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ScriptScoreQuery" + } + ] }, "semantic": { - "$ref": "#/components/schemas/_types.query_dsl.SemanticQuery" + "description": "A semantic query to semantic_text field types", + "x-state": "Generally available; Added in 8.15.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SemanticQuery" + } + ] }, "shape": { - "$ref": "#/components/schemas/_types.query_dsl.ShapeQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-shape-query" + }, + "description": "Queries documents that contain fields indexed using the `shape` type.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ShapeQuery" + } + ] }, "simple_query_string": { - "$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-simple-query-string-query" + }, + "description": "Returns documents based on a provided query string, using a parser with a limited but fault-tolerant syntax.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringQuery" + } + ] }, "span_containing": { - "$ref": "#/components/schemas/_types.query_dsl.SpanContainingQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-containing-query" + }, + "description": "Returns matches which enclose another span query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanContainingQuery" + } + ] }, "span_field_masking": { - "$ref": "#/components/schemas/_types.query_dsl.SpanFieldMaskingQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-field-masking-query" + }, + "description": "Wrapper to allow span queries to participate in composite single-field span queries by _lying_ about their search field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanFieldMaskingQuery" + } + ] }, "span_first": { - "$ref": "#/components/schemas/_types.query_dsl.SpanFirstQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-first-query" + }, + "description": "Matches spans near the beginning of a field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanFirstQuery" + } + ] }, "span_multi": { - "$ref": "#/components/schemas/_types.query_dsl.SpanMultiTermQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-multi-term-query" + }, + "description": "Allows you to wrap a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query) as a `span` query, so it can be nested.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanMultiTermQuery" + } + ] }, "span_near": { - "$ref": "#/components/schemas/_types.query_dsl.SpanNearQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-near-query" + }, + "description": "Matches spans which are near one another.\nYou can specify `slop`, the maximum number of intervening unmatched positions, as well as whether matches are required to be in-order.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanNearQuery" + } + ] }, "span_not": { - "$ref": "#/components/schemas/_types.query_dsl.SpanNotQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-not-query" + }, + "description": "Removes matches which overlap with another span query or which are within x tokens before (controlled by the parameter `pre`) or y tokens after (controlled by the parameter `post`) another span query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanNotQuery" + } + ] }, "span_or": { - "$ref": "#/components/schemas/_types.query_dsl.SpanOrQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-query" + }, + "description": "Matches the union of its span clauses.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanOrQuery" + } + ] }, "span_term": { "externalDocs": { @@ -56856,10 +60833,27 @@ "maxProperties": 1 }, "span_within": { - "$ref": "#/components/schemas/_types.query_dsl.SpanWithinQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-within-query" + }, + "description": "Returns matches which are enclosed inside another span query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanWithinQuery" + } + ] }, "sparse_vector": { - "$ref": "#/components/schemas/_types.query_dsl.SparseVectorQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-sparse-vector-query" + }, + "description": "Using input query vectors or a natural language processing model to convert a query into a list of token-weight pairs, queries against a sparse vector field.", + "x-state": "Generally available; Added in 8.15.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SparseVectorQuery" + } + ] }, "term": { "externalDocs": { @@ -56874,7 +60868,15 @@ "maxProperties": 1 }, "terms": { - "$ref": "#/components/schemas/_types.query_dsl.TermsQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-query" + }, + "description": "Returns documents that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.TermsQuery" + } + ] }, "terms_set": { "externalDocs": { @@ -56929,10 +60931,23 @@ "maxProperties": 1 }, "wrapper": { - "$ref": "#/components/schemas/_types.query_dsl.WrapperQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wrapper-query" + }, + "description": "A query that accepts any other query as base64 encoded string.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.WrapperQuery" + } + ] }, "type": { - "$ref": "#/components/schemas/_types.query_dsl.TypeQuery" + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.TypeQuery" + } + ] } }, "minProperties": 1, @@ -56961,7 +60976,12 @@ ] }, "minimum_should_match": { - "$ref": "#/components/schemas/_types.MinimumShouldMatch" + "description": "Specifies the number or percentage of `should` clauses returned documents must match.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MinimumShouldMatch" + } + ] }, "must": { "description": "The clause (query) must appear in matching documents and will contribute to the score.", @@ -57046,10 +61066,20 @@ "type": "number" }, "negative": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Query used to decrease the relevance score of matching documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "positive": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Any returned documents must match this query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } }, "required": [ @@ -57075,13 +61105,25 @@ "type": "number" }, "high_freq_operator": { - "$ref": "#/components/schemas/_types.query_dsl.Operator" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.Operator" + } + ] }, "low_freq_operator": { - "$ref": "#/components/schemas/_types.query_dsl.Operator" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.Operator" + } + ] }, "minimum_should_match": { - "$ref": "#/components/schemas/_types.MinimumShouldMatch" + "allOf": [ + { + "$ref": "#/components/schemas/_types.MinimumShouldMatch" + } + ] }, "query": { "type": "string" @@ -57118,13 +61160,33 @@ "type": "boolean" }, "operator": { - "$ref": "#/components/schemas/_types.query_dsl.CombinedFieldsOperator" + "description": "Boolean logic used to interpret text in the query value.", + "default": "or", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.CombinedFieldsOperator" + } + ] }, "minimum_should_match": { - "$ref": "#/components/schemas/_types.MinimumShouldMatch" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match" + }, + "description": "Minimum number of clauses that must match for a document to be returned.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MinimumShouldMatch" + } + ] }, "zero_terms_query": { - "$ref": "#/components/schemas/_types.query_dsl.CombinedFieldsZeroTerms" + "description": "Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter.", + "default": "none", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.CombinedFieldsZeroTerms" + } + ] } }, "required": [ @@ -57157,7 +61219,12 @@ "type": "object", "properties": { "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Filter query you wish to run. Any returned documents must match this query.\nFilter queries do not calculate relevance scores.\nTo speed up performance, Elasticsearch automatically caches frequently used filter queries.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } }, "required": [ @@ -57236,7 +61303,12 @@ "type": "object" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Name of the field used to calculate distances. This field must meet the following criteria:\nbe a `date`, `date_nanos` or `geo_point` field;\nhave an `index` mapping parameter value of `true`, which is the default;\nhave an `doc_values` mapping parameter value of `true`, which is the default.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -57266,13 +61338,28 @@ "type": "object", "properties": { "origin": { - "$ref": "#/components/schemas/_types.GeoLocation" + "description": "Date or point of origin used to calculate distances.\nIf the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.\nDate Math, such as `now-1h`, is supported.\nIf the field value is a `geo_point` field, the `origin` value must be a geopoint.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoLocation" + } + ] }, "pivot": { - "$ref": "#/components/schemas/_types.Distance" + "description": "Distance from the `origin` at which relevance scores receive half of the `boost` value.\nIf the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Distance" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Name of the field used to calculate distances. This field must meet the following criteria:\nbe a `date`, `date_nanos` or `geo_point` field;\nhave an `index` mapping parameter value of `true`, which is the default;\nhave an `doc_values` mapping parameter value of `true`, which is the default.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -57305,13 +61392,28 @@ "type": "object", "properties": { "origin": { - "$ref": "#/components/schemas/_types.DateMath" + "description": "Date or point of origin used to calculate distances.\nIf the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.\nDate Math, such as `now-1h`, is supported.\nIf the field value is a `geo_point` field, the `origin` value must be a geopoint.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateMath" + } + ] }, "pivot": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Distance from the `origin` at which relevance scores receive half of the `boost` value.\nIf the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Name of the field used to calculate distances. This field must meet the following criteria:\nbe a `date`, `date_nanos` or `geo_point` field;\nhave an `index` mapping parameter value of `true`, which is the default;\nhave an `doc_values` mapping parameter value of `true`, which is the default.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -57334,7 +61436,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Name of the field you wish to search.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -57352,7 +61459,13 @@ "type": "object", "properties": { "boost_mode": { - "$ref": "#/components/schemas/_types.query_dsl.FunctionBoostMode" + "description": "Defines how he newly computed score is combined with the score of the query", + "default": "multiply", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.FunctionBoostMode" + } + ] }, "functions": { "description": "One or more functions that compute a new score for each document returned by the query.", @@ -57370,10 +61483,21 @@ "type": "number" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "A query that determines the documents for which a new score is computed.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "score_mode": { - "$ref": "#/components/schemas/_types.query_dsl.FunctionScoreMode" + "description": "Specifies how the computed scores are combined", + "default": "multiply", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.FunctionScoreMode" + } + ] } } } @@ -57396,7 +61520,11 @@ "type": "object", "properties": { "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "weight": { "type": "number" @@ -57407,22 +61535,52 @@ "type": "object", "properties": { "exp": { - "$ref": "#/components/schemas/_types.query_dsl.DecayFunction" + "description": "Function that scores a document with a exponential decay, depending on the distance of a numeric field value of the document from an origin.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.DecayFunction" + } + ] }, "gauss": { - "$ref": "#/components/schemas/_types.query_dsl.DecayFunction" + "description": "Function that scores a document with a normal decay, depending on the distance of a numeric field value of the document from an origin.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.DecayFunction" + } + ] }, "linear": { - "$ref": "#/components/schemas/_types.query_dsl.DecayFunction" + "description": "Function that scores a document with a linear decay, depending on the distance of a numeric field value of the document from an origin.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.DecayFunction" + } + ] }, "field_value_factor": { - "$ref": "#/components/schemas/_types.query_dsl.FieldValueFactorScoreFunction" + "description": "Function allows you to use a field from a document to influence the score.\nIt’s similar to using the script_score function, however, it avoids the overhead of scripting.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.FieldValueFactorScoreFunction" + } + ] }, "random_score": { - "$ref": "#/components/schemas/_types.query_dsl.RandomScoreFunction" + "description": "Generates scores that are uniformly distributed from 0 up to but not including 1.\nIn case you want scores to be reproducible, it is possible to provide a `seed` and `field`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.RandomScoreFunction" + } + ] }, "script_score": { - "$ref": "#/components/schemas/_types.query_dsl.ScriptScoreFunction" + "description": "Enables you to wrap another query and customize the scoring of it optionally with a computation derived from other numeric field values in the doc using a script expression.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ScriptScoreFunction" + } + ] } }, "minProperties": 1, @@ -57460,7 +61618,13 @@ "type": "object", "properties": { "multi_value_mode": { - "$ref": "#/components/schemas/_types.query_dsl.MultiValueMode" + "description": "Determines how the distance is calculated when a field used for computing the decay contains multiple values.", + "default": "min", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.MultiValueMode" + } + ] } } }, @@ -57487,7 +61651,13 @@ "type": "object", "properties": { "multi_value_mode": { - "$ref": "#/components/schemas/_types.query_dsl.MultiValueMode" + "description": "Determines how the distance is calculated when a field used for computing the decay contains multiple values.", + "default": "min", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.MultiValueMode" + } + ] } } }, @@ -57505,7 +61675,13 @@ "type": "object", "properties": { "multi_value_mode": { - "$ref": "#/components/schemas/_types.query_dsl.MultiValueMode" + "description": "Determines how the distance is calculated when a field used for computing the decay contains multiple values.", + "default": "min", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.MultiValueMode" + } + ] } } }, @@ -57523,7 +61699,13 @@ "type": "object", "properties": { "multi_value_mode": { - "$ref": "#/components/schemas/_types.query_dsl.MultiValueMode" + "description": "Determines how the distance is calculated when a field used for computing the decay contains multiple values.", + "default": "min", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.MultiValueMode" + } + ] } } }, @@ -57531,7 +61713,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field to be extracted from the document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "factor": { "description": "Optional factor to multiply the field value with.", @@ -57543,7 +61730,12 @@ "type": "number" }, "modifier": { - "$ref": "#/components/schemas/_types.query_dsl.FieldValueFactorModifier" + "description": "Modifier to apply to the field value.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.FieldValueFactorModifier" + } + ] } }, "required": [ @@ -57569,7 +61761,11 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "seed": { "oneOf": [ @@ -57587,7 +61783,12 @@ "type": "object", "properties": { "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "A script that computes a score.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } }, "required": [ @@ -57598,10 +61799,20 @@ "type": "object", "properties": { "source": { - "$ref": "#/components/schemas/_types.ScriptSource" + "description": "The script source.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptSource" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The `id` for a stored script.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "params": { "description": "Specifies any named parameters that are passed into the script as variables.\nUse parameters instead of hard-coded values to decrease compile time.", @@ -57611,7 +61822,13 @@ } }, "lang": { - "$ref": "#/components/schemas/_types.ScriptLanguage" + "description": "Specifies the language the script is written in.", + "default": "painless", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptLanguage" + } + ] }, "options": { "type": "object", @@ -57645,7 +61862,12 @@ } }, "collapse": { - "$ref": "#/components/schemas/_global.search._types.FieldCollapse" + "description": "Collapses search results the values of the specified field.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.FieldCollapse" + } + ] }, "explain": { "description": "If `true`, the request returns detailed information about score computation as part of a hit.", @@ -57665,10 +61887,24 @@ "type": "number" }, "highlight": { - "$ref": "#/components/schemas/_global.search._types.Highlight" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/highlighting" + }, + "description": "Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.Highlight" + } + ] }, "track_total_hits": { - "$ref": "#/components/schemas/_global.search._types.TrackHits" + "description": "Number of hits matching the query to count accurately.\nIf `true`, the exact number of hits is returned at the cost of some performance.\nIf `false`, the response does not include the total number of hits matching the query.", + "default": "10000", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.TrackHits" + } + ] }, "indices_boost": { "externalDocs": { @@ -57714,14 +61950,25 @@ ] }, "rank": { - "$ref": "#/components/schemas/_types.RankContainer" + "description": "The Reciprocal Rank Fusion (RRF) to use.", + "x-state": "Generally available; Added in 8.8.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RankContainer" + } + ] }, "min_score": { "description": "The minimum `_score` for matching documents.\nDocuments with a lower `_score` are not included in search results or results collected by aggregations.", "type": "number" }, "post_filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Use the `post_filter` parameter to filter search results.\nThe search hits are filtered after the aggregations are calculated.\nA post filter has no impact on the aggregation results.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "profile": { "description": "Set to `true` to return detailed timing information about the execution of individual components in a search request.\nNOTE: This is a debugging tool and adds significant overhead to search execution.", @@ -57729,7 +61976,15 @@ "type": "boolean" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl" + }, + "description": "The search definition using the Query DSL.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "rescore": { "description": "Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases.", @@ -57746,7 +62001,16 @@ ] }, "retriever": { - "$ref": "#/components/schemas/_types.RetrieverContainer" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrievers" + }, + "description": "A retriever is a specification to describe top documents returned from a search.\nA retriever replaces other elements of the search API that also return top documents such as `query` and `knn`.", + "x-state": "Generally available; Added in 8.14.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RetrieverContainer" + } + ] }, "script_fields": { "description": "Retrieve a script evaluation (based on different fields) for each hit.", @@ -57756,7 +62020,12 @@ } }, "search_after": { - "$ref": "#/components/schemas/_types.SortResults" + "description": "Used to retrieve the next page of hits using a set of sort values from the previous page.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortResults" + } + ] }, "size": { "description": "The number of hits to return, which must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` property.", @@ -57764,13 +62033,34 @@ "type": "number" }, "slice": { - "$ref": "#/components/schemas/_types.SlicedScroll" + "description": "Split a scrolled search into multiple slices that can be consumed independently.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SlicedScroll" + } + ] }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results" + }, + "description": "A comma-separated list of : pairs.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] }, "_source": { - "$ref": "#/components/schemas/_global.search._types.SourceConfig" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#source-filtering" + }, + "description": "The source fields that are returned for matching documents.\nThese fields are returned in the `hits._source` property of the search response.\nIf the `stored_fields` property is specified, the `_source` property defaults to `false`.\nOtherwise, it defaults to `true`.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.SourceConfig" + } + ] }, "fields": { "description": "An array of wildcard (`*`) field patterns.\nThe request returns values for field names matching these patterns in the `hits.fields` property of the response.", @@ -57780,7 +62070,12 @@ } }, "suggest": { - "$ref": "#/components/schemas/_global.search._types.Suggester" + "description": "Defines a suggester that provides similar looking terms based on a provided text.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.Suggester" + } + ] }, "terminate_after": { "description": "The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this property to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this property for requests that target data streams with backing indices across multiple data tiers.\n\nIf set to `0` (default), the query does not terminate early.", @@ -57809,13 +62104,34 @@ "type": "boolean" }, "stored_fields": { - "$ref": "#/components/schemas/_types.Fields" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#stored-fields" + }, + "description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` property defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "pit": { - "$ref": "#/components/schemas/_global.search._types.PointInTimeReference" + "description": "Limit the search to a point in time (PIT).\nIf you provide a PIT, you cannot specify an `` in the request path.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.PointInTimeReference" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "externalDocs": { + "url": "https://www.elastic.co/docs/manage-data/data-store/mapping/define-runtime-fields-in-search-request" + }, + "description": "One or more runtime fields in the search request.\nThese fields take precedence over mapped fields with the same name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "stats": { "description": "The stats groups to associate with the search.\nEach group maintains a statistics aggregation for its associated searches.\nYou can retrieve these stats using the indices stats API.", @@ -57830,7 +62146,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to collapse the result set on", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "inner_hits": { "description": "The number of inner hits and their sort order", @@ -57851,7 +62172,11 @@ "type": "number" }, "collapse": { - "$ref": "#/components/schemas/_global.search._types.FieldCollapse" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.FieldCollapse" + } + ] } }, "required": [ @@ -57862,7 +62187,12 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The name for the particular inner hit definition in the response.\nUseful when a search request contains multiple inner hits.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "size": { "description": "The maximum number of hits to return per `inner_hits`.", @@ -57875,7 +62205,11 @@ "type": "number" }, "collapse": { - "$ref": "#/components/schemas/_global.search._types.FieldCollapse" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.FieldCollapse" + } + ] }, "docvalue_fields": { "type": "array", @@ -57887,7 +62221,11 @@ "type": "boolean" }, "highlight": { - "$ref": "#/components/schemas/_global.search._types.Highlight" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.Highlight" + } + ] }, "ignore_unmapped": { "type": "boolean" @@ -57908,13 +62246,26 @@ } }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "description": "How the inner hits should be sorted per `inner_hits`.\nBy default, inner hits are sorted by score.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] }, "_source": { - "$ref": "#/components/schemas/_global.search._types.SourceConfig" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.SourceConfig" + } + ] }, "stored_fields": { - "$ref": "#/components/schemas/_types.Fields" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "track_scores": { "default": false, @@ -57933,7 +62284,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "A wildcard pattern. The request returns values for field names matching this pattern.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "format": { "description": "The format in which the values are returned.", @@ -57956,7 +62312,11 @@ "type": "object", "properties": { "encoder": { - "$ref": "#/components/schemas/_global.search._types.HighlighterEncoder" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.HighlighterEncoder" + } + ] }, "fields": { "oneOf": [ @@ -58007,7 +62367,11 @@ "type": "number" }, "matched_fields": { - "$ref": "#/components/schemas/_types.Fields" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] } } } @@ -58017,7 +62381,11 @@ "type": "object", "properties": { "type": { - "$ref": "#/components/schemas/_global.search._types.HighlighterType" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.HighlighterType" + } + ] }, "boundary_chars": { "description": "A string that contains each boundary character.", @@ -58030,7 +62398,12 @@ "type": "number" }, "boundary_scanner": { - "$ref": "#/components/schemas/_global.search._types.BoundaryScanner" + "description": "Specifies how to break the highlighted fragments: chars, sentence, or word.\nOnly valid for the unified and fvh highlighters.\nDefaults to `sentence` for the `unified` highlighter. Defaults to `chars` for the `fvh` highlighter.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.BoundaryScanner" + } + ] }, "boundary_scanner_locale": { "description": "Controls which locale is used to search for sentence and word boundaries.\nThis parameter takes a form of a language tag, for example: `\"en-US\"`, `\"fr-FR\"`, `\"ja-JP\"`.", @@ -58042,7 +62415,13 @@ "type": "boolean" }, "fragmenter": { - "$ref": "#/components/schemas/_global.search._types.HighlighterFragmenter" + "description": "Specifies how text should be broken up in highlight snippets: `simple` or `span`.\nOnly valid for the `plain` highlighter.", + "default": "span", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.HighlighterFragmenter" + } + ] }, "fragment_size": { "description": "The size of the highlighted fragment in characters.", @@ -58053,7 +62432,12 @@ "type": "boolean" }, "highlight_query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Highlight matches for a query other than the search query.\nThis is especially useful if you use a rescore query because those are not taken into account by highlighting by default.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "max_fragment_length": { "type": "number" @@ -58079,7 +62463,13 @@ } }, "order": { - "$ref": "#/components/schemas/_global.search._types.HighlighterOrder" + "description": "Sorts highlighted fragments by score when set to `score`.\nBy default, fragments will be output in the order they appear in the field (order: `none`).\nSetting this option to `score` will output the most relevant fragments first.\nEach highlighter applies its own logic to compute relevancy scores.", + "default": "none", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.HighlighterOrder" + } + ] }, "phrase_limit": { "description": "Controls the number of matching phrases in a document that are considered.\nPrevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory.\nWhen using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory.\nOnly supported by the `fvh` highlighter.", @@ -58106,7 +62496,12 @@ "type": "boolean" }, "tags_schema": { - "$ref": "#/components/schemas/_global.search._types.HighlighterTagsSchema" + "description": "Set to `styled` to use the built-in tag schema.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.HighlighterTagsSchema" + } + ] } } }, @@ -58156,7 +62551,11 @@ "type": "object", "properties": { "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "ignore_failure": { "type": "boolean" @@ -58193,16 +62592,32 @@ "type": "object", "properties": { "_score": { - "$ref": "#/components/schemas/_types.ScoreSort" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScoreSort" + } + ] }, "_doc": { - "$ref": "#/components/schemas/_types.ScoreSort" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScoreSort" + } + ] }, "_geo_distance": { - "$ref": "#/components/schemas/_types.GeoDistanceSort" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoDistanceSort" + } + ] }, "_script": { - "$ref": "#/components/schemas/_types.ScriptSort" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptSort" + } + ] } }, "minProperties": 1, @@ -58212,7 +62627,11 @@ "type": "object", "properties": { "order": { - "$ref": "#/components/schemas/_types.SortOrder" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortOrder" + } + ] } } }, @@ -58227,22 +62646,42 @@ "type": "object", "properties": { "mode": { - "$ref": "#/components/schemas/_types.SortMode" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortMode" + } + ] }, "distance_type": { - "$ref": "#/components/schemas/_types.GeoDistanceType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoDistanceType" + } + ] }, "ignore_unmapped": { "type": "boolean" }, "order": { - "$ref": "#/components/schemas/_types.SortOrder" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortOrder" + } + ] }, "unit": { - "$ref": "#/components/schemas/_types.DistanceUnit" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DistanceUnit" + } + ] }, "nested": { - "$ref": "#/components/schemas/_types.NestedSortValue" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NestedSortValue" + } + ] } } }, @@ -58281,16 +62720,28 @@ "type": "object", "properties": { "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "max_children": { "type": "number" }, "nested": { - "$ref": "#/components/schemas/_types.NestedSortValue" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NestedSortValue" + } + ] }, "path": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -58301,19 +62752,39 @@ "type": "object", "properties": { "order": { - "$ref": "#/components/schemas/_types.SortOrder" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortOrder" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "type": { - "$ref": "#/components/schemas/_types.ScriptSortType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptSortType" + } + ] }, "mode": { - "$ref": "#/components/schemas/_types.SortMode" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortMode" + } + ] }, "nested": { - "$ref": "#/components/schemas/_types.NestedSortValue" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NestedSortValue" + } + ] } }, "required": [ @@ -58347,10 +62818,20 @@ "type": "boolean" }, "excludes": { - "$ref": "#/components/schemas/_types.Fields" + "description": "A list of fields to exclude from the returned source.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "includes": { - "$ref": "#/components/schemas/_types.Fields" + "description": "A list of fields to include in the returned source.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] } } }, @@ -58358,13 +62839,28 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The name of the vector field to search against", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "query_vector": { - "$ref": "#/components/schemas/_types.QueryVector" + "description": "The query vector", + "allOf": [ + { + "$ref": "#/components/schemas/_types.QueryVector" + } + ] }, "query_vector_builder": { - "$ref": "#/components/schemas/_types.QueryVectorBuilder" + "description": "The query vector builder. You must provide a query_vector_builder or query_vector, but not both.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.QueryVectorBuilder" + } + ] }, "k": { "description": "The final number of nearest neighbors to return as top hits", @@ -58397,10 +62893,21 @@ "type": "number" }, "inner_hits": { - "$ref": "#/components/schemas/_global.search._types.InnerHits" + "description": "If defined, each search hit will contain inner hits.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.InnerHits" + } + ] }, "rescore_vector": { - "$ref": "#/components/schemas/_types.RescoreVector" + "description": "Apply oversampling and rescoring to quantized vectors", + "x-state": "Generally available; Added in 8.18.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RescoreVector" + } + ] } }, "required": [ @@ -58417,7 +62924,11 @@ "type": "object", "properties": { "text_embedding": { - "$ref": "#/components/schemas/_types.TextEmbedding" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TextEmbedding" + } + ] } }, "minProperties": 1, @@ -58454,7 +62965,12 @@ "type": "object", "properties": { "rrf": { - "$ref": "#/components/schemas/_types.RrfRank" + "description": "The reciprocal rank fusion parameters", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RrfRank" + } + ] } }, "minProperties": 1, @@ -58497,10 +63013,18 @@ "type": "object", "properties": { "query": { - "$ref": "#/components/schemas/_global.search._types.RescoreQuery" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.RescoreQuery" + } + ] }, "learning_to_rank": { - "$ref": "#/components/schemas/_global.search._types.LearningToRank" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.LearningToRank" + } + ] } }, "minProperties": 1, @@ -58512,7 +63036,12 @@ "type": "object", "properties": { "rescore_query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "The query to use for rescoring.\nThis query is only run on the Top-K results returned by the `query` and `post_filter` phases.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "query_weight": { "description": "Relative importance of the original query versus the rescore query.", @@ -58525,7 +63054,13 @@ "type": "number" }, "score_mode": { - "$ref": "#/components/schemas/_global.search._types.ScoreMode" + "description": "Determines how scores are combined.", + "default": "total", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.ScoreMode" + } + ] } }, "required": [ @@ -58565,28 +63100,68 @@ "type": "object", "properties": { "standard": { - "$ref": "#/components/schemas/_types.StandardRetriever" + "description": "A retriever that replaces the functionality of a traditional query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.StandardRetriever" + } + ] }, "knn": { - "$ref": "#/components/schemas/_types.KnnRetriever" + "description": "A retriever that replaces the functionality of a knn search.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.KnnRetriever" + } + ] }, "rrf": { - "$ref": "#/components/schemas/_types.RRFRetriever" + "description": "A retriever that produces top documents from reciprocal rank fusion (RRF).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RRFRetriever" + } + ] }, "text_similarity_reranker": { - "$ref": "#/components/schemas/_types.TextSimilarityReranker" + "description": "A retriever that reranks the top documents based on a reranking model using the InferenceAPI", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TextSimilarityReranker" + } + ] }, "rule": { - "$ref": "#/components/schemas/_types.RuleRetriever" + "description": "A retriever that replaces the functionality of a rule query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RuleRetriever" + } + ] }, "rescorer": { - "$ref": "#/components/schemas/_types.RescorerRetriever" + "description": "A retriever that re-scores only the results produced by its child retriever.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RescorerRetriever" + } + ] }, "linear": { - "$ref": "#/components/schemas/_types.LinearRetriever" + "description": "A retriever that supports the combination of different retrievers through a weighted linear combination.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.LinearRetriever" + } + ] }, "pinned": { - "$ref": "#/components/schemas/_types.PinnedRetriever" + "description": "A pinned retriever applies pinned documents to the underlying retriever.\nThis retriever will rewrite to a PinnedQueryBuilder.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.PinnedRetriever" + } + ] } }, "minProperties": 1, @@ -58601,20 +63176,40 @@ "type": "object", "properties": { "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Defines a query to retrieve a set of top documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "search_after": { - "$ref": "#/components/schemas/_types.SortResults" + "description": "Defines a search after object parameter used for pagination.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortResults" + } + ] }, "terminate_after": { "description": "Maximum number of documents to collect for each shard.", "type": "number" }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "description": "A sort object that that specifies the order of matching documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] }, "collapse": { - "$ref": "#/components/schemas/_global.search._types.FieldCollapse" + "description": "Collapses the top documents by a specified key into a single top document per key.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.FieldCollapse" + } + ] } } } @@ -58660,10 +63255,20 @@ "type": "string" }, "query_vector": { - "$ref": "#/components/schemas/_types.QueryVector" + "description": "Query vector. Must have the same number of dimensions as the vector field you are searching against. You must provide a query_vector_builder or query_vector, but not both.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.QueryVector" + } + ] }, "query_vector_builder": { - "$ref": "#/components/schemas/_types.QueryVectorBuilder" + "description": "Defines a model to build a query vector.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.QueryVectorBuilder" + } + ] }, "k": { "description": "Number of nearest neighbors to return as top hits.", @@ -58678,7 +63283,13 @@ "type": "number" }, "rescore_vector": { - "$ref": "#/components/schemas/_types.RescoreVector" + "description": "Apply oversampling and rescoring to quantized vectors", + "x-state": "Generally available; Added in 8.18.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RescoreVector" + } + ] } }, "required": [ @@ -58737,7 +63348,12 @@ "type": "object", "properties": { "retriever": { - "$ref": "#/components/schemas/_types.RetrieverContainer" + "description": "The nested retriever which will produce the first-level results, that will later be used for reranking.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RetrieverContainer" + } + ] }, "rank_window_size": { "description": "This value determines how many documents we will consider from the nested retriever.", @@ -58791,7 +63407,12 @@ "type": "object" }, "retriever": { - "$ref": "#/components/schemas/_types.RetrieverContainer" + "description": "The retriever whose results rules should be applied to.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RetrieverContainer" + } + ] }, "rank_window_size": { "description": "This value determines the size of the individual result set.", @@ -58815,7 +63436,12 @@ "type": "object", "properties": { "retriever": { - "$ref": "#/components/schemas/_types.RetrieverContainer" + "description": "Inner retriever.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RetrieverContainer" + } + ] }, "rescore": { "oneOf": [ @@ -58866,7 +63492,11 @@ } }, "normalizer": { - "$ref": "#/components/schemas/_types.ScoreNormalizer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScoreNormalizer" + } + ] } } } @@ -58876,13 +63506,21 @@ "type": "object", "properties": { "retriever": { - "$ref": "#/components/schemas/_types.RetrieverContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.RetrieverContainer" + } + ] }, "weight": { "type": "number" }, "normalizer": { - "$ref": "#/components/schemas/_types.ScoreNormalizer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScoreNormalizer" + } + ] } }, "required": [ @@ -58908,7 +63546,12 @@ "type": "object", "properties": { "retriever": { - "$ref": "#/components/schemas/_types.RetrieverContainer" + "description": "Inner retriever.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RetrieverContainer" + } + ] }, "ids": { "type": "array", @@ -58936,10 +63579,18 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] } }, "required": [ @@ -58950,10 +63601,18 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "max": { "type": "number" @@ -58977,10 +63636,18 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "keep_alive": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } }, "required": [ @@ -59015,19 +63682,44 @@ "type": "string" }, "input_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "For type `lookup`", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "For type `lookup`", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "target_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "For type `lookup`", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "Painless script executed at query time.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "type": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFieldType" + "description": "Field type, which can be: `boolean`, `composite`, `date`, `double`, `geo_point`, `ip`,`keyword`, `long`, or `lookup`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFieldType" + } + ] } }, "required": [ @@ -59038,7 +63730,11 @@ "type": "object", "properties": { "type": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFieldType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFieldType" + } + ] } }, "required": [ @@ -59064,7 +63760,11 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "format": { "type": "string" @@ -59120,7 +63820,13 @@ "type": "number" }, "rewrite": { - "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + "description": "Number of beginning characters left unchanged when creating expansions.", + "default": "constant_score", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + } + ] }, "transpositions": { "description": "Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`).", @@ -59128,7 +63834,12 @@ "type": "boolean" }, "fuzziness": { - "$ref": "#/components/schemas/_types.Fuzziness" + "description": "Maximum edit distance allowed for matching.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fuzziness" + } + ] }, "value": { "description": "Term you wish to find in the provided field.", @@ -59173,10 +63884,21 @@ "type": "object", "properties": { "type": { - "$ref": "#/components/schemas/_types.query_dsl.GeoExecution" + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.GeoExecution" + } + ] }, "validation_method": { - "$ref": "#/components/schemas/_types.query_dsl.GeoValidationMethod" + "description": "Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.\nSet to `COERCE` to also try to infer correct latitude or longitude.", + "default": "'strict'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.GeoValidationMethod" + } + ] }, "ignore_unmapped": { "description": "Set to `true` to ignore an unmapped field and not match any documents for this query.\nSet to `false` to throw an exception if the field is not mapped.", @@ -59211,13 +63933,30 @@ "type": "object", "properties": { "distance": { - "$ref": "#/components/schemas/_types.Distance" + "description": "The radius of the circle centred on the specified location.\nPoints which fall into this circle are considered to be matches.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Distance" + } + ] }, "distance_type": { - "$ref": "#/components/schemas/_types.GeoDistanceType" + "description": "How to compute the distance.\nSet to `plane` for a faster calculation that's inaccurate on long distances and close to the poles.", + "default": "'arc'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoDistanceType" + } + ] }, "validation_method": { - "$ref": "#/components/schemas/_types.query_dsl.GeoValidationMethod" + "description": "Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.\nSet to `COERCE` to also try to infer correct latitude or longitude.", + "default": "'strict'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.GeoValidationMethod" + } + ] }, "ignore_unmapped": { "description": "Set to `true` to ignore an unmapped field and not match any documents for this query.\nSet to `false` to throw an exception if the field is not mapped.", @@ -59240,13 +63979,25 @@ "type": "object", "properties": { "geotile": { - "$ref": "#/components/schemas/_types.GeoTile" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoTile" + } + ] }, "geohash": { - "$ref": "#/components/schemas/_types.GeoHash" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoHash" + } + ] }, "geohex": { - "$ref": "#/components/schemas/_types.GeoHexCell" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoHexCell" + } + ] } }, "minProperties": 1, @@ -59263,7 +64014,12 @@ "type": "object", "properties": { "validation_method": { - "$ref": "#/components/schemas/_types.query_dsl.GeoValidationMethod" + "default": "'strict'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.GeoValidationMethod" + } + ] }, "ignore_unmapped": { "type": "boolean" @@ -59303,7 +64059,12 @@ "type": "boolean" }, "inner_hits": { - "$ref": "#/components/schemas/_global.search._types.InnerHits" + "description": "If defined, each search hit will contain inner hits.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.InnerHits" + } + ] }, "max_children": { "description": "Maximum number of child documents that match the query allowed for a returned parent document.\nIf the parent document exceeds this limit, it is excluded from the search results.", @@ -59314,13 +64075,29 @@ "type": "number" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Query you wish to run on child documents of the `type` field.\nIf a child document matches the search, the query returns the parent document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "score_mode": { - "$ref": "#/components/schemas/_types.query_dsl.ChildScoreMode" + "description": "Indicates how scores for matching child documents affect the root parent document’s relevance score.", + "default": "'none'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ChildScoreMode" + } + ] }, "type": { - "$ref": "#/components/schemas/_types.RelationName" + "description": "Name of the child relationship mapped for the `join` field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RelationName" + } + ] } }, "required": [ @@ -59357,13 +64134,28 @@ "type": "boolean" }, "inner_hits": { - "$ref": "#/components/schemas/_global.search._types.InnerHits" + "description": "If defined, each search hit will contain inner hits.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.InnerHits" + } + ] }, "parent_type": { - "$ref": "#/components/schemas/_types.RelationName" + "description": "Name of the parent relationship mapped for the `join` field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RelationName" + } + ] }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Query you wish to run on parent documents of the `parent_type` field.\nIf a parent document matches the search, the query returns its child documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "score": { "description": "Indicates whether the relevance score of a matching parent document is aggregated into its child documents.", @@ -59387,7 +64179,12 @@ "type": "object", "properties": { "values": { - "$ref": "#/components/schemas/_types.Ids" + "description": "An array of document IDs.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Ids" + } + ] } } } @@ -59418,28 +64215,66 @@ "type": "object", "properties": { "all_of": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsAllOf" + "description": "Returns matches that span a combination of other rules.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsAllOf" + } + ] }, "any_of": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsAnyOf" + "description": "Returns intervals produced by any of its sub-rules.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsAnyOf" + } + ] }, "fuzzy": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsFuzzy" + "description": "Matches terms that are similar to the provided term, within an edit distance defined by `fuzziness`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsFuzzy" + } + ] }, "match": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsMatch" + "description": "Matches analyzed text.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsMatch" + } + ] }, "prefix": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsPrefix" + "description": "Matches terms that start with a specified set of characters.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsPrefix" + } + ] }, "range": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsRange" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsRange" + } + ] }, "regexp": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsRegexp" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsRegexp" + } + ] }, "wildcard": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsWildcard" + "description": "Matches terms using a wildcard pattern.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsWildcard" + } + ] } }, "minProperties": 1, @@ -59468,7 +64303,12 @@ "type": "boolean" }, "filter": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsFilter" + "description": "Rule used to filter returned intervals.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsFilter" + } + ] } }, "required": [ @@ -59479,28 +64319,66 @@ "type": "object", "properties": { "all_of": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsAllOf" + "description": "Returns matches that span a combination of other rules.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsAllOf" + } + ] }, "any_of": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsAnyOf" + "description": "Returns intervals produced by any of its sub-rules.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsAnyOf" + } + ] }, "fuzzy": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsFuzzy" + "description": "Matches analyzed text.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsFuzzy" + } + ] }, "match": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsMatch" + "description": "Matches analyzed text.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsMatch" + } + ] }, "prefix": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsPrefix" + "description": "Matches terms that start with a specified set of characters.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsPrefix" + } + ] }, "range": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsRange" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsRange" + } + ] }, "regexp": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsRegexp" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsRegexp" + } + ] }, "wildcard": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsWildcard" + "description": "Matches terms using a wildcard pattern.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsWildcard" + } + ] } }, "minProperties": 1, @@ -59517,7 +64395,12 @@ } }, "filter": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsFilter" + "description": "Rule used to filter returned intervals.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsFilter" + } + ] } }, "required": [ @@ -59528,31 +64411,76 @@ "type": "object", "properties": { "after": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + "description": "Query used to return intervals that follow an interval from the `filter` rule.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + } + ] }, "before": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + "description": "Query used to return intervals that occur before an interval from the `filter` rule.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + } + ] }, "contained_by": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + "description": "Query used to return intervals contained by an interval from the `filter` rule.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + } + ] }, "containing": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + "description": "Query used to return intervals that contain an interval from the `filter` rule.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + } + ] }, "not_contained_by": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + "description": "Query used to return intervals that are **not** contained by an interval from the `filter` rule.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + } + ] }, "not_containing": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + "description": "Query used to return intervals that do **not** contain an interval from the `filter` rule.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + } + ] }, "not_overlapping": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + "description": "Query used to return intervals that do **not** overlap with an interval from the `filter` rule.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + } + ] }, "overlapping": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + "description": "Query used to return intervals that overlap with an interval from the `filter` rule.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "Script used to return matching documents.\nThis script must return a boolean value: `true` or `false`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } }, "minProperties": 1, @@ -59566,7 +64494,13 @@ "type": "string" }, "fuzziness": { - "$ref": "#/components/schemas/_types.Fuzziness" + "description": "Maximum edit distance allowed for matching.", + "default": "auto", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fuzziness" + } + ] }, "prefix_length": { "description": "Number of beginning characters left unchanged when creating expansions.", @@ -59583,7 +64517,12 @@ "type": "boolean" }, "use_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "If specified, match intervals from this field rather than the top-level field.\nThe `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -59612,10 +64551,20 @@ "type": "string" }, "use_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "If specified, match intervals from this field rather than the top-level field.\nThe `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "filter": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsFilter" + "description": "An optional interval filter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsFilter" + } + ] } }, "required": [ @@ -59634,7 +64583,12 @@ "type": "string" }, "use_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "If specified, match intervals from this field rather than the top-level field.\nThe `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -59665,7 +64619,12 @@ "type": "string" }, "use_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "If specified, match intervals from this field rather than the top-level field.\nThe `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } } }, @@ -59681,7 +64640,12 @@ "type": "string" }, "use_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "If specified, match intervals from this field rather than the top-level field.\nThe `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -59700,7 +64664,12 @@ "type": "string" }, "use_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "If specified, match intervals from this field rather than the top-level field.\nThe `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -59716,13 +64685,28 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The name of the vector field to search against", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "query_vector": { - "$ref": "#/components/schemas/_types.QueryVector" + "description": "The query vector", + "allOf": [ + { + "$ref": "#/components/schemas/_types.QueryVector" + } + ] }, "query_vector_builder": { - "$ref": "#/components/schemas/_types.QueryVectorBuilder" + "description": "The query vector builder. You must provide a query_vector_builder or query_vector, but not both.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.QueryVectorBuilder" + } + ] }, "num_candidates": { "description": "The number of nearest neighbor candidates to consider per shard", @@ -59751,7 +64735,13 @@ "type": "number" }, "rescore_vector": { - "$ref": "#/components/schemas/_types.RescoreVector" + "description": "Apply oversampling and rescoring to quantized vectors", + "x-state": "Generally available; Added in 8.18.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RescoreVector" + } + ] } }, "required": [ @@ -59782,10 +64772,20 @@ "type": "number" }, "fuzziness": { - "$ref": "#/components/schemas/_types.Fuzziness" + "description": "Maximum edit distance allowed for matching.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fuzziness" + } + ] }, "fuzzy_rewrite": { - "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + "description": "Method used to rewrite the query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + } + ] }, "fuzzy_transpositions": { "description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).", @@ -59803,10 +64803,21 @@ "type": "number" }, "minimum_should_match": { - "$ref": "#/components/schemas/_types.MinimumShouldMatch" + "description": "Minimum number of clauses that must match for a document to be returned.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MinimumShouldMatch" + } + ] }, "operator": { - "$ref": "#/components/schemas/_types.query_dsl.Operator" + "description": "Boolean logic used to interpret text in the query value.", + "default": "'or'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.Operator" + } + ] }, "prefix_length": { "description": "Number of beginning characters left unchanged for fuzzy matching.", @@ -59828,7 +64839,13 @@ ] }, "zero_terms_query": { - "$ref": "#/components/schemas/_types.query_dsl.ZeroTermsQuery" + "description": "Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter.", + "default": "'none'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ZeroTermsQuery" + } + ] } }, "required": [ @@ -59867,10 +64884,20 @@ "type": "string" }, "fuzziness": { - "$ref": "#/components/schemas/_types.Fuzziness" + "description": "Maximum edit distance allowed for matching.\nCan be applied to the term subqueries constructed for all terms but the final term.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fuzziness" + } + ] }, "fuzzy_rewrite": { - "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + "description": "Method used to rewrite the query.\nCan be applied to the term subqueries constructed for all terms but the final term.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + } + ] }, "fuzzy_transpositions": { "description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).\nCan be applied to the term subqueries constructed for all terms but the final term.", @@ -59883,10 +64910,21 @@ "type": "number" }, "minimum_should_match": { - "$ref": "#/components/schemas/_types.MinimumShouldMatch" + "description": "Minimum number of clauses that must match for a document to be returned.\nApplied to the constructed bool query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MinimumShouldMatch" + } + ] }, "operator": { - "$ref": "#/components/schemas/_types.query_dsl.Operator" + "description": "Boolean logic used to interpret text in the query value.\nApplied to the constructed bool query.", + "default": "'or'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.Operator" + } + ] }, "prefix_length": { "description": "Number of beginning characters left unchanged for fuzzy matching.\nCan be applied to the term subqueries constructed for all terms but the final term.", @@ -59936,7 +64974,13 @@ "type": "number" }, "zero_terms_query": { - "$ref": "#/components/schemas/_types.query_dsl.ZeroTermsQuery" + "description": "Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter.", + "default": "'none'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ZeroTermsQuery" + } + ] } }, "required": [ @@ -59972,7 +65016,13 @@ "type": "number" }, "zero_terms_query": { - "$ref": "#/components/schemas/_types.query_dsl.ZeroTermsQuery" + "description": "Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter.", + "default": "none", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ZeroTermsQuery" + } + ] } }, "required": [ @@ -60052,7 +65102,12 @@ "type": "number" }, "minimum_should_match": { - "$ref": "#/components/schemas/_types.MinimumShouldMatch" + "description": "After the disjunctive query has been formed, this parameter controls the number of terms that must match.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MinimumShouldMatch" + } + ] }, "min_term_freq": { "description": "The minimum term frequency below which the terms are ignored from the input document.", @@ -60065,10 +65120,19 @@ "type": "number" }, "routing": { - "$ref": "#/components/schemas/_types.Routing" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "stop_words": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "description": "An array of stop words.\nAny word in this set is ignored.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "unlike": { "description": "Used in combination with `like` to exclude documents that match a set of terms.", @@ -60085,10 +65149,19 @@ ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "version_type": { - "$ref": "#/components/schemas/_types.VersionType" + "default": "'internal'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionType" + } + ] } }, "required": [ @@ -60122,10 +65195,20 @@ } }, "_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "ID of a document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "Index of a document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "per_field_analyzer": { "description": "Overrides the default analyzer.", @@ -60135,13 +65218,26 @@ } }, "routing": { - "$ref": "#/components/schemas/_types.Routing" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "version_type": { - "$ref": "#/components/schemas/_types.VersionType" + "default": "'internal'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionType" + } + ] } } }, @@ -60232,13 +65328,28 @@ "type": "number" }, "fields": { - "$ref": "#/components/schemas/_types.Fields" + "description": "The fields to be queried.\nDefaults to the `index.query.default_field` index settings, which in turn defaults to `*`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "fuzziness": { - "$ref": "#/components/schemas/_types.Fuzziness" + "description": "Maximum edit distance allowed for matching.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fuzziness" + } + ] }, "fuzzy_rewrite": { - "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + "description": "Method used to rewrite the query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + } + ] }, "fuzzy_transpositions": { "description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).\nCan be applied to the term subqueries constructed for all terms but the final term.", @@ -60256,10 +65367,21 @@ "type": "number" }, "minimum_should_match": { - "$ref": "#/components/schemas/_types.MinimumShouldMatch" + "description": "Minimum number of clauses that must match for a document to be returned.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MinimumShouldMatch" + } + ] }, "operator": { - "$ref": "#/components/schemas/_types.query_dsl.Operator" + "description": "Boolean logic used to interpret text in the query value.", + "default": "'or'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.Operator" + } + ] }, "prefix_length": { "description": "Number of beginning characters left unchanged for fuzzy matching.", @@ -60281,10 +65403,22 @@ "type": "number" }, "type": { - "$ref": "#/components/schemas/_types.query_dsl.TextQueryType" + "description": "How `the` multi_match query is executed internally.", + "default": "'best_fields'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.TextQueryType" + } + ] }, "zero_terms_query": { - "$ref": "#/components/schemas/_types.query_dsl.ZeroTermsQuery" + "description": "Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter.", + "default": "'none'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ZeroTermsQuery" + } + ] } }, "required": [ @@ -60318,16 +65452,37 @@ "type": "boolean" }, "inner_hits": { - "$ref": "#/components/schemas/_global.search._types.InnerHits" + "description": "If defined, each search hit will contain inner hits.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.InnerHits" + } + ] }, "path": { - "$ref": "#/components/schemas/_types.Field" + "description": "Path to the nested object you wish to search.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Query you wish to run on nested objects in the path.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "score_mode": { - "$ref": "#/components/schemas/_types.query_dsl.ChildScoreMode" + "description": "How scores for matching child objects affect the root parent document’s relevance score.", + "default": "'avg'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ChildScoreMode" + } + ] } }, "required": [ @@ -60346,7 +65501,12 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "ID of the parent document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "ignore_unmapped": { "description": "Indicates whether to ignore an unmapped `type` and not return any documents instead of an error.", @@ -60354,7 +65514,12 @@ "type": "boolean" }, "type": { - "$ref": "#/components/schemas/_types.RelationName" + "description": "Name of the child relationship mapped for the `join` field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RelationName" + } + ] } } } @@ -60380,13 +65545,28 @@ } }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field that holds the indexed queries. The field must use the `percolator` mapping type.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The ID of a stored document to percolate.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The index of a stored document to percolate.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "name": { "description": "The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified.", @@ -60397,10 +65577,20 @@ "type": "string" }, "routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "Routing used to fetch document to percolate.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "The expected version of a stored document to percolate.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] } }, "required": [ @@ -60423,7 +65613,12 @@ "type": "object", "properties": { "organic": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Any choice of query used to rank documents which will be ranked below the \"pinned\" documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } }, "required": [ @@ -60459,10 +65654,20 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The unique document ID.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The index that contains the document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] } }, "required": [ @@ -60478,7 +65683,12 @@ "type": "object", "properties": { "rewrite": { - "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + "description": "Method used to rewrite the query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + } + ] }, "value": { "description": "Beginning characters of terms you wish to find in the provided field.", @@ -60525,10 +65735,21 @@ "type": "boolean" }, "default_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Default field to search if no field is provided in the query string.\nSupports wildcards (`*`).\nDefaults to the `index.query.default_field` index setting, which has a default value of `*`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "default_operator": { - "$ref": "#/components/schemas/_types.query_dsl.Operator" + "description": "Default boolean logic used to interpret text in the query string if no operators are specified.", + "default": "'or'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.Operator" + } + ] }, "enable_position_increments": { "description": "If `true`, enable position increments in queries constructed from a `query_string` search.", @@ -60547,7 +65768,12 @@ } }, "fuzziness": { - "$ref": "#/components/schemas/_types.Fuzziness" + "description": "Maximum edit distance allowed for fuzzy matching.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fuzziness" + } + ] }, "fuzzy_max_expansions": { "description": "Maximum number of terms to which the query expands for fuzzy matching.", @@ -60560,7 +65786,12 @@ "type": "number" }, "fuzzy_rewrite": { - "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + "description": "Method used to rewrite the query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + } + ] }, "fuzzy_transpositions": { "description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).", @@ -60578,7 +65809,12 @@ "type": "number" }, "minimum_should_match": { - "$ref": "#/components/schemas/_types.MinimumShouldMatch" + "description": "Minimum number of clauses that must match for a document to be returned.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MinimumShouldMatch" + } + ] }, "phrase_slop": { "description": "Maximum number of positions allowed between matching tokens for phrases.", @@ -60598,17 +65834,33 @@ "type": "string" }, "rewrite": { - "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + "description": "Method used to rewrite the query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + } + ] }, "tie_breaker": { "description": "How to combine the queries generated from the individual search terms in the resulting `dis_max` query.", "type": "number" }, "time_zone": { - "$ref": "#/components/schemas/_types.TimeZone" + "description": "Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TimeZone" + } + ] }, "type": { - "$ref": "#/components/schemas/_types.query_dsl.TextQueryType" + "description": "Determines how the query matches and scores documents.", + "default": "'best_fields'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.TextQueryType" + } + ] } }, "required": [ @@ -60648,10 +65900,20 @@ "type": "object", "properties": { "format": { - "$ref": "#/components/schemas/_types.DateFormat" + "description": "Date format used to convert `date` values in the query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateFormat" + } + ] }, "time_zone": { - "$ref": "#/components/schemas/_types.TimeZone" + "description": "Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TimeZone" + } + ] } } } @@ -60669,7 +65931,13 @@ "type": "object", "properties": { "relation": { - "$ref": "#/components/schemas/_types.query_dsl.RangeRelation" + "description": "Indicates how the range query matches values for `range` fields.", + "default": "intersects", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.RangeRelation" + } + ] }, "gt": { "description": "Greater than.", @@ -60708,10 +65976,20 @@ "type": "object", "properties": { "format": { - "$ref": "#/components/schemas/_types.DateFormat" + "description": "Date format used to convert `date` values in the query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateFormat" + } + ] }, "time_zone": { - "$ref": "#/components/schemas/_types.TimeZone" + "description": "Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TimeZone" + } + ] } } } @@ -60726,19 +66004,45 @@ "type": "object", "properties": { "relation": { - "$ref": "#/components/schemas/_types.query_dsl.RangeRelation" + "description": "Indicates how the range query matches values for `range` fields.", + "default": "intersects", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.RangeRelation" + } + ] }, "gt": { - "$ref": "#/components/schemas/_types.DateMath" + "description": "Greater than.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateMath" + } + ] }, "gte": { - "$ref": "#/components/schemas/_types.DateMath" + "description": "Greater than or equal to.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateMath" + } + ] }, "lt": { - "$ref": "#/components/schemas/_types.DateMath" + "description": "Less than.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateMath" + } + ] }, "lte": { - "$ref": "#/components/schemas/_types.DateMath" + "description": "Less than or equal to.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateMath" + } + ] } } } @@ -60763,7 +66067,13 @@ "type": "object", "properties": { "relation": { - "$ref": "#/components/schemas/_types.query_dsl.RangeRelation" + "description": "Indicates how the range query matches values for `range` fields.", + "default": "intersects", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.RangeRelation" + } + ] }, "gt": { "description": "Greater than.", @@ -60804,7 +66114,13 @@ "type": "object", "properties": { "relation": { - "$ref": "#/components/schemas/_types.query_dsl.RangeRelation" + "description": "Indicates how the range query matches values for `range` fields.", + "default": "intersects", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.RangeRelation" + } + ] }, "gt": { "description": "Greater than.", @@ -60835,19 +66151,44 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "`rank_feature` or `rank_features` field used to boost relevance scores.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "saturation": { - "$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunctionSaturation" + "description": "Saturation function used to boost relevance scores based on the value of the rank feature `field`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunctionSaturation" + } + ] }, "log": { - "$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunctionLogarithm" + "description": "Logarithmic function used to boost relevance scores based on the value of the rank feature `field`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunctionLogarithm" + } + ] }, "linear": { - "$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunctionLinear" + "description": "Linear function used to boost relevance scores based on the value of the rank feature `field`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunctionLinear" + } + ] }, "sigmoid": { - "$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunctionSigmoid" + "description": "Sigmoid function used to boost relevance scores based on the value of the rank feature `field`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunctionSigmoid" + } + ] } }, "required": [ @@ -60952,7 +66293,12 @@ "type": "number" }, "rewrite": { - "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + "description": "Method used to rewrite the query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + } + ] }, "value": { "description": "Regular expression for terms you wish to find in the provided field.", @@ -60974,7 +66320,11 @@ "type": "object", "properties": { "organic": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "ruleset_ids": { "oneOf": [ @@ -61012,7 +66362,12 @@ "type": "object", "properties": { "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "Contains a script to run as a query.\nThis script must return a boolean value, `true` or `false`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } }, "required": [ @@ -61034,10 +66389,20 @@ "type": "number" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Query used to return documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "Script used to compute the score of documents returned by the query.\nImportant: final relevance scores from the `script_score` query cannot be negative.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } }, "required": [ @@ -61110,7 +66475,13 @@ "type": "boolean" }, "default_operator": { - "$ref": "#/components/schemas/_types.query_dsl.Operator" + "description": "Default boolean logic used to interpret text in the query string if no operators are specified.", + "default": "'or'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.Operator" + } + ] }, "fields": { "description": "Array of fields you wish to search.\nAccepts wildcard expressions.\nYou also can boost relevance scores for matches to particular fields using a caret (`^`) notation.\nDefaults to the `index.query.default_field index` setting, which has a default value of `*`.", @@ -61120,7 +66491,13 @@ } }, "flags": { - "$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringFlags" + "description": "List of enabled operators for the simple query string syntax.", + "default": "ALL", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringFlags" + } + ] }, "fuzzy_max_expansions": { "description": "Maximum number of terms to which the query expands for fuzzy matching.", @@ -61142,7 +66519,12 @@ "type": "boolean" }, "minimum_should_match": { - "$ref": "#/components/schemas/_types.MinimumShouldMatch" + "description": "Minimum number of clauses that must match for a document to be returned.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MinimumShouldMatch" + } + ] }, "query": { "description": "Query string in the simple query string syntax you wish to parse and use for search.", @@ -61205,10 +66587,20 @@ "type": "object", "properties": { "big": { - "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + "description": "Can be any span query.\nMatching spans from `big` that contain matches from `little` are returned.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + } + ] }, "little": { - "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + "description": "Can be any span query.\nMatching spans from `big` that contain matches from `little` are returned.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + } + ] } }, "required": [ @@ -61222,28 +66614,67 @@ "type": "object", "properties": { "span_containing": { - "$ref": "#/components/schemas/_types.query_dsl.SpanContainingQuery" + "description": "Accepts a list of span queries, but only returns those spans which also match a second span query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanContainingQuery" + } + ] }, "span_field_masking": { - "$ref": "#/components/schemas/_types.query_dsl.SpanFieldMaskingQuery" + "description": "Allows queries like `span_near` or `span_or` across different fields.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanFieldMaskingQuery" + } + ] }, "span_first": { - "$ref": "#/components/schemas/_types.query_dsl.SpanFirstQuery" + "description": "Accepts another span query whose matches must appear within the first N positions of the field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanFirstQuery" + } + ] }, "span_gap": { - "$ref": "#/components/schemas/_types.query_dsl.SpanGapQuery" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanGapQuery" + } + ] }, "span_multi": { - "$ref": "#/components/schemas/_types.query_dsl.SpanMultiTermQuery" + "description": "Wraps a `term`, `range`, `prefix`, `wildcard`, `regexp`, or `fuzzy` query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanMultiTermQuery" + } + ] }, "span_near": { - "$ref": "#/components/schemas/_types.query_dsl.SpanNearQuery" + "description": "Accepts multiple span queries whose matches must be within the specified distance of each other, and possibly in the same order.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanNearQuery" + } + ] }, "span_not": { - "$ref": "#/components/schemas/_types.query_dsl.SpanNotQuery" + "description": "Wraps another span query, and excludes any documents which match that query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanNotQuery" + } + ] }, "span_or": { - "$ref": "#/components/schemas/_types.query_dsl.SpanOrQuery" + "description": "Combines multiple span queries and returns documents which match any of the specified queries.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanOrQuery" + } + ] }, "span_term": { "description": "The equivalent of the `term` query but for use with other span queries.", @@ -61255,7 +66686,12 @@ "maxProperties": 1 }, "span_within": { - "$ref": "#/components/schemas/_types.query_dsl.SpanWithinQuery" + "description": "The result from a single span query is returned as long is its span falls within the spans returned by a list of other span queries.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanWithinQuery" + } + ] } }, "minProperties": 1, @@ -61270,10 +66706,18 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + } + ] } }, "required": [ @@ -61296,7 +66740,12 @@ "type": "number" }, "match": { - "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + "description": "Can be any other span type query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + } + ] } }, "required": [ @@ -61324,7 +66773,12 @@ "type": "object", "properties": { "match": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Should be a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } }, "required": [ @@ -61376,10 +66830,20 @@ "type": "number" }, "exclude": { - "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + "description": "Span query whose matches must not overlap those returned.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + } + ] }, "include": { - "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + "description": "Span query whose matches are filtered.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + } + ] }, "post": { "description": "The number of tokens after the include span that can’t have overlap with the exclude span.", @@ -61430,7 +66894,11 @@ "type": "object", "properties": { "value": { - "$ref": "#/components/schemas/_types.FieldValue" + "allOf": [ + { + "$ref": "#/components/schemas/_types.FieldValue" + } + ] } }, "required": [ @@ -61448,10 +66916,20 @@ "type": "object", "properties": { "big": { - "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + "description": "Can be any span query.\nMatching spans from `little` that are enclosed within `big` are returned.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + } + ] }, "little": { - "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + "description": "Can be any span query.\nMatching spans from `little` that are enclosed within `big` are returned.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + } + ] } }, "required": [ @@ -61475,7 +66953,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The name of the field that contains the token-weight pairs to be searched against.\nThis field must be a mapped sparse_vector field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "query": { "description": "The query text you want to use for search.\nIf inference_id is specified, query must also be specified.", @@ -61487,7 +66970,13 @@ "type": "boolean" }, "pruning_config": { - "$ref": "#/components/schemas/_types.TokenPruningConfig" + "description": "Optional pruning configuration.\nIf enabled, this will omit non-significant tokens from the query in order to improve query performance.\nThis is only used if prune is set to true.\nIf prune is set to true but pruning_config is not specified, default values will be used.", + "x-state": "Generally available; Added in 8.15.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TokenPruningConfig" + } + ] } }, "required": [ @@ -61505,7 +66994,12 @@ } }, "inference_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The inference ID to use to convert the query text into token-weight pairs.\nIt must be the same inference ID that was used to create the tokens from the input text.\nOnly one of inference_id and query_vector is allowed.\nIf inference_id is specified, query must also be specified.\nOnly one of inference_id or query_vector may be supplied in a request.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] } }, "minProperties": 1, @@ -61544,7 +67038,12 @@ "type": "object", "properties": { "value": { - "$ref": "#/components/schemas/_types.FieldValue" + "description": "Term you wish to find in the provided field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.FieldValue" + } + ] }, "case_insensitive": { "description": "Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.\nWhen `false`, the case sensitivity of matching depends on the underlying field’s mapping.", @@ -61578,13 +67077,29 @@ "type": "object", "properties": { "minimum_should_match": { - "$ref": "#/components/schemas/_types.MinimumShouldMatch" + "description": "Specification describing number of matching terms required to return a document.", + "x-state": "Generally available; Added in 8.10.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MinimumShouldMatch" + } + ] }, "minimum_should_match_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Numeric field containing the number of matching terms required to return a document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "minimum_should_match_script": { - "$ref": "#/components/schemas/_types.Script" + "description": "Custom script containing the number of matching terms required to return a document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "terms": { "description": "Array of terms you wish to find in the provided field.", @@ -61617,7 +67132,13 @@ "type": "string" }, "pruning_config": { - "$ref": "#/components/schemas/_types.TokenPruningConfig" + "description": "Token pruning configurations", + "x-state": "Technical preview; Added in 8.13.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TokenPruningConfig" + } + ] } }, "required": [ @@ -61656,7 +67177,12 @@ ] }, "pruning_config": { - "$ref": "#/components/schemas/_types.TokenPruningConfig" + "description": "Token pruning configurations", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TokenPruningConfig" + } + ] } }, "required": [ @@ -61679,7 +67205,12 @@ "type": "boolean" }, "rewrite": { - "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + "description": "Method used to rewrite the query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + } + ] }, "value": { "description": "Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set.", @@ -61758,17 +67289,32 @@ "type": "number" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field on which to run the aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "format": { "description": "The date format used to format `key_as_string` in the response.\nIf no `format` is specified, the first date format specified in the field mapping is used.", "type": "string" }, "minimum_interval": { - "$ref": "#/components/schemas/_types.aggregations.MinimumInterval" + "description": "The minimum rounding interval.\nThis can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower than `minimum_interval`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MinimumInterval" + } + ] }, "missing": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "offset": { "description": "Time zone specified as a ISO 8601 UTC offset.", @@ -61781,10 +67327,19 @@ } }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "time_zone": { - "$ref": "#/components/schemas/_types.TimeZone" + "description": "Time zone ID.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TimeZone" + } + ] } } } @@ -61830,13 +67385,27 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field on which to run the aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "missing": { - "$ref": "#/components/schemas/_types.aggregations.Missing" + "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.Missing" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } } }, @@ -61879,7 +67448,13 @@ "type": "string" }, "gap_policy": { - "$ref": "#/components/schemas/_types.aggregations.GapPolicy" + "description": "Policy to apply when gaps are found in the data.", + "default": "skip", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GapPolicy" + } + ] } } } @@ -61902,7 +67477,12 @@ "type": "object", "properties": { "buckets_path": { - "$ref": "#/components/schemas/_types.aggregations.BucketsPath" + "description": "Path to the buckets that contain one set of values to correlate.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsPath" + } + ] } } } @@ -61941,7 +67521,13 @@ "type": "number" }, "execution_hint": { - "$ref": "#/components/schemas/_types.aggregations.TDigestExecutionHint" + "description": "The default implementation of TDigest is optimized for performance, scaling to millions or even billions of sample values while maintaining acceptable accuracy levels (close to 1% relative error for millions of samples in some cases).\nTo use an implementation optimized for accuracy, set this parameter to high_accuracy instead.", + "default": "default", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TDigestExecutionHint" + } + ] } } } @@ -61963,7 +67549,12 @@ "type": "object", "properties": { "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "The script to run for this aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } } } @@ -61978,7 +67569,12 @@ "type": "object", "properties": { "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "The script to run for this aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } } } @@ -61997,14 +67593,25 @@ "type": "number" }, "gap_policy": { - "$ref": "#/components/schemas/_types.aggregations.GapPolicy" + "description": "The policy to apply when gaps are found in the data.", + "default": "skip", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GapPolicy" + } + ] }, "size": { "description": "The number of buckets to return.\nDefaults to all buckets of the parent aggregation.", "type": "number" }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "description": "The list of fields to sort on.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] } } } @@ -62051,7 +67658,12 @@ "type": "object", "properties": { "function": { - "$ref": "#/components/schemas/_types.aggregations.BucketCorrelationFunction" + "description": "The correlation function to execute.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketCorrelationFunction" + } + ] } }, "required": [ @@ -62064,7 +67676,12 @@ "type": "object", "properties": { "count_correlation": { - "$ref": "#/components/schemas/_types.aggregations.BucketCorrelationFunctionCountCorrelation" + "description": "The configuration to calculate a count correlation. This function is designed for determining the correlation of a term value and a given metric.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketCorrelationFunctionCountCorrelation" + } + ] } }, "required": [ @@ -62075,7 +67692,12 @@ "type": "object", "properties": { "indicator": { - "$ref": "#/components/schemas/_types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator" + "description": "The indicator with which to correlate the configured `bucket_path` values.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator" + } + ] } }, "required": [ @@ -62126,7 +67748,12 @@ "type": "boolean" }, "execution_hint": { - "$ref": "#/components/schemas/_types.aggregations.CardinalityExecutionMode" + "description": "Mechanism by which cardinality aggregations is run.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CardinalityExecutionMode" + } + ] } } } @@ -62152,7 +67779,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The semi-structured text field to categorize.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "max_unique_tokens": { "description": "The maximum number of unique tokens at any position up to max_matched_tokens. Must be larger than 1.\nSmaller values use less memory and create fewer categories. Larger values will use more memory and\ncreate narrower categories. Max allowed value is 100.", @@ -62177,7 +67809,15 @@ } }, "categorization_analyzer": { - "$ref": "#/components/schemas/_types.aggregations.CategorizeTextAnalyzer" + "externalDocs": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-analyze" + }, + "description": "The categorization analyzer specifies how the text is analyzed and tokenized before being categorized.\nThe syntax is very similar to that used to define the analyzer in the analyze API. This property\ncannot be used at the same time as `categorization_filters`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CategorizeTextAnalyzer" + } + ] }, "shard_size": { "description": "The number of categorization buckets to return from each shard before merging all the results.", @@ -62242,7 +67882,12 @@ "type": "object", "properties": { "type": { - "$ref": "#/components/schemas/_types.RelationName" + "description": "The child type that should be selected.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RelationName" + } + ] } } } @@ -62257,7 +67902,12 @@ "type": "object", "properties": { "after": { - "$ref": "#/components/schemas/_types.aggregations.CompositeAggregateKey" + "description": "When paginating, use the `after_key` value returned in the previous response to retrieve the next page.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CompositeAggregateKey" + } + ] }, "size": { "description": "The number of composite buckets that should be returned.", @@ -62282,16 +67932,36 @@ "type": "object", "properties": { "terms": { - "$ref": "#/components/schemas/_types.aggregations.CompositeTermsAggregation" + "description": "A terms aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CompositeTermsAggregation" + } + ] }, "histogram": { - "$ref": "#/components/schemas/_types.aggregations.CompositeHistogramAggregation" + "description": "A histogram aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CompositeHistogramAggregation" + } + ] }, "date_histogram": { - "$ref": "#/components/schemas/_types.aggregations.CompositeDateHistogramAggregation" + "description": "A date histogram aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CompositeDateHistogramAggregation" + } + ] }, "geotile_grid": { - "$ref": "#/components/schemas/_types.aggregations.CompositeGeoTileGridAggregation" + "description": "A geotile grid aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CompositeGeoTileGridAggregation" + } + ] } } }, @@ -62309,22 +67979,44 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Either `field` or `script` must be present", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "missing_bucket": { "type": "boolean" }, "missing_order": { - "$ref": "#/components/schemas/_types.aggregations.MissingOrder" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MissingOrder" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "Either `field` or `script` must be present", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "value_type": { - "$ref": "#/components/schemas/_types.aggregations.ValueType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ValueType" + } + ] }, "order": { - "$ref": "#/components/schemas/_types.SortOrder" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortOrder" + } + ] } } }, @@ -62381,16 +68073,34 @@ "type": "string" }, "calendar_interval": { - "$ref": "#/components/schemas/_types.DurationLarge" + "description": "Either `calendar_interval` or `fixed_interval` must be present", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationLarge" + } + ] }, "fixed_interval": { - "$ref": "#/components/schemas/_types.DurationLarge" + "description": "Either `calendar_interval` or `fixed_interval` must be present", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationLarge" + } + ] }, "offset": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "time_zone": { - "$ref": "#/components/schemas/_types.TimeZone" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TimeZone" + } + ] } } } @@ -62408,7 +68118,11 @@ "type": "number" }, "bounds": { - "$ref": "#/components/schemas/_types.GeoBounds" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoBounds" + } + ] } } } @@ -62443,39 +68157,84 @@ "type": "object", "properties": { "calendar_interval": { - "$ref": "#/components/schemas/_types.aggregations.CalendarInterval" + "description": "Calendar-aware interval.\nCan be specified using the unit name, such as `month`, or as a single unit quantity, such as `1M`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CalendarInterval" + } + ] }, "extended_bounds": { - "$ref": "#/components/schemas/_types.aggregations.ExtendedBoundsFieldDateMath" + "description": "Enables extending the bounds of the histogram beyond the data itself.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ExtendedBoundsFieldDateMath" + } + ] }, "hard_bounds": { - "$ref": "#/components/schemas/_types.aggregations.ExtendedBoundsFieldDateMath" + "description": "Limits the histogram to specified bounds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ExtendedBoundsFieldDateMath" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The date field whose values are use to build a histogram.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "fixed_interval": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "format": { "description": "The date format used to format `key_as_string` in the response.\nIf no `format` is specified, the first date format specified in the field mapping is used.", "type": "string" }, "interval": { - "$ref": "#/components/schemas/_types.Duration" + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "min_doc_count": { "description": "Only returns buckets that have `min_doc_count` number of documents.\nBy default, all buckets between the first bucket that matches documents and the last one are returned.", "type": "number" }, "missing": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "offset": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Changes the start value of each bucket by the specified positive (`+`) or negative offset (`-`) duration.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "order": { - "$ref": "#/components/schemas/_types.aggregations.AggregateOrder" + "description": "The sort order of the returned buckets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.AggregateOrder" + } + ] }, "params": { "type": "object", @@ -62484,10 +68243,19 @@ } }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "time_zone": { - "$ref": "#/components/schemas/_types.TimeZone" + "description": "Time zone used for bucketing and rounding.\nDefaults to Coordinated Universal Time (UTC).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TimeZone" + } + ] }, "keyed": { "description": "Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array.", @@ -62522,10 +68290,20 @@ "type": "object", "properties": { "max": { - "$ref": "#/components/schemas/_types.aggregations.FieldDateMath" + "description": "Maximum value for the bound.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.FieldDateMath" + } + ] }, "min": { - "$ref": "#/components/schemas/_types.aggregations.FieldDateMath" + "description": "Minimum value for the bound.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.FieldDateMath" + } + ] } } }, @@ -62572,14 +68350,24 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The date field whose values are use to build ranges.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "format": { "description": "The date format used to format `from` and `to` in the response.", "type": "string" }, "missing": { - "$ref": "#/components/schemas/_types.aggregations.Missing" + "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.Missing" + } + ] }, "ranges": { "description": "Array of date ranges.", @@ -62589,7 +68377,12 @@ } }, "time_zone": { - "$ref": "#/components/schemas/_types.TimeZone" + "description": "Time zone used to convert dates from another time zone to UTC.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TimeZone" + } + ] }, "keyed": { "description": "Set to `true` to associate a unique string key with each bucket and returns the ranges as a hash rather than an array.", @@ -62603,14 +68396,24 @@ "type": "object", "properties": { "from": { - "$ref": "#/components/schemas/_types.aggregations.FieldDateMath" + "description": "Start of the range (inclusive).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.FieldDateMath" + } + ] }, "key": { "description": "Custom key to return the range with.", "type": "string" }, "to": { - "$ref": "#/components/schemas/_types.aggregations.FieldDateMath" + "description": "End of the range (exclusive).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.FieldDateMath" + } + ] } } }, @@ -62633,7 +68436,13 @@ "type": "object", "properties": { "execution_hint": { - "$ref": "#/components/schemas/_types.aggregations.SamplerAggregationExecutionHint" + "description": "The type of value used for de-duplication.", + "default": "global_ordinals", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.SamplerAggregationExecutionHint" + } + ] }, "max_docs_per_value": { "description": "Limits how many documents are permitted per choice of de-duplicating value.", @@ -62641,7 +68450,11 @@ "type": "number" }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "shard_size": { "description": "Limits how many top-scoring documents are collected in the sample processed on each shard.", @@ -62649,7 +68462,12 @@ "type": "number" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field used to provide values used for de-duplication.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } } } @@ -62721,7 +68539,12 @@ "type": "number" }, "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Query that filters documents from analysis.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } }, "required": [ @@ -62732,13 +68555,27 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "exclude": { - "$ref": "#/components/schemas/_types.aggregations.TermsExclude" + "description": "Values to exclude.\nCan be regular expression strings or arrays of strings of exact terms.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsExclude" + } + ] }, "include": { - "$ref": "#/components/schemas/_types.aggregations.TermsInclude" + "description": "Values to include.\nCan be regular expression strings or arrays of strings of exact terms.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsInclude" + } + ] } }, "required": [ @@ -62800,7 +68637,12 @@ "type": "object", "properties": { "filters": { - "$ref": "#/components/schemas/_types.aggregations.BucketsQueryContainer" + "description": "Collection of queries from which to build buckets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsQueryContainer" + } + ] }, "other_bucket": { "description": "Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters.", @@ -62866,7 +68708,11 @@ "type": "number" }, "location": { - "$ref": "#/components/schemas/_types.GeoLocation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoLocation" + } + ] } } } @@ -62881,13 +68727,29 @@ "type": "object", "properties": { "distance_type": { - "$ref": "#/components/schemas/_types.GeoDistanceType" + "description": "The distance calculation type.", + "default": "arc", + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoDistanceType" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "A field of type `geo_point` used to evaluate the distance.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "origin": { - "$ref": "#/components/schemas/_types.GeoLocation" + "description": "The origin used to evaluate the distance.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoLocation" + } + ] }, "ranges": { "description": "An array of ranges used to bucket documents.", @@ -62897,7 +68759,13 @@ } }, "unit": { - "$ref": "#/components/schemas/_types.DistanceUnit" + "description": "The distance unit.", + "default": "m", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DistanceUnit" + } + ] } } } @@ -62945,13 +68813,29 @@ "type": "object", "properties": { "bounds": { - "$ref": "#/components/schemas/_types.GeoBounds" + "description": "The bounding box to filter the points in each bucket.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoBounds" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing indexed `geo_point` or `geo_shape` values.\nIf the field contains an array, `geohash_grid` aggregates all array values.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "precision": { - "$ref": "#/components/schemas/_types.GeoHashPrecision" + "description": "The string length of the geohashes used to define cells/buckets in the results.", + "default": "5", + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoHashPrecision" + } + ] }, "shard_size": { "description": "Allows for more accurate counting of the top cells returned in the final result the aggregation.\nDefaults to returning `max(10,(size x number-of-shards))` buckets from each shard.", @@ -62981,17 +68865,33 @@ "type": "object", "properties": { "point": { - "$ref": "#/components/schemas/_types.aggregations.GeoLinePoint" + "description": "The name of the geo_point field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GeoLinePoint" + } + ] }, "sort": { - "$ref": "#/components/schemas/_types.aggregations.GeoLineSort" + "description": "The name of the numeric field to use as the sort key for ordering the points.\nWhen the `geo_line` aggregation is nested inside a `time_series` aggregation, this field defaults to `@timestamp`, and any other value will result in error.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GeoLineSort" + } + ] }, "include_sort": { "description": "When `true`, returns an additional array of the sort values in the feature properties.", "type": "boolean" }, "sort_order": { - "$ref": "#/components/schemas/_types.SortOrder" + "description": "The order in which the line is sorted (ascending or descending).", + "default": "asc", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortOrder" + } + ] }, "size": { "description": "The maximum length of the line represented in the aggregation.\nValid sizes are between 1 and 10000.", @@ -63008,7 +68908,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The name of the geo_point field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -63019,7 +68924,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The name of the numeric field to use as the sort key for ordering the points.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -63035,10 +68945,21 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing indexed `geo_point` or `geo_shape` values.\nIf the field contains an array, `geotile_grid` aggregates all array values.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "precision": { - "$ref": "#/components/schemas/_types.GeoTilePrecision" + "description": "Integer zoom of the key used to define cells/buckets in the results.\nValues outside of the range [0,29] will be rejected.", + "default": "7", + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoTilePrecision" + } + ] }, "shard_size": { "description": "Allows for more accurate counting of the top cells returned in the final result the aggregation.\nDefaults to returning `max(10,(size x number-of-shards))` buckets from each shard.", @@ -63050,7 +68971,12 @@ "type": "number" }, "bounds": { - "$ref": "#/components/schemas/_types.GeoBounds" + "description": "A bounding box to filter the geo-points or geo-shapes in each bucket.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoBounds" + } + ] } } } @@ -63068,7 +68994,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing indexed `geo_point` or `geo_shape` values.\nIf the field contains an array, `geohex_grid` aggregates all array values.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "precision": { "description": "Integer zoom of the key used to defined cells or buckets\nin the results. Value should be between 0-15.", @@ -63076,7 +69007,12 @@ "type": "number" }, "bounds": { - "$ref": "#/components/schemas/_types.GeoBounds" + "description": "Bounding box used to filter the geo-points in each bucket.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoBounds" + } + ] }, "size": { "description": "Maximum number of buckets to return.", @@ -63113,13 +69049,28 @@ "type": "object", "properties": { "extended_bounds": { - "$ref": "#/components/schemas/_types.aggregations.ExtendedBoundsdouble" + "description": "Enables extending the bounds of the histogram beyond the data itself.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ExtendedBoundsdouble" + } + ] }, "hard_bounds": { - "$ref": "#/components/schemas/_types.aggregations.ExtendedBoundsdouble" + "description": "Limits the range of buckets in the histogram.\nIt is particularly useful in the case of open data ranges that can result in a very large number of buckets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ExtendedBoundsdouble" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The name of the field to aggregate on.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "interval": { "description": "The interval for the buckets.\nMust be a positive decimal.", @@ -63138,10 +69089,19 @@ "type": "number" }, "order": { - "$ref": "#/components/schemas/_types.aggregations.AggregateOrder" + "description": "The sort order of the returned buckets.\nBy default, the returned buckets are sorted by their key ascending.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.AggregateOrder" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "format": { "type": "string" @@ -63177,7 +69137,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The date field whose values are used to build ranges.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ranges": { "description": "Array of IP ranges.", @@ -63232,7 +69197,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The IP address field to aggregation on. The field mapping type must be `ip`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "prefix_length": { "description": "Length of the network prefix. For IPv4 addresses the accepted range is [0, 32].\nFor IPv6 addresses the accepted range is [0, 128].", @@ -63274,10 +69244,20 @@ "type": "object", "properties": { "model_id": { - "$ref": "#/components/schemas/_types.Name" + "description": "The ID or alias for the trained model.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "inference_config": { - "$ref": "#/components/schemas/_types.aggregations.InferenceConfigContainer" + "description": "Contains the inference type and its options.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.InferenceConfigContainer" + } + ] } }, "required": [ @@ -63290,10 +69270,20 @@ "type": "object", "properties": { "regression": { - "$ref": "#/components/schemas/ml._types.RegressionInferenceOptions" + "description": "Regression configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.RegressionInferenceOptions" + } + ] }, "classification": { - "$ref": "#/components/schemas/ml._types.ClassificationInferenceOptions" + "description": "Classification configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ClassificationInferenceOptions" + } + ] } }, "minProperties": 1, @@ -63303,7 +69293,12 @@ "type": "object", "properties": { "results_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "num_top_feature_importance_values": { "description": "Specifies the maximum number of feature importance values per document.", @@ -63347,7 +69342,13 @@ "type": "object", "properties": { "mode": { - "$ref": "#/components/schemas/_types.SortMode" + "description": "Array value the aggregation will use for array or multi-valued fields.", + "default": "avg", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortMode" + } + ] } } } @@ -63362,7 +69363,12 @@ "type": "object", "properties": { "fields": { - "$ref": "#/components/schemas/_types.Fields" + "description": "An array of fields for computing the statistics.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "missing": { "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", @@ -63409,7 +69415,13 @@ "type": "number" }, "execution_hint": { - "$ref": "#/components/schemas/_types.aggregations.TDigestExecutionHint" + "description": "The default implementation of TDigest is optimized for performance, scaling to millions or even billions of sample values while maintaining acceptable accuracy levels (close to 1% relative error for millions of samples in some cases).\nTo use an implementation optimized for accuracy, set this parameter to high_accuracy instead.", + "default": "default", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TDigestExecutionHint" + } + ] } } } @@ -63444,10 +69456,19 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The name of the field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "missing": { - "$ref": "#/components/schemas/_types.aggregations.Missing" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.Missing" + } + ] } } } @@ -63490,7 +69511,11 @@ ] }, "settings": { - "$ref": "#/components/schemas/_types.EmptyObject" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EmptyObject" + } + ] } }, "required": [ @@ -63540,7 +69565,11 @@ ] }, "settings": { - "$ref": "#/components/schemas/_types.EmptyObject" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EmptyObject" + } + ] } }, "required": [ @@ -63565,7 +69594,11 @@ ] }, "settings": { - "$ref": "#/components/schemas/_types.aggregations.EwmaModelSettings" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.EwmaModelSettings" + } + ] } }, "required": [ @@ -63598,7 +69631,11 @@ ] }, "settings": { - "$ref": "#/components/schemas/_types.aggregations.HoltLinearModelSettings" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.HoltLinearModelSettings" + } + ] } }, "required": [ @@ -63634,7 +69671,11 @@ ] }, "settings": { - "$ref": "#/components/schemas/_types.aggregations.HoltWintersModelSettings" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.HoltWintersModelSettings" + } + ] } }, "required": [ @@ -63663,7 +69704,11 @@ "type": "number" }, "type": { - "$ref": "#/components/schemas/_types.aggregations.HoltWintersType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.HoltWintersType" + } + ] } } }, @@ -63732,10 +69777,21 @@ "type": "object", "properties": { "collect_mode": { - "$ref": "#/components/schemas/_types.aggregations.TermsAggregationCollectMode" + "description": "Specifies the strategy for data collection.", + "default": "breadth_first", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsAggregationCollectMode" + } + ] }, "order": { - "$ref": "#/components/schemas/_types.aggregations.AggregateOrder" + "description": "Specifies the sort order of the buckets.\nDefaults to sorting by descending document count.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.AggregateOrder" + } + ] }, "min_doc_count": { "description": "The minimum number of documents in a bucket for it to be returned.", @@ -63786,10 +69842,20 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "A fields from which to retrieve terms.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "missing": { - "$ref": "#/components/schemas/_types.aggregations.Missing" + "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.Missing" + } + ] } }, "required": [ @@ -63805,7 +69871,12 @@ "type": "object", "properties": { "path": { - "$ref": "#/components/schemas/_types.Field" + "description": "The path to the field of type `nested`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } } } @@ -63820,7 +69891,12 @@ "type": "object", "properties": { "method": { - "$ref": "#/components/schemas/_types.aggregations.NormalizeMethod" + "description": "The specific method to apply.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.NormalizeMethod" + } + ] } } } @@ -63846,7 +69922,12 @@ "type": "object", "properties": { "type": { - "$ref": "#/components/schemas/_types.RelationName" + "description": "The child type that should be selected.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RelationName" + } + ] } } } @@ -63881,10 +69962,20 @@ ] }, "hdr": { - "$ref": "#/components/schemas/_types.aggregations.HdrMethod" + "description": "Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.HdrMethod" + } + ] }, "tdigest": { - "$ref": "#/components/schemas/_types.aggregations.TDigest" + "description": "Sets parameters for the default TDigest algorithm used to calculate percentile ranks.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TDigest" + } + ] } } } @@ -63907,7 +69998,13 @@ "type": "number" }, "execution_hint": { - "$ref": "#/components/schemas/_types.aggregations.TDigestExecutionHint" + "description": "The default implementation of TDigest is optimized for performance, scaling to millions or even billions of sample values while maintaining acceptable accuracy levels (close to 1% relative error for millions of samples in some cases).\nTo use an implementation optimized for accuracy, set this parameter to high_accuracy instead.", + "default": "default", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TDigestExecutionHint" + } + ] } } }, @@ -63932,10 +70029,20 @@ } }, "hdr": { - "$ref": "#/components/schemas/_types.aggregations.HdrMethod" + "description": "Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.HdrMethod" + } + ] }, "tdigest": { - "$ref": "#/components/schemas/_types.aggregations.TDigest" + "description": "Sets parameters for the default TDigest algorithm used to calculate percentiles.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TDigest" + } + ] } } } @@ -63969,7 +70076,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The date field whose values are use to build ranges.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "missing": { "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", @@ -63983,7 +70095,11 @@ } }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "keyed": { "description": "Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array.", @@ -64005,13 +70121,28 @@ "type": "object", "properties": { "exclude": { - "$ref": "#/components/schemas/_types.aggregations.TermsExclude" + "description": "Terms that should be excluded from the aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsExclude" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field from which to return rare terms.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "include": { - "$ref": "#/components/schemas/_types.aggregations.TermsInclude" + "description": "Terms that should be included in the aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsInclude" + } + ] }, "max_doc_count": { "description": "The maximum number of documents a term should appear in.", @@ -64019,7 +70150,12 @@ "type": "number" }, "missing": { - "$ref": "#/components/schemas/_types.aggregations.Missing" + "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.Missing" + } + ] }, "precision": { "description": "The precision of the internal CuckooFilters.\nSmaller precision leads to better approximation, but higher memory usage.", @@ -64042,10 +70178,21 @@ "type": "object", "properties": { "unit": { - "$ref": "#/components/schemas/_types.aggregations.CalendarInterval" + "description": "The interval used to calculate the rate.\nBy default, the interval of the `date_histogram` is used.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CalendarInterval" + } + ] }, "mode": { - "$ref": "#/components/schemas/_types.aggregations.RateMode" + "description": "How the rate is calculated.", + "default": "sum", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.RateMode" + } + ] } } } @@ -64067,7 +70214,12 @@ "type": "object", "properties": { "path": { - "$ref": "#/components/schemas/_types.Field" + "description": "Defines the nested object field that should be joined back to.\nThe default is empty, which means that it joins back to the root/main document level.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } } } @@ -64127,13 +70279,28 @@ "type": "object", "properties": { "combine_script": { - "$ref": "#/components/schemas/_types.Script" + "description": "Runs once on each shard after document collection is complete.\nAllows the aggregation to consolidate the state returned from each shard.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "init_script": { - "$ref": "#/components/schemas/_types.Script" + "description": "Runs prior to any collection of documents.\nAllows the aggregation to set up any initial state.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "map_script": { - "$ref": "#/components/schemas/_types.Script" + "description": "Run once per document collected.\nIf no `combine_script` is specified, the resulting state needs to be stored in the `state` object.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "params": { "description": "A global object with script parameters for `init`, `map` and `combine` scripts.\nIt is shared between the scripts.", @@ -64143,7 +70310,12 @@ } }, "reduce_script": { - "$ref": "#/components/schemas/_types.Script" + "description": "Runs once on the coordinating node after all shards have returned their results.\nThe script is provided with access to a variable `states`, which is an array of the result of the `combine_script` on each shard.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } } } @@ -64174,28 +70346,68 @@ "type": "object", "properties": { "background_filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "chi_square": { - "$ref": "#/components/schemas/_types.aggregations.ChiSquareHeuristic" + "description": "Use Chi square, as described in \"Information Retrieval\", Manning et al., Chapter 13.5.2, as the significance score.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ChiSquareHeuristic" + } + ] }, "exclude": { - "$ref": "#/components/schemas/_types.aggregations.TermsExclude" + "description": "Terms to exclude.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsExclude" + } + ] }, "execution_hint": { - "$ref": "#/components/schemas/_types.aggregations.TermsAggregationExecutionHint" + "description": "Mechanism by which the aggregation should be executed: using field values directly or using global ordinals.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsAggregationExecutionHint" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field from which to return significant terms.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "gnd": { - "$ref": "#/components/schemas/_types.aggregations.GoogleNormalizedDistanceHeuristic" + "description": "Use Google normalized distance as described in \"The Google Similarity Distance\", Cilibrasi and Vitanyi, 2007, as the significance score.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GoogleNormalizedDistanceHeuristic" + } + ] }, "include": { - "$ref": "#/components/schemas/_types.aggregations.TermsInclude" + "description": "Terms to include.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsInclude" + } + ] }, "jlh": { - "$ref": "#/components/schemas/_types.EmptyObject" + "description": "Use JLH score as the significance score.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EmptyObject" + } + ] }, "min_doc_count": { "description": "Only return terms that are found in more than `min_doc_count` hits.", @@ -64203,13 +70415,28 @@ "type": "number" }, "mutual_information": { - "$ref": "#/components/schemas/_types.aggregations.MutualInformationHeuristic" + "description": "Use mutual information as described in \"Information Retrieval\", Manning et al., Chapter 13.5.1, as the significance score.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MutualInformationHeuristic" + } + ] }, "percentage": { - "$ref": "#/components/schemas/_types.aggregations.PercentageScoreHeuristic" + "description": "A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.PercentageScoreHeuristic" + } + ] }, "script_heuristic": { - "$ref": "#/components/schemas/_types.aggregations.ScriptedHeuristic" + "description": "Customized score, implemented via a script.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ScriptedHeuristic" + } + ] }, "shard_min_doc_count": { "description": "Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`.\nTerms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`.", @@ -64282,7 +70509,11 @@ "type": "object", "properties": { "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } }, "required": [ @@ -64298,32 +70529,72 @@ "type": "object", "properties": { "background_filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "chi_square": { - "$ref": "#/components/schemas/_types.aggregations.ChiSquareHeuristic" + "description": "Use Chi square, as described in \"Information Retrieval\", Manning et al., Chapter 13.5.2, as the significance score.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ChiSquareHeuristic" + } + ] }, "exclude": { - "$ref": "#/components/schemas/_types.aggregations.TermsExclude" + "description": "Values to exclude.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsExclude" + } + ] }, "execution_hint": { - "$ref": "#/components/schemas/_types.aggregations.TermsAggregationExecutionHint" + "description": "Determines whether the aggregation will use field values directly or global ordinals.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsAggregationExecutionHint" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field from which to return significant text.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "filter_duplicate_text": { "description": "Whether to out duplicate text to deal with noisy data.", "type": "boolean" }, "gnd": { - "$ref": "#/components/schemas/_types.aggregations.GoogleNormalizedDistanceHeuristic" + "description": "Use Google normalized distance as described in \"The Google Similarity Distance\", Cilibrasi and Vitanyi, 2007, as the significance score.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GoogleNormalizedDistanceHeuristic" + } + ] }, "include": { - "$ref": "#/components/schemas/_types.aggregations.TermsInclude" + "description": "Values to include.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsInclude" + } + ] }, "jlh": { - "$ref": "#/components/schemas/_types.EmptyObject" + "description": "Use JLH score as the significance score.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EmptyObject" + } + ] }, "min_doc_count": { "description": "Only return values that are found in more than `min_doc_count` hits.", @@ -64331,13 +70602,28 @@ "type": "number" }, "mutual_information": { - "$ref": "#/components/schemas/_types.aggregations.MutualInformationHeuristic" + "description": "Use mutual information as described in \"Information Retrieval\", Manning et al., Chapter 13.5.1, as the significance score.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MutualInformationHeuristic" + } + ] }, "percentage": { - "$ref": "#/components/schemas/_types.aggregations.PercentageScoreHeuristic" + "description": "A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.PercentageScoreHeuristic" + } + ] }, "script_heuristic": { - "$ref": "#/components/schemas/_types.aggregations.ScriptedHeuristic" + "description": "Customized score, implemented via a script.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ScriptedHeuristic" + } + ] }, "shard_min_doc_count": { "description": "Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count.\nValues will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`.", @@ -64352,7 +70638,12 @@ "type": "number" }, "source_fields": { - "$ref": "#/components/schemas/_types.Fields" + "description": "Overrides the JSON `_source` fields from which text will be analyzed.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] } } } @@ -64424,19 +70715,44 @@ "type": "object", "properties": { "collect_mode": { - "$ref": "#/components/schemas/_types.aggregations.TermsAggregationCollectMode" + "description": "Determines how child aggregations should be calculated: breadth-first or depth-first.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsAggregationCollectMode" + } + ] }, "exclude": { - "$ref": "#/components/schemas/_types.aggregations.TermsExclude" + "description": "Values to exclude.\nAccepts regular expressions and partitions.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsExclude" + } + ] }, "execution_hint": { - "$ref": "#/components/schemas/_types.aggregations.TermsAggregationExecutionHint" + "description": "Determines whether the aggregation will use field values directly or global ordinals.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsAggregationExecutionHint" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field from which to return terms.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "include": { - "$ref": "#/components/schemas/_types.aggregations.TermsInclude" + "description": "Values to include.\nAccepts regular expressions and partitions.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsInclude" + } + ] }, "min_doc_count": { "description": "Only return values that are found in more than `min_doc_count` hits.", @@ -64444,10 +70760,19 @@ "type": "number" }, "missing": { - "$ref": "#/components/schemas/_types.aggregations.Missing" + "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.Missing" + } + ] }, "missing_order": { - "$ref": "#/components/schemas/_types.aggregations.MissingOrder" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MissingOrder" + } + ] }, "missing_bucket": { "type": "boolean" @@ -64457,10 +70782,19 @@ "type": "string" }, "order": { - "$ref": "#/components/schemas/_types.aggregations.AggregateOrder" + "description": "Specifies the sort order of the buckets.\nDefaults to sorting by descending document count.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.AggregateOrder" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "shard_min_doc_count": { "description": "Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`.\nTerms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`.", @@ -64540,7 +70874,12 @@ "type": "number" }, "highlight": { - "$ref": "#/components/schemas/_global.search._types.Highlight" + "description": "Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.Highlight" + } + ] }, "script_fields": { "description": "Returns the result of one or more script evaluations for each hit.", @@ -64555,13 +70894,28 @@ "type": "number" }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "description": "Sort order of the top matching hits.\nBy default, the hits are sorted by the score of the main query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] }, "_source": { - "$ref": "#/components/schemas/_global.search._types.SourceConfig" + "description": "Selects the fields of the source that are returned.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.SourceConfig" + } + ] }, "stored_fields": { - "$ref": "#/components/schemas/_types.Fields" + "description": "Returns values for the specified stored fields (fields that use the `store` mapping option).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "track_scores": { "description": "If `true`, calculates and returns document scores, even if the scores are not used for sorting.", @@ -64590,13 +70944,29 @@ "type": "object", "properties": { "a": { - "$ref": "#/components/schemas/_types.aggregations.TestPopulation" + "description": "Test population A.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TestPopulation" + } + ] }, "b": { - "$ref": "#/components/schemas/_types.aggregations.TestPopulation" + "description": "Test population B.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TestPopulation" + } + ] }, "type": { - "$ref": "#/components/schemas/_types.aggregations.TTestType" + "description": "The type of test.", + "default": "heteroscedastic", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TTestType" + } + ] } } } @@ -64606,13 +70976,27 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to aggregate.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "A filter used to define a set of records to run unpaired t-test on.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } }, "required": [ @@ -64655,7 +71039,12 @@ "type": "number" }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "description": "The sort order of the documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] } } } @@ -64665,7 +71054,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "A field to return as a metric.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -64710,13 +71104,27 @@ "type": "string" }, "value": { - "$ref": "#/components/schemas/_types.aggregations.WeightedAverageValue" + "description": "Configuration for the field that provides the values.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.WeightedAverageValue" + } + ] }, "value_type": { - "$ref": "#/components/schemas/_types.aggregations.ValueType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ValueType" + } + ] }, "weight": { - "$ref": "#/components/schemas/_types.aggregations.WeightedAverageValue" + "description": "Configuration for the field or script that provides the weights.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.WeightedAverageValue" + } + ] } } } @@ -64726,14 +71134,23 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field from which to extract the values or weights.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "missing": { "description": "A value or weight to use if the field is missing.", "type": "number" }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } } }, @@ -64741,7 +71158,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The name of the field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "buckets": { "description": "The target number of buckets.", @@ -64757,7 +71179,11 @@ "type": "number" }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } } }, @@ -64765,10 +71191,18 @@ "type": "object", "properties": { "required_capacity": { - "$ref": "#/components/schemas/autoscaling.get_autoscaling_capacity.AutoscalingCapacity" + "allOf": [ + { + "$ref": "#/components/schemas/autoscaling.get_autoscaling_capacity.AutoscalingCapacity" + } + ] }, "current_capacity": { - "$ref": "#/components/schemas/autoscaling.get_autoscaling_capacity.AutoscalingCapacity" + "allOf": [ + { + "$ref": "#/components/schemas/autoscaling.get_autoscaling_capacity.AutoscalingCapacity" + } + ] }, "current_nodes": { "type": "array", @@ -64794,10 +71228,18 @@ "type": "object", "properties": { "node": { - "$ref": "#/components/schemas/autoscaling.get_autoscaling_capacity.AutoscalingResources" + "allOf": [ + { + "$ref": "#/components/schemas/autoscaling.get_autoscaling_capacity.AutoscalingResources" + } + ] }, "total": { - "$ref": "#/components/schemas/autoscaling.get_autoscaling_capacity.AutoscalingResources" + "allOf": [ + { + "$ref": "#/components/schemas/autoscaling.get_autoscaling_capacity.AutoscalingResources" + } + ] } }, "required": [ @@ -64824,7 +71266,11 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.NodeName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeName" + } + ] } }, "required": [ @@ -64838,7 +71284,11 @@ "type": "object", "properties": { "required_capacity": { - "$ref": "#/components/schemas/autoscaling.get_autoscaling_capacity.AutoscalingCapacity" + "allOf": [ + { + "$ref": "#/components/schemas/autoscaling.get_autoscaling_capacity.AutoscalingCapacity" + } + ] }, "reason_summary": { "type": "string" @@ -64905,16 +71355,36 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_global.bulk.IndexOperation" + "description": "Index the specified document.\nIf the document exists, it replaces the document and increments the version.\nThe following line must contain the source data to be indexed.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.bulk.IndexOperation" + } + ] }, "create": { - "$ref": "#/components/schemas/_global.bulk.CreateOperation" + "description": "Index the specified document if it does not already exist.\nThe following line must contain the source data to be indexed.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.bulk.CreateOperation" + } + ] }, "update": { - "$ref": "#/components/schemas/_global.bulk.UpdateOperation" + "description": "Perform a partial document update.\nThe following line must contain the partial document and update options.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.bulk.UpdateOperation" + } + ] }, "delete": { - "$ref": "#/components/schemas/_global.bulk.DeleteOperation" + "description": "Remove the specified document from the index.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.bulk.DeleteOperation" + } + ] } }, "minProperties": 1, @@ -64962,25 +71432,52 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The document ID.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The name of the index or index alias to perform the action on.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "A custom value used to route operations to a specific shard.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "if_primary_term": { "type": "number" }, "if_seq_no": { - "$ref": "#/components/schemas/_types.SequenceNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SequenceNumber" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "version_type": { - "$ref": "#/components/schemas/_types.VersionType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionType" + } + ] } } }, @@ -65043,7 +71540,12 @@ "type": "boolean" }, "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "The script to run to update the document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "scripted_upsert": { "description": "Set to `true` to run the script whether or not the document exists.", @@ -65051,7 +71553,13 @@ "type": "boolean" }, "_source": { - "$ref": "#/components/schemas/_global.search._types.SourceConfig" + "description": "If `false`, source retrieval is turned off.\nYou can also specify a comma-separated list of the fields you want to retrieve.", + "default": "true", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.SourceConfig" + } + ] }, "upsert": { "description": "If the document does not already exist, the contents of `upsert` are inserted as a new document.\nIf the document exists, the `script` is run.", @@ -65083,10 +71591,19 @@ "type": "number" }, "failure_store": { - "$ref": "#/components/schemas/_global.bulk.FailureStoreStatus" + "allOf": [ + { + "$ref": "#/components/schemas/_global.bulk.FailureStoreStatus" + } + ] }, "error": { - "$ref": "#/components/schemas/_types.ErrorCause" + "description": "Additional information about the failed operation.\nThe property is returned only for failed operations.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] }, "_primary_term": { "description": "The primary term assigned to the document for the operation.\nThis property is returned only for successful operations.", @@ -65097,19 +71614,38 @@ "type": "string" }, "_seq_no": { - "$ref": "#/components/schemas/_types.SequenceNumber" + "description": "The sequence number assigned to the document for the operation.\nSequence numbers are used to ensure an older version of a document doesn't overwrite a newer version.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SequenceNumber" + } + ] }, "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "description": "Shard information for the operation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] }, "_version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "The document version associated with the operation.\nThe document version is incremented each time the document is updated.\nThis property is returned only for successful actions.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "forced_refresh": { "type": "boolean" }, "get": { - "$ref": "#/components/schemas/_types.InlineGetDictUserDefined" + "allOf": [ + { + "$ref": "#/components/schemas/_types.InlineGetDictUserDefined" + } + ] } }, "required": [ @@ -65139,13 +71675,21 @@ "type": "boolean" }, "_seq_no": { - "$ref": "#/components/schemas/_types.SequenceNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SequenceNumber" + } + ] }, "_primary_term": { "type": "number" }, "_routing": { - "$ref": "#/components/schemas/_types.Routing" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "_source": { "type": "object", @@ -65221,7 +71765,12 @@ "type": "string" }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "index alias points to", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "filter": { "description": "filter", @@ -65627,10 +72176,20 @@ "type": "object", "properties": { "epoch": { - "$ref": "#/components/schemas/_spec_utils.StringifiedEpochTimeUnitSeconds" + "description": "seconds since 1970-01-01 00:00:00", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.StringifiedEpochTimeUnitSeconds" + } + ] }, "timestamp": { - "$ref": "#/components/schemas/_types.TimeOfDay" + "description": "time in HH:MM:SS", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TimeOfDay" + } + ] }, "count": { "description": "the document count", @@ -65744,10 +72303,20 @@ "type": "object", "properties": { "epoch": { - "$ref": "#/components/schemas/_spec_utils.StringifiedEpochTimeUnitSeconds" + "description": "seconds since 1970-01-01 00:00:00", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.StringifiedEpochTimeUnitSeconds" + } + ] }, "timestamp": { - "$ref": "#/components/schemas/_types.TimeOfDay" + "description": "time in HH:MM:SS", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TimeOfDay" + } + ] }, "cluster": { "description": "cluster name", @@ -66513,7 +73082,12 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The identifier for the job.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "type": { "description": "The type of analysis that the job performs.", @@ -66524,13 +73098,28 @@ "type": "string" }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "The version of Elasticsearch when the job was created.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "source_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The name of the source index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "dest_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The name of the destination index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "description": { "description": "A description of the job.", @@ -66557,13 +73146,28 @@ "type": "string" }, "node.id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The unique identifier of the assigned node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "node.name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The name of the assigned node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "node.ephemeral_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The ephemeral identifier of the assigned node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "node.address": { "description": "The network address of the assigned node.", @@ -66632,7 +73236,12 @@ "type": "string" }, "state": { - "$ref": "#/components/schemas/ml._types.DatafeedState" + "description": "The status of the datafeed.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DatafeedState" + } + ] }, "assignment_explanation": { "description": "For started datafeeds only, contains messages relating to the selection of a node.", @@ -66882,10 +73491,20 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The anomaly detection job identifier.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "state": { - "$ref": "#/components/schemas/ml._types.JobState" + "description": "The status of the anomaly detection job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobState" + } + ] }, "opened_time": { "description": "For open jobs only, the amount of time the job has been opened.", @@ -66904,7 +73523,12 @@ "type": "string" }, "data.input_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The number of bytes of input data posted to the anomaly detection job.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "data.input_records": { "description": "The number of input documents posted to the anomaly detection job.", @@ -66959,13 +73583,28 @@ "type": "string" }, "model.bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The number of bytes of memory used by the models.\nThis is the maximum value since the last time the model was persisted.\nIf the job is closed, this value indicates the latest size.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "model.memory_status": { - "$ref": "#/components/schemas/ml._types.MemoryStatus" + "description": "The status of the mathematical models.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.MemoryStatus" + } + ] }, "model.bytes_exceeded": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The number of bytes over the high limit for memory usage at the last allocation failure.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "model.memory_limit": { "description": "The upper limit for model memory usage, checked on increasing values.", @@ -66988,7 +73627,12 @@ "type": "string" }, "model.categorization_status": { - "$ref": "#/components/schemas/ml._types.CategorizationStatus" + "description": "The status of categorization for the job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.CategorizationStatus" + } + ] }, "model.categorized_doc_count": { "description": "The number of documents that have had a field categorized.", @@ -67075,14 +73719,24 @@ "type": "string" }, "node.id": { - "$ref": "#/components/schemas/_types.NodeId" + "description": "The uniqe identifier of the assigned node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] }, "node.name": { "description": "The name of the assigned node.", "type": "string" }, "node.ephemeral_id": { - "$ref": "#/components/schemas/_types.NodeId" + "description": "The ephemeral identifier of the assigned node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] }, "node.address": { "description": "The network address of the assigned node.", @@ -67198,14 +73852,24 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The model identifier.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "created_by": { "description": "Information about the creator of the model.", "type": "string" }, "heap_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The estimated heap size to keep the model in memory.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "operations": { "description": "The estimated number of operations to use the model.\nThis number helps to measure the computational complexity of the model.", @@ -67216,10 +73880,20 @@ "type": "string" }, "create_time": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The time the model was created.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "The version of Elasticsearch when the model was created.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "description": { "description": "A description of the model.", @@ -67587,7 +74261,12 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The unique node identifier.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "pid": { "description": "The process identifier.", @@ -67606,7 +74285,12 @@ "type": "string" }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "The Elasticsearch version.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "flavor": { "description": "The Elasticsearch distribution flavor.", @@ -67625,23 +74309,48 @@ "type": "string" }, "disk.total": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The total disk space.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "disk.used": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The used disk space.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "disk.avail": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The available disk space.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "disk.used_percent": { - "$ref": "#/components/schemas/_types.Percentage" + "description": "The used disk space percentage.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Percentage" + } + ] }, "heap.current": { "description": "The used heap.", "type": "string" }, "heap.percent": { - "$ref": "#/components/schemas/_types.Percentage" + "description": "The used heap ratio.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Percentage" + } + ] }, "heap.max": { "description": "The maximum configured heap.", @@ -67652,7 +74361,12 @@ "type": "string" }, "ram.percent": { - "$ref": "#/components/schemas/_types.Percentage" + "description": "The used machine memory ratio.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Percentage" + } + ] }, "ram.max": { "description": "The total machine memory.", @@ -67663,7 +74377,12 @@ "type": "string" }, "file_desc.percent": { - "$ref": "#/components/schemas/_types.Percentage" + "description": "The used file descriptor ratio.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Percentage" + } + ] }, "file_desc.max": { "description": "The maximum number of file descriptors.", @@ -67698,7 +74417,12 @@ "type": "string" }, "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The node name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "completion.size": { "description": "The size of completion.", @@ -67987,17 +74711,32 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.NodeId" + "description": "The unique node identifier.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The node name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "component": { "description": "The component name.", "type": "string" }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "The component version.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "description": { "description": "The plugin details.", @@ -68093,26 +74832,56 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The index name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "shard": { "description": "The shard name.", "type": "string" }, "start_time": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The recovery start time.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "start_time_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The recovery start time in epoch milliseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "stop_time": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The recovery stop time.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "stop_time_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The recovery stop time in epoch milliseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "time": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The recovery time.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "type": { "description": "The recovery type.", @@ -68155,7 +74924,12 @@ "type": "string" }, "files_percent": { - "$ref": "#/components/schemas/_types.Percentage" + "description": "The ratio of files recovered.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Percentage" + } + ] }, "files_total": { "description": "The total number of files.", @@ -68170,7 +74944,12 @@ "type": "string" }, "bytes_percent": { - "$ref": "#/components/schemas/_types.Percentage" + "description": "The ratio of bytes recovered.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Percentage" + } + ] }, "bytes_total": { "description": "The total number of bytes.", @@ -68185,7 +74964,12 @@ "type": "string" }, "translog_ops_percent": { - "$ref": "#/components/schemas/_types.Percentage" + "description": "The ratio of translog operations recovered.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Percentage" + } + ] } } }, @@ -68253,7 +75037,12 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The index name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "shard": { "description": "The shard name.", @@ -68268,7 +75057,12 @@ "type": "string" }, "id": { - "$ref": "#/components/schemas/_types.NodeId" + "description": "The unique identifier of the node where it lives.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] }, "segment": { "description": "The segment name, which is derived from the segment generation and used internally to create file names in the directory of the shard.", @@ -68287,10 +75081,20 @@ "type": "string" }, "size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The segment size in bytes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "size.memory": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The segment memory in bytes.\nA value of `-1` indicates Elasticsearch was unable to compute this number.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "committed": { "description": "If `true`, the segment is synced to disk.\nSegments that are synced can survive a hard reboot.\nIf `false`, the data from uncommitted segments is also stored in the transaction log so that Elasticsearch is able to replay changes on the next start.", @@ -68301,7 +75105,12 @@ "type": "string" }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "The version of Lucene used to write the segment.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "compound": { "description": "If `true`, the segment is stored in a compound file.\nThis means Lucene merged all files from the segment in a single file to save file descriptors.", @@ -68955,19 +75764,44 @@ "type": "string" }, "start_epoch": { - "$ref": "#/components/schemas/_spec_utils.StringifiedEpochTimeUnitSeconds" + "description": "The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process started.", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.StringifiedEpochTimeUnitSeconds" + } + ] }, "start_time": { - "$ref": "#/components/schemas/watcher._types.ScheduleTimeOfDay" + "description": "The time (HH:MM:SS) at which the snapshot process started.", + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ScheduleTimeOfDay" + } + ] }, "end_epoch": { - "$ref": "#/components/schemas/_spec_utils.StringifiedEpochTimeUnitSeconds" + "description": "The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process ended.", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.StringifiedEpochTimeUnitSeconds" + } + ] }, "end_time": { - "$ref": "#/components/schemas/_types.TimeOfDay" + "description": "The time (HH:MM:SS) at which the snapshot process ended.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TimeOfDay" + } + ] }, "duration": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The time it took the snapshot process to complete, in time units.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "indices": { "description": "The number of indices in the snapshot.", @@ -69027,14 +75861,24 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The identifier of the task with the node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "action": { "description": "The task action.", "type": "string" }, "task_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The unique task identifier.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "parent_task_id": { "description": "The parent task identifier.", @@ -69061,7 +75905,12 @@ "type": "string" }, "node_id": { - "$ref": "#/components/schemas/_types.NodeId" + "description": "The unique node identifier.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] }, "ip": { "description": "The IP address for the node.", @@ -69076,7 +75925,12 @@ "type": "string" }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "The Elasticsearch version.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "x_opaque_id": { "description": "The X-Opaque-ID header.", @@ -69092,7 +75946,12 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The template name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "index_patterns": { "description": "The template index patterns.", @@ -69191,7 +76050,12 @@ "type": "string" }, "node_id": { - "$ref": "#/components/schemas/_types.NodeId" + "description": "The persistent node identifier.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] }, "ephemeral_node_id": { "description": "The ephemeral node identifier.", @@ -69392,7 +76256,12 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The transform identifier.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "state": { "description": "The status of the transform.\nReturned values include:\n`aborting`: The transform is aborting.\n`failed: The transform failed. For more information about the failure, check the `reason` field.\n`indexing`: The transform is actively processing data and creating new documents.\n`started`: The transform is running but not actively indexing data.\n`stopped`: The transform is stopped.\n`stopping`: The transform is stopping.", @@ -69447,7 +76316,12 @@ "type": "string" }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "The version of Elasticsearch that existed on the node when the transform was created.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "source_index": { "description": "The source indices for the transform.", @@ -69551,7 +76425,11 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] }, "mode": { "type": "string" @@ -69570,10 +76448,18 @@ ] }, "soft_deletes": { - "$ref": "#/components/schemas/indices._types.SoftDeletes" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.SoftDeletes" + } + ] }, "sort": { - "$ref": "#/components/schemas/indices._types.IndexSegmentSort" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSegmentSort" + } + ] }, "number_of_shards": { "default": "1", @@ -69603,14 +76489,24 @@ "type": "number" }, "check_on_startup": { - "$ref": "#/components/schemas/indices._types.IndexCheckOnStartup" + "default": "false", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexCheckOnStartup" + } + ] }, "codec": { "default": "LZ4", "type": "string" }, "routing_partition_size": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + "default": "1", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + } + ] }, "load_fixed_bitset_filters_eagerly": { "default": true, @@ -69639,13 +76535,26 @@ ] }, "merge": { - "$ref": "#/components/schemas/indices._types.Merge" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.Merge" + } + ] }, "search": { - "$ref": "#/components/schemas/indices._types.SettingsSearch" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.SettingsSearch" + } + ] }, "refresh_interval": { - "$ref": "#/components/schemas/_types.Duration" + "default": "1s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "max_result_window": { "default": 10000.0, @@ -69676,16 +76585,32 @@ "type": "number" }, "blocks": { - "$ref": "#/components/schemas/indices._types.IndexSettingBlocks" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettingBlocks" + } + ] }, "max_refresh_listeners": { "type": "number" }, "analyze": { - "$ref": "#/components/schemas/indices._types.SettingsAnalyze" + "externalDocs": { + "url": "https://www.elastic.co/docs/manage-data/data-store/text-analysis/specify-an-analyzer#update-analyzers-on-existing-indices" + }, + "description": "Settings to define analyzers, tokenizers, token filters and character filters.\nRefer to the linked documentation for step-by-step examples of updating analyzers on existing indices.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.SettingsAnalyze" + } + ] }, "highlight": { - "$ref": "#/components/schemas/indices._types.SettingsHighlight" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.SettingsHighlight" + } + ] }, "max_terms_count": { "default": 65536.0, @@ -69696,34 +76621,77 @@ "type": "number" }, "routing": { - "$ref": "#/components/schemas/indices._types.IndexRouting" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexRouting" + } + ] }, "gc_deletes": { - "$ref": "#/components/schemas/_types.Duration" + "default": "60s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "default_pipeline": { - "$ref": "#/components/schemas/_types.PipelineName" + "default": "_none", + "allOf": [ + { + "$ref": "#/components/schemas/_types.PipelineName" + } + ] }, "final_pipeline": { - "$ref": "#/components/schemas/_types.PipelineName" + "default": "_none", + "allOf": [ + { + "$ref": "#/components/schemas/_types.PipelineName" + } + ] }, "lifecycle": { - "$ref": "#/components/schemas/indices._types.IndexSettingsLifecycle" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettingsLifecycle" + } + ] }, "provided_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "creation_date": { - "$ref": "#/components/schemas/_spec_utils.StringifiedEpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.StringifiedEpochTimeUnitMillis" + } + ] }, "creation_date_string": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "uuid": { - "$ref": "#/components/schemas/_types.Uuid" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Uuid" + } + ] }, "version": { - "$ref": "#/components/schemas/indices._types.IndexVersioning" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexVersioning" + } + ] }, "verified_before_close": { "oneOf": [ @@ -69749,10 +76717,18 @@ "type": "number" }, "translog": { - "$ref": "#/components/schemas/indices._types.Translog" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.Translog" + } + ] }, "query_string": { - "$ref": "#/components/schemas/indices._types.SettingsQueryString" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.SettingsQueryString" + } + ] }, "priority": { "oneOf": [ @@ -69768,16 +76744,32 @@ "type": "number" }, "analysis": { - "$ref": "#/components/schemas/indices._types.IndexSettingsAnalysis" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettingsAnalysis" + } + ] }, "settings": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] }, "time_series": { - "$ref": "#/components/schemas/indices._types.IndexSettingsTimeSeries" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettingsTimeSeries" + } + ] }, "queries": { - "$ref": "#/components/schemas/indices._types.Queries" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.Queries" + } + ] }, "similarity": { "description": "Configure custom similarity settings to customize how search results are scored.", @@ -69787,16 +76779,35 @@ } }, "mapping": { - "$ref": "#/components/schemas/indices._types.MappingLimitSettings" + "description": "Enable or disable dynamic mapping for an index.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.MappingLimitSettings" + } + ] }, "indexing.slowlog": { - "$ref": "#/components/schemas/indices._types.IndexingSlowlogSettings" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexingSlowlogSettings" + } + ] }, "indexing_pressure": { - "$ref": "#/components/schemas/indices._types.IndexingPressure" + "description": "Configure indexing back pressure limits.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexingPressure" + } + ] }, "store": { - "$ref": "#/components/schemas/indices._types.Storage" + "description": "The store module allows you to control how index data is stored and accessed on disk.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.Storage" + } + ] } } }, @@ -69809,7 +76820,12 @@ "type": "boolean" }, "retention_lease": { - "$ref": "#/components/schemas/indices._types.RetentionLease" + "description": "The maximum period to retain a shard history retention lease before it is considered expired.\nShard history retention leases ensure that soft deletes are retained during merges on the Lucene\nindex. If a soft delete is merged away before it can be replicated to a follower the following\nprocess will fail due to incomplete history on the leader.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.RetentionLease" + } + ] } } }, @@ -69817,7 +76833,11 @@ "type": "object", "properties": { "period": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } }, "required": [ @@ -69828,7 +76848,11 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Fields" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "order": { "oneOf": [ @@ -69924,7 +76948,11 @@ "type": "object", "properties": { "scheduler": { - "$ref": "#/components/schemas/indices._types.MergeScheduler" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.MergeScheduler" + } + ] } } }, @@ -69932,10 +76960,18 @@ "type": "object", "properties": { "max_thread_count": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + } + ] }, "max_merge_count": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + } + ] } } }, @@ -69943,10 +76979,18 @@ "type": "object", "properties": { "idle": { - "$ref": "#/components/schemas/indices._types.SearchIdle" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.SearchIdle" + } + ] }, "slowlog": { - "$ref": "#/components/schemas/indices._types.SlowlogSettings" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.SlowlogSettings" + } + ] } } }, @@ -69954,7 +76998,12 @@ "type": "object", "properties": { "after": { - "$ref": "#/components/schemas/_types.Duration" + "default": "30s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } } }, @@ -69971,7 +77020,11 @@ "type": "boolean" }, "threshold": { - "$ref": "#/components/schemas/indices._types.SlowlogTresholds" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.SlowlogTresholds" + } + ] } } }, @@ -69979,10 +77032,18 @@ "type": "object", "properties": { "query": { - "$ref": "#/components/schemas/indices._types.SlowlogTresholdLevels" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.SlowlogTresholdLevels" + } + ] }, "fetch": { - "$ref": "#/components/schemas/indices._types.SlowlogTresholdLevels" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.SlowlogTresholdLevels" + } + ] } } }, @@ -69990,16 +77051,32 @@ "type": "object", "properties": { "warn": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "info": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "debug": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "trace": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } } }, @@ -70007,19 +77084,39 @@ "type": "object", "properties": { "read_only": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] }, "read_only_allow_delete": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] }, "read": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] }, "write": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] }, "metadata": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] } } }, @@ -70038,7 +77135,12 @@ "type": "object", "properties": { "max_token_count": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + "default": "10000", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + } + ] } } }, @@ -70055,10 +77157,18 @@ "type": "object", "properties": { "allocation": { - "$ref": "#/components/schemas/indices._types.IndexRoutingAllocation" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexRoutingAllocation" + } + ] }, "rebalance": { - "$ref": "#/components/schemas/indices._types.IndexRoutingRebalance" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexRoutingRebalance" + } + ] } } }, @@ -70066,16 +77176,32 @@ "type": "object", "properties": { "enable": { - "$ref": "#/components/schemas/indices._types.IndexRoutingAllocationOptions" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexRoutingAllocationOptions" + } + ] }, "include": { - "$ref": "#/components/schemas/indices._types.IndexRoutingAllocationInclude" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexRoutingAllocationInclude" + } + ] }, "initial_recovery": { - "$ref": "#/components/schemas/indices._types.IndexRoutingAllocationInitialRecovery" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexRoutingAllocationInitialRecovery" + } + ] }, "disk": { - "$ref": "#/components/schemas/indices._types.IndexRoutingAllocationDisk" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexRoutingAllocationDisk" + } + ] } } }, @@ -70095,7 +77221,11 @@ "type": "string" }, "_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] } } }, @@ -70103,7 +77233,11 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] } } }, @@ -70126,7 +77260,11 @@ "type": "object", "properties": { "enable": { - "$ref": "#/components/schemas/indices._types.IndexRoutingRebalanceOptions" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexRoutingRebalanceOptions" + } + ] } }, "required": [ @@ -70149,10 +77287,21 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The name of the policy to use to manage the index. For information about how Elasticsearch applies policy changes, see Policy updates.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "indexing_complete": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "description": "Indicates whether or not the index has been rolled over. Automatically set to true when ILM completes the rollover action.\nYou can explicitly set it to skip rollover.", + "default": "false", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] }, "origination_date": { "description": "If specified, this is the timestamp used to calculate the index age for its phase transitions. Use this setting\nif you create a new index that contains old data and want to use the original creation date to calculate the index\nage. Specified as a Unix epoch value in milliseconds.", @@ -70164,7 +77313,11 @@ "type": "boolean" }, "step": { - "$ref": "#/components/schemas/indices._types.IndexSettingsLifecycleStep" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettingsLifecycleStep" + } + ] }, "rollover_alias": { "description": "The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action.\nWhen the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more\ninformation about rolling indices, see Rollover.", @@ -70189,7 +77342,12 @@ "type": "object", "properties": { "wait_time_threshold": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Time to wait for the cluster to resolve allocation issues during an ILM shrink action. Must be greater than 1h (1 hour).\nSee Shard allocation for shrink.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } } }, @@ -70211,7 +77369,11 @@ "type": "object", "properties": { "created": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "created_string": { "type": "string" @@ -70222,16 +77384,38 @@ "type": "object", "properties": { "sync_interval": { - "$ref": "#/components/schemas/_types.Duration" + "description": "How often the translog is fsynced to disk and committed, regardless of write operations.\nValues less than 100ms are not allowed.", + "default": "5s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "durability": { - "$ref": "#/components/schemas/indices._types.TranslogDurability" + "description": "Whether or not to `fsync` and commit the translog after every index, delete, update, or bulk request.", + "default": "string", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.TranslogDurability" + } + ] }, "flush_threshold_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The translog stores all operations that are not yet safely persisted in Lucene (i.e., are not\npart of a Lucene commit point). Although these operations are available for reads, they will need\nto be replayed if the shard was stopped and had to be recovered. This setting controls the\nmaximum total size of these operations, to prevent recoveries from taking too long. Once the\nmaximum size has been reached a flush will happen, generating a new Lucene commit point.", + "default": "512mb", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "retention": { - "$ref": "#/components/schemas/indices._types.TranslogRetention" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.TranslogRetention" + } + ] } } }, @@ -70248,10 +77432,22 @@ "type": "object", "properties": { "size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "This controls the total size of translog files to keep for each shard. Keeping more translog files increases\nthe chance of performing an operation based sync when recovering a replica. If the translog files are not\nsufficient, replica recovery will fall back to a file based sync. This setting is ignored, and should not be\nset, if soft deletes are enabled. Soft deletes are enabled by default in indices created in Elasticsearch\nversions 7.0.0 and later.", + "default": "512mb", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "age": { - "$ref": "#/components/schemas/_types.Duration" + "description": "This controls the maximum duration for which translog files are kept by each shard. Keeping more\ntranslog files increases the chance of performing an operation based sync when recovering replicas. If\nthe translog files are not sufficient, replica recovery will fall back to a file based sync. This setting\nis ignored, and should not be set, if soft deletes are enabled. Soft deletes are enabled by default in\nindices created in Elasticsearch versions 7.0.0 and later.", + "default": "12h", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } } }, @@ -70259,7 +77455,11 @@ "type": "object", "properties": { "lenient": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] } }, "required": [ @@ -70515,7 +77715,12 @@ ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "max_output_size": { "description": "The maximum token size to emit. Tokens larger than this size will be discarded.\nDefaults to `255`", @@ -70527,7 +77732,13 @@ "type": "string" }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.", + "default": "_none_", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "description": "The path to a file containing stop words.", @@ -70548,7 +77759,12 @@ ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] } }, "required": [ @@ -70565,10 +77781,19 @@ ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "decompound_mode": { - "$ref": "#/components/schemas/_types.analysis.NoriDecompoundMode" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.NoriDecompoundMode" + } + ] }, "stoptags": { "type": "array", @@ -70602,7 +77827,12 @@ ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "flags": { "description": "Java regular expression flags. Flags should be pipe-separated, eg \"CASE_INSENSITIVE|COMMENTS\".", @@ -70619,7 +77849,13 @@ "type": "string" }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.", + "default": "_none_", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "description": "The path to a file containing stop words.", @@ -70640,7 +77876,12 @@ ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] } }, "required": [ @@ -70662,7 +77903,13 @@ "type": "number" }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.", + "default": "_none_", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "description": "The path to a file containing stop words.", @@ -70683,10 +77930,21 @@ ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.", + "default": "_none_", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "description": "The path to a file containing stop words.", @@ -70707,7 +77965,12 @@ ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] } }, "required": [ @@ -70724,10 +77987,18 @@ ] }, "method": { - "$ref": "#/components/schemas/_types.analysis.IcuNormalizationType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuNormalizationType" + } + ] }, "mode": { - "$ref": "#/components/schemas/_types.analysis.IcuNormalizationMode" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuNormalizationMode" + } + ] } }, "required": [ @@ -70761,7 +78032,11 @@ ] }, "mode": { - "$ref": "#/components/schemas/_types.analysis.KuromojiTokenizationMode" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.KuromojiTokenizationMode" + } + ] }, "user_dictionary": { "type": "string" @@ -70790,13 +78065,26 @@ ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "language": { - "$ref": "#/components/schemas/_types.analysis.SnowballLanguage" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.SnowballLanguage" + } + ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] } }, "required": [ @@ -70846,7 +78134,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -70872,7 +78164,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -70898,7 +78194,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -70924,7 +78224,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -70950,7 +78254,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -70970,7 +78278,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -70996,7 +78308,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71022,7 +78338,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71042,7 +78362,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71062,7 +78386,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71088,7 +78416,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71108,7 +78440,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71134,7 +78470,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71160,7 +78500,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71180,7 +78524,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71206,7 +78554,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71232,7 +78584,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71258,7 +78614,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71284,7 +78644,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71304,7 +78668,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71330,7 +78698,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71356,7 +78728,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71382,7 +78758,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71408,7 +78788,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71434,7 +78818,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71460,7 +78848,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71486,7 +78878,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71512,7 +78908,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71532,7 +78932,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71558,7 +78962,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71584,7 +78992,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71610,7 +79022,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71636,7 +79052,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71662,7 +79082,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71688,7 +79112,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71714,7 +79142,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71740,7 +79172,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -71816,7 +79252,11 @@ "type": "object", "properties": { "version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] } } }, @@ -71896,10 +79336,18 @@ ] }, "mode": { - "$ref": "#/components/schemas/_types.analysis.IcuNormalizationMode" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuNormalizationMode" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.analysis.IcuNormalizationType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuNormalizationType" + } + ] }, "unicode_set_filter": { "type": "string" @@ -72207,7 +79655,11 @@ "type": "object", "properties": { "version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] } } }, @@ -72268,7 +79720,12 @@ ] }, "preserve_original": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "description": "If `true`, emit both original tokens and folded tokens. Defaults to `false`.", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] } }, "required": [ @@ -72464,7 +79921,12 @@ } }, "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "Predicate script used to apply token filters. If a token matches this script, the filters in the `filter` parameter are applied to the token.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } }, "required": [ @@ -72536,7 +79998,12 @@ "type": "string" }, "encoding": { - "$ref": "#/components/schemas/_types.analysis.DelimitedPayloadEncoding" + "description": "Data type for the stored payload.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.DelimitedPayloadEncoding" + } + ] } }, "required": [ @@ -72597,10 +80064,20 @@ "type": "number" }, "side": { - "$ref": "#/components/schemas/_types.analysis.EdgeNGramSide" + "description": "Indicates whether to truncate tokens from the `front` or `back`. Defaults to `front`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.EdgeNGramSide" + } + ] }, "preserve_original": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "description": "Emits original token when set to `true`. Defaults to `false`.", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] } }, "required": [ @@ -72642,7 +80119,12 @@ "type": "string" }, "articles_case": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "description": "If `true`, elision matching is case insensitive. If `false`, elision matching is case sensitive. Defaults to `false`.", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] } }, "required": [ @@ -72932,7 +80414,12 @@ ] }, "mode": { - "$ref": "#/components/schemas/_types.analysis.KeepTypesMode" + "description": "Indicates whether to keep or remove the specified token types.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.KeepTypesMode" + } + ] }, "types": { "description": "List of token types to keep or remove.", @@ -73129,7 +80616,12 @@ "type": "boolean" }, "max_token_count": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + "description": "Maximum number of tokens to keep. Once this limit is reached, any remaining tokens are excluded from the output. Defaults to `1`.", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + } + ] } }, "required": [ @@ -73153,7 +80645,12 @@ ] }, "language": { - "$ref": "#/components/schemas/_types.analysis.LowercaseTokenFilterLanguages" + "description": "Language-specific lowercase token filter to use.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.LowercaseTokenFilterLanguages" + } + ] } }, "required": [ @@ -73229,7 +80726,12 @@ } }, "preserve_original": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "description": "If `true` (the default) then emit the original token in addition to the filtered tokens.", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] } }, "required": [ @@ -73262,7 +80764,12 @@ "type": "number" }, "preserve_original": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "description": "Emits original token when set to `true`. Defaults to `false`.", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] } }, "required": [ @@ -73321,7 +80828,12 @@ } }, "preserve_original": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "description": "If set to `true` (the default) it will emit the original token.", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] } }, "required": [ @@ -73446,7 +80958,12 @@ ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "Script containing a condition used to filter incoming tokens. Only tokens that match this script are included in the output.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } }, "required": [ @@ -73601,10 +81118,20 @@ "type": "string" }, "max_shingle_size": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + "description": "Maximum number of tokens to concatenate when creating shingles. Defaults to `2`.", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + } + ] }, "min_shingle_size": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + "description": "Minimum number of tokens to concatenate when creating shingles. Defaults to `2`.", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + } + ] }, "output_unigrams": { "description": "If `true`, the output includes the original input tokens. If `false`, the output only includes shingles; the original input tokens are removed. Defaults to `true`.", @@ -73640,7 +81167,12 @@ ] }, "language": { - "$ref": "#/components/schemas/_types.analysis.SnowballLanguage" + "description": "Controls the language used by the stemmer.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.SnowballLanguage" + } + ] } }, "required": [ @@ -73749,7 +81281,12 @@ "type": "boolean" }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "description": "Language value, such as `_arabic_` or `_thai_`. Defaults to `_english_`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "description": "Path to a file that contains a list of stop words to remove.\nThis path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each stop word in the file must be separated by a line break.", @@ -73796,7 +81333,12 @@ "type": "boolean" }, "format": { - "$ref": "#/components/schemas/_types.analysis.SynonymFormat" + "description": "Sets the synonym rules format.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.SynonymFormat" + } + ] }, "lenient": { "description": "If `true` ignores errors while parsing the synonym rules. It is important to note that only those synonym rules which cannot get parsed are ignored. Defaults to the value of the `updateable` setting.", @@ -74008,7 +81550,12 @@ "type": "boolean" }, "preserve_original": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "description": "If `true`, the filter includes the original version of any split tokens in the output. This original version includes non-alphanumeric delimiters. Defaults to `false`.", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] }, "protected_words": { "description": "Array of tokens the filter won’t split.", @@ -74084,7 +81631,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] } }, "required": [ @@ -74186,10 +81737,18 @@ ] }, "alternate": { - "$ref": "#/components/schemas/_types.analysis.IcuCollationAlternate" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuCollationAlternate" + } + ] }, "caseFirst": { - "$ref": "#/components/schemas/_types.analysis.IcuCollationCaseFirst" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuCollationCaseFirst" + } + ] }, "caseLevel": { "type": "boolean" @@ -74198,7 +81757,11 @@ "type": "string" }, "decomposition": { - "$ref": "#/components/schemas/_types.analysis.IcuCollationDecomposition" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuCollationDecomposition" + } + ] }, "hiraganaQuaternaryMode": { "type": "boolean" @@ -74213,7 +81776,11 @@ "type": "string" }, "strength": { - "$ref": "#/components/schemas/_types.analysis.IcuCollationStrength" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuCollationStrength" + } + ] }, "variableTop": { "type": "string" @@ -74299,7 +81866,11 @@ ] }, "name": { - "$ref": "#/components/schemas/_types.analysis.IcuNormalizationType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuNormalizationType" + } + ] } }, "required": [ @@ -74324,7 +81895,11 @@ ] }, "dir": { - "$ref": "#/components/schemas/_types.analysis.IcuTransformDirection" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuTransformDirection" + } + ] }, "id": { "type": "string" @@ -74359,7 +81934,11 @@ ] }, "encoder": { - "$ref": "#/components/schemas/_types.analysis.PhoneticEncoder" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.PhoneticEncoder" + } + ] }, "languageset": { "oneOf": [ @@ -74378,13 +81957,21 @@ "type": "number" }, "name_type": { - "$ref": "#/components/schemas/_types.analysis.PhoneticNameType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.PhoneticNameType" + } + ] }, "replace": { "type": "boolean" }, "rule_type": { - "$ref": "#/components/schemas/_types.analysis.PhoneticRuleType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.PhoneticRuleType" + } + ] } }, "required": [ @@ -74626,7 +82213,11 @@ "type": "object", "properties": { "version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] } } }, @@ -74821,7 +82412,11 @@ ] }, "buffer_size": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + } + ] }, "delimiter": { "type": "string" @@ -74830,10 +82425,18 @@ "type": "string" }, "reverse": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] }, "skip": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + } + ] } }, "required": [ @@ -75056,7 +82659,11 @@ "type": "boolean" }, "mode": { - "$ref": "#/components/schemas/_types.analysis.KuromojiTokenizationMode" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.KuromojiTokenizationMode" + } + ] }, "nbest_cost": { "type": "number" @@ -75099,7 +82706,11 @@ ] }, "decompound_mode": { - "$ref": "#/components/schemas/_types.analysis.NoriDecompoundMode" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.NoriDecompoundMode" + } + ] }, "discard_punctuation": { "type": "boolean" @@ -75124,10 +82735,18 @@ "type": "object", "properties": { "end_time": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "start_time": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] } } }, @@ -75135,7 +82754,11 @@ "type": "object", "properties": { "cache": { - "$ref": "#/components/schemas/indices._types.CacheQueries" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.CacheQueries" + } + ] } } }, @@ -75228,7 +82851,11 @@ ] }, "independence_measure": { - "$ref": "#/components/schemas/_types.DFIIndependenceMeasure" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DFIIndependenceMeasure" + } + ] } }, "required": [ @@ -75254,13 +82881,25 @@ ] }, "after_effect": { - "$ref": "#/components/schemas/_types.DFRAfterEffect" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DFRAfterEffect" + } + ] }, "basic_model": { - "$ref": "#/components/schemas/_types.DFRBasicModel" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DFRBasicModel" + } + ] }, "normalization": { - "$ref": "#/components/schemas/_types.Normalization" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Normalization" + } + ] } }, "required": [ @@ -75310,13 +82949,25 @@ ] }, "distribution": { - "$ref": "#/components/schemas/_types.IBDistribution" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IBDistribution" + } + ] }, "lambda": { - "$ref": "#/components/schemas/_types.IBLambda" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IBLambda" + } + ] }, "normalization": { - "$ref": "#/components/schemas/_types.Normalization" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Normalization" + } + ] } }, "required": [ @@ -75384,10 +83035,18 @@ ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "weight_script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } }, "required": [ @@ -75403,25 +83062,53 @@ "type": "boolean" }, "total_fields": { - "$ref": "#/components/schemas/indices._types.MappingLimitSettingsTotalFields" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.MappingLimitSettingsTotalFields" + } + ] }, "depth": { - "$ref": "#/components/schemas/indices._types.MappingLimitSettingsDepth" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.MappingLimitSettingsDepth" + } + ] }, "nested_fields": { - "$ref": "#/components/schemas/indices._types.MappingLimitSettingsNestedFields" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.MappingLimitSettingsNestedFields" + } + ] }, "nested_objects": { - "$ref": "#/components/schemas/indices._types.MappingLimitSettingsNestedObjects" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.MappingLimitSettingsNestedObjects" + } + ] }, "field_name_length": { - "$ref": "#/components/schemas/indices._types.MappingLimitSettingsFieldNameLength" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.MappingLimitSettingsFieldNameLength" + } + ] }, "dimension_fields": { - "$ref": "#/components/schemas/indices._types.MappingLimitSettingsDimensionFields" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.MappingLimitSettingsDimensionFields" + } + ] }, "source": { - "$ref": "#/components/schemas/indices._types.MappingLimitSettingsSourceFields" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.MappingLimitSettingsSourceFields" + } + ] }, "ignore_malformed": { "oneOf": [ @@ -75516,7 +83203,11 @@ "type": "object", "properties": { "mode": { - "$ref": "#/components/schemas/indices._types.SourceMode" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.SourceMode" + } + ] } }, "required": [ @@ -75544,7 +83235,11 @@ "type": "boolean" }, "threshold": { - "$ref": "#/components/schemas/indices._types.IndexingSlowlogTresholds" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexingSlowlogTresholds" + } + ] } } }, @@ -75552,7 +83247,12 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/indices._types.SlowlogTresholdLevels" + "description": "The indexing slow log, similar in functionality to the search slow log. The log file name ends with `_index_indexing_slowlog.json`.\nLog and the thresholds are configured in the same way as the search slowlog.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.SlowlogTresholdLevels" + } + ] } } }, @@ -75560,7 +83260,11 @@ "type": "object", "properties": { "memory": { - "$ref": "#/components/schemas/indices._types.IndexingPressureMemory" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexingPressureMemory" + } + ] } }, "required": [ @@ -75580,14 +83284,23 @@ "type": "object", "properties": { "type": { - "$ref": "#/components/schemas/indices._types.StorageType" + "allOf": [ + { + "$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" }, "stats_refresh_interval": { - "$ref": "#/components/schemas/_types.Duration" + "description": "How often store statistics are refreshed", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } }, "required": [ @@ -75614,19 +83327,44 @@ "type": "object", "properties": { "follower_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The name of the follower index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "leader_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The name of the index in the leader cluster that is followed.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "parameters": { - "$ref": "#/components/schemas/ccr.follow_info.FollowerIndexParameters" + "description": "An object that encapsulates cross-cluster replication parameters. If the follower index's status is paused, this object is omitted.", + "allOf": [ + { + "$ref": "#/components/schemas/ccr.follow_info.FollowerIndexParameters" + } + ] }, "remote_cluster": { - "$ref": "#/components/schemas/_types.Name" + "description": "The remote cluster that contains the leader index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "status": { - "$ref": "#/components/schemas/ccr.follow_info.FollowerIndexStatus" + "description": "The status of the index following: `active` or `paused`.", + "allOf": [ + { + "$ref": "#/components/schemas/ccr.follow_info.FollowerIndexStatus" + } + ] } }, "required": [ @@ -75652,27 +83390,52 @@ "type": "number" }, "max_read_request_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "max_retry_delay": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when\nretrying.", + "allOf": [ + { + "$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" + "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.", + "allOf": [ + { + "$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" + "description": "The maximum total bytes of operations per bulk write request executed on the follower.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "read_poll_timeout": { - "$ref": "#/components/schemas/_types.Duration" + "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.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } } }, @@ -75687,7 +83450,12 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The name of the follower index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "shards": { "description": "An array of shard-level following task statistics.", @@ -75718,10 +83486,19 @@ "type": "number" }, "fatal_exception": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] }, "follower_aliases_version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "The index aliases version the follower is synced up to.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "follower_global_checkpoint": { "description": "The current global checkpoint on the follower.\nThe difference between the `leader_global_checkpoint` and the `follower_global_checkpoint` is an indication of how much the follower is lagging the leader.", @@ -75732,16 +83509,36 @@ "type": "string" }, "follower_mapping_version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "The mapping version the follower is synced up to.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "follower_max_seq_no": { - "$ref": "#/components/schemas/_types.SequenceNumber" + "description": "The current maximum sequence number on the follower.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SequenceNumber" + } + ] }, "follower_settings_version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "The index settings version the follower is synced up to.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "last_requested_seq_no": { - "$ref": "#/components/schemas/_types.SequenceNumber" + "description": "The starting sequence number of the last batch of operations requested from the leader.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SequenceNumber" + } + ] }, "leader_global_checkpoint": { "description": "The current global checkpoint on the leader known to the follower task.", @@ -75752,7 +83549,12 @@ "type": "string" }, "leader_max_seq_no": { - "$ref": "#/components/schemas/_types.SequenceNumber" + "description": "The current maximum sequence number on the leader known to the follower task.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SequenceNumber" + } + ] }, "operations_read": { "description": "The total number of operations read from the leader.", @@ -75794,35 +83596,76 @@ "type": "number" }, "time_since_last_read": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "time_since_last_read_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The number of milliseconds since a read request was sent to the leader.\nWhen the follower is caught up to the leader, this number will increase up to the configured `read_poll_timeout` at which point another read request will be sent to the leader.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "total_read_remote_exec_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "total_read_remote_exec_time_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The total time reads spent running on the remote cluster.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "total_read_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "total_read_time_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The total time reads were outstanding, measured from the time a read was sent to the leader to the time a reply was returned to the follower.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "total_write_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "total_write_time_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The total time spent writing on the follower.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "write_buffer_operation_count": { "description": "The number of write operations queued on the follower.", "type": "number" }, "write_buffer_size_in_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The total number of bytes of operations currently queued for writing.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] } }, "required": [ @@ -75860,10 +83703,20 @@ "type": "object", "properties": { "exception": { - "$ref": "#/components/schemas/_types.ErrorCause" + "description": "The exception that caused the read to fail.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] }, "from_seq_no": { - "$ref": "#/components/schemas/_types.SequenceNumber" + "description": "The starting sequence number of the batch requested from the leader.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SequenceNumber" + } + ] }, "retries": { "description": "The number of times the batch has been retried.", @@ -75880,10 +83733,18 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "pattern": { - "$ref": "#/components/schemas/ccr.get_auto_follow_pattern.AutoFollowPatternSummary" + "allOf": [ + { + "$ref": "#/components/schemas/ccr.get_auto_follow_pattern.AutoFollowPatternSummary" + } + ] } }, "required": [ @@ -75902,13 +83763,29 @@ "type": "string" }, "follow_index_pattern": { - "$ref": "#/components/schemas/_types.IndexPattern" + "description": "The name of follower index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexPattern" + } + ] }, "leader_index_patterns": { - "$ref": "#/components/schemas/_types.IndexPatterns" + "description": "An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexPatterns" + } + ] }, "leader_index_exclusion_patterns": { - "$ref": "#/components/schemas/_types.IndexPatterns" + "description": "An array of simple index patterns that can be used to exclude indices from being auto-followed.", + "x-state": "Generally available; Added in 7.14.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexPatterns" + } + ] }, "max_outstanding_read_requests": { "description": "The maximum number of outstanding reads requests from the remote cluster.", @@ -75973,13 +83850,25 @@ "type": "object", "properties": { "cluster_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "last_seen_metadata_version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "time_since_last_check_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } }, "required": [ @@ -76035,7 +83924,11 @@ "type": "string" }, "decision": { - "$ref": "#/components/schemas/cluster.allocation_explain.AllocationExplainDecision" + "allOf": [ + { + "$ref": "#/components/schemas/cluster.allocation_explain.AllocationExplainDecision" + } + ] }, "explanation": { "type": "string" @@ -76101,13 +83994,25 @@ "type": "object", "properties": { "node_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "least_available": { - "$ref": "#/components/schemas/cluster.allocation_explain.DiskUsage" + "allOf": [ + { + "$ref": "#/components/schemas/cluster.allocation_explain.DiskUsage" + } + ] }, "most_available": { - "$ref": "#/components/schemas/cluster.allocation_explain.DiskUsage" + "allOf": [ + { + "$ref": "#/components/schemas/cluster.allocation_explain.DiskUsage" + } + ] } }, "required": [ @@ -76151,7 +84056,11 @@ "type": "object", "properties": { "node_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "path": { "type": "string" @@ -76177,13 +84086,26 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "roles": { - "$ref": "#/components/schemas/_types.NodeRoles" + "x-state": "Generally available; Added in 8.11.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeRoles" + } + ] }, "attributes": { "type": "object", @@ -76192,7 +84114,11 @@ } }, "transport_address": { - "$ref": "#/components/schemas/_types.TransportAddress" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TransportAddress" + } + ] }, "weight_ranking": { "type": "number" @@ -76251,22 +84177,47 @@ } }, "node_decision": { - "$ref": "#/components/schemas/cluster.allocation_explain.Decision" + "allOf": [ + { + "$ref": "#/components/schemas/cluster.allocation_explain.Decision" + } + ] }, "node_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "node_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "roles": { - "$ref": "#/components/schemas/_types.NodeRoles" + "x-state": "Generally available; Added in 8.11.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeRoles" + } + ] }, "store": { - "$ref": "#/components/schemas/cluster.allocation_explain.AllocationStore" + "allOf": [ + { + "$ref": "#/components/schemas/cluster.allocation_explain.AllocationStore" + } + ] }, "transport_address": { - "$ref": "#/components/schemas/_types.TransportAddress" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TransportAddress" + } + ] }, "weight_ranking": { "type": "number" @@ -76318,13 +84269,21 @@ "type": "object", "properties": { "at": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "last_allocation_status": { "type": "string" }, "reason": { - "$ref": "#/components/schemas/cluster.allocation_explain.UnassignedInformationReason" + "allOf": [ + { + "$ref": "#/components/schemas/cluster.allocation_explain.UnassignedInformationReason" + } + ] }, "details": { "type": "string" @@ -76368,10 +84327,18 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "component_template": { - "$ref": "#/components/schemas/cluster._types.ComponentTemplateNode" + "allOf": [ + { + "$ref": "#/components/schemas/cluster._types.ComponentTemplateNode" + } + ] } }, "required": [ @@ -76383,13 +84350,25 @@ "type": "object", "properties": { "template": { - "$ref": "#/components/schemas/cluster._types.ComponentTemplateSummary" + "allOf": [ + { + "$ref": "#/components/schemas/cluster._types.ComponentTemplateSummary" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "deprecated": { "type": "boolean" @@ -76403,10 +84382,18 @@ "type": "object", "properties": { "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "settings": { "type": "object", @@ -76415,7 +84402,11 @@ } }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "aliases": { "type": "object", @@ -76424,7 +84415,12 @@ } }, "lifecycle": { - "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover" + "x-state": "Generally available; Added in 8.11.0", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover" + } + ] }, "data_stream_options": { "x-state": "Generally available; Added in 8.19.0", @@ -76444,13 +84440,21 @@ "type": "object", "properties": { "all_field": { - "$ref": "#/components/schemas/_types.mapping.AllField" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.AllField" + } + ] }, "date_detection": { "type": "boolean" }, "dynamic": { - "$ref": "#/components/schemas/_types.mapping.DynamicMapping" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.DynamicMapping" + } + ] }, "dynamic_date_formats": { "type": "array", @@ -76470,13 +84474,25 @@ } }, "_field_names": { - "$ref": "#/components/schemas/_types.mapping.FieldNamesField" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.FieldNamesField" + } + ] }, "index_field": { - "$ref": "#/components/schemas/_types.mapping.IndexField" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.IndexField" + } + ] }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "numeric_detection": { "type": "boolean" @@ -76488,13 +84504,25 @@ } }, "_routing": { - "$ref": "#/components/schemas/_types.mapping.RoutingField" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RoutingField" + } + ] }, "_size": { - "$ref": "#/components/schemas/_types.mapping.SizeField" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.SizeField" + } + ] }, "_source": { - "$ref": "#/components/schemas/_types.mapping.SourceField" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.SourceField" + } + ] }, "runtime": { "type": "object", @@ -76506,10 +84534,19 @@ "type": "boolean" }, "subobjects": { - "$ref": "#/components/schemas/_types.mapping.Subobjects" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.Subobjects" + } + ] }, "_data_stream_timestamp": { - "$ref": "#/components/schemas/_types.mapping.DataStreamTimestamp" + "x-state": "Generally available; Added in 7.16.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.DataStreamTimestamp" + } + ] } } }, @@ -76653,7 +84690,11 @@ ] }, "match_pattern": { - "$ref": "#/components/schemas/_types.mapping.MatchType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.MatchType" + } + ] } } }, @@ -76661,10 +84702,18 @@ "type": "object", "properties": { "mapping": { - "$ref": "#/components/schemas/_types.mapping.Property" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.Property" + } + ] }, "runtime": { - "$ref": "#/components/schemas/_types.mapping.RuntimeField" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeField" + } + ] } }, "minProperties": 1, @@ -76880,7 +84929,11 @@ "type": "object", "properties": { "copy_to": { - "$ref": "#/components/schemas/_types.Fields" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "store": { "type": "boolean" @@ -76909,7 +84962,11 @@ "type": "number" }, "dynamic": { - "$ref": "#/components/schemas/_types.mapping.DynamicMapping" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.DynamicMapping" + } + ] }, "fields": { "type": "object", @@ -76918,7 +84975,11 @@ } }, "synthetic_source_keep": { - "$ref": "#/components/schemas/_types.mapping.SyntheticSourceKeepEnum" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.SyntheticSourceKeepEnum" + } + ] } } }, @@ -76942,7 +85003,11 @@ "type": "number" }, "fielddata": { - "$ref": "#/components/schemas/indices._types.NumericFielddata" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.NumericFielddata" + } + ] }, "index": { "type": "boolean" @@ -76954,10 +85019,18 @@ "type": "boolean" }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "on_script_error": { - "$ref": "#/components/schemas/_types.mapping.OnScriptError" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.OnScriptError" + } + ] }, "time_series_dimension": { "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.", @@ -76981,7 +85054,11 @@ "type": "object", "properties": { "format": { - "$ref": "#/components/schemas/indices._types.NumericFielddataFormat" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.NumericFielddataFormat" + } + ] } }, "required": [ @@ -77020,7 +85097,11 @@ "type": "boolean" }, "null_value": { - "$ref": "#/components/schemas/_types.FieldValue" + "allOf": [ + { + "$ref": "#/components/schemas/_types.FieldValue" + } + ] }, "boost": { "type": "number" @@ -77029,16 +85110,28 @@ "type": "boolean" }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "on_script_error": { - "$ref": "#/components/schemas/_types.mapping.OnScriptError" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.OnScriptError" + } + ] }, "ignore_malformed": { "type": "boolean" }, "time_series_metric": { - "$ref": "#/components/schemas/_types.mapping.TimeSeriesMetricType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TimeSeriesMetricType" + } + ] }, "analyzer": { "type": "string" @@ -77050,7 +85143,11 @@ "type": "boolean" }, "index_options": { - "$ref": "#/components/schemas/_types.mapping.IndexOptions" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.IndexOptions" + } + ] }, "index_phrases": { "type": "boolean" @@ -77079,7 +85176,11 @@ "type": "string" }, "term_vector": { - "$ref": "#/components/schemas/_types.mapping.TermVectorOption" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TermVectorOption" + } + ] }, "format": { "type": "string" @@ -77201,13 +85302,25 @@ "type": "boolean" }, "index_options": { - "$ref": "#/components/schemas/_types.mapping.IndexOptions" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.IndexOptions" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "on_script_error": { - "$ref": "#/components/schemas/_types.mapping.OnScriptError" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.OnScriptError" + } + ] }, "normalizer": { "type": "string" @@ -77275,7 +85388,12 @@ } }, "copy_to": { - "$ref": "#/components/schemas/_types.Fields" + "description": "Allows you to copy the values of multiple fields into a group\nfield, which can then be queried as a single field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] } }, "required": [ @@ -77366,7 +85484,11 @@ "type": "boolean" }, "index_options": { - "$ref": "#/components/schemas/_types.mapping.IndexOptions" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.IndexOptions" + } + ] }, "max_shingle_size": { "type": "number" @@ -77392,7 +85514,11 @@ ] }, "term_vector": { - "$ref": "#/components/schemas/_types.mapping.TermVectorOption" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TermVectorOption" + } + ] }, "type": { "type": "string", @@ -77428,13 +85554,21 @@ "type": "boolean" }, "fielddata_frequency_filter": { - "$ref": "#/components/schemas/indices._types.FielddataFrequencyFilter" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.FielddataFrequencyFilter" + } + ] }, "index": { "type": "boolean" }, "index_options": { - "$ref": "#/components/schemas/_types.mapping.IndexOptions" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.IndexOptions" + } + ] }, "index_phrases": { "type": "boolean" @@ -77474,7 +85608,11 @@ ] }, "term_vector": { - "$ref": "#/components/schemas/_types.mapping.TermVectorOption" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TermVectorOption" + } + ] }, "type": { "type": "string", @@ -77575,13 +85713,25 @@ "type": "boolean" }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "on_script_error": { - "$ref": "#/components/schemas/_types.mapping.OnScriptError" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.OnScriptError" + } + ] }, "null_value": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "precision_step": { "type": "number" @@ -77611,7 +85761,11 @@ "type": "number" }, "fielddata": { - "$ref": "#/components/schemas/indices._types.NumericFielddata" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.NumericFielddata" + } + ] }, "format": { "type": "string" @@ -77623,13 +85777,25 @@ "type": "boolean" }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "on_script_error": { - "$ref": "#/components/schemas/_types.mapping.OnScriptError" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.OnScriptError" + } + ] }, "null_value": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "precision_step": { "type": "number" @@ -77677,7 +85843,11 @@ } }, "time_series_metric": { - "$ref": "#/components/schemas/_types.mapping.TimeSeriesMetricType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TimeSeriesMetricType" + } + ] } }, "required": [ @@ -77707,7 +85877,13 @@ "type": "number" }, "element_type": { - "$ref": "#/components/schemas/_types.mapping.DenseVectorElementType" + "description": "The data type used to encode vectors. The supported data types are `float` (default), `byte`, and `bit`.", + "default": "float", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.DenseVectorElementType" + } + ] }, "index": { "description": "If `true`, you can search this field using the kNN search API.", @@ -77715,10 +85891,20 @@ "type": "boolean" }, "index_options": { - "$ref": "#/components/schemas/_types.mapping.DenseVectorIndexOptions" + "description": "An optional section that configures the kNN indexing algorithm. The HNSW algorithm has two internal parameters\nthat influence how the data structure is built. These can be adjusted to improve the accuracy of results, at the\nexpense of slower indexing speed.\n\nThis parameter can only be specified when `index` is `true`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.DenseVectorIndexOptions" + } + ] }, "similarity": { - "$ref": "#/components/schemas/_types.mapping.DenseVectorSimilarity" + "description": "The vector similarity metric to use in kNN search.\n\nDocuments are ranked by their vector field's similarity to the query vector. The `_score` of each document will\nbe derived from the similarity, in a way that ensures scores are positive and that a larger score corresponds\nto a higher ranking.\n\nDefaults to `l2_norm` when `element_type` is `bit` otherwise defaults to `cosine`.\n\n`bit` vectors only support `l2_norm` as their similarity metric.\n\nThis parameter can only be specified when `index` is `true`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.DenseVectorSimilarity" + } + ] } }, "required": [ @@ -77753,10 +85939,20 @@ "type": "number" }, "type": { - "$ref": "#/components/schemas/_types.mapping.DenseVectorIndexOptionsType" + "description": "The type of kNN algorithm to use.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.DenseVectorIndexOptionsType" + } + ] }, "rescore_vector": { - "$ref": "#/components/schemas/_types.mapping.DenseVectorIndexOptionsRescoreVector" + "description": "The rescore vector options. This is only applicable to `bbq_hnsw`, `int4_hnsw`, `int8_hnsw`, `bbq_flat`, `int4_flat`, and `int8_flat` index types.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.DenseVectorIndexOptionsRescoreVector" + } + ] } }, "required": [ @@ -77821,7 +86017,11 @@ "type": "boolean" }, "index_options": { - "$ref": "#/components/schemas/_types.mapping.IndexOptions" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.IndexOptions" + } + ] }, "null_value": { "type": "string" @@ -77893,7 +86093,11 @@ "type": "boolean" }, "subobjects": { - "$ref": "#/components/schemas/_types.mapping.Subobjects" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.Subobjects" + } + ] }, "type": { "type": "string", @@ -77955,7 +86159,11 @@ ] }, "element_type": { - "$ref": "#/components/schemas/_types.mapping.RankVectorElementType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RankVectorElementType" + } + ] }, "dims": { "type": "number" @@ -77991,16 +86199,37 @@ } }, "inference_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Inference endpoint that will be used to generate embeddings for the field.\nThis parameter cannot be updated. Use the Create inference API to create the endpoint.\nIf `search_inference_id` is specified, the inference endpoint will only be used at index time.", + "default": ".elser-2-elasticsearch", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "search_inference_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Inference endpoint that will be used to generate embeddings at query time.\nYou can update this parameter by using the Update mapping API. Use the Create inference API to create the endpoint.\nIf not specified, the inference endpoint defined by inference_id will be used at both index and query time.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "index_options": { - "$ref": "#/components/schemas/_types.mapping.SemanticTextIndexOptions" + "description": "Settings for index_options that override any defaults used by semantic_text, for example\nspecific quantization settings.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.SemanticTextIndexOptions" + } + ] }, "chunking_settings": { - "$ref": "#/components/schemas/_types.mapping.ChunkingSettings" + "description": "Settings for chunking text into smaller passages. If specified, these will override the\nchunking settings sent in the inference endpoint associated with inference_id. If chunking settings are updated,\nthey will not be applied to existing documents until they are reindexed.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.ChunkingSettings" + } + ] } }, "required": [ @@ -78011,7 +86240,11 @@ "type": "object", "properties": { "dense_vector": { - "$ref": "#/components/schemas/_types.mapping.DenseVectorIndexOptions" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.DenseVectorIndexOptions" + } + ] } } }, @@ -78078,7 +86311,13 @@ ] }, "index_options": { - "$ref": "#/components/schemas/_types.mapping.SparseVectorIndexOptions" + "description": "Additional index options for the sparse vector field that controls the\ntoken pruning behavior of the sparse vector field.", + "x-state": "Generally available; Added in 8.19.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.SparseVectorIndexOptions" + } + ] } }, "required": [ @@ -78096,7 +86335,13 @@ "type": "boolean" }, "pruning_config": { - "$ref": "#/components/schemas/_types.TokenPruningConfig" + "description": "Optional pruning configuration.\nIf enabled, this will omit non-significant tokens from the query in order to improve query performance.\nThis is only used if prune is set to true.\nIf prune is set to true but pruning_config is not specified, default values will be used.", + "x-state": "Generally available; Added in 8.19.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TokenPruningConfig" + } + ] } } }, @@ -78146,10 +86391,18 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "path": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "type": { "type": "string" @@ -78227,7 +86480,11 @@ "type": "object", "properties": { "path": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "type": { "type": "string", @@ -78287,10 +86544,18 @@ "type": "string" }, "on_script_error": { - "$ref": "#/components/schemas/_types.mapping.OnScriptError" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.OnScriptError" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "time_series_dimension": { "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.", @@ -78382,16 +86647,28 @@ "type": "boolean" }, "null_value": { - "$ref": "#/components/schemas/_types.GeoLocation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoLocation" + } + ] }, "index": { "type": "boolean" }, "on_script_error": { - "$ref": "#/components/schemas/_types.mapping.OnScriptError" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.OnScriptError" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "type": { "type": "string", @@ -78400,7 +86677,11 @@ ] }, "time_series_metric": { - "$ref": "#/components/schemas/_types.mapping.GeoPointMetricType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.GeoPointMetricType" + } + ] } }, "required": [ @@ -78439,10 +86720,18 @@ "type": "boolean" }, "orientation": { - "$ref": "#/components/schemas/_types.mapping.GeoOrientation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.GeoOrientation" + } + ] }, "strategy": { - "$ref": "#/components/schemas/_types.mapping.GeoStrategy" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.GeoStrategy" + } + ] }, "type": { "type": "string", @@ -78526,7 +86815,11 @@ "type": "boolean" }, "orientation": { - "$ref": "#/components/schemas/_types.mapping.GeoOrientation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.GeoOrientation" + } + ] }, "type": { "type": "string", @@ -78556,7 +86849,11 @@ ] }, "null_value": { - "$ref": "#/components/schemas/_types.byte" + "allOf": [ + { + "$ref": "#/components/schemas/_types.byte" + } + ] } }, "required": [ @@ -78589,13 +86886,27 @@ "type": "boolean" }, "on_script_error": { - "$ref": "#/components/schemas/_types.mapping.OnScriptError" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.OnScriptError" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "time_series_metric": { - "$ref": "#/components/schemas/_types.mapping.TimeSeriesMetricType" + "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.", + "x-state": "Technical preview", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TimeSeriesMetricType" + } + ] }, "time_series_dimension": { "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.", @@ -78769,7 +87080,11 @@ ] }, "null_value": { - "$ref": "#/components/schemas/_types.short" + "allOf": [ + { + "$ref": "#/components/schemas/_types.short" + } + ] } }, "required": [ @@ -78796,7 +87111,11 @@ ] }, "null_value": { - "$ref": "#/components/schemas/_types.ulong" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ulong" + } + ] } }, "required": [ @@ -78976,7 +87295,11 @@ "type": "boolean" }, "index_options": { - "$ref": "#/components/schemas/_types.mapping.IndexOptions" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.IndexOptions" + } + ] }, "index": { "description": "Should the field be searchable?", @@ -78999,19 +87322,35 @@ "type": "string" }, "strength": { - "$ref": "#/components/schemas/_types.analysis.IcuCollationStrength" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuCollationStrength" + } + ] }, "decomposition": { - "$ref": "#/components/schemas/_types.analysis.IcuCollationDecomposition" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuCollationDecomposition" + } + ] }, "alternate": { - "$ref": "#/components/schemas/_types.analysis.IcuCollationAlternate" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuCollationAlternate" + } + ] }, "case_level": { "type": "boolean" }, "case_first": { - "$ref": "#/components/schemas/_types.analysis.IcuCollationCaseFirst" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuCollationCaseFirst" + } + ] }, "numeric": { "type": "boolean" @@ -79105,7 +87444,11 @@ } }, "mode": { - "$ref": "#/components/schemas/_types.mapping.SourceFieldMode" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.SourceFieldMode" + } + ] } } }, @@ -79132,7 +87475,12 @@ "type": "object", "properties": { "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Query used to limit documents the alias can access.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "index_routing": { "description": "Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.", @@ -79169,7 +87517,12 @@ "type": "object", "properties": { "rollover": { - "$ref": "#/components/schemas/indices._types.DataStreamLifecycleRolloverConditions" + "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.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamLifecycleRolloverConditions" + } + ] } } } @@ -79179,7 +87532,11 @@ "type": "object", "properties": { "min_age": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "max_age": { "type": "string" @@ -79191,16 +87548,32 @@ "type": "number" }, "min_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "max_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "min_primary_shard_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "max_primary_shard_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "min_primary_shard_docs": { "type": "number" @@ -79215,10 +87588,20 @@ "type": "object", "properties": { "data_retention": { - "$ref": "#/components/schemas/_types.Duration" + "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.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "downsampling": { - "$ref": "#/components/schemas/indices._types.DataStreamLifecycleDownsampling" + "description": "The downsampling configuration to execute for the managed backing index after rollover.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamLifecycleDownsampling" + } + ] }, "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.", @@ -79246,10 +87629,20 @@ "type": "object", "properties": { "after": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The duration since rollover when this downsampling round should execute", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "config": { - "$ref": "#/components/schemas/indices._types.DownsampleConfig" + "description": "The downsample configuration to execute.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DownsampleConfig" + } + ] } }, "required": [ @@ -79261,7 +87654,12 @@ "type": "object", "properties": { "fixed_interval": { - "$ref": "#/components/schemas/_types.DurationLarge" + "description": "The interval at which to aggregate the original time series index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationLarge" + } + ] } }, "required": [ @@ -79388,7 +87786,12 @@ "type": "number" }, "cluster_name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The name of the cluster.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "delayed_unassigned_shards": { "description": "The number of shards whose allocation has been delayed by the timeout settings.", @@ -79425,13 +87828,27 @@ "type": "number" }, "status": { - "$ref": "#/components/schemas/_types.HealthStatus" + "allOf": [ + { + "$ref": "#/components/schemas/_types.HealthStatus" + } + ] }, "task_max_waiting_in_queue": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The time since the earliest initiated task is waiting for being performed.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "task_max_waiting_in_queue_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The time expressed in milliseconds since the earliest initiated task is waiting for being performed.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "timed_out": { "description": "If false the response returned within the period of time that is specified by the timeout parameter (30s by default)", @@ -79493,7 +87910,11 @@ } }, "status": { - "$ref": "#/components/schemas/_types.HealthStatus" + "allOf": [ + { + "$ref": "#/components/schemas/_types.HealthStatus" + } + ] }, "unassigned_shards": { "type": "number" @@ -79530,7 +87951,11 @@ "type": "number" }, "status": { - "$ref": "#/components/schemas/_types.HealthStatus" + "allOf": [ + { + "$ref": "#/components/schemas/_types.HealthStatus" + } + ] }, "unassigned_shards": { "type": "number" @@ -79656,10 +88081,18 @@ "type": "object", "properties": { "requests": { - "$ref": "#/components/schemas/nodes._types.HttpRouteRequests" + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.HttpRouteRequests" + } + ] }, "responses": { - "$ref": "#/components/schemas/nodes._types.HttpRouteResponses" + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.HttpRouteResponses" + } + ] } }, "required": [ @@ -79763,7 +88196,12 @@ } }, "total": { - "$ref": "#/components/schemas/nodes._types.IngestTotal" + "description": "Contains statistics about ingest operations for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.IngestTotal" + } + ] } } }, @@ -79793,7 +88231,12 @@ } }, "time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "ingested_as_first_pipeline_in_bytes": { "description": "Total number of bytes of all documents ingested by the pipeline.\nThis field is only present on pipelines which are the first to process a document.\nThus, it is not present on pipelines which only serve as a final pipeline after a default pipeline, a pipeline run after a reroute processor, or pipelines in pipeline processors.", @@ -79820,7 +88263,11 @@ "type": "object", "properties": { "stats": { - "$ref": "#/components/schemas/nodes._types.Processor" + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.Processor" + } + ] }, "type": { "type": "string" @@ -79843,7 +88290,12 @@ "type": "number" }, "time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "Time, in milliseconds, spent by the processor transforming documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } } }, @@ -79863,7 +88315,12 @@ "type": "number" }, "time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } }, "required": [ @@ -79969,10 +88426,20 @@ "type": "string" }, "time_in_queue": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The time since the task is waiting for being performed.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "time_in_queue_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The time expressed in milliseconds since the task is waiting for being performed.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } }, "required": [ @@ -79993,19 +88460,42 @@ } }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "settings": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] }, "defaults": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "description": "Default settings, included when the request's `include_default` is `true`.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] }, "data_stream": { - "$ref": "#/components/schemas/_types.DataStreamName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DataStreamName" + } + ] }, "lifecycle": { - "$ref": "#/components/schemas/indices._types.DataStreamLifecycle" + "description": "Data stream lifecycle applicable if this is a data stream.", + "x-state": "Generally available; Added in 8.11.0", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamLifecycle" + } + ] } } }, @@ -80013,10 +88503,20 @@ "type": "object", "properties": { "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Query used to limit documents the alias can access.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "index_routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "is_hidden": { "description": "If `true`, the alias is hidden.\nAll indices for the alias must have the same `is_hidden` value.", @@ -80029,10 +88529,20 @@ "type": "boolean" }, "routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "Value used to route indexing and search operations to a specific shard.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "search_routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] } } }, @@ -80075,7 +88585,12 @@ "type": "number" }, "initial_connect_timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The initial connect timeout for remote cluster connections.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "skip_unavailable": { "description": "If `true`, cross-cluster search skips the remote cluster when its nodes are unavailable during the search and ignores errors returned by the remote cluster.", @@ -80114,7 +88629,12 @@ "type": "boolean" }, "initial_connect_timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The initial connect timeout for remote cluster connections.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "skip_unavailable": { "description": "If `true`, cross-cluster search skips the remote cluster when its nodes are unavailable during the search and ignores errors returned by the remote cluster.", @@ -80168,19 +88688,44 @@ "type": "object", "properties": { "cancel": { - "$ref": "#/components/schemas/cluster.reroute.CommandCancelAction" + "description": "Cancel allocation of a shard (or recovery). Accepts index and shard for index name and shard number, and node for the node to cancel the shard allocation on. This can be used to force resynchronization of existing replicas from the primary shard by cancelling them and allowing them to be reinitialized through the standard recovery process. By default only replica shard allocations can be cancelled. If it is necessary to cancel the allocation of a primary shard then the allow_primary flag must also be included in the request.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.reroute.CommandCancelAction" + } + ] }, "move": { - "$ref": "#/components/schemas/cluster.reroute.CommandMoveAction" + "description": "Move a started shard from one node to another node. Accepts index and shard for index name and shard number, from_node for the node to move the shard from, and to_node for the node to move the shard to.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.reroute.CommandMoveAction" + } + ] }, "allocate_replica": { - "$ref": "#/components/schemas/cluster.reroute.CommandAllocateReplicaAction" + "description": "Allocate an unassigned replica shard to a node. Accepts index and shard for index name and shard number, and node to allocate the shard to. Takes allocation deciders into account.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.reroute.CommandAllocateReplicaAction" + } + ] }, "allocate_stale_primary": { - "$ref": "#/components/schemas/cluster.reroute.CommandAllocatePrimaryAction" + "description": "Allocate a primary shard to a node that holds a stale copy. Accepts the index and shard for index name and shard number, and node to allocate the shard to. Using this command may lead to data loss for the provided shard id. If a node which has the good copy of the data rejoins the cluster later on, that data will be deleted or overwritten with the data of the stale copy that was forcefully allocated with this command. To ensure that these implications are well-understood, this command requires the flag accept_data_loss to be explicitly set to true.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.reroute.CommandAllocatePrimaryAction" + } + ] }, "allocate_empty_primary": { - "$ref": "#/components/schemas/cluster.reroute.CommandAllocatePrimaryAction" + "description": "Allocate an empty primary shard to a node. Accepts the index and shard for index name and shard number, and node to allocate the shard to. Using this command leads to a complete loss of all data that was indexed into this shard, if it was previously started. If a node which has a copy of the data rejoins the cluster later on, that data will be deleted. To ensure that these implications are well-understood, this command requires the flag accept_data_loss to be explicitly set to true.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.reroute.CommandAllocatePrimaryAction" + } + ] } } }, @@ -80188,7 +88733,11 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "shard": { "type": "number" @@ -80210,7 +88759,11 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "shard": { "type": "number" @@ -80235,7 +88788,11 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "shard": { "type": "number" @@ -80254,7 +88811,11 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "shard": { "type": "number" @@ -80287,7 +88848,11 @@ } }, "parameters": { - "$ref": "#/components/schemas/cluster.reroute.RerouteParameters" + "allOf": [ + { + "$ref": "#/components/schemas/cluster.reroute.RerouteParameters" + } + ] } }, "required": [ @@ -80322,19 +88887,35 @@ "type": "boolean" }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "node": { - "$ref": "#/components/schemas/_types.NodeName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeName" + } + ] }, "shard": { "type": "number" }, "from_node": { - "$ref": "#/components/schemas/_types.NodeName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeName" + } + ] }, "to_node": { - "$ref": "#/components/schemas/_types.NodeName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeName" + } + ] } }, "required": [ @@ -80353,16 +88934,36 @@ "type": "object", "properties": { "cluster_name": { - "$ref": "#/components/schemas/_types.Name" + "description": "Name of the cluster, based on the cluster name setting.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "cluster_uuid": { - "$ref": "#/components/schemas/_types.Uuid" + "description": "Unique identifier for the cluster.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Uuid" + } + ] }, "indices": { - "$ref": "#/components/schemas/cluster.stats.ClusterIndices" + "description": "Contains statistics about indices with shards assigned to selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.ClusterIndices" + } + ] }, "nodes": { - "$ref": "#/components/schemas/cluster.stats.ClusterNodes" + "description": "Contains statistics about nodes selected by the request’s node filters.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.ClusterNodes" + } + ] }, "repositories": { "description": "Contains stats on repository feature usage exposed in cluster stats for telemetry.", @@ -80375,17 +88976,32 @@ } }, "snapshots": { - "$ref": "#/components/schemas/cluster.stats.ClusterSnapshotStats" + "description": "Contains stats cluster snapshots.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.ClusterSnapshotStats" + } + ] }, "status": { - "$ref": "#/components/schemas/_types.HealthStatus" + "description": "Health status of the cluster, based on the state of its primary and replica shards.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.HealthStatus" + } + ] }, "timestamp": { "description": "Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed.", "type": "number" }, "ccs": { - "$ref": "#/components/schemas/cluster.stats.CCSStats" + "description": "Cross-cluster stats", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.CCSStats" + } + ] } }, "required": [ @@ -80405,38 +89021,88 @@ "type": "object", "properties": { "analysis": { - "$ref": "#/components/schemas/cluster.stats.CharFilterTypes" + "description": "Contains statistics about analyzers and analyzer components used in selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.CharFilterTypes" + } + ] }, "completion": { - "$ref": "#/components/schemas/_types.CompletionStats" + "description": "Contains statistics about memory used for completion in selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.CompletionStats" + } + ] }, "count": { "description": "Total number of indices with shards assigned to selected nodes.", "type": "number" }, "docs": { - "$ref": "#/components/schemas/_types.DocStats" + "description": "Contains counts for documents in selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DocStats" + } + ] }, "fielddata": { - "$ref": "#/components/schemas/_types.FielddataStats" + "description": "Contains statistics about the field data cache of selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.FielddataStats" + } + ] }, "query_cache": { - "$ref": "#/components/schemas/_types.QueryCacheStats" + "description": "Contains statistics about the query cache of selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.QueryCacheStats" + } + ] }, "search": { - "$ref": "#/components/schemas/cluster.stats.SearchUsageStats" + "description": "Holds a snapshot of the search usage statistics.\nUsed to hold the stats for a single node that's part of a ClusterStatsNodeResponse, as well as to\naccumulate stats for the entire cluster and return them as part of the ClusterStatsResponse.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.SearchUsageStats" + } + ] }, "segments": { - "$ref": "#/components/schemas/_types.SegmentsStats" + "description": "Contains statistics about segments in selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SegmentsStats" + } + ] }, "shards": { - "$ref": "#/components/schemas/cluster.stats.ClusterIndicesShards" + "description": "Contains statistics about indices with shards assigned to selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.ClusterIndicesShards" + } + ] }, "store": { - "$ref": "#/components/schemas/_types.StoreStats" + "description": "Contains statistics about the size of shards assigned to selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.StoreStats" + } + ] }, "mappings": { - "$ref": "#/components/schemas/cluster.stats.FieldTypesMappings" + "description": "Contains statistics about field mappings in selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.FieldTypesMappings" + } + ] }, "versions": { "description": "Contains statistics about analyzers and analyzer components used in selected nodes.", @@ -80446,10 +89112,20 @@ } }, "dense_vector": { - "$ref": "#/components/schemas/cluster.stats.DenseVectorStats" + "description": "Contains statistics about indexed dense vector", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.DenseVectorStats" + } + ] }, "sparse_vector": { - "$ref": "#/components/schemas/cluster.stats.SparseVectorStats" + "description": "Contains statistics about indexed sparse vector", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.SparseVectorStats" + } + ] } }, "required": [ @@ -80549,7 +89225,12 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The name for the field type in selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "count": { "description": "The number of occurrences of the field type in selected nodes.", @@ -80627,7 +89308,12 @@ "type": "number" }, "size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Total amount of memory used for completion across all shards assigned to selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "fields": { "type": "object", @@ -80644,7 +89330,11 @@ "type": "object", "properties": { "size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "size_in_bytes": { "type": "number" @@ -80670,7 +89360,12 @@ "type": "number" }, "total_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Human readable total_size_in_bytes", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] } }, "required": [ @@ -80685,7 +89380,11 @@ "type": "number" }, "memory_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "memory_size_in_bytes": { "type": "number" @@ -80697,7 +89396,11 @@ } }, "global_ordinals": { - "$ref": "#/components/schemas/_types.GlobalOrdinalsStats" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GlobalOrdinalsStats" + } + ] } }, "required": [ @@ -80709,7 +89412,11 @@ "type": "object", "properties": { "memory_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "memory_size_in_bytes": { "type": "number" @@ -80723,7 +89430,11 @@ "type": "object", "properties": { "build_time_in_millis": { - "$ref": "#/components/schemas/_types.UnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.UnitMillis" + } + ] }, "build_time": { "type": "string" @@ -80743,7 +89454,11 @@ "type": "object", "properties": { "build_time_in_millis": { - "$ref": "#/components/schemas/_types.UnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.UnitMillis" + } + ] }, "build_time": { "type": "string" @@ -80777,7 +89492,12 @@ "type": "number" }, "memory_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Total amount of memory used for the query cache across all shards assigned to selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "memory_size_in_bytes": { "description": "Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes.", @@ -80849,7 +89569,12 @@ "type": "number" }, "doc_values_memory": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Total amount of memory used for doc values across all shards assigned to selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "doc_values_memory_in_bytes": { "description": "Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.", @@ -80863,14 +89588,24 @@ } }, "fixed_bit_set": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Total amount of memory used by fixed bit sets across all shards assigned to selected nodes.\nFixed bit sets are used for nested object field types and type filters for join fields.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "fixed_bit_set_memory_in_bytes": { "description": "Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.", "type": "number" }, "index_writer_memory": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Total amount of memory used by all index writers across all shards assigned to selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "index_writer_memory_in_bytes": { "description": "Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.", @@ -80881,21 +89616,36 @@ "type": "number" }, "memory": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Total amount of memory used for segments across all shards assigned to selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "memory_in_bytes": { "description": "Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.", "type": "number" }, "norms_memory": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Total amount of memory used for normalization factors across all shards assigned to selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "norms_memory_in_bytes": { "description": "Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.", "type": "number" }, "points_memory": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Total amount of memory used for points across all shards assigned to selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "points_memory_in_bytes": { "description": "Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.", @@ -80906,24 +89656,44 @@ "type": "number" }, "stored_fields_memory": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Total amount of memory used for stored fields across all shards assigned to selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "terms_memory_in_bytes": { "description": "Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.", "type": "number" }, "terms_memory": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Total amount of memory used for terms across all shards assigned to selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "term_vectors_memory": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Total amount of memory used for term vectors across all shards assigned to selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "term_vectors_memory_in_bytes": { "description": "Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.", "type": "number" }, "version_map_memory": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Total amount of memory used by all version maps across all shards assigned to selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "version_map_memory_in_bytes": { "description": "Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes.", @@ -80978,7 +89748,12 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/cluster.stats.ClusterIndicesShardsIndex" + "description": "Contains statistics about shards assigned to selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.ClusterIndicesShardsIndex" + } + ] }, "primaries": { "description": "Number of primary shards assigned to selected nodes.", @@ -80998,13 +89773,28 @@ "type": "object", "properties": { "primaries": { - "$ref": "#/components/schemas/cluster.stats.ClusterShardMetrics" + "description": "Contains statistics about the number of primary shards assigned to selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.ClusterShardMetrics" + } + ] }, "replication": { - "$ref": "#/components/schemas/cluster.stats.ClusterShardMetrics" + "description": "Contains statistics about the number of replication shards assigned to selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.ClusterShardMetrics" + } + ] }, "shards": { - "$ref": "#/components/schemas/cluster.stats.ClusterShardMetrics" + "description": "Contains statistics about the number of shards assigned to selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.ClusterShardMetrics" + } + ] } }, "required": [ @@ -81039,21 +89829,36 @@ "type": "object", "properties": { "size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Total size of all shards assigned to selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "size_in_bytes": { "description": "Total size, in bytes, of all shards assigned to selected nodes.", "type": "number" }, "reserved": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "A prediction of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "reserved_in_bytes": { "description": "A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.", "type": "number" }, "total_data_set_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Total data set size of all shards assigned to selected nodes.\nThis includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "total_data_set_size_in_bytes": { "description": "Total data set size, in bytes, of all shards assigned to selected nodes.\nThis includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.", @@ -81091,7 +89896,12 @@ "type": "number" }, "total_deduplicated_mapping_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Total size of all mappings after deduplication and compression.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "total_deduplicated_mapping_size_in_bytes": { "description": "Total size of all mappings, in bytes, after deduplication and compression.", @@ -81154,7 +89964,12 @@ "type": "number" }, "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "Field data type used in selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "scriptless_count": { "description": "Number of runtime fields that don’t declare a script.", @@ -81203,10 +90018,18 @@ "type": "number" }, "total_primary_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] } }, "required": [ @@ -81223,7 +90046,11 @@ "type": "number" }, "off_heap": { - "$ref": "#/components/schemas/cluster.stats.DenseVectorOffHeapStats" + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.DenseVectorOffHeapStats" + } + ] } }, "required": [ @@ -81237,31 +90064,51 @@ "type": "number" }, "total_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "total_veb_size_bytes": { "type": "number" }, "total_veb_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "total_vec_size_bytes": { "type": "number" }, "total_vec_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "total_veq_size_bytes": { "type": "number" }, "total_veq_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "total_vex_size_bytes": { "type": "number" }, "total_vex_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "fielddata": { "type": "object", @@ -81296,7 +90143,12 @@ "type": "object", "properties": { "count": { - "$ref": "#/components/schemas/cluster.stats.ClusterNodeCount" + "description": "Contains counts for nodes selected by the request’s node filters.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.ClusterNodeCount" + } + ] }, "discovery_types": { "description": "Contains statistics about the discovery types used by selected nodes.", @@ -81306,22 +90158,51 @@ } }, "fs": { - "$ref": "#/components/schemas/cluster.stats.ClusterFileSystem" + "description": "Contains statistics about file stores by selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.ClusterFileSystem" + } + ] }, "indexing_pressure": { - "$ref": "#/components/schemas/cluster.stats.IndexingPressure" + "x-state": "Generally available; Added in 7.16.0", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.IndexingPressure" + } + ] }, "ingest": { - "$ref": "#/components/schemas/cluster.stats.ClusterIngest" + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.ClusterIngest" + } + ] }, "jvm": { - "$ref": "#/components/schemas/cluster.stats.ClusterJvm" + "description": "Contains statistics about the Java Virtual Machines (JVMs) used by selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.ClusterJvm" + } + ] }, "network_types": { - "$ref": "#/components/schemas/cluster.stats.ClusterNetworkTypes" + "description": "Contains statistics about the transport and HTTP networks used by selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.ClusterNetworkTypes" + } + ] }, "os": { - "$ref": "#/components/schemas/cluster.stats.ClusterOperatingSystem" + "description": "Contains statistics about the operating systems used by selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.ClusterOperatingSystem" + } + ] }, "packaging_types": { "description": "Contains statistics about Elasticsearch distributions installed on selected nodes.", @@ -81338,7 +90219,12 @@ } }, "process": { - "$ref": "#/components/schemas/cluster.stats.ClusterProcess" + "description": "Contains statistics about processes used by selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.ClusterProcess" + } + ] }, "versions": { "description": "Array of Elasticsearch versions used on selected nodes.", @@ -81437,42 +90323,73 @@ "type": "number" }, "available": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Total number of bytes available to JVM in file stores across all selected nodes.\nDepending on operating system or process-level restrictions, this number may be less than `nodes.fs.free_in_byes`.\nThis is the actual amount of free disk space the selected Elasticsearch nodes can use.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "free_in_bytes": { "description": "Total number, in bytes, of unallocated bytes in file stores across all selected nodes.", "type": "number" }, "free": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Total number of unallocated bytes in file stores across all selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "total_in_bytes": { "description": "Total size, in bytes, of all file stores across all selected nodes.", "type": "number" }, "total": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Total size of all file stores across all selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "low_watermark_free_space": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "low_watermark_free_space_in_bytes": { "type": "number" }, "high_watermark_free_space": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "high_watermark_free_space_in_bytes": { "type": "number" }, "flood_stage_free_space": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "flood_stage_free_space_in_bytes": { "type": "number" }, "frozen_flood_stage_free_space": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "frozen_flood_stage_free_space_in_bytes": { "type": "number" @@ -81483,7 +90400,11 @@ "type": "object", "properties": { "memory": { - "$ref": "#/components/schemas/nodes._types.IndexingPressureMemory" + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.IndexingPressureMemory" + } + ] } }, "required": [ @@ -81494,17 +90415,32 @@ "type": "object", "properties": { "limit": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Configured memory limit for the indexing requests.\nReplica requests have an automatic limit that is 1.5x this value.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "limit_in_bytes": { "description": "Configured memory limit, in bytes, for the indexing requests.\nReplica requests have an automatic limit that is 1.5x this value.", "type": "number" }, "current": { - "$ref": "#/components/schemas/nodes._types.PressureMemory" + "description": "Contains statistics for current indexing load.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.PressureMemory" + } + ] }, "total": { - "$ref": "#/components/schemas/nodes._types.PressureMemory" + "description": "Contains statistics for the cumulative indexing load since the node started.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.PressureMemory" + } + ] } } }, @@ -81512,35 +90448,60 @@ "type": "object", "properties": { "all": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Memory consumed by indexing requests in the coordinating, primary, or replica stage.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "all_in_bytes": { "description": "Memory consumed, in bytes, by indexing requests in the coordinating, primary, or replica stage.", "type": "number" }, "combined_coordinating_and_primary": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Memory consumed by indexing requests in the coordinating or primary stage.\nThis value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "combined_coordinating_and_primary_in_bytes": { "description": "Memory consumed, in bytes, by indexing requests in the coordinating or primary stage.\nThis value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally.", "type": "number" }, "coordinating": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Memory consumed by indexing requests in the coordinating stage.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "coordinating_in_bytes": { "description": "Memory consumed, in bytes, by indexing requests in the coordinating stage.", "type": "number" }, "primary": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Memory consumed by indexing requests in the primary stage.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "primary_in_bytes": { "description": "Memory consumed, in bytes, by indexing requests in the primary stage.", "type": "number" }, "replica": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Memory consumed by indexing requests in the replica stage.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "replica_in_bytes": { "description": "Memory consumed, in bytes, by indexing requests in the replica stage.", @@ -81597,10 +90558,18 @@ "type": "number" }, "time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } }, "required": [ @@ -81614,13 +90583,28 @@ "type": "object", "properties": { "max_uptime_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "Uptime duration, in milliseconds, since JVM last started.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "max_uptime": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Uptime duration since JVM last started.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "mem": { - "$ref": "#/components/schemas/cluster.stats.ClusterJvmMemory" + "description": "Contains statistics about memory used by selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.ClusterJvmMemory" + } + ] }, "threads": { "description": "Number of active threads in use by JVM across all selected nodes.", @@ -81649,14 +90633,24 @@ "type": "number" }, "heap_max": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Maximum amount of memory available for use by the heap across all selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "heap_used_in_bytes": { "description": "Memory, in bytes, currently in use by the heap across all selected nodes.", "type": "number" }, "heap_used": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Memory currently in use by the heap across all selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] } }, "required": [ @@ -81680,7 +90674,12 @@ "type": "boolean" }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "Version of JVM used by one or more selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "vm_name": { "description": "Name of the JVM.", @@ -81691,7 +90690,12 @@ "type": "string" }, "vm_version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "Full version number of JVM.\nThe full version number includes a plus sign (+) followed by the build number.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] } }, "required": [ @@ -81746,7 +90750,12 @@ "type": "number" }, "mem": { - "$ref": "#/components/schemas/cluster.stats.OperatingSystemMemoryInfo" + "description": "Contains statistics about memory used by selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.OperatingSystemMemoryInfo" + } + ] }, "names": { "description": "Contains statistics about operating systems used by selected nodes.", @@ -81797,14 +90806,25 @@ "type": "number" }, "adjusted_total": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Total amount of memory across all selected nodes, but using the value specified using the `es.total_memory_bytes` system property instead of measured total memory for those nodes where that system property was set.", + "x-state": "Generally available; Added in 7.16.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "free_in_bytes": { "description": "Amount, in bytes, of free physical memory across all selected nodes.", "type": "number" }, "free": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Amount of free physical memory across all selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "free_percent": { "description": "Percentage of free physical memory across all selected nodes.", @@ -81815,14 +90835,24 @@ "type": "number" }, "total": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Total amount of physical memory across all selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "used_in_bytes": { "description": "Amount, in bytes, of physical memory in use across all selected nodes.", "type": "number" }, "used": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Amount of physical memory in use across all selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "used_percent": { "description": "Percentage of physical memory in use across all selected nodes.", @@ -81845,7 +90875,12 @@ "type": "number" }, "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "Name of an operating system used by one or more selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] } }, "required": [ @@ -81861,7 +90896,12 @@ "type": "number" }, "pretty_name": { - "$ref": "#/components/schemas/_types.Name" + "description": "Human-readable name of an operating system used by one or more selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] } }, "required": [ @@ -81901,7 +90941,11 @@ "type": "string" }, "elasticsearch_version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "extended_plugins": { "type": "array", @@ -81913,13 +90957,25 @@ "type": "boolean" }, "java_version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "licensed": { "type": "boolean" @@ -81941,10 +90997,20 @@ "type": "object", "properties": { "cpu": { - "$ref": "#/components/schemas/cluster.stats.ClusterProcessCpu" + "description": "Contains statistics about CPU used by selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.ClusterProcessCpu" + } + ] }, "open_file_descriptors": { - "$ref": "#/components/schemas/cluster.stats.ClusterProcessOpenFileDescriptors" + "description": "Contains statistics about open file descriptors in selected nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.ClusterProcessOpenFileDescriptors" + } + ] } }, "required": [ @@ -81990,7 +91056,11 @@ "type": "object", "properties": { "current_counts": { - "$ref": "#/components/schemas/cluster.stats.SnapshotCurrentCounts" + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.SnapshotCurrentCounts" + } + ] }, "repositories": { "type": "object", @@ -82043,13 +91113,25 @@ "type": "string" }, "oldest_start_time_millis": { - "$ref": "#/components/schemas/_types.UnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.UnitMillis" + } + ] }, "oldest_start_time": { - "$ref": "#/components/schemas/_types.DateFormat" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateFormat" + } + ] }, "current_counts": { - "$ref": "#/components/schemas/cluster.stats.RepositoryStatsCurrentCounts" + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.RepositoryStatsCurrentCounts" + } + ] } }, "required": [ @@ -82080,7 +91162,11 @@ "type": "number" }, "shards": { - "$ref": "#/components/schemas/cluster.stats.RepositoryStatsShards" + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.RepositoryStatsShards" + } + ] } }, "required": [ @@ -82130,10 +91216,20 @@ } }, "_search": { - "$ref": "#/components/schemas/cluster.stats.CCSUsageStats" + "description": "Information about cross-cluster search usage.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.CCSUsageStats" + } + ] }, "_esql": { - "$ref": "#/components/schemas/cluster.stats.CCSUsageStats" + "description": "Information about ES|QL cross-cluster query usage.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.CCSUsageStats" + } + ] } }, "required": [ @@ -82160,7 +91256,12 @@ "type": "string" }, "status": { - "$ref": "#/components/schemas/_types.HealthStatus" + "description": "Health status of the cluster, based on the state of its primary and replica shards.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.HealthStatus" + } + ] }, "version": { "description": "The list of Elasticsearch versions used by the nodes on the remote cluster.", @@ -82237,13 +91338,28 @@ "type": "number" }, "took": { - "$ref": "#/components/schemas/cluster.stats.CCSUsageTimeValue" + "description": "Statistics about the time taken to execute cross-cluster search requests.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.CCSUsageTimeValue" + } + ] }, "took_mrt_true": { - "$ref": "#/components/schemas/cluster.stats.CCSUsageTimeValue" + "description": "Statistics about the time taken to execute cross-cluster search requests for which the `ccs_minimize_roundtrips` setting was set to `true`.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.CCSUsageTimeValue" + } + ] }, "took_mrt_false": { - "$ref": "#/components/schemas/cluster.stats.CCSUsageTimeValue" + "description": "Statistics about the time taken to execute cross-cluster search requests for which the `ccs_minimize_roundtrips` setting was set to `false`.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.CCSUsageTimeValue" + } + ] }, "remotes_per_search_max": { "description": "The maximum number of remote clusters that were queried in a single cross-cluster search request.", @@ -82299,13 +91415,28 @@ "type": "object", "properties": { "max": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The maximum time taken to execute a request, in milliseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "avg": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The average time taken to execute a request, in milliseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "p90": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The 90th percentile of the time taken to execute requests, in milliseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } }, "required": [ @@ -82326,7 +91457,12 @@ "type": "number" }, "took": { - "$ref": "#/components/schemas/cluster.stats.CCSUsageTimeValue" + "description": "Statistics about the time taken to execute requests against this cluster.", + "allOf": [ + { + "$ref": "#/components/schemas/cluster.stats.CCSUsageTimeValue" + } + ] } }, "required": [ @@ -82339,7 +91475,12 @@ "type": "object", "properties": { "_nodes": { - "$ref": "#/components/schemas/_types.NodeStatistics" + "description": "Contains statistics about the number of nodes selected by the request’s node filters.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeStatistics" + } + ] } } }, @@ -82392,10 +91533,18 @@ "type": "string" }, "configuration": { - "$ref": "#/components/schemas/connector._types.ConnectorConfiguration" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.ConnectorConfiguration" + } + ] }, "custom_scheduling": { - "$ref": "#/components/schemas/connector._types.ConnectorCustomScheduling" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.ConnectorCustomScheduling" + } + ] }, "deleted": { "type": "boolean" @@ -82415,7 +91564,11 @@ ] }, "features": { - "$ref": "#/components/schemas/connector._types.ConnectorFeatures" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.ConnectorFeatures" + } + ] }, "filtering": { "type": "array", @@ -82424,7 +91577,11 @@ } }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "index_name": { "oneOf": [ @@ -82447,49 +91604,89 @@ "type": "string" }, "last_access_control_sync_scheduled_at": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "last_access_control_sync_status": { - "$ref": "#/components/schemas/connector._types.SyncStatus" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.SyncStatus" + } + ] }, "last_deleted_document_count": { "type": "number" }, "last_incremental_sync_scheduled_at": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "last_indexed_document_count": { "type": "number" }, "last_seen": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "last_sync_error": { "type": "string" }, "last_sync_scheduled_at": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "last_sync_status": { - "$ref": "#/components/schemas/connector._types.SyncStatus" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.SyncStatus" + } + ] }, "last_synced": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "name": { "type": "string" }, "pipeline": { - "$ref": "#/components/schemas/connector._types.IngestPipelineParams" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.IngestPipelineParams" + } + ] }, "scheduling": { - "$ref": "#/components/schemas/connector._types.SchedulingConfiguration" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.SchedulingConfiguration" + } + ] }, "service_type": { "type": "string" }, "status": { - "$ref": "#/components/schemas/connector._types.ConnectorStatus" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.ConnectorStatus" + } + ] }, "sync_cursor": { "type": "object" @@ -82522,7 +91719,11 @@ "type": "string" }, "default_value": { - "$ref": "#/components/schemas/_types.ScalarValue" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScalarValue" + } + ] }, "depends_on": { "type": "array", @@ -82531,7 +91732,11 @@ } }, "display": { - "$ref": "#/components/schemas/connector._types.DisplayType" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.DisplayType" + } + ] }, "label": { "type": "string" @@ -82566,7 +91771,11 @@ ] }, "type": { - "$ref": "#/components/schemas/connector._types.ConnectorFieldType" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.ConnectorFieldType" + } + ] }, "ui_restrictions": { "type": "array", @@ -82623,7 +91832,11 @@ "type": "string" }, "value": { - "$ref": "#/components/schemas/_types.ScalarValue" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScalarValue" + } + ] } }, "required": [ @@ -82648,7 +91861,11 @@ "type": "string" }, "value": { - "$ref": "#/components/schemas/_types.ScalarValue" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScalarValue" + } + ] } }, "required": [ @@ -82790,7 +92007,11 @@ "type": "object", "properties": { "configuration_overrides": { - "$ref": "#/components/schemas/connector._types.CustomSchedulingConfigurationOverrides" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.CustomSchedulingConfigurationOverrides" + } + ] }, "enabled": { "type": "boolean" @@ -82799,7 +92020,11 @@ "type": "string" }, "last_synced": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "name": { "type": "string" @@ -82845,16 +92070,35 @@ "type": "object", "properties": { "document_level_security": { - "$ref": "#/components/schemas/connector._types.FeatureEnabled" + "description": "Indicates whether document-level security is enabled.", + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FeatureEnabled" + } + ] }, "incremental_sync": { - "$ref": "#/components/schemas/connector._types.FeatureEnabled" + "description": "Indicates whether incremental syncs are enabled.", + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FeatureEnabled" + } + ] }, "native_connector_api_keys": { - "$ref": "#/components/schemas/connector._types.FeatureEnabled" + "description": "Indicates whether managed connector API keys are enabled.", + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FeatureEnabled" + } + ] }, "sync_rules": { - "$ref": "#/components/schemas/connector._types.SyncRulesFeature" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.SyncRulesFeature" + } + ] } } }, @@ -82873,10 +92117,20 @@ "type": "object", "properties": { "advanced": { - "$ref": "#/components/schemas/connector._types.FeatureEnabled" + "description": "Indicates whether advanced sync rules are enabled.", + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FeatureEnabled" + } + ] }, "basic": { - "$ref": "#/components/schemas/connector._types.FeatureEnabled" + "description": "Indicates whether basic sync rules are enabled.", + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FeatureEnabled" + } + ] } } }, @@ -82884,13 +92138,21 @@ "type": "object", "properties": { "active": { - "$ref": "#/components/schemas/connector._types.FilteringRules" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FilteringRules" + } + ] }, "domain": { "type": "string" }, "draft": { - "$ref": "#/components/schemas/connector._types.FilteringRules" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FilteringRules" + } + ] } }, "required": [ @@ -82902,7 +92164,11 @@ "type": "object", "properties": { "advanced_snippet": { - "$ref": "#/components/schemas/connector._types.FilteringAdvancedSnippet" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FilteringAdvancedSnippet" + } + ] }, "rules": { "type": "array", @@ -82911,7 +92177,11 @@ } }, "validation": { - "$ref": "#/components/schemas/connector._types.FilteringRulesValidation" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FilteringRulesValidation" + } + ] } }, "required": [ @@ -82924,10 +92194,18 @@ "type": "object", "properties": { "created_at": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "updated_at": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "value": { "type": "object" @@ -82941,25 +92219,49 @@ "type": "object", "properties": { "created_at": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "order": { "type": "number" }, "policy": { - "$ref": "#/components/schemas/connector._types.FilteringPolicy" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FilteringPolicy" + } + ] }, "rule": { - "$ref": "#/components/schemas/connector._types.FilteringRuleRule" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FilteringRuleRule" + } + ] }, "updated_at": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "value": { "type": "string" @@ -83003,7 +92305,11 @@ } }, "state": { - "$ref": "#/components/schemas/connector._types.FilteringValidationState" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FilteringValidationState" + } + ] } }, "required": [ @@ -83079,13 +92385,25 @@ "type": "object", "properties": { "access_control": { - "$ref": "#/components/schemas/connector._types.ConnectorScheduling" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.ConnectorScheduling" + } + ] }, "full": { - "$ref": "#/components/schemas/connector._types.ConnectorScheduling" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.ConnectorScheduling" + } + ] }, "incremental": { - "$ref": "#/components/schemas/connector._types.ConnectorScheduling" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.ConnectorScheduling" + } + ] } } }, @@ -83119,19 +92437,39 @@ "type": "object", "properties": { "cancelation_requested_at": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "canceled_at": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "completed_at": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "connector": { - "$ref": "#/components/schemas/connector._types.SyncJobConnectorReference" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.SyncJobConnectorReference" + } + ] }, "created_at": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "deleted_document_count": { "type": "number" @@ -83140,7 +92478,11 @@ "type": "string" }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "indexed_document_count": { "type": "number" @@ -83149,10 +92491,18 @@ "type": "number" }, "job_type": { - "$ref": "#/components/schemas/connector._types.SyncJobType" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.SyncJobType" + } + ] }, "last_seen": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "metadata": { "type": "object", @@ -83161,16 +92511,28 @@ } }, "started_at": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "status": { - "$ref": "#/components/schemas/connector._types.SyncStatus" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.SyncStatus" + } + ] }, "total_document_count": { "type": "number" }, "trigger_method": { - "$ref": "#/components/schemas/connector._types.SyncJobTriggerMethod" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.SyncJobTriggerMethod" + } + ] }, "worker_hostname": { "type": "string" @@ -83194,13 +92556,25 @@ "type": "object", "properties": { "configuration": { - "$ref": "#/components/schemas/connector._types.ConnectorConfiguration" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.ConnectorConfiguration" + } + ] }, "filtering": { - "$ref": "#/components/schemas/connector._types.FilteringRules" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FilteringRules" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "index_name": { "type": "string" @@ -83209,7 +92583,11 @@ "type": "string" }, "pipeline": { - "$ref": "#/components/schemas/connector._types.IngestPipelineParams" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.IngestPipelineParams" + } + ] }, "service_type": { "type": "string" @@ -83245,26 +92623,56 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The unique identifier for the added document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The name of the index the document was added to.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "_primary_term": { "description": "The primary term assigned to the document for the indexing operation.", "type": "number" }, "result": { - "$ref": "#/components/schemas/_types.Result" + "description": "The result of the indexing operation: `created` or `updated`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] }, "_seq_no": { - "$ref": "#/components/schemas/_types.SequenceNumber" + "description": "The sequence number assigned to the document for the indexing operation.\nSequence numbers are used to ensure an older version of a document doesn't overwrite a newer version.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SequenceNumber" + } + ] }, "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "description": "Information about the replication process of the operation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] }, "_version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "The document version, which is incremented each time the document is updated.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "forced_refresh": { "type": "boolean" @@ -83288,10 +92696,18 @@ "type": "string" }, "creation_date_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "node_ids": { - "$ref": "#/components/schemas/_types.Ids" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Ids" + } + ] } }, "required": [ @@ -83329,13 +92745,25 @@ "type": "object", "properties": { "cause": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "status": { "type": "number" @@ -83391,7 +92819,12 @@ } }, "tasks": { - "$ref": "#/components/schemas/tasks._types.TaskInfos" + "description": "Either a flat list of tasks if `group_by` was set to `none`, or grouped by parents if\n`group_by` was set to `parents`.", + "allOf": [ + { + "$ref": "#/components/schemas/tasks._types.TaskInfos" + } + ] } } }, @@ -83402,13 +92835,21 @@ "type": "number" }, "node_id": { - "$ref": "#/components/schemas/_types.NodeId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] }, "status": { "type": "string" }, "reason": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] } }, "required": [ @@ -83422,16 +92863,32 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.NodeId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] }, "transport_address": { - "$ref": "#/components/schemas/_types.TransportAddress" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TransportAddress" + } + ] }, "host": { - "$ref": "#/components/schemas/_types.Host" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Host" + } + ] }, "ip": { - "$ref": "#/components/schemas/_types.Ip" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Ip" + } + ] }, "roles": { "type": "array", @@ -83482,16 +92939,32 @@ "type": "number" }, "node": { - "$ref": "#/components/schemas/_types.NodeId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] }, "running_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "running_time_in_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "start_time_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "status": { "description": "The internal status of the task, which varies from task to task.\nThe format also varies.\nWhile the goal is to keep the status for a particular task consistent from version to version, this is not always possible because sometimes the implementation changes.\nFields might be removed from the status for a particular request so any parsing you do of the status might break in minor releases.", @@ -83501,7 +92974,11 @@ "type": "string" }, "parent_task_id": { - "$ref": "#/components/schemas/_types.TaskId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TaskId" + } + ] } }, "required": [ @@ -83553,7 +93030,11 @@ "type": "object", "properties": { "phase": { - "$ref": "#/components/schemas/enrich.execute_policy.EnrichPolicyPhase" + "allOf": [ + { + "$ref": "#/components/schemas/enrich.execute_policy.EnrichPolicyPhase" + } + ] }, "step": { "type": "string" @@ -83593,19 +93074,39 @@ "type": "object", "properties": { "enrich_fields": { - "$ref": "#/components/schemas/_types.Fields" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "indices": { - "$ref": "#/components/schemas/_types.Indices" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "match_field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "elasticsearch_version": { "type": "string" @@ -83624,7 +93125,11 @@ "type": "number" }, "node_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "queue_size": { "type": "number" @@ -83648,10 +93153,18 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "task": { - "$ref": "#/components/schemas/tasks._types.TaskInfo" + "allOf": [ + { + "$ref": "#/components/schemas/tasks._types.TaskInfo" + } + ] } }, "required": [ @@ -83663,7 +93176,11 @@ "type": "object", "properties": { "node_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "count": { "type": "number" @@ -83672,13 +93189,21 @@ "type": "number" }, "hits_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "misses": { "type": "number" }, "misses_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "evictions": { "type": "number" @@ -83702,7 +93227,12 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Identifier for the search.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "is_partial": { "description": "If true, the response does not contain complete search results.", @@ -83713,14 +93243,24 @@ "type": "boolean" }, "took": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "Milliseconds it took Elasticsearch to execute the request.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "timed_out": { "description": "If true, the request timed out before completion.", "type": "boolean" }, "hits": { - "$ref": "#/components/schemas/eql._types.EqlHits" + "description": "Contains matching events and sequences. Also contains related metadata.", + "allOf": [ + { + "$ref": "#/components/schemas/eql._types.EqlHits" + } + ] }, "shard_failures": { "description": "Contains information about shard failures (if any), in case allow_partial_search_results=true", @@ -83738,7 +93278,12 @@ "type": "object", "properties": { "total": { - "$ref": "#/components/schemas/_global.search._types.TotalHits" + "description": "Metadata about the number of matching events or sequences.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.TotalHits" + } + ] }, "events": { "description": "Contains events matching the query. Each object represents a matching event.", @@ -83760,10 +93305,20 @@ "type": "object", "properties": { "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "Name of the index containing the event.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Unique identifier for the event. This ID is only unique within the index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_source": { "description": "Original JSON body passed for the event at index time.", @@ -83941,7 +93496,11 @@ "type": "object", "properties": { "took": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "is_partial": { "type": "boolean" @@ -83968,7 +93527,12 @@ } }, "_clusters": { - "$ref": "#/components/schemas/esql._types.EsqlClusterInfo" + "description": "Cross-cluster search information. Present if `include_ccs_metadata` was `true` in the request\nand a cross-cluster search was performed.", + "allOf": [ + { + "$ref": "#/components/schemas/esql._types.EsqlClusterInfo" + } + ] }, "profile": { "description": "Profiling information. Present if `profile` was `true` in the request.\nThe contents of this field are currently unstable.", @@ -84037,16 +93601,28 @@ "type": "object", "properties": { "status": { - "$ref": "#/components/schemas/esql._types.EsqlClusterStatus" + "allOf": [ + { + "$ref": "#/components/schemas/esql._types.EsqlClusterStatus" + } + ] }, "indices": { "type": "string" }, "took": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "_shards": { - "$ref": "#/components/schemas/esql._types.EsqlShardInfo" + "allOf": [ + { + "$ref": "#/components/schemas/esql._types.EsqlShardInfo" + } + ] }, "failures": { "type": "array", @@ -84108,10 +93684,18 @@ ] }, "node": { - "$ref": "#/components/schemas/_types.NodeId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] }, "reason": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] } }, "required": [ @@ -84127,7 +93711,11 @@ "type": "number" }, "node": { - "$ref": "#/components/schemas/_types.NodeId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] }, "start_time_millis": { "type": "number" @@ -84160,13 +93748,21 @@ "type": "boolean" }, "_seq_no": { - "$ref": "#/components/schemas/_types.SequenceNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SequenceNumber" + } + ] }, "_primary_term": { "type": "number" }, "_routing": { - "$ref": "#/components/schemas/_types.Routing" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "_source": { "type": "object" @@ -84199,16 +93795,36 @@ "type": "boolean" }, "indices": { - "$ref": "#/components/schemas/_types.Indices" + "description": "The list of indices where this field has the same type family, or null if all indices have the same type family for the field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "meta": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Merged metadata across all indices as a map of string keys to arrays of values. A value length of 1 indicates that all indices had the same value for this key, while a length of 2 or more indicates that not all indices had the same value for this key.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "non_aggregatable_indices": { - "$ref": "#/components/schemas/_types.Indices" + "description": "The list of indices where this field is not aggregatable, or null if all indices have the same definition for the field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "non_searchable_indices": { - "$ref": "#/components/schemas/_types.Indices" + "description": "The list of indices where this field is not searchable, or null if all indices have the same definition for the field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "searchable": { "description": "Whether this field is indexed for search on all indices.", @@ -84227,7 +93843,13 @@ "type": "boolean" }, "time_series_metric": { - "$ref": "#/components/schemas/_types.mapping.TimeSeriesMetricType" + "description": "Contains metric type if this fields is used as a time series\nmetrics, absent if the field is not used as metric.", + "x-state": "Technical preview; Added in 8.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TimeSeriesMetricType" + } + ] }, "non_dimension_indices": { "description": "If this list is present in response then some indices have the\nfield marked as a dimension and other indices, the ones in this list, do not.", @@ -84276,13 +93898,21 @@ "type": "boolean" }, "expand_wildcards": { - "$ref": "#/components/schemas/_types.ExpandWildcards" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ExpandWildcards" + } + ] }, "ignore_unavailable": { "type": "boolean" }, "index": { - "$ref": "#/components/schemas/_types.Indices" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "preference": { "type": "string" @@ -84291,10 +93921,18 @@ "type": "boolean" }, "routing": { - "$ref": "#/components/schemas/_types.Routing" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "search_type": { - "$ref": "#/components/schemas/_types.SearchType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SearchType" + } + ] }, "ccs_minimize_roundtrips": { "type": "boolean" @@ -84344,10 +93982,20 @@ "type": "boolean" }, "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "description": "A count of shards used for the request.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] }, "hits": { - "$ref": "#/components/schemas/_global.search._types.HitsMetadata" + "description": "The returned documents and metadata.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.HitsMetadata" + } + ] }, "aggregations": { "type": "object", @@ -84356,7 +94004,11 @@ } }, "_clusters": { - "$ref": "#/components/schemas/_types.ClusterStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ClusterStatistics" + } + ] }, "fields": { "type": "object", @@ -84371,13 +94023,29 @@ "type": "number" }, "profile": { - "$ref": "#/components/schemas/_global.search._types.Profile" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.Profile" + } + ] }, "pit_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_scroll_id": { - "$ref": "#/components/schemas/_types.ScrollId" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results" + }, + "description": "The identifier for the search and its search context.\nYou can use this scroll ID with the scroll API to retrieve the next batch of search results for the request.\nThis property is returned only if the `scroll` query parameter is specified in the request.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScrollId" + } + ] }, "suggest": { "type": "object", @@ -84404,7 +94072,11 @@ "type": "object", "properties": { "error": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] }, "status": { "type": "number" @@ -84419,7 +94091,12 @@ "type": "object", "properties": { "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The name of the index the document belongs to.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "fields": { "description": "If the `stored_fields` parameter is set to `true` and `found` is `true`, it contains the document fields stored in the index.", @@ -84439,7 +94116,12 @@ "type": "boolean" }, "_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The unique identifier for the document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_primary_term": { "description": "The primary term assigned to the document for the indexing operation.", @@ -84450,14 +94132,24 @@ "type": "string" }, "_seq_no": { - "$ref": "#/components/schemas/_types.SequenceNumber" + "description": "The sequence number assigned to the document for the indexing operation.\nSequence numbers are used to ensure an older version of a document doesn't overwrite a newer version.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SequenceNumber" + } + ] }, "_source": { "description": "If `found` is `true`, it contains the document data formatted in JSON.\nIf the `_source` parameter is set to `false` or the `stored_fields` parameter is set to `true`, it is excluded.", "type": "object" }, "_version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "The document version, which is ncremented each time the document is updated.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] } }, "required": [ @@ -84470,7 +94162,12 @@ "type": "object", "properties": { "lang": { - "$ref": "#/components/schemas/_types.ScriptLanguage" + "description": "The language the script is written in.\nFor search templates, use `mustache`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptLanguage" + } + ] }, "options": { "type": "object", @@ -84479,7 +94176,12 @@ } }, "source": { - "$ref": "#/components/schemas/_types.ScriptSource" + "description": "The script source.\nFor search templates, an object containing the search template.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptSource" + } + ] } }, "required": [ @@ -84497,7 +94199,11 @@ } }, "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] } }, "required": [ @@ -84509,7 +94215,11 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "return_type": { "type": "string" @@ -84531,7 +94241,11 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "type": { "type": "string" @@ -84552,7 +94266,11 @@ } }, "language": { - "$ref": "#/components/schemas/_types.ScriptLanguage" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptLanguage" + } + ] } }, "required": [ @@ -84564,10 +94282,20 @@ "type": "object", "properties": { "connections": { - "$ref": "#/components/schemas/graph._types.Hop" + "description": "Specifies one or more fields from which you want to extract terms that are associated with the specified vertices.", + "allOf": [ + { + "$ref": "#/components/schemas/graph._types.Hop" + } + ] }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "An optional guiding query that constrains the Graph API as it explores connected terms.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "vertices": { "description": "Contains the fields you are interested in.", @@ -84592,7 +94320,12 @@ } }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Identifies a field in the documents of interest.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "include": { "description": "Identifies the terms of interest that form the starting points from which you want to spider out.", @@ -84639,7 +94372,12 @@ "type": "object", "properties": { "sample_diversity": { - "$ref": "#/components/schemas/graph._types.SampleDiversity" + "description": "To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample.\nYou can do this by selecting a single-value field and setting a maximum number of documents per value for that field.", + "allOf": [ + { + "$ref": "#/components/schemas/graph._types.SampleDiversity" + } + ] }, "sample_size": { "description": "Each hop considers a sample of the best-matching documents on each shard.\nUsing samples improves the speed of execution and keeps exploration focused on meaningfully-connected terms.\nVery small values (less than 50) might not provide sufficient weight-of-evidence to identify significant connections between terms.\nVery large sample sizes can dilute the quality of the results and increase execution times.", @@ -84647,7 +94385,12 @@ "type": "number" }, "timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned.\nThis timeout is honored on a best-effort basis.\nExecution might overrun this timeout if, for example, a long pause is encountered while FieldData is loaded for a field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "use_significance": { "description": "Filters associated terms so only those that are significantly associated with your query are included.", @@ -84662,7 +94405,11 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "max_docs_per_value": { "type": "number" @@ -84703,7 +94450,11 @@ "type": "number" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "term": { "type": "string" @@ -84723,31 +94474,67 @@ "type": "object", "properties": { "master_is_stable": { - "$ref": "#/components/schemas/_global.health_report.MasterIsStableIndicator" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.MasterIsStableIndicator" + } + ] }, "shards_availability": { - "$ref": "#/components/schemas/_global.health_report.ShardsAvailabilityIndicator" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.ShardsAvailabilityIndicator" + } + ] }, "disk": { - "$ref": "#/components/schemas/_global.health_report.DiskIndicator" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.DiskIndicator" + } + ] }, "repository_integrity": { - "$ref": "#/components/schemas/_global.health_report.RepositoryIntegrityIndicator" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.RepositoryIntegrityIndicator" + } + ] }, "data_stream_lifecycle": { - "$ref": "#/components/schemas/_global.health_report.DataStreamLifecycleIndicator" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.DataStreamLifecycleIndicator" + } + ] }, "ilm": { - "$ref": "#/components/schemas/_global.health_report.IlmIndicator" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.IlmIndicator" + } + ] }, "slm": { - "$ref": "#/components/schemas/_global.health_report.SlmIndicator" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.SlmIndicator" + } + ] }, "shards_capacity": { - "$ref": "#/components/schemas/_global.health_report.ShardsCapacityIndicator" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.ShardsCapacityIndicator" + } + ] }, "file_settings": { - "$ref": "#/components/schemas/_global.health_report.FileSettingsIndicator" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.FileSettingsIndicator" + } + ] } } }, @@ -84761,7 +94548,11 @@ "type": "object", "properties": { "details": { - "$ref": "#/components/schemas/_global.health_report.MasterIsStableIndicatorDetails" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.MasterIsStableIndicatorDetails" + } + ] } } } @@ -84771,7 +94562,11 @@ "type": "object", "properties": { "current_master": { - "$ref": "#/components/schemas/_global.health_report.IndicatorNode" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.IndicatorNode" + } + ] }, "recent_masters": { "type": "array", @@ -84780,7 +94575,11 @@ } }, "exception_fetching_history": { - "$ref": "#/components/schemas/_global.health_report.MasterIsStableIndicatorExceptionFetchingHistory" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.MasterIsStableIndicatorExceptionFetchingHistory" + } + ] }, "cluster_formation": { "type": "array", @@ -84862,7 +94661,11 @@ "type": "object", "properties": { "status": { - "$ref": "#/components/schemas/_global.health_report.IndicatorHealthStatus" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.IndicatorHealthStatus" + } + ] }, "symptom": { "type": "string" @@ -84940,7 +94743,11 @@ "type": "string" }, "affected_resources": { - "$ref": "#/components/schemas/_global.health_report.DiagnosisAffectedResources" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.DiagnosisAffectedResources" + } + ] }, "cause": { "type": "string" @@ -84961,7 +94768,11 @@ "type": "object", "properties": { "indices": { - "$ref": "#/components/schemas/_types.Indices" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "nodes": { "type": "array", @@ -84999,7 +94810,11 @@ "type": "object", "properties": { "details": { - "$ref": "#/components/schemas/_global.health_report.ShardsAvailabilityIndicatorDetails" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.ShardsAvailabilityIndicatorDetails" + } + ] } } } @@ -85062,7 +94877,11 @@ "type": "object", "properties": { "details": { - "$ref": "#/components/schemas/_global.health_report.DiskIndicatorDetails" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.DiskIndicatorDetails" + } + ] } } } @@ -85105,7 +94924,11 @@ "type": "object", "properties": { "details": { - "$ref": "#/components/schemas/_global.health_report.RepositoryIntegrityIndicatorDetails" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.RepositoryIntegrityIndicatorDetails" + } + ] } } } @@ -85138,7 +94961,11 @@ "type": "object", "properties": { "details": { - "$ref": "#/components/schemas/_global.health_report.DataStreamLifecycleDetails" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.DataStreamLifecycleDetails" + } + ] } } } @@ -85169,7 +94996,11 @@ "type": "object", "properties": { "index_name": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "first_occurrence_timestamp": { "type": "number" @@ -85194,7 +95025,11 @@ "type": "object", "properties": { "details": { - "$ref": "#/components/schemas/_global.health_report.IlmIndicatorDetails" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.IlmIndicatorDetails" + } + ] } } } @@ -85204,7 +95039,11 @@ "type": "object", "properties": { "ilm_status": { - "$ref": "#/components/schemas/_types.LifecycleOperationMode" + "allOf": [ + { + "$ref": "#/components/schemas/_types.LifecycleOperationMode" + } + ] }, "policies": { "type": "number" @@ -85237,7 +95076,11 @@ "type": "object", "properties": { "details": { - "$ref": "#/components/schemas/_global.health_report.SlmIndicatorDetails" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.SlmIndicatorDetails" + } + ] } } } @@ -85247,13 +95090,21 @@ "type": "object", "properties": { "slm_status": { - "$ref": "#/components/schemas/_types.LifecycleOperationMode" + "allOf": [ + { + "$ref": "#/components/schemas/_types.LifecycleOperationMode" + } + ] }, "policies": { "type": "number" }, "unhealthy_policies": { - "$ref": "#/components/schemas/_global.health_report.SlmIndicatorUnhealthyPolicies" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.SlmIndicatorUnhealthyPolicies" + } + ] } }, "required": [ @@ -85288,7 +95139,11 @@ "type": "object", "properties": { "details": { - "$ref": "#/components/schemas/_global.health_report.ShardsCapacityIndicatorDetails" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.ShardsCapacityIndicatorDetails" + } + ] } } } @@ -85298,10 +95153,18 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/_global.health_report.ShardsCapacityIndicatorTierDetail" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.ShardsCapacityIndicatorTierDetail" + } + ] }, "frozen": { - "$ref": "#/components/schemas/_global.health_report.ShardsCapacityIndicatorTierDetail" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.ShardsCapacityIndicatorTierDetail" + } + ] } }, "required": [ @@ -85333,7 +95196,11 @@ "type": "object", "properties": { "details": { - "$ref": "#/components/schemas/_global.health_report.FileSettingsIndicatorDetails" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.FileSettingsIndicatorDetails" + } + ] } } } @@ -85371,40 +95238,80 @@ "type": "object", "properties": { "action": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "action_time": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "action_time_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "age": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "failed_step": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "failed_step_retry_count": { "type": "number" }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "index_creation_date": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "index_creation_date_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "is_auto_retryable_error": { "type": "boolean" }, "lifecycle_date": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "lifecycle_date_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "managed": { "type": "string", @@ -85413,16 +95320,32 @@ ] }, "phase": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "phase_time": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "phase_time_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "policy": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "previous_step_info": { "type": "object", @@ -85440,7 +95363,11 @@ "type": "string" }, "step": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "step_info": { "type": "object", @@ -85449,16 +95376,32 @@ } }, "step_time": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "step_time_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "phase_execution": { - "$ref": "#/components/schemas/ilm.explain_lifecycle.LifecycleExplainPhaseExecution" + "allOf": [ + { + "$ref": "#/components/schemas/ilm.explain_lifecycle.LifecycleExplainPhaseExecution" + } + ] }, "time_since_index_creation": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "skip": { "type": "boolean" @@ -85474,16 +95417,32 @@ "type": "object", "properties": { "phase_definition": { - "$ref": "#/components/schemas/ilm._types.Phase" + "allOf": [ + { + "$ref": "#/components/schemas/ilm._types.Phase" + } + ] }, "policy": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "modified_date_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] } }, "required": [ @@ -85496,10 +95455,18 @@ "type": "object", "properties": { "actions": { - "$ref": "#/components/schemas/ilm._types.Actions" + "allOf": [ + { + "$ref": "#/components/schemas/ilm._types.Actions" + } + ] }, "min_age": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } } }, @@ -85507,43 +95474,109 @@ "type": "object", "properties": { "allocate": { - "$ref": "#/components/schemas/ilm._types.AllocateAction" + "description": "Phases allowed: warm, cold.", + "allOf": [ + { + "$ref": "#/components/schemas/ilm._types.AllocateAction" + } + ] }, "delete": { - "$ref": "#/components/schemas/ilm._types.DeleteAction" + "description": "Phases allowed: delete.", + "allOf": [ + { + "$ref": "#/components/schemas/ilm._types.DeleteAction" + } + ] }, "downsample": { - "$ref": "#/components/schemas/ilm._types.DownsampleAction" + "description": "Phases allowed: hot, warm, cold.", + "allOf": [ + { + "$ref": "#/components/schemas/ilm._types.DownsampleAction" + } + ] }, "freeze": { - "$ref": "#/components/schemas/_types.EmptyObject" + "deprecated": true, + "description": "The freeze action is a noop in 8.x", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EmptyObject" + } + ] }, "forcemerge": { - "$ref": "#/components/schemas/ilm._types.ForceMergeAction" + "description": "Phases allowed: hot, warm.", + "allOf": [ + { + "$ref": "#/components/schemas/ilm._types.ForceMergeAction" + } + ] }, "migrate": { - "$ref": "#/components/schemas/ilm._types.MigrateAction" + "description": "Phases allowed: warm, cold.", + "allOf": [ + { + "$ref": "#/components/schemas/ilm._types.MigrateAction" + } + ] }, "readonly": { - "$ref": "#/components/schemas/_types.EmptyObject" + "description": "Phases allowed: hot, warm, cold.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EmptyObject" + } + ] }, "rollover": { - "$ref": "#/components/schemas/ilm._types.RolloverAction" + "description": "Phases allowed: hot.", + "allOf": [ + { + "$ref": "#/components/schemas/ilm._types.RolloverAction" + } + ] }, "set_priority": { - "$ref": "#/components/schemas/ilm._types.SetPriorityAction" + "description": "Phases allowed: hot, warm, cold.", + "allOf": [ + { + "$ref": "#/components/schemas/ilm._types.SetPriorityAction" + } + ] }, "searchable_snapshot": { - "$ref": "#/components/schemas/ilm._types.SearchableSnapshotAction" + "description": "Phases allowed: hot, cold, frozen.", + "allOf": [ + { + "$ref": "#/components/schemas/ilm._types.SearchableSnapshotAction" + } + ] }, "shrink": { - "$ref": "#/components/schemas/ilm._types.ShrinkAction" + "description": "Phases allowed: hot, warm.", + "allOf": [ + { + "$ref": "#/components/schemas/ilm._types.ShrinkAction" + } + ] }, "unfollow": { - "$ref": "#/components/schemas/_types.EmptyObject" + "description": "Phases allowed: hot, warm, cold, frozen.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EmptyObject" + } + ] }, "wait_for_snapshot": { - "$ref": "#/components/schemas/ilm._types.WaitForSnapshotAction" + "description": "Phases allowed: delete.", + "allOf": [ + { + "$ref": "#/components/schemas/ilm._types.WaitForSnapshotAction" + } + ] } } }, @@ -85588,10 +95621,18 @@ "type": "object", "properties": { "fixed_interval": { - "$ref": "#/components/schemas/_types.DurationLarge" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationLarge" + } + ] }, "wait_timeout": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } }, "required": [ @@ -85624,13 +95665,25 @@ "type": "object", "properties": { "max_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "max_primary_shard_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "max_age": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "max_docs": { "type": "number" @@ -85639,13 +95692,25 @@ "type": "number" }, "min_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "min_primary_shard_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "min_age": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "min_docs": { "type": "number" @@ -85684,7 +95749,11 @@ "type": "number" }, "max_primary_shard_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "allow_write_after_shrink": { "type": "boolean" @@ -85706,7 +95775,11 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "managed": { "type": "string", @@ -85724,13 +95797,25 @@ "type": "object", "properties": { "modified_date": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "policy": { - "$ref": "#/components/schemas/ilm._types.Policy" + "allOf": [ + { + "$ref": "#/components/schemas/ilm._types.Policy" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] } }, "required": [ @@ -85743,10 +95828,19 @@ "type": "object", "properties": { "phases": { - "$ref": "#/components/schemas/ilm._types.Phases" + "allOf": [ + { + "$ref": "#/components/schemas/ilm._types.Phases" + } + ] }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Arbitrary metadata that is not automatically generated or used by Elasticsearch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] } }, "required": [ @@ -85757,19 +95851,39 @@ "type": "object", "properties": { "cold": { - "$ref": "#/components/schemas/ilm._types.Phase" + "allOf": [ + { + "$ref": "#/components/schemas/ilm._types.Phase" + } + ] }, "delete": { - "$ref": "#/components/schemas/ilm._types.Phase" + "allOf": [ + { + "$ref": "#/components/schemas/ilm._types.Phase" + } + ] }, "frozen": { - "$ref": "#/components/schemas/ilm._types.Phase" + "allOf": [ + { + "$ref": "#/components/schemas/ilm._types.Phase" + } + ] }, "hot": { - "$ref": "#/components/schemas/ilm._types.Phase" + "allOf": [ + { + "$ref": "#/components/schemas/ilm._types.Phase" + } + ] }, "warm": { - "$ref": "#/components/schemas/ilm._types.Phase" + "allOf": [ + { + "$ref": "#/components/schemas/ilm._types.Phase" + } + ] } } }, @@ -85812,7 +95926,11 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "blocked": { "type": "boolean" @@ -85840,7 +95958,11 @@ "type": "object", "properties": { "analyzer": { - "$ref": "#/components/schemas/indices.analyze.AnalyzerDetail" + "allOf": [ + { + "$ref": "#/components/schemas/indices.analyze.AnalyzerDetail" + } + ] }, "charfilters": { "type": "array", @@ -85858,7 +95980,11 @@ } }, "tokenizer": { - "$ref": "#/components/schemas/indices.analyze.TokenDetail" + "allOf": [ + { + "$ref": "#/components/schemas/indices.analyze.TokenDetail" + } + ] } }, "required": [ @@ -85995,7 +96121,11 @@ "type": "object", "properties": { "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] } } }, @@ -86034,10 +96164,20 @@ "type": "object", "properties": { "mappings_override": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "description": "Mappings overrides to be applied to the destination index (optional)", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "settings_override": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "description": "Settings overrides to be applied to the destination index (optional)", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] }, "remove_index_blocks": { "description": "If index blocks should be removed when creating destination index (optional)", @@ -86054,13 +96194,28 @@ "type": "number" }, "data_stream": { - "$ref": "#/components/schemas/_types.Name" + "description": "Name of the data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "maximum_timestamp": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The data stream’s highest `@timestamp` value, converted to milliseconds since the Unix epoch.\nNOTE: This timestamp is provided as a best effort.\nThe data stream may contain `@timestamp` values higher than this if one or more of the following conditions are met:\nThe stream contains closed backing indices;\nBacking indices with a lower generation contain higher `@timestamp` values.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "store_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Total size of all shards for the data stream’s backing indices.\nThis parameter is only returned if the `human` query parameter is `true`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "store_size_bytes": { "description": "Total size, in bytes, of all shards for the data stream’s backing indices.", @@ -86083,7 +96238,11 @@ "type": "object", "properties": { "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] } } } @@ -86121,28 +96280,56 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "managed_by_lifecycle": { "type": "boolean" }, "index_creation_date_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "time_since_index_creation": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "rollover_date_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "time_since_rollover": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "lifecycle": { - "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover" + } + ] }, "generation_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "error": { "type": "string" @@ -86157,7 +96344,11 @@ "type": "object", "properties": { "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] } }, "required": [ @@ -86219,10 +96410,18 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.DataStreamName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DataStreamName" + } + ] }, "lifecycle": { - "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover" + } + ] } }, "required": [ @@ -86241,7 +96440,12 @@ "type": "number" }, "name": { - "$ref": "#/components/schemas/_types.DataStreamName" + "description": "The name of the data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DataStreamName" + } + ] } }, "required": [ @@ -86254,14 +96458,24 @@ "type": "object", "properties": { "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Custom metadata for the stream, copied from the `_meta` object of the stream’s matching index template.\nIf empty, the response omits this property.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "allow_custom_routing": { "description": "If `true`, the data stream allows custom routing on write request.", "type": "boolean" }, "failure_store": { - "$ref": "#/components/schemas/indices._types.FailureStore" + "description": "Information about failure store backing indices", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.FailureStore" + } + ] }, "generation": { "description": "Current generation for the data stream. This number acts as a cumulative count of the stream’s rollovers, starting at 1.", @@ -86272,10 +96486,20 @@ "type": "boolean" }, "ilm_policy": { - "$ref": "#/components/schemas/_types.Name" + "description": "Name of the current ILM lifecycle policy in the stream’s matching index template.\nThis lifecycle policy is set in the `index.lifecycle.name` setting.\nIf the template does not include a lifecycle policy, this property is not included in the response.\nNOTE: A data stream’s backing indices may be assigned different lifecycle policies. To retrieve the lifecycle policy for individual backing indices, use the get index settings API.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "next_generation_managed_by": { - "$ref": "#/components/schemas/indices._types.ManagedBy" + "description": "Name of the lifecycle system that'll manage the next generation of the data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.ManagedBy" + } + ] }, "prefer_ilm": { "description": "Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream.", @@ -86289,10 +96513,21 @@ } }, "lifecycle": { - "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover" + "description": "Contains the configuration for the data stream lifecycle of this data stream.", + "x-state": "Generally available; Added in 8.11.0", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.DataStreamName" + "description": "Name of the data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DataStreamName" + } + ] }, "replicated": { "description": "If `true`, the data stream is created and managed by cross-cluster replication and the local cluster can not write into this data stream or change its mappings.", @@ -86303,13 +96538,28 @@ "type": "boolean" }, "settings": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "description": "The settings specific to this data stream that will take precedence over the settings in the matching index\ntemplate.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "description": "The mappings specific to this data stream that will take precedence over the mappings in the matching index\ntemplate.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "status": { - "$ref": "#/components/schemas/_types.HealthStatus" + "description": "Health status of the data stream.\nThis health status is based on the state of the primary and replica shards of the stream’s backing indices.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.HealthStatus" + } + ] }, "system": { "description": "If `true`, the data stream is created and managed by an Elastic stack component and cannot be modified through normal user interaction.", @@ -86317,13 +96567,28 @@ "type": "boolean" }, "template": { - "$ref": "#/components/schemas/_types.Name" + "description": "Name of the index template used to create the data stream’s backing indices.\nThe template’s index pattern must match the name of this data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "timestamp_field": { - "$ref": "#/components/schemas/indices._types.DataStreamTimestampField" + "description": "Information about the `@timestamp` field in the data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamTimestampField" + } + ] }, "index_mode": { - "$ref": "#/components/schemas/indices._types.IndexMode" + "description": "The index mode for the data stream that will be used for newly created backing indices.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexMode" + } + ] } }, "required": [ @@ -86366,23 +96631,48 @@ "type": "object", "properties": { "index_name": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "Name of the backing index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "index_uuid": { - "$ref": "#/components/schemas/_types.Uuid" + "description": "Universally unique identifier (UUID) for the index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Uuid" + } + ] }, "ilm_policy": { - "$ref": "#/components/schemas/_types.Name" + "description": "Name of the current ILM lifecycle policy configured for this backing index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "managed_by": { - "$ref": "#/components/schemas/indices._types.ManagedBy" + "description": "Name of the lifecycle system that's currently managing this backing index.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.ManagedBy" + } + ] }, "prefer_ilm": { "description": "Indicates if ILM should take precedence over DSL in case both are configured to manage this index.", "type": "boolean" }, "index_mode": { - "$ref": "#/components/schemas/indices._types.IndexMode" + "description": "The index mode of this backing index of the data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexMode" + } + ] } }, "required": [ @@ -86411,7 +96701,12 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Field" + "description": "Name of the timestamp field for the data stream, which must be `@timestamp`. The `@timestamp` field must be included in every document indexed to the data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -86426,10 +96721,20 @@ "type": "string" }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "description": "The settings specific to this data stream", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "effective_mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "description": "The settings specific to this data stream merged with the settings from its template. These `effective_settings`\nare the settings that will be used when a new index is created for this data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] } }, "required": [ @@ -86442,10 +96747,18 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.DataStreamName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DataStreamName" + } + ] }, "options": { - "$ref": "#/components/schemas/indices._types.DataStreamOptions" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamOptions" + } + ] } }, "required": [ @@ -86457,7 +96770,12 @@ "type": "object", "properties": { "failure_store": { - "$ref": "#/components/schemas/indices._types.DataStreamFailureStore" + "description": "If defined, it specifies configuration for the failure store of this data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamFailureStore" + } + ] } } }, @@ -86471,7 +96789,12 @@ "type": "boolean" }, "lifecycle": { - "$ref": "#/components/schemas/indices._types.FailureStoreLifecycle" + "description": "If defined, it specifies the lifecycle configuration for the failure store of this data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.FailureStoreLifecycle" + } + ] } } }, @@ -86480,7 +96803,12 @@ "type": "object", "properties": { "data_retention": { - "$ref": "#/components/schemas/_types.Duration" + "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.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "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.", @@ -86497,10 +96825,20 @@ "type": "string" }, "settings": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "description": "The settings specific to this data stream", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] }, "effective_settings": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "description": "The settings specific to this data stream merged with the settings from its template. These `effective_settings`\nare the settings that will be used when a new index is created for this data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] } }, "required": [ @@ -86547,10 +96885,18 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "index_template": { - "$ref": "#/components/schemas/indices._types.IndexTemplate" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexTemplate" + } + ] } }, "required": [ @@ -86562,7 +96908,12 @@ "type": "object", "properties": { "index_patterns": { - "$ref": "#/components/schemas/_types.Names" + "description": "Name of the index template.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Names" + } + ] }, "composed_of": { "description": "An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence.", @@ -86572,23 +96923,43 @@ } }, "template": { - "$ref": "#/components/schemas/indices._types.IndexTemplateSummary" + "description": "Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexTemplateSummary" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "priority": { "description": "Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch.", "type": "number" }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Optional user metadata about the index template. May have any contents.\nThis map is not automatically generated by Elasticsearch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "allow_auto_create": { "type": "boolean" }, "data_stream": { - "$ref": "#/components/schemas/indices._types.IndexTemplateDataStreamConfiguration" + "description": "If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexTemplateDataStreamConfiguration" + } + ] }, "deprecated": { "description": "Marks this index template as deprecated.\nWhen creating or updating a non-deprecated index template that uses deprecated components,\nElasticsearch will emit a deprecation warning.", @@ -86596,7 +96967,13 @@ "type": "boolean" }, "ignore_missing_component_templates": { - "$ref": "#/components/schemas/_types.Names" + "description": "A list of component template names that are allowed to be absent.", + "x-state": "Generally available; Added in 8.7.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Names" + } + ] } }, "required": [ @@ -86615,13 +96992,28 @@ } }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "description": "Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping parameters.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "settings": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "description": "Configuration options for the index.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] }, "lifecycle": { - "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover" + "x-state": "Generally available; Added in 8.11.0", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover" + } + ] }, "data_stream_options": { "x-state": "Generally available; Added in 8.19.0", @@ -86656,10 +97048,18 @@ "type": "object", "properties": { "item": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] } }, "required": [ @@ -86716,7 +97116,11 @@ } }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "order": { "type": "number" @@ -86728,7 +97132,11 @@ } }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] } }, "required": [ @@ -86743,10 +97151,20 @@ "type": "object", "properties": { "mode": { - "$ref": "#/components/schemas/indices.migrate_reindex.ModeEnum" + "description": "Reindex mode. Currently only 'upgrade' is supported.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.migrate_reindex.ModeEnum" + } + ] }, "source": { - "$ref": "#/components/schemas/indices.migrate_reindex.SourceIndex" + "description": "The source index or data stream (only data streams are currently supported).", + "allOf": [ + { + "$ref": "#/components/schemas/indices.migrate_reindex.SourceIndex" + } + ] } }, "required": [ @@ -86764,7 +97182,11 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] } }, "required": [ @@ -86775,10 +97197,20 @@ "type": "object", "properties": { "add_backing_index": { - "$ref": "#/components/schemas/indices.modify_data_stream.IndexAndDataStreamAction" + "description": "Adds an existing index as a backing index for a data stream.\nThe index is hidden as part of this operation.\nWARNING: Adding indices with the `add_backing_index` action can potentially result in improper data stream behavior.\nThis should be considered an expert level API.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.modify_data_stream.IndexAndDataStreamAction" + } + ] }, "remove_backing_index": { - "$ref": "#/components/schemas/indices.modify_data_stream.IndexAndDataStreamAction" + "description": "Removes a backing index from a data stream.\nThe index is unhidden as part of this operation.\nA data stream’s write index cannot be removed.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.modify_data_stream.IndexAndDataStreamAction" + } + ] } }, "minProperties": 1, @@ -86788,10 +97220,20 @@ "type": "object", "properties": { "data_stream": { - "$ref": "#/components/schemas/_types.DataStreamName" + "description": "Data stream targeted by the action.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DataStreamName" + } + ] }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "Index for the action.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] } }, "required": [ @@ -86803,7 +97245,12 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The data stream name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "applied_to_data_stream": { "description": "If the mappings were successfully applied to the data stream (or would have been, if running in `dry_run`\nmode), it is `true`. If an error occurred, it is `false`.", @@ -86814,10 +97261,20 @@ "type": "string" }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "description": "The mappings that are specfic to this data stream that will override any mappings from the matching index template.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "effective_mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "description": "The mappings that are effective on this data stream, taking into account the mappings from the matching index\ntemplate and the mappings specific to this data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] } }, "required": [ @@ -86829,7 +97286,12 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The data stream name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "applied_to_data_stream": { "description": "If the settings were successfully applied to the data stream (or would have been, if running in `dry_run`\nmode), it is `true`. If an error occurred, it is `false`.", @@ -86840,13 +97302,28 @@ "type": "string" }, "settings": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "description": "The settings that are specfic to this data stream that will override any settings from the matching index template.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] }, "effective_settings": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "description": "The settings that are effective on this data stream, taking into account the settings from the matching index\ntemplate and the settings specific to this data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] }, "index_settings_results": { - "$ref": "#/components/schemas/indices.put_data_stream_settings.IndexSettingResults" + "description": "Information about whether and where each setting was applied.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.put_data_stream_settings.IndexSettingResults" + } + ] } }, "required": [ @@ -86890,7 +97367,11 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "error": { "description": "A message explaining why the settings could not be applied to specific indices.", @@ -86913,13 +97394,28 @@ } }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "description": "Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping parameters.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "settings": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "description": "Configuration options for the index.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] }, "lifecycle": { - "$ref": "#/components/schemas/indices._types.DataStreamLifecycle" + "x-state": "Generally available; Added in 8.11.0", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamLifecycle" + } + ] } } }, @@ -86955,49 +97451,97 @@ "type": "number" }, "index": { - "$ref": "#/components/schemas/indices.recovery.RecoveryIndexStatus" + "allOf": [ + { + "$ref": "#/components/schemas/indices.recovery.RecoveryIndexStatus" + } + ] }, "primary": { "type": "boolean" }, "source": { - "$ref": "#/components/schemas/indices.recovery.RecoveryOrigin" + "allOf": [ + { + "$ref": "#/components/schemas/indices.recovery.RecoveryOrigin" + } + ] }, "stage": { "type": "string" }, "start": { - "$ref": "#/components/schemas/indices.recovery.RecoveryStartStatus" + "allOf": [ + { + "$ref": "#/components/schemas/indices.recovery.RecoveryStartStatus" + } + ] }, "start_time": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "start_time_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "stop_time": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "stop_time_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "target": { - "$ref": "#/components/schemas/indices.recovery.RecoveryOrigin" + "allOf": [ + { + "$ref": "#/components/schemas/indices.recovery.RecoveryOrigin" + } + ] }, "total_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "total_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "translog": { - "$ref": "#/components/schemas/indices.recovery.TranslogStatus" + "allOf": [ + { + "$ref": "#/components/schemas/indices.recovery.TranslogStatus" + } + ] }, "type": { "type": "string" }, "verify_index": { - "$ref": "#/components/schemas/indices.recovery.VerifyIndex" + "allOf": [ + { + "$ref": "#/components/schemas/indices.recovery.VerifyIndex" + } + ] } }, "required": [ @@ -87018,31 +97562,67 @@ "type": "object", "properties": { "bytes": { - "$ref": "#/components/schemas/indices.recovery.RecoveryBytes" + "allOf": [ + { + "$ref": "#/components/schemas/indices.recovery.RecoveryBytes" + } + ] }, "files": { - "$ref": "#/components/schemas/indices.recovery.RecoveryFiles" + "allOf": [ + { + "$ref": "#/components/schemas/indices.recovery.RecoveryFiles" + } + ] }, "size": { - "$ref": "#/components/schemas/indices.recovery.RecoveryBytes" + "allOf": [ + { + "$ref": "#/components/schemas/indices.recovery.RecoveryBytes" + } + ] }, "source_throttle_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "source_throttle_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "target_throttle_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "target_throttle_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "total_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "total_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } }, "required": [ @@ -87057,31 +97637,67 @@ "type": "object", "properties": { "percent": { - "$ref": "#/components/schemas/_types.Percentage" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Percentage" + } + ] }, "recovered": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "recovered_in_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "recovered_from_snapshot": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "recovered_from_snapshot_in_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "reused": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "reused_in_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "total": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "total_in_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] } }, "required": [ @@ -87101,7 +97717,11 @@ } }, "percent": { - "$ref": "#/components/schemas/_types.Percentage" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Percentage" + } + ] }, "recovered": { "type": "number" @@ -87146,37 +97766,77 @@ "type": "string" }, "host": { - "$ref": "#/components/schemas/_types.Host" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Host" + } + ] }, "transport_address": { - "$ref": "#/components/schemas/_types.TransportAddress" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TransportAddress" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "ip": { - "$ref": "#/components/schemas/_types.Ip" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Ip" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "bootstrap_new_history_uuid": { "type": "boolean" }, "repository": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "snapshot": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "restoreUUID": { - "$ref": "#/components/schemas/_types.Uuid" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Uuid" + } + ] }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] } } }, @@ -87184,16 +97844,32 @@ "type": "object", "properties": { "check_index_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "check_index_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "total_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "total_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } }, "required": [ @@ -87205,7 +97881,11 @@ "type": "object", "properties": { "percent": { - "$ref": "#/components/schemas/_types.Percentage" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Percentage" + } + ] }, "recovered": { "type": "number" @@ -87217,10 +97897,18 @@ "type": "number" }, "total_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "total_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } }, "required": [ @@ -87235,16 +97923,32 @@ "type": "object", "properties": { "check_index_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "check_index_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "total_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "total_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } }, "required": [ @@ -87262,7 +97966,11 @@ } }, "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] } }, "required": [ @@ -87299,13 +98007,21 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "unblocked": { "type": "boolean" }, "exception": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] } }, "required": [ @@ -87333,7 +98049,12 @@ "type": "string" }, "version": { - "$ref": "#/components/schemas/_types.ElasticsearchVersionMinInfo" + "description": "Provides version information about the cluster.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ElasticsearchVersionMinInfo" + } + ] } }, "required": [ @@ -87349,10 +98070,18 @@ "type": "string" }, "minimum_index_compatibility_version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "minimum_wire_compatibility_version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "number": { "type": "string" @@ -87369,7 +98098,11 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "aliases": { "type": "array", @@ -87384,7 +98117,11 @@ } }, "data_stream": { - "$ref": "#/components/schemas/_types.DataStreamName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DataStreamName" + } + ] } }, "required": [ @@ -87396,10 +98133,18 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "indices": { - "$ref": "#/components/schemas/_types.Indices" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] } }, "required": [ @@ -87411,13 +98156,25 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.DataStreamName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DataStreamName" + } + ] }, "timestamp_field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "backing_indices": { - "$ref": "#/components/schemas/_types.Indices" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] } }, "required": [ @@ -87430,13 +98187,25 @@ "type": "object", "properties": { "min_age": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "max_age": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "max_age_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "min_docs": { "type": "number" @@ -87445,25 +98214,41 @@ "type": "number" }, "max_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "max_size_bytes": { "type": "number" }, "min_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "min_size_bytes": { "type": "number" }, "max_primary_shard_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "max_primary_shard_size_bytes": { "type": "number" }, "min_primary_shard_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "min_primary_shard_size_bytes": { "type": "number" @@ -87507,7 +98292,11 @@ "type": "number" }, "routing": { - "$ref": "#/components/schemas/indices.segments.ShardSegmentRouting" + "allOf": [ + { + "$ref": "#/components/schemas/indices.segments.ShardSegmentRouting" + } + ] }, "num_search_segments": { "type": "number" @@ -87576,7 +98365,11 @@ "type": "number" }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] } }, "required": [ @@ -87632,13 +98425,25 @@ "type": "object", "properties": { "allocation": { - "$ref": "#/components/schemas/indices.shard_stores.ShardStoreAllocation" + "allOf": [ + { + "$ref": "#/components/schemas/indices.shard_stores.ShardStoreAllocation" + } + ] }, "allocation_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "store_exception": { - "$ref": "#/components/schemas/indices.shard_stores.ShardStoreException" + "allOf": [ + { + "$ref": "#/components/schemas/indices.shard_stores.ShardStoreException" + } + ] } }, "required": [ @@ -87672,7 +98477,11 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "index_patterns": { "type": "array", @@ -87696,10 +98505,18 @@ } }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "settings": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] } }, "required": [ @@ -87712,7 +98529,11 @@ "type": "object", "properties": { "primaries": { - "$ref": "#/components/schemas/indices.stats.IndexStats" + "allOf": [ + { + "$ref": "#/components/schemas/indices.stats.IndexStats" + } + ] }, "shards": { "type": "object", @@ -87724,16 +98545,34 @@ } }, "total": { - "$ref": "#/components/schemas/indices.stats.IndexStats" + "allOf": [ + { + "$ref": "#/components/schemas/indices.stats.IndexStats" + } + ] }, "uuid": { - "$ref": "#/components/schemas/_types.Uuid" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Uuid" + } + ] }, "health": { - "$ref": "#/components/schemas/_types.HealthStatus" + "x-state": "Generally available; Added in 8.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.HealthStatus" + } + ] }, "status": { - "$ref": "#/components/schemas/indices.stats.IndexMetadataState" + "x-state": "Generally available; Added in 8.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/indices.stats.IndexMetadataState" + } + ] } } }, @@ -87741,61 +98580,155 @@ "type": "object", "properties": { "completion": { - "$ref": "#/components/schemas/_types.CompletionStats" + "description": "Contains statistics about completions across all shards assigned to the node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.CompletionStats" + } + ] }, "docs": { - "$ref": "#/components/schemas/_types.DocStats" + "description": "Contains statistics about documents across all primary shards assigned to the node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DocStats" + } + ] }, "fielddata": { - "$ref": "#/components/schemas/_types.FielddataStats" + "description": "Contains statistics about the field data cache across all shards assigned to the node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.FielddataStats" + } + ] }, "flush": { - "$ref": "#/components/schemas/_types.FlushStats" + "description": "Contains statistics about flush operations for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.FlushStats" + } + ] }, "get": { - "$ref": "#/components/schemas/_types.GetStats" + "description": "Contains statistics about get operations for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.GetStats" + } + ] }, "indexing": { - "$ref": "#/components/schemas/_types.IndexingStats" + "description": "Contains statistics about indexing operations for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexingStats" + } + ] }, "indices": { - "$ref": "#/components/schemas/indices.stats.IndicesStats" + "description": "Contains statistics about indices operations for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.stats.IndicesStats" + } + ] }, "merges": { - "$ref": "#/components/schemas/_types.MergesStats" + "description": "Contains statistics about merge operations for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MergesStats" + } + ] }, "query_cache": { - "$ref": "#/components/schemas/_types.QueryCacheStats" + "description": "Contains statistics about the query cache across all shards assigned to the node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.QueryCacheStats" + } + ] }, "recovery": { - "$ref": "#/components/schemas/_types.RecoveryStats" + "description": "Contains statistics about recovery operations for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RecoveryStats" + } + ] }, "refresh": { - "$ref": "#/components/schemas/_types.RefreshStats" + "description": "Contains statistics about refresh operations for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RefreshStats" + } + ] }, "request_cache": { - "$ref": "#/components/schemas/_types.RequestCacheStats" + "description": "Contains statistics about the request cache across all shards assigned to the node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RequestCacheStats" + } + ] }, "search": { - "$ref": "#/components/schemas/_types.SearchStats" + "description": "Contains statistics about search operations for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SearchStats" + } + ] }, "segments": { - "$ref": "#/components/schemas/_types.SegmentsStats" + "description": "Contains statistics about segments across all shards assigned to the node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SegmentsStats" + } + ] }, "store": { - "$ref": "#/components/schemas/_types.StoreStats" + "description": "Contains statistics about the size of shards assigned to the node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.StoreStats" + } + ] }, "translog": { - "$ref": "#/components/schemas/_types.TranslogStats" + "description": "Contains statistics about transaction log operations for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TranslogStats" + } + ] }, "warmer": { - "$ref": "#/components/schemas/_types.WarmerStats" + "description": "Contains statistics about index warming operations for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.WarmerStats" + } + ] }, "bulk": { - "$ref": "#/components/schemas/_types.BulkStats" + "allOf": [ + { + "$ref": "#/components/schemas/_types.BulkStats" + } + ] }, "shard_stats": { - "$ref": "#/components/schemas/indices.stats.ShardsTotalStats" + "x-state": "Generally available; Added in 7.15.0", + "allOf": [ + { + "$ref": "#/components/schemas/indices.stats.ShardsTotalStats" + } + ] } } }, @@ -87809,10 +98742,18 @@ "type": "number" }, "total_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "total_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } }, "required": [ @@ -87828,28 +98769,52 @@ "type": "number" }, "exists_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "exists_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "exists_total": { "type": "number" }, "missing_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "missing_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "missing_total": { "type": "number" }, "time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "total": { "type": "number" @@ -87875,10 +98840,18 @@ "type": "number" }, "delete_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "delete_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "delete_total": { "type": "number" @@ -87890,16 +98863,32 @@ "type": "number" }, "throttle_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "throttle_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "index_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "index_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "index_total": { "type": "number" @@ -87970,22 +98959,46 @@ "type": "number" }, "total_stopped_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "total_stopped_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "total_throttled_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "total_throttled_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "total_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "total_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } }, "required": [ @@ -88011,10 +99024,18 @@ "type": "number" }, "throttle_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "throttle_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } }, "required": [ @@ -88030,7 +99051,11 @@ "type": "number" }, "external_total_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "listeners": { "type": "number" @@ -88039,10 +99064,18 @@ "type": "number" }, "total_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "total_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } }, "required": [ @@ -88086,10 +99119,18 @@ "type": "number" }, "fetch_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "fetch_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "fetch_total": { "type": "number" @@ -88101,10 +99142,18 @@ "type": "number" }, "query_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "query_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "query_total": { "type": "number" @@ -88113,10 +99162,18 @@ "type": "number" }, "scroll_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "scroll_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "scroll_total": { "type": "number" @@ -88125,10 +99182,18 @@ "type": "number" }, "suggest_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "suggest_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "suggest_total": { "type": "number" @@ -88201,10 +99266,18 @@ "type": "number" }, "total_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "total_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } }, "required": [ @@ -88220,25 +99293,49 @@ "type": "number" }, "total_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "total_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "total_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "total_size_in_bytes": { "type": "number" }, "avg_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "avg_time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "avg_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "avg_size_in_bytes": { "type": "number" @@ -88267,73 +99364,165 @@ "type": "object", "properties": { "commit": { - "$ref": "#/components/schemas/indices.stats.ShardCommit" + "allOf": [ + { + "$ref": "#/components/schemas/indices.stats.ShardCommit" + } + ] }, "completion": { - "$ref": "#/components/schemas/_types.CompletionStats" + "allOf": [ + { + "$ref": "#/components/schemas/_types.CompletionStats" + } + ] }, "docs": { - "$ref": "#/components/schemas/_types.DocStats" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DocStats" + } + ] }, "fielddata": { - "$ref": "#/components/schemas/_types.FielddataStats" + "allOf": [ + { + "$ref": "#/components/schemas/_types.FielddataStats" + } + ] }, "flush": { - "$ref": "#/components/schemas/_types.FlushStats" + "allOf": [ + { + "$ref": "#/components/schemas/_types.FlushStats" + } + ] }, "get": { - "$ref": "#/components/schemas/_types.GetStats" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GetStats" + } + ] }, "indexing": { - "$ref": "#/components/schemas/_types.IndexingStats" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexingStats" + } + ] }, "mappings": { - "$ref": "#/components/schemas/indices.stats.MappingStats" + "allOf": [ + { + "$ref": "#/components/schemas/indices.stats.MappingStats" + } + ] }, "merges": { - "$ref": "#/components/schemas/_types.MergesStats" + "allOf": [ + { + "$ref": "#/components/schemas/_types.MergesStats" + } + ] }, "shard_path": { - "$ref": "#/components/schemas/indices.stats.ShardPath" + "allOf": [ + { + "$ref": "#/components/schemas/indices.stats.ShardPath" + } + ] }, "query_cache": { - "$ref": "#/components/schemas/indices.stats.ShardQueryCache" + "allOf": [ + { + "$ref": "#/components/schemas/indices.stats.ShardQueryCache" + } + ] }, "recovery": { - "$ref": "#/components/schemas/_types.RecoveryStats" + "allOf": [ + { + "$ref": "#/components/schemas/_types.RecoveryStats" + } + ] }, "refresh": { - "$ref": "#/components/schemas/_types.RefreshStats" + "allOf": [ + { + "$ref": "#/components/schemas/_types.RefreshStats" + } + ] }, "request_cache": { - "$ref": "#/components/schemas/_types.RequestCacheStats" + "allOf": [ + { + "$ref": "#/components/schemas/_types.RequestCacheStats" + } + ] }, "retention_leases": { - "$ref": "#/components/schemas/indices.stats.ShardRetentionLeases" + "allOf": [ + { + "$ref": "#/components/schemas/indices.stats.ShardRetentionLeases" + } + ] }, "routing": { - "$ref": "#/components/schemas/indices.stats.ShardRouting" + "allOf": [ + { + "$ref": "#/components/schemas/indices.stats.ShardRouting" + } + ] }, "search": { - "$ref": "#/components/schemas/_types.SearchStats" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SearchStats" + } + ] }, "segments": { - "$ref": "#/components/schemas/_types.SegmentsStats" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SegmentsStats" + } + ] }, "seq_no": { - "$ref": "#/components/schemas/indices.stats.ShardSequenceNumber" + "allOf": [ + { + "$ref": "#/components/schemas/indices.stats.ShardSequenceNumber" + } + ] }, "store": { - "$ref": "#/components/schemas/_types.StoreStats" + "allOf": [ + { + "$ref": "#/components/schemas/_types.StoreStats" + } + ] }, "translog": { - "$ref": "#/components/schemas/_types.TranslogStats" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TranslogStats" + } + ] }, "warmer": { - "$ref": "#/components/schemas/_types.WarmerStats" + "allOf": [ + { + "$ref": "#/components/schemas/_types.WarmerStats" + } + ] }, "bulk": { - "$ref": "#/components/schemas/_types.BulkStats" + "allOf": [ + { + "$ref": "#/components/schemas/_types.BulkStats" + } + ] }, "shards": { "x-state": "Generally available; Added in 7.15.0", @@ -88343,10 +99532,18 @@ } }, "shard_stats": { - "$ref": "#/components/schemas/indices.stats.ShardsTotalStats" + "allOf": [ + { + "$ref": "#/components/schemas/indices.stats.ShardsTotalStats" + } + ] }, "indices": { - "$ref": "#/components/schemas/indices.stats.IndicesStats" + "allOf": [ + { + "$ref": "#/components/schemas/indices.stats.IndicesStats" + } + ] } } }, @@ -88357,7 +99554,11 @@ "type": "number" }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "num_docs": { "type": "number" @@ -88383,7 +99584,11 @@ "type": "number" }, "total_estimated_overhead": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "total_estimated_overhead_in_bytes": { "type": "number" @@ -88455,7 +99660,11 @@ "type": "number" }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "leases": { "type": "array", @@ -88474,10 +99683,18 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "retaining_seq_no": { - "$ref": "#/components/schemas/_types.SequenceNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SequenceNumber" + } + ] }, "timestamp": { "type": "number" @@ -88514,7 +99731,11 @@ ] }, "state": { - "$ref": "#/components/schemas/indices.stats.ShardRoutingState" + "allOf": [ + { + "$ref": "#/components/schemas/indices.stats.ShardRoutingState" + } + ] } }, "required": [ @@ -88542,7 +99763,11 @@ "type": "number" }, "max_seq_no": { - "$ref": "#/components/schemas/_types.SequenceNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SequenceNumber" + } + ] } }, "required": [ @@ -88562,13 +99787,28 @@ "type": "object", "properties": { "add": { - "$ref": "#/components/schemas/indices.update_aliases.AddAction" + "description": "Adds a data stream or index to an alias.\nIf the alias doesn’t exist, the `add` action creates it.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.update_aliases.AddAction" + } + ] }, "remove": { - "$ref": "#/components/schemas/indices.update_aliases.RemoveAction" + "description": "Removes a data stream or index from an alias.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.update_aliases.RemoveAction" + } + ] }, "remove_index": { - "$ref": "#/components/schemas/indices.update_aliases.RemoveIndexAction" + "description": "Deletes an index.\nYou cannot use this action on aliases or data streams.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.update_aliases.RemoveIndexAction" + } + ] } }, "minProperties": 1, @@ -88578,7 +99818,12 @@ "type": "object", "properties": { "alias": { - "$ref": "#/components/schemas/_types.IndexAlias" + "description": "Alias for the action.\nIndex alias names support date math.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexAlias" + } + ] }, "aliases": { "description": "Aliases for the action.\nIndex alias names support date math.", @@ -88595,16 +99840,36 @@ ] }, "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Query used to limit documents the alias can access.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "Data stream or index for the action.\nSupports wildcards (`*`).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "indices": { - "$ref": "#/components/schemas/_types.Indices" + "description": "Data streams or indices for the action.\nSupports wildcards (`*`).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "index_routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.\nData stream aliases don’t support this parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "is_hidden": { "description": "If `true`, the alias is hidden.", @@ -88616,10 +99881,20 @@ "type": "boolean" }, "routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "Value used to route indexing and search operations to a specific shard.\nData stream aliases don’t support this parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "search_routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.\nData stream aliases don’t support this parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "must_exist": { "description": "If `true`, the alias must exist to perform the action.", @@ -88632,7 +99907,12 @@ "type": "object", "properties": { "alias": { - "$ref": "#/components/schemas/_types.IndexAlias" + "description": "Alias for the action.\nIndex alias names support date math.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexAlias" + } + ] }, "aliases": { "description": "Aliases for the action.\nIndex alias names support date math.", @@ -88649,10 +99929,20 @@ ] }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "Data stream or index for the action.\nSupports wildcards (`*`).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "indices": { - "$ref": "#/components/schemas/_types.Indices" + "description": "Data streams or indices for the action.\nSupports wildcards (`*`).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "must_exist": { "description": "If `true`, the alias must exist to perform the action.", @@ -88665,10 +99955,20 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "Data stream or index for the action.\nSupports wildcards (`*`).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "indices": { - "$ref": "#/components/schemas/_types.Indices" + "description": "Data streams or indices for the action.\nSupports wildcards (`*`).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "must_exist": { "description": "If `true`, the alias must exist to perform the action.", @@ -88687,7 +99987,11 @@ "type": "string" }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "valid": { "type": "boolean" @@ -88728,7 +100032,12 @@ "type": "number" }, "tool_choice": { - "$ref": "#/components/schemas/inference._types.CompletionToolType" + "description": "Controls which tool is called by the model.\nString representation: One of `auto`, `none`, or `requrired`. `auto` allows the model to choose between calling tools and generating a message. `none` causes the model to not call any tools. `required` forces the model to call one or more tools.\nExample (object representation):\n```\n{\n \"tool_choice\": {\n \"type\": \"function\",\n \"function\": {\n \"name\": \"get_current_weather\"\n }\n }\n}\n```", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CompletionToolType" + } + ] }, "tools": { "description": "A list of tools that the model can call.\nExample:\n```\n{\n \"tools\": [\n {\n \"type\": \"function\",\n \"function\": {\n \"name\": \"get_price_of_item\",\n \"description\": \"Get the current price of an item\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"item\": {\n \"id\": \"12345\"\n },\n \"unit\": {\n \"type\": \"currency\"\n }\n }\n }\n }\n }\n ]\n}\n```", @@ -88751,14 +100060,24 @@ "type": "object", "properties": { "content": { - "$ref": "#/components/schemas/inference._types.MessageContent" + "description": "The content of the message.\n\nString example:\n```\n{\n \"content\": \"Some string\"\n}\n```\n\nObject example:\n```\n{\n \"content\": [\n {\n \"text\": \"Some text\",\n \"type\": \"text\"\n }\n ]\n}\n```", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.MessageContent" + } + ] }, "role": { "description": "The role of the message author. Valid values are `user`, `assistant`, `system`, and `tool`.", "type": "string" }, "tool_call_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Only for `tool` role messages. The tool call that this message is responding to.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "tool_calls": { "description": "Only for `assistant` role messages. The tool calls generated by the model. If it's specified, the `content` field is optional.\nExample:\n```\n{\n \"tool_calls\": [\n {\n \"id\": \"call_KcAjWtAww20AihPHphUh46Gd\",\n \"type\": \"function\",\n \"function\": {\n \"name\": \"get_current_weather\",\n \"arguments\": \"{\\\"location\\\":\\\"Boston, MA\\\"}\"\n }\n }\n ]\n}\n```", @@ -88808,10 +100127,20 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The identifier of the tool call.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "function": { - "$ref": "#/components/schemas/inference._types.ToolCallFunction" + "description": "The function that the model called.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.ToolCallFunction" + } + ] }, "type": { "description": "The type of the tool call.", @@ -88861,7 +100190,12 @@ "type": "string" }, "function": { - "$ref": "#/components/schemas/inference._types.CompletionToolChoiceFunction" + "description": "The tool choice function.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CompletionToolChoiceFunction" + } + ] } }, "required": [ @@ -88891,7 +100225,12 @@ "type": "string" }, "function": { - "$ref": "#/components/schemas/inference._types.CompletionToolFunction" + "description": "The function definition.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CompletionToolFunction" + } + ] } }, "required": [ @@ -89003,7 +100342,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskType" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskType" + } + ] } }, "required": [ @@ -89018,17 +100362,32 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "description": "Chunking configuration object", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { "description": "The service type", "type": "string" }, "service_settings": { - "$ref": "#/components/schemas/inference._types.ServiceSettings" + "description": "Settings specific to the service", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.ServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.TaskSettings" + "description": "Task settings specific to the service and task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskSettings" + } + ] } }, "required": [ @@ -89132,7 +100491,11 @@ "type": "object", "properties": { "embedding": { - "$ref": "#/components/schemas/inference._types.DenseByteVector" + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.DenseByteVector" + } + ] } }, "required": [ @@ -89151,7 +100514,11 @@ "type": "object", "properties": { "embedding": { - "$ref": "#/components/schemas/inference._types.DenseVector" + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.DenseVector" + } + ] } }, "required": [ @@ -89169,7 +100536,11 @@ "type": "object", "properties": { "embedding": { - "$ref": "#/components/schemas/inference._types.SparseVector" + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.SparseVector" + } + ] } }, "required": [ @@ -89230,7 +100601,15 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "externalDocs": { + "url": "https://docs.ai21.com/reference/api-rate-limits" + }, + "description": "This setting helps to minimize the number of rate limit errors returned from the AI21 API.\nBy default, the `ai21` service sets the number of requests allowed per minute to 200. Please refer to AI21 documentation for more details.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] } }, "required": [ @@ -89260,7 +100639,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeAi21" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeAi21" + } + ] } }, "required": [ @@ -89307,7 +100691,12 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "description": "This setting helps to minimize the number of rate limit errors returned from AlibabaCloud AI Search.\nBy default, the `alibabacloud-ai-search` service sets the number of requests allowed per minute to `1000`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] }, "service_id": { "description": "The name of the model service to use for the inference task.\nThe following service IDs are available for the `completion` task:\n\n* `ops-qwen-turbo`\n* `qwen-turbo`\n* `qwen-plus`\n* `qwen-max ÷ qwen-max-longcontext`\n\nThe following service ID is available for the `rerank` task:\n\n* `ops-bge-reranker-larger`\n\nThe following service ID is available for the `sparse_embedding` task:\n\n* `ops-text-sparse-embedding-001`\n\nThe following service IDs are available for the `text_embedding` task:\n\n`ops-text-embedding-001`\n`ops-text-embedding-zh-001`\n`ops-text-embedding-en-001`\n`ops-text-embedding-002`", @@ -89351,7 +100740,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeAlibabaCloudAI" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeAlibabaCloudAI" + } + ] } }, "required": [ @@ -89409,7 +100803,12 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "description": "This setting helps to minimize the number of rate limit errors returned from Watsonx.\nBy default, the `watsonxai` service sets the number of requests allowed per minute to 120.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] }, "secret_key": { "externalDocs": { @@ -89461,7 +100860,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeAmazonBedrock" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeAmazonBedrock" + } + ] } }, "required": [ @@ -89509,7 +100913,12 @@ "type": "string" }, "api": { - "$ref": "#/components/schemas/inference._types.AmazonSageMakerApi" + "description": "The API format to use when calling SageMaker.\nElasticsearch will convert the POST _inference request to this data format when invoking the SageMaker endpoint.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AmazonSageMakerApi" + } + ] }, "region": { "externalDocs": { @@ -89624,7 +101033,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeAmazonSageMaker" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeAmazonSageMaker" + } + ] } }, "required": [ @@ -89658,7 +101072,12 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "description": "This setting helps to minimize the number of rate limit errors returned from Anthropic.\nBy default, the `anthropic` service sets the number of requests allowed per minute to 50.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] } }, "required": [ @@ -89706,7 +101125,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeAnthropic" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeAnthropic" + } + ] } }, "required": [ @@ -89762,7 +101186,12 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "description": "This setting helps to minimize the number of rate limit errors returned from Azure AI Studio.\nBy default, the `azureaistudio` service sets the number of requests allowed per minute to 240.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] } }, "required": [ @@ -89819,7 +101248,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeAzureAIStudio" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeAzureAIStudio" + } + ] } }, "required": [ @@ -89879,7 +101313,15 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "externalDocs": { + "url": "https://learn.microsoft.com/en-us/azure/ai-services/openai/quotas-limits" + }, + "description": "This setting helps to minimize the number of rate limit errors returned from Azure.\nThe `azureopenai` service sets a default number of requests allowed per minute depending on the task type.\nFor `text_embedding`, it is set to `1440`.\nFor `completion`, it is set to `120`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] }, "resource_name": { "externalDocs": { @@ -89917,7 +101359,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeAzureOpenAI" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeAzureOpenAI" + } + ] } }, "required": [ @@ -89959,17 +101406,33 @@ "type": "string" }, "embedding_type": { - "$ref": "#/components/schemas/inference._types.CohereEmbeddingType" + "description": "For a `text_embedding` task, the types of embeddings you want to get back.\nUse `binary` for binary embeddings, which are encoded as bytes with signed int8 precision.\nUse `bit` for binary embeddings, which are encoded as bytes with signed int8 precision (this is a synonym of `binary`).\nUse `byte` for signed int8 embeddings (this is a synonym of `int8`).\nUse `float` for the default float embeddings.\nUse `int8` for signed int8 embeddings.", + "default": "float", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CohereEmbeddingType" + } + ] }, "model_id": { "description": "For a `completion`, `rerank`, or `text_embedding` task, the name of the model to use for the inference task.\n\n* For the available `completion` models, refer to the [Cohere command docs](https://docs.cohere.com/docs/models#command).\n* For the available `rerank` models, refer to the [Cohere rerank docs](https://docs.cohere.com/reference/rerank-1).\n* For the available `text_embedding` models, refer to [Cohere embed docs](https://docs.cohere.com/reference/embed).", "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "description": "This setting helps to minimize the number of rate limit errors returned from Cohere.\nBy default, the `cohere` service sets the number of requests allowed per minute to 10000.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] }, "similarity": { - "$ref": "#/components/schemas/inference._types.CohereSimilarityType" + "description": "The similarity measure.\nIf the `embedding_type` is `float`, the default value is `dot_product`.\nIf the `embedding_type` is `int8` or `byte`, the default value is `cosine`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CohereSimilarityType" + } + ] } }, "required": [ @@ -89999,7 +101462,12 @@ "type": "object", "properties": { "input_type": { - "$ref": "#/components/schemas/inference._types.CohereInputType" + "description": "For a `text_embedding` task, the type of input passed to the model.\nValid values are:\n\n* `classification`: Use it for embeddings passed through a text classifier.\n* `clustering`: Use it for the embeddings run through a clustering algorithm.\n* `ingest`: Use it for storing document embeddings in a vector database.\n* `search`: Use it for storing embeddings of search queries run against a vector database to find relevant documents.\n\nIMPORTANT: The `input_type` field is required when using embedding models `v3` and higher.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CohereInputType" + } + ] }, "return_documents": { "description": "For a `rerank` task, return doc text within the results.", @@ -90010,7 +101478,12 @@ "type": "number" }, "truncate": { - "$ref": "#/components/schemas/inference._types.CohereTruncateType" + "description": "For a `text_embedding` task, the method to handle inputs longer than the maximum token length.\nValid values are:\n\n* `END`: When the input exceeds the maximum input token length, the end of the input is discarded.\n* `NONE`: When the input exceeds the maximum input token length, an error is returned.\n* `START`: When the input exceeds the maximum input token length, the start of the input is discarded.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CohereTruncateType" + } + ] } }, "required": [ @@ -90047,7 +101520,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeCohere" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeCohere" + } + ] } }, "required": [ @@ -90096,10 +101574,20 @@ "type": "object" }, "request": { - "$ref": "#/components/schemas/inference._types.CustomRequestParams" + "description": "The request configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CustomRequestParams" + } + ] }, "response": { - "$ref": "#/components/schemas/inference._types.CustomResponseParams" + "description": "The response configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CustomResponseParams" + } + ] }, "secret_parameters": { "description": "Specifies secret parameters, like `api_key` or `api_token`, that are required to access the custom service.\nFor example:\n```\n\"secret_parameters\":{\n \"api_key\":\"\"\n}\n```", @@ -90162,7 +101650,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeCustom" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeCustom" + } + ] } }, "required": [ @@ -90231,7 +101724,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeDeepSeek" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeDeepSeek" + } + ] } }, "required": [ @@ -90259,7 +101757,12 @@ "type": "object", "properties": { "adaptive_allocations": { - "$ref": "#/components/schemas/inference._types.AdaptiveAllocations" + "description": "Adaptive allocations configuration details.\nIf `enabled` is true, the number of allocations of the model is set based on the current load the process gets.\nWhen the load is high, a new model allocation is automatically created, respecting the value of `max_number_of_allocations` if it's set.\nWhen the load is low, a model allocation is automatically removed, respecting the value of `min_number_of_allocations` if it's set.\nIf `enabled` is true, do not set the number of allocations manually.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AdaptiveAllocations" + } + ] }, "deployment_id": { "description": "The deployment identifier for a trained model deployment.\nWhen `deployment_id` is used the `model_id` is optional.", @@ -90327,7 +101830,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeElasticsearch" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeElasticsearch" + } + ] } }, "required": [ @@ -90361,7 +101869,12 @@ "type": "object", "properties": { "adaptive_allocations": { - "$ref": "#/components/schemas/inference._types.AdaptiveAllocations" + "description": "Adaptive allocations configuration details.\nIf `enabled` is true, the number of allocations of the model is set based on the current load the process gets.\nWhen the load is high, a new model allocation is automatically created, respecting the value of `max_number_of_allocations` if it's set.\nWhen the load is low, a model allocation is automatically removed, respecting the value of `min_number_of_allocations` if it's set.\nIf `enabled` is true, do not set the number of allocations manually.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AdaptiveAllocations" + } + ] }, "num_allocations": { "description": "The total number of allocations this model is assigned across machine learning nodes.\nIncreasing this value generally increases the throughput.\nIf adaptive allocations is enabled, do not set this value because it's automatically set.", @@ -90390,7 +101903,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeELSER" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeELSER" + } + ] } }, "required": [ @@ -90434,7 +101952,12 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "description": "This setting helps to minimize the number of rate limit errors returned from Google AI Studio.\nBy default, the `googleaistudio` service sets the number of requests allowed per minute to 360.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] } }, "required": [ @@ -90455,7 +101978,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeGoogleAIStudio" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeGoogleAIStudio" + } + ] } }, "required": [ @@ -90509,7 +102037,12 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "description": "This setting helps to minimize the number of rate limit errors returned from Google Vertex AI.\nBy default, the `googlevertexai` service sets the number of requests allowed per minute to 30.000.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] }, "service_account_json": { "description": "A valid service account in JSON format for the Google Vertex AI API.", @@ -90549,7 +102082,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeGoogleVertexAI" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeGoogleVertexAI" + } + ] } }, "required": [ @@ -90592,7 +102130,12 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "description": "This setting helps to minimize the number of rate limit errors returned from Hugging Face.\nBy default, the `hugging_face` service sets the number of requests allowed per minute to 3000 for all supported tasks.\nHugging Face does not publish a universal rate limit — actual limits may vary.\nIt is recommended to adjust this value based on the capacity and limits of your specific deployment environment.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] }, "url": { "externalDocs": { @@ -90637,7 +102180,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeHuggingFace" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeHuggingFace" + } + ] } }, "required": [ @@ -90684,10 +102232,23 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "externalDocs": { + "url": "https://jina.ai/contact-sales/#rate-limit" + }, + "description": "This setting helps to minimize the number of rate limit errors returned from JinaAI.\nBy default, the `jinaai` service sets the number of requests allowed per minute to 2000 for all task types.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] }, "similarity": { - "$ref": "#/components/schemas/inference._types.JinaAISimilarityType" + "description": "For a `text_embedding` task, the similarity measure. One of cosine, dot_product, l2_norm.\nThe default values varies with the embedding type.\nFor example, a float embedding type uses a `dot_product` similarity measure by default.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.JinaAISimilarityType" + } + ] } }, "required": [ @@ -90710,7 +102271,12 @@ "type": "boolean" }, "task": { - "$ref": "#/components/schemas/inference._types.JinaAITextEmbeddingTask" + "description": "For a `text_embedding` task, the task passed to the model.\nValid values are:\n\n* `classification`: Use it for embeddings passed through a text classifier.\n* `clustering`: Use it for the embeddings run through a clustering algorithm.\n* `ingest`: Use it for storing document embeddings in a vector database.\n* `search`: Use it for storing embeddings of search queries run against a vector database to find relevant documents.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.JinaAITextEmbeddingTask" + } + ] }, "top_n": { "description": "For a `rerank` task, the number of most relevant documents to return.\nIt defaults to the number of the documents.\nIf this inference endpoint is used in a `text_similarity_reranker` retriever query and `top_n` is set, it must be greater than or equal to `rank_window_size` in the query.", @@ -90740,7 +102306,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeJinaAi" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeJinaAi" + } + ] } }, "required": [ @@ -90790,10 +102361,20 @@ "type": "number" }, "similarity": { - "$ref": "#/components/schemas/inference._types.LlamaSimilarityType" + "description": "For a `text_embedding` task, the similarity measure. One of cosine, dot_product, l2_norm.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.LlamaSimilarityType" + } + ] }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "description": "This setting helps to minimize the number of rate limit errors returned from the Llama API.\nBy default, the `llama` service sets the number of requests allowed per minute to 3000.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] } }, "required": [ @@ -90822,7 +102403,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeLlama" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeLlama" + } + ] } }, "required": [ @@ -90876,7 +102462,12 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "description": "This setting helps to minimize the number of rate limit errors returned from the Mistral API.\nBy default, the `mistral` service sets the number of requests allowed per minute to 240.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] } }, "required": [ @@ -90897,7 +102488,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeMistral" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeMistral" + } + ] } }, "required": [ @@ -90955,7 +102551,12 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "description": "This setting helps to minimize the number of rate limit errors returned from OpenAI.\nThe `openai` service sets a default number of requests allowed per minute depending on the task type.\nFor `text_embedding`, it is set to `3000`.\nFor `completion`, it is set to `500`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] }, "url": { "description": "The URL endpoint to use for the requests.\nIt can be changed for testing purposes.", @@ -90990,7 +102591,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeOpenAI" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeOpenAI" + } + ] } }, "required": [ @@ -91039,7 +102645,12 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "description": "This setting helps to minimize the number of rate limit errors returned from VoyageAI.\nThe `voyageai` service sets a default number of requests allowed per minute depending on the task type.\nFor both `text_embedding` and `rerank`, it is set to `2000`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] }, "embedding_type": { "externalDocs": { @@ -91089,7 +102700,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeVoyageAI" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeVoyageAI" + } + ] } }, "required": [ @@ -91149,7 +102765,12 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "description": "This setting helps to minimize the number of rate limit errors returned from Watsonx.\nBy default, the `watsonxai` service sets the number of requests allowed per minute to 120.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] }, "url": { "description": "The URL of the inference endpoint that you created on Watsonx.", @@ -91177,7 +102798,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeWatsonx" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeWatsonx" + } + ] } }, "required": [ @@ -91255,7 +102881,12 @@ "type": "object", "properties": { "build_date": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The Elasticsearch Git commit's date.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "build_flavor": { "description": "The build flavor. For example, `default`.", @@ -91274,13 +102905,28 @@ "type": "string" }, "lucene_version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "The version number of Elasticsearch's underlying Lucene software.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "minimum_index_compatibility_version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "The minimum index version with which the responding node can read from disk.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "minimum_wire_compatibility_version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "The minimum node version with which the responding node can communicate.\nAlso the minimum version from which you can perform a rolling upgrade.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "number": { "description": "The Elasticsearch version number.\n\n::: IMPORTANT: For Serverless deployments, this static value is always `8.11.0` and is used solely for backward compatibility with legacy clients.\n Serverless environments are versionless and automatically upgraded, so this value can be safely ignored.", @@ -91311,7 +102957,12 @@ "type": "number" }, "total_download_time": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "Total milliseconds spent downloading databases.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "databases_count": { "description": "Current number of databases available for use.", @@ -91363,7 +103014,12 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "Name of the database.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] } }, "required": [ @@ -91374,16 +103030,28 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "version": { "type": "number" }, "modified_date_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "database": { - "$ref": "#/components/schemas/ingest._types.DatabaseConfiguration" + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.DatabaseConfiguration" + } + ] } }, "required": [ @@ -91400,7 +103068,12 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The provider-assigned name of the IP geolocation database to download.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] } }, "required": [ @@ -91411,10 +103084,18 @@ "type": "object", "properties": { "maxmind": { - "$ref": "#/components/schemas/ingest._types.Maxmind" + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.Maxmind" + } + ] }, "ipinfo": { - "$ref": "#/components/schemas/ingest._types.Ipinfo" + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.Ipinfo" + } + ] } }, "minProperties": 1, @@ -91426,7 +103107,11 @@ "type": "object", "properties": { "account_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] } }, "required": [ @@ -91440,19 +103125,39 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "modified_date_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "modified_date": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "database": { - "$ref": "#/components/schemas/ingest._types.DatabaseConfigurationFull" + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.DatabaseConfigurationFull" + } + ] } }, "required": [ @@ -91467,7 +103172,12 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The provider-assigned name of the IP geolocation database to download.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] } }, "required": [ @@ -91478,16 +103188,32 @@ "type": "object", "properties": { "web": { - "$ref": "#/components/schemas/ingest._types.Web" + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.Web" + } + ] }, "local": { - "$ref": "#/components/schemas/ingest._types.Local" + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.Local" + } + ] }, "maxmind": { - "$ref": "#/components/schemas/ingest._types.Maxmind" + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.Maxmind" + } + ] }, "ipinfo": { - "$ref": "#/components/schemas/ingest._types.Ipinfo" + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.Ipinfo" + } + ] } }, "minProperties": 1, @@ -91531,7 +103257,12 @@ } }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "Version number used by external systems to track ingest pipelines.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "deprecated": { "description": "Marks this ingest pipeline as deprecated.\nWhen a deprecated ingest pipeline is referenced as the default or final pipeline when creating or updating a non-deprecated index template, Elasticsearch will emit a deprecation warning.", @@ -91539,7 +103270,12 @@ "type": "boolean" }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Arbitrary metadata about the ingest pipeline. This map is not automatically generated by Elasticsearch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] } } }, @@ -91547,139 +103283,364 @@ "type": "object", "properties": { "append": { - "$ref": "#/components/schemas/ingest._types.AppendProcessor" + "description": "Appends one or more values to an existing array if the field already exists and it is an array.\nConverts a scalar to an array and appends one or more values to it if the field exists and it is a scalar.\nCreates an array containing the provided values if the field doesn’t exist.\nAccepts a single value or an array of values.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.AppendProcessor" + } + ] }, "attachment": { - "$ref": "#/components/schemas/ingest._types.AttachmentProcessor" + "description": "The attachment processor lets Elasticsearch extract file attachments in common formats (such as PPT, XLS, and PDF) by using the Apache text extraction library Tika.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.AttachmentProcessor" + } + ] }, "bytes": { - "$ref": "#/components/schemas/ingest._types.BytesProcessor" + "description": "Converts a human readable byte value (for example `1kb`) to its value in bytes (for example `1024`).\nIf the field is an array of strings, all members of the array will be converted.\nSupported human readable units are \"b\", \"kb\", \"mb\", \"gb\", \"tb\", \"pb\" case insensitive.\nAn error will occur if the field is not a supported format or resultant value exceeds 2^63.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.BytesProcessor" + } + ] }, "circle": { - "$ref": "#/components/schemas/ingest._types.CircleProcessor" + "description": "Converts circle definitions of shapes to regular polygons which approximate them.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.CircleProcessor" + } + ] }, "community_id": { - "$ref": "#/components/schemas/ingest._types.CommunityIDProcessor" + "description": "Computes the Community ID for network flow data as defined in the\nCommunity ID Specification. You can use a community ID to correlate network\nevents related to a single flow.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.CommunityIDProcessor" + } + ] }, "convert": { - "$ref": "#/components/schemas/ingest._types.ConvertProcessor" + "description": "Converts a field in the currently ingested document to a different type, such as converting a string to an integer.\nIf the field value is an array, all members will be converted.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.ConvertProcessor" + } + ] }, "csv": { - "$ref": "#/components/schemas/ingest._types.CsvProcessor" + "description": "Extracts fields from CSV line out of a single text field within a document.\nAny empty field in CSV will be skipped.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.CsvProcessor" + } + ] }, "date": { - "$ref": "#/components/schemas/ingest._types.DateProcessor" + "description": "Parses dates from fields, and then uses the date or timestamp as the timestamp for the document.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.DateProcessor" + } + ] }, "date_index_name": { - "$ref": "#/components/schemas/ingest._types.DateIndexNameProcessor" + "description": "The purpose of this processor is to point documents to the right time based index based on a date or timestamp field in a document by using the date math index name support.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.DateIndexNameProcessor" + } + ] }, "dissect": { - "$ref": "#/components/schemas/ingest._types.DissectProcessor" + "description": "Extracts structured fields out of a single text field by matching the text field against a delimiter-based pattern.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.DissectProcessor" + } + ] }, "dot_expander": { - "$ref": "#/components/schemas/ingest._types.DotExpanderProcessor" + "description": "Expands a field with dots into an object field.\nThis processor allows fields with dots in the name to be accessible by other processors in the pipeline.\nOtherwise these fields can’t be accessed by any processor.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.DotExpanderProcessor" + } + ] }, "drop": { - "$ref": "#/components/schemas/ingest._types.DropProcessor" + "description": "Drops the document without raising any errors.\nThis is useful to prevent the document from getting indexed based on some condition.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.DropProcessor" + } + ] }, "enrich": { - "$ref": "#/components/schemas/ingest._types.EnrichProcessor" + "description": "The `enrich` processor can enrich documents with data from another index.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.EnrichProcessor" + } + ] }, "fail": { - "$ref": "#/components/schemas/ingest._types.FailProcessor" + "description": "Raises an exception.\nThis is useful for when you expect a pipeline to fail and want to relay a specific message to the requester.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.FailProcessor" + } + ] }, "fingerprint": { - "$ref": "#/components/schemas/ingest._types.FingerprintProcessor" + "description": "Computes a hash of the document’s content. You can use this hash for\ncontent fingerprinting.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.FingerprintProcessor" + } + ] }, "foreach": { - "$ref": "#/components/schemas/ingest._types.ForeachProcessor" + "description": "Runs an ingest processor on each element of an array or object.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.ForeachProcessor" + } + ] }, "ip_location": { - "$ref": "#/components/schemas/ingest._types.IpLocationProcessor" + "description": "Currently an undocumented alias for GeoIP Processor.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.IpLocationProcessor" + } + ] }, "geo_grid": { - "$ref": "#/components/schemas/ingest._types.GeoGridProcessor" + "description": "Converts geo-grid definitions of grid tiles or cells to regular bounding boxes or polygons which describe their shape.\nThis is useful if there is a need to interact with the tile shapes as spatially indexable fields.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.GeoGridProcessor" + } + ] }, "geoip": { - "$ref": "#/components/schemas/ingest._types.GeoIpProcessor" + "description": "The `geoip` processor adds information about the geographical location of an IPv4 or IPv6 address.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.GeoIpProcessor" + } + ] }, "grok": { - "$ref": "#/components/schemas/ingest._types.GrokProcessor" + "description": "Extracts structured fields out of a single text field within a document.\nYou choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.GrokProcessor" + } + ] }, "gsub": { - "$ref": "#/components/schemas/ingest._types.GsubProcessor" + "description": "Converts a string field by applying a regular expression and a replacement.\nIf the field is an array of string, all members of the array will be converted.\nIf any non-string values are encountered, the processor will throw an exception.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.GsubProcessor" + } + ] }, "html_strip": { - "$ref": "#/components/schemas/ingest._types.HtmlStripProcessor" + "description": "Removes HTML tags from the field.\nIf the field is an array of strings, HTML tags will be removed from all members of the array.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.HtmlStripProcessor" + } + ] }, "inference": { - "$ref": "#/components/schemas/ingest._types.InferenceProcessor" + "description": "Uses a pre-trained data frame analytics model or a model deployed for natural language processing tasks to infer against the data that is being ingested in the pipeline.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.InferenceProcessor" + } + ] }, "join": { - "$ref": "#/components/schemas/ingest._types.JoinProcessor" + "description": "Joins each element of an array into a single string using a separator character between each element.\nThrows an error when the field is not an array.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.JoinProcessor" + } + ] }, "json": { - "$ref": "#/components/schemas/ingest._types.JsonProcessor" + "description": "Converts a JSON string into a structured JSON object.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.JsonProcessor" + } + ] }, "kv": { - "$ref": "#/components/schemas/ingest._types.KeyValueProcessor" + "description": "This processor helps automatically parse messages (or specific event fields) which are of the `foo=bar` variety.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.KeyValueProcessor" + } + ] }, "lowercase": { - "$ref": "#/components/schemas/ingest._types.LowercaseProcessor" + "description": "Converts a string to its lowercase equivalent.\nIf the field is an array of strings, all members of the array will be converted.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.LowercaseProcessor" + } + ] }, "network_direction": { - "$ref": "#/components/schemas/ingest._types.NetworkDirectionProcessor" + "description": "Calculates the network direction given a source IP address, destination IP\naddress, and a list of internal networks.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.NetworkDirectionProcessor" + } + ] }, "pipeline": { - "$ref": "#/components/schemas/ingest._types.PipelineProcessor" + "description": "Executes another pipeline.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.PipelineProcessor" + } + ] }, "redact": { - "$ref": "#/components/schemas/ingest._types.RedactProcessor" + "description": "The Redact processor uses the Grok rules engine to obscure text in the input document matching the given Grok patterns.\nThe processor can be used to obscure Personal Identifying Information (PII) by configuring it to detect known patterns such as email or IP addresses.\nText that matches a Grok pattern is replaced with a configurable string such as `` where an email address is matched or simply replace all matches with the text `` if preferred.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.RedactProcessor" + } + ] }, "registered_domain": { - "$ref": "#/components/schemas/ingest._types.RegisteredDomainProcessor" + "description": "Extracts the registered domain (also known as the effective top-level\ndomain or eTLD), sub-domain, and top-level domain from a fully qualified\ndomain name (FQDN). Uses the registered domains defined in the Mozilla\nPublic Suffix List.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.RegisteredDomainProcessor" + } + ] }, "remove": { - "$ref": "#/components/schemas/ingest._types.RemoveProcessor" + "description": "Removes existing fields.\nIf one field doesn’t exist, an exception will be thrown.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.RemoveProcessor" + } + ] }, "rename": { - "$ref": "#/components/schemas/ingest._types.RenameProcessor" + "description": "Renames an existing field.\nIf the field doesn’t exist or the new name is already used, an exception will be thrown.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.RenameProcessor" + } + ] }, "reroute": { - "$ref": "#/components/schemas/ingest._types.RerouteProcessor" + "description": "Routes a document to another target index or data stream.\nWhen setting the `destination` option, the target is explicitly specified and the dataset and namespace options can’t be set.\nWhen the `destination` option is not set, this processor is in a data stream mode. Note that in this mode, the reroute processor can only be used on data streams that follow the data stream naming scheme.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.RerouteProcessor" + } + ] }, "script": { - "$ref": "#/components/schemas/ingest._types.ScriptProcessor" + "description": "Runs an inline or stored script on incoming documents.\nThe script runs in the `ingest` context.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.ScriptProcessor" + } + ] }, "set": { - "$ref": "#/components/schemas/ingest._types.SetProcessor" + "description": "Adds a field with the specified value.\nIf the field already exists, its value will be replaced with the provided one.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.SetProcessor" + } + ] }, "set_security_user": { - "$ref": "#/components/schemas/ingest._types.SetSecurityUserProcessor" + "description": "Sets user-related details (such as `username`, `roles`, `email`, `full_name`, `metadata`, `api_key`, `realm` and `authentication_type`) from the current authenticated user to the current document by pre-processing the ingest.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.SetSecurityUserProcessor" + } + ] }, "sort": { - "$ref": "#/components/schemas/ingest._types.SortProcessor" + "description": "Sorts the elements of an array ascending or descending.\nHomogeneous arrays of numbers will be sorted numerically, while arrays of strings or heterogeneous arrays of strings + numbers will be sorted lexicographically.\nThrows an error when the field is not an array.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.SortProcessor" + } + ] }, "split": { - "$ref": "#/components/schemas/ingest._types.SplitProcessor" + "description": "Splits a field into an array using a separator character.\nOnly works on string fields.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.SplitProcessor" + } + ] }, "terminate": { - "$ref": "#/components/schemas/ingest._types.TerminateProcessor" + "description": "Terminates the current ingest pipeline, causing no further processors to be run.\nThis will normally be executed conditionally, using the `if` option.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.TerminateProcessor" + } + ] }, "trim": { - "$ref": "#/components/schemas/ingest._types.TrimProcessor" + "description": "Trims whitespace from a field.\nIf the field is an array of strings, all members of the array will be trimmed.\nThis only works on leading and trailing whitespace.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.TrimProcessor" + } + ] }, "uppercase": { - "$ref": "#/components/schemas/ingest._types.UppercaseProcessor" + "description": "Converts a string to its uppercase equivalent.\nIf the field is an array of strings, all members of the array will be converted.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.UppercaseProcessor" + } + ] }, "urldecode": { - "$ref": "#/components/schemas/ingest._types.UrlDecodeProcessor" + "description": "URL-decodes a string.\nIf the field is an array of strings, all members of the array will be decoded.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.UrlDecodeProcessor" + } + ] }, "uri_parts": { - "$ref": "#/components/schemas/ingest._types.UriPartsProcessor" + "description": "Parses a Uniform Resource Identifier (URI) string and extracts its components as an object.\nThis URI object includes properties for the URI’s domain, path, fragment, port, query, scheme, user info, username, and password.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.UriPartsProcessor" + } + ] }, "user_agent": { - "$ref": "#/components/schemas/ingest._types.UserAgentProcessor" + "description": "The `user_agent` processor extracts details from the user agent string a browser sends with its web requests.\nThis processor adds this information by default under the `user_agent` field.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.UserAgentProcessor" + } + ] } }, "minProperties": 1, @@ -91694,7 +103655,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to be appended to.\nSupports template snippets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "value": { "description": "The value to be appended. Supports template snippets.", @@ -91731,7 +103697,12 @@ "type": "string" }, "if": { - "$ref": "#/components/schemas/_types.Script" + "description": "Conditionally execute the processor.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "ignore_failure": { "description": "Ignore failures for the processor.", @@ -91759,7 +103730,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to get the base64 encoded field from.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and field does not exist, the processor quietly exits without modifying the document.", @@ -91772,7 +103748,13 @@ "type": "number" }, "indexed_chars_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field name from which you can overwrite the number of chars being used for extraction.", + "default": "null", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "properties": { "description": "Array of properties to select to be stored.\nCan be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`.", @@ -91782,7 +103764,13 @@ } }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field that will hold the attachment information.", + "default": "attachment", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "remove_binary": { "description": "If true, the binary field will be removed from the document", @@ -91809,7 +103797,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to convert.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", @@ -91817,7 +103810,13 @@ "type": "boolean" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.", + "default": "field", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -91839,7 +103838,12 @@ "type": "number" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", @@ -91847,10 +103851,20 @@ "type": "boolean" }, "shape_type": { - "$ref": "#/components/schemas/ingest._types.ShapeType" + "description": "Which field mapping type is to be used when processing the circle: `geo_shape` or `shape`.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.ShapeType" + } + ] }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to assign the polygon shape to\nBy default, the field is updated in-place.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -91877,31 +103891,85 @@ "type": "object", "properties": { "source_ip": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing the source IP address.", + "default": "source.ip", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "source_port": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing the source port.", + "default": "source.port", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "destination_ip": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing the destination IP address.", + "default": "destination.ip", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "destination_port": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing the destination port.", + "default": "destination.port", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "iana_number": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing the IANA number.", + "default": "network.iana_number", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "icmp_type": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing the ICMP type.", + "default": "icmp.type", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "icmp_code": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing the ICMP code.", + "default": "icmp.code", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "transport": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing the transport protocol name or number. Used only when the\niana_number field is not present. The following protocol names are currently\nsupported: eigrp, gre, icmp, icmpv6, igmp, ipv6-icmp, ospf, pim, sctp, tcp, udp", + "default": "network.transport", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Output field for the community ID.", + "default": "network.community_id", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "seed": { "description": "Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The\nseed can prevent hash collisions between network domains, such as a staging\nand production network that use the same addressing scheme.", @@ -91926,7 +103994,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field whose value is to be converted.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", @@ -91934,10 +104007,21 @@ "type": "boolean" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to assign the converted value to.\nBy default, the `field` is updated in-place.", + "default": "field", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "type": { - "$ref": "#/components/schemas/ingest._types.ConvertType" + "description": "The type to convert the existing value to.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.ConvertType" + } + ] } }, "required": [ @@ -91973,7 +104057,12 @@ "type": "object" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to extract data from.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", @@ -91990,7 +104079,12 @@ "type": "string" }, "target_fields": { - "$ref": "#/components/schemas/_types.Fields" + "description": "The array of fields to assign extracted values to.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "trim": { "description": "Trim whitespaces in unquoted fields.", @@ -92013,7 +104107,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to get the date from.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "formats": { "description": "An array of the expected date formats.\nCan be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N.", @@ -92028,7 +104127,13 @@ "type": "string" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field that will hold the parsed date.", + "default": "`@timestamp`", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "timezone": { "description": "The timezone to use when parsing the date.\nSupports template snippets.", @@ -92068,7 +104173,12 @@ "type": "string" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to get the date or timestamp from.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "index_name_format": { "description": "The format to be used when printing the parsed date into the index name.\nA valid java time pattern is expected here.\nSupports template snippets.", @@ -92111,7 +104221,12 @@ "type": "string" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to dissect.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", @@ -92139,7 +104254,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to expand into an object field.\nIf set to `*`, all top-level fields will be expanded.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "override": { "description": "Controls the behavior when there is already an existing nested object that conflicts with the expanded field.\nWhen `false`, the processor will merge conflicts by combining the old and the new values into an array.\nWhen `true`, the value from the expanded field will overwrite the existing value.", @@ -92176,7 +104296,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field in the input document that matches the policies match_field used to retrieve the enrichment data.\nSupports template snippets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", @@ -92198,10 +104323,21 @@ "type": "string" }, "shape_relation": { - "$ref": "#/components/schemas/_types.GeoShapeRelation" + "description": "A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index.\nThis option is only used for `geo_match` enrich policy types.", + "default": "INTERSECTS", + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoShapeRelation" + } + ] }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.\nSupports template snippets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -92249,17 +104385,34 @@ "type": "object", "properties": { "fields": { - "$ref": "#/components/schemas/_types.Fields" + "description": "Array of fields to include in the fingerprint. For objects, the processor\nhashes both the field key and value. For other fields, the processor hashes\nonly the field value.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Output field for the fingerprint.", + "default": "fingerprint", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "salt": { "description": "Salt value for the hash function.", "type": "string" }, "method": { - "$ref": "#/components/schemas/ingest._types.FingerprintDigest" + "description": "The hash method used to compute the fingerprint. Must be one of MD5, SHA-1,\nSHA-256, SHA-512, or MurmurHash3.", + "default": "SHA-1", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.FingerprintDigest" + } + ] }, "ignore_missing": { "description": "If true, the processor ignores any missing fields. If all fields are\nmissing, the processor silently exits without modifying the document.", @@ -92292,7 +104445,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing array or object values.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true`, the processor silently exits without changing the document if the `field` is `null` or missing.", @@ -92300,7 +104458,12 @@ "type": "boolean" }, "processor": { - "$ref": "#/components/schemas/ingest._types.ProcessorContainer" + "description": "Ingest processor to run on each element.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.ProcessorContainer" + } + ] } }, "required": [ @@ -92324,7 +104487,12 @@ "type": "string" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to get the ip address from for the geographical lookup.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "first_only": { "description": "If `true`, only the first found IP location data will be returned, even if the field contains an array.", @@ -92344,7 +104512,13 @@ } }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field that will hold the geographical information looked up from the MaxMind database.", + "default": "geoip", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "download_database_on_pipeline_creation": { "description": "If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created.\nElse, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index.", @@ -92370,22 +104544,53 @@ "type": "string" }, "tile_type": { - "$ref": "#/components/schemas/ingest._types.GeoGridTileType" + "description": "Three tile formats are understood: geohash, geotile and geohex.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.GeoGridTileType" + } + ] }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to assign the polygon shape to, by default, the `field` is updated in-place.", + "default": "field", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "parent_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "If specified and a parent tile exists, save that tile address to this field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "children_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "If specified and children tiles exist, save those tile addresses to this field as an array of strings.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "non_children_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "If specified and intersecting non-child tiles exist, save their addresses to this field as an array of strings.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "precision_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "If specified, save the tile precision (zoom) as an integer to this field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", @@ -92393,7 +104598,13 @@ "type": "boolean" }, "target_format": { - "$ref": "#/components/schemas/ingest._types.GeoGridTargetFormat" + "description": "Which format to save the generated polygon in.", + "default": "geojson", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.GeoGridTargetFormat" + } + ] } }, "required": [ @@ -92432,7 +104643,12 @@ "type": "string" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to get the ip address from for the geographical lookup.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "first_only": { "description": "If `true`, only the first found geoip data will be returned, even if the field contains an array.", @@ -92452,7 +104668,13 @@ } }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field that will hold the geographical information looked up from the MaxMind database.", + "default": "geoip", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "download_database_on_pipeline_creation": { "description": "If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created.\nElse, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index.", @@ -92479,7 +104701,12 @@ "type": "string" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to use for grok expression parsing.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", @@ -92525,7 +104752,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to apply the replacement to.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", @@ -92541,7 +104773,13 @@ "type": "string" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to assign the converted value to\nBy default, the `field` is updated in-place.", + "default": "field", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -92561,7 +104799,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The string-valued field to remove HTML tags from.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document,", @@ -92569,7 +104812,13 @@ "type": "boolean" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to assign the converted value to\nBy default, the `field` is updated in-place.", + "default": "field", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -92587,10 +104836,21 @@ "type": "object", "properties": { "model_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The ID or alias for the trained model, or the ID of the deployment.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field added to incoming documents to contain results objects.", + "default": "ml.inference.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "field_map": { "description": "Maps the document field names to the known field names of the model.\nThis mapping takes precedence over any default mappings provided in the model configuration.", @@ -92600,7 +104860,12 @@ } }, "inference_config": { - "$ref": "#/components/schemas/ingest._types.InferenceConfig" + "description": "Contains the inference type and its options.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.InferenceConfig" + } + ] }, "input_output": { "description": "Input fields for inference and output (destination) fields for the inference results.\nThis option is incompatible with the target_field and field_map options.", @@ -92631,10 +104896,20 @@ "type": "object", "properties": { "regression": { - "$ref": "#/components/schemas/ingest._types.InferenceConfigRegression" + "description": "Regression configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.InferenceConfigRegression" + } + ] }, "classification": { - "$ref": "#/components/schemas/ingest._types.InferenceConfigClassification" + "description": "Classification configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.InferenceConfigClassification" + } + ] } }, "minProperties": 1, @@ -92644,7 +104919,13 @@ "type": "object", "properties": { "results_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field that is added to incoming documents to contain the inference prediction.", + "default": "_prediction", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "num_top_feature_importance_values": { "description": "Specifies the maximum number of feature importance values per document.", @@ -92667,10 +104948,22 @@ "type": "number" }, "results_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field that is added to incoming documents to contain the inference prediction.", + "default": "_prediction", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "top_classes_results_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Specifies the field to which the top classes are written.", + "default": "top_classes", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "prediction_field_type": { "description": "Specifies the type of the predicted field to write.\nValid values are: `string`, `number`, `boolean`.", @@ -92702,14 +104995,25 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing array values to join.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "separator": { "description": "The separator character.", "type": "string" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to assign the joined value to.\nBy default, the field is updated in-place.", + "default": "field", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -92733,7 +105037,12 @@ "type": "boolean" }, "add_to_root_conflict_strategy": { - "$ref": "#/components/schemas/ingest._types.JsonProcessorConflictStrategy" + "description": "When set to `replace`, root fields that conflict with fields from the parsed JSON will be overridden.\nWhen set to `merge`, conflicting fields will be merged.\nOnly applicable `if add_to_root` is set to true.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.JsonProcessorConflictStrategy" + } + ] }, "allow_duplicate_keys": { "description": "When set to `true`, the JSON parser will not fail if the JSON contains duplicate keys.\nInstead, the last encountered value for any duplicate key wins.", @@ -92741,10 +105050,21 @@ "type": "boolean" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to be parsed.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field that the converted structured object will be written into.\nAny existing content in this field will be overwritten.", + "default": "field", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -92776,7 +105096,12 @@ } }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to be parsed.\nSupports template snippets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "field_split": { "description": "Regex pattern to use for splitting key-value pairs.", @@ -92805,7 +105130,12 @@ "type": "boolean" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to insert the extracted keys into.\nDefaults to the root of the document.\nSupports template snippets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "trim_key": { "description": "String of characters to trim from extracted keys.", @@ -92837,7 +105167,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to make lowercase.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", @@ -92845,7 +105180,13 @@ "type": "boolean" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.", + "default": "field", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -92863,13 +105204,31 @@ "type": "object", "properties": { "source_ip": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing the source IP address.", + "default": "source.ip", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "destination_ip": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing the destination IP address.", + "default": "destination.ip", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Output field for the network direction.", + "default": "network.direction", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "internal_networks": { "description": "List of internal networks. Supports IPv4 and IPv6 addresses and ranges in\nCIDR notation. Also supports the named ranges listed below. These may be\nconstructed with template snippets. Must specify only one of\ninternal_networks or internal_networks_field.", @@ -92879,7 +105238,12 @@ } }, "internal_networks_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "A field on the given document to read the internal_networks configuration\nfrom.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If true and any required fields are missing, the processor quietly exits\nwithout modifying the document.", @@ -92899,7 +105263,12 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The name of the pipeline to execute.\nSupports template snippets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "ignore_missing_pipeline": { "description": "Whether to ignore missing pipelines instead of failing.", @@ -92922,7 +105291,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to be redacted", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "patterns": { "description": "A list of grok expressions to match and redact named captures with", @@ -92980,10 +105354,20 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing the source FQDN.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Object field containing extracted domain components. If an empty string,\nthe processor adds components to the document’s root.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If true and any required fields are missing, the processor quietly exits\nwithout modifying the document.", @@ -93006,10 +105390,20 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Fields" + "description": "Fields to be removed. Supports template snippets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "keep": { - "$ref": "#/components/schemas/_types.Fields" + "description": "Fields to be kept. When set, all fields other than those specified are removed.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", @@ -93032,7 +105426,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to be renamed.\nSupports template snippets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", @@ -93040,7 +105439,12 @@ "type": "boolean" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The new name of the field.\nSupports template snippets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -93103,10 +105507,21 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "ID of a stored script.\nIf no `source` is specified, this parameter is required.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "lang": { - "$ref": "#/components/schemas/_types.ScriptLanguage" + "description": "Script language.", + "default": "painless", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptLanguage" + } + ] }, "params": { "description": "Object containing parameters for the script.", @@ -93116,7 +105531,12 @@ } }, "source": { - "$ref": "#/components/schemas/_types.ScriptSource" + "description": "Inline script.\nIf no `id` is specified, this parameter is required.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptSource" + } + ] } } } @@ -93131,10 +105551,20 @@ "type": "object", "properties": { "copy_from": { - "$ref": "#/components/schemas/_types.Field" + "description": "The origin field which will be copied to `field`, cannot set `value` simultaneously.\nSupported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to insert, upsert, or update.\nSupports template snippets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_empty_value": { "description": "If `true` and `value` is a template snippet that evaluates to `null` or the empty string, the processor quietly exits without modifying the document.", @@ -93170,7 +105600,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to store the user information into.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "properties": { "description": "Controls what user related properties are added to the field.", @@ -93195,13 +105630,29 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to be sorted.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "order": { - "$ref": "#/components/schemas/_types.SortOrder" + "description": "The sort order to use.\nAccepts `\"asc\"` or `\"desc\"`.", + "default": "asc", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortOrder" + } + ] }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to assign the sorted value to.\nBy default, the field is updated in-place.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -93219,7 +105670,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to split.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", @@ -93236,7 +105692,13 @@ "type": "string" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to assign the split value to.\nBy default, the field is updated in-place.", + "default": "field", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -93265,7 +105727,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The string-valued field to trim whitespace from.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", @@ -93273,7 +105740,13 @@ "type": "boolean" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to assign the trimmed value to.\nBy default, the field is updated in-place.", + "default": "field", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -93291,7 +105764,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to make uppercase.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", @@ -93299,7 +105777,13 @@ "type": "boolean" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.", + "default": "field", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -93317,7 +105801,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to decode.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", @@ -93325,7 +105814,13 @@ "type": "boolean" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.", + "default": "field", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -93343,7 +105838,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing the URI string.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", @@ -93361,7 +105861,13 @@ "type": "boolean" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Output field for the URI object.", + "default": "url", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -93379,7 +105885,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field containing the user agent string.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", @@ -93391,7 +105902,13 @@ "type": "string" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field that will be filled with the user agent details.", + "default": "user_agent", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "properties": { "description": "Controls what properties are added to `target_field`.", @@ -93439,10 +105956,20 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Unique identifier for the document.\nThis ID must be unique within the `_index`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "Name of the index containing the document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "_source": { "description": "JSON body for the document.", @@ -93457,10 +105984,18 @@ "type": "object", "properties": { "doc": { - "$ref": "#/components/schemas/ingest._types.DocumentSimulation" + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.DocumentSimulation" + } + ] }, "error": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] }, "processor_results": { "type": "array", @@ -93475,13 +106010,27 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Unique identifier for the document. This ID must be unique within the `_index`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "Name of the index containing the document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "_ingest": { - "$ref": "#/components/schemas/ingest._types.Ingest" + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.Ingest" + } + ] }, "_routing": { "description": "Value used to send the document to a specific primary shard.", @@ -93495,10 +106044,19 @@ } }, "_version": { - "$ref": "#/components/schemas/_spec_utils.StringifiedVersionNumber" + "description": "", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.StringifiedVersionNumber" + } + ] }, "_version_type": { - "$ref": "#/components/schemas/_types.VersionType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionType" + } + ] } }, "required": [ @@ -93512,13 +106070,26 @@ "type": "object", "properties": { "_redact": { - "$ref": "#/components/schemas/ingest._types.Redact" + "x-state": "Generally available; Added in 8.16.0", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.Redact" + } + ] }, "timestamp": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "pipeline": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] } }, "required": [ @@ -93552,7 +106123,11 @@ "type": "object", "properties": { "doc": { - "$ref": "#/components/schemas/ingest._types.DocumentSimulation" + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.DocumentSimulation" + } + ] }, "tag": { "type": "string" @@ -93561,16 +106136,28 @@ "type": "string" }, "status": { - "$ref": "#/components/schemas/ingest._types.PipelineSimulationStatusOptions" + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.PipelineSimulationStatusOptions" + } + ] }, "description": { "type": "string" }, "ignored_error": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] }, "error": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] } } }, @@ -93588,16 +106175,32 @@ "type": "object", "properties": { "expiry_date": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "expiry_date_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "issue_date": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "issue_date_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "issued_to": { "type": "string" @@ -93628,16 +106231,32 @@ ] }, "status": { - "$ref": "#/components/schemas/license._types.LicenseStatus" + "allOf": [ + { + "$ref": "#/components/schemas/license._types.LicenseStatus" + } + ] }, "type": { - "$ref": "#/components/schemas/license._types.LicenseType" + "allOf": [ + { + "$ref": "#/components/schemas/license._types.LicenseType" + } + ] }, "uid": { - "$ref": "#/components/schemas/_types.Uuid" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Uuid" + } + ] }, "start_date_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] } }, "required": [ @@ -93679,13 +106298,25 @@ "type": "object", "properties": { "expiry_date_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "issue_date_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "start_date_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "issued_to": { "type": "string" @@ -93711,7 +106342,11 @@ "type": "string" }, "type": { - "$ref": "#/components/schemas/license._types.LicenseType" + "allOf": [ + { + "$ref": "#/components/schemas/license._types.LicenseType" + } + ] }, "uid": { "type": "string" @@ -93753,7 +106388,12 @@ "type": "string" }, "last_modified": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The date the pipeline was last updated.\nIt must be in the `yyyy-MM-dd'T'HH:mm:ss.SSSZZ` strict_date_time format.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "pipeline": { "externalDocs": { @@ -93763,10 +106403,23 @@ "type": "string" }, "pipeline_metadata": { - "$ref": "#/components/schemas/logstash._types.PipelineMetadata" + "description": "Optional metadata about the pipeline, which can have any contents.\nThis metadata is not generated or used by Elasticsearch or Logstash.", + "allOf": [ + { + "$ref": "#/components/schemas/logstash._types.PipelineMetadata" + } + ] }, "pipeline_settings": { - "$ref": "#/components/schemas/logstash._types.PipelineSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/logstash/logstash-settings-file" + }, + "description": "Settings for the pipeline.\nIt supports only flat keys in dot notation.", + "allOf": [ + { + "$ref": "#/components/schemas/logstash._types.PipelineSettings" + } + ] }, "username": { "description": "The user who last updated the pipeline.", @@ -93838,25 +106491,58 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The unique document ID.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The index that contains the document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "The key for the primary shard the document resides on. Required if routing is used during indexing.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "_source": { - "$ref": "#/components/schemas/_global.search._types.SourceConfig" + "description": "If `false`, excludes all _source fields.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.SourceConfig" + } + ] }, "stored_fields": { - "$ref": "#/components/schemas/_types.Fields" + "description": "The stored fields you want to retrieve.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "version_type": { - "$ref": "#/components/schemas/_types.VersionType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionType" + } + ] } }, "required": [ @@ -93877,13 +106563,25 @@ "type": "object", "properties": { "error": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] }, "_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] } }, "required": [ @@ -93900,7 +106598,12 @@ "type": "string" }, "level": { - "$ref": "#/components/schemas/migration.deprecations.DeprecationLevel" + "description": "The level property describes the significance of the issue.", + "allOf": [ + { + "$ref": "#/components/schemas/migration.deprecations.DeprecationLevel" + } + ] }, "message": { "description": "Descriptive information about the deprecation warning.", @@ -93943,10 +106646,18 @@ "type": "string" }, "minimum_index_version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "migration_status": { - "$ref": "#/components/schemas/migration.get_feature_upgrade_status.MigrationStatus" + "allOf": [ + { + "$ref": "#/components/schemas/migration.get_feature_upgrade_status.MigrationStatus" + } + ] }, "indices": { "type": "array", @@ -93975,13 +106686,25 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "failure_cause": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] } }, "required": [ @@ -94004,13 +106727,29 @@ "type": "object", "properties": { "bucket_span": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The size of the interval that the analysis is aggregated into, typically between `5m` and `1h`. This value should be either a whole number of days or equate to a\nwhole number of buckets in one day. If the anomaly detection job uses a datafeed with aggregations, this value must also be divisible by the interval of the date histogram aggregation.", + "default": "5m", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "categorization_analyzer": { - "$ref": "#/components/schemas/ml._types.CategorizationAnalyzer" + "description": "If `categorization_field_name` is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as `categorization_filters`. The categorization analyzer specifies how the `categorization_field` is interpreted by the categorization process. The `categorization_analyzer` field can be specified either as a string or as an object. If it is a string, it must refer to a built-in analyzer or one added by another plugin.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.CategorizationAnalyzer" + } + ] }, "categorization_field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "categorization_filters": { "description": "If `categorization_field_name` is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as `categorization_analyzer`. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the `categorization_analyzer` property instead and include the filters as pattern_replace character filters. The effect is exactly the same.", @@ -94034,20 +106773,41 @@ } }, "latency": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second. NOTE: Latency is applicable only when you send data by using the post data API.", + "default": "0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "model_prune_window": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of the `bucket_span`. If set too low, important information may be removed from the model. For jobs created in 8.1 and later, the default value is the greater of `30d` or 20 times `bucket_span`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "multivariate_by_fields": { "description": "This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to `true`, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. For example, suppose CPU and memory usage on host A is usually highly correlated with the same metrics on host B. Perhaps this correlation occurs because they are running a load-balanced application. If you enable this property, anomalies will be reported when, for example, CPU usage on host A is high and the value of CPU usage on host B is low. That is to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU of host B. To use the `multivariate_by_fields` property, you must also specify `by_field_name` in your detector.", "type": "boolean" }, "per_partition_categorization": { - "$ref": "#/components/schemas/ml._types.PerPartitionCategorization" + "description": "Settings related to how categorization interacts with partition fields.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.PerPartitionCategorization" + } + ] }, "summary_count_field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -94082,7 +106842,15 @@ } }, "tokenizer": { - "$ref": "#/components/schemas/_types.analysis.Tokenizer" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/text-analysis/tokenizer-reference" + }, + "description": "The name or definition of the tokenizer to use after character filters are applied. This property is compulsory if `categorization_analyzer` is specified as an object. Machine learning provides a tokenizer called `ml_standard` that tokenizes in a way that has been determined to produce good categorization results on a variety of log file formats for logs in English. If you want to use that tokenizer but change the character or token filters, specify \"tokenizer\": \"ml_standard\" in your `categorization_analyzer`. Additionally, the `ml_classic` tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2). `ml_classic` was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify \"tokenizer\": \"ml_classic\" in your `categorization_analyzer`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.Tokenizer" + } + ] } } }, @@ -94090,7 +106858,12 @@ "type": "object", "properties": { "by_field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "custom_rules": { "description": "Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules.", @@ -94108,20 +106881,40 @@ "type": "number" }, "exclude_frequent": { - "$ref": "#/components/schemas/ml._types.ExcludeFrequent" + "description": "If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, you can set `exclude_frequent` to `all` for both fields, or to `by` or `over` for those specific fields.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ExcludeFrequent" + } + ] }, "field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "function": { "description": "The analysis function that is used. For example, `count`, `rare`, `mean`, `min`, `max`, or `sum`.", "type": "string" }, "over_field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "partition_field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "use_null": { "description": "Defines whether a new series is used as the null series when there is no value for the by or partition fields.", @@ -94170,10 +106963,20 @@ "type": "object", "properties": { "applies_to": { - "$ref": "#/components/schemas/ml._types.AppliesTo" + "description": "Specifies the result property to which the condition applies. If your detector uses `lat_long`, `metric`, `rare`, or `freq_rare` functions, you can only specify conditions that apply to time.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AppliesTo" + } + ] }, "operator": { - "$ref": "#/components/schemas/ml._types.ConditionOperator" + "description": "Specifies the condition operator. The available options are greater than, greater than or equals, less than, and less than or equals.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ConditionOperator" + } + ] }, "value": { "description": "The value that is compared against the `applies_to` field using the operator.", @@ -94208,10 +107011,21 @@ "type": "object", "properties": { "filter_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The identifier for the filter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "filter_type": { - "$ref": "#/components/schemas/ml._types.FilterType" + "description": "If set to `include`, the rule applies for values in the filter. If set to `exclude`, the rule applies for values not in the filter.", + "default": "include", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.FilterType" + } + ] } }, "required": [ @@ -94251,13 +107065,28 @@ "type": "object", "properties": { "classification": { - "$ref": "#/components/schemas/ml._types.DataframeEvaluationClassification" + "description": "Classification evaluation evaluates the results of a classification analysis which outputs a prediction that identifies to which of the classes each document belongs.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeEvaluationClassification" + } + ] }, "outlier_detection": { - "$ref": "#/components/schemas/ml._types.DataframeEvaluationOutlierDetection" + "description": "Outlier detection evaluates the results of an outlier detection analysis which outputs the probability that each document is an outlier.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeEvaluationOutlierDetection" + } + ] }, "regression": { - "$ref": "#/components/schemas/ml._types.DataframeEvaluationRegression" + "description": "Regression evaluation evaluates the results of a regression analysis which outputs a prediction of values.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeEvaluationRegression" + } + ] } }, "minProperties": 1, @@ -94267,16 +107096,36 @@ "type": "object", "properties": { "actual_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "predicted_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field in the index which contains the predicted value, in other words the results of the classification analysis.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "top_classes_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field of the index which is an array of documents of the form { \"class_name\": XXX, \"class_probability\": YYY }. This field must be defined as nested in the mappings.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "metrics": { - "$ref": "#/components/schemas/ml._types.DataframeEvaluationClassificationMetrics" + "description": "Specifies the metrics that are used for the evaluation.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeEvaluationClassificationMetrics" + } + ] } }, "required": [ @@ -94313,7 +107162,12 @@ "type": "object", "properties": { "auc_roc": { - "$ref": "#/components/schemas/ml._types.DataframeEvaluationClassificationMetricsAucRoc" + "description": "The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as \"class_name\") treated as positive.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeEvaluationClassificationMetricsAucRoc" + } + ] }, "precision": { "description": "Precision of predictions (per-class and average).", @@ -94335,7 +107189,12 @@ "type": "object", "properties": { "class_name": { - "$ref": "#/components/schemas/_types.Name" + "description": "Name of the only class that is treated as positive during AUC ROC calculation. Other classes are treated as negative (\"one-vs-all\" strategy). All the evaluated documents must have class_name in the list of their top classes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "include_curve": { "description": "Whether or not the curve should be returned in addition to the score. Default value is false.", @@ -94347,13 +107206,28 @@ "type": "object", "properties": { "actual_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "predicted_probability_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "metrics": { - "$ref": "#/components/schemas/ml._types.DataframeEvaluationOutlierDetectionMetrics" + "description": "Specifies the metrics that are used for the evaluation.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeEvaluationOutlierDetectionMetrics" + } + ] } }, "required": [ @@ -94384,13 +107258,28 @@ "type": "object", "properties": { "actual_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field of the index which contains the ground truth. The data type of this field must be numerical.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "predicted_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field in the index that contains the predicted value, in other words the results of the regression analysis.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "metrics": { - "$ref": "#/components/schemas/ml._types.DataframeEvaluationRegressionMetrics" + "description": "Specifies the metrics that are used for the evaluation. For more information on mse, msle, and huber, consult the Jupyter notebook on regression loss functions.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeEvaluationRegressionMetrics" + } + ] } }, "required": [ @@ -94409,10 +107298,20 @@ } }, "msle": { - "$ref": "#/components/schemas/ml._types.DataframeEvaluationRegressionMetricsMsle" + "description": "Average squared difference between the logarithm of the predicted values and the logarithm of the actual (ground truth) value.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeEvaluationRegressionMetricsMsle" + } + ] }, "huber": { - "$ref": "#/components/schemas/ml._types.DataframeEvaluationRegressionMetricsHuber" + "description": "Pseudo Huber loss function.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeEvaluationRegressionMetricsHuber" + } + ] }, "r_squared": { "description": "Proportion of the variance in the dependent variable that is predictable from the independent variables.", @@ -94445,19 +107344,44 @@ "type": "object", "properties": { "auc_roc": { - "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationSummaryAucRoc" + "description": "The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve.\nIt is calculated for a specific class (provided as \"class_name\") treated as positive.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationSummaryAucRoc" + } + ] }, "accuracy": { - "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummaryAccuracy" + "description": "Accuracy of predictions (per-class and overall).", + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummaryAccuracy" + } + ] }, "multiclass_confusion_matrix": { - "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummaryMulticlassConfusionMatrix" + "description": "Multiclass confusion matrix.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummaryMulticlassConfusionMatrix" + } + ] }, "precision": { - "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummaryPrecision" + "description": "Precision of predictions (per-class and average).", + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummaryPrecision" + } + ] }, "recall": { - "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummaryRecall" + "description": "Recall of predictions (per-class and average).", + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummaryRecall" + } + ] } } }, @@ -94536,7 +107460,11 @@ "type": "object", "properties": { "class_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] } }, "required": [ @@ -94567,7 +107495,11 @@ "type": "object", "properties": { "actual_class": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "actual_class_doc_count": { "type": "number" @@ -94593,7 +107525,11 @@ "type": "object", "properties": { "predicted_class": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "count": { "type": "number" @@ -94644,7 +107580,13 @@ "type": "object", "properties": { "auc_roc": { - "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationSummaryAucRoc" + "description": "The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve.", + "default": "{\"include_curve\": false}", + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationSummaryAucRoc" + } + ] }, "precision": { "description": "Set the different thresholds of the outlier score at where the metric is calculated.", @@ -94700,16 +107642,36 @@ "type": "object", "properties": { "huber": { - "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue" + "description": "Pseudo Huber loss function.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue" + } + ] }, "mse": { - "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue" + "description": "Average squared difference between the predicted values and the actual (`ground truth`) value.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue" + } + ] }, "msle": { - "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue" + "description": "Average squared difference between the logarithm of the predicted values and the logarithm of the actual (`ground truth`) value.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue" + } + ] }, "r_squared": { - "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue" + "description": "Proportion of the variance in the dependent variable that is predictable from the independent variables.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue" + } + ] } } }, @@ -94717,16 +107679,36 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.Indices" + "description": "Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. NOTE: If your source indices contain documents with the same IDs, only the document that is indexed last appears in the destination index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {\"match_all\": {}}.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "description": "Definitions of runtime fields that will become part of the mapping of the destination index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "_source": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields" + "description": "Specify `includes` and/or `excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields" + } + ] } }, "required": [ @@ -94756,10 +107738,20 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "Defines the destination index to store the results of the data frame analytics job.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "results_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Defines the name of the field in which to store the results of the analysis. Defaults to `ml`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -94770,13 +107762,28 @@ "type": "object", "properties": { "classification": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisClassification" + "description": "The configuration information necessary to perform classification.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisClassification" + } + ] }, "outlier_detection": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisOutlierDetection" + "description": "The configuration information necessary to perform outlier detection. NOTE: Advanced parameters are for fine-tuning classification analysis. They are set automatically by hyperparameter optimization to give the minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisOutlierDetection" + } + ] }, "regression": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisRegression" + "description": "The configuration information necessary to perform regression. NOTE: Advanced parameters are for fine-tuning regression analysis. They are set automatically by hyperparameter optimization to give the minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisRegression" + } + ] } }, "minProperties": 1, @@ -94863,7 +107870,12 @@ "type": "number" }, "prediction_field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "Defines the name of the prediction field in the results. Defaults to `_prediction`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "randomize_seed": { "description": "Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as `source` and `analyzed_fields` are the same).", @@ -94878,7 +107890,13 @@ "type": "number" }, "training_percent": { - "$ref": "#/components/schemas/_types.Percentage" + "description": "Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage.", + "default": 100.0, + "allOf": [ + { + "$ref": "#/components/schemas/_types.Percentage" + } + ] } }, "required": [ @@ -94889,19 +107907,44 @@ "type": "object", "properties": { "frequency_encoding": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorFrequencyEncoding" + "description": "The configuration information necessary to perform frequency encoding.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorFrequencyEncoding" + } + ] }, "multi_encoding": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorMultiEncoding" + "description": "The configuration information necessary to perform multi encoding. It allows multiple processors to be changed together. This way the output of a processor can then be passed to another as an input.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorMultiEncoding" + } + ] }, "n_gram_encoding": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorNGramEncoding" + "description": "The configuration information necessary to perform n-gram encoding. Features created by this encoder have the following name format: .. For example, if the feature_prefix is f, the feature name for the second unigram in a string is f.11.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorNGramEncoding" + } + ] }, "one_hot_encoding": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorOneHotEncoding" + "description": "The configuration information necessary to perform one hot encoding.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorOneHotEncoding" + } + ] }, "target_mean_encoding": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorTargetMeanEncoding" + "description": "The configuration information necessary to perform target mean encoding.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorTargetMeanEncoding" + } + ] } }, "minProperties": 1, @@ -94911,10 +107954,19 @@ "type": "object", "properties": { "feature_name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The resulting feature name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "frequency_map": { "description": "The resulting frequency map for the field value. If the field value is missing from the frequency_map, the resulting value is 0.", @@ -94953,7 +108005,12 @@ "type": "string" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The name of the text field to encode.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "length": { "description": "Specifies the length of the n-gram substring. Defaults to 50. Must be greater than 0.", @@ -94983,7 +108040,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The name of the field to encode.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "hot_map": { "description": "The one hot map mapping the field value with the column name.", @@ -95003,10 +108065,20 @@ "type": "number" }, "feature_name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The resulting feature name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The name of the field to encode.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "target_map": { "description": "The field value to target mean transition map.", @@ -95100,7 +108172,12 @@ } }, "name": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "reason": { "description": "The reason a field is not selected to be included in the analysis.", @@ -95160,7 +108237,12 @@ } }, "bucket_span": { - "$ref": "#/components/schemas/_types.DurationValueUnitSeconds" + "description": "The length of the bucket in seconds. This value matches the bucket span that is specified in the job.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitSeconds" + } + ] }, "event_count": { "description": "The number of input data records processed in this bucket.", @@ -95175,20 +108257,40 @@ "type": "boolean" }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Identifier for the anomaly detection job.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "processing_time_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The amount of time, in milliseconds, that it took to analyze the bucket contents and calculate results.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "result_type": { "description": "Internal. This value is always set to bucket.", "type": "string" }, "timestamp": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The start time of the bucket. This timestamp uniquely identifies the bucket. Events that occur exactly at the\ntimestamp of the bucket are included in the results for the bucket.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "timestamp_string": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The start time of the bucket. This timestamp uniquely identifies the bucket. Events that occur exactly at the\ntimestamp of the bucket are included in the results for the bucket.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] } }, "required": [ @@ -95212,10 +108314,20 @@ "type": "number" }, "bucket_span": { - "$ref": "#/components/schemas/_types.DurationValueUnitSeconds" + "description": "The length of the bucket in seconds. This value matches the bucket span that is specified in the job.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitSeconds" + } + ] }, "influencer_field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field name of the influencer.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "initial_anomaly_score": { "description": "The score between 0-100 for each bucket influencer. This score is the initial value that was calculated at the\ntime the bucket was processed.", @@ -95226,7 +108338,12 @@ "type": "boolean" }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Identifier for the anomaly detection job.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "probability": { "description": "The probability that the bucket has this behavior, in the range 0 to 1. This value can be held to a high precision\nof over 300 decimal places, so the `anomaly_score` is provided as a human-readable and friendly interpretation of\nthis.", @@ -95241,10 +108358,20 @@ "type": "string" }, "timestamp": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The start time of the bucket for which these results were calculated.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "timestamp_string": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The start time of the bucket for which these results were calculated.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] } }, "required": [ @@ -95271,20 +108398,39 @@ "type": "object", "properties": { "calendar_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "A string that uniquely identifies a calendar.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "event_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "description": { "description": "A description of the scheduled event.", "type": "string" }, "end_time": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The timestamp for the end of the scheduled event in milliseconds since the epoch or ISO 8601 format.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "start_time": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The timestamp for the beginning of the scheduled event in milliseconds since the epoch or ISO 8601 format.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "skip_result": { "description": "When true the model will not create results for this calendar period.", @@ -95311,7 +108457,12 @@ "type": "object", "properties": { "calendar_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "A string that uniquely identifies a calendar.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "description": { "description": "A description of the calendar.", @@ -95337,7 +108488,12 @@ "type": "object", "properties": { "category_id": { - "$ref": "#/components/schemas/_types.ulong" + "description": "A unique identifier for the category. category_id is unique at the job level, even when per-partition categorization is enabled.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ulong" + } + ] }, "examples": { "description": "A list of examples of actual values that matched the category.", @@ -95347,13 +108503,28 @@ } }, "grok_pattern": { - "$ref": "#/components/schemas/_types.GrokPattern" + "description": "[experimental] A Grok pattern that could be used in Logstash or an ingest pipeline to extract fields from messages that match the category. This field is experimental and may be changed or removed in a future release. The Grok patterns that are found are not optimal, but are often a good starting point for manual tweaking.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.GrokPattern" + } + ] }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Identifier for the anomaly detection job.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "max_matching_length": { - "$ref": "#/components/schemas/_types.ulong" + "description": "The maximum length of the fields that matched the category. The value is increased by 10% to enable matching for similar fields that have not been analyzed.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ulong" + } + ] }, "partition_field_name": { "description": "If per-partition categorization is enabled, this property identifies the field used to segment the categorization. It is not present when per-partition categorization is disabled.", @@ -95410,25 +108581,50 @@ "type": "boolean" }, "analysis": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer" + } + ] }, "analyzed_fields": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields" + } + ] }, "authorization": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsAuthorization" + "description": "The security privileges that the job uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the job, this property is omitted.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsAuthorization" + } + ] }, "create_time": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "description": { "type": "string" }, "dest": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsDestination" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsDestination" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "max_num_threads": { "type": "number" @@ -95437,13 +108633,25 @@ "type": "string" }, "source": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] } }, "required": [ @@ -95457,7 +108665,12 @@ "type": "object", "properties": { "api_key": { - "$ref": "#/components/schemas/ml._types.ApiKeyAuthorization" + "description": "If an API key was used for the most recent update to the job, its name and identifier are listed in the response.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ApiKeyAuthorization" + } + ] }, "roles": { "description": "If a user ID was used for the most recent update to the job, its roles at the time of the update are listed in the response.", @@ -95493,23 +108706,49 @@ "type": "object", "properties": { "analysis_stats": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsContainer" + "description": "An object containing information about the analysis job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsContainer" + } + ] }, "assignment_explanation": { "description": "For running jobs only, contains messages relating to the selection of a node to run the job.", "type": "string" }, "data_counts": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsDataCounts" + "description": "An object that provides counts for the quantity of documents skipped, used in training, or available for testing.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsDataCounts" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The unique identifier of the data frame analytics job.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "memory_usage": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsMemoryUsage" + "description": "An object describing memory usage of the analytics. It is present only after the job is started and memory usage is reported.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsMemoryUsage" + } + ] }, "node": { - "$ref": "#/components/schemas/_types.NodeAttributes" + "description": "Contains properties for the node that runs the job. This information is available only for running jobs.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeAttributes" + } + ] }, "progress": { "description": "The progress report of the data frame analytics job by phase.", @@ -95519,7 +108758,12 @@ } }, "state": { - "$ref": "#/components/schemas/ml._types.DataframeState" + "description": "The status of the data frame analytics job, which can be one of the following values: failed, started, starting, stopping, stopped.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeState" + } + ] } }, "required": [ @@ -95534,13 +108778,28 @@ "type": "object", "properties": { "classification_stats": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsHyperparameters" + "description": "An object containing information about the classification analysis job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsHyperparameters" + } + ] }, "outlier_detection_stats": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsOutlierDetection" + "description": "An object containing information about the outlier detection job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsOutlierDetection" + } + ] }, "regression_stats": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsHyperparameters" + "description": "An object containing information about the regression analysis.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsHyperparameters" + } + ] } }, "minProperties": 1, @@ -95550,20 +108809,40 @@ "type": "object", "properties": { "hyperparameters": { - "$ref": "#/components/schemas/ml._types.Hyperparameters" + "description": "An object containing the parameters of the classification analysis job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Hyperparameters" + } + ] }, "iteration": { "description": "The number of iterations on the analysis.", "type": "number" }, "timestamp": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The timestamp when the statistics were reported in milliseconds since the epoch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "timing_stats": { - "$ref": "#/components/schemas/ml._types.TimingStats" + "description": "An object containing time statistics about the data frame analytics job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TimingStats" + } + ] }, "validation_loss": { - "$ref": "#/components/schemas/ml._types.ValidationLoss" + "description": "An object containing information about validation loss.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ValidationLoss" + } + ] } }, "required": [ @@ -95639,10 +108918,20 @@ "type": "object", "properties": { "elapsed_time": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "Runtime of the analysis in milliseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "iteration_time": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "Runtime of the latest iteration of the analysis in milliseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } }, "required": [ @@ -95673,13 +108962,28 @@ "type": "object", "properties": { "parameters": { - "$ref": "#/components/schemas/ml._types.OutlierDetectionParameters" + "description": "The list of job parameters specified by the user or determined by algorithmic heuristics.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.OutlierDetectionParameters" + } + ] }, "timestamp": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The timestamp when the statistics were reported in milliseconds since the epoch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "timing_stats": { - "$ref": "#/components/schemas/ml._types.TimingStats" + "description": "An object containing time statistics about the data frame analytics job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TimingStats" + } + ] } }, "required": [ @@ -95758,7 +109062,12 @@ "type": "string" }, "timestamp": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The timestamp when memory usage was calculated.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] } }, "required": [ @@ -95777,16 +109086,36 @@ } }, "ephemeral_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The ephemeral ID of the node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.NodeId" + "description": "The unique identifier of the node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.NodeName" + "description": "The unique identifier of the node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeName" + } + ] }, "transport_address": { - "$ref": "#/components/schemas/_types.TransportAddress" + "description": "The host and port where transport HTTP connections are accepted.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TransportAddress" + } + ] } }, "required": [ @@ -95831,19 +109160,45 @@ "type": "string" }, "datafeed_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "A numerical character string that uniquely identifies the datafeed.\nThis identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.\nIt must start and end with alphanumeric characters.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "node": { - "$ref": "#/components/schemas/ml._types.DiscoveryNodeCompact" + "description": "For started datafeeds only, this information pertains to the node upon which the datafeed is started.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DiscoveryNodeCompact" + } + ] }, "state": { - "$ref": "#/components/schemas/ml._types.DatafeedState" + "description": "The status of the datafeed, which can be one of the following values: `starting`, `started`, `stopping`, `stopped`.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DatafeedState" + } + ] }, "timing_stats": { - "$ref": "#/components/schemas/ml._types.DatafeedTimingStats" + "description": "An object that provides statistical information about timing aspect of this datafeed.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DatafeedTimingStats" + } + ] }, "running_state": { - "$ref": "#/components/schemas/ml._types.DatafeedRunningState" + "description": "An object containing the running state for this datafeed.\nIt is only provided if the datafeed is started.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DatafeedRunningState" + } + ] } }, "required": [ @@ -95856,16 +109211,32 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "ephemeral_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "transport_address": { - "$ref": "#/components/schemas/_types.TransportAddress" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TransportAddress" + } + ] }, "attributes": { "type": "object", @@ -95890,23 +109261,47 @@ "type": "number" }, "exponential_average_search_time_per_hour_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "description": "The exponential average search time per hour, in milliseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] }, "exponential_average_calculation_context": { - "$ref": "#/components/schemas/ml._types.ExponentialAverageCalculationContext" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ExponentialAverageCalculationContext" + } + ] }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Identifier for the anomaly detection job.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "search_count": { "description": "The number of searches run by the datafeed.", "type": "number" }, "total_search_time_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "description": "The total time the datafeed spent searching, in milliseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] }, "average_search_time_per_bucket_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "description": "The average search time per bucket, in milliseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] } }, "required": [ @@ -95932,13 +109327,25 @@ "type": "object", "properties": { "incremental_metric_value_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] }, "latest_timestamp": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "previous_exponential_average_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] } }, "required": [ @@ -95957,7 +109364,12 @@ "type": "boolean" }, "search_interval": { - "$ref": "#/components/schemas/ml._types.RunningStateSearchInterval" + "description": "Provides the latest time interval the datafeed has searched.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.RunningStateSearchInterval" + } + ] } }, "required": [ @@ -95969,16 +109381,36 @@ "type": "object", "properties": { "end": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The end time.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "end_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The end time as an epoch in milliseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "start": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The start time.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "start_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The start time as an epoch in milliseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } }, "required": [ @@ -95996,16 +109428,33 @@ } }, "authorization": { - "$ref": "#/components/schemas/ml._types.DatafeedAuthorization" + "description": "The security privileges that the datafeed uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the datafeed, this property is omitted.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DatafeedAuthorization" + } + ] }, "chunking_config": { - "$ref": "#/components/schemas/ml._types.ChunkingConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ChunkingConfig" + } + ] }, "datafeed_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "frequency": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "indices": { "type": "array", @@ -96020,16 +109469,31 @@ } }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "max_empty_searches": { "type": "number" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl" + }, + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "query_delay": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "script_fields": { "type": "object", @@ -96041,13 +109505,25 @@ "type": "number" }, "delayed_data_check_config": { - "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "indices_options": { - "$ref": "#/components/schemas/_types.IndicesOptions" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndicesOptions" + } + ] } }, "required": [ @@ -96062,7 +109538,12 @@ "type": "object", "properties": { "api_key": { - "$ref": "#/components/schemas/ml._types.ApiKeyAuthorization" + "description": "If an API key was used for the most recent update to the datafeed, its name and identifier are listed in the response.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ApiKeyAuthorization" + } + ] }, "roles": { "description": "If a user ID was used for the most recent update to the datafeed, its roles at the time of the update are listed in the response.", @@ -96081,10 +109562,21 @@ "type": "object", "properties": { "mode": { - "$ref": "#/components/schemas/ml._types.ChunkingMode" + "description": "If the mode is `auto`, the chunk size is dynamically calculated;\nthis is the recommended value when the datafeed does not use aggregations.\nIf the mode is `manual`, chunking is applied according to the specified `time_span`;\nuse this mode when the datafeed uses aggregations. If the mode is `off`, no chunking is applied.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ChunkingMode" + } + ] }, "time_span": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The time span that each search will be querying. This setting is applicable only when the `mode` is set to `manual`.", + "default": "3h", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } }, "required": [ @@ -96103,7 +109595,12 @@ "type": "object", "properties": { "check_window": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The window of time that is searched for late data. This window of time ends with the latest finalized bucket.\nIt defaults to null, which causes an appropriate `check_window` to be calculated when the real-time datafeed runs.\nIn particular, the default `check_window` span calculation is based on the maximum of `2h` or `8 * bucket_span`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "enabled": { "description": "Specifies whether the datafeed periodically checks for delayed data.", @@ -96123,7 +109620,12 @@ "type": "boolean" }, "expand_wildcards": { - "$ref": "#/components/schemas/_types.ExpandWildcards" + "description": "Type of index that wildcard patterns can match. If the request can target data streams, this argument\ndetermines whether wildcard expressions match hidden data streams. Supports comma-separated values,\nsuch as `open,hidden`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ExpandWildcards" + } + ] }, "ignore_unavailable": { "description": "If true, missing or closed indices are not included in the response.", @@ -96145,7 +109647,12 @@ "type": "string" }, "filter_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "A string that uniquely identifies a filter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "items": { "description": "An array of strings which is the filter item list.", @@ -96164,14 +109671,24 @@ "type": "object", "properties": { "bucket_span": { - "$ref": "#/components/schemas/_types.DurationValueUnitSeconds" + "description": "The length of the bucket in seconds. This value matches the bucket span that is specified in the job.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitSeconds" + } + ] }, "influencer_score": { "description": "A normalized score between 0-100, which is based on the probability of the influencer in this bucket aggregated\nacross detectors. Unlike `initial_influencer_score`, this value is updated by a re-normalization process as new\ndata is analyzed.", "type": "number" }, "influencer_field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field name of the influencer.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "influencer_field_value": { "description": "The entity that influenced, contributed to, or was to blame for the anomaly.", @@ -96186,7 +109703,12 @@ "type": "boolean" }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Identifier for the anomaly detection job.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "probability": { "description": "The probability that the influencer has this behavior, in the range 0 to 1. This value can be held to a high\nprecision of over 300 decimal places, so the `influencer_score` is provided as a human-readable and friendly\ninterpretation of this value.", @@ -96197,7 +109719,12 @@ "type": "string" }, "timestamp": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The start time of the bucket for which these results were calculated.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "foo": { "description": "Additional influencer properties are added, depending on the fields being analyzed. For example, if it’s\nanalyzing `user_name` as an influencer, a field `user_name` is added to the result document. This\ninformation enables you to filter the anomaly results more easily.", @@ -96225,29 +109752,65 @@ "type": "string" }, "data_counts": { - "$ref": "#/components/schemas/ml._types.DataCounts" + "description": "An object that describes the quantity of input to the job and any related error counts.\nThe `data_count` values are cumulative for the lifetime of a job.\nIf a model snapshot is reverted or old results are deleted, the job counts are not reset.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataCounts" + } + ] }, "forecasts_stats": { - "$ref": "#/components/schemas/ml._types.JobForecastStatistics" + "description": "An object that provides statistical information about forecasts belonging to this job.\nSome statistics are omitted if no forecasts have been made.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobForecastStatistics" + } + ] }, "job_id": { "description": "Identifier for the anomaly detection job.", "type": "string" }, "model_size_stats": { - "$ref": "#/components/schemas/ml._types.ModelSizeStats" + "description": "An object that provides information about the size and contents of the model.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ModelSizeStats" + } + ] }, "node": { - "$ref": "#/components/schemas/ml._types.DiscoveryNodeCompact" + "description": "Contains properties for the node that runs the job.\nThis information is available only for open jobs.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DiscoveryNodeCompact" + } + ] }, "open_time": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "For open jobs only, the elapsed time for which the job has been open.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "state": { - "$ref": "#/components/schemas/ml._types.JobState" + "description": "The status of the anomaly detection job, which can be one of the following values: `closed`, `closing`, `failed`, `opened`, `opening`.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobState" + } + ] }, "timing_stats": { - "$ref": "#/components/schemas/ml._types.JobTimingStats" + "description": "An object that provides statistical information about timing aspect of this job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobTimingStats" + } + ] }, "deleting": { "description": "Indicates that the process of deleting the job is in progress but not yet completed. It is only reported when `true`.", @@ -96288,7 +109851,11 @@ "type": "number" }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "last_data_time": { "type": "number" @@ -96343,13 +109910,25 @@ "type": "object", "properties": { "memory_bytes": { - "$ref": "#/components/schemas/ml._types.JobStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobStatistics" + } + ] }, "processing_time_ms": { - "$ref": "#/components/schemas/ml._types.JobStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobStatistics" + } + ] }, "records": { - "$ref": "#/components/schemas/ml._types.JobStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobStatistics" + } + ] }, "status": { "type": "object", @@ -96399,28 +109978,60 @@ "type": "number" }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "log_time": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "memory_status": { - "$ref": "#/components/schemas/ml._types.MemoryStatus" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.MemoryStatus" + } + ] }, "model_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "model_bytes_exceeded": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "model_bytes_memory_limit": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "output_memory_allocator_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "peak_model_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "assignment_memory_basis": { "type": "string" @@ -96438,7 +110049,11 @@ "type": "number" }, "categorization_status": { - "$ref": "#/components/schemas/ml._types.CategorizationStatus" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.CategorizationStatus" + } + ] }, "categorized_doc_count": { "type": "number" @@ -96485,28 +110100,56 @@ "type": "object", "properties": { "average_bucket_processing_time_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] }, "bucket_count": { "type": "number" }, "exponential_average_bucket_processing_time_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] }, "exponential_average_bucket_processing_time_per_hour_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "total_bucket_processing_time_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] }, "maximum_bucket_processing_time_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] }, "minimum_bucket_processing_time_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] } }, "required": [ @@ -96524,22 +110167,50 @@ "type": "boolean" }, "analysis_config": { - "$ref": "#/components/schemas/ml._types.AnalysisConfig" + "description": "The analysis configuration, which specifies how to analyze the data.\nAfter you create a job, you cannot change the analysis configuration; all the properties are informational.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AnalysisConfig" + } + ] }, "analysis_limits": { - "$ref": "#/components/schemas/ml._types.AnalysisLimits" + "description": "Limits can be applied for the resources required to hold the mathematical models in memory.\nThese limits are approximate and can be set per job.\nThey do not control the memory used by other processes, for example the Elasticsearch Java processes.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AnalysisLimits" + } + ] }, "background_persist_interval": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Advanced configuration option.\nThe time between each periodic persistence of the model.\nThe default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time.\nThe smallest allowed value is 1 hour.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "blocked": { - "$ref": "#/components/schemas/ml._types.JobBlocked" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobBlocked" + } + ] }, "create_time": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "custom_settings": { - "$ref": "#/components/schemas/ml._types.CustomSettings" + "description": "Advanced configuration option.\nContains custom metadata about the job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.CustomSettings" + } + ] }, "daily_model_snapshot_retention_after_days": { "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job.\nIt specifies a period of time (in days) after which only the first snapshot per day is retained.\nThis period is relative to the timestamp of the most recent snapshot for this job.\nValid values range from 0 to `model_snapshot_retention_days`.", @@ -96547,10 +110218,20 @@ "type": "number" }, "data_description": { - "$ref": "#/components/schemas/ml._types.DataDescription" + "description": "The data description defines the format of the input data when you send data to the job by using the post data API.\nNote that when configuring a datafeed, these properties are automatically set.\nWhen data is received via the post data API, it is not stored in Elasticsearch.\nOnly the results for anomaly detection are retained.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataDescription" + } + ] }, "datafeed_config": { - "$ref": "#/components/schemas/ml._types.Datafeed" + "description": "The datafeed, which retrieves data from Elasticsearch for analysis by the job.\nYou can associate only one datafeed with each anomaly detection job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Datafeed" + } + ] }, "deleting": { "description": "Indicates that the process of deleting the job is in progress but not yet completed.\nIt is only reported when `true`.", @@ -96561,7 +110242,12 @@ "type": "string" }, "finished_time": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "If the job closed or failed, this is the time the job finished, otherwise it is `null`.\nThis property is informational; you cannot change its value.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "groups": { "description": "A list of job groups.\nA job can belong to no groups or many.", @@ -96571,20 +110257,39 @@ } }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Identifier for the anomaly detection job.\nThis identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.\nIt must start and end with alphanumeric characters.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "job_type": { "description": "Reserved for future use, currently set to `anomaly_detector`.", "type": "string" }, "job_version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "The machine learning configuration version number at which the the job was created.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "model_plot_config": { - "$ref": "#/components/schemas/ml._types.ModelPlotConfig" + "description": "This advanced configuration option stores model information along with the results.\nIt provides a more detailed view into anomaly detection.\nModel plot provides a simplified and indicative view of the model and its bounds.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ModelPlotConfig" + } + ] }, "model_snapshot_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "model_snapshot_retention_days": { "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job.\nIt specifies the maximum period of time (in days) that snapshots are retained.\nThis period is relative to the timestamp of the most recent snapshot for this job.\nBy default, snapshots ten days older than the newest snapshot are deleted.", @@ -96595,7 +110300,12 @@ "type": "number" }, "results_index_name": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "A text string that affects the name of the machine learning results index.\nThe default value is `shared`, which generates an index named `.ml-anomalies-shared`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "results_retention_days": { "description": "Advanced configuration option.\nThe period of time (in days) that results are retained.\nAge is calculated relative to the timestamp of the latest bucket result.\nIf this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch.\nThe default value is null, which means all results are retained.\nAnnotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results.\nAnnotations added by users are retained forever.", @@ -96620,7 +110330,13 @@ "type": "number" }, "model_memory_limit": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The approximate maximum amount of memory resources that are required for analytical processing. Once this limit is approached, data pruning becomes more aggressive. Upon exceeding this limit, new entities are not modeled. If the `xpack.ml.max_model_memory_limit` setting has a value greater than 0 and less than 1024mb, that value is used instead of the default. The default value is relatively small to ensure that high resource usage is a conscious decision. If you have jobs that are expected to analyze high cardinality fields, you will likely need to use a higher value. If you specify a number instead of a string, the units are assumed to be MiB. Specifying a string is recommended for clarity. If you specify a byte size unit of `b` or `kb` and the number does not equate to a discrete number of megabytes, it is rounded down to the closest MiB. The minimum valid value is 1 MiB. If you specify a value less than 1 MiB, an error occurs. If you specify a value for the `xpack.ml.max_model_memory_limit` setting, an error occurs when you try to create jobs that have `model_memory_limit` values greater than that setting value.", + "default": "1024mb", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] } } }, @@ -96628,10 +110344,18 @@ "type": "object", "properties": { "reason": { - "$ref": "#/components/schemas/ml._types.JobBlockedReason" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobBlockedReason" + } + ] }, "task_id": { - "$ref": "#/components/schemas/_types.TaskId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TaskId" + } + ] } }, "required": [ @@ -96658,7 +110382,13 @@ "type": "string" }, "time_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The name of the field that contains the timestamp.", + "default": "time", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "time_format": { "description": "The time format, which can be `epoch`, `epoch_ms`, or a custom pattern. The value `epoch` refers to UNIX or Epoch time (the number of seconds since 1 Jan 1970). The value `epoch_ms` indicates that time is measured in milliseconds since the epoch. The `epoch` and `epoch_ms` time formats accept either integer or real values. Custom patterns must conform to the Java DateTimeFormatter class. When you use date-time formatting patterns, it is recommended that you provide the full date, time and time zone. For example: `yyyy-MM-dd'T'HH:mm:ssX`. If the pattern that you specify is not sufficient to produce a complete timestamp, job creation fails.", @@ -96685,7 +110415,13 @@ "type": "boolean" }, "terms": { - "$ref": "#/components/schemas/_types.Field" + "description": "Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer.", + "x-state": "Generally available; Added in 7.9.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } } }, @@ -96699,13 +110435,28 @@ } }, "jvm": { - "$ref": "#/components/schemas/ml.get_memory_stats.JvmStats" + "description": "Contains Java Virtual Machine (JVM) statistics for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.get_memory_stats.JvmStats" + } + ] }, "mem": { - "$ref": "#/components/schemas/ml.get_memory_stats.MemStats" + "description": "Contains statistics about memory usage for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.get_memory_stats.MemStats" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "Human-readable identifier for the node. Based on the Node name setting setting.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "roles": { "description": "Roles assigned to the node.", @@ -96715,10 +110466,19 @@ } }, "transport_address": { - "$ref": "#/components/schemas/_types.TransportAddress" + "description": "The host and port where transport HTTP connections are accepted.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TransportAddress" + } + ] }, "ephemeral_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] } }, "required": [ @@ -96735,21 +110495,36 @@ "type": "object", "properties": { "heap_max": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Maximum amount of memory available for use by the heap.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "heap_max_in_bytes": { "description": "Maximum amount of memory, in bytes, available for use by the heap.", "type": "number" }, "java_inference": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Amount of Java heap currently being used for caching inference models.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "java_inference_in_bytes": { "description": "Amount of Java heap, in bytes, currently being used for caching inference models.", "type": "number" }, "java_inference_max": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Maximum amount of Java heap to be used for caching inference models.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "java_inference_max_in_bytes": { "description": "Maximum amount of Java heap, in bytes, to be used for caching inference models.", @@ -96766,21 +110541,36 @@ "type": "object", "properties": { "adjusted_total": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "If the amount of physical memory has been overridden using the es.total_memory_bytes system property\nthen this reports the overridden value. Otherwise it reports the same value as total.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "adjusted_total_in_bytes": { "description": "If the amount of physical memory has been overridden using the `es.total_memory_bytes` system property\nthen this reports the overridden value in bytes. Otherwise it reports the same value as `total_in_bytes`.", "type": "number" }, "total": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Total amount of physical memory.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "total_in_bytes": { "description": "Total amount of physical memory in bytes.", "type": "number" }, "ml": { - "$ref": "#/components/schemas/ml.get_memory_stats.MemMlStats" + "description": "Contains statistics about machine learning use of native memory on the node.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.get_memory_stats.MemMlStats" + } + ] } }, "required": [ @@ -96793,35 +110583,60 @@ "type": "object", "properties": { "anomaly_detectors": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Amount of native memory set aside for anomaly detection jobs.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "anomaly_detectors_in_bytes": { "description": "Amount of native memory, in bytes, set aside for anomaly detection jobs.", "type": "number" }, "data_frame_analytics": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Amount of native memory set aside for data frame analytics jobs.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "data_frame_analytics_in_bytes": { "description": "Amount of native memory, in bytes, set aside for data frame analytics jobs.", "type": "number" }, "max": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Maximum amount of native memory (separate to the JVM heap) that may be used by machine learning native processes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "max_in_bytes": { "description": "Maximum amount of native memory (separate to the JVM heap), in bytes, that may be used by machine learning native processes.", "type": "number" }, "native_code_overhead": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Amount of native memory set aside for loading machine learning native code shared libraries.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "native_code_overhead_in_bytes": { "description": "Amount of native memory, in bytes, set aside for loading machine learning native code shared libraries.", "type": "number" }, "native_inference": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Amount of native memory set aside for trained models that have a PyTorch model_type.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "native_inference_in_bytes": { "description": "Amount of native memory, in bytes, set aside for trained models that have a PyTorch model_type.", @@ -96840,16 +110655,33 @@ "type": "object", "properties": { "job_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "snapshot_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "state": { - "$ref": "#/components/schemas/ml._types.SnapshotUpgradeState" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.SnapshotUpgradeState" + } + ] }, "node": { - "$ref": "#/components/schemas/ml._types.DiscoveryNode" + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DiscoveryNode" + } + ] }, "assignment_explanation": { "type": "string" @@ -96884,13 +110716,25 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "ephemeral_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "transport_address": { - "$ref": "#/components/schemas/_types.TransportAddress" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TransportAddress" + } + ] }, "external_id": { "type": "string" @@ -96908,7 +110752,11 @@ } }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "min_index_version": { "type": "number" @@ -96936,7 +110784,12 @@ "type": "string" }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "A numerical character string that uniquely identifies the job that the snapshot was created for.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "latest_record_time_stamp": { "description": "The timestamp of the latest processed record.", @@ -96947,10 +110800,20 @@ "type": "number" }, "min_version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "The minimum version required to be able to restore the model snapshot.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "model_size_stats": { - "$ref": "#/components/schemas/ml._types.ModelSizeStats" + "description": "Summary information describing the model.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ModelSizeStats" + } + ] }, "retain": { "description": "If true, this snapshot will not be deleted during automatic cleanup of snapshots older than model_snapshot_retention_days. However, this snapshot will be deleted when the job is deleted. The default value is false.", @@ -96961,7 +110824,12 @@ "type": "number" }, "snapshot_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "A numerical character string that uniquely identifies the model snapshot.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "timestamp": { "description": "The creation timestamp for the snapshot.", @@ -96981,7 +110849,12 @@ "type": "object", "properties": { "bucket_span": { - "$ref": "#/components/schemas/_types.DurationValueUnitSeconds" + "description": "The length of the bucket in seconds. Matches the job with the longest bucket_span value.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitSeconds" + } + ] }, "is_interim": { "description": "If true, this is an interim result. In other words, the results are calculated based on partial input data.", @@ -97003,10 +110876,20 @@ "type": "string" }, "timestamp": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The start time of the bucket for which these results were calculated.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "timestamp_string": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The start time of the bucket for which these results were calculated.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] } }, "required": [ @@ -97022,7 +110905,11 @@ "type": "object", "properties": { "job_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "max_anomaly_score": { "type": "number" @@ -97044,10 +110931,20 @@ } }, "anomaly_score_explanation": { - "$ref": "#/components/schemas/ml._types.AnomalyExplanation" + "description": "Information about the factors impacting the initial anomaly score.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AnomalyExplanation" + } + ] }, "bucket_span": { - "$ref": "#/components/schemas/_types.DurationValueUnitSeconds" + "description": "The length of the bucket in seconds. This value matches the `bucket_span` that is specified in the job.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitSeconds" + } + ] }, "by_field_name": { "description": "The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split.", @@ -97081,7 +110978,12 @@ "type": "string" }, "geo_results": { - "$ref": "#/components/schemas/ml._types.GeoResults" + "description": "If the detector function is `lat_long`, this object contains comma delimited strings for the latitude and longitude of the actual and typical values.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.GeoResults" + } + ] }, "influencers": { "description": "If influencers were specified in the detector configuration, this array contains influencers that contributed to or were to blame for an anomaly.", @@ -97131,7 +111033,12 @@ "type": "string" }, "timestamp": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The start time of the bucket for which these results were calculated.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "typical": { "description": "The typical value for the bucket, according to analytical modeling.", @@ -97208,7 +111115,11 @@ } }, "by_field_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "by_field_value": { "type": "string" @@ -97217,7 +111128,11 @@ "type": "string" }, "field_name": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "function": { "type": "string" @@ -97226,7 +111141,11 @@ "type": "string" }, "geo_results": { - "$ref": "#/components/schemas/ml._types.GeoResults" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.GeoResults" + } + ] }, "influencers": { "type": "array", @@ -97235,7 +111154,11 @@ } }, "over_field_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "over_field_value": { "type": "string" @@ -97305,10 +111228,20 @@ "type": "object", "properties": { "model_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Identifier for the trained model.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "model_type": { - "$ref": "#/components/schemas/ml._types.TrainedModelType" + "description": "The model type", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelType" + } + ] }, "tags": { "description": "A comma delimited string of tags. A trained model can have many tags, or none.", @@ -97318,7 +111251,12 @@ } }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "The Elasticsearch version number in which the trained model was created.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "compressed_definition": { "type": "string" @@ -97328,7 +111266,12 @@ "type": "string" }, "create_time": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The time when the trained model was created.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "default_field_map": { "description": "Any field map described in the inference configuration takes precedence.", @@ -97354,32 +111297,63 @@ "type": "boolean" }, "inference_config": { - "$ref": "#/components/schemas/ml._types.InferenceConfigCreateContainer" + "description": "The default configuration for inference. This can be either a regression, classification, or one of the many NLP focused configurations. It must match the underlying definition.trained_model's target_type. For pre-packaged models such as ELSER the config is not required.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.InferenceConfigCreateContainer" + } + ] }, "input": { - "$ref": "#/components/schemas/ml._types.TrainedModelConfigInput" + "description": "The input field names for the model definition.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelConfigInput" + } + ] }, "license_level": { "description": "The license level of the trained model.", "type": "string" }, "metadata": { - "$ref": "#/components/schemas/ml._types.TrainedModelConfigMetadata" + "description": "An object containing metadata about the trained model. For example, models created by data frame analytics contain analysis_config and input objects.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelConfigMetadata" + } + ] }, "model_size_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "model_package": { - "$ref": "#/components/schemas/ml._types.ModelPackageConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ModelPackageConfig" + } + ] }, "location": { - "$ref": "#/components/schemas/ml._types.TrainedModelLocation" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelLocation" + } + ] }, "platform_architecture": { "type": "string" }, "prefix_strings": { - "$ref": "#/components/schemas/ml._types.TrainedModelPrefixStrings" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelPrefixStrings" + } + ] } }, "required": [ @@ -97401,37 +111375,99 @@ "type": "object", "properties": { "regression": { - "$ref": "#/components/schemas/ml._types.RegressionInferenceOptions" + "description": "Regression configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.RegressionInferenceOptions" + } + ] }, "classification": { - "$ref": "#/components/schemas/ml._types.ClassificationInferenceOptions" + "description": "Classification configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ClassificationInferenceOptions" + } + ] }, "text_classification": { - "$ref": "#/components/schemas/ml._types.TextClassificationInferenceOptions" + "description": "Text classification configuration for inference.", + "x-state": "Generally available; Added in 8.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TextClassificationInferenceOptions" + } + ] }, "zero_shot_classification": { - "$ref": "#/components/schemas/ml._types.ZeroShotClassificationInferenceOptions" + "description": "Zeroshot classification configuration for inference.", + "x-state": "Generally available; Added in 8.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ZeroShotClassificationInferenceOptions" + } + ] }, "fill_mask": { - "$ref": "#/components/schemas/ml._types.FillMaskInferenceOptions" + "description": "Fill mask configuration for inference.", + "x-state": "Generally available; Added in 8.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.FillMaskInferenceOptions" + } + ] }, "learning_to_rank": { - "$ref": "#/components/schemas/ml._types.LearningToRankConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.LearningToRankConfig" + } + ] }, "ner": { - "$ref": "#/components/schemas/ml._types.NerInferenceOptions" + "description": "Named entity recognition configuration for inference.", + "x-state": "Generally available; Added in 8.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NerInferenceOptions" + } + ] }, "pass_through": { - "$ref": "#/components/schemas/ml._types.PassThroughInferenceOptions" + "description": "Pass through configuration for inference.", + "x-state": "Generally available; Added in 8.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.PassThroughInferenceOptions" + } + ] }, "text_embedding": { - "$ref": "#/components/schemas/ml._types.TextEmbeddingInferenceOptions" + "description": "Text embedding configuration for inference.", + "x-state": "Generally available; Added in 8.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TextEmbeddingInferenceOptions" + } + ] }, "text_expansion": { - "$ref": "#/components/schemas/ml._types.TextExpansionInferenceOptions" + "description": "Text expansion configuration for inference.", + "x-state": "Generally available; Added in 8.8.0", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TextExpansionInferenceOptions" + } + ] }, "question_answering": { - "$ref": "#/components/schemas/ml._types.QuestionAnsweringInferenceOptions" + "description": "Question answering configuration for inference.", + "x-state": "Generally available; Added in 8.3.0", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.QuestionAnsweringInferenceOptions" + } + ] } }, "minProperties": 1, @@ -97446,7 +111482,12 @@ "type": "number" }, "tokenization": { - "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + "description": "The tokenization options", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", @@ -97460,7 +111501,11 @@ } }, "vocabulary": { - "$ref": "#/components/schemas/ml._types.Vocabulary" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Vocabulary" + } + ] } } }, @@ -97469,19 +111514,45 @@ "type": "object", "properties": { "bert": { - "$ref": "#/components/schemas/ml._types.NlpBertTokenizationConfig" + "description": "Indicates BERT tokenization and its options", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NlpBertTokenizationConfig" + } + ] }, "bert_ja": { - "$ref": "#/components/schemas/ml._types.NlpBertTokenizationConfig" + "description": "Indicates BERT Japanese tokenization and its options", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NlpBertTokenizationConfig" + } + ] }, "mpnet": { - "$ref": "#/components/schemas/ml._types.NlpBertTokenizationConfig" + "description": "Indicates MPNET tokenization and its options", + "x-state": "Generally available; Added in 8.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NlpBertTokenizationConfig" + } + ] }, "roberta": { - "$ref": "#/components/schemas/ml._types.NlpRobertaTokenizationConfig" + "description": "Indicates RoBERTa tokenization and its options", + "x-state": "Generally available; Added in 8.2.0", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NlpRobertaTokenizationConfig" + } + ] }, "xlm_roberta": { - "$ref": "#/components/schemas/ml._types.XlmRobertaTokenizationConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.XlmRobertaTokenizationConfig" + } + ] } }, "minProperties": 1, @@ -97517,7 +111588,13 @@ "type": "number" }, "truncate": { - "$ref": "#/components/schemas/ml._types.TokenizationTruncate" + "description": "Should tokenization input be automatically truncated before sending to the model for inference", + "default": "first", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TokenizationTruncate" + } + ] }, "with_special_tokens": { "description": "Is tokenization completed with special tokens", @@ -97566,7 +111643,11 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] } }, "required": [ @@ -97578,7 +111659,12 @@ "type": "object", "properties": { "tokenization": { - "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + "description": "The tokenization options to update when inferring", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + } + ] }, "hypothesis_template": { "description": "Hypothesis template used when tokenizing labels for prediction", @@ -97626,14 +111712,23 @@ "type": "number" }, "tokenization": { - "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + "description": "The tokenization options to update when inferring", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", "type": "string" }, "vocabulary": { - "$ref": "#/components/schemas/ml._types.Vocabulary" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Vocabulary" + } + ] } }, "required": [ @@ -97683,7 +111778,11 @@ "type": "string" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } }, "required": [ @@ -97696,7 +111795,12 @@ "type": "object", "properties": { "tokenization": { - "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + "description": "The tokenization options", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", @@ -97710,7 +111814,11 @@ } }, "vocabulary": { - "$ref": "#/components/schemas/ml._types.Vocabulary" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Vocabulary" + } + ] } } }, @@ -97719,14 +111827,23 @@ "type": "object", "properties": { "tokenization": { - "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + "description": "The tokenization options", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", "type": "string" }, "vocabulary": { - "$ref": "#/components/schemas/ml._types.Vocabulary" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Vocabulary" + } + ] } } }, @@ -97739,14 +111856,23 @@ "type": "number" }, "tokenization": { - "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + "description": "The tokenization options", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", "type": "string" }, "vocabulary": { - "$ref": "#/components/schemas/ml._types.Vocabulary" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Vocabulary" + } + ] } }, "required": [ @@ -97758,14 +111884,23 @@ "type": "object", "properties": { "tokenization": { - "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + "description": "The tokenization options", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", "type": "string" }, "vocabulary": { - "$ref": "#/components/schemas/ml._types.Vocabulary" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Vocabulary" + } + ] } }, "required": [ @@ -97781,7 +111916,12 @@ "type": "number" }, "tokenization": { - "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + "description": "The tokenization options to update when inferring", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", @@ -97848,7 +111988,12 @@ "type": "number" }, "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "Name of the hyperparameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "relative_importance": { "description": "A number between 0 and 1 showing the proportion of influence on the variation of the loss function among all tuned hyperparameters. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization.", @@ -97873,7 +112018,12 @@ "type": "object", "properties": { "feature_name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The feature for which this importance was calculated.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "importance": { "description": "A collection of feature importance statistics related to the training data set for this particular feature.", @@ -97922,7 +112072,12 @@ "type": "object", "properties": { "class_name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The target class value. Could be a string, boolean, or number.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "importance": { "description": "A collection of feature importance statistics related to the training data set for this particular feature.", @@ -97941,7 +112096,11 @@ "type": "object", "properties": { "create_time": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "description": { "type": "string" @@ -97953,7 +112112,11 @@ } }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "minimum_version": { "type": "string" @@ -97965,16 +112128,28 @@ "type": "string" }, "packaged_model_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "platform_architecture": { "type": "string" }, "prefix_strings": { - "$ref": "#/components/schemas/ml._types.TrainedModelPrefixStrings" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelPrefixStrings" + } + ] }, "size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "sha256": { "type": "string" @@ -98010,7 +112185,11 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/ml._types.TrainedModelLocationIndex" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelLocationIndex" + } + ] } }, "required": [ @@ -98021,7 +112200,11 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] } }, "required": [ @@ -98032,10 +112215,20 @@ "type": "object", "properties": { "deployment_stats": { - "$ref": "#/components/schemas/ml._types.TrainedModelDeploymentStats" + "description": "A collection of deployment stats, which is present when the models are deployed.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelDeploymentStats" + } + ] }, "inference_stats": { - "$ref": "#/components/schemas/ml._types.TrainedModelInferenceStats" + "description": "A collection of inference stats fields.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelInferenceStats" + } + ] }, "ingest": { "description": "A collection of ingest stats for the model across all nodes.\nThe values are summations of the individual node statistics.\nThe format matches the ingest section in the nodes stats API.", @@ -98045,10 +112238,20 @@ } }, "model_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The unique identifier of the trained model.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "model_size_stats": { - "$ref": "#/components/schemas/ml._types.TrainedModelSizeStats" + "description": "A collection of model size stats.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelSizeStats" + } + ] }, "pipeline_count": { "description": "The number of ingest pipelines that currently refer to the model.", @@ -98065,16 +112268,34 @@ "type": "object", "properties": { "adaptive_allocations": { - "$ref": "#/components/schemas/ml._types.AdaptiveAllocationsSettings" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AdaptiveAllocationsSettings" + } + ] }, "allocation_status": { - "$ref": "#/components/schemas/ml._types.TrainedModelDeploymentAllocationStatus" + "description": "The detailed allocation status for the deployment.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelDeploymentAllocationStatus" + } + ] }, "cache_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "deployment_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The unique identifier for the trained model deployment.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "error_count": { "description": "The sum of `error_count` for all nodes in the deployment.", @@ -98085,7 +112306,12 @@ "type": "number" }, "model_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The unique identifier for the trained model.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "nodes": { "description": "The deployment stats for each node that currently has the model allocated.\nIn serverless, stats are reported for a single unnamed virtual node.", @@ -98102,7 +112328,11 @@ "type": "number" }, "priority": { - "$ref": "#/components/schemas/ml._types.TrainingPriority" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainingPriority" + } + ] }, "queue_capacity": { "description": "The number of inference requests that can be queued before new requests are rejected.", @@ -98117,10 +112347,20 @@ "type": "string" }, "start_time": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The epoch timestamp when the deployment started.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "state": { - "$ref": "#/components/schemas/ml._types.DeploymentAssignmentState" + "description": "The overall state of the deployment.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DeploymentAssignmentState" + } + ] }, "threads_per_allocation": { "description": "The number of threads used be each allocation during inference.", @@ -98168,7 +112408,12 @@ "type": "number" }, "state": { - "$ref": "#/components/schemas/ml._types.DeploymentAllocationState" + "description": "The detailed allocation state related to the nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DeploymentAllocationState" + } + ] }, "target_allocation_count": { "description": "The desired number of nodes for model allocation.", @@ -98193,13 +112438,27 @@ "type": "object", "properties": { "average_inference_time_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "description": "The average time for each inference call to complete on this node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] }, "average_inference_time_ms_last_minute": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] }, "average_inference_time_ms_excluding_cache_hits": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "description": "The average time for each inference call to complete on this node, excluding cache", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] }, "error_count": { "description": "The number of errors when evaluating the trained model.", @@ -98216,10 +112475,21 @@ "type": "number" }, "last_access": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The epoch time stamp of the last inference call for the model on this node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "node": { - "$ref": "#/components/schemas/ml._types.DiscoveryNode" + "description": "Information pertaining to the node.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DiscoveryNode" + } + ] }, "number_of_allocations": { "description": "The number of allocations assigned to this node.", @@ -98237,10 +112507,20 @@ "type": "number" }, "routing_state": { - "$ref": "#/components/schemas/ml._types.TrainedModelAssignmentRoutingStateAndReason" + "description": "The current routing state and reason for the current routing state for this allocation.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelAssignmentRoutingStateAndReason" + } + ] }, "start_time": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The epoch timestamp when the allocation started.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "threads_per_allocation": { "description": "The number of threads used by each allocation during inference.", @@ -98268,7 +112548,12 @@ "type": "string" }, "routing_state": { - "$ref": "#/components/schemas/ml._types.RoutingState" + "description": "The current routing state.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.RoutingState" + } + ] } }, "required": [ @@ -98321,7 +112606,12 @@ "type": "number" }, "timestamp": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The time when the statistics were last updated.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] } }, "required": [ @@ -98336,10 +112626,20 @@ "type": "object", "properties": { "model_size_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The size of the model in bytes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "required_native_memory_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The amount of memory required to load the model in bytes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] } }, "required": [ @@ -98351,34 +112651,84 @@ "type": "object", "properties": { "regression": { - "$ref": "#/components/schemas/ml._types.RegressionInferenceOptions" + "description": "Regression configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.RegressionInferenceOptions" + } + ] }, "classification": { - "$ref": "#/components/schemas/ml._types.ClassificationInferenceOptions" + "description": "Classification configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ClassificationInferenceOptions" + } + ] }, "text_classification": { - "$ref": "#/components/schemas/ml._types.TextClassificationInferenceUpdateOptions" + "description": "Text classification configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TextClassificationInferenceUpdateOptions" + } + ] }, "zero_shot_classification": { - "$ref": "#/components/schemas/ml._types.ZeroShotClassificationInferenceUpdateOptions" + "description": "Zeroshot classification configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ZeroShotClassificationInferenceUpdateOptions" + } + ] }, "fill_mask": { - "$ref": "#/components/schemas/ml._types.FillMaskInferenceUpdateOptions" + "description": "Fill mask configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.FillMaskInferenceUpdateOptions" + } + ] }, "ner": { - "$ref": "#/components/schemas/ml._types.NerInferenceUpdateOptions" + "description": "Named entity recognition configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NerInferenceUpdateOptions" + } + ] }, "pass_through": { - "$ref": "#/components/schemas/ml._types.PassThroughInferenceUpdateOptions" + "description": "Pass through configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.PassThroughInferenceUpdateOptions" + } + ] }, "text_embedding": { - "$ref": "#/components/schemas/ml._types.TextEmbeddingInferenceUpdateOptions" + "description": "Text embedding configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TextEmbeddingInferenceUpdateOptions" + } + ] }, "text_expansion": { - "$ref": "#/components/schemas/ml._types.TextExpansionInferenceUpdateOptions" + "description": "Text expansion configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TextExpansionInferenceUpdateOptions" + } + ] }, "question_answering": { - "$ref": "#/components/schemas/ml._types.QuestionAnsweringInferenceUpdateOptions" + "description": "Question answering configuration for inference", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.QuestionAnsweringInferenceUpdateOptions" + } + ] } }, "minProperties": 1, @@ -98392,7 +112742,12 @@ "type": "number" }, "tokenization": { - "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + "description": "The tokenization options to update when inferring", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", @@ -98411,7 +112766,12 @@ "type": "object", "properties": { "truncate": { - "$ref": "#/components/schemas/ml._types.TokenizationTruncate" + "description": "Truncate options to apply", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TokenizationTruncate" + } + ] }, "span": { "description": "Span options to apply", @@ -98423,7 +112783,12 @@ "type": "object", "properties": { "tokenization": { - "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + "description": "The tokenization options to update when inferring", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", @@ -98453,7 +112818,12 @@ "type": "number" }, "tokenization": { - "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + "description": "The tokenization options to update when inferring", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", @@ -98465,7 +112835,12 @@ "type": "object", "properties": { "tokenization": { - "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + "description": "The tokenization options to update when inferring", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", @@ -98477,7 +112852,12 @@ "type": "object", "properties": { "tokenization": { - "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + "description": "The tokenization options to update when inferring", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", @@ -98489,7 +112869,11 @@ "type": "object", "properties": { "tokenization": { - "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", @@ -98501,7 +112885,11 @@ "type": "object", "properties": { "tokenization": { - "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", @@ -98521,7 +112909,12 @@ "type": "number" }, "tokenization": { - "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + "description": "The tokenization options to update when inferring", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", @@ -98694,10 +113087,18 @@ "type": "object", "properties": { "anomaly_detectors": { - "$ref": "#/components/schemas/ml.info.AnomalyDetectors" + "allOf": [ + { + "$ref": "#/components/schemas/ml.info.AnomalyDetectors" + } + ] }, "datafeeds": { - "$ref": "#/components/schemas/ml.info.Datafeeds" + "allOf": [ + { + "$ref": "#/components/schemas/ml.info.Datafeeds" + } + ] } }, "required": [ @@ -98709,7 +113110,11 @@ "type": "object", "properties": { "categorization_analyzer": { - "$ref": "#/components/schemas/ml._types.CategorizationAnalyzer" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.CategorizationAnalyzer" + } + ] }, "categorization_examples_limit": { "type": "number" @@ -98753,13 +113158,25 @@ "type": "number" }, "max_model_memory_limit": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "effective_max_model_memory_limit": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "total_ml_memory": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] } }, "required": [ @@ -98773,7 +113190,11 @@ "type": "string" }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] } }, "required": [ @@ -98785,10 +113206,18 @@ "type": "object", "properties": { "source": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource" + } + ] }, "analysis": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer" + } + ] }, "model_memory_limit": { "type": "string" @@ -98797,7 +113226,11 @@ "type": "number" }, "analyzed_fields": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields" + } + ] } }, "required": [ @@ -98816,38 +113249,87 @@ } }, "chunking_config": { - "$ref": "#/components/schemas/ml._types.ChunkingConfig" + "description": "Datafeeds might be required to search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated and is an advanced configuration option.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ChunkingConfig" + } + ] }, "datafeed_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. The default value is the job identifier.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "delayed_data_check_config": { - "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig" + "description": "Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that the `query_delay` option is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig" + } + ] }, "frequency": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: `150s`. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "indices": { - "$ref": "#/components/schemas/_types.Indices" + "description": "An array of index names. Wildcards are supported. If any indices are in remote clusters, the machine learning nodes must have the `remote_cluster_client` role.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "indices_options": { - "$ref": "#/components/schemas/_types.IndicesOptions" + "description": "Specifies index expansion options that are used during search.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndicesOptions" + } + ] }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "max_empty_searches": { "description": "If a real-time datafeed has never seen any data (including during any initial training period) then it will automatically stop itself and close its associated job after this many real-time searches that return no documents. In other words, it will stop after `frequency` times `max_empty_searches` of real-time operation. If not set then a datafeed with no end time that sees no data will remain started until it is explicitly stopped.", "type": "number" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "query_delay": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between `60s` and `120s`. This randomness improves the query performance when there are multiple jobs running on the same node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "description": "Specifies runtime fields for the datafeed search.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "script_fields": { "description": "Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields.", @@ -98872,16 +113354,36 @@ "type": "boolean" }, "analysis_config": { - "$ref": "#/components/schemas/ml._types.AnalysisConfig" + "description": "The analysis configuration, which specifies how to analyze the data.\nAfter you create a job, you cannot change the analysis configuration; all the properties are informational.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AnalysisConfig" + } + ] }, "analysis_limits": { - "$ref": "#/components/schemas/ml._types.AnalysisLimits" + "description": "Limits can be applied for the resources required to hold the mathematical models in memory.\nThese limits are approximate and can be set per job.\nThey do not control the memory used by other processes, for example the Elasticsearch Java processes.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AnalysisLimits" + } + ] }, "background_persist_interval": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Advanced configuration option.\nThe time between each periodic persistence of the model.\nThe default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time.\nThe smallest allowed value is 1 hour.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "custom_settings": { - "$ref": "#/components/schemas/ml._types.CustomSettings" + "description": "Advanced configuration option.\nContains custom metadata about the job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.CustomSettings" + } + ] }, "daily_model_snapshot_retention_after_days": { "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job.\nIt specifies a period of time (in days) after which only the first snapshot per day is retained.\nThis period is relative to the timestamp of the most recent snapshot for this job.", @@ -98889,10 +113391,20 @@ "type": "number" }, "data_description": { - "$ref": "#/components/schemas/ml._types.DataDescription" + "description": "The data description defines the format of the input data when you send data to the job by using the post data API.\nNote that when configure a datafeed, these properties are automatically set.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataDescription" + } + ] }, "datafeed_config": { - "$ref": "#/components/schemas/ml._types.DatafeedConfig" + "description": "The datafeed, which retrieves data from Elasticsearch for analysis by the job.\nYou can associate only one datafeed with each anomaly detection job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DatafeedConfig" + } + ] }, "description": { "description": "A description of the job.", @@ -98906,14 +113418,24 @@ } }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Identifier for the anomaly detection job.\nThis identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.\nIt must start and end with alphanumeric characters.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "job_type": { "description": "Reserved for future use, currently set to `anomaly_detector`.", "type": "string" }, "model_plot_config": { - "$ref": "#/components/schemas/ml._types.ModelPlotConfig" + "description": "This advanced configuration option stores model information along with the results.\nIt provides a more detailed view into anomaly detection.\nModel plot provides a simplified and indicative view of the model and its bounds.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ModelPlotConfig" + } + ] }, "model_snapshot_retention_days": { "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job.\nIt specifies the maximum period of time (in days) that snapshots are retained.\nThis period is relative to the timestamp of the most recent snapshot for this job.\nThe default value is `10`, which means snapshots ten days older than the newest snapshot are deleted.", @@ -98925,7 +113447,13 @@ "type": "number" }, "results_index_name": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "A text string that affects the name of the machine learning results index.\nThe default value is `shared`, which generates an index named `.ml-anomalies-shared`.", + "default": "shared", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "results_retention_days": { "description": "Advanced configuration option.\nThe period of time (in days) that results are retained.\nAge is calculated relative to the timestamp of the latest bucket result.\nIf this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch.\nThe default value is null, which means all results are retained.\nAnnotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results.\nAnnotations added by users are retained forever.", @@ -98957,13 +113485,29 @@ "type": "object", "properties": { "bucket_span": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The size of the interval that the analysis is aggregated into, typically between `5m` and `1h`.", + "default": "5m", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "categorization_analyzer": { - "$ref": "#/components/schemas/ml._types.CategorizationAnalyzer" + "description": "If `categorization_field_name` is specified, you can also define the analyzer that is used to interpret the categorization field.\nThis property cannot be used at the same time as `categorization_filters`.\nThe categorization analyzer specifies how the `categorization_field` is interpreted by the categorization process.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.CategorizationAnalyzer" + } + ] }, "categorization_field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "If this property is specified, the values of the specified field will be categorized.\nThe resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "categorization_filters": { "description": "If `categorization_field_name` is specified, you can also define optional filters.\nThis property expects an array of regular expressions.\nThe expressions are used to filter out matching sequences from the categorization field values.", @@ -98987,20 +113531,41 @@ } }, "model_prune_window": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Advanced configuration option.\nAffects the pruning of models that have not been updated for the given time duration.\nThe value must be set to a multiple of the `bucket_span`.\nIf set too low, important information may be removed from the model.\nTypically, set to `30d` or longer.\nIf not set, model pruning only occurs if the model memory status reaches the soft limit or the hard limit.\nFor jobs created in 8.1 and later, the default value is the greater of `30d` or 20 times `bucket_span`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "latency": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The size of the window in which to expect data that is out of time order.\nDefaults to no latency.\nIf you specify a non-zero value, it must be greater than or equal to one second.", + "default": "0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "multivariate_by_fields": { "description": "This functionality is reserved for internal use.\nIt is not supported for use in customer environments and is not subject to the support SLA of official GA features.\nIf set to `true`, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold.", "type": "boolean" }, "per_partition_categorization": { - "$ref": "#/components/schemas/ml._types.PerPartitionCategorization" + "description": "Settings related to how categorization interacts with partition fields.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.PerPartitionCategorization" + } + ] }, "summary_count_field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "If this property is specified, the data that is fed to the job is expected to be pre-summarized.\nThis property value is the name of the field that contains the count of raw data points that have been summarized.\nThe same `summary_count_field_name` applies to all detectors in the job.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -99013,7 +113578,12 @@ "type": "object", "properties": { "by_field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field used to split the data.\nIn particular, this property is used for analyzing the splits with respect to their own history.\nIt is used for finding unusual values in the context of the split.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "custom_rules": { "description": "An array of custom rule objects, which enable you to customize the way detectors operate.\nFor example, a rule may dictate to the detector conditions under which results should be skipped.\nKibana refers to custom rules as job rules.", @@ -99031,20 +113601,40 @@ "type": "number" }, "exclude_frequent": { - "$ref": "#/components/schemas/ml._types.ExcludeFrequent" + "description": "Contains one of the following values: `all`, `none`, `by`, or `over`.\nIf set, frequent entities are excluded from influencing the anomaly results.\nEntities can be considered frequent over time or frequent in a population.\nIf you are working with both over and by fields, then you can set `exclude_frequent` to all for both fields, or to `by` or `over` for those specific fields.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ExcludeFrequent" + } + ] }, "field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field that the detector uses in the function.\nIf you use an event rate function such as `count` or `rare`, do not specify this field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "function": { "description": "The analysis function that is used.\nFor example, `count`, `rare`, `mean`, `min`, `max`, and `sum`.", "type": "string" }, "over_field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field used to split the data.\nIn particular, this property is used for analyzing the splits with respect to the history of all splits.\nIt is used for finding unusual values in the population of all splits.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "partition_field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field used to segment the analysis.\nWhen you use this property, you have completely independent baselines for each value of this field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "use_null": { "description": "Defines whether a new series is used as the null series when there is no value for the by or partition fields.", @@ -99067,7 +113657,12 @@ } }, "trained_model": { - "$ref": "#/components/schemas/ml.put_trained_model.TrainedModel" + "description": "The definition of the trained model.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.TrainedModel" + } + ] } }, "required": [ @@ -99078,13 +113673,25 @@ "type": "object", "properties": { "frequency_encoding": { - "$ref": "#/components/schemas/ml.put_trained_model.FrequencyEncodingPreprocessor" + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.FrequencyEncodingPreprocessor" + } + ] }, "one_hot_encoding": { - "$ref": "#/components/schemas/ml.put_trained_model.OneHotEncodingPreprocessor" + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.OneHotEncodingPreprocessor" + } + ] }, "target_mean_encoding": { - "$ref": "#/components/schemas/ml.put_trained_model.TargetMeanEncodingPreprocessor" + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.TargetMeanEncodingPreprocessor" + } + ] } }, "minProperties": 1, @@ -99160,13 +113767,28 @@ "type": "object", "properties": { "tree": { - "$ref": "#/components/schemas/ml.put_trained_model.TrainedModelTree" + "description": "The definition for a binary decision tree.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.TrainedModelTree" + } + ] }, "tree_node": { - "$ref": "#/components/schemas/ml.put_trained_model.TrainedModelTreeNode" + "description": "The definition of a node in a tree.\nThere are two major types of nodes: leaf nodes and not-leaf nodes.\n- Leaf nodes only need node_index and leaf_value defined.\n- All other nodes need split_feature, left_child, right_child, threshold, decision_type, and default_left defined.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.TrainedModelTreeNode" + } + ] }, "ensemble": { - "$ref": "#/components/schemas/ml.put_trained_model.Ensemble" + "description": "The definition for an ensemble model", + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.Ensemble" + } + ] } } }, @@ -99239,7 +113861,11 @@ "type": "object", "properties": { "aggregate_output": { - "$ref": "#/components/schemas/ml.put_trained_model.AggregateOutput" + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.AggregateOutput" + } + ] }, "classification_labels": { "type": "array", @@ -99271,16 +113897,32 @@ "type": "object", "properties": { "logistic_regression": { - "$ref": "#/components/schemas/ml.put_trained_model.Weights" + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.Weights" + } + ] }, "weighted_sum": { - "$ref": "#/components/schemas/ml.put_trained_model.Weights" + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.Weights" + } + ] }, "weighted_mode": { - "$ref": "#/components/schemas/ml.put_trained_model.Weights" + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.Weights" + } + ] }, "exponent": { - "$ref": "#/components/schemas/ml.put_trained_model.Weights" + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.Weights" + } + ] } } }, @@ -99299,7 +113941,11 @@ "type": "object", "properties": { "field_names": { - "$ref": "#/components/schemas/_types.Names" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Names" + } + ] } }, "required": [ @@ -99321,7 +113967,12 @@ ] }, "assignment_state": { - "$ref": "#/components/schemas/ml._types.DeploymentAssignmentState" + "description": "The overall assignment state.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DeploymentAssignmentState" + } + ] }, "max_assigned_allocations": { "type": "number" @@ -99337,10 +113988,19 @@ } }, "start_time": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The timestamp when the deployment started.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "task_parameters": { - "$ref": "#/components/schemas/ml._types.TrainedModelAssignmentTaskParameters" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelAssignmentTaskParameters" + } + ] } }, "required": [ @@ -99358,7 +114018,12 @@ "type": "string" }, "routing_state": { - "$ref": "#/components/schemas/ml._types.RoutingState" + "description": "The current routing state.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.RoutingState" + } + ] }, "current_allocations": { "description": "Current number of allocations.", @@ -99379,29 +114044,62 @@ "type": "object", "properties": { "model_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The size of the trained model in bytes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "model_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The unique identifier for the trained model.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "deployment_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The unique identifier for the trained model deployment.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "cache_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The size of the trained model cache.", + "x-state": "Generally available; Added in 8.4.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "number_of_allocations": { "description": "The total number of allocations this model is assigned across ML nodes.", "type": "number" }, "priority": { - "$ref": "#/components/schemas/ml._types.TrainingPriority" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainingPriority" + } + ] }, "per_deployment_memory_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "per_allocation_memory_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "queue_capacity": { "description": "Number of inference requests are allowed in the queue at a time.", @@ -99496,7 +114194,12 @@ "type": "boolean" }, "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The ID of the search template to use. If no `source` is specified,\nthis parameter is required.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "params": { "description": "Key-value pairs used to replace Mustache variables in the template.\nThe key is the variable name.\nThe value is the variable value.", @@ -99511,7 +114214,12 @@ "type": "boolean" }, "source": { - "$ref": "#/components/schemas/_types.ScriptSource" + "description": "An inline search template. Supports the same parameters as the search API's\nrequest body. It also supports Mustache variables. If no `id` is specified, this\nparameter is required.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptSource" + } + ] } } }, @@ -99519,17 +114227,32 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The ID of the document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The index of the document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "doc": { "description": "An artificial document (a document not present in the index) for which you want to retrieve term vectors.", "type": "object" }, "fields": { - "$ref": "#/components/schemas/_types.Fields" + "description": "Comma-separated list or wildcard expressions of fields to include in the statistics.\nUsed as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "field_statistics": { "description": "If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies.", @@ -99537,7 +114260,12 @@ "type": "boolean" }, "filter": { - "$ref": "#/components/schemas/_global.termvectors.Filter" + "description": "Filter terms based on their tf-idf scores.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.termvectors.Filter" + } + ] }, "offsets": { "description": "If `true`, the response includes term offsets.", @@ -99555,7 +114283,12 @@ "type": "boolean" }, "routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "Custom value used to route operations to a specific shard.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "term_statistics": { "description": "If true, the response includes term frequency and document frequency.", @@ -99563,10 +114296,20 @@ "type": "boolean" }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "If `true`, returns the document version as part of a hit.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "version_type": { - "$ref": "#/components/schemas/_types.VersionType" + "description": "Specific version type.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionType" + } + ] } } }, @@ -99612,13 +114355,25 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "_version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "took": { "type": "number" @@ -99633,7 +114388,11 @@ } }, "error": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] } }, "required": [ @@ -99644,7 +114403,11 @@ "type": "object", "properties": { "field_statistics": { - "$ref": "#/components/schemas/_global.termvectors.FieldStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_global.termvectors.FieldStatistics" + } + ] }, "terms": { "type": "object", @@ -99731,7 +114494,15 @@ "type": "object", "properties": { "cluster_name": { - "$ref": "#/components/schemas/_types.Name" + "externalDocs": { + "url": "https://www.elastic.co/docs/deploy-manage/deploy/self-managed/important-settings-configuration##_cluster_name_setting" + }, + "description": "Name of the cluster. Based on the `cluster.name` setting.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "nodes": { "description": "Contains repositories metering information for the nodes selected by the request.", @@ -99752,33 +114523,68 @@ "type": "object", "properties": { "repository_name": { - "$ref": "#/components/schemas/_types.Name" + "description": "Repository name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "repository_type": { "description": "Repository type.", "type": "string" }, "repository_location": { - "$ref": "#/components/schemas/nodes._types.RepositoryLocation" + "description": "Represents an unique location within the repository.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.RepositoryLocation" + } + ] }, "repository_ephemeral_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "An identifier that changes every time the repository is updated.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "repository_started_at": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "Time the repository was created or updated. Recorded in milliseconds since the Unix Epoch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "repository_stopped_at": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "Time the repository was deleted or updated. Recorded in milliseconds since the Unix Epoch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "archived": { "description": "A flag that tells whether or not this object has been archived. When a repository is closed or updated the\nrepository metering information is archived and kept for a certain period of time. This allows retrieving the\nrepository metering information of previous repository instantiations.", "type": "boolean" }, "cluster_version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "The cluster state version when this object was archived, this field can be used as a logical timestamp to delete\nall the archived metrics up to an observed version. This field is only present for archived repository metering\ninformation objects. The main purpose of this field is to avoid possible race conditions during repository metering\ninformation deletions, i.e. deleting archived repositories metering information that we haven’t observed yet.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "request_counts": { - "$ref": "#/components/schemas/nodes._types.RequestCounts" + "description": "An object with the number of request performed against the repository grouped by request type.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.RequestCounts" + } + ] } }, "required": [ @@ -99868,7 +114674,12 @@ "type": "object", "properties": { "cluster_name": { - "$ref": "#/components/schemas/_types.Name" + "description": "Name of the cluster. Based on the `cluster.name` setting.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "nodes": { "description": "Contains repositories metering information for the nodes selected by the request.", @@ -99904,7 +114715,11 @@ "type": "object", "properties": { "cluster_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "nodes": { "type": "object", @@ -99946,25 +114761,56 @@ } }, "host": { - "$ref": "#/components/schemas/_types.Host" + "description": "The node’s host name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Host" + } + ] }, "http": { - "$ref": "#/components/schemas/nodes.info.NodeInfoHttp" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoHttp" + } + ] }, "index_version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "ip": { - "$ref": "#/components/schemas/_types.Ip" + "description": "The node’s IP address.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Ip" + } + ] }, "jvm": { - "$ref": "#/components/schemas/nodes.info.NodeJvmInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeJvmInfo" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The node's name", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "os": { - "$ref": "#/components/schemas/nodes.info.NodeOperatingSystemInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeOperatingSystemInfo" + } + ] }, "plugins": { "type": "array", @@ -99973,13 +114819,25 @@ } }, "process": { - "$ref": "#/components/schemas/nodes.info.NodeProcessInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeProcessInfo" + } + ] }, "roles": { - "$ref": "#/components/schemas/_types.NodeRoles" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeRoles" + } + ] }, "settings": { - "$ref": "#/components/schemas/nodes.info.NodeInfoSettings" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoSettings" + } + ] }, "thread_pool": { "type": "object", @@ -99992,19 +114850,42 @@ "type": "number" }, "total_indexing_buffer_in_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Same as total_indexing_buffer, but expressed in bytes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "transport": { - "$ref": "#/components/schemas/nodes.info.NodeInfoTransport" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoTransport" + } + ] }, "transport_address": { - "$ref": "#/components/schemas/_types.TransportAddress" + "description": "Host and port where transport HTTP connections are accepted.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TransportAddress" + } + ] }, "transport_version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "Elasticsearch version running on this node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "modules": { "type": "array", @@ -100013,7 +114894,11 @@ } }, "ingest": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngest" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngest" + } + ] }, "aggregations": { "type": "object", @@ -100022,7 +114907,11 @@ } }, "remote_cluster_server": { - "$ref": "#/components/schemas/nodes.info.RemoveClusterServer" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.RemoveClusterServer" + } + ] } }, "required": [ @@ -100051,7 +114940,11 @@ } }, "max_content_length": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "max_content_length_in_bytes": { "type": "number" @@ -100076,7 +114969,11 @@ } }, "mem": { - "$ref": "#/components/schemas/nodes.info.NodeInfoJvmMemory" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoJvmMemory" + } + ] }, "memory_pools": { "type": "array", @@ -100088,19 +114985,35 @@ "type": "number" }, "start_time_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "vm_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "vm_vendor": { "type": "string" }, "vm_version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "using_bundled_jdk": { "type": "boolean" @@ -100140,31 +115053,51 @@ "type": "object", "properties": { "direct_max": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "direct_max_in_bytes": { "type": "number" }, "heap_init": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "heap_init_in_bytes": { "type": "number" }, "heap_max": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "heap_max_in_bytes": { "type": "number" }, "non_heap_init": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "non_heap_init_in_bytes": { "type": "number" }, "non_heap_max": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "non_heap_max_in_bytes": { "type": "number" @@ -100194,25 +115127,56 @@ "type": "number" }, "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "Name of the operating system (ex: Linux, Windows, Mac OS X)", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "pretty_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "refresh_interval_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "Refresh interval for the OS statistics", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "Version of the operating system", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "cpu": { - "$ref": "#/components/schemas/nodes.info.NodeInfoOSCPU" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoOSCPU" + } + ] }, "mem": { - "$ref": "#/components/schemas/nodes.info.NodeInfoMemory" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoMemory" + } + ] }, "swap": { - "$ref": "#/components/schemas/nodes.info.NodeInfoMemory" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoMemory" + } + ] } }, "required": [ @@ -100290,7 +115254,12 @@ "type": "boolean" }, "refresh_interval_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "Refresh interval for the process statistics", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } }, "required": [ @@ -100303,49 +115272,109 @@ "type": "object", "properties": { "cluster": { - "$ref": "#/components/schemas/nodes.info.NodeInfoSettingsCluster" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoSettingsCluster" + } + ] }, "node": { - "$ref": "#/components/schemas/nodes.info.NodeInfoSettingsNode" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoSettingsNode" + } + ] }, "path": { - "$ref": "#/components/schemas/nodes.info.NodeInfoPath" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoPath" + } + ] }, "repositories": { - "$ref": "#/components/schemas/nodes.info.NodeInfoRepositories" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoRepositories" + } + ] }, "discovery": { - "$ref": "#/components/schemas/nodes.info.NodeInfoDiscover" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoDiscover" + } + ] }, "action": { - "$ref": "#/components/schemas/nodes.info.NodeInfoAction" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoAction" + } + ] }, "client": { - "$ref": "#/components/schemas/nodes.info.NodeInfoClient" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoClient" + } + ] }, "http": { - "$ref": "#/components/schemas/nodes.info.NodeInfoSettingsHttp" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoSettingsHttp" + } + ] }, "bootstrap": { - "$ref": "#/components/schemas/nodes.info.NodeInfoBootstrap" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoBootstrap" + } + ] }, "transport": { - "$ref": "#/components/schemas/nodes.info.NodeInfoSettingsTransport" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoSettingsTransport" + } + ] }, "network": { - "$ref": "#/components/schemas/nodes.info.NodeInfoSettingsNetwork" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoSettingsNetwork" + } + ] }, "xpack": { - "$ref": "#/components/schemas/nodes.info.NodeInfoXpack" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoXpack" + } + ] }, "script": { - "$ref": "#/components/schemas/nodes.info.NodeInfoScript" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoScript" + } + ] }, "search": { - "$ref": "#/components/schemas/nodes.info.NodeInfoSearch" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoSearch" + } + ] }, "ingest": { - "$ref": "#/components/schemas/nodes.info.NodeInfoSettingsIngest" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoSettingsIngest" + } + ] } }, "required": [ @@ -100359,13 +115388,25 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "routing": { - "$ref": "#/components/schemas/indices._types.IndexRouting" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexRouting" + } + ] }, "election": { - "$ref": "#/components/schemas/nodes.info.NodeInfoSettingsClusterElection" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoSettingsClusterElection" + } + ] }, "initial_master_nodes": { "oneOf": [ @@ -100381,7 +115422,12 @@ ] }, "deprecation_indexing": { - "$ref": "#/components/schemas/nodes.info.DeprecationIndexing" + "x-state": "Generally available; Added in 7.16.0", + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.DeprecationIndexing" + } + ] } }, "required": [ @@ -100393,7 +115439,11 @@ "type": "object", "properties": { "strategy": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] } }, "required": [ @@ -100422,7 +115472,11 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "attr": { "type": "object", @@ -100473,7 +115527,11 @@ "type": "object", "properties": { "url": { - "$ref": "#/components/schemas/nodes.info.NodeInfoRepositoriesUrl" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoRepositoriesUrl" + } + ] } }, "required": [ @@ -100544,7 +115602,11 @@ "type": "object", "properties": { "type": { - "$ref": "#/components/schemas/nodes.info.NodeInfoSettingsHttpType" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoSettingsHttpType" + } + ] }, "type.default": { "type": "string" @@ -100600,13 +115662,21 @@ "type": "object", "properties": { "type": { - "$ref": "#/components/schemas/nodes.info.NodeInfoSettingsTransportType" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoSettingsTransportType" + } + ] }, "type.default": { "type": "string" }, "features": { - "$ref": "#/components/schemas/nodes.info.NodeInfoSettingsTransportFeatures" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoSettingsTransportFeatures" + } + ] } }, "required": [ @@ -100657,10 +115727,18 @@ "type": "object", "properties": { "license": { - "$ref": "#/components/schemas/nodes.info.NodeInfoXpackLicense" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoXpackLicense" + } + ] }, "security": { - "$ref": "#/components/schemas/nodes.info.NodeInfoXpackSecurity" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoXpackSecurity" + } + ] }, "notification": { "type": "object", @@ -100669,7 +115747,11 @@ } }, "ml": { - "$ref": "#/components/schemas/nodes.info.NodeInfoXpackMl" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoXpackMl" + } + ] } }, "required": [ @@ -100680,7 +115762,11 @@ "type": "object", "properties": { "self_generated": { - "$ref": "#/components/schemas/nodes.info.NodeInfoXpackLicenseType" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoXpackLicenseType" + } + ] } }, "required": [ @@ -100702,16 +115788,28 @@ "type": "object", "properties": { "http": { - "$ref": "#/components/schemas/nodes.info.NodeInfoXpackSecuritySsl" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoXpackSecuritySsl" + } + ] }, "enabled": { "type": "string" }, "transport": { - "$ref": "#/components/schemas/nodes.info.NodeInfoXpackSecuritySsl" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoXpackSecuritySsl" + } + ] }, "authc": { - "$ref": "#/components/schemas/nodes.info.NodeInfoXpackSecurityAuthc" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoXpackSecurityAuthc" + } + ] } }, "required": [ @@ -100736,10 +115834,18 @@ "type": "object", "properties": { "realms": { - "$ref": "#/components/schemas/nodes.info.NodeInfoXpackSecurityAuthcRealms" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoXpackSecurityAuthcRealms" + } + ] }, "token": { - "$ref": "#/components/schemas/nodes.info.NodeInfoXpackSecurityAuthcToken" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoXpackSecurityAuthcToken" + } + ] } } }, @@ -100817,7 +115923,11 @@ "type": "object", "properties": { "remote": { - "$ref": "#/components/schemas/nodes.info.NodeInfoSearchRemote" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoSearchRemote" + } + ] } }, "required": [ @@ -100839,106 +115949,242 @@ "type": "object", "properties": { "attachment": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "append": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "csv": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "convert": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "date": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "date_index_name": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "dot_expander": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "enrich": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "fail": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "foreach": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "json": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "user_agent": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "kv": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "geoip": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "grok": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "gsub": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "join": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "lowercase": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "remove": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "rename": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "script": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "set": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "sort": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "split": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "trim": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "uppercase": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "urldecode": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "bytes": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "dissect": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "set_security_user": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "pipeline": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "drop": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "circle": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] }, "inference": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestInfo" + } + ] } } }, @@ -100946,7 +116192,11 @@ "type": "object", "properties": { "downloader": { - "$ref": "#/components/schemas/nodes.info.NodeInfoIngestDownloader" + "allOf": [ + { + "$ref": "#/components/schemas/nodes.info.NodeInfoIngestDownloader" + } + ] } }, "required": [ @@ -100971,7 +116221,11 @@ "type": "number" }, "keep_alive": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "max": { "type": "number" @@ -101065,7 +116319,11 @@ } }, "publish_address": { - "$ref": "#/components/schemas/_types.TransportAddress" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TransportAddress" + } + ] } }, "required": [ @@ -101085,7 +116343,11 @@ "type": "object", "properties": { "cluster_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "nodes": { "type": "object", @@ -101105,10 +116367,18 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "reload_exception": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] } }, "required": [ @@ -101124,7 +116394,11 @@ "type": "object", "properties": { "cluster_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "nodes": { "type": "object", @@ -101157,16 +116431,36 @@ } }, "fs": { - "$ref": "#/components/schemas/nodes._types.FileSystem" + "description": "File system information, data path, free disk space, read/write stats.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.FileSystem" + } + ] }, "host": { - "$ref": "#/components/schemas/_types.Host" + "description": "Network host for the node, based on the network host setting.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Host" + } + ] }, "http": { - "$ref": "#/components/schemas/nodes._types.Http" + "description": "HTTP connection information.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.Http" + } + ] }, "ingest": { - "$ref": "#/components/schemas/nodes._types.Ingest" + "description": "Statistics about ingest preprocessing.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.Ingest" + } + ] }, "ip": { "description": "IP address and port for the node.", @@ -101183,22 +116477,52 @@ ] }, "jvm": { - "$ref": "#/components/schemas/nodes._types.Jvm" + "description": "JVM stats, memory pool information, garbage collection, buffer pools, number of loaded/unloaded classes.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.Jvm" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "Human-readable identifier for the node.\nBased on the node name setting.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "os": { - "$ref": "#/components/schemas/nodes._types.OperatingSystem" + "description": "Operating system stats, load average, mem, swap.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.OperatingSystem" + } + ] }, "process": { - "$ref": "#/components/schemas/nodes._types.Process" + "description": "Process statistics, memory consumption, cpu usage, open file descriptors.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.Process" + } + ] }, "roles": { - "$ref": "#/components/schemas/_types.NodeRoles" + "description": "Roles assigned to the node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeRoles" + } + ] }, "script": { - "$ref": "#/components/schemas/nodes._types.Scripting" + "description": "Contains script statistics for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.Scripting" + } + ] }, "script_cache": { "type": "object", @@ -101227,10 +116551,20 @@ "type": "number" }, "transport": { - "$ref": "#/components/schemas/nodes._types.Transport" + "description": "Transport statistics about sent and received bytes in cluster communication.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.Transport" + } + ] }, "transport_address": { - "$ref": "#/components/schemas/_types.TransportAddress" + "description": "Host and port for the transport layer, used for internal communication between nodes in a cluster.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TransportAddress" + } + ] }, "attributes": { "description": "Contains a list of attributes for the node.", @@ -101240,13 +116574,28 @@ } }, "discovery": { - "$ref": "#/components/schemas/nodes._types.Discovery" + "description": "Contains node discovery statistics for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.Discovery" + } + ] }, "indexing_pressure": { - "$ref": "#/components/schemas/nodes._types.IndexingPressure" + "description": "Contains indexing pressure statistics for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.IndexingPressure" + } + ] }, "indices": { - "$ref": "#/components/schemas/indices.stats.ShardStats" + "description": "Indices stats about size, document count, indexing and deletion times, search times, field cache size, merges and flushes.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.stats.ShardStats" + } + ] } } }, @@ -101258,14 +116607,24 @@ "type": "number" }, "avg_response_time": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The exponentially weighted moving average response time of search requests on the keyed node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "avg_response_time_ns": { "description": "The exponentially weighted moving average response time, in nanoseconds, of search requests on the keyed node.", "type": "number" }, "avg_service_time": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The exponentially weighted moving average service time of search requests on the keyed node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "avg_service_time_ns": { "description": "The exponentially weighted moving average service time, in nanoseconds, of search requests on the keyed node.", @@ -101325,10 +116684,20 @@ "type": "number" }, "total": { - "$ref": "#/components/schemas/nodes._types.FileSystemTotal" + "description": "Contains statistics for all file stores of the node.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.FileSystemTotal" + } + ] }, "io_stats": { - "$ref": "#/components/schemas/nodes._types.IoStats" + "description": "Contains I/O statistics for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.IoStats" + } + ] } } }, @@ -101434,7 +116803,12 @@ } }, "total": { - "$ref": "#/components/schemas/nodes._types.IoStatDevice" + "description": "The sum of the disk metrics for all devices that back an Elasticsearch data path.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.IoStatDevice" + } + ] } } }, @@ -101478,16 +116852,36 @@ } }, "classes": { - "$ref": "#/components/schemas/nodes._types.JvmClasses" + "description": "Contains statistics about classes loaded by JVM for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.JvmClasses" + } + ] }, "gc": { - "$ref": "#/components/schemas/nodes._types.GarbageCollector" + "description": "Contains statistics about JVM garbage collectors for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.GarbageCollector" + } + ] }, "mem": { - "$ref": "#/components/schemas/nodes._types.JvmMemoryStats" + "description": "Contains JVM memory usage statistics for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.JvmMemoryStats" + } + ] }, "threads": { - "$ref": "#/components/schemas/nodes._types.JvmThreads" + "description": "Contains statistics about JVM thread usage for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.JvmThreads" + } + ] }, "timestamp": { "description": "Last time JVM statistics were refreshed.", @@ -101594,7 +116988,12 @@ "type": "number" }, "heap_max": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Maximum amount of memory, available for use by the heap.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "non_heap_used_in_bytes": { "description": "Non-heap memory used, in bytes.", @@ -101651,16 +117050,32 @@ "type": "object", "properties": { "cpu": { - "$ref": "#/components/schemas/nodes._types.Cpu" + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.Cpu" + } + ] }, "mem": { - "$ref": "#/components/schemas/nodes._types.ExtendedMemoryStats" + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.ExtendedMemoryStats" + } + ] }, "swap": { - "$ref": "#/components/schemas/nodes._types.MemoryStats" + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.MemoryStats" + } + ] }, "cgroup": { - "$ref": "#/components/schemas/nodes._types.Cgroup" + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.Cgroup" + } + ] }, "timestamp": { "type": "number" @@ -101674,22 +117089,46 @@ "type": "number" }, "sys": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "sys_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "total": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "total_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "user": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "user_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "load_average": { "type": "object", @@ -101762,13 +117201,28 @@ "type": "object", "properties": { "cpuacct": { - "$ref": "#/components/schemas/nodes._types.CpuAcct" + "description": "Contains statistics about `cpuacct` control group for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.CpuAcct" + } + ] }, "cpu": { - "$ref": "#/components/schemas/nodes._types.CgroupCpu" + "description": "Contains statistics about `cpu` control group for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.CgroupCpu" + } + ] }, "memory": { - "$ref": "#/components/schemas/nodes._types.CgroupMemory" + "description": "Contains statistics about the memory control group for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.CgroupMemory" + } + ] } } }, @@ -101780,7 +117234,12 @@ "type": "string" }, "usage_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "description": "The total CPU time, in nanoseconds, consumed by all tasks in the same cgroup as the Elasticsearch process.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] } } }, @@ -101800,7 +117259,12 @@ "type": "number" }, "stat": { - "$ref": "#/components/schemas/nodes._types.CgroupCpuStat" + "description": "Contains CPU statistics for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.CgroupCpuStat" + } + ] } } }, @@ -101816,7 +117280,12 @@ "type": "number" }, "time_throttled_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "description": "The total amount of time, in nanoseconds, for which all tasks in the same cgroup as the Elasticsearch process have been throttled.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] } } }, @@ -101841,10 +117310,20 @@ "type": "object", "properties": { "cpu": { - "$ref": "#/components/schemas/nodes._types.Cpu" + "description": "Contains CPU statistics for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.Cpu" + } + ] }, "mem": { - "$ref": "#/components/schemas/nodes._types.MemoryStats" + "description": "Contains virtual memory statistics for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.MemoryStats" + } + ] }, "open_file_descriptors": { "description": "Number of opened file descriptors associated with the current or `-1` if not supported.", @@ -101952,10 +117431,20 @@ "type": "object", "properties": { "cluster_state_queue": { - "$ref": "#/components/schemas/nodes._types.ClusterStateQueue" + "description": "Contains statistics for the cluster state queue of the node.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.ClusterStateQueue" + } + ] }, "published_cluster_states": { - "$ref": "#/components/schemas/nodes._types.PublishedClusterStates" + "description": "Contains statistics for the published cluster states of the node.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.PublishedClusterStates" + } + ] }, "cluster_state_update": { "description": "Contains low-level statistics about how long various activities took during cluster state updates while the node was the elected master.\nOmitted if the node is not master-eligible.\nEvery field whose name ends in `_time` within this object is also represented as a raw number of milliseconds in a field whose name ends in `_time_millis`.\nThe human-readable fields with a `_time` suffix are only returned if requested with the `?human=true` query parameter.", @@ -101965,10 +117454,18 @@ } }, "serialized_cluster_states": { - "$ref": "#/components/schemas/nodes._types.SerializedClusterState" + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.SerializedClusterState" + } + ] }, "cluster_applier_stats": { - "$ref": "#/components/schemas/nodes._types.ClusterAppliedStats" + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.ClusterAppliedStats" + } + ] } } }, @@ -102014,46 +117511,116 @@ "type": "number" }, "computation_time": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The cumulative amount of time spent computing no-op cluster state updates since the node started.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "computation_time_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The cumulative amount of time, in milliseconds, spent computing no-op cluster state updates since the node started.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "publication_time": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The cumulative amount of time spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (just after the computation of the new cluster state) until the publication has finished and the master node is ready to start processing the next state update.\nThis includes the time measured by `context_construction_time`, `commit_time`, `completion_time` and `master_apply_time`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "publication_time_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The cumulative amount of time, in milliseconds, spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (just after the computation of the new cluster state) until the publication has finished and the master node is ready to start processing the next state update.\nThis includes the time measured by `context_construction_time`, `commit_time`, `completion_time` and `master_apply_time`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "context_construction_time": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The cumulative amount of time spent constructing a publication context since the node started for publications that ultimately succeeded.\nThis statistic includes the time spent computing the difference between the current and new cluster state preparing a serialized representation of this difference.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "context_construction_time_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The cumulative amount of time, in milliseconds, spent constructing a publication context since the node started for publications that ultimately succeeded.\nThis statistic includes the time spent computing the difference between the current and new cluster state preparing a serialized representation of this difference.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "commit_time": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The cumulative amount of time spent waiting for a successful cluster state update to commit, which measures the time from the start of each publication until a majority of the master-eligible nodes have written the state to disk and confirmed the write to the elected master.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "commit_time_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The cumulative amount of time, in milliseconds, spent waiting for a successful cluster state update to commit, which measures the time from the start of each publication until a majority of the master-eligible nodes have written the state to disk and confirmed the write to the elected master.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "completion_time": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The cumulative amount of time spent waiting for a successful cluster state update to complete, which measures the time from the start of each publication until all the other nodes have notified the elected master that they have applied the cluster state.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "completion_time_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The cumulative amount of time, in milliseconds, spent waiting for a successful cluster state update to complete, which measures the time from the start of each publication until all the other nodes have notified the elected master that they have applied the cluster state.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "master_apply_time": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The cumulative amount of time spent successfully applying cluster state updates on the elected master since the node started.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "master_apply_time_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The cumulative amount of time, in milliseconds, spent successfully applying cluster state updates on the elected master since the node started.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "notification_time": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The cumulative amount of time spent notifying listeners of a no-op cluster state update since the node started.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "notification_time_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The cumulative amount of time, in milliseconds, spent notifying listeners of a no-op cluster state update since the node started.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } }, "required": [ @@ -102064,10 +117631,19 @@ "type": "object", "properties": { "full_states": { - "$ref": "#/components/schemas/nodes._types.SerializedClusterStateDetail" + "description": "Number of published cluster states.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.SerializedClusterStateDetail" + } + ] }, "diffs": { - "$ref": "#/components/schemas/nodes._types.SerializedClusterStateDetail" + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.SerializedClusterStateDetail" + } + ] } } }, @@ -102112,10 +117688,18 @@ "type": "number" }, "cumulative_execution_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "cumulative_execution_time_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } } }, @@ -102123,7 +117707,12 @@ "type": "object", "properties": { "memory": { - "$ref": "#/components/schemas/nodes._types.IndexingPressureMemory" + "description": "Contains statistics for memory consumption from indexing load.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.IndexingPressureMemory" + } + ] } } }, @@ -102136,7 +117725,11 @@ "type": "object", "properties": { "cluster_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "nodes": { "type": "object", @@ -102162,10 +117755,18 @@ } }, "since": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "timestamp": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "aggregations": { "type": "object", @@ -102185,10 +117786,20 @@ "type": "object", "properties": { "rule_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "A unique identifier for the rule.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "type": { - "$ref": "#/components/schemas/query_rules._types.QueryRuleType" + "description": "The type of rule.\n`pinned` will identify and pin specific documents to the top of search results.\n`exclude` will exclude specific documents from search results.", + "allOf": [ + { + "$ref": "#/components/schemas/query_rules._types.QueryRuleType" + } + ] }, "criteria": { "description": "The criteria that must be met for the rule to be applied.\nIf multiple criteria are specified for a rule, all criteria must be met for the rule to be applied.", @@ -102205,7 +117816,12 @@ ] }, "actions": { - "$ref": "#/components/schemas/query_rules._types.QueryRuleActions" + "description": "The actions to take when the rule is matched.\nThe format of this action depends on the rule type.", + "allOf": [ + { + "$ref": "#/components/schemas/query_rules._types.QueryRuleActions" + } + ] }, "priority": { "type": "number" @@ -102229,7 +117845,12 @@ "type": "object", "properties": { "type": { - "$ref": "#/components/schemas/query_rules._types.QueryRuleCriteriaType" + "description": "The type of criteria. The following criteria types are supported:\n\n* `always`: Matches all queries, regardless of input.\n* `contains`: Matches that contain this value anywhere in the field meet the criteria defined by the rule. Only applicable for string values.\n* `exact`: Only exact matches meet the criteria defined by the rule. Applicable for string or numerical values.\n* `fuzzy`: Exact matches or matches within the allowed Levenshtein Edit Distance meet the criteria defined by the rule. Only applicable for string values.\n* `gt`: Matches with a value greater than this value meet the criteria defined by the rule. Only applicable for numerical values.\n* `gte`: Matches with a value greater than or equal to this value meet the criteria defined by the rule. Only applicable for numerical values.\n* `lt`: Matches with a value less than this value meet the criteria defined by the rule. Only applicable for numerical values.\n* `lte`: Matches with a value less than or equal to this value meet the criteria defined by the rule. Only applicable for numerical values.\n* `prefix`: Matches that start with this value meet the criteria defined by the rule. Only applicable for string values.\n* `suffix`: Matches that end with this value meet the criteria defined by the rule. Only applicable for string values.", + "allOf": [ + { + "$ref": "#/components/schemas/query_rules._types.QueryRuleCriteriaType" + } + ] }, "metadata": { "description": "The metadata field to match against.\nThis metadata will be used to match against `match_criteria` sent in the rule.\nIt is required for all criteria types except `always`.", @@ -102287,7 +117908,12 @@ "type": "object", "properties": { "ruleset_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "A unique identifier for the ruleset.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "rules": { "description": "Rules associated with the query ruleset.", @@ -102306,7 +117932,12 @@ "type": "object", "properties": { "ruleset_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "A unique identifier for the ruleset.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "rule_total_count": { "description": "The number of rules associated with the ruleset.", @@ -102338,10 +117969,20 @@ "type": "object", "properties": { "ruleset_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Ruleset unique identifier", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "rule_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Rule unique identifier within that ruleset", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] } }, "required": [ @@ -102353,10 +117994,20 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The search request’s ID, used to group result details later.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "request": { - "$ref": "#/components/schemas/_global.rank_eval.RankEvalQuery" + "description": "The query being evaluated.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.rank_eval.RankEvalQuery" + } + ] }, "ratings": { "description": "List of document ratings", @@ -102366,7 +118017,12 @@ } }, "template_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The search template Id", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "params": { "description": "The search template parameters.", @@ -102385,7 +118041,11 @@ "type": "object", "properties": { "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "size": { "type": "number" @@ -102399,10 +118059,20 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The document ID.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The document’s index. For data streams, this should be the document’s backing index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "rating": { "description": "The document’s relevance with regard to this search request.", @@ -102419,19 +118089,39 @@ "type": "object", "properties": { "precision": { - "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricPrecision" + "allOf": [ + { + "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricPrecision" + } + ] }, "recall": { - "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricRecall" + "allOf": [ + { + "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricRecall" + } + ] }, "mean_reciprocal_rank": { - "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricMeanReciprocalRank" + "allOf": [ + { + "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricMeanReciprocalRank" + } + ] }, "dcg": { - "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricDiscountedCumulativeGain" + "allOf": [ + { + "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricDiscountedCumulativeGain" + } + ] }, "expected_reciprocal_rank": { - "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricExpectedReciprocalRank" + "allOf": [ + { + "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricExpectedReciprocalRank" + } + ] } } }, @@ -102583,10 +118273,18 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] } }, "required": [ @@ -102598,7 +118296,11 @@ "type": "object", "properties": { "hit": { - "$ref": "#/components/schemas/_global.rank_eval.RankEvalHit" + "allOf": [ + { + "$ref": "#/components/schemas/_global.rank_eval.RankEvalHit" + } + ] }, "rating": { "oneOf": [ @@ -102620,10 +118322,18 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "_score": { "type": "number" @@ -102639,20 +118349,42 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The name of the data stream, index, or index alias you are copying to.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "op_type": { - "$ref": "#/components/schemas/_types.OpType" + "description": "If it is `create`, the operation will only index documents that do not already exist (also known as \"put if absent\").\n\nIMPORTANT: To reindex to a data stream destination, this argument must be `create`.", + "default": "index", + "allOf": [ + { + "$ref": "#/components/schemas/_types.OpType" + } + ] }, "pipeline": { "description": "The name of the pipeline to use.", "type": "string" }, "routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "By default, a document's routing is preserved unless it's changed by the script.\nIf it is `keep`, the routing on the bulk request sent for each match is set to the routing on the match.\nIf it is `discard`, the routing on the bulk request sent for each match is set to `null`.\nIf it is `=value`, the routing on the bulk request sent for each match is set to all value specified after the equals sign (`=`).", + "default": "keep", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "version_type": { - "$ref": "#/components/schemas/_types.VersionType" + "description": "The versioning to use for the indexing operation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionType" + } + ] } }, "required": [ @@ -102663,13 +118395,28 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.Indices" + "description": "The name of the data stream, index, or alias you are copying from.\nIt accepts a comma-separated list to reindex from multiple sources.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "The documents to reindex, which is defined with Query DSL.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "remote": { - "$ref": "#/components/schemas/_global.reindex.RemoteSource" + "description": "A remote instance of Elasticsearch that you want to index from.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.reindex.RemoteSource" + } + ] }, "size": { "description": "The number of documents to index per batch.\nUse it when you are indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB.", @@ -102677,16 +118424,37 @@ "type": "number" }, "slice": { - "$ref": "#/components/schemas/_types.SlicedScroll" + "description": "Slice the reindex request manually using the provided slice ID and total number of slices.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SlicedScroll" + } + ] }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "deprecated": true, + "description": "A comma-separated list of `:` pairs to sort by before indexing.\nUse it in conjunction with `max_docs` to control what documents are reindexed.\n\nWARNING: Sort in reindex is deprecated.\nSorting in reindex was never guaranteed to index documents in order and prevents further development of reindex such as resilience and performance improvements.\nIf used in combination with `max_docs`, consider using a query filter instead.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] }, "_source": { - "$ref": "#/components/schemas/_types.Fields" + "description": "If `true`, reindex all source fields.\nSet it to a list to reindex select fields.", + "default": "true", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] } }, "required": [ @@ -102697,7 +118465,13 @@ "type": "object", "properties": { "connect_timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The remote connection timeout.", + "default": "30s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "headers": { "description": "An object containing the headers of the request.", @@ -102707,16 +118481,37 @@ } }, "host": { - "$ref": "#/components/schemas/_types.Host" + "description": "The URL for the remote instance of Elasticsearch that you want to index from.\nThis information is required when you're indexing from remote.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Host" + } + ] }, "username": { - "$ref": "#/components/schemas/_types.Username" + "description": "The username to use for authentication with the remote host.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Username" + } + ] }, "password": { - "$ref": "#/components/schemas/_types.Password" + "description": "The password to use for authentication with the remote host.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Password" + } + ] }, "socket_timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The remote socket read timeout.", + "default": "30s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } }, "required": [ @@ -102763,22 +118558,42 @@ "type": "number" }, "node": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "running_time_in_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "start_time_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "status": { - "$ref": "#/components/schemas/_global.reindex_rethrottle.ReindexStatus" + "allOf": [ + { + "$ref": "#/components/schemas/_global.reindex_rethrottle.ReindexStatus" + } + ] }, "type": { "type": "string" }, "headers": { - "$ref": "#/components/schemas/_types.HttpHeaders" + "allOf": [ + { + "$ref": "#/components/schemas/_types.HttpHeaders" + } + ] } }, "required": [ @@ -102818,19 +118633,42 @@ "type": "number" }, "retries": { - "$ref": "#/components/schemas/_types.Retries" + "description": "The number of retries attempted by reindex. `bulk` is the number of bulk actions retried and `search` is the number of search actions retried.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Retries" + } + ] }, "throttled": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "throttled_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "Number of milliseconds the request slept to conform to `requests_per_second`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "throttled_until": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "throttled_until_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "This field should always be equal to zero in a `_reindex` response.\nIt only has meaning when using the Task API, where it indicates the next time (in milliseconds since epoch) a throttled request will be executed again in order to conform to `requests_per_second`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "total": { "description": "The number of documents that were successfully processed.", @@ -102869,19 +118707,39 @@ } }, "host": { - "$ref": "#/components/schemas/_types.Host" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Host" + } + ] }, "ip": { - "$ref": "#/components/schemas/_types.Ip" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Ip" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "roles": { - "$ref": "#/components/schemas/_types.NodeRoles" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeRoles" + } + ] }, "transport_address": { - "$ref": "#/components/schemas/_types.TransportAddress" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TransportAddress" + } + ] } }, "required": [ @@ -102896,13 +118754,28 @@ "type": "object", "properties": { "config": { - "$ref": "#/components/schemas/rollup.get_jobs.RollupJobConfiguration" + "description": "The rollup job configuration.", + "allOf": [ + { + "$ref": "#/components/schemas/rollup.get_jobs.RollupJobConfiguration" + } + ] }, "stats": { - "$ref": "#/components/schemas/rollup.get_jobs.RollupJobStats" + "description": "Transient statistics about the rollup job, such as how many documents have been processed and how many rollup summary docs have been indexed.\nThese stats are not persisted.\nIf a node is restarted, these stats are reset.", + "allOf": [ + { + "$ref": "#/components/schemas/rollup.get_jobs.RollupJobStats" + } + ] }, "status": { - "$ref": "#/components/schemas/rollup.get_jobs.RollupJobStatus" + "description": "The current status of the indexer for the rollup job.", + "allOf": [ + { + "$ref": "#/components/schemas/rollup.get_jobs.RollupJobStatus" + } + ] } }, "required": [ @@ -102918,10 +118791,18 @@ "type": "string" }, "groups": { - "$ref": "#/components/schemas/rollup._types.Groupings" + "allOf": [ + { + "$ref": "#/components/schemas/rollup._types.Groupings" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "index_pattern": { "type": "string" @@ -102936,10 +118817,18 @@ "type": "number" }, "rollup_index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "timeout": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } }, "required": [ @@ -102957,13 +118846,28 @@ "type": "object", "properties": { "date_histogram": { - "$ref": "#/components/schemas/rollup._types.DateHistogramGrouping" + "description": "A date histogram group aggregates a date field into time-based buckets.\nThis group is mandatory; you currently cannot roll up documents without a timestamp and a `date_histogram` group.", + "allOf": [ + { + "$ref": "#/components/schemas/rollup._types.DateHistogramGrouping" + } + ] }, "histogram": { - "$ref": "#/components/schemas/rollup._types.HistogramGrouping" + "description": "The histogram group aggregates one or more numeric fields into numeric histogram intervals.", + "allOf": [ + { + "$ref": "#/components/schemas/rollup._types.HistogramGrouping" + } + ] }, "terms": { - "$ref": "#/components/schemas/rollup._types.TermsGrouping" + "description": "The terms group can be used on keyword or numeric fields to allow bucketing via the terms aggregation at a later point.\nThe indexer enumerates and stores all values of a field for each time-period.\nThis can be potentially costly for high-cardinality groups such as IP addresses, especially if the time-bucket is particularly sparse.", + "allOf": [ + { + "$ref": "#/components/schemas/rollup._types.TermsGrouping" + } + ] } } }, @@ -102971,25 +118875,54 @@ "type": "object", "properties": { "delay": { - "$ref": "#/components/schemas/_types.Duration" + "description": "How long to wait before rolling up new documents.\nBy default, the indexer attempts to roll up all data that is available.\nHowever, it is not uncommon for data to arrive out of order.\nThe indexer is unable to deal with data that arrives after a time-span has been rolled up.\nYou need to specify a delay that matches the longest period of time you expect out-of-order data to arrive.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The date field that is to be rolled up.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "format": { "type": "string" }, "interval": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "calendar_interval": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The interval of time buckets to be generated when rolling up.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "fixed_interval": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The interval of time buckets to be generated when rolling up.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "time_zone": { - "$ref": "#/components/schemas/_types.TimeZone" + "description": "Defines what `time_zone` the rollup documents are stored as.\nUnlike raw data, which can shift timezones on the fly, rolled documents have to be stored with a specific timezone.\nBy default, rollup documents are stored in `UTC`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TimeZone" + } + ] } }, "required": [ @@ -103000,7 +118933,12 @@ "type": "object", "properties": { "fields": { - "$ref": "#/components/schemas/_types.Fields" + "description": "The set of fields that you wish to build histograms for.\nAll fields specified must be some kind of numeric.\nOrder does not matter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "interval": { "description": "The interval of histogram buckets to be generated when rolling up.\nFor example, a value of `5` creates buckets that are five units wide (`0-5`, `5-10`, etc).\nNote that only one interval can be specified in the histogram group, meaning that all fields being grouped via the histogram must share the same interval.", @@ -103016,7 +118954,12 @@ "type": "object", "properties": { "fields": { - "$ref": "#/components/schemas/_types.Fields" + "description": "The set of fields that you wish to collect terms for.\nThis array can contain fields that are both keyword and numerics.\nOrder does not matter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] } }, "required": [ @@ -103027,7 +118970,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to collect metrics for. This must be a numeric of some kind.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "metrics": { "description": "An array of metrics to collect for the field. At least one metric must be configured.", @@ -103062,7 +119010,11 @@ "type": "number" }, "index_time_in_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "index_total": { "type": "number" @@ -103077,7 +119029,11 @@ "type": "number" }, "search_time_in_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "search_total": { "type": "number" @@ -103086,7 +119042,11 @@ "type": "number" }, "processing_time_in_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "processing_total": { "type": "number" @@ -103117,7 +119077,11 @@ } }, "job_state": { - "$ref": "#/components/schemas/rollup.get_jobs.IndexingJobState" + "allOf": [ + { + "$ref": "#/components/schemas/rollup.get_jobs.IndexingJobState" + } + ] }, "upgraded_doc_id": { "type": "boolean" @@ -103188,10 +119152,18 @@ "type": "string" }, "calendar_interval": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "time_zone": { - "$ref": "#/components/schemas/_types.TimeZone" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TimeZone" + } + ] } }, "required": [ @@ -103228,10 +119200,18 @@ "type": "string" }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "rollup_index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] } }, "required": [ @@ -103248,10 +119228,18 @@ "type": "string" }, "time_zone": { - "$ref": "#/components/schemas/_types.TimeZone" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TimeZone" + } + ] }, "calendar_interval": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } }, "required": [ @@ -103282,10 +119270,20 @@ "type": "object" }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "Index containing a mapping that's compatible with the indexed document.\nYou may specify a remote index by prefixing the index with the remote cluster alias.\nFor example, `remote1:my_index` indicates that you want to run the painless script against the \"my_index\" index on the \"remote1\" cluster.\nThis request will be forwarded to the \"remote1\" cluster if you have configured a connection to that remote cluster.\n\nNOTE: Wildcards are not accepted in the index expression for this endpoint.\nThe expression `*:myindex` will return the error \"No such remote cluster\" and the expression `logs*` or `remote1:logs*` will return the error \"index not found\".", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Use this parameter to specify a query for computing a score.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } }, "required": [ @@ -103302,10 +119300,20 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "Search Application name", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "updated_at_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "Last time the Search Application was updated.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] } }, "required": [ @@ -103326,10 +119334,20 @@ } }, "analytics_collection_name": { - "$ref": "#/components/schemas/_types.Name" + "description": "Analytics collection associated to the Search Application.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "template": { - "$ref": "#/components/schemas/search_application._types.SearchApplicationTemplate" + "description": "Search template to use on search operations.", + "allOf": [ + { + "$ref": "#/components/schemas/search_application._types.SearchApplicationTemplate" + } + ] } }, "required": [ @@ -103340,7 +119358,12 @@ "type": "object", "properties": { "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "The associated mustache template.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } }, "required": [ @@ -103351,7 +119374,12 @@ "type": "object", "properties": { "event_data_stream": { - "$ref": "#/components/schemas/search_application._types.EventDataStream" + "description": "Data stream for the collection.", + "allOf": [ + { + "$ref": "#/components/schemas/search_application._types.EventDataStream" + } + ] } }, "required": [ @@ -103362,7 +119390,11 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] } }, "required": [ @@ -103386,7 +119418,12 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The name of the analytics collection created or updated", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] } }, "required": [ @@ -103423,13 +119460,28 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.NodeName" + "description": "The human-readable identifier of the node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeName" + } + ] }, "ephemeral_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The ephemeral ID of the node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "transport_address": { - "$ref": "#/components/schemas/_types.TransportAddress" + "description": "The host and port where transport HTTP connections are accepted.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TransportAddress" + } + ] }, "external_id": { "x-state": "Generally available; Added in 8.3.0", @@ -103443,10 +119495,18 @@ } }, "roles": { - "$ref": "#/components/schemas/_types.NodeRoles" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeRoles" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "min_index_version": { "type": "number" @@ -103471,19 +119531,31 @@ "type": "object", "properties": { "state": { - "$ref": "#/components/schemas/indices.stats.ShardRoutingState" + "allOf": [ + { + "$ref": "#/components/schemas/indices.stats.ShardRoutingState" + } + ] }, "primary": { "type": "boolean" }, "node": { - "$ref": "#/components/schemas/_types.NodeName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeName" + } + ] }, "shard": { "type": "number" }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "allocation_id": { "type": "object", @@ -103498,7 +119570,11 @@ } }, "unassigned_info": { - "$ref": "#/components/schemas/cluster.allocation_explain.UnassignedInformation" + "allOf": [ + { + "$ref": "#/components/schemas/cluster.allocation_explain.UnassignedInformation" + } + ] }, "relocating_node": { "oneOf": [ @@ -103512,7 +119588,11 @@ ] }, "relocation_failure_info": { - "$ref": "#/components/schemas/_types.RelocationFailureInfo" + "allOf": [ + { + "$ref": "#/components/schemas/_types.RelocationFailureInfo" + } + ] } }, "required": [ @@ -103543,7 +119623,11 @@ } }, "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } } }, @@ -103551,7 +119635,11 @@ "type": "object", "properties": { "shared_cache": { - "$ref": "#/components/schemas/searchable_snapshots.cache_stats.Shared" + "allOf": [ + { + "$ref": "#/components/schemas/searchable_snapshots.cache_stats.Shared" + } + ] } }, "required": [ @@ -103565,13 +119653,21 @@ "type": "number" }, "bytes_read_in_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "writes": { "type": "number" }, "bytes_written_in_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "evictions": { "type": "number" @@ -103580,10 +119676,18 @@ "type": "number" }, "size_in_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "region_size_in_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] } }, "required": [ @@ -103601,13 +119705,25 @@ "type": "object", "properties": { "snapshot": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "indices": { - "$ref": "#/components/schemas/_types.Indices" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] } }, "required": [ @@ -103643,7 +119759,11 @@ "type": "number" }, "_doc": { - "$ref": "#/components/schemas/security._types.UserProfileHitMetadata" + "allOf": [ + { + "$ref": "#/components/schemas/security._types.UserProfileHitMetadata" + } + ] } }, "required": [ @@ -103660,7 +119780,11 @@ "type": "number" }, "_seq_no": { - "$ref": "#/components/schemas/_types.SequenceNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SequenceNumber" + } + ] } }, "required": [ @@ -103672,10 +119796,18 @@ "type": "object", "properties": { "uid": { - "$ref": "#/components/schemas/security._types.UserProfileId" + "allOf": [ + { + "$ref": "#/components/schemas/security._types.UserProfileId" + } + ] }, "user": { - "$ref": "#/components/schemas/security._types.UserProfileUser" + "allOf": [ + { + "$ref": "#/components/schemas/security._types.UserProfileUser" + } + ] }, "data": { "type": "object", @@ -103729,10 +119861,18 @@ ] }, "realm_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "realm_domain": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "roles": { "type": "array", @@ -103741,7 +119881,11 @@ } }, "username": { - "$ref": "#/components/schemas/_types.Username" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Username" + } + ] } }, "required": [ @@ -103754,10 +119898,18 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] } }, "required": [ @@ -103768,7 +119920,11 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "type": { "type": "string" @@ -103783,7 +119939,11 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "type": { "x-state": "Generally available; Added in 7.14.0", @@ -103870,7 +120030,12 @@ } }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Optional meta-data. Within the metadata object, keys that begin with `_` are reserved for system usage.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "run_as": { "externalDocs": { @@ -103887,7 +120052,12 @@ "type": "string" }, "restriction": { - "$ref": "#/components/schemas/security._types.Restriction" + "description": "Restriction for when the role descriptor is allowed to be effective.", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.Restriction" + } + ] }, "transient_metadata": { "type": "object", @@ -103974,7 +120144,214 @@ "type": "object", "properties": { "field_security": { - "$ref": "#/components/schemas/security._types.FieldSecurity" + "externalDocs": { + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level" + }, + "description": "The document fields that the owners of the role have read access to.", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.FieldSecurity" + } + ] + }, + "names": { + "description": "A list of indices (or index name patterns) to which the permissions in this entry apply.", + "oneOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.IndexName" + } + } + ] + }, + "privileges": { + "description": "The index level privileges that owners of the role have on the specified indices.", + "type": "array", + "items": { + "$ref": "#/components/schemas/security._types.IndexPrivilege" + } + }, + "query": { + "description": "A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role.", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.IndicesPrivilegesQuery" + } + ] + }, + "allow_restricted_indices": { + "description": "Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.", + "default": false, + "x-state": "Generally available", + "type": "boolean" + } + }, + "required": [ + "names", + "privileges" + ] + }, + "security._types.FieldSecurity": { + "type": "object", + "properties": { + "except": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] + }, + "grant": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] + } + } + }, + "security._types.IndexPrivilege": { + "anyOf": [ + { + "type": "string", + "enum": [ + "all", + "auto_configure", + "create", + "create_doc", + "create_index", + "cross_cluster_replication", + "cross_cluster_replication_internal", + "delete", + "delete_index", + "index", + "maintenance", + "manage", + "manage_data_stream_lifecycle", + "manage_follow_index", + "manage_ilm", + "manage_leader_index", + "monitor", + "none", + "read", + "read_cross_cluster", + "view_index_metadata", + "write" + ] + }, + { + "type": "string" + } + ] + }, + "security._types.IndicesPrivilegesQuery": { + "description": "While creating or updating a role you can provide either a JSON structure or a string to the API.\nHowever, the response provided by Elasticsearch will only be string with a json-as-text content.\n\nSince this is embedded in `IndicesPrivileges`, the same structure is used for clarity in both contexts.", + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + }, + { + "$ref": "#/components/schemas/security._types.RoleTemplateQuery" + } + ] + }, + "security._types.RoleTemplateQuery": { + "type": "object", + "properties": { + "template": { + "externalDocs": { + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level#templating-role-query" + }, + "description": "When you create a role, you can specify a query that defines the document level security permissions. You can optionally\nuse Mustache templates in the role query to insert the username of the current authenticated user into the role.\nLike other places in Elasticsearch that support templating or scripting, you can specify inline, stored, or file-based\ntemplates and define custom parameters. You access the details for the current authenticated user through the _user parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.RoleTemplateScript" + } + ] + } + } + }, + "security._types.RoleTemplateScript": { + "type": "object", + "properties": { + "source": { + "allOf": [ + { + "$ref": "#/components/schemas/security._types.RoleTemplateInlineQuery" + } + ] + }, + "id": { + "description": "The `id` for a stored script.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] + }, + "params": { + "description": "Specifies any named parameters that are passed into the script as variables.\nUse parameters instead of hard-coded values to decrease compile time.", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "lang": { + "description": "Specifies the language the script is written in.", + "default": "painless", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptLanguage" + } + ] + }, + "options": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "security._types.RoleTemplateInlineQuery": { + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] + }, + "security._types.RemoteIndicesPrivileges": { + "description": "The subset of index level privileges that can be defined for remote clusters.", + "type": "object", + "properties": { + "clusters": { + "description": "A list of cluster aliases to which the permissions in this entry apply.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Names" + } + ] + }, + "field_security": { + "externalDocs": { + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level" + }, + "description": "The document fields that the owners of the role have read access to.", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.FieldSecurity" + } + ] }, "names": { "description": "A list of indices (or index name patterns) to which the permissions in this entry apply.", @@ -103998,158 +120375,13 @@ } }, "query": { - "$ref": "#/components/schemas/security._types.IndicesPrivilegesQuery" - }, - "allow_restricted_indices": { - "description": "Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.", - "default": false, - "x-state": "Generally available", - "type": "boolean" - } - }, - "required": [ - "names", - "privileges" - ] - }, - "security._types.FieldSecurity": { - "type": "object", - "properties": { - "except": { - "$ref": "#/components/schemas/_types.Fields" - }, - "grant": { - "$ref": "#/components/schemas/_types.Fields" - } - } - }, - "security._types.IndexPrivilege": { - "anyOf": [ - { - "type": "string", - "enum": [ - "all", - "auto_configure", - "create", - "create_doc", - "create_index", - "cross_cluster_replication", - "cross_cluster_replication_internal", - "delete", - "delete_index", - "index", - "maintenance", - "manage", - "manage_data_stream_lifecycle", - "manage_follow_index", - "manage_ilm", - "manage_leader_index", - "monitor", - "none", - "read", - "read_cross_cluster", - "view_index_metadata", - "write" - ] - }, - { - "type": "string" - } - ] - }, - "security._types.IndicesPrivilegesQuery": { - "description": "While creating or updating a role you can provide either a JSON structure or a string to the API.\nHowever, the response provided by Elasticsearch will only be string with a json-as-text content.\n\nSince this is embedded in `IndicesPrivileges`, the same structure is used for clarity in both contexts.", - "oneOf": [ - { - "type": "string" - }, - { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" - }, - { - "$ref": "#/components/schemas/security._types.RoleTemplateQuery" - } - ] - }, - "security._types.RoleTemplateQuery": { - "type": "object", - "properties": { - "template": { - "$ref": "#/components/schemas/security._types.RoleTemplateScript" - } - } - }, - "security._types.RoleTemplateScript": { - "type": "object", - "properties": { - "source": { - "$ref": "#/components/schemas/security._types.RoleTemplateInlineQuery" - }, - "id": { - "$ref": "#/components/schemas/_types.Id" - }, - "params": { - "description": "Specifies any named parameters that are passed into the script as variables.\nUse parameters instead of hard-coded values to decrease compile time.", - "type": "object", - "additionalProperties": { - "type": "object" - } - }, - "lang": { - "$ref": "#/components/schemas/_types.ScriptLanguage" - }, - "options": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "security._types.RoleTemplateInlineQuery": { - "oneOf": [ - { - "type": "string" - }, - { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" - } - ] - }, - "security._types.RemoteIndicesPrivileges": { - "description": "The subset of index level privileges that can be defined for remote clusters.", - "type": "object", - "properties": { - "clusters": { - "$ref": "#/components/schemas/_types.Names" - }, - "field_security": { - "$ref": "#/components/schemas/security._types.FieldSecurity" - }, - "names": { - "description": "A list of indices (or index name patterns) to which the permissions in this entry apply.", - "oneOf": [ - { - "$ref": "#/components/schemas/_types.IndexName" - }, + "description": "A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role.", + "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/_types.IndexName" - } + "$ref": "#/components/schemas/security._types.IndicesPrivilegesQuery" } ] }, - "privileges": { - "description": "The index level privileges that owners of the role have on the specified indices.", - "type": "array", - "items": { - "$ref": "#/components/schemas/security._types.IndexPrivilege" - } - }, - "query": { - "$ref": "#/components/schemas/security._types.IndicesPrivilegesQuery" - }, "allow_restricted_indices": { "description": "Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.", "default": false, @@ -104168,7 +120400,12 @@ "type": "object", "properties": { "clusters": { - "$ref": "#/components/schemas/_types.Names" + "description": "A list of cluster aliases to which the permissions in this entry apply.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Names" + } + ] }, "privileges": { "description": "The cluster level privileges that owners of the role have on the remote cluster.", @@ -104194,7 +120431,11 @@ "type": "object", "properties": { "application": { - "$ref": "#/components/schemas/security._types.ApplicationGlobalUserPrivileges" + "allOf": [ + { + "$ref": "#/components/schemas/security._types.ApplicationGlobalUserPrivileges" + } + ] } }, "required": [ @@ -104205,7 +120446,11 @@ "type": "object", "properties": { "manage": { - "$ref": "#/components/schemas/security._types.ManageUserPrivileges" + "allOf": [ + { + "$ref": "#/components/schemas/security._types.ManageUserPrivileges" + } + ] } }, "required": [ @@ -104286,7 +120531,11 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] } }, "required": [ @@ -104349,7 +120598,15 @@ "type": "object", "properties": { "field_security": { - "$ref": "#/components/schemas/security._types.FieldSecurity" + "externalDocs": { + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level" + }, + "description": "The document fields that the owners of the role have read access to.", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.FieldSecurity" + } + ] }, "names": { "description": "A list of indices (or index name patterns) to which the permissions in this entry apply.", @@ -104366,7 +120623,12 @@ ] }, "query": { - "$ref": "#/components/schemas/security._types.IndicesPrivilegesQuery" + "description": "A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role.", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.IndicesPrivilegesQuery" + } + ] }, "allow_restricted_indices": { "description": "Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.", @@ -104383,7 +120645,11 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "value": { "type": "string" @@ -104435,16 +120701,28 @@ } }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "enabled": { "type": "boolean" }, "authentication_realm": { - "$ref": "#/components/schemas/security.delegate_pki.AuthenticationRealm" + "allOf": [ + { + "$ref": "#/components/schemas/security.delegate_pki.AuthenticationRealm" + } + ] }, "lookup_realm": { - "$ref": "#/components/schemas/security.delegate_pki.AuthenticationRealm" + "allOf": [ + { + "$ref": "#/components/schemas/security.delegate_pki.AuthenticationRealm" + } + ] }, "authentication_type": { "type": "string" @@ -104518,29 +120796,66 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Id for the API key", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "Name of the API key.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "type": { - "$ref": "#/components/schemas/security._types.ApiKeyType" + "description": "The type of the API key (e.g. `rest` or `cross_cluster`).", + "x-state": "Generally available; Added in 8.10.0", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.ApiKeyType" + } + ] }, "creation": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "Creation time for the API key in milliseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "expiration": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "Expiration time for the API key in milliseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "invalidated": { "description": "Invalidation status for the API key.\nIf the key has been invalidated, it has a value of `true`. Otherwise, it is `false`.", "type": "boolean" }, "invalidation": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "If the key has been invalidated, invalidation time in milliseconds.", + "x-state": "Generally available; Added in 8.12.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "username": { - "$ref": "#/components/schemas/_types.Username" + "description": "Principal for which this API key was created", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Username" + } + ] }, "realm": { "description": "Realm name of the principal for which this API key was created.", @@ -104552,7 +120867,13 @@ "type": "string" }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Metadata of the API key", + "x-state": "Generally available; Added in 7.13.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "role_descriptors": { "description": "The role descriptors assigned to this API key when it was created or last updated.\nAn empty role descriptor means the API key inherits the owner user’s permissions.", @@ -104573,7 +120894,13 @@ } }, "access": { - "$ref": "#/components/schemas/security._types.Access" + "description": "The access granted to cross-cluster API keys.\nThe access is composed of permissions for cross cluster search and cross cluster replication.\nAt least one of them must be specified.\nWhen specified, the new access assignment fully replaces the previously assigned access.", + "x-state": "Generally available; Added in 8.10.0", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.Access" + } + ] }, "profile_uid": { "description": "The profile uid for the API key owner principal, if requested and if it exists", @@ -104581,7 +120908,12 @@ "type": "string" }, "_sort": { - "$ref": "#/components/schemas/_types.SortResults" + "description": "Sorting values when using the `sort` parameter with the `security.query_api_keys` API.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortResults" + } + ] } }, "required": [ @@ -104615,10 +120947,18 @@ "type": "string" }, "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] } }, "required": [ @@ -104655,7 +120995,11 @@ } }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "description": { "type": "string" @@ -104712,10 +121056,18 @@ "type": "object", "properties": { "format": { - "$ref": "#/components/schemas/security._types.TemplateFormat" + "allOf": [ + { + "$ref": "#/components/schemas/security._types.TemplateFormat" + } + ] }, "template": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } }, "required": [ @@ -104736,7 +121088,11 @@ "type": "boolean" }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "roles": { "type": "array", @@ -104751,7 +121107,11 @@ } }, "rules": { - "$ref": "#/components/schemas/security._types.RoleMappingRule" + "allOf": [ + { + "$ref": "#/components/schemas/security._types.RoleMappingRule" + } + ] } }, "required": [ @@ -104794,7 +121154,11 @@ "maxProperties": 1 }, "except": { - "$ref": "#/components/schemas/security._types.RoleMappingRule" + "allOf": [ + { + "$ref": "#/components/schemas/security._types.RoleMappingRule" + } + ] } }, "minProperties": 1, @@ -104804,7 +121168,11 @@ "type": "object", "properties": { "role_descriptor": { - "$ref": "#/components/schemas/security._types.RoleDescriptorRead" + "allOf": [ + { + "$ref": "#/components/schemas/security._types.RoleDescriptorRead" + } + ] } }, "required": [ @@ -104867,7 +121235,12 @@ } }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Optional meta-data. Within the metadata object, keys that begin with `_` are reserved for system usage.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "run_as": { "externalDocs": { @@ -104884,7 +121257,15 @@ "type": "string" }, "restriction": { - "$ref": "#/components/schemas/security._types.Restriction" + "externalDocs": { + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/role-restriction" + }, + "description": "A restriction for when the role descriptor is allowed to be effective.", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.Restriction" + } + ] }, "transient_metadata": { "type": "object", @@ -104902,7 +121283,12 @@ "type": "object", "properties": { "_nodes": { - "$ref": "#/components/schemas/_types.NodeStatistics" + "description": "General status showing how nodes respond to the above collection request", + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeStatistics" + } + ] }, "file_tokens": { "description": "File-backed tokens collected from all nodes", @@ -104935,7 +121321,11 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] } } }, @@ -104957,13 +121347,25 @@ "type": "object", "properties": { "authentication_realm": { - "$ref": "#/components/schemas/security.get_token.UserRealm" + "allOf": [ + { + "$ref": "#/components/schemas/security.get_token.UserRealm" + } + ] }, "lookup_realm": { - "$ref": "#/components/schemas/security.get_token.UserRealm" + "allOf": [ + { + "$ref": "#/components/schemas/security.get_token.UserRealm" + } + ] }, "authentication_provider": { - "$ref": "#/components/schemas/security.get_token.AuthenticationProvider" + "allOf": [ + { + "$ref": "#/components/schemas/security.get_token.AuthenticationProvider" + } + ] }, "authentication_type": { "type": "string" @@ -104981,7 +121383,11 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "type": { "type": "string" @@ -104999,7 +121405,11 @@ "type": "string" }, "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] } }, "required": [ @@ -105033,7 +121443,11 @@ ] }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "roles": { "type": "array", @@ -105042,13 +121456,21 @@ } }, "username": { - "$ref": "#/components/schemas/_types.Username" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Username" + } + ] }, "enabled": { "type": "boolean" }, "profile_uid": { - "$ref": "#/components/schemas/security._types.UserProfileId" + "allOf": [ + { + "$ref": "#/components/schemas/security._types.UserProfileId" + } + ] } }, "required": [ @@ -105191,10 +121613,19 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "expiration": { - "$ref": "#/components/schemas/_types.DurationLarge" + "description": "Expiration time for the API key. By default, API keys never expire.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationLarge" + } + ] }, "role_descriptors": { "description": "The role descriptors for this API key.\nWhen it is not specified or is an empty array, the API key has a point in time snapshot of permissions of the specified user or access token.\nIf you supply role descriptors, the resultant permissions are an intersection of API keys permissions and the permissions of the user or access token.", @@ -105217,7 +121648,12 @@ ] }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Arbitrary metadata that you want to associate with the API key.\nIt supports nested data structure.\nWithin the `metadata` object, keys beginning with `_` are reserved for system usage.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] } }, "required": [ @@ -105263,7 +121699,12 @@ "type": "object", "properties": { "names": { - "$ref": "#/components/schemas/_types.Indices" + "description": "A list of indices.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "privileges": { "description": "A list of the privileges that you want to check for the specified indices.", @@ -105366,7 +121807,11 @@ } }, "meta": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] } } }, @@ -105374,31 +121819,75 @@ "type": "object", "properties": { "cardinality": { - "$ref": "#/components/schemas/_types.aggregations.CardinalityAggregation" + "description": "A single-value metrics aggregation that calculates an approximate count of distinct values.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CardinalityAggregation" + } + ] }, "composite": { - "$ref": "#/components/schemas/_types.aggregations.CompositeAggregation" + "description": "A multi-bucket aggregation that creates composite buckets from different sources.\nUnlike the other multi-bucket aggregations, you can use the `composite` aggregation to paginate *all* buckets from a multi-level aggregation efficiently.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CompositeAggregation" + } + ] }, "date_range": { - "$ref": "#/components/schemas/_types.aggregations.DateRangeAggregation" + "description": "A multi-bucket value source based aggregation that enables the user to define a set of date ranges - each representing a bucket.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.DateRangeAggregation" + } + ] }, "filter": { - "$ref": "#/components/schemas/security.query_api_keys.ApiKeyQueryContainer" + "description": "A single bucket aggregation that narrows the set of documents to those that match a query.", + "allOf": [ + { + "$ref": "#/components/schemas/security.query_api_keys.ApiKeyQueryContainer" + } + ] }, "filters": { - "$ref": "#/components/schemas/security.query_api_keys.ApiKeyFiltersAggregation" + "description": "A multi-bucket aggregation where each bucket contains the documents that match a query.", + "allOf": [ + { + "$ref": "#/components/schemas/security.query_api_keys.ApiKeyFiltersAggregation" + } + ] }, "missing": { - "$ref": "#/components/schemas/_types.aggregations.MissingAggregation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MissingAggregation" + } + ] }, "range": { - "$ref": "#/components/schemas/_types.aggregations.RangeAggregation" + "description": "A multi-bucket value source based aggregation that enables the user to define a set of ranges - each representing a bucket.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.RangeAggregation" + } + ] }, "terms": { - "$ref": "#/components/schemas/_types.aggregations.TermsAggregation" + "description": "A multi-bucket value source based aggregation where buckets are dynamically built - one per unique value.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsAggregation" + } + ] }, "value_count": { - "$ref": "#/components/schemas/_types.aggregations.ValueCountAggregation" + "description": "A single-value metrics aggregation that counts the number of values that are extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ValueCountAggregation" + } + ] } }, "minProperties": 1, @@ -105410,13 +121899,28 @@ "type": "object", "properties": { "bool": { - "$ref": "#/components/schemas/_types.query_dsl.BoolQuery" + "description": "Matches documents matching boolean combinations of other queries.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.BoolQuery" + } + ] }, "exists": { - "$ref": "#/components/schemas/_types.query_dsl.ExistsQuery" + "description": "Returns documents that contain an indexed value for a field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ExistsQuery" + } + ] }, "ids": { - "$ref": "#/components/schemas/_types.query_dsl.IdsQuery" + "description": "Returns documents based on their IDs.\nThis query uses document IDs stored in the `_id` field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IdsQuery" + } + ] }, "match": { "description": "Returns documents that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.", @@ -105428,7 +121932,12 @@ "maxProperties": 1 }, "match_all": { - "$ref": "#/components/schemas/_types.query_dsl.MatchAllQuery" + "description": "Matches all documents, giving them all a `_score` of 1.0.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.MatchAllQuery" + } + ] }, "prefix": { "description": "Returns documents that contain a specific prefix in a provided field.", @@ -105449,7 +121958,12 @@ "maxProperties": 1 }, "simple_query_string": { - "$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringQuery" + "description": "Returns documents based on a provided query string, using a parser with a limited but fault-tolerant syntax.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringQuery" + } + ] }, "term": { "description": "Returns documents that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.", @@ -105461,7 +121975,12 @@ "maxProperties": 1 }, "terms": { - "$ref": "#/components/schemas/_types.query_dsl.TermsQuery" + "description": "Returns documents that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.TermsQuery" + } + ] }, "wildcard": { "description": "Returns documents that contain terms matching a wildcard pattern.", @@ -105485,7 +122004,12 @@ "type": "object", "properties": { "filters": { - "$ref": "#/components/schemas/_types.aggregations.BucketsApiKeyQueryContainer" + "description": "Collection of queries from which to build buckets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsApiKeyQueryContainer" + } + ] }, "other_bucket": { "description": "Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters.", @@ -105569,13 +122093,28 @@ "type": "object", "properties": { "bool": { - "$ref": "#/components/schemas/_types.query_dsl.BoolQuery" + "description": "matches roles matching boolean combinations of other queries.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.BoolQuery" + } + ] }, "exists": { - "$ref": "#/components/schemas/_types.query_dsl.ExistsQuery" + "description": "Returns roles that contain an indexed value for a field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ExistsQuery" + } + ] }, "ids": { - "$ref": "#/components/schemas/_types.query_dsl.IdsQuery" + "description": "Returns roles based on their IDs.\nThis query uses role document IDs stored in the `_id` field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IdsQuery" + } + ] }, "match": { "description": "Returns roles that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.", @@ -105587,7 +122126,12 @@ "maxProperties": 1 }, "match_all": { - "$ref": "#/components/schemas/_types.query_dsl.MatchAllQuery" + "description": "Matches all roles, giving them all a `_score` of 1.0.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.MatchAllQuery" + } + ] }, "prefix": { "description": "Returns roles that contain a specific prefix in a provided field.", @@ -105608,7 +122152,12 @@ "maxProperties": 1 }, "simple_query_string": { - "$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringQuery" + "description": "Returns roles based on a provided query string, using a parser with a limited but fault-tolerant syntax.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringQuery" + } + ] }, "term": { "description": "Returns roles that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.", @@ -105620,7 +122169,12 @@ "maxProperties": 1 }, "terms": { - "$ref": "#/components/schemas/_types.query_dsl.TermsQuery" + "description": "Returns roles that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.TermsQuery" + } + ] }, "wildcard": { "description": "Returns roles that contain terms matching a wildcard pattern.", @@ -105644,7 +122198,11 @@ "type": "object", "properties": { "_sort": { - "$ref": "#/components/schemas/_types.SortResults" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortResults" + } + ] }, "name": { "description": "Name of the role.", @@ -105661,13 +122219,28 @@ "type": "object", "properties": { "ids": { - "$ref": "#/components/schemas/_types.query_dsl.IdsQuery" + "description": "Returns users based on their IDs.\nThis query uses the user document IDs stored in the `_id` field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IdsQuery" + } + ] }, "bool": { - "$ref": "#/components/schemas/_types.query_dsl.BoolQuery" + "description": "matches users matching boolean combinations of other queries.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.BoolQuery" + } + ] }, "exists": { - "$ref": "#/components/schemas/_types.query_dsl.ExistsQuery" + "description": "Returns users that contain an indexed value for a field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ExistsQuery" + } + ] }, "match": { "description": "Returns users that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.", @@ -105679,7 +122252,12 @@ "maxProperties": 1 }, "match_all": { - "$ref": "#/components/schemas/_types.query_dsl.MatchAllQuery" + "description": "Matches all users, giving them all a `_score` of 1.0.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.MatchAllQuery" + } + ] }, "prefix": { "description": "Returns users that contain a specific prefix in a provided field.", @@ -105700,7 +122278,12 @@ "maxProperties": 1 }, "simple_query_string": { - "$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringQuery" + "description": "Returns users based on a provided query string, using a parser with a limited but fault-tolerant syntax.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringQuery" + } + ] }, "term": { "description": "Returns users that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.", @@ -105712,7 +122295,12 @@ "maxProperties": 1 }, "terms": { - "$ref": "#/components/schemas/_types.query_dsl.TermsQuery" + "description": "Returns users that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.TermsQuery" + } + ] }, "wildcard": { "description": "Returns users that contain terms matching a wildcard pattern.", @@ -105736,7 +122324,11 @@ "type": "object", "properties": { "_sort": { - "$ref": "#/components/schemas/_types.SortResults" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortResults" + } + ] } } } @@ -105778,7 +122370,11 @@ "type": "number" }, "relation": { - "$ref": "#/components/schemas/_types.RelationName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.RelationName" + } + ] } }, "required": [ @@ -105790,28 +122386,56 @@ "type": "object", "properties": { "node_id": { - "$ref": "#/components/schemas/_types.NodeId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] }, "type": { - "$ref": "#/components/schemas/shutdown.get_node.ShutdownType" + "allOf": [ + { + "$ref": "#/components/schemas/shutdown.get_node.ShutdownType" + } + ] }, "reason": { "type": "string" }, "shutdown_startedmillis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "status": { - "$ref": "#/components/schemas/shutdown.get_node.ShutdownStatus" + "allOf": [ + { + "$ref": "#/components/schemas/shutdown.get_node.ShutdownStatus" + } + ] }, "shard_migration": { - "$ref": "#/components/schemas/shutdown.get_node.ShardMigrationStatus" + "allOf": [ + { + "$ref": "#/components/schemas/shutdown.get_node.ShardMigrationStatus" + } + ] }, "persistent_tasks": { - "$ref": "#/components/schemas/shutdown.get_node.PersistentTaskStatus" + "allOf": [ + { + "$ref": "#/components/schemas/shutdown.get_node.PersistentTaskStatus" + } + ] }, "plugins": { - "$ref": "#/components/schemas/shutdown.get_node.PluginsStatus" + "allOf": [ + { + "$ref": "#/components/schemas/shutdown.get_node.PluginsStatus" + } + ] } }, "required": [ @@ -105845,7 +122469,11 @@ "type": "object", "properties": { "status": { - "$ref": "#/components/schemas/shutdown.get_node.ShutdownStatus" + "allOf": [ + { + "$ref": "#/components/schemas/shutdown.get_node.ShutdownStatus" + } + ] } }, "required": [ @@ -105856,7 +122484,11 @@ "type": "object", "properties": { "status": { - "$ref": "#/components/schemas/shutdown.get_node.ShutdownStatus" + "allOf": [ + { + "$ref": "#/components/schemas/shutdown.get_node.ShutdownStatus" + } + ] } }, "required": [ @@ -105867,7 +122499,11 @@ "type": "object", "properties": { "status": { - "$ref": "#/components/schemas/shutdown.get_node.ShutdownStatus" + "allOf": [ + { + "$ref": "#/components/schemas/shutdown.get_node.ShutdownStatus" + } + ] } }, "required": [ @@ -105886,7 +122522,11 @@ "type": "object", "properties": { "doc": { - "$ref": "#/components/schemas/simulate.ingest.IngestDocumentSimulation" + "allOf": [ + { + "$ref": "#/components/schemas/simulate.ingest.IngestDocumentSimulation" + } + ] } } }, @@ -105895,10 +122535,20 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Identifier for the document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "Name of the index that the document would be indexed into if this were not a simulation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "_source": { "description": "JSON body for the document.", @@ -105908,7 +122558,12 @@ } }, "_version": { - "$ref": "#/components/schemas/_spec_utils.StringifiedVersionNumber" + "description": "", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.StringifiedVersionNumber" + } + ] }, "executed_pipelines": { "description": "A list of the names of the pipelines executed on this document.", @@ -105928,7 +122583,12 @@ } }, "error": { - "$ref": "#/components/schemas/_types.ErrorCause" + "description": "Any error resulting from simulatng ingest on this doc. This can be an error generated by\nexecuting a processor, or a mapping validation error when simulating indexing the resulting\ndoc.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] } }, "required": [ @@ -105943,34 +122603,77 @@ "type": "object", "properties": { "in_progress": { - "$ref": "#/components/schemas/slm._types.InProgress" + "allOf": [ + { + "$ref": "#/components/schemas/slm._types.InProgress" + } + ] }, "last_failure": { - "$ref": "#/components/schemas/slm._types.Invocation" + "allOf": [ + { + "$ref": "#/components/schemas/slm._types.Invocation" + } + ] }, "last_success": { - "$ref": "#/components/schemas/slm._types.Invocation" + "allOf": [ + { + "$ref": "#/components/schemas/slm._types.Invocation" + } + ] }, "modified_date": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The last time the policy was modified.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "modified_date_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "next_execution": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The next time the policy will run.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "next_execution_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "policy": { - "$ref": "#/components/schemas/slm._types.Policy" + "allOf": [ + { + "$ref": "#/components/schemas/slm._types.Policy" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "The version of the snapshot policy.\nOnly the latest version is stored and incremented when the policy is updated.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "stats": { - "$ref": "#/components/schemas/slm._types.Statistics" + "allOf": [ + { + "$ref": "#/components/schemas/slm._types.Statistics" + } + ] } }, "required": [ @@ -105985,16 +122688,28 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "start_time_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "state": { "type": "string" }, "uuid": { - "$ref": "#/components/schemas/_types.Uuid" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Uuid" + } + ] } }, "required": [ @@ -106008,10 +122723,18 @@ "type": "object", "properties": { "snapshot_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "time": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] } }, "required": [ @@ -106023,19 +122746,35 @@ "type": "object", "properties": { "config": { - "$ref": "#/components/schemas/slm._types.Configuration" + "allOf": [ + { + "$ref": "#/components/schemas/slm._types.Configuration" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "repository": { "type": "string" }, "retention": { - "$ref": "#/components/schemas/slm._types.Retention" + "allOf": [ + { + "$ref": "#/components/schemas/slm._types.Retention" + } + ] }, "schedule": { - "$ref": "#/components/schemas/watcher._types.CronExpression" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.CronExpression" + } + ] } }, "required": [ @@ -106053,7 +122792,12 @@ "type": "boolean" }, "indices": { - "$ref": "#/components/schemas/_types.Indices" + "description": "A comma-separated list of data streams and indices to include in the snapshot. Multi-index syntax is supported.\nBy default, a snapshot includes all data streams and indices in the cluster. If this argument is provided, the snapshot only includes the specified data streams and clusters.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "include_global_state": { "description": "If true, the current global state is included in the snapshot.", @@ -106068,7 +122812,12 @@ } }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Attaches arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data. Metadata must be less than 1024 bytes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "partial": { "description": "If false, the entire snapshot will fail if one or more indices included in the snapshot do not have all primary shards available.", @@ -106081,7 +122830,12 @@ "type": "object", "properties": { "expire_after": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Time period after which a snapshot is considered expired and eligible for deletion. SLM deletes expired snapshots based on the slm.retention_schedule.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "max_count": { "description": "Maximum number of snapshots to retain, even if the snapshots have not yet expired. If the number of snapshots in the repository exceeds this limit, the policy retains the most recent snapshots and deletes older snapshots.", @@ -106105,10 +122859,18 @@ "type": "object", "properties": { "retention_deletion_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "retention_deletion_time_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "retention_failed": { "type": "number" @@ -106120,7 +122882,11 @@ "type": "number" }, "policy": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "total_snapshots_deleted": { "type": "number" @@ -106190,16 +122956,32 @@ } }, "duration": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "duration_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "end_time": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "end_time_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "failures": { "type": "array", @@ -106224,37 +123006,74 @@ } }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "reason": { "type": "string" }, "repository": { - "$ref": "#/components/schemas/_types.Name" + "x-state": "Generally available; Added in 7.14.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "snapshot": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] }, "start_time": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "start_time_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "state": { "type": "string" }, "uuid": { - "$ref": "#/components/schemas/_types.Uuid" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Uuid" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "version_id": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "feature_states": { "type": "array", @@ -106273,10 +123092,18 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "node_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "reason": { "type": "string" @@ -106285,7 +123112,11 @@ "type": "number" }, "index_uuid": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "status": { "type": "string" @@ -106306,7 +123137,11 @@ "type": "number" }, "size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "size_in_bytes": { "type": "number" @@ -106328,7 +123163,11 @@ "type": "string" }, "indices": { - "$ref": "#/components/schemas/_types.Indices" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] } }, "required": [ @@ -106380,7 +123219,12 @@ ] }, "settings": { - "$ref": "#/components/schemas/snapshot._types.AzureRepositorySettings" + "description": "The repository settings.", + "allOf": [ + { + "$ref": "#/components/schemas/snapshot._types.AzureRepositorySettings" + } + ] } }, "required": [ @@ -106439,7 +123283,12 @@ "type": "object", "properties": { "chunk_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Big files can be broken down into multiple smaller blobs in the blob store during snapshotting.\nIt is not recommended to change this value from its default unless there is an explicit reason for limiting the size of blobs in the repository.\nSetting a value lower than the default can result in an increased number of API calls to the blob store during snapshot create and restore operations compared to using the default value and thus make both operations slower and more costly.\nSpecify the chunk size as a byte unit, for example: `10MB`, `5KB`, 500B.\nThe default varies by repository type.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "compress": { "description": "When set to `true`, metadata files are stored in compressed format.\nThis setting doesn't affect index files that are already compressed by default.", @@ -106447,10 +123296,20 @@ "type": "boolean" }, "max_restore_bytes_per_sec": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The maximum snapshot restore rate per node.\nIt defaults to unlimited.\nNote that restores are also throttled through recovery settings.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "max_snapshot_bytes_per_sec": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The maximum snapshot creation rate per node.\nIt defaults to 40mb per second.\nNote that if the recovery settings for managed services are set, then it defaults to unlimited, and the rate is additionally throttled through recovery settings.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] } } }, @@ -106458,7 +123317,11 @@ "type": "object", "properties": { "uuid": { - "$ref": "#/components/schemas/_types.Uuid" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Uuid" + } + ] } } }, @@ -106481,7 +123344,12 @@ ] }, "settings": { - "$ref": "#/components/schemas/snapshot._types.GcsRepositorySettings" + "description": "The repository settings.", + "allOf": [ + { + "$ref": "#/components/schemas/snapshot._types.GcsRepositorySettings" + } + ] } }, "required": [ @@ -106548,7 +123416,12 @@ ] }, "settings": { - "$ref": "#/components/schemas/snapshot._types.S3RepositorySettings" + "description": "The repository settings.\n\nNOTE: In addition to the specified settings, you can also use all non-secure client settings in the repository settings.\nIn this case, the client settings found in the repository settings will be merged with those of the named client used by the repository.\nConflicts between client and repository settings are resolved by the repository settings taking precedence over client settings.", + "allOf": [ + { + "$ref": "#/components/schemas/snapshot._types.S3RepositorySettings" + } + ] } }, "required": [ @@ -106578,7 +123451,12 @@ "type": "string" }, "buffer_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The minimum threshold below which the chunk is uploaded using a single request.\nBeyond this threshold, the S3 repository will use the AWS Multipart Upload API to split the chunk into several parts, each of `buffer_size` length, and to upload each part in its own request.\nNote that setting a buffer size lower than 5mb is not allowed since it will prevent the use of the Multipart API and may result in upload errors.\nIt is also not possible to set a buffer size greater than 5gb as it is the maximum upload size allowed by S3.\nDefaults to `100mb` or 5% of JVM heap, whichever is smaller.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "canned_acl": { "externalDocs": { @@ -106602,7 +123480,13 @@ "type": "number" }, "get_register_retry_delay": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The time to wait before trying again if an attempt to read a linearizable register fails.", + "default": "5s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "max_multipart_parts": { "description": "The maximum number of parts that Elasticsearch will write during a multipart upload of a single object.\nFiles which are larger than `buffer_size × max_multipart_parts` will be chunked into several smaller objects.\nElasticsearch may also split a file across multiple objects to satisfy other constraints such as the `chunk_size` limit.\nDefaults to `10000` which is the maximum number of parts in a multipart upload in AWS S3.", @@ -106636,10 +123520,22 @@ "type": "string" }, "throttled_delete_retry.delay_increment": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The delay before the first retry and the amount the delay is incremented by on each subsequent retry.\nThe default is 50ms and the minimum is 0ms.", + "default": "50ms", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "throttled_delete_retry.maximum_delay": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The upper bound on how long the delays between retries will grow to.\nThe default is 5s and the minimum is 0ms.", + "default": "5s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "throttled_delete_retry.maximum_number_of_retries": { "description": "The number times to retry a throttled snapshot deletion.\nThe default is 10 and the minimum value is 0 which will disable retries altogether.\nNote that if retries are enabled in the Azure client, each of these retries comprises that many client-level retries.", @@ -106671,7 +123567,12 @@ ] }, "settings": { - "$ref": "#/components/schemas/snapshot._types.SharedFileSystemRepositorySettings" + "description": "The repository settings.", + "allOf": [ + { + "$ref": "#/components/schemas/snapshot._types.SharedFileSystemRepositorySettings" + } + ] } }, "required": [ @@ -106729,7 +123630,12 @@ ] }, "settings": { - "$ref": "#/components/schemas/snapshot._types.ReadOnlyUrlRepositorySettings" + "description": "The repository settings.", + "allOf": [ + { + "$ref": "#/components/schemas/snapshot._types.ReadOnlyUrlRepositorySettings" + } + ] } }, "required": [ @@ -106753,7 +123659,13 @@ "type": "number" }, "http_socket_timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The maximum wait time for data transfers over a connection.", + "default": "50s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "max_number_of_snapshots": { "description": "The maximum number of snapshots the repository can contain.\nThe default is `Integer.MAX_VALUE`, which is 2^31-1 or `2147483647`.", @@ -106790,7 +123702,12 @@ ] }, "settings": { - "$ref": "#/components/schemas/snapshot._types.SourceOnlyRepositorySettings" + "description": "The repository settings.", + "allOf": [ + { + "$ref": "#/components/schemas/snapshot._types.SourceOnlyRepositorySettings" + } + ] } }, "required": [ @@ -106852,7 +123769,11 @@ "type": "object", "properties": { "repository": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "snapshots": { "type": "array", @@ -106861,7 +123782,11 @@ } }, "error": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] } }, "required": [ @@ -106872,10 +123797,18 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] } }, "required": [ @@ -106887,28 +123820,68 @@ "type": "object", "properties": { "blob": { - "$ref": "#/components/schemas/snapshot.repository_analyze.BlobDetails" + "description": "A description of the blob that was written and read.", + "allOf": [ + { + "$ref": "#/components/schemas/snapshot.repository_analyze.BlobDetails" + } + ] }, "overwrite_elapsed": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The elapsed time spent overwriting the blob.\nIf the blob was not overwritten, this information is omitted.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "overwrite_elapsed_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "description": "The elapsed time spent overwriting the blob, in nanoseconds.\nIf the blob was not overwritten, this information is omitted.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "write_elapsed": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The elapsed time spent writing the blob.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "write_elapsed_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "description": "The elapsed time spent writing the blob, in nanoseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "write_throttled": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The length of time spent waiting for the `max_snapshot_bytes_per_sec` (or `indices.recovery.max_bytes_per_sec` if the recovery settings for managed services are set) throttle while writing the blob.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "write_throttled_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "description": "The length of time spent waiting for the `max_snapshot_bytes_per_sec` (or `indices.recovery.max_bytes_per_sec` if the recovery settings for managed services are set) throttle while writing the blob, in nanoseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "writer_node": { - "$ref": "#/components/schemas/snapshot.repository_analyze.SnapshotNodeInfo" + "description": "The node which wrote the blob and coordinated the read operations.", + "allOf": [ + { + "$ref": "#/components/schemas/snapshot.repository_analyze.SnapshotNodeInfo" + } + ] } }, "required": [ @@ -106943,10 +123916,20 @@ "type": "number" }, "reads": { - "$ref": "#/components/schemas/snapshot.repository_analyze.ReadBlobDetails" + "description": "A description of every read operation performed on the blob.", + "allOf": [ + { + "$ref": "#/components/schemas/snapshot.repository_analyze.ReadBlobDetails" + } + ] }, "size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The size of the blob.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "size_bytes": { "description": "The size of the blob in bytes.", @@ -106972,29 +123955,64 @@ "type": "boolean" }, "elapsed": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The length of time spent reading the blob.\nIf the blob was not found, this detail is omitted.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "elapsed_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "description": "The length of time spent reading the blob, in nanoseconds.\nIf the blob was not found, this detail is omitted.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "first_byte_time": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The length of time waiting for the first byte of the read operation to be received.\nIf the blob was not found, this detail is omitted.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "first_byte_time_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "description": "The length of time waiting for the first byte of the read operation to be received, in nanoseconds.\nIf the blob was not found, this detail is omitted.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "found": { "description": "Indicates whether the blob was found by the read operation.\nIf the read was started before the write completed or the write was ended before completion, it might be false.", "type": "boolean" }, "node": { - "$ref": "#/components/schemas/snapshot.repository_analyze.SnapshotNodeInfo" + "description": "The node that performed the read operation.", + "allOf": [ + { + "$ref": "#/components/schemas/snapshot.repository_analyze.SnapshotNodeInfo" + } + ] }, "throttled": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The length of time spent waiting due to the `max_restore_bytes_per_sec` or `indices.recovery.max_bytes_per_sec` throttles during the read of the blob.\nIf the blob was not found, this detail is omitted.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "throttled_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "description": "The length of time spent waiting due to the `max_restore_bytes_per_sec` or `indices.recovery.max_bytes_per_sec` throttles during the read of the blob, in nanoseconds.\nIf the blob was not found, this detail is omitted.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] } }, "required": [ @@ -107007,10 +124025,20 @@ "type": "object", "properties": { "read": { - "$ref": "#/components/schemas/snapshot.repository_analyze.ReadSummaryInfo" + "description": "A collection of statistics that summarise the results of the read operations in the test.", + "allOf": [ + { + "$ref": "#/components/schemas/snapshot.repository_analyze.ReadSummaryInfo" + } + ] }, "write": { - "$ref": "#/components/schemas/snapshot.repository_analyze.WriteSummaryInfo" + "description": "A collection of statistics that summarise the results of the write operations in the test.", + "allOf": [ + { + "$ref": "#/components/schemas/snapshot.repository_analyze.WriteSummaryInfo" + } + ] } }, "required": [ @@ -107026,35 +124054,80 @@ "type": "number" }, "max_wait": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The maximum time spent waiting for the first byte of any read request to be received.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "max_wait_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "description": "The maximum time spent waiting for the first byte of any read request to be received, in nanoseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "total_elapsed": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The total elapsed time spent on reading blobs in the test.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "total_elapsed_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "description": "The total elapsed time spent on reading blobs in the test, in nanoseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "total_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The total size of all the blobs or partial blobs read in the test.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "total_size_bytes": { "description": "The total size of all the blobs or partial blobs read in the test, in bytes.", "type": "number" }, "total_throttled": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The total time spent waiting due to the `max_restore_bytes_per_sec` or `indices.recovery.max_bytes_per_sec` throttles.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "total_throttled_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "description": "The total time spent waiting due to the `max_restore_bytes_per_sec` or `indices.recovery.max_bytes_per_sec` throttles, in nanoseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "total_wait": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The total time spent waiting for the first byte of each read request to be received.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "total_wait_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "description": "The total time spent waiting for the first byte of each read request to be received, in nanoseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] } }, "required": [ @@ -107079,20 +124152,40 @@ "type": "number" }, "total_elapsed": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The total elapsed time spent on writing blobs in the test.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "total_elapsed_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "description": "The total elapsed time spent on writing blobs in the test, in nanoseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "total_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The total size of all the blobs written in the test.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "total_size_bytes": { "description": "The total size of all the blobs written in the test, in bytes.", "type": "number" }, "total_throttled": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The total time spent waiting due to the `max_snapshot_bytes_per_sec` throttle.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "total_throttled_nanos": { "description": "The total time spent waiting due to the `max_snapshot_bytes_per_sec` throttle, in nanoseconds.", @@ -107122,7 +124215,11 @@ "type": "string" }, "shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] } }, "required": [ @@ -107149,7 +124246,12 @@ "type": "string" }, "shards_stats": { - "$ref": "#/components/schemas/snapshot._types.ShardsStats" + "description": "Statistics for the shards in the snapshot.", + "allOf": [ + { + "$ref": "#/components/schemas/snapshot._types.ShardsStats" + } + ] }, "snapshot": { "description": "The name of the snapshot.", @@ -107160,10 +124262,20 @@ "type": "string" }, "stats": { - "$ref": "#/components/schemas/snapshot._types.SnapshotStats" + "description": "Details about the number (`file_count`) and size (`size_in_bytes`) of files included in the snapshot.", + "allOf": [ + { + "$ref": "#/components/schemas/snapshot._types.SnapshotStats" + } + ] }, "uuid": { - "$ref": "#/components/schemas/_types.Uuid" + "description": "The universally unique identifier (UUID) for the snapshot.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Uuid" + } + ] } }, "required": [ @@ -107187,10 +124299,18 @@ } }, "shards_stats": { - "$ref": "#/components/schemas/snapshot._types.ShardsStats" + "allOf": [ + { + "$ref": "#/components/schemas/snapshot._types.ShardsStats" + } + ] }, "stats": { - "$ref": "#/components/schemas/snapshot._types.SnapshotStats" + "allOf": [ + { + "$ref": "#/components/schemas/snapshot._types.SnapshotStats" + } + ] } }, "required": [ @@ -107203,10 +124323,18 @@ "type": "object", "properties": { "stage": { - "$ref": "#/components/schemas/snapshot._types.ShardsStatsStage" + "allOf": [ + { + "$ref": "#/components/schemas/snapshot._types.ShardsStatsStage" + } + ] }, "stats": { - "$ref": "#/components/schemas/snapshot._types.ShardsStatsSummary" + "allOf": [ + { + "$ref": "#/components/schemas/snapshot._types.ShardsStatsSummary" + } + ] } }, "required": [ @@ -107228,19 +124356,39 @@ "type": "object", "properties": { "incremental": { - "$ref": "#/components/schemas/snapshot._types.ShardsStatsSummaryItem" + "allOf": [ + { + "$ref": "#/components/schemas/snapshot._types.ShardsStatsSummaryItem" + } + ] }, "total": { - "$ref": "#/components/schemas/snapshot._types.ShardsStatsSummaryItem" + "allOf": [ + { + "$ref": "#/components/schemas/snapshot._types.ShardsStatsSummaryItem" + } + ] }, "start_time_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } }, "required": [ @@ -107306,19 +124454,43 @@ "type": "object", "properties": { "incremental": { - "$ref": "#/components/schemas/snapshot._types.FileCountSnapshotStats" + "description": "The number and size of files that still need to be copied as part of the incremental snapshot.\nFor completed snapshots, this property indicates the number and size of files that were not already in the repository and were copied as part of the incremental snapshot.", + "allOf": [ + { + "$ref": "#/components/schemas/snapshot._types.FileCountSnapshotStats" + } + ] }, "start_time_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The time, in milliseconds, when the snapshot creation process started.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The total time, in milliseconds, that it took for the snapshot process to complete.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "total": { - "$ref": "#/components/schemas/snapshot._types.FileCountSnapshotStats" + "description": "The total number and size of files that are referenced by the snapshot.", + "allOf": [ + { + "$ref": "#/components/schemas/snapshot._types.FileCountSnapshotStats" + } + ] } }, "required": [ @@ -107347,7 +124519,12 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "A human-readable name for the node.\nYou can set this name using the `node.name` property in `elasticsearch.yml`.\nThe default value is the machine's hostname.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] } }, "required": [ @@ -107358,7 +124535,11 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "type": { "type": "string" @@ -107403,7 +124584,12 @@ ] }, "expiry": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The ISO formatted date of the certificate's expiry (not-after) date.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "format": { "description": "The format of the file.\nValid values include `jks`, `PKCS12`, and `PEM`.", @@ -107444,10 +124630,20 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "description": "The update operation result.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] }, "reload_analyzers_details": { - "$ref": "#/components/schemas/indices.reload_search_analyzers.ReloadResult" + "description": "Updating synonyms in a synonym set can reload the associated analyzers in case refresh is set to true.\nThis information is the analyzers reloading result.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.reload_search_analyzers.ReloadResult" + } + ] } }, "required": [ @@ -107458,10 +124654,23 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Synonym Rule identifier", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "synonyms": { - "$ref": "#/components/schemas/synonyms._types.SynonymString" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/text-analysis/analysis-synonym-graph-tokenfilter#_solr_format_2" + }, + "description": "Synonyms, in Solr format, that conform the synonym rule.", + "allOf": [ + { + "$ref": "#/components/schemas/synonyms._types.SynonymString" + } + ] } }, "required": [ @@ -107476,7 +124685,12 @@ "type": "object", "properties": { "synonyms_set": { - "$ref": "#/components/schemas/_types.Id" + "description": "Synonyms set identifier", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "count": { "description": "Number of synonym rules that the synonym set contains", @@ -107492,10 +124706,23 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The identifier for the synonym rule.\nIf you do not specify a synonym rule ID when you create a rule, an identifier is created automatically by Elasticsearch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "synonyms": { - "$ref": "#/components/schemas/synonyms._types.SynonymString" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/text-analysis/analysis-synonym-graph-tokenfilter#analysis-synonym-graph-define-synonyms" + }, + "description": "The synonyms that conform the synonym rule in Solr format.", + "allOf": [ + { + "$ref": "#/components/schemas/synonyms._types.SynonymString" + } + ] } }, "required": [ @@ -107589,7 +124816,12 @@ "type": "string" }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "Version number used by external systems to track ingest pipelines.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "processors": { "description": "Processors used to perform transformations on documents before indexing.\nProcessors run sequentially in the order specified.", @@ -107646,50 +124878,114 @@ "type": "object", "properties": { "authorization": { - "$ref": "#/components/schemas/ml._types.TransformAuthorization" + "description": "The security privileges that the transform uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the transform, this property is omitted.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TransformAuthorization" + } + ] }, "create_time": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The time the transform was created.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "create_time_string": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "description": { "description": "Free text description of the transform.", "type": "string" }, "dest": { - "$ref": "#/components/schemas/_global.reindex.Destination" + "description": "The destination for the transform.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.reindex.Destination" + } + ] }, "frequency": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "latest": { - "$ref": "#/components/schemas/transform._types.Latest" + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Latest" + } + ] }, "pivot": { - "$ref": "#/components/schemas/transform._types.Pivot" + "description": "The pivot method transforms the data by aggregating and grouping it.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Pivot" + } + ] }, "retention_policy": { - "$ref": "#/components/schemas/transform._types.RetentionPolicyContainer" + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.RetentionPolicyContainer" + } + ] }, "settings": { - "$ref": "#/components/schemas/transform._types.Settings" + "description": "Defines optional transform settings.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Settings" + } + ] }, "source": { - "$ref": "#/components/schemas/transform._types.Source" + "description": "The source of the data for the transform.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Source" + } + ] }, "sync": { - "$ref": "#/components/schemas/transform._types.SyncContainer" + "description": "Defines the properties transforms require to run continuously.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.SyncContainer" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "The version of Elasticsearch that existed on the node when the transform was created.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] } }, "required": [ @@ -107702,7 +124998,12 @@ "type": "object", "properties": { "api_key": { - "$ref": "#/components/schemas/ml._types.ApiKeyAuthorization" + "description": "If an API key was used for the most recent update to the transform, its name and identifier are listed in the response.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ApiKeyAuthorization" + } + ] }, "roles": { "description": "If a user ID was used for the most recent update to the transform, its roles at the time of the update are listed in the response.", @@ -107721,7 +125022,12 @@ "type": "object", "properties": { "sort": { - "$ref": "#/components/schemas/_types.Field" + "description": "Specifies the date field that is used to identify the latest documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "unique_key": { "description": "Specifies an array of one or more fields that are used to group the data.", @@ -107759,16 +125065,32 @@ "type": "object", "properties": { "date_histogram": { - "$ref": "#/components/schemas/_types.aggregations.DateHistogramAggregation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.DateHistogramAggregation" + } + ] }, "geotile_grid": { - "$ref": "#/components/schemas/_types.aggregations.GeoTileGridAggregation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GeoTileGridAggregation" + } + ] }, "histogram": { - "$ref": "#/components/schemas/_types.aggregations.HistogramAggregation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.HistogramAggregation" + } + ] }, "terms": { - "$ref": "#/components/schemas/_types.aggregations.TermsAggregation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsAggregation" + } + ] } }, "minProperties": 1, @@ -107778,7 +125100,12 @@ "type": "object", "properties": { "time": { - "$ref": "#/components/schemas/transform._types.RetentionPolicy" + "description": "Specifies that the transform uses a time field to set the retention policy.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.RetentionPolicy" + } + ] } }, "minProperties": 1, @@ -107788,10 +125115,20 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The date field that is used to calculate the age of the document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "max_age": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Specifies the maximum age of a document in the destination index. Documents that are older than the configured\nvalue are removed from the destination index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } }, "required": [ @@ -107839,13 +125176,29 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.Indices" + "description": "The source indices for the transform. It can be a single index, an index pattern (for example, `\"my-index-*\"\"`), an\narray of indices (for example, `[\"my-index-000001\", \"my-index-000002\"]`), or an array of index patterns (for\nexample, `[\"my-index-*\", \"my-other-index-*\"]`. For remote indices use the syntax `\"remote_name:index_name\"`. If\nany indices are in remote clusters then the master node and at least one transform node must have the `remote_cluster_client` node role.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "A query clause that retrieves a subset of data from the source index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "description": "Definitions of search-time runtime fields that can be used by the transform. For search runtime fields all data\nnodes, including remote nodes, must be 7.12 or later.", + "x-state": "Generally available; Added in 7.12.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] } }, "required": [ @@ -107856,7 +125209,12 @@ "type": "object", "properties": { "time": { - "$ref": "#/components/schemas/transform._types.TimeSync" + "description": "Specifies that the transform uses a time field to synchronize the source and destination indices.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.TimeSync" + } + ] } }, "minProperties": 1, @@ -107866,10 +125224,21 @@ "type": "object", "properties": { "delay": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The time delay between the current time and the latest input data time.", + "default": "60s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field\nthat contains the ingest timestamp. If you use a different field, you might need to set the delay such that it\naccounts for data transmission delays.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -107880,16 +125249,33 @@ "type": "object", "properties": { "checkpointing": { - "$ref": "#/components/schemas/transform.get_transform_stats.Checkpointing" + "allOf": [ + { + "$ref": "#/components/schemas/transform.get_transform_stats.Checkpointing" + } + ] }, "health": { - "$ref": "#/components/schemas/transform.get_transform_stats.TransformStatsHealth" + "allOf": [ + { + "$ref": "#/components/schemas/transform.get_transform_stats.TransformStatsHealth" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "node": { - "$ref": "#/components/schemas/_types.NodeAttributes" + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeAttributes" + } + ] }, "reason": { "type": "string" @@ -107898,7 +125284,11 @@ "type": "string" }, "stats": { - "$ref": "#/components/schemas/transform.get_transform_stats.TransformIndexerStats" + "allOf": [ + { + "$ref": "#/components/schemas/transform.get_transform_stats.TransformIndexerStats" + } + ] } }, "required": [ @@ -107915,13 +125305,25 @@ "type": "number" }, "changes_last_detected_at_string": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "last": { - "$ref": "#/components/schemas/transform.get_transform_stats.CheckpointStats" + "allOf": [ + { + "$ref": "#/components/schemas/transform.get_transform_stats.CheckpointStats" + } + ] }, "next": { - "$ref": "#/components/schemas/transform.get_transform_stats.CheckpointStats" + "allOf": [ + { + "$ref": "#/components/schemas/transform.get_transform_stats.CheckpointStats" + } + ] }, "operations_behind": { "type": "number" @@ -107930,7 +125332,11 @@ "type": "number" }, "last_search_time_string": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] } }, "required": [ @@ -107944,19 +125350,39 @@ "type": "number" }, "checkpoint_progress": { - "$ref": "#/components/schemas/transform.get_transform_stats.TransformProgress" + "allOf": [ + { + "$ref": "#/components/schemas/transform.get_transform_stats.TransformProgress" + } + ] }, "timestamp": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "timestamp_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "time_upper_bound": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "time_upper_bound_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] } }, "required": [ @@ -107991,7 +125417,11 @@ "type": "object", "properties": { "status": { - "$ref": "#/components/schemas/_types.HealthStatus" + "allOf": [ + { + "$ref": "#/components/schemas/_types.HealthStatus" + } + ] }, "issues": { "description": "If a non-healthy status is returned, contains a list of issues of the transform.", @@ -108025,10 +125455,19 @@ "type": "number" }, "first_occurrence": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The timestamp this issue occurred for for the first time", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "first_occurence_string": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] } }, "required": [ @@ -108041,7 +125480,11 @@ "type": "object", "properties": { "delete_time_in_ms": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "documents_indexed": { "type": "number" @@ -108053,7 +125496,11 @@ "type": "number" }, "exponential_avg_checkpoint_duration_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] }, "exponential_avg_documents_indexed": { "type": "number" @@ -108065,7 +125512,11 @@ "type": "number" }, "index_time_in_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "index_total": { "type": "number" @@ -108074,7 +125525,11 @@ "type": "number" }, "processing_time_in_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "processing_total": { "type": "number" @@ -108083,7 +125538,11 @@ "type": "number" }, "search_time_in_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "search_total": { "type": "number" @@ -108114,7 +125573,12 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The destination index for the transform. The mappings of the destination index are deduced based on the source\nfields when possible. If alternate mappings are required, use the create index API prior to starting the\ntransform.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "pipeline": { "description": "The unique identifier for an ingest pipeline.", @@ -108131,7 +125595,11 @@ "type": "object", "properties": { "get": { - "$ref": "#/components/schemas/_types.InlineGet" + "allOf": [ + { + "$ref": "#/components/schemas/_types.InlineGet" + } + ] } } } @@ -108162,19 +125630,39 @@ "type": "object", "properties": { "actions": { - "$ref": "#/components/schemas/watcher._types.Actions" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.Actions" + } + ] }, "last_checked": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "last_met_condition": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "state": { - "$ref": "#/components/schemas/watcher._types.ActivationState" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ActivationState" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "execution_state": { "type": "string" @@ -108196,16 +125684,32 @@ "type": "object", "properties": { "ack": { - "$ref": "#/components/schemas/watcher._types.AcknowledgeState" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.AcknowledgeState" + } + ] }, "last_execution": { - "$ref": "#/components/schemas/watcher._types.ExecutionState" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ExecutionState" + } + ] }, "last_successful_execution": { - "$ref": "#/components/schemas/watcher._types.ExecutionState" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ExecutionState" + } + ] }, "last_throttle": { - "$ref": "#/components/schemas/watcher._types.ThrottleState" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ThrottleState" + } + ] } }, "required": [ @@ -108216,10 +125720,18 @@ "type": "object", "properties": { "state": { - "$ref": "#/components/schemas/watcher._types.AcknowledgementOptions" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.AcknowledgementOptions" + } + ] }, "timestamp": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] } }, "required": [ @@ -108242,7 +125754,11 @@ "type": "boolean" }, "timestamp": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "reason": { "type": "string" @@ -108260,7 +125776,11 @@ "type": "string" }, "timestamp": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] } }, "required": [ @@ -108275,7 +125795,11 @@ "type": "boolean" }, "timestamp": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] } }, "required": [ @@ -108287,13 +125811,25 @@ "type": "object", "properties": { "actions": { - "$ref": "#/components/schemas/watcher._types.Actions" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.Actions" + } + ] }, "state": { - "$ref": "#/components/schemas/watcher._types.ActivationState" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ActivationState" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] } }, "required": [ @@ -108322,7 +125858,11 @@ } }, "all": { - "$ref": "#/components/schemas/watcher._types.SimulatedActions" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.SimulatedActions" + } + ] }, "use_all": { "type": "boolean" @@ -108338,10 +125878,18 @@ "type": "object", "properties": { "scheduled_time": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "triggered_time": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] } }, "required": [ @@ -108358,28 +125906,60 @@ } }, "condition": { - "$ref": "#/components/schemas/watcher._types.ConditionContainer" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ConditionContainer" + } + ] }, "input": { - "$ref": "#/components/schemas/watcher._types.InputContainer" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.InputContainer" + } + ] }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "status": { - "$ref": "#/components/schemas/watcher._types.WatchStatus" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.WatchStatus" + } + ] }, "throttle_period": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "throttle_period_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "transform": { - "$ref": "#/components/schemas/_types.TransformContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TransformContainer" + } + ] }, "trigger": { - "$ref": "#/components/schemas/watcher._types.TriggerContainer" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.TriggerContainer" + } + ] } }, "required": [ @@ -108393,10 +125973,18 @@ "type": "object", "properties": { "action_type": { - "$ref": "#/components/schemas/watcher._types.ActionType" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ActionType" + } + ] }, "condition": { - "$ref": "#/components/schemas/watcher._types.ConditionContainer" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ConditionContainer" + } + ] }, "foreach": { "type": "string" @@ -108405,34 +125993,75 @@ "type": "number" }, "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "throttle_period": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "throttle_period_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "transform": { - "$ref": "#/components/schemas/_types.TransformContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TransformContainer" + } + ] }, "index": { - "$ref": "#/components/schemas/watcher._types.IndexAction" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.IndexAction" + } + ] }, "logging": { - "$ref": "#/components/schemas/watcher._types.LoggingAction" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.LoggingAction" + } + ] }, "email": { - "$ref": "#/components/schemas/watcher._types.EmailAction" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.EmailAction" + } + ] }, "pagerduty": { - "$ref": "#/components/schemas/watcher._types.PagerDutyAction" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.PagerDutyAction" + } + ] }, "slack": { - "$ref": "#/components/schemas/watcher._types.SlackAction" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.SlackAction" + } + ] }, "webhook": { - "$ref": "#/components/schemas/watcher._types.WebhookAction" + "x-state": "Generally available; Added in 7.14.0", + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.WebhookAction" + } + ] } } }, @@ -108451,7 +126080,11 @@ "type": "object", "properties": { "always": { - "$ref": "#/components/schemas/watcher._types.AlwaysCondition" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.AlwaysCondition" + } + ] }, "array_compare": { "type": "object", @@ -108475,10 +126108,18 @@ "maxProperties": 1 }, "never": { - "$ref": "#/components/schemas/watcher._types.NeverCondition" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.NeverCondition" + } + ] }, "script": { - "$ref": "#/components/schemas/watcher._types.ScriptCondition" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ScriptCondition" + } + ] } }, "minProperties": 1, @@ -108505,7 +126146,12 @@ "type": "object", "properties": { "lang": { - "$ref": "#/components/schemas/_types.ScriptLanguage" + "default": "painless", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptLanguage" + } + ] }, "params": { "type": "object", @@ -108514,7 +126160,11 @@ } }, "source": { - "$ref": "#/components/schemas/_types.ScriptSource" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptSource" + } + ] }, "id": { "type": "string" @@ -108531,10 +126181,18 @@ } }, "script": { - "$ref": "#/components/schemas/_types.ScriptTransform" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptTransform" + } + ] }, "search": { - "$ref": "#/components/schemas/_types.SearchTransform" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SearchTransform" + } + ] } }, "minProperties": 1, @@ -108554,7 +126212,11 @@ } }, "source": { - "$ref": "#/components/schemas/_types.ScriptSource" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptSource" + } + ] }, "id": { "type": "string" @@ -108565,10 +126227,18 @@ "type": "object", "properties": { "request": { - "$ref": "#/components/schemas/watcher._types.SearchInputRequestDefinition" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.SearchInputRequestDefinition" + } + ] }, "timeout": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } }, "required": [ @@ -108580,7 +126250,11 @@ "type": "object", "properties": { "body": { - "$ref": "#/components/schemas/watcher._types.SearchInputRequestBody" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.SearchInputRequestBody" + } + ] }, "indices": { "type": "array", @@ -108589,13 +126263,25 @@ } }, "indices_options": { - "$ref": "#/components/schemas/_types.IndicesOptions" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndicesOptions" + } + ] }, "search_type": { - "$ref": "#/components/schemas/_types.SearchType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SearchType" + } + ] }, "template": { - "$ref": "#/components/schemas/watcher._types.SearchTemplateRequestBody" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.SearchTemplateRequestBody" + } + ] }, "rest_total_hits_as_int": { "type": "boolean" @@ -108606,7 +126292,11 @@ "type": "object", "properties": { "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } }, "required": [ @@ -108621,7 +126311,12 @@ "type": "boolean" }, "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "ID of the search template to use. If no source is specified,\nthis parameter is required.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "params": { "type": "object", @@ -108643,22 +126338,48 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "doc_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "refresh": { - "$ref": "#/components/schemas/_types.Refresh" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Refresh" + } + ] }, "op_type": { - "$ref": "#/components/schemas/_types.OpType" + "default": "index", + "allOf": [ + { + "$ref": "#/components/schemas/_types.OpType" + } + ] }, "timeout": { - "$ref": "#/components/schemas/_types.Duration" + "default": "60s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "execution_time_field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -108696,7 +126417,11 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "bcc": { "oneOf": [ @@ -108712,7 +126437,11 @@ ] }, "body": { - "$ref": "#/components/schemas/watcher._types.EmailBody" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.EmailBody" + } + ] }, "cc": { "oneOf": [ @@ -108731,7 +126460,11 @@ "type": "string" }, "priority": { - "$ref": "#/components/schemas/watcher._types.EmailPriority" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.EmailPriority" + } + ] }, "reply_to": { "oneOf": [ @@ -108747,7 +126480,11 @@ ] }, "sent_date": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "subject": { "type": "string" @@ -108802,13 +126539,25 @@ "type": "object", "properties": { "http": { - "$ref": "#/components/schemas/watcher._types.HttpEmailAttachment" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.HttpEmailAttachment" + } + ] }, "reporting": { - "$ref": "#/components/schemas/watcher._types.ReportingEmailAttachment" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ReportingEmailAttachment" + } + ] }, "data": { - "$ref": "#/components/schemas/watcher._types.DataEmailAttachment" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.DataEmailAttachment" + } + ] } }, "minProperties": 1, @@ -108824,7 +126573,11 @@ "type": "boolean" }, "request": { - "$ref": "#/components/schemas/watcher._types.HttpInputRequestDefinition" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.HttpInputRequestDefinition" + } + ] } } }, @@ -108832,13 +126585,21 @@ "type": "object", "properties": { "auth": { - "$ref": "#/components/schemas/watcher._types.HttpInputAuthentication" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.HttpInputAuthentication" + } + ] }, "body": { "type": "string" }, "connection_timeout": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "headers": { "type": "object", @@ -108847,10 +126608,18 @@ } }, "host": { - "$ref": "#/components/schemas/_types.Host" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Host" + } + ] }, "method": { - "$ref": "#/components/schemas/watcher._types.HttpInputMethod" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.HttpInputMethod" + } + ] }, "params": { "type": "object", @@ -108862,16 +126631,32 @@ "type": "string" }, "port": { - "$ref": "#/components/schemas/_types.uint" + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "proxy": { - "$ref": "#/components/schemas/watcher._types.HttpInputProxy" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.HttpInputProxy" + } + ] }, "read_timeout": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "scheme": { - "$ref": "#/components/schemas/watcher._types.ConnectionScheme" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ConnectionScheme" + } + ] }, "url": { "type": "string" @@ -108882,7 +126667,11 @@ "type": "object", "properties": { "basic": { - "$ref": "#/components/schemas/watcher._types.HttpInputBasicAuthentication" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.HttpInputBasicAuthentication" + } + ] } }, "required": [ @@ -108893,10 +126682,18 @@ "type": "object", "properties": { "password": { - "$ref": "#/components/schemas/_types.Password" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Password" + } + ] }, "username": { - "$ref": "#/components/schemas/_types.Username" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Username" + } + ] } }, "required": [ @@ -108918,10 +126715,18 @@ "type": "object", "properties": { "host": { - "$ref": "#/components/schemas/_types.Host" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Host" + } + ] }, "port": { - "$ref": "#/components/schemas/_types.uint" + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] } }, "required": [ @@ -108950,10 +126755,19 @@ "type": "number" }, "interval": { - "$ref": "#/components/schemas/_types.Duration" + "default": "15s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "request": { - "$ref": "#/components/schemas/watcher._types.HttpInputRequestDefinition" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.HttpInputRequestDefinition" + } + ] } }, "required": [ @@ -108964,7 +126778,11 @@ "type": "object", "properties": { "format": { - "$ref": "#/components/schemas/watcher._types.DataAttachmentFormat" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.DataAttachmentFormat" + } + ] } } }, @@ -109010,13 +126828,22 @@ "type": "string" }, "event_type": { - "$ref": "#/components/schemas/watcher._types.PagerDutyEventType" + "default": "trigger", + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.PagerDutyEventType" + } + ] }, "incident_key": { "type": "string" }, "proxy": { - "$ref": "#/components/schemas/watcher._types.PagerDutyEventProxy" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.PagerDutyEventProxy" + } + ] } }, "required": [ @@ -109035,7 +126862,11 @@ "type": "string" }, "type": { - "$ref": "#/components/schemas/watcher._types.PagerDutyContextType" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.PagerDutyContextType" + } + ] } }, "required": [ @@ -109061,7 +126892,11 @@ "type": "object", "properties": { "host": { - "$ref": "#/components/schemas/_types.Host" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Host" + } + ] }, "port": { "type": "number" @@ -109075,7 +126910,11 @@ "type": "string" }, "message": { - "$ref": "#/components/schemas/watcher._types.SlackMessage" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.SlackMessage" + } + ] } }, "required": [ @@ -109092,7 +126931,11 @@ } }, "dynamic_attachments": { - "$ref": "#/components/schemas/watcher._types.SlackDynamicAttachment" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.SlackDynamicAttachment" + } + ] }, "from": { "type": "string" @@ -109166,7 +127009,11 @@ "type": "string" }, "ts": { - "$ref": "#/components/schemas/_types.EpochTimeUnitSeconds" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitSeconds" + } + ] } }, "required": [ @@ -109197,7 +127044,11 @@ "type": "object", "properties": { "attachment_template": { - "$ref": "#/components/schemas/watcher._types.SlackAttachment" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.SlackAttachment" + } + ] }, "list_path": { "type": "string" @@ -109222,13 +127073,25 @@ "type": "object", "properties": { "chain": { - "$ref": "#/components/schemas/watcher._types.ChainInput" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ChainInput" + } + ] }, "http": { - "$ref": "#/components/schemas/watcher._types.HttpInput" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.HttpInput" + } + ] }, "search": { - "$ref": "#/components/schemas/watcher._types.SearchInput" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.SearchInput" + } + ] }, "simple": { "type": "object", @@ -109269,10 +127132,18 @@ } }, "request": { - "$ref": "#/components/schemas/watcher._types.HttpInputRequestDefinition" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.HttpInputRequestDefinition" + } + ] }, "response_content_type": { - "$ref": "#/components/schemas/watcher._types.ResponseContentType" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ResponseContentType" + } + ] } } }, @@ -109294,10 +127165,18 @@ } }, "request": { - "$ref": "#/components/schemas/watcher._types.SearchInputRequestDefinition" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.SearchInputRequestDefinition" + } + ] }, "timeout": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } }, "required": [ @@ -109308,7 +127187,11 @@ "type": "object", "properties": { "schedule": { - "$ref": "#/components/schemas/watcher._types.ScheduleContainer" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ScheduleContainer" + } + ] } }, "minProperties": 1, @@ -109321,16 +127204,32 @@ "type": "string" }, "cron": { - "$ref": "#/components/schemas/watcher._types.CronExpression" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.CronExpression" + } + ] }, "daily": { - "$ref": "#/components/schemas/watcher._types.DailySchedule" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.DailySchedule" + } + ] }, "hourly": { - "$ref": "#/components/schemas/watcher._types.HourlySchedule" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.HourlySchedule" + } + ] }, "interval": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "monthly": { "oneOf": [ @@ -109506,10 +127405,18 @@ "type": "object", "properties": { "condition": { - "$ref": "#/components/schemas/watcher._types.ConditionContainer" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ConditionContainer" + } + ] }, "input": { - "$ref": "#/components/schemas/watcher._types.InputContainer" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.InputContainer" + } + ] }, "messages": { "type": "array", @@ -109518,28 +127425,56 @@ } }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "node": { "type": "string" }, "result": { - "$ref": "#/components/schemas/watcher._types.ExecutionResult" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ExecutionResult" + } + ] }, "state": { - "$ref": "#/components/schemas/watcher._types.ExecutionStatus" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ExecutionStatus" + } + ] }, "trigger_event": { - "$ref": "#/components/schemas/watcher._types.TriggerEventResult" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.TriggerEventResult" + } + ] }, "user": { - "$ref": "#/components/schemas/_types.Username" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Username" + } + ] }, "watch_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "status": { - "$ref": "#/components/schemas/watcher._types.WatchStatus" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.WatchStatus" + } + ] } }, "required": [ @@ -109564,16 +127499,32 @@ } }, "condition": { - "$ref": "#/components/schemas/watcher._types.ExecutionResultCondition" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ExecutionResultCondition" + } + ] }, "execution_duration": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "execution_time": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "input": { - "$ref": "#/components/schemas/watcher._types.ExecutionResultInput" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ExecutionResultInput" + } + ] } }, "required": [ @@ -109588,37 +127539,77 @@ "type": "object", "properties": { "email": { - "$ref": "#/components/schemas/watcher._types.EmailResult" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.EmailResult" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "index": { - "$ref": "#/components/schemas/watcher._types.IndexResult" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.IndexResult" + } + ] }, "logging": { - "$ref": "#/components/schemas/watcher._types.LoggingResult" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.LoggingResult" + } + ] }, "pagerduty": { - "$ref": "#/components/schemas/watcher._types.PagerDutyResult" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.PagerDutyResult" + } + ] }, "reason": { "type": "string" }, "slack": { - "$ref": "#/components/schemas/watcher._types.SlackResult" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.SlackResult" + } + ] }, "status": { - "$ref": "#/components/schemas/watcher._types.ActionStatusOptions" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ActionStatusOptions" + } + ] }, "type": { - "$ref": "#/components/schemas/watcher._types.ActionType" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ActionType" + } + ] }, "webhook": { - "$ref": "#/components/schemas/watcher._types.WebhookResult" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.WebhookResult" + } + ] }, "error": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] } }, "required": [ @@ -109634,7 +127625,11 @@ "type": "string" }, "message": { - "$ref": "#/components/schemas/watcher._types.Email" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.Email" + } + ] }, "reason": { "type": "string" @@ -109648,7 +127643,11 @@ "type": "object", "properties": { "response": { - "$ref": "#/components/schemas/watcher._types.IndexResultSummary" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.IndexResultSummary" + } + ] } }, "required": [ @@ -109662,16 +127661,32 @@ "type": "boolean" }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] } }, "required": [ @@ -109697,16 +127712,28 @@ "type": "object", "properties": { "event": { - "$ref": "#/components/schemas/watcher._types.PagerDutyEvent" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.PagerDutyEvent" + } + ] }, "reason": { "type": "string" }, "request": { - "$ref": "#/components/schemas/watcher._types.HttpInputRequestResult" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.HttpInputRequestResult" + } + ] }, "response": { - "$ref": "#/components/schemas/watcher._types.HttpInputResponseResult" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.HttpInputResponseResult" + } + ] } }, "required": [ @@ -109730,7 +127757,11 @@ "type": "string" }, "headers": { - "$ref": "#/components/schemas/_types.HttpHeaders" + "allOf": [ + { + "$ref": "#/components/schemas/_types.HttpHeaders" + } + ] }, "status": { "type": "number" @@ -109749,7 +127780,11 @@ "type": "string" }, "message": { - "$ref": "#/components/schemas/watcher._types.SlackMessage" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.SlackMessage" + } + ] } }, "required": [ @@ -109769,10 +127804,18 @@ "type": "object", "properties": { "request": { - "$ref": "#/components/schemas/watcher._types.HttpInputRequestResult" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.HttpInputRequestResult" + } + ] }, "response": { - "$ref": "#/components/schemas/watcher._types.HttpInputResponseResult" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.HttpInputResponseResult" + } + ] } }, "required": [ @@ -109786,10 +127829,18 @@ "type": "boolean" }, "status": { - "$ref": "#/components/schemas/watcher._types.ActionStatusOptions" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ActionStatusOptions" + } + ] }, "type": { - "$ref": "#/components/schemas/watcher._types.ConditionType" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ConditionType" + } + ] } }, "required": [ @@ -109818,10 +127869,18 @@ } }, "status": { - "$ref": "#/components/schemas/watcher._types.ActionStatusOptions" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ActionStatusOptions" + } + ] }, "type": { - "$ref": "#/components/schemas/watcher._types.InputType" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.InputType" + } + ] } }, "required": [ @@ -109855,10 +127914,18 @@ "type": "object", "properties": { "manual": { - "$ref": "#/components/schemas/watcher._types.TriggerEventContainer" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.TriggerEventContainer" + } + ] }, "triggered_time": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "type": { "type": "string" @@ -109874,7 +127941,11 @@ "type": "object", "properties": { "schedule": { - "$ref": "#/components/schemas/watcher._types.ScheduleTriggerEvent" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ScheduleTriggerEvent" + } + ] } }, "minProperties": 1, @@ -109884,19 +127955,35 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "status": { - "$ref": "#/components/schemas/watcher._types.WatchStatus" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.WatchStatus" + } + ] }, "watch": { - "$ref": "#/components/schemas/watcher._types.Watch" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.Watch" + } + ] }, "_primary_term": { "type": "number" }, "_seq_no": { - "$ref": "#/components/schemas/_types.SequenceNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SequenceNumber" + } + ] } }, "required": [ @@ -109924,7 +128011,11 @@ } }, "execution_thread_pool": { - "$ref": "#/components/schemas/watcher._types.ExecutionThreadPool" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ExecutionThreadPool" + } + ] }, "queued_watches": { "description": "Watcher moderates the execution of watches such that their execution won't put too much pressure on the node and its resources.\nIf too many watches trigger concurrently and there isn't enough capacity to run them all, some of the watches are queued, waiting for the current running watches to finish.s\nThe queued watches metric gives insight on these queued watches.\n\nTo include this metric, the `metric` option should include `queued_watches` or `_all`.", @@ -109938,10 +128029,19 @@ "type": "number" }, "watcher_state": { - "$ref": "#/components/schemas/watcher.stats.WatcherState" + "description": "The current state of Watcher.", + "allOf": [ + { + "$ref": "#/components/schemas/watcher.stats.WatcherState" + } + ] }, "node_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] } }, "required": [ @@ -109960,10 +128060,20 @@ "type": "object", "properties": { "execution_phase": { - "$ref": "#/components/schemas/watcher._types.ExecutionPhase" + "description": "The current watch execution phase.", + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ExecutionPhase" + } + ] }, "triggered_time": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The time the watch was triggered by the trigger engine.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "executed_actions": { "type": "array", @@ -109972,10 +128082,19 @@ } }, "watch_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "watch_record_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The watch record identifier.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] } }, "required": [ @@ -110004,7 +128123,12 @@ "type": "object", "properties": { "execution_time": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The time the watch was run.\nThis is just before the input is being run.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] } }, "required": [ @@ -110049,7 +128173,11 @@ "type": "object", "properties": { "date": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "hash": { "type": "string" @@ -110064,85 +128192,197 @@ "type": "object", "properties": { "aggregate_metric": { - "$ref": "#/components/schemas/xpack.info.Feature" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] }, "analytics": { - "$ref": "#/components/schemas/xpack.info.Feature" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] }, "ccr": { - "$ref": "#/components/schemas/xpack.info.Feature" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] }, "data_streams": { - "$ref": "#/components/schemas/xpack.info.Feature" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] }, "data_tiers": { - "$ref": "#/components/schemas/xpack.info.Feature" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] }, "enrich": { - "$ref": "#/components/schemas/xpack.info.Feature" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] }, "enterprise_search": { - "$ref": "#/components/schemas/xpack.info.Feature" + "x-state": "Generally available; Added in 8.8.0", + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] }, "eql": { - "$ref": "#/components/schemas/xpack.info.Feature" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] }, "esql": { - "$ref": "#/components/schemas/xpack.info.Feature" + "x-state": "Generally available; Added in 8.14.0", + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] }, "graph": { - "$ref": "#/components/schemas/xpack.info.Feature" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] }, "ilm": { - "$ref": "#/components/schemas/xpack.info.Feature" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] }, "logstash": { - "$ref": "#/components/schemas/xpack.info.Feature" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] }, "logsdb": { - "$ref": "#/components/schemas/xpack.info.Feature" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] }, "ml": { - "$ref": "#/components/schemas/xpack.info.Feature" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] }, "monitoring": { - "$ref": "#/components/schemas/xpack.info.Feature" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] }, "rollup": { - "$ref": "#/components/schemas/xpack.info.Feature" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] }, "runtime_fields": { - "$ref": "#/components/schemas/xpack.info.Feature" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] }, "searchable_snapshots": { - "$ref": "#/components/schemas/xpack.info.Feature" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] }, "security": { - "$ref": "#/components/schemas/xpack.info.Feature" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] }, "slm": { - "$ref": "#/components/schemas/xpack.info.Feature" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] }, "spatial": { - "$ref": "#/components/schemas/xpack.info.Feature" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] }, "sql": { - "$ref": "#/components/schemas/xpack.info.Feature" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] }, "transform": { - "$ref": "#/components/schemas/xpack.info.Feature" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] }, "universal_profiling": { - "$ref": "#/components/schemas/xpack.info.Feature" + "x-state": "Generally available; Added in 8.7.0", + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] }, "voting_only": { - "$ref": "#/components/schemas/xpack.info.Feature" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] }, "watcher": { - "$ref": "#/components/schemas/xpack.info.Feature" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] }, "archive": { - "$ref": "#/components/schemas/xpack.info.Feature" + "x-state": "Generally available; Added in 8.2.0", + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.Feature" + } + ] } }, "required": [ @@ -110187,7 +128427,11 @@ "type": "boolean" }, "native_code_info": { - "$ref": "#/components/schemas/xpack.info.NativeCodeInformation" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.info.NativeCodeInformation" + } + ] } }, "required": [ @@ -110202,7 +128446,11 @@ "type": "string" }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] } }, "required": [ @@ -110214,16 +128462,32 @@ "type": "object", "properties": { "expiry_date_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "mode": { - "$ref": "#/components/schemas/license._types.LicenseType" + "allOf": [ + { + "$ref": "#/components/schemas/license._types.LicenseType" + } + ] }, "status": { - "$ref": "#/components/schemas/license._types.LicenseStatus" + "allOf": [ + { + "$ref": "#/components/schemas/license._types.LicenseStatus" + } + ] }, "type": { - "$ref": "#/components/schemas/license._types.LicenseType" + "allOf": [ + { + "$ref": "#/components/schemas/license._types.LicenseType" + } + ] }, "uid": { "type": "string" @@ -110261,7 +128525,11 @@ "type": "object", "properties": { "stats": { - "$ref": "#/components/schemas/xpack.usage.AnalyticsStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.AnalyticsStatistics" + } + ] } }, "required": [ @@ -110339,13 +128607,25 @@ "type": "object", "properties": { "execution": { - "$ref": "#/components/schemas/xpack.usage.WatcherActions" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.WatcherActions" + } + ] }, "watch": { - "$ref": "#/components/schemas/xpack.usage.WatcherWatch" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.WatcherWatch" + } + ] }, "count": { - "$ref": "#/components/schemas/xpack.usage.Counter" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Counter" + } + ] } }, "required": [ @@ -110374,10 +128654,18 @@ "type": "object", "properties": { "total": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "total_time_in_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } }, "required": [ @@ -110407,7 +128695,11 @@ } }, "trigger": { - "$ref": "#/components/schemas/xpack.usage.WatcherWatchTrigger" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.WatcherWatchTrigger" + } + ] } }, "required": [ @@ -110434,10 +128726,18 @@ "type": "object", "properties": { "schedule": { - "$ref": "#/components/schemas/xpack.usage.WatcherWatchTriggerSchedule" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.WatcherWatchTriggerSchedule" + } + ] }, "_all": { - "$ref": "#/components/schemas/xpack.usage.Counter" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Counter" + } + ] } }, "required": [ @@ -110453,10 +128753,18 @@ "type": "object", "properties": { "cron": { - "$ref": "#/components/schemas/xpack.usage.Counter" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Counter" + } + ] }, "_all": { - "$ref": "#/components/schemas/xpack.usage.Counter" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Counter" + } + ] } }, "required": [ @@ -110519,19 +128827,40 @@ "type": "object", "properties": { "data_warm": { - "$ref": "#/components/schemas/xpack.usage.DataTierPhaseStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.DataTierPhaseStatistics" + } + ] }, "data_frozen": { - "$ref": "#/components/schemas/xpack.usage.DataTierPhaseStatistics" + "x-state": "Generally available; Added in 7.13.0", + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.DataTierPhaseStatistics" + } + ] }, "data_cold": { - "$ref": "#/components/schemas/xpack.usage.DataTierPhaseStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.DataTierPhaseStatistics" + } + ] }, "data_content": { - "$ref": "#/components/schemas/xpack.usage.DataTierPhaseStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.DataTierPhaseStatistics" + } + ] }, "data_hot": { - "$ref": "#/components/schemas/xpack.usage.DataTierPhaseStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.DataTierPhaseStatistics" + } + ] } }, "required": [ @@ -110599,7 +128928,11 @@ "type": "object", "properties": { "features": { - "$ref": "#/components/schemas/xpack.usage.EqlFeatures" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.EqlFeatures" + } + ] }, "queries": { "type": "object", @@ -110619,25 +128952,53 @@ "type": "object", "properties": { "join": { - "$ref": "#/components/schemas/_types.uint" + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "joins": { - "$ref": "#/components/schemas/xpack.usage.EqlFeaturesJoin" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.EqlFeaturesJoin" + } + ] }, "keys": { - "$ref": "#/components/schemas/xpack.usage.EqlFeaturesKeys" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.EqlFeaturesKeys" + } + ] }, "event": { - "$ref": "#/components/schemas/_types.uint" + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "pipes": { - "$ref": "#/components/schemas/xpack.usage.EqlFeaturesPipes" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.EqlFeaturesPipes" + } + ] }, "sequence": { - "$ref": "#/components/schemas/_types.uint" + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "sequences": { - "$ref": "#/components/schemas/xpack.usage.EqlFeaturesSequences" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.EqlFeaturesSequences" + } + ] } }, "required": [ @@ -110654,19 +129015,39 @@ "type": "object", "properties": { "join_queries_two": { - "$ref": "#/components/schemas/_types.uint" + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "join_queries_three": { - "$ref": "#/components/schemas/_types.uint" + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "join_until": { - "$ref": "#/components/schemas/_types.uint" + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "join_queries_five_or_more": { - "$ref": "#/components/schemas/_types.uint" + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "join_queries_four": { - "$ref": "#/components/schemas/_types.uint" + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] } }, "required": [ @@ -110681,19 +129062,39 @@ "type": "object", "properties": { "join_keys_two": { - "$ref": "#/components/schemas/_types.uint" + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "join_keys_one": { - "$ref": "#/components/schemas/_types.uint" + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "join_keys_three": { - "$ref": "#/components/schemas/_types.uint" + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "join_keys_five_or_more": { - "$ref": "#/components/schemas/_types.uint" + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "join_keys_four": { - "$ref": "#/components/schemas/_types.uint" + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] } }, "required": [ @@ -110708,10 +129109,18 @@ "type": "object", "properties": { "pipe_tail": { - "$ref": "#/components/schemas/_types.uint" + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "pipe_head": { - "$ref": "#/components/schemas/_types.uint" + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] } }, "required": [ @@ -110723,22 +129132,46 @@ "type": "object", "properties": { "sequence_queries_three": { - "$ref": "#/components/schemas/_types.uint" + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "sequence_queries_four": { - "$ref": "#/components/schemas/_types.uint" + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "sequence_queries_two": { - "$ref": "#/components/schemas/_types.uint" + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "sequence_until": { - "$ref": "#/components/schemas/_types.uint" + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "sequence_queries_five_or_more": { - "$ref": "#/components/schemas/_types.uint" + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "sequence_maxspan": { - "$ref": "#/components/schemas/_types.uint" + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] } }, "required": [ @@ -110794,7 +129227,11 @@ "type": "object", "properties": { "invocations": { - "$ref": "#/components/schemas/xpack.usage.Invocations" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Invocations" + } + ] } }, "required": [ @@ -110839,7 +129276,11 @@ "type": "number" }, "phases": { - "$ref": "#/components/schemas/xpack.usage.Phases" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Phases" + } + ] } }, "required": [ @@ -110851,19 +129292,39 @@ "type": "object", "properties": { "cold": { - "$ref": "#/components/schemas/xpack.usage.Phase" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Phase" + } + ] }, "delete": { - "$ref": "#/components/schemas/xpack.usage.Phase" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Phase" + } + ] }, "frozen": { - "$ref": "#/components/schemas/xpack.usage.Phase" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Phase" + } + ] }, "hot": { - "$ref": "#/components/schemas/xpack.usage.Phase" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Phase" + } + ] }, "warm": { - "$ref": "#/components/schemas/xpack.usage.Phase" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Phase" + } + ] } } }, @@ -110877,7 +129338,11 @@ } }, "min_age": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } }, "required": [ @@ -110910,10 +129375,18 @@ "type": "number" }, "data_frame_analytics_jobs": { - "$ref": "#/components/schemas/xpack.usage.MlDataFrameAnalyticsJobs" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.MlDataFrameAnalyticsJobs" + } + ] }, "inference": { - "$ref": "#/components/schemas/xpack.usage.MlInference" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.MlInference" + } + ] } }, "required": [ @@ -110950,13 +129423,25 @@ } }, "detectors": { - "$ref": "#/components/schemas/ml._types.JobStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobStatistics" + } + ] }, "forecasts": { - "$ref": "#/components/schemas/xpack.usage.MlJobForecasts" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.MlJobForecasts" + } + ] }, "model_size": { - "$ref": "#/components/schemas/ml._types.JobStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobStatistics" + } + ] } }, "required": [ @@ -110986,16 +129471,32 @@ "type": "object", "properties": { "memory_usage": { - "$ref": "#/components/schemas/xpack.usage.MlDataFrameAnalyticsJobsMemory" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.MlDataFrameAnalyticsJobsMemory" + } + ] }, "_all": { - "$ref": "#/components/schemas/xpack.usage.MlDataFrameAnalyticsJobsCount" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.MlDataFrameAnalyticsJobsCount" + } + ] }, "analysis_counts": { - "$ref": "#/components/schemas/xpack.usage.MlDataFrameAnalyticsJobsAnalysis" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.MlDataFrameAnalyticsJobsAnalysis" + } + ] }, "stopped": { - "$ref": "#/components/schemas/xpack.usage.MlDataFrameAnalyticsJobsCount" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.MlDataFrameAnalyticsJobsCount" + } + ] } }, "required": [ @@ -111006,7 +129507,11 @@ "type": "object", "properties": { "peak_usage_bytes": { - "$ref": "#/components/schemas/ml._types.JobStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobStatistics" + } + ] } }, "required": [ @@ -111048,10 +129553,19 @@ } }, "trained_models": { - "$ref": "#/components/schemas/xpack.usage.MlInferenceTrainedModels" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.MlInferenceTrainedModels" + } + ] }, "deployments": { - "$ref": "#/components/schemas/xpack.usage.MlInferenceDeployments" + "x-state": "Generally available; Added in 8.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.MlInferenceDeployments" + } + ] } }, "required": [ @@ -111063,16 +129577,32 @@ "type": "object", "properties": { "num_docs_processed": { - "$ref": "#/components/schemas/xpack.usage.MlInferenceIngestProcessorCount" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.MlInferenceIngestProcessorCount" + } + ] }, "pipelines": { - "$ref": "#/components/schemas/xpack.usage.MlCounter" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.MlCounter" + } + ] }, "num_failures": { - "$ref": "#/components/schemas/xpack.usage.MlInferenceIngestProcessorCount" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.MlInferenceIngestProcessorCount" + } + ] }, "time_ms": { - "$ref": "#/components/schemas/xpack.usage.MlInferenceIngestProcessorCount" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.MlInferenceIngestProcessorCount" + } + ] } }, "required": [ @@ -111116,19 +129646,40 @@ "type": "object", "properties": { "estimated_operations": { - "$ref": "#/components/schemas/ml._types.JobStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobStatistics" + } + ] }, "estimated_heap_memory_usage_bytes": { - "$ref": "#/components/schemas/ml._types.JobStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobStatistics" + } + ] }, "count": { - "$ref": "#/components/schemas/xpack.usage.MlInferenceTrainedModelsCount" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.MlInferenceTrainedModelsCount" + } + ] }, "_all": { - "$ref": "#/components/schemas/xpack.usage.MlCounter" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.MlCounter" + } + ] }, "model_size_bytes": { - "$ref": "#/components/schemas/ml._types.JobStatistics" + "x-state": "Generally available; Added in 8.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobStatistics" + } + ] } }, "required": [ @@ -111176,13 +129727,25 @@ "type": "number" }, "inference_counts": { - "$ref": "#/components/schemas/ml._types.JobStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobStatistics" + } + ] }, "model_sizes_bytes": { - "$ref": "#/components/schemas/ml._types.JobStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobStatistics" + } + ] }, "time_ms": { - "$ref": "#/components/schemas/xpack.usage.MlInferenceDeploymentsTimeMs" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.MlInferenceDeploymentsTimeMs" + } + ] } }, "required": [ @@ -111283,7 +129846,11 @@ "type": "number" }, "name": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "scriptless_count": { "type": "number" @@ -111348,19 +129915,39 @@ "type": "object", "properties": { "api_key_service": { - "$ref": "#/components/schemas/xpack.usage.FeatureToggle" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.FeatureToggle" + } + ] }, "anonymous": { - "$ref": "#/components/schemas/xpack.usage.FeatureToggle" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.FeatureToggle" + } + ] }, "audit": { - "$ref": "#/components/schemas/xpack.usage.Audit" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Audit" + } + ] }, "fips_140": { - "$ref": "#/components/schemas/xpack.usage.FeatureToggle" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.FeatureToggle" + } + ] }, "ipfilter": { - "$ref": "#/components/schemas/xpack.usage.IpFilter" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.IpFilter" + } + ] }, "realms": { "type": "object", @@ -111375,19 +129962,39 @@ } }, "roles": { - "$ref": "#/components/schemas/xpack.usage.SecurityRoles" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.SecurityRoles" + } + ] }, "ssl": { - "$ref": "#/components/schemas/xpack.usage.Ssl" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Ssl" + } + ] }, "system_key": { - "$ref": "#/components/schemas/xpack.usage.FeatureToggle" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.FeatureToggle" + } + ] }, "token_service": { - "$ref": "#/components/schemas/xpack.usage.FeatureToggle" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.FeatureToggle" + } + ] }, "operator_privileges": { - "$ref": "#/components/schemas/xpack.usage.Base" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.Base" + } + ] } }, "required": [ @@ -111540,13 +130147,25 @@ "type": "object", "properties": { "native": { - "$ref": "#/components/schemas/xpack.usage.SecurityRolesNative" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.SecurityRolesNative" + } + ] }, "dls": { - "$ref": "#/components/schemas/xpack.usage.SecurityRolesDls" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.SecurityRolesDls" + } + ] }, "file": { - "$ref": "#/components/schemas/xpack.usage.SecurityRolesFile" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.SecurityRolesFile" + } + ] } }, "required": [ @@ -111578,7 +130197,11 @@ "type": "object", "properties": { "bit_set_cache": { - "$ref": "#/components/schemas/xpack.usage.SecurityRolesDlsBitSetCache" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.SecurityRolesDlsBitSetCache" + } + ] } }, "required": [ @@ -111592,10 +130215,18 @@ "type": "number" }, "memory": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "memory_in_bytes": { - "$ref": "#/components/schemas/_types.ulong" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ulong" + } + ] } }, "required": [ @@ -111626,10 +130257,18 @@ "type": "object", "properties": { "http": { - "$ref": "#/components/schemas/xpack.usage.FeatureToggle" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.FeatureToggle" + } + ] }, "transport": { - "$ref": "#/components/schemas/xpack.usage.FeatureToggle" + "allOf": [ + { + "$ref": "#/components/schemas/xpack.usage.FeatureToggle" + } + ] } }, "required": [ @@ -111649,7 +130288,11 @@ "type": "number" }, "policy_stats": { - "$ref": "#/components/schemas/slm._types.Statistics" + "allOf": [ + { + "$ref": "#/components/schemas/slm._types.Statistics" + } + ] } } } @@ -112217,19 +130860,39 @@ "type": "string" }, "allocation_delay": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "allocation_delay_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "can_allocate": { - "$ref": "#/components/schemas/cluster.allocation_explain.Decision" + "allOf": [ + { + "$ref": "#/components/schemas/cluster.allocation_explain.Decision" + } + ] }, "can_move_to_other_node": { - "$ref": "#/components/schemas/cluster.allocation_explain.Decision" + "allOf": [ + { + "$ref": "#/components/schemas/cluster.allocation_explain.Decision" + } + ] }, "can_rebalance_cluster": { - "$ref": "#/components/schemas/cluster.allocation_explain.Decision" + "allOf": [ + { + "$ref": "#/components/schemas/cluster.allocation_explain.Decision" + } + ] }, "can_rebalance_cluster_decisions": { "type": "array", @@ -112238,7 +130901,11 @@ } }, "can_rebalance_to_other_node": { - "$ref": "#/components/schemas/cluster.allocation_explain.Decision" + "allOf": [ + { + "$ref": "#/components/schemas/cluster.allocation_explain.Decision" + } + ] }, "can_remain_decisions": { "type": "array", @@ -112247,25 +130914,49 @@ } }, "can_remain_on_current_node": { - "$ref": "#/components/schemas/cluster.allocation_explain.Decision" + "allOf": [ + { + "$ref": "#/components/schemas/cluster.allocation_explain.Decision" + } + ] }, "cluster_info": { - "$ref": "#/components/schemas/cluster.allocation_explain.ClusterInfo" + "allOf": [ + { + "$ref": "#/components/schemas/cluster.allocation_explain.ClusterInfo" + } + ] }, "configured_delay": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "configured_delay_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "current_node": { - "$ref": "#/components/schemas/cluster.allocation_explain.CurrentNode" + "allOf": [ + { + "$ref": "#/components/schemas/cluster.allocation_explain.CurrentNode" + } + ] }, "current_state": { "type": "string" }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "move_explanation": { "type": "string" @@ -112283,16 +130974,28 @@ "type": "string" }, "remaining_delay": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "remaining_delay_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "shard": { "type": "number" }, "unassigned_info": { - "$ref": "#/components/schemas/cluster.allocation_explain.UnassignedInformation" + "allOf": [ + { + "$ref": "#/components/schemas/cluster.allocation_explain.UnassignedInformation" + } + ] }, "note": { "x-state": "Generally available; Added in 7.14.0", @@ -112396,10 +131099,18 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] } }, "required": [ @@ -112426,7 +131137,11 @@ "type": "number" }, "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] } }, "required": [ @@ -112505,19 +131220,35 @@ "type": "object", "properties": { "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "matched": { "type": "boolean" }, "explanation": { - "$ref": "#/components/schemas/_global.explain.ExplanationDetail" + "allOf": [ + { + "$ref": "#/components/schemas/_global.explain.ExplanationDetail" + } + ] }, "get": { - "$ref": "#/components/schemas/_types.InlineGet" + "allOf": [ + { + "$ref": "#/components/schemas/_types.InlineGet" + } + ] } }, "required": [ @@ -112543,7 +131274,12 @@ "type": "object", "properties": { "indices": { - "$ref": "#/components/schemas/_types.Indices" + "description": "The list of indices where this field has the same type family, or null if all indices have the same type family for the field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "fields": { "type": "object", @@ -112610,10 +131346,18 @@ "type": "boolean" }, "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] }, "hits": { - "$ref": "#/components/schemas/_global.search._types.HitsMetadata" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.HitsMetadata" + } + ] }, "aggregations": { "type": "object", @@ -112622,7 +131366,11 @@ } }, "_clusters": { - "$ref": "#/components/schemas/_types.ClusterStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ClusterStatistics" + } + ] }, "fields": { "type": "object", @@ -112637,13 +131385,25 @@ "type": "number" }, "profile": { - "$ref": "#/components/schemas/_global.search._types.Profile" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.Profile" + } + ] }, "pit_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_scroll_id": { - "$ref": "#/components/schemas/_types.ScrollId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScrollId" + } + ] }, "suggest": { "type": "object", @@ -112722,10 +131482,18 @@ "type": "string" }, "indicators": { - "$ref": "#/components/schemas/_global.health_report.Indicators" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.Indicators" + } + ] }, "status": { - "$ref": "#/components/schemas/_global.health_report.IndicatorHealthStatus" + "allOf": [ + { + "$ref": "#/components/schemas/_global.health_report.IndicatorHealthStatus" + } + ] } }, "required": [ @@ -112785,7 +131553,11 @@ "type": "object", "properties": { "detail": { - "$ref": "#/components/schemas/indices.analyze.AnalyzeDetail" + "allOf": [ + { + "$ref": "#/components/schemas/indices.analyze.AnalyzeDetail" + } + ] }, "tokens": { "type": "array", @@ -112825,7 +131597,11 @@ "type": "boolean" }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "shards_acknowledged": { "type": "boolean" @@ -112851,7 +131627,11 @@ "type": "boolean" }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "shards_acknowledged": { "type": "boolean" @@ -112874,7 +131654,12 @@ "type": "object", "properties": { "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "description": "Contains information about shards that attempted to execute the request.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] }, "backing_indices": { "description": "Total number of backing indices for the selected data streams.", @@ -112892,7 +131677,12 @@ } }, "total_store_sizes": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "Total size of all shards for the selected data streams.\nThis property is included only if the `human` query parameter is `true`", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "total_store_size_bytes": { "description": "Total size, in bytes, of all shards for the selected data streams.", @@ -113267,7 +132057,11 @@ } }, "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] } }, "required": [ @@ -113325,7 +132119,11 @@ "type": "boolean" }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] } }, "required": [ @@ -113351,7 +132149,11 @@ } }, "template": { - "$ref": "#/components/schemas/indices.simulate_template.Template" + "allOf": [ + { + "$ref": "#/components/schemas/indices.simulate_template.Template" + } + ] } }, "required": [ @@ -113381,7 +132183,11 @@ "type": "boolean" }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] } }, "required": [ @@ -113407,10 +132213,18 @@ } }, "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] }, "_all": { - "$ref": "#/components/schemas/indices.stats.IndicesStats" + "allOf": [ + { + "$ref": "#/components/schemas/indices.stats.IndicesStats" + } + ] } }, "required": [ @@ -113435,7 +132249,11 @@ } }, "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] }, "valid": { "type": "boolean" @@ -113608,13 +132426,21 @@ "type": "object", "properties": { "acknowledge": { - "$ref": "#/components/schemas/license.post.Acknowledgement" + "allOf": [ + { + "$ref": "#/components/schemas/license.post.Acknowledgement" + } + ] }, "acknowledged": { "type": "boolean" }, "license_status": { - "$ref": "#/components/schemas/license._types.LicenseStatus" + "allOf": [ + { + "$ref": "#/components/schemas/license._types.LicenseStatus" + } + ] } }, "required": [ @@ -113814,7 +132640,12 @@ } }, "memory_estimation": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsMemoryEstimation" + "description": "An array of objects that explain selection for each field, sorted by the field names.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsMemoryEstimation" + } + ] } }, "required": [ @@ -114117,10 +132948,18 @@ "type": "object", "properties": { "_nodes": { - "$ref": "#/components/schemas/_types.NodeStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeStatistics" + } + ] }, "cluster_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "nodes": { "type": "object", @@ -114536,10 +133375,18 @@ "type": "boolean" }, "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] }, "hits": { - "$ref": "#/components/schemas/_global.search._types.HitsMetadata" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.HitsMetadata" + } + ] }, "aggregations": { "type": "object", @@ -114728,10 +133575,18 @@ "type": "boolean" }, "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] }, "hits": { - "$ref": "#/components/schemas/_global.search._types.HitsMetadata" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.HitsMetadata" + } + ] }, "aggregations": { "type": "object", @@ -114740,7 +133595,11 @@ } }, "_clusters": { - "$ref": "#/components/schemas/_types.ClusterStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ClusterStatistics" + } + ] }, "fields": { "type": "object", @@ -114755,13 +133614,25 @@ "type": "number" }, "profile": { - "$ref": "#/components/schemas/_global.search._types.Profile" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.Profile" + } + ] }, "pit_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_scroll_id": { - "$ref": "#/components/schemas/_types.ScrollId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScrollId" + } + ] }, "suggest": { "type": "object", @@ -114871,10 +133742,20 @@ "type": "number" }, "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Unique ID for this API key.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "Specifies the name for this API key.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "encoded": { "description": "API key credentials which is the base64-encoding of\nthe UTF-8 representation of `id` and `api_key` joined\nby a colon (`:`).", @@ -114909,7 +133790,11 @@ "type": "boolean" }, "token": { - "$ref": "#/components/schemas/security.create_service_token.Token" + "allOf": [ + { + "$ref": "#/components/schemas/security.create_service_token.Token" + } + ] } }, "required": [ @@ -115072,7 +133957,11 @@ "type": "object", "properties": { "application": { - "$ref": "#/components/schemas/security.has_privileges.ApplicationsPrivileges" + "allOf": [ + { + "$ref": "#/components/schemas/security.has_privileges.ApplicationsPrivileges" + } + ] }, "cluster": { "type": "object", @@ -115090,7 +133979,11 @@ } }, "username": { - "$ref": "#/components/schemas/_types.Username" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Username" + } + ] } }, "required": [ @@ -115125,7 +134018,12 @@ } }, "errors": { - "$ref": "#/components/schemas/security.has_privileges_user_profile.HasPrivilegesUserProfileErrors" + "description": "The subset of the requested profile IDs for which an error\nwas encountered. It does not include the missing profile IDs\nor the profile IDs of the users that do not have all the\nrequested privileges. This field is absent if empty.", + "allOf": [ + { + "$ref": "#/components/schemas/security.has_privileges_user_profile.HasPrivilegesUserProfileErrors" + } + ] } }, "required": [ @@ -115175,7 +134073,12 @@ "type": "object", "properties": { "role": { - "$ref": "#/components/schemas/security._types.CreatedStatus" + "description": "When an existing role is updated, `created` is set to `false`.", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.CreatedStatus" + } + ] } }, "required": [ @@ -115202,7 +134105,11 @@ "type": "boolean" }, "role_mapping": { - "$ref": "#/components/schemas/security._types.CreatedStatus" + "allOf": [ + { + "$ref": "#/components/schemas/security._types.CreatedStatus" + } + ] } }, "required": [ @@ -115400,7 +134307,12 @@ "type": "object", "properties": { "total": { - "$ref": "#/components/schemas/security.suggest_user_profiles.TotalUserProfiles" + "description": "Metadata about the number of matching profiles.", + "allOf": [ + { + "$ref": "#/components/schemas/security.suggest_user_profiles.TotalUserProfiles" + } + ] }, "took": { "description": "The number of milliseconds it took Elasticsearch to run the request.", @@ -115542,7 +134454,12 @@ "type": "boolean" }, "snapshot": { - "$ref": "#/components/schemas/snapshot._types.SnapshotInfo" + "description": "Snapshot information. Present when the request had `wait_for_completion` set to `true`", + "allOf": [ + { + "$ref": "#/components/schemas/snapshot._types.SnapshotInfo" + } + ] } } }, @@ -115636,7 +134553,12 @@ "type": "string" }, "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The identifier for the search.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-ID` HTTP header.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "is_running": { "description": "If `true`, the search is still running.\nIf `false`, the search has finished.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header.", @@ -115678,7 +134600,11 @@ "type": "number" }, "_source": { - "$ref": "#/components/schemas/_global.search._types.SourceConfig" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.SourceConfig" + } + ] }, "fields": { "type": "array", @@ -115687,10 +134613,18 @@ } }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] } } } @@ -115715,7 +134649,11 @@ "type": "object", "properties": { "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] }, "terms": { "type": "array", @@ -115754,10 +134692,18 @@ "type": "boolean" }, "_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "term_vectors": { "type": "object", @@ -115769,7 +134715,11 @@ "type": "number" }, "_version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] } }, "required": [ @@ -115810,7 +134760,11 @@ "type": "string" }, "ecs_compatibility": { - "$ref": "#/components/schemas/text_structure._types.EcsCompatibilityType" + "allOf": [ + { + "$ref": "#/components/schemas/text_structure._types.EcsCompatibilityType" + } + ] }, "field_stats": { "type": "object", @@ -115819,10 +134773,18 @@ } }, "format": { - "$ref": "#/components/schemas/text_structure._types.FormatType" + "allOf": [ + { + "$ref": "#/components/schemas/text_structure._types.FormatType" + } + ] }, "grok_pattern": { - "$ref": "#/components/schemas/_types.GrokPattern" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GrokPattern" + } + ] }, "java_timestamp_formats": { "type": "array", @@ -115837,10 +134799,18 @@ } }, "ingest_pipeline": { - "$ref": "#/components/schemas/ingest._types.PipelineConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.PipelineConfig" + } + ] }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "multiline_start_pattern": { "type": "string" @@ -115858,7 +134828,11 @@ "type": "string" }, "timestamp_field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -115948,7 +134922,11 @@ "type": "object", "properties": { "generated_dest_index": { - "$ref": "#/components/schemas/indices._types.IndexState" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexState" + } + ] }, "preview": { "type": "array", @@ -115979,7 +134957,11 @@ "type": "object", "properties": { "status": { - "$ref": "#/components/schemas/watcher._types.WatchStatus" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.WatchStatus" + } + ] } }, "required": [ @@ -116003,7 +134985,11 @@ "type": "object", "properties": { "status": { - "$ref": "#/components/schemas/watcher._types.ActivationStatus" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ActivationStatus" + } + ] } }, "required": [ @@ -116021,7 +135007,11 @@ "type": "object", "properties": { "status": { - "$ref": "#/components/schemas/watcher._types.ActivationStatus" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ActivationStatus" + } + ] } }, "required": [ @@ -116039,10 +135029,20 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The watch record identifier as it would be stored in the `.watcher-history` index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "watch_record": { - "$ref": "#/components/schemas/watcher.execute_watch.WatchRecord" + "description": "The watch record document as it would be stored in the `.watcher-history` index.", + "allOf": [ + { + "$ref": "#/components/schemas/watcher.execute_watch.WatchRecord" + } + ] } }, "required": [ @@ -116070,16 +135070,28 @@ "type": "boolean" }, "_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_primary_term": { "type": "number" }, "_seq_no": { - "$ref": "#/components/schemas/_types.SequenceNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SequenceNumber" + } + ] }, "_version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] } }, "required": [ @@ -116134,10 +135146,18 @@ "type": "object", "properties": { "_nodes": { - "$ref": "#/components/schemas/_types.NodeStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeStatistics" + } + ] }, "cluster_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "manually_stopped": { "type": "boolean" @@ -126234,7 +145254,11 @@ } }, "collapse": { - "$ref": "#/components/schemas/_global.search._types.FieldCollapse" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.FieldCollapse" + } + ] }, "explain": { "description": "If true, returns detailed information about score computation as part of a hit.", @@ -126254,10 +145278,19 @@ "type": "number" }, "highlight": { - "$ref": "#/components/schemas/_global.search._types.Highlight" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.Highlight" + } + ] }, "track_total_hits": { - "$ref": "#/components/schemas/_global.search._types.TrackHits" + "description": "Number of hits matching the query to count accurately. If true, the exact\nnumber of hits is returned at the cost of some performance. If false, the\nresponse does not include the total number of hits matching the query.\nDefaults to 10,000 hits.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.TrackHits" + } + ] }, "indices_boost": { "description": "Boosts the _score of documents from specified indices.", @@ -126298,13 +145331,22 @@ "type": "number" }, "post_filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "profile": { "type": "boolean" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Defines the search definition using the Query DSL.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "rescore": { "oneOf": [ @@ -126327,7 +145369,11 @@ } }, "search_after": { - "$ref": "#/components/schemas/_types.SortResults" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortResults" + } + ] }, "size": { "description": "The number of hits to return. By default, you cannot page through more\nthan 10,000 hits using the from and size parameters. To page through more\nhits, use the search_after parameter.", @@ -126335,13 +145381,26 @@ "type": "number" }, "slice": { - "$ref": "#/components/schemas/_types.SlicedScroll" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SlicedScroll" + } + ] }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] }, "_source": { - "$ref": "#/components/schemas/_global.search._types.SourceConfig" + "description": "Indicates which source fields are returned for matching documents. These\nfields are returned in the hits._source property of the search response.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.SourceConfig" + } + ] }, "fields": { "description": "Array of wildcard (*) patterns. The request returns values for field names\nmatching these patterns in the hits.fields property of the response.", @@ -126351,7 +145410,11 @@ } }, "suggest": { - "$ref": "#/components/schemas/_global.search._types.Suggester" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.Suggester" + } + ] }, "terminate_after": { "description": "Maximum number of documents to collect for each shard. If a query reaches this\nlimit, Elasticsearch terminates the query early. Elasticsearch collects documents\nbefore sorting. Defaults to 0, which does not terminate query execution early.", @@ -126377,13 +145440,28 @@ "type": "boolean" }, "stored_fields": { - "$ref": "#/components/schemas/_types.Fields" + "description": "List of stored fields to return as part of a hit. If no fields are specified,\nno stored fields are included in the response. If this field is specified, the _source\nparameter defaults to false. You can pass _source: true to return both source fields\nand stored fields in the search response.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "pit": { - "$ref": "#/components/schemas/_global.search._types.PointInTimeReference" + "description": "Limits the search to a point in time (PIT). If you provide a PIT, you\ncannot specify an in the request path.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.PointInTimeReference" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "description": "Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "stats": { "description": "Stats groups to associate with the search. Each group maintains a statistics\naggregation for its associated searches. You can retrieve these stats using\nthe indices stats API.", @@ -126455,7 +145533,12 @@ "type": "object", "properties": { "scroll_id": { - "$ref": "#/components/schemas/_types.ScrollIds" + "description": "The scroll IDs to clear.\nTo clear all scroll IDs, use `_all`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScrollIds" + } + ] } } }, @@ -126475,7 +145558,12 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The name of the index that you would like an explanation for.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "shard": { "description": "An identifier for the shard that you would like an explanation for.", @@ -126486,7 +145574,12 @@ "type": "boolean" }, "current_node": { - "$ref": "#/components/schemas/_types.NodeId" + "description": "Explain a shard only if it is currently located on the specified node name or node ID.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] } } }, @@ -126512,13 +145605,28 @@ "type": "object", "properties": { "template": { - "$ref": "#/components/schemas/indices._types.IndexState" + "description": "The template to be applied which includes mappings, settings, or aliases configuration.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexState" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "Version number used to manage component templates externally.\nThis number isn't automatically generated or incremented by Elasticsearch.\nTo unset a version, replace the template without specifying a version.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Optional user metadata about the component template.\nIt may have any contents. This map is not automatically generated by Elasticsearch.\nThis information is stored in the cluster state, so keeping it short is preferable.\nTo unset `_meta`, replace the template without specifying this information.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "deprecated": { "description": "Marks this index template as deprecated. When creating or updating a non-deprecated index template\nthat uses deprecated components, Elasticsearch will emit a deprecation warning.", @@ -126554,7 +145662,11 @@ "type": "string" }, "index_name": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "is_native": { "type": "boolean" @@ -126588,7 +145700,12 @@ "type": "object", "properties": { "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Defines the search query using Query DSL. A request body query cannot be used\nwith the `q` query string parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } } }, @@ -126631,16 +145748,38 @@ "type": "boolean" }, "event_category_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing the event classification, such as process, file, or network.", + "default": "event.category", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "tiebreaker_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field used to sort hits with the same timestamp in ascending order", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "timestamp_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing event timestamp. Default \"@timestamp\"", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "fetch_size": { - "$ref": "#/components/schemas/_types.uint" + "description": "Maximum number of events to search at a time for sequence queries.", + "default": 1000.0, + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "filter": { "description": "Query, written in Query DSL, used to filter the events on which the EQL query runs.", @@ -126657,13 +145796,21 @@ ] }, "keep_alive": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "keep_on_completion": { "type": "boolean" }, "wait_for_completion_timeout": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "allow_partial_search_results": { "description": "Allow query execution also in case of shard failures.\nIf true, the query will keep running and will return results based on the available shards.\nFor sequences, the behavior can be further refined using allow_partial_sequence_results", @@ -126676,7 +145823,12 @@ "type": "boolean" }, "size": { - "$ref": "#/components/schemas/_types.uint" + "description": "For basic queries, the maximum number of matching events to return. Defaults to 10", + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "fields": { "description": "Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit.", @@ -126693,10 +145845,20 @@ ] }, "result_position": { - "$ref": "#/components/schemas/eql.search.ResultPosition" + "default": "tail", + "allOf": [ + { + "$ref": "#/components/schemas/eql.search.ResultPosition" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "x-state": "Generally available; Added in 8.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "max_samples_per_key": { "description": "By default, the response of a sample query contains up to `10` samples, with one sample per unique set of join keys. Use the `size`\nparameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the\n`max_samples_per_key` parameter. Pipes are not supported for sample queries.", @@ -126731,7 +145893,12 @@ "type": "object", "properties": { "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Defines the search definition using the Query DSL.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } } }, @@ -126751,13 +145918,30 @@ "type": "object", "properties": { "fields": { - "$ref": "#/components/schemas/_types.Fields" + "description": "A list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported.", + "x-state": "Generally available; Added in 8.5.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "index_filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Filter indices if the provided query rewrites to `match_none` on every shard.\n\nIMPORTANT: The filtering is done on a best-effort basis, it uses index statistics and mappings to rewrite queries to `match_none` instead of fully running the request.\nFor instance a range query over a date field can rewrite to `match_none` if all documents within a shard (including deleted documents) are outside of the provided range.\nHowever, not all queries can rewrite to `match_none` so this API may return an index even if the provided filter matches no document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "description": "Define ad-hoc runtime fields in the request similar to the way it is done in search requests.\nThese fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings.", + "x-state": "Generally available; Added in 7.12.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] } } }, @@ -126796,7 +145980,11 @@ } }, "collapse": { - "$ref": "#/components/schemas/_global.search._types.FieldCollapse" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.FieldCollapse" + } + ] }, "explain": { "description": "If true, returns detailed information about score computation as part of a hit.", @@ -126816,10 +146004,19 @@ "type": "number" }, "highlight": { - "$ref": "#/components/schemas/_global.search._types.Highlight" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.Highlight" + } + ] }, "track_total_hits": { - "$ref": "#/components/schemas/_global.search._types.TrackHits" + "description": "Number of hits matching the query to count accurately. If true, the exact\nnumber of hits is returned at the cost of some performance. If false, the\nresponse does not include the total number of hits matching the query.\nDefaults to 10,000 hits.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.TrackHits" + } + ] }, "indices_boost": { "description": "Boosts the _score of documents from specified indices.", @@ -126845,13 +146042,22 @@ "type": "number" }, "post_filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "profile": { "type": "boolean" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Defines the search definition using the Query DSL.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "rescore": { "oneOf": [ @@ -126874,7 +146080,11 @@ } }, "search_after": { - "$ref": "#/components/schemas/_types.SortResults" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortResults" + } + ] }, "size": { "description": "The number of hits to return. By default, you cannot page through more\nthan 10,000 hits using the from and size parameters. To page through more\nhits, use the search_after parameter.", @@ -126882,13 +146092,26 @@ "type": "number" }, "slice": { - "$ref": "#/components/schemas/_types.SlicedScroll" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SlicedScroll" + } + ] }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] }, "_source": { - "$ref": "#/components/schemas/_global.search._types.SourceConfig" + "description": "Indicates which source fields are returned for matching documents. These\nfields are returned in the hits._source property of the search response.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.SourceConfig" + } + ] }, "fields": { "description": "Array of wildcard (*) patterns. The request returns values for field names\nmatching these patterns in the hits.fields property of the response.", @@ -126898,7 +146121,11 @@ } }, "suggest": { - "$ref": "#/components/schemas/_global.search._types.Suggester" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.Suggester" + } + ] }, "terminate_after": { "description": "Maximum number of documents to collect for each shard. If a query reaches this\nlimit, Elasticsearch terminates the query early. Elasticsearch collects documents\nbefore sorting. Defaults to 0, which does not terminate query execution early.", @@ -126924,13 +146151,28 @@ "type": "boolean" }, "stored_fields": { - "$ref": "#/components/schemas/_types.Fields" + "description": "List of stored fields to return as part of a hit. If no fields are specified,\nno stored fields are included in the response. If this field is specified, the _source\nparameter defaults to false. You can pass _source: true to return both source fields\nand stored fields in the search response.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "pit": { - "$ref": "#/components/schemas/_global.search._types.PointInTimeReference" + "description": "Limits the search to a point in time (PIT). If you provide a PIT, you\ncannot specify an in the request path.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.PointInTimeReference" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "description": "Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "stats": { "description": "Stats groups to associate with the search. Each group maintains a statistics\naggregation for its associated searches. You can retrieve these stats using\nthe indices stats API.", @@ -126951,13 +146193,28 @@ "type": "object", "properties": { "connections": { - "$ref": "#/components/schemas/graph._types.Hop" + "description": "Specifies or more fields from which you want to extract terms that are associated with the specified vertices.", + "allOf": [ + { + "$ref": "#/components/schemas/graph._types.Hop" + } + ] }, "controls": { - "$ref": "#/components/schemas/graph._types.ExploreControls" + "description": "Direct the Graph API how to build the graph.", + "allOf": [ + { + "$ref": "#/components/schemas/graph._types.ExploreControls" + } + ] }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "A seed query that identifies the documents of interest. Can be any valid Elasticsearch query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "vertices": { "description": "Specifies one or more fields that contain the terms you want to include in the graph as vertices.", @@ -127029,7 +146286,12 @@ "type": "boolean" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field used to derive the analyzer.\nTo use this parameter, you must specify an index.\nIf specified, the `analyzer` parameter overrides this value.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "filter": { "description": "Array of token filters used to apply after the tokenizer.", @@ -127043,10 +146305,20 @@ "type": "string" }, "text": { - "$ref": "#/components/schemas/indices.analyze.TextToAnalyze" + "description": "Text to analyze.\nIf an array of strings is provided, it is analyzed as a multi-value field.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.analyze.TextToAnalyze" + } + ] }, "tokenizer": { - "$ref": "#/components/schemas/_types.analysis.Tokenizer" + "description": "Tokenizer to use to convert text into tokens.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.Tokenizer" + } + ] } } }, @@ -127139,20 +146411,40 @@ "type": "object", "properties": { "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Query used to limit documents the alias can access.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "index_routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.\nData stream aliases don’t support this parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "is_write_index": { "description": "If `true`, sets the write index or data stream for the alias.\nIf an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests.\nIf an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index.\nData stream aliases don’t automatically set a write data stream, even if the alias points to one data stream.", "type": "boolean" }, "routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "Value used to route indexing and search operations to a specific shard.\nData stream aliases don’t support this parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "search_routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.\nData stream aliases don’t support this parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] } } }, @@ -127171,7 +146463,12 @@ "type": "object", "properties": { "index_patterns": { - "$ref": "#/components/schemas/_types.Indices" + "description": "Name of the index template to create.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "composed_of": { "description": "An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence.", @@ -127181,20 +146478,40 @@ } }, "template": { - "$ref": "#/components/schemas/indices.put_index_template.IndexTemplateMapping" + "description": "Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.put_index_template.IndexTemplateMapping" + } + ] }, "data_stream": { - "$ref": "#/components/schemas/indices._types.DataStreamVisibility" + "description": "If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamVisibility" + } + ] }, "priority": { "description": "Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch.", "type": "number" }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.\nExternal systems can use these version numbers to simplify template management.\nTo unset a version, replace the template without specifying one.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Optional user metadata about the index template.\nIt may have any contents.\nIt is not automatically generated or used by Elasticsearch.\nThis user-defined object is stored in the cluster state, so keeping it short is preferable\nTo unset the metadata, replace the template without specifying it.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "allow_auto_create": { "description": "This setting overrides the value of the `action.auto_create_index` cluster setting.\nIf set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.\nIf set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.", @@ -127239,7 +146556,12 @@ "type": "boolean" }, "dynamic": { - "$ref": "#/components/schemas/_types.mapping.DynamicMapping" + "description": "Controls whether new fields are added dynamically.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.DynamicMapping" + } + ] }, "dynamic_date_formats": { "description": "If date detection is enabled then new string fields are checked\nagainst 'dynamic_date_formats' and if the value matches then\na new date field is added instead of string.", @@ -127261,10 +146583,20 @@ } }, "_field_names": { - "$ref": "#/components/schemas/_types.mapping.FieldNamesField" + "description": "Control whether field names are enabled for the index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.FieldNamesField" + } + ] }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "A mapping type can have custom meta data associated with it. These are\nnot used at all by Elasticsearch, but can be used to store\napplication-specific metadata.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "numeric_detection": { "description": "Automatically map strings into numeric data types for all fields.", @@ -127279,13 +146611,28 @@ } }, "_routing": { - "$ref": "#/components/schemas/_types.mapping.RoutingField" + "description": "Enable making a routing value required on indexed documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RoutingField" + } + ] }, "_source": { - "$ref": "#/components/schemas/_types.mapping.SourceField" + "description": "Control whether the _source field is enabled on the index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.SourceField" + } + ] }, "runtime": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "description": "Mapping of runtime fields for the index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] } } }, @@ -127354,17 +146701,32 @@ ] }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "description": "Mapping for fields in the index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "order": { "description": "Order in which Elasticsearch applies this template if index\nmatches multiple templates.\n\nTemplates with lower 'order' values are merged first. Templates with higher\n'order' values are merged later, overriding templates with lower values.", "type": "number" }, "settings": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "description": "Configuration options for the index.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "Version number used to manage index templates externally. This number\nis not automatically generated by Elasticsearch.\nTo unset a version, replace the template without specifying one.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] } } }, @@ -127397,10 +146759,20 @@ } }, "conditions": { - "$ref": "#/components/schemas/indices.rollover.RolloverConditions" + "description": "Conditions for the rollover.\nIf specified, Elasticsearch only performs the rollover if the current index satisfies these conditions.\nIf this parameter is not specified, Elasticsearch performs the rollover unconditionally.\nIf conditions are specified, at least one of them must be a `max_*` condition.\nThe index will rollover if any `max_*` condition is satisfied and all `min_*` conditions are satisfied.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.rollover.RolloverConditions" + } + ] }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "description": "Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping paramaters.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "settings": { "description": "Configuration options for the index.\nData streams do not support this parameter.", @@ -127462,7 +146834,12 @@ "type": "boolean" }, "index_patterns": { - "$ref": "#/components/schemas/_types.Indices" + "description": "Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "composed_of": { "description": "An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence.", @@ -127472,20 +146849,40 @@ } }, "template": { - "$ref": "#/components/schemas/indices.put_index_template.IndexTemplateMapping" + "description": "Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.put_index_template.IndexTemplateMapping" + } + ] }, "data_stream": { - "$ref": "#/components/schemas/indices._types.DataStreamVisibility" + "description": "If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamVisibility" + } + ] }, "priority": { "description": "Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch.", "type": "number" }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Optional user metadata about the index template.\nMay have any contents.\nThis map is not automatically generated by Elasticsearch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "ignore_missing_component_templates": { "description": "The configuration option ignore_missing_component_templates can be used when an index template\nreferences a component template that might not exist", @@ -127547,7 +146944,12 @@ "type": "object", "properties": { "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Query in the Lucene query string syntax.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } } } @@ -127583,7 +146985,12 @@ "type": "string" }, "task_settings": { - "$ref": "#/components/schemas/inference._types.TaskSettings" + "description": "Task settings for the individual inference request.\nThese settings are specific to the task type you specified and override the task settings specified when initializing the service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskSettings" + } + ] } }, "required": [ @@ -127639,7 +147046,12 @@ } }, "pipeline": { - "$ref": "#/components/schemas/ingest._types.Pipeline" + "description": "The pipeline to test.\nIf you don't specify the `pipeline` request path parameter, this parameter is required.\nIf you specify both this and the request path parameter, the API only uses the request path parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.Pipeline" + } + ] } }, "required": [ @@ -127664,7 +147076,11 @@ "type": "object", "properties": { "license": { - "$ref": "#/components/schemas/license._types.License" + "allOf": [ + { + "$ref": "#/components/schemas/license._types.License" + } + ] }, "licenses": { "description": "A sequence of one or more JSON documents containing the license information.", @@ -127698,7 +147114,12 @@ } }, "ids": { - "$ref": "#/components/schemas/_types.Ids" + "description": "The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Ids" + } + ] } } }, @@ -127739,7 +147160,13 @@ "type": "number" }, "timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "How long can the underlying delete processes run until they are canceled.", + "default": "8h", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } } } @@ -127753,13 +147180,28 @@ "type": "object", "properties": { "source": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource" + "description": "The configuration of how to source the analysis data. It requires an\nindex. Optionally, query and _source may be specified.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource" + } + ] }, "dest": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsDestination" + "description": "The destination configuration, consisting of index and optionally\nresults_field (ml by default).", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsDestination" + } + ] }, "analysis": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer" + "description": "The analysis configuration, which contains the information necessary to\nperform one of the following types of analysis: classification, outlier\ndetection, or regression.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer" + } + ] }, "description": { "description": "A description of the job.", @@ -127776,7 +147218,12 @@ "type": "number" }, "analyzed_fields": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields" + "description": "Specify includes and/or excludes patterns to select which fields will be\nincluded in the analysis. The patterns specified in excludes are applied\nlast, therefore excludes takes precedence. In other words, if the same\nfield is specified in both includes and excludes, then the field will not\nbe included in the analysis.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields" + } + ] }, "allow_lazy_start": { "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node.", @@ -127811,7 +147258,13 @@ "type": "boolean" }, "end": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "Refer to the description for the `end` query parameter.", + "default": "-1", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "exclude_interim": { "description": "Refer to the description for the `exclude_interim` query parameter.", @@ -127824,13 +147277,29 @@ "type": "boolean" }, "page": { - "$ref": "#/components/schemas/ml._types.Page" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Page" + } + ] }, "sort": { - "$ref": "#/components/schemas/_types.Field" + "description": "Refer to the desription for the `sort` query parameter.", + "default": "timestamp", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "start": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "Refer to the description for the `start` query parameter.", + "default": "-1", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] } } }, @@ -127850,7 +147319,12 @@ "type": "object", "properties": { "page": { - "$ref": "#/components/schemas/ml._types.Page" + "description": "This object is supported only when you omit the calendar identifier.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Page" + } + ] } } } @@ -127864,7 +147338,12 @@ "type": "object", "properties": { "page": { - "$ref": "#/components/schemas/ml._types.Page" + "description": "Configures pagination.\nThis parameter has the `from` and `size` properties.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Page" + } + ] } } }, @@ -127884,7 +147363,12 @@ "type": "object", "properties": { "page": { - "$ref": "#/components/schemas/ml._types.Page" + "description": "Configures pagination.\nThis parameter has the `from` and `size` properties.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Page" + } + ] } } }, @@ -127909,16 +147393,35 @@ "type": "boolean" }, "end": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "Refer to the description for the `end` query parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "page": { - "$ref": "#/components/schemas/ml._types.Page" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Page" + } + ] }, "sort": { - "$ref": "#/components/schemas/_types.Field" + "description": "Refer to the description for the `sort` query parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "start": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "Refer to the description for the `start` query parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] } } }, @@ -127943,10 +147446,20 @@ "type": "boolean" }, "bucket_span": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Refer to the description for the `bucket_span` query parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "end": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "Refer to the description for the `end` query parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "exclude_interim": { "description": "Refer to the description for the `exclude_interim` query parameter.", @@ -127965,7 +147478,12 @@ ] }, "start": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "Refer to the description for the `start` query parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "top_n": { "description": "Refer to the description for the `top_n` query parameter.", @@ -127995,7 +147513,13 @@ "type": "boolean" }, "end": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "Refer to the description for the `end` query parameter.", + "default": "-1", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "exclude_interim": { "description": "Refer to the description for the `exclude_interim` query parameter.", @@ -128003,7 +147527,11 @@ "type": "boolean" }, "page": { - "$ref": "#/components/schemas/ml._types.Page" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Page" + } + ] }, "record_score": { "description": "Refer to the description for the `record_score` query parameter.", @@ -128011,10 +147539,22 @@ "type": "number" }, "sort": { - "$ref": "#/components/schemas/_types.Field" + "description": "Refer to the description for the `sort` query parameter.", + "default": "record_score", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "start": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "Refer to the description for the `start` query parameter.", + "default": "-1", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] } } }, @@ -128034,7 +147574,12 @@ "type": "object", "properties": { "config": { - "$ref": "#/components/schemas/ml.preview_data_frame_analytics.DataframePreviewConfig" + "description": "A data frame analytics config as described in create data frame analytics\njobs. Note that `id` and `dest` don’t need to be provided in the context of\nthis API.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.preview_data_frame_analytics.DataframePreviewConfig" + } + ] } } }, @@ -128054,10 +147599,20 @@ "type": "object", "properties": { "datafeed_config": { - "$ref": "#/components/schemas/ml._types.DatafeedConfig" + "description": "The datafeed definition to preview.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DatafeedConfig" + } + ] }, "job_config": { - "$ref": "#/components/schemas/ml._types.JobConfig" + "description": "The configuration details for the anomaly detection job that is associated with the datafeed. If the\n`datafeed_config` object does not include a `job_id` that references an existing anomaly detection job, you must\nsupply this `job_config` object. If you include both a `job_id` and a `job_config`, the latter information is\nused. You cannot specify a `job_config` object unless you also supply a `datafeed_config` object.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobConfig" + } + ] } } } @@ -128151,7 +147706,12 @@ "type": "object", "properties": { "secure_settings_password": { - "$ref": "#/components/schemas/_types.Password" + "description": "The password for the Elasticsearch keystore.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Password" + } + ] } } }, @@ -128171,7 +147731,12 @@ "type": "object", "properties": { "script": { - "$ref": "#/components/schemas/_types.StoredScript" + "description": "The script or search template, its parameters, and its language.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.StoredScript" + } + ] } }, "required": [ @@ -128208,7 +147773,12 @@ } }, "metric": { - "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetric" + "description": "Definition of the evaluation metric to calculate.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetric" + } + ] } }, "required": [ @@ -128232,7 +147802,12 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The ID of the search template to render.\nIf no `source` is specified, this or the `` request path parameter is required.\nIf you specify both this parameter and the `` parameter, the API uses only ``.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "file": { "type": "string" @@ -128245,7 +147820,12 @@ } }, "source": { - "$ref": "#/components/schemas/_types.ScriptSource" + "description": "An inline search template.\nIt supports the same parameters as the search API's request body.\nThese parameters also support Mustache variables.\nIf no `id` or `` is specified, this parameter is required.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptSource" + } + ] } } }, @@ -128275,7 +147855,15 @@ } }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "externalDocs": { + "url": "https://www.elastic.co/docs/manage-data/lifecycle/rollup/rollup-search-limitations" + }, + "description": "Specifies a DSL query that is subject to some limitations.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "size": { "description": "Must be zero if set, as rollups work on pre-aggregated data.", @@ -128300,13 +147888,29 @@ "type": "object", "properties": { "context": { - "$ref": "#/components/schemas/_global.scripts_painless_execute.PainlessContext" + "description": "The context that the script should run in.\nNOTE: Result ordering in the field contexts is not guaranteed.", + "default": "painless_test", + "allOf": [ + { + "$ref": "#/components/schemas/_global.scripts_painless_execute.PainlessContext" + } + ] }, "context_setup": { - "$ref": "#/components/schemas/_global.scripts_painless_execute.PainlessContextSetup" + "description": "Additional parameters for the `context`.\nNOTE: This parameter is required for all contexts except `painless_test`, which is the default if no value is provided for `context`.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.scripts_painless_execute.PainlessContextSetup" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "The Painless script to run.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } } }, @@ -128337,10 +147941,21 @@ "type": "object", "properties": { "scroll": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The period to retain the search context for scrolling.", + "default": "1d", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "scroll_id": { - "$ref": "#/components/schemas/_types.ScrollId" + "description": "The scroll ID of the search.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScrollId" + } + ] } }, "required": [ @@ -128373,7 +147988,12 @@ } }, "collapse": { - "$ref": "#/components/schemas/_global.search._types.FieldCollapse" + "description": "Collapses search results the values of the specified field.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.FieldCollapse" + } + ] }, "explain": { "description": "If `true`, the request returns detailed information about score computation as part of a hit.", @@ -128393,10 +148013,24 @@ "type": "number" }, "highlight": { - "$ref": "#/components/schemas/_global.search._types.Highlight" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/highlighting" + }, + "description": "Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.Highlight" + } + ] }, "track_total_hits": { - "$ref": "#/components/schemas/_global.search._types.TrackHits" + "description": "Number of hits matching the query to count accurately.\nIf `true`, the exact number of hits is returned at the cost of some performance.\nIf `false`, the response does not include the total number of hits matching the query.", + "default": "10000", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.TrackHits" + } + ] }, "indices_boost": { "externalDocs": { @@ -128442,14 +148076,25 @@ ] }, "rank": { - "$ref": "#/components/schemas/_types.RankContainer" + "description": "The Reciprocal Rank Fusion (RRF) to use.", + "x-state": "Generally available; Added in 8.8.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RankContainer" + } + ] }, "min_score": { "description": "The minimum `_score` for matching documents.\nDocuments with a lower `_score` are not included in search results and results collected by aggregations.", "type": "number" }, "post_filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Use the `post_filter` parameter to filter search results.\nThe search hits are filtered after the aggregations are calculated.\nA post filter has no impact on the aggregation results.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "profile": { "description": "Set to `true` to return detailed timing information about the execution of individual components in a search request.\nNOTE: This is a debugging tool and adds significant overhead to search execution.", @@ -128457,7 +148102,15 @@ "type": "boolean" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl" + }, + "description": "The search definition using the Query DSL.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "rescore": { "description": "Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases.", @@ -128474,7 +148127,16 @@ ] }, "retriever": { - "$ref": "#/components/schemas/_types.RetrieverContainer" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrievers" + }, + "description": "A retriever is a specification to describe top documents returned from a search.\nA retriever replaces other elements of the search API that also return top documents such as `query` and `knn`.", + "x-state": "Generally available; Added in 8.14.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RetrieverContainer" + } + ] }, "script_fields": { "description": "Retrieve a script evaluation (based on different fields) for each hit.", @@ -128484,7 +148146,12 @@ } }, "search_after": { - "$ref": "#/components/schemas/_types.SortResults" + "description": "Used to retrieve the next page of hits using a set of sort values from the previous page.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortResults" + } + ] }, "size": { "description": "The number of hits to return, which must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` property.", @@ -128492,13 +148159,34 @@ "type": "number" }, "slice": { - "$ref": "#/components/schemas/_types.SlicedScroll" + "description": "Split a scrolled search into multiple slices that can be consumed independently.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SlicedScroll" + } + ] }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results" + }, + "description": "A comma-separated list of : pairs.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] }, "_source": { - "$ref": "#/components/schemas/_global.search._types.SourceConfig" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#source-filtering" + }, + "description": "The source fields that are returned for matching documents.\nThese fields are returned in the `hits._source` property of the search response.\nIf the `stored_fields` property is specified, the `_source` property defaults to `false`.\nOtherwise, it defaults to `true`.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.SourceConfig" + } + ] }, "fields": { "description": "An array of wildcard (`*`) field patterns.\nThe request returns values for field names matching these patterns in the `hits.fields` property of the response.", @@ -128508,7 +148196,12 @@ } }, "suggest": { - "$ref": "#/components/schemas/_global.search._types.Suggester" + "description": "Defines a suggester that provides similar looking terms based on a provided text.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.Suggester" + } + ] }, "terminate_after": { "description": "The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this property to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this property for requests that target data streams with backing indices across multiple data tiers.\n\nIf set to `0` (default), the query does not terminate early.", @@ -128537,13 +148230,34 @@ "type": "boolean" }, "stored_fields": { - "$ref": "#/components/schemas/_types.Fields" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#stored-fields" + }, + "description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` property defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "pit": { - "$ref": "#/components/schemas/_global.search._types.PointInTimeReference" + "description": "Limit the search to a point in time (PIT).\nIf you provide a PIT, you cannot specify an `` in the request path.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.PointInTimeReference" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "externalDocs": { + "url": "https://www.elastic.co/docs/manage-data/data-store/mapping/define-runtime-fields-in-search-request" + }, + "description": "One or more runtime fields in the search request.\nThese fields take precedence over mapped fields with the same name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "stats": { "description": "The stats groups to associate with the search.\nEach group maintains a statistics aggregation for its associated searches.\nYou can retrieve these stats using the indices stats API.", @@ -128627,10 +148341,20 @@ "type": "number" }, "fields": { - "$ref": "#/components/schemas/_types.Fields" + "description": "The fields to return in the `hits` layer.\nIt supports wildcards (`*`).\nThis parameter does not support fields with array values. Fields with array\nvalues may return inconsistent results.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "grid_agg": { - "$ref": "#/components/schemas/_global.search_mvt._types.GridAggregationType" + "description": "The aggregation used to create a grid for the `field`.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search_mvt._types.GridAggregationType" + } + ] }, "grid_precision": { "description": "Additional zoom levels available through the aggs layer. For example, if `` is `7`\nand `grid_precision` is `8`, you can zoom in up to level 15. Accepts 0-8. If 0, results\ndon't include the aggs layer.", @@ -128638,13 +148362,29 @@ "type": "number" }, "grid_type": { - "$ref": "#/components/schemas/_global.search_mvt._types.GridType" + "description": "Determines the geometry type for features in the aggs layer. In the aggs layer,\neach feature represents a `geotile_grid` cell. If `grid, each feature is a polygon\nof the cells bounding box. If `point`, each feature is a Point that is the centroid\nof the cell.", + "default": "grid", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search_mvt._types.GridType" + } + ] }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "The query DSL used to filter documents for the search.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "description": "Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "size": { "description": "The maximum number of features to return in the hits layer. Accepts 0-10000.\nIf 0, results don't include the hits layer.", @@ -128652,10 +148392,21 @@ "type": "number" }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "description": "Sort the features in the hits layer. By default, the API calculates a bounding\nbox for each feature. It sorts features based on this box's diagonal length,\nfrom longest to shortest.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] }, "track_total_hits": { - "$ref": "#/components/schemas/_global.search._types.TrackHits" + "description": "The number of hits matching the query to count accurately. If `true`, the exact number\nof hits is returned at the cost of some performance. If `false`, the response does\nnot include the total number of hits matching the query.", + "default": "10000", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.TrackHits" + } + ] }, "with_labels": { "description": "If `true`, the hits and aggs layers will contain additional point features representing\nsuggested label positions for the original features.\n\n* `Point` and `MultiPoint` features will have one of the points selected.\n* `Polygon` and `MultiPolygon` features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree.\n* `LineString` features will likewise provide a roughly central point selected from the triangle-tree.\n* The aggregation results will provide one central point for each aggregation bucket.\n\nAll attributes from the original features will also be copied to the new label features.\nIn addition, the new features will be distinguishable using the tag `_mvt_label_position`.", @@ -128684,7 +148435,12 @@ "type": "boolean" }, "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The ID of the search template to use. If no `source` is specified,\nthis parameter is required.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "params": { "description": "Key-value pairs used to replace Mustache variables in the template.\nThe key is the variable name.\nThe value is the variable value.", @@ -128699,7 +148455,12 @@ "type": "boolean" }, "source": { - "$ref": "#/components/schemas/_types.ScriptSource" + "description": "An inline search template. Supports the same parameters as the search API's\nrequest body. It also supports Mustache variables. If no `id` is specified, this\nparameter is required.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptSource" + } + ] } } }, @@ -128720,7 +148481,12 @@ "type": "object", "properties": { "password": { - "$ref": "#/components/schemas/_types.Password" + "description": "The new password value. Passwords must be at least 6 characters long.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Password" + } + ] }, "password_hash": { "description": "A hash of the new password value. This must be produced using the same\nhashing algorithm as has been configured for password storage. For more details,\nsee the explanation of the `xpack.security.authc.password_hashing.algorithm`\nsetting.", @@ -128745,10 +148511,20 @@ "type": "object", "properties": { "expiration": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The expiration time for the API key.\nBy default, API keys never expire.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "A name for the API key.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "role_descriptors": { "externalDocs": { @@ -128761,7 +148537,13 @@ } }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with `_` are reserved for system usage.", + "x-state": "Generally available; Added in 7.13.0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] } } }, @@ -128826,7 +148608,12 @@ } }, "privileges": { - "$ref": "#/components/schemas/security.has_privileges_user_profile.PrivilegesCheck" + "description": "An object containing all the privileges to be checked.", + "allOf": [ + { + "$ref": "#/components/schemas/security.has_privileges_user_profile.PrivilegesCheck" + } + ] } }, "required": [ @@ -128924,7 +148711,12 @@ } }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Optional metadata. Within the metadata object, keys that begin with an underscore (`_`) are reserved for system use.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "run_as": { "externalDocs": { @@ -128981,7 +148773,12 @@ "type": "boolean" }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Additional metadata that helps define which roles are assigned to each user.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "roles": { "description": "A list of role names that are granted to the users that match the role mapping rules.\nExactly one of `roles` or `role_templates` must be specified.", @@ -128998,7 +148795,12 @@ } }, "rules": { - "$ref": "#/components/schemas/security._types.RoleMappingRule" + "description": "The rules that determine which users should be matched by the mapping.\nA rule is a logical condition that is expressed by using a JSON DSL.", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.RoleMappingRule" + } + ] }, "run_as": { "type": "array", @@ -129066,7 +148868,11 @@ "type": "object", "properties": { "username": { - "$ref": "#/components/schemas/_types.Username" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Username" + } + ] }, "email": { "description": "The email of the user.", @@ -129093,10 +148899,20 @@ ] }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Arbitrary metadata that you want to associate with the user.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "password": { - "$ref": "#/components/schemas/_types.Password" + "description": "The user's password.\nPasswords must be at least 6 characters long.\nWhen adding a user, one of `password` or `password_hash` is required.\nWhen updating an existing user, the password is optional, so that other fields on the user (such as their roles) may be updated without modifying the user's password", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Password" + } + ] }, "password_hash": { "externalDocs": { @@ -129143,7 +148959,12 @@ } }, "query": { - "$ref": "#/components/schemas/security.query_api_keys.ApiKeyQueryContainer" + "description": "A query to filter which API keys to return.\nIf the query parameter is missing, it is equivalent to a `match_all` query.\nThe query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`,\n`ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`.\nYou can query the following public information associated with an API key: `id`, `type`, `name`,\n`creation`, `expiration`, `invalidated`, `invalidation`, `username`, `realm`, and `metadata`.\n\nNOTE: The queryable string values associated with API keys are internally mapped as keywords.\nConsequently, if no `analyzer` parameter is specified for a `match` query, then the provided match query string is interpreted as a single keyword value.\nSuch a match query is hence equivalent to a `term` query.", + "allOf": [ + { + "$ref": "#/components/schemas/security.query_api_keys.ApiKeyQueryContainer" + } + ] }, "from": { "description": "The starting document offset.\nIt must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", @@ -129151,7 +148972,15 @@ "type": "number" }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results" + }, + "description": "The sort definition.\nOther than `id`, all public fields of an API key are eligible for sorting.\nIn addition, sort can also be applied to the `_doc` field to sort by index order.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] }, "size": { "description": "The number of hits to return.\nIt must not be negative.\nThe `size` parameter can be set to `0`, in which case no API key matches are returned, only the aggregation results.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", @@ -129159,7 +148988,15 @@ "type": "number" }, "search_after": { - "$ref": "#/components/schemas/_types.SortResults" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#search-after" + }, + "description": "The search after definition.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortResults" + } + ] } } }, @@ -129190,7 +149027,12 @@ "type": "object", "properties": { "query": { - "$ref": "#/components/schemas/security.query_role.RoleQueryContainer" + "description": "A query to filter which roles to return.\nIf the query parameter is missing, it is equivalent to a `match_all` query.\nThe query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`,\n`ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`.\nYou can query the following information associated with roles: `name`, `description`, `metadata`,\n`applications.application`, `applications.privileges`, and `applications.resources`.", + "allOf": [ + { + "$ref": "#/components/schemas/security.query_role.RoleQueryContainer" + } + ] }, "from": { "description": "The starting document offset.\nIt must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", @@ -129198,7 +149040,12 @@ "type": "number" }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "description": "The sort definition.\nYou can sort on `username`, `roles`, or `enabled`.\nIn addition, sort can also be applied to the `_doc` field to sort by index order.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] }, "size": { "description": "The number of hits to return.\nIt must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", @@ -129206,7 +149053,15 @@ "type": "number" }, "search_after": { - "$ref": "#/components/schemas/_types.SortResults" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#search-after" + }, + "description": "The search after definition.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortResults" + } + ] } } }, @@ -129232,7 +149087,12 @@ "type": "object", "properties": { "query": { - "$ref": "#/components/schemas/security.query_user.UserQueryContainer" + "description": "A query to filter which users to return.\nIf the query parameter is missing, it is equivalent to a `match_all` query.\nThe query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`,\n`ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`.\nYou can query the following information associated with user: `username`, `roles`, `enabled`, `full_name`, and `email`.", + "allOf": [ + { + "$ref": "#/components/schemas/security.query_user.UserQueryContainer" + } + ] }, "from": { "description": "The starting document offset.\nIt must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", @@ -129240,7 +149100,15 @@ "type": "number" }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results" + }, + "description": "The sort definition.\nFields eligible for sorting are: `username`, `roles`, `enabled`.\nIn addition, sort can also be applied to the `_doc` field to sort by index order.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] }, "size": { "description": "The number of hits to return.\nIt must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", @@ -129248,7 +149116,15 @@ "type": "number" }, "search_after": { - "$ref": "#/components/schemas/_types.SortResults" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#search-after" + }, + "description": "The search after definition", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortResults" + } + ] } } }, @@ -129297,7 +149173,12 @@ ] }, "hint": { - "$ref": "#/components/schemas/security.suggest_user_profiles.Hint" + "description": "Extra search criteria to improve relevance of the suggestion result.\nProfiles matching the spcified hint are ranked higher in the response.\nProfiles not matching the hint aren't excluded from the response as long as the profile matches the `name` field query.", + "allOf": [ + { + "$ref": "#/components/schemas/security.suggest_user_profiles.Hint" + } + ] } } }, @@ -129370,7 +149251,11 @@ } }, "mapping_addition": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "pipeline_substitutions": { "description": "Pipelines to test.\nIf you don’t specify the `pipeline` request path parameter, this parameter is required.\nIf you specify both this and the request path parameter, the API only uses the request path parameter.", @@ -129417,7 +149302,13 @@ "type": "object", "properties": { "expand_wildcards": { - "$ref": "#/components/schemas/_types.ExpandWildcards" + "description": "Determines how wildcard patterns in the `indices` parameter match data streams and indices.\nIt supports comma-separated values such as `open,hidden`.", + "default": "all", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ExpandWildcards" + } + ] }, "feature_states": { "externalDocs": { @@ -129440,10 +149331,20 @@ "type": "boolean" }, "indices": { - "$ref": "#/components/schemas/_types.Indices" + "description": "A comma-separated list of data streams and indices to include in the snapshot.\nIt supports a multi-target syntax.\nThe default is an empty array (`[]`), which includes all regular data streams and regular indices.\nTo exclude all data streams and indices, use `-*`.\n\nYou can't use this parameter to include or exclude system indices or system data streams from a snapshot.\nUse `feature_states` instead.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data.\nIt can have any contents but it must be less than 1024 bytes.\nThis information is not automatically generated by Elasticsearch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "partial": { "description": "If `true`, it enables you to restore a partial snapshot of indices with unavailable shards.\nOnly shards that were successfully included in the snapshot will be restored.\nAll missing shards will be recreated as empty.\n\nIf `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available.", @@ -129541,7 +149442,16 @@ "type": "boolean" }, "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/sql-rest-filtering" + }, + "description": "The Elasticsearch query DSL for additional filtering.", + "default": "none", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "index_using_frozen": { "description": "If `true`, the search can run on frozen indices.", @@ -129549,7 +149459,13 @@ "type": "boolean" }, "keep_alive": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The retention period for an async or saved synchronous search.", + "default": "5d", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "keep_on_completion": { "description": "If `true`, Elasticsearch stores synchronous searches if you also specify the `wait_for_completion_timeout` parameter.\nIf `false`, Elasticsearch only stores async searches that don't finish before the `wait_for_completion_timeout`.", @@ -129557,7 +149473,13 @@ "type": "boolean" }, "page_timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The minimum retention period for the scroll cursor.\nAfter this time period, a pagination request might fail because the scroll cursor is no longer available.\nSubsequent scroll requests prolong the lifetime of the scroll cursor by the duration of `page_timeout` in the scroll request.", + "default": "45s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "params": { "description": "The values for parameters in the query.", @@ -129574,16 +149496,41 @@ "type": "string" }, "request_timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The timeout before the request fails.", + "default": "90s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "description": "One or more runtime fields for the search request.\nThese fields take precedence over mapped fields with the same name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "time_zone": { - "$ref": "#/components/schemas/_types.TimeZone" + "externalDocs": { + "url": "https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html" + }, + "description": "The ISO-8601 time zone ID for the search.", + "default": "Z", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TimeZone" + } + ] }, "wait_for_completion_timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The period to wait for complete results.\nIt defaults to no timeout, meaning the request waits for complete search results.\nIf the search doesn't finish within this period, the search becomes async.\n\nTo save a synchronous search, you must specify this parameter and the `keep_on_completion` parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } } }, @@ -129609,14 +149556,32 @@ "type": "number" }, "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/sql-rest-filtering" + }, + "description": "The Elasticsearch query DSL for additional filtering.", + "default": "none", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "query": { "description": "The SQL query to run.", "type": "string" }, "time_zone": { - "$ref": "#/components/schemas/_types.TimeZone" + "externalDocs": { + "url": "https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html" + }, + "description": "The ISO-8601 time zone ID for the search.", + "default": "Z", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TimeZone" + } + ] } }, "required": [ @@ -129641,7 +149606,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The string to match at the start of indexed terms. If not provided, all terms in the field are considered.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "size": { "description": "The number of matching terms to return.", @@ -129649,7 +149619,13 @@ "type": "number" }, "timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The maximum length of time to spend collecting results.\nIf the timeout is exceeded the `complete` flag set to `false` in the response and the results may be partial or empty.", + "default": "1s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "case_insensitive": { "description": "When `true`, the provided search string is matched against index terms without case sensitivity.", @@ -129657,7 +149633,12 @@ "type": "boolean" }, "index_filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Filter an index shard if the provided query rewrites to `match_none`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "string": { "description": "The string to match at the start of indexed terms.\nIf it is not provided, all terms in the field are considered.\n\n> info\n> The prefix string cannot be larger than the largest possible keyword value, which is Lucene's term byte-length limit of 32766.", @@ -129692,7 +149673,15 @@ "type": "object" }, "filter": { - "$ref": "#/components/schemas/_global.termvectors.Filter" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-mlt-query" + }, + "description": "Filter terms based on their tf-idf scores.\nThis could be useful in order find out a good characteristic vector of a document.\nThis feature works in a similar manner to the second phase of the More Like This Query.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.termvectors.Filter" + } + ] }, "per_field_analyzer": { "description": "Override the default per-field analyzer.\nThis is useful in order to generate term vectors in any fashion, especially when using artificial documents.\nWhen providing an analyzer for a field that already stores term vectors, the term vectors will be regenerated.", @@ -129734,13 +149723,28 @@ "type": "boolean" }, "routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "A custom value that is used to route operations to a specific shard.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "If `true`, returns the document version as part of a hit.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "version_type": { - "$ref": "#/components/schemas/_types.VersionType" + "description": "The version type.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionType" + } + ] } } }, @@ -129809,7 +149813,12 @@ "type": "object", "properties": { "grok_pattern": { - "$ref": "#/components/schemas/_types.GrokPattern" + "description": "The Grok pattern to run on the text.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.GrokPattern" + } + ] }, "text": { "description": "The lines of text to run the Grok pattern on.", @@ -129841,32 +149850,73 @@ "type": "object", "properties": { "dest": { - "$ref": "#/components/schemas/transform._types.Destination" + "description": "The destination for the transform.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Destination" + } + ] }, "description": { "description": "Free text description of the transform.", "type": "string" }, "frequency": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is 1s and the maximum is 1h.", + "default": "1m", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "pivot": { - "$ref": "#/components/schemas/transform._types.Pivot" + "description": "The pivot method transforms the data by aggregating and grouping it.\nThese objects define the group by fields and the aggregation to reduce\nthe data.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Pivot" + } + ] }, "source": { - "$ref": "#/components/schemas/transform._types.Source" + "description": "The source of the data for the transform.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Source" + } + ] }, "settings": { - "$ref": "#/components/schemas/transform._types.Settings" + "description": "Defines optional transform settings.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Settings" + } + ] }, "sync": { - "$ref": "#/components/schemas/transform._types.SyncContainer" + "description": "Defines the properties transforms require to run continuously.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.SyncContainer" + } + ] }, "retention_policy": { - "$ref": "#/components/schemas/transform._types.RetentionPolicyContainer" + "description": "Defines a retention policy for the transform. Data that meets the defined\ncriteria is deleted from the destination index.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.RetentionPolicyContainer" + } + ] }, "latest": { - "$ref": "#/components/schemas/transform._types.Latest" + "description": "The latest method transforms the data by finding the latest document for\neach unique key.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Latest" + } + ] } } }, @@ -129910,13 +149960,28 @@ "type": "boolean" }, "simulated_actions": { - "$ref": "#/components/schemas/watcher._types.SimulatedActions" + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.SimulatedActions" + } + ] }, "trigger_data": { - "$ref": "#/components/schemas/watcher._types.ScheduleTriggerEvent" + "description": "This structure is parsed as the data of the trigger event that will be used during the watch execution.", + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ScheduleTriggerEvent" + } + ] }, "watch": { - "$ref": "#/components/schemas/watcher._types.Watch" + "description": "When present, this watch is used instead of the one specified in the request.\nThis watch is not persisted to the index and `record_execution` cannot be set.", + "default": "null", + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.Watch" + } + ] } } }, @@ -129954,25 +150019,60 @@ } }, "condition": { - "$ref": "#/components/schemas/watcher._types.ConditionContainer" + "description": "The condition that defines if the actions should be run.", + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.ConditionContainer" + } + ] }, "input": { - "$ref": "#/components/schemas/watcher._types.InputContainer" + "description": "The input that defines the input that loads the data for the watch.", + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.InputContainer" + } + ] }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Metadata JSON that will be copied into the history entries.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "throttle_period": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The minimum time between actions being run.\nThe default is 5 seconds.\nThis default can be changed in the config file with the setting `xpack.watcher.throttle.period.default_period`.\nIf both this value and the `throttle_period_in_millis` parameter are specified, Watcher uses the last parameter included in the request.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "throttle_period_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "Minimum time in milliseconds between actions being run. Defaults to 5000. If both this value and the throttle_period parameter are specified, Watcher uses the last parameter included in the request.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "transform": { - "$ref": "#/components/schemas/_types.TransformContainer" + "description": "The transform that processes the watch payload to prepare it for the watch actions.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TransformContainer" + } + ] }, "trigger": { - "$ref": "#/components/schemas/watcher._types.TriggerContainer" + "description": "The trigger that defines when the watch should run.", + "allOf": [ + { + "$ref": "#/components/schemas/watcher._types.TriggerContainer" + } + ] } } }, @@ -130002,13 +150102,34 @@ "type": "number" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "A query that filters the watches to be returned.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results" + }, + "description": "One or more fields used to sort the search results.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] }, "search_after": { - "$ref": "#/components/schemas/_types.SortResults" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#search-after" + }, + "description": "Retrieve the next page of hits using a set of sort values from the previous page.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortResults" + } + ] } } } diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index f1d6fce20d..3d763b82ba 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -1781,7 +1781,12 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The ID of the point-in-time.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] } }, "required": [ @@ -2139,13 +2144,25 @@ "type": "object", "properties": { "cluster_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "http": { - "$ref": "#/components/schemas/nodes._types.Http" + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.Http" + } + ] }, "ingest": { - "$ref": "#/components/schemas/nodes._types.Ingest" + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.Ingest" + } + ] }, "thread_pool": { "type": "object", @@ -2154,7 +2171,11 @@ } }, "script": { - "$ref": "#/components/schemas/nodes._types.Scripting" + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.Scripting" + } + ] } }, "required": [ @@ -2204,7 +2225,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -2527,7 +2552,11 @@ "type": "string" }, "index_name": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "is_native": { "type": "boolean" @@ -2555,10 +2584,18 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] } }, "required": [ @@ -2609,7 +2646,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -2834,13 +2875,26 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The id of the associated connector", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "job_type": { - "$ref": "#/components/schemas/connector._types.SyncJobType" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.SyncJobType" + } + ] }, "trigger_method": { - "$ref": "#/components/schemas/connector._types.SyncJobTriggerMethod" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.SyncJobTriggerMethod" + } + ] } }, "required": [ @@ -2865,7 +2919,11 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] } }, "required": [ @@ -2915,7 +2973,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -2988,7 +3050,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -3041,7 +3107,11 @@ "type": "object", "properties": { "configuration": { - "$ref": "#/components/schemas/connector._types.ConnectorConfiguration" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.ConnectorConfiguration" + } + ] }, "values": { "type": "object", @@ -3072,7 +3142,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -3157,7 +3231,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -3222,7 +3300,11 @@ } }, "advanced_snippet": { - "$ref": "#/components/schemas/connector._types.FilteringAdvancedSnippet" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FilteringAdvancedSnippet" + } + ] } } }, @@ -3247,7 +3329,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -3300,7 +3386,11 @@ "type": "object", "properties": { "validation": { - "$ref": "#/components/schemas/connector._types.FilteringRulesValidation" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FilteringRulesValidation" + } + ] } }, "required": [ @@ -3320,7 +3410,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -3400,7 +3494,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -3477,7 +3575,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -3549,7 +3651,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -3597,7 +3703,11 @@ "type": "object", "properties": { "pipeline": { - "$ref": "#/components/schemas/connector._types.IngestPipelineParams" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.IngestPipelineParams" + } + ] } }, "required": [ @@ -3622,7 +3732,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -3674,7 +3788,11 @@ "type": "object", "properties": { "scheduling": { - "$ref": "#/components/schemas/connector._types.SchedulingConfiguration" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.SchedulingConfiguration" + } + ] } }, "required": [ @@ -3702,7 +3820,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -3779,7 +3901,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -3831,7 +3957,11 @@ "type": "object", "properties": { "status": { - "$ref": "#/components/schemas/connector._types.ConnectorStatus" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.ConnectorStatus" + } + ] } }, "required": [ @@ -3856,7 +3986,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -5232,10 +5366,20 @@ "type": "number" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "The documents to delete specified with Query DSL.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "slice": { - "$ref": "#/components/schemas/_types.SlicedScroll" + "description": "Slice the request manually using the provided slice ID and total number of slices.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SlicedScroll" + } + ] } } }, @@ -5297,32 +5441,64 @@ "type": "number" }, "retries": { - "$ref": "#/components/schemas/_types.Retries" + "description": "The number of retries attempted by delete by query.\n`bulk` is the number of bulk actions retried.\n`search` is the number of search actions retried.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Retries" + } + ] }, "slice_id": { "type": "number" }, "task": { - "$ref": "#/components/schemas/_types.TaskId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TaskId" + } + ] }, "throttled": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "throttled_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The number of milliseconds the request slept to conform to `requests_per_second`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "throttled_until": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "throttled_until_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "This field should always be equal to zero in a `_delete_by_query` response.\nIt has meaning only when using the task API, where it indicates the next time (in milliseconds since epoch) a throttled request will be run again in order to conform to `requests_per_second`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "timed_out": { "description": "If `true`, some requests run during the delete by query operation timed out.", "type": "boolean" }, "took": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The number of milliseconds from start to end of the whole operation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "total": { "description": "The number of documents that were successfully processed.", @@ -5393,13 +5569,21 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "found": { "type": "boolean" }, "script": { - "$ref": "#/components/schemas/_types.StoredScript" + "allOf": [ + { + "$ref": "#/components/schemas/_types.StoredScript" + } + ] } }, "required": [ @@ -5628,13 +5812,28 @@ "type": "object", "properties": { "geo_match": { - "$ref": "#/components/schemas/enrich._types.Policy" + "description": "Matches enrich data to incoming documents based on a `geo_shape` query.", + "allOf": [ + { + "$ref": "#/components/schemas/enrich._types.Policy" + } + ] }, "match": { - "$ref": "#/components/schemas/enrich._types.Policy" + "description": "Matches enrich data to incoming documents based on a `term` query.", + "allOf": [ + { + "$ref": "#/components/schemas/enrich._types.Policy" + } + ] }, "range": { - "$ref": "#/components/schemas/enrich._types.Policy" + "description": "Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query.", + "allOf": [ + { + "$ref": "#/components/schemas/enrich._types.Policy" + } + ] } } }, @@ -5769,10 +5968,18 @@ "type": "object", "properties": { "status": { - "$ref": "#/components/schemas/enrich.execute_policy.ExecuteEnrichPolicyStatus" + "allOf": [ + { + "$ref": "#/components/schemas/enrich.execute_policy.ExecuteEnrichPolicyStatus" + } + ] }, "task": { - "$ref": "#/components/schemas/_types.TaskId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TaskId" + } + ] } } } @@ -5948,7 +6155,12 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Identifier for the search.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "is_partial": { "description": "If true, the search request is still executing. If false, the search is completed.", @@ -5959,10 +6171,20 @@ "type": "boolean" }, "start_time_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "For a running search shows a timestamp when the eql search started, in milliseconds since the Unix epoch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "expiration_time_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "Shows a timestamp when the eql search will be expired, in milliseconds since the Unix epoch. When this time is reached, the search and its results are deleted, even if the search is still ongoing.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "completion_status": { "description": "For a completed search shows the http status code of the completed search.", @@ -6147,7 +6369,11 @@ "type": "number" }, "node": { - "$ref": "#/components/schemas/_types.NodeId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] }, "start_time_millis": { "type": "number" @@ -6159,7 +6385,11 @@ "type": "string" }, "coordinating_node": { - "$ref": "#/components/schemas/_types.NodeId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] }, "data_nodes": { "type": "array", @@ -6295,7 +6525,12 @@ "type": "boolean" }, "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "locale": { "type": "string" @@ -7724,10 +7959,20 @@ } }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "description": "Mapping for fields in the index. If specified, this mapping can include:\n- Field names\n- Field data types\n- Mapping parameters", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "settings": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "description": "Configuration options for the index.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] } } }, @@ -7760,7 +8005,11 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "shards_acknowledged": { "type": "boolean" @@ -9065,10 +9314,20 @@ "type": "object", "properties": { "data_retention": { - "$ref": "#/components/schemas/_types.Duration" + "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.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "downsampling": { - "$ref": "#/components/schemas/indices._types.DataStreamLifecycleDownsampling" + "description": "The downsampling configuration to execute for the managed backing index after rollover.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamLifecycleDownsampling" + } + ] }, "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.", @@ -9463,7 +9722,12 @@ "type": "object", "properties": { "failure_store": { - "$ref": "#/components/schemas/indices._types.DataStreamFailureStore" + "description": "If defined, it will update the failure store configuration of every data stream resolved by the name expression.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamFailureStore" + } + ] } } } @@ -10720,7 +10984,11 @@ } }, "template": { - "$ref": "#/components/schemas/indices.simulate_template.Template" + "allOf": [ + { + "$ref": "#/components/schemas/indices.simulate_template.Template" + } + ] } }, "required": [ @@ -11293,7 +11561,12 @@ ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.TaskSettings" + "description": "Optional task settings", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskSettings" + } + ] } }, "required": [ @@ -11656,10 +11929,20 @@ "type": "object", "properties": { "service": { - "$ref": "#/components/schemas/inference._types.Ai21ServiceType" + "description": "The type of service supported for the specified task type. In this case, `ai21`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.Ai21ServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.Ai21ServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `ai21` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.Ai21ServiceSettings" + } + ] } }, "required": [ @@ -11750,16 +12033,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.AlibabaCloudServiceType" + "description": "The type of service supported for the specified task type. In this case, `alibabacloud-ai-search`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AlibabaCloudServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.AlibabaCloudServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `alibabacloud-ai-search` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AlibabaCloudServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.AlibabaCloudTaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AlibabaCloudTaskSettings" + } + ] } }, "required": [ @@ -11862,16 +12168,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.AmazonBedrockServiceType" + "description": "The type of service supported for the specified task type. In this case, `amazonbedrock`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AmazonBedrockServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.AmazonBedrockServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `amazonbedrock` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AmazonBedrockServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.AmazonBedrockTaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AmazonBedrockTaskSettings" + } + ] } }, "required": [ @@ -11964,16 +12293,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.AmazonSageMakerServiceType" + "description": "The type of service supported for the specified task type. In this case, `amazon_sagemaker`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AmazonSageMakerServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.AmazonSageMakerServiceSettings" + "description": "Settings used to install the inference model.\nThese settings are specific to the `amazon_sagemaker` service and `service_settings.api` you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AmazonSageMakerServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.AmazonSageMakerTaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type and `service_settings.api` you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AmazonSageMakerTaskSettings" + } + ] } }, "required": [ @@ -12081,16 +12433,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.AnthropicServiceType" + "description": "The type of service supported for the specified task type. In this case, `anthropic`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AnthropicServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.AnthropicServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `watsonxai` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AnthropicServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.AnthropicTaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AnthropicTaskSettings" + } + ] } }, "required": [ @@ -12177,16 +12552,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.AzureAiStudioServiceType" + "description": "The type of service supported for the specified task type. In this case, `azureaistudio`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AzureAiStudioServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.AzureAiStudioServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `openai` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AzureAiStudioServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.AzureAiStudioTaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AzureAiStudioTaskSettings" + } + ] } }, "required": [ @@ -12284,16 +12682,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.AzureOpenAIServiceType" + "description": "The type of service supported for the specified task type. In this case, `azureopenai`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AzureOpenAIServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.AzureOpenAIServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `azureopenai` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AzureOpenAIServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.AzureOpenAITaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AzureOpenAITaskSettings" + } + ] } }, "required": [ @@ -12386,16 +12807,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.CohereServiceType" + "description": "The type of service supported for the specified task type. In this case, `cohere`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CohereServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.CohereServiceSettings" + "description": "Settings used to install the inference model.\nThese settings are specific to the `cohere` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CohereServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.CohereTaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CohereTaskSettings" + } + ] } }, "required": [ @@ -12483,16 +12927,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.CustomServiceType" + "description": "The type of service supported for the specified task type. In this case, `custom`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CustomServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.CustomServiceSettings" + "description": "Settings used to install the inference model.\nThese settings are specific to the `custom` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CustomServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.CustomTaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CustomTaskSettings" + } + ] } }, "required": [ @@ -12600,13 +13067,31 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.DeepSeekServiceType" + "description": "The type of service supported for the specified task type. In this case, `deepseek`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.DeepSeekServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.DeepSeekServiceSettings" + "description": "Settings used to install the inference model.\nThese settings are specific to the `deepseek` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.DeepSeekServiceSettings" + } + ] } }, "required": [ @@ -12687,16 +13172,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.ElasticsearchServiceType" + "description": "The type of service supported for the specified task type. In this case, `elasticsearch`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.ElasticsearchServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.ElasticsearchServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `elasticsearch` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.ElasticsearchServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.ElasticsearchTaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.ElasticsearchTaskSettings" + } + ] } }, "required": [ @@ -12815,13 +13323,31 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.ElserServiceType" + "description": "The type of service supported for the specified task type. In this case, `elser`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.ElserServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.ElserServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `elser` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.ElserServiceSettings" + } + ] } }, "required": [ @@ -12921,13 +13447,31 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.GoogleAiServiceType" + "description": "The type of service supported for the specified task type. In this case, `googleaistudio`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.GoogleAiServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.GoogleAiStudioServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `googleaistudio` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.GoogleAiStudioServiceSettings" + } + ] } }, "required": [ @@ -13015,16 +13559,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.GoogleVertexAIServiceType" + "description": "The type of service supported for the specified task type. In this case, `googlevertexai`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.GoogleVertexAIServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.GoogleVertexAIServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `googlevertexai` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.GoogleVertexAIServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.GoogleVertexAITaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.GoogleVertexAITaskSettings" + } + ] } }, "required": [ @@ -13117,16 +13684,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.HuggingFaceServiceType" + "description": "The type of service supported for the specified task type. In this case, `hugging_face`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.HuggingFaceServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.HuggingFaceServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `hugging_face` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.HuggingFaceServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.HuggingFaceTaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.HuggingFaceTaskSettings" + } + ] } }, "required": [ @@ -13219,16 +13809,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.JinaAIServiceType" + "description": "The type of service supported for the specified task type. In this case, `jinaai`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.JinaAIServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.JinaAIServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `jinaai` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.JinaAIServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.JinaAITaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.JinaAITaskSettings" + } + ] } }, "required": [ @@ -13321,13 +13934,31 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.LlamaServiceType" + "description": "The type of service supported for the specified task type. In this case, `llama`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.LlamaServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.LlamaServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `llama` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.LlamaServiceSettings" + } + ] } }, "required": [ @@ -13422,13 +14053,31 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.MistralServiceType" + "description": "The type of service supported for the specified task type. In this case, `mistral`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.MistralServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.MistralServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `mistral` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.MistralServiceSettings" + } + ] } }, "required": [ @@ -13515,16 +14164,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.OpenAIServiceType" + "description": "The type of service supported for the specified task type. In this case, `openai`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.OpenAIServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.OpenAIServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `openai` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.OpenAIServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.OpenAITaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.OpenAITaskSettings" + } + ] } }, "required": [ @@ -13617,16 +14289,39 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config" + }, + "description": "The chunking configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { - "$ref": "#/components/schemas/inference._types.VoyageAIServiceType" + "description": "The type of service supported for the specified task type. In this case, `voyageai`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.VoyageAIServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.VoyageAIServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `voyageai` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.VoyageAIServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.VoyageAITaskSettings" + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.VoyageAITaskSettings" + } + ] } }, "required": [ @@ -13719,10 +14414,20 @@ "type": "object", "properties": { "service": { - "$ref": "#/components/schemas/inference._types.WatsonxServiceType" + "description": "The type of service supported for the specified task type. In this case, `watsonxai`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.WatsonxServiceType" + } + ] }, "service_settings": { - "$ref": "#/components/schemas/inference._types.WatsonxServiceSettings" + "description": "Settings used to install the inference model. These settings are specific to the `watsonxai` service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.WatsonxServiceSettings" + } + ] } }, "required": [ @@ -13816,7 +14521,12 @@ ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.TaskSettings" + "description": "Task settings for the individual inference request.\nThese settings are specific to the task type you specified and override the task settings specified when initializing the service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskSettings" + } + ] } }, "required": [ @@ -13933,7 +14643,12 @@ ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.TaskSettings" + "description": "Optional task settings", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskSettings" + } + ] } }, "required": [ @@ -14029,7 +14744,12 @@ ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.TaskSettings" + "description": "Optional task settings", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskSettings" + } + ] } }, "required": [ @@ -14091,19 +14811,38 @@ "type": "object", "properties": { "cluster_name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The responding cluster's name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "cluster_uuid": { - "$ref": "#/components/schemas/_types.Uuid" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Uuid" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The responding node's name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "tagline": { "type": "string" }, "version": { - "$ref": "#/components/schemas/_types.ElasticsearchVersionInfo" + "description": "The running version of Elasticsearch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ElasticsearchVersionInfo" + } + ] } }, "required": [ @@ -14258,7 +14997,12 @@ "type": "object", "properties": { "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "description": { "description": "Description of the ingest pipeline.", @@ -14279,7 +15023,12 @@ } }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "deprecated": { "description": "Marks this ingest pipeline as deprecated.\nWhen a deprecated ingest pipeline is referenced as the default or final pipeline when creating or updating a non-deprecated index template, Elasticsearch will emit a deprecation warning.", @@ -14626,7 +15375,11 @@ "type": "object", "properties": { "license": { - "$ref": "#/components/schemas/license.get.LicenseInformation" + "allOf": [ + { + "$ref": "#/components/schemas/license.get.LicenseInformation" + } + ] } }, "required": [ @@ -15080,7 +15833,13 @@ "type": "boolean" }, "timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Refer to the description for the `timeout` query parameter.", + "default": "30m", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } } } @@ -15208,14 +15967,24 @@ "type": "object", "properties": { "calendar_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "A string that uniquely identifies a calendar.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "description": { "description": "A description of the calendar.", "type": "string" }, "job_ids": { - "$ref": "#/components/schemas/_types.Ids" + "description": "A list of anomaly detection job identifiers or group names.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Ids" + } + ] } }, "required": [ @@ -15415,14 +16184,24 @@ "type": "object", "properties": { "calendar_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "A string that uniquely identifies a calendar.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "description": { "description": "A description of the calendar.", "type": "string" }, "job_ids": { - "$ref": "#/components/schemas/_types.Ids" + "description": "A list of anomaly detection job identifiers or group names.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Ids" + } + ] } }, "required": [ @@ -15482,14 +16261,24 @@ "type": "object", "properties": { "calendar_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "A string that uniquely identifies a calendar.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "description": { "description": "A description of the calendar.", "type": "string" }, "job_ids": { - "$ref": "#/components/schemas/_types.Ids" + "description": "A list of anomaly detection job identifiers or group names.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Ids" + } + ] } }, "required": [ @@ -15586,17 +16375,32 @@ "type": "boolean" }, "analysis": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer" + "description": "The analysis configuration, which contains the information necessary to\nperform one of the following types of analysis: classification, outlier\ndetection, or regression.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer" + } + ] }, "analyzed_fields": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields" + "description": "Specifies `includes` and/or `excludes` patterns to select which fields\nwill be included in the analysis. The patterns specified in `excludes`\nare applied last, therefore `excludes` takes precedence. In other words,\nif the same field is specified in both `includes` and `excludes`, then\nthe field will not be included in the analysis. If `analyzed_fields` is\nnot set, only the relevant fields will be included. For example, all the\nnumeric fields for outlier detection.\nThe supported fields vary for each type of analysis. Outlier detection\nrequires numeric or `boolean` data to analyze. The algorithms don’t\nsupport missing values therefore fields that have data types other than\nnumeric or boolean are ignored. Documents where included fields contain\nmissing values, null values, or an array are also ignored. Therefore the\n`dest` index may contain documents that don’t have an outlier score.\nRegression supports fields that are numeric, `boolean`, `text`,\n`keyword`, and `ip` data types. It is also tolerant of missing values.\nFields that are supported are included in the analysis, other fields are\nignored. Documents where included fields contain an array with two or\nmore values are also ignored. Documents in the `dest` index that don’t\ncontain a results field are not included in the regression analysis.\nClassification supports fields that are numeric, `boolean`, `text`,\n`keyword`, and `ip` data types. It is also tolerant of missing values.\nFields that are supported are included in the analysis, other fields are\nignored. Documents where included fields contain an array with two or\nmore values are also ignored. Documents in the `dest` index that don’t\ncontain a results field are not included in the classification analysis.\nClassification analysis can be improved by mapping ordinal variable\nvalues to a single number. For example, in case of age ranges, you can\nmodel the values as `0-14 = 0`, `15-24 = 1`, `25-34 = 2`, and so on.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields" + } + ] }, "description": { "description": "A description of the job.", "type": "string" }, "dest": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsDestination" + "description": "The destination configuration.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsDestination" + } + ] }, "max_num_threads": { "description": "The maximum number of threads to be used by the analysis. Using more\nthreads may decrease the time necessary to complete the analysis at the\ncost of using more CPU. Note that the process may use additional threads\nfor operational functionality other than the analysis itself.", @@ -15604,7 +16408,11 @@ "type": "number" }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "model_memory_limit": { "description": "The approximate maximum amount of memory resources that are permitted for\nanalytical processing. If your `elasticsearch.yml` file contains an\n`xpack.ml.max_model_memory_limit` setting, an error occurs when you try\nto create data frame analytics jobs that have `model_memory_limit` values\ngreater than that setting.", @@ -15612,13 +16420,28 @@ "type": "string" }, "source": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource" + "description": "The configuration of how to source the analysis data.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource" + } + ] }, "headers": { - "$ref": "#/components/schemas/_types.HttpHeaders" + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.HttpHeaders" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] } }, "required": [ @@ -15646,43 +16469,79 @@ "type": "object", "properties": { "authorization": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsAuthorization" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsAuthorization" + } + ] }, "allow_lazy_start": { "type": "boolean" }, "analysis": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer" + } + ] }, "analyzed_fields": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields" + } + ] }, "create_time": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "description": { "type": "string" }, "dest": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsDestination" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsDestination" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "max_num_threads": { "type": "number" }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "model_memory_limit": { "type": "string" }, "source": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] } }, "required": [ @@ -15882,35 +16741,81 @@ } }, "chunking_config": { - "$ref": "#/components/schemas/ml._types.ChunkingConfig" + "description": "Datafeeds might be required to search over long time periods, for several months or years.\nThis search is split into time chunks in order to ensure the load on Elasticsearch is managed.\nChunking configuration controls how the size of these time chunks are calculated;\nit is an advanced configuration option.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ChunkingConfig" + } + ] }, "delayed_data_check_config": { - "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig" + "description": "Specifies whether the datafeed checks for missing data and the size of the window.\nThe datafeed can optionally search over indices that have already been read in an effort to determine whether\nany data has subsequently been added to the index. If missing data is found, it is a good indication that the\n`query_delay` is set too low and the data is being indexed after the datafeed has passed that moment in time.\nThis check runs only on real-time datafeeds.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig" + } + ] }, "frequency": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The interval at which scheduled queries are made while the datafeed runs in real time.\nThe default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible\nfraction of the bucket span. When `frequency` is shorter than the bucket span, interim results for the last\n(partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses\naggregations, this value must be divisible by the interval of the date histogram aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "indices": { - "$ref": "#/components/schemas/_types.Indices" + "description": "An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the master\nnodes and the machine learning nodes must have the `remote_cluster_client` role.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "indices_options": { - "$ref": "#/components/schemas/_types.IndicesOptions" + "description": "Specifies index expansion options that are used during search", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndicesOptions" + } + ] }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Identifier for the anomaly detection job.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "max_empty_searches": { "description": "If a real-time datafeed has never seen any data (including during any initial training period), it automatically\nstops and closes the associated job after this many real-time searches return no documents. In other words,\nit stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no\nend time that sees no data remains started until it is explicitly stopped. By default, it is not set.", "type": "number" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an\nElasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this\nobject is passed verbatim to Elasticsearch.", + "default": "{\"match_all\": {\"boost\": 1}}", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "query_delay": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might\nnot be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default\nvalue is randomly selected between `60s` and `120s`. This randomness improves the query performance\nwhen there are multiple jobs running on the same node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "description": "Specifies runtime fields for the datafeed search.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "script_fields": { "description": "Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.\nThe detector configuration objects in a job can contain functions that use these script fields.", @@ -15925,7 +16830,12 @@ "type": "number" }, "headers": { - "$ref": "#/components/schemas/_types.HttpHeaders" + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.HttpHeaders" + } + ] } } }, @@ -15954,19 +16864,39 @@ } }, "authorization": { - "$ref": "#/components/schemas/ml._types.DatafeedAuthorization" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DatafeedAuthorization" + } + ] }, "chunking_config": { - "$ref": "#/components/schemas/ml._types.ChunkingConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ChunkingConfig" + } + ] }, "delayed_data_check_config": { - "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig" + } + ] }, "datafeed_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "frequency": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "indices": { "type": "array", @@ -15975,22 +16905,42 @@ } }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "indices_options": { - "$ref": "#/components/schemas/_types.IndicesOptions" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndicesOptions" + } + ] }, "max_empty_searches": { "type": "number" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "query_delay": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "script_fields": { "type": "object", @@ -16174,7 +17124,11 @@ "type": "string" }, "filter_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "items": { "type": "array", @@ -16352,16 +17306,36 @@ "type": "boolean" }, "analysis_config": { - "$ref": "#/components/schemas/ml._types.AnalysisConfig" + "description": "Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AnalysisConfig" + } + ] }, "analysis_limits": { - "$ref": "#/components/schemas/ml._types.AnalysisLimits" + "description": "Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AnalysisLimits" + } + ] }, "background_persist_interval": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the `background_persist_interval` value too low.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "custom_settings": { - "$ref": "#/components/schemas/ml._types.CustomSettings" + "description": "Advanced configuration option. Contains custom meta data about the job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.CustomSettings" + } + ] }, "daily_model_snapshot_retention_after_days": { "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to `model_snapshot_retention_days`.", @@ -16369,17 +17343,32 @@ "type": "number" }, "data_description": { - "$ref": "#/components/schemas/ml._types.DataDescription" + "description": "Defines the format of the input data when you send data to the job by using the post data API. Note that when configure a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataDescription" + } + ] }, "datafeed_config": { - "$ref": "#/components/schemas/ml._types.DatafeedConfig" + "description": "Defines a datafeed for the anomaly detection job. If Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DatafeedConfig" + } + ] }, "description": { "description": "A description of the job.", "type": "string" }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "groups": { "description": "A list of job groups. A job can belong to no groups or many.", @@ -16389,7 +17378,12 @@ } }, "model_plot_config": { - "$ref": "#/components/schemas/ml._types.ModelPlotConfig" + "description": "This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ModelPlotConfig" + } + ] }, "model_snapshot_retention_days": { "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted.", @@ -16401,7 +17395,13 @@ "type": "number" }, "results_index_name": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "A text string that affects the name of the machine learning results index. By default, the job generates an index named `.ml-anomalies-shared`.", + "default": "shared", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "results_retention_days": { "description": "Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever.", @@ -16435,28 +17435,56 @@ "type": "boolean" }, "analysis_config": { - "$ref": "#/components/schemas/ml._types.AnalysisConfigRead" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AnalysisConfigRead" + } + ] }, "analysis_limits": { - "$ref": "#/components/schemas/ml._types.AnalysisLimits" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AnalysisLimits" + } + ] }, "background_persist_interval": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "create_time": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "custom_settings": { - "$ref": "#/components/schemas/ml._types.CustomSettings" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.CustomSettings" + } + ] }, "daily_model_snapshot_retention_after_days": { "type": "number" }, "data_description": { - "$ref": "#/components/schemas/ml._types.DataDescription" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataDescription" + } + ] }, "datafeed_config": { - "$ref": "#/components/schemas/ml._types.Datafeed" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Datafeed" + } + ] }, "description": { "type": "string" @@ -16468,7 +17496,11 @@ } }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "job_type": { "type": "string" @@ -16477,10 +17509,18 @@ "type": "string" }, "model_plot_config": { - "$ref": "#/components/schemas/ml._types.ModelPlotConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ModelPlotConfig" + } + ] }, "model_snapshot_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "model_snapshot_retention_days": { "type": "number" @@ -16710,24 +17750,45 @@ "type": "string" }, "definition": { - "$ref": "#/components/schemas/ml.put_trained_model.Definition" + "description": "The inference definition for the model. If definition is specified, then\ncompressed_definition cannot be specified.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.Definition" + } + ] }, "description": { "description": "A human-readable description of the inference trained model.", "type": "string" }, "inference_config": { - "$ref": "#/components/schemas/ml._types.InferenceConfigCreateContainer" + "description": "The default configuration for inference. This can be either a regression\nor classification configuration. It must match the underlying\ndefinition.trained_model's target_type. For pre-packaged models such as\nELSER the config is not required.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.InferenceConfigCreateContainer" + } + ] }, "input": { - "$ref": "#/components/schemas/ml.put_trained_model.Input" + "description": "The input field names for the model definition.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.Input" + } + ] }, "metadata": { "description": "An object map that contains metadata about the model.", "type": "object" }, "model_type": { - "$ref": "#/components/schemas/ml._types.TrainedModelType" + "description": "The model type.", + "default": "tree_ensemble", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelType" + } + ] }, "model_size_bytes": { "description": "The estimated memory usage in bytes to keep the trained model in memory.\nThis property is supported only if defer_definition_decompression is true\nor the model definition is not supplied.", @@ -16745,7 +17806,13 @@ } }, "prefix_strings": { - "$ref": "#/components/schemas/ml._types.TrainedModelPrefixStrings" + "description": "Optional prefix strings applied at inference", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelPrefixStrings" + } + ] } } } @@ -16975,7 +18042,12 @@ "type": "object", "properties": { "analysis_config": { - "$ref": "#/components/schemas/ml._types.AnalysisConfig" + "description": "For a list of the properties that you can specify in the\n`analysis_config` component of the body of this API.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AnalysisConfig" + } + ] }, "max_bucket_cardinality": { "description": "Estimates of the highest cardinality in a single bucket that is observed\nfor influencer fields over the time period that the job analyzes data.\nTo produce a good answer, values must be provided for all influencer\nfields. Providing values for fields that are not listed as `influencers`\nhas no effect on the estimation.", @@ -17053,13 +18125,28 @@ "type": "object", "properties": { "evaluation": { - "$ref": "#/components/schemas/ml._types.DataframeEvaluationContainer" + "description": "Defines the type of evaluation you want to perform.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeEvaluationContainer" + } + ] }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "Defines the `index` in which the evaluation will be performed.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "A query clause that retrieves a subset of data from the source index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } }, "required": [ @@ -17107,13 +18194,28 @@ "type": "object", "properties": { "classification": { - "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummary" + "description": "Evaluation results for a classification analysis.\nIt outputs a prediction that identifies to which of the classes each document belongs.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummary" + } + ] }, "outlier_detection": { - "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeOutlierDetectionSummary" + "description": "Evaluation results for an outlier detection analysis.\nIt outputs the probability that each document is an outlier.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeOutlierDetectionSummary" + } + ] }, "regression": { - "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeRegressionSummary" + "description": "Evaluation results for a regression analysis which outputs a prediction of values.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeRegressionSummary" + } + ] } } }, @@ -17225,20 +18327,40 @@ "type": "object", "properties": { "advance_time": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "Refer to the description for the `advance_time` query parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "calc_interim": { "description": "Refer to the description for the `calc_interim` query parameter.", "type": "boolean" }, "end": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "Refer to the description for the `end` query parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "skip_time": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "Refer to the description for the `skip_time` query parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "start": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "Refer to the description for the `start` query parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] } } }, @@ -18111,7 +19233,12 @@ } }, "inference_config": { - "$ref": "#/components/schemas/ml._types.InferenceConfigUpdateContainer" + "description": "The inference configuration updates to apply on the API call", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.InferenceConfigUpdateContainer" + } + ] } }, "required": [ @@ -18198,7 +19325,13 @@ "type": "object", "properties": { "timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Refer to the description for the `timeout` query parameter.", + "default": "30m", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } } }, @@ -18223,7 +19356,12 @@ "type": "boolean" }, "node": { - "$ref": "#/components/schemas/_types.NodeId" + "description": "The ID of the node that the job was started on. In serverless this will be the \"serverless\".\nIf the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] } }, "required": [ @@ -18769,7 +19907,12 @@ "type": "boolean" }, "node": { - "$ref": "#/components/schemas/_types.NodeId" + "description": "The ID of the node that the job was started on. If the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string.\nThe node ID of the node the job has been assigned to, or\nan empty string if it hasn't been assigned to a node. In\nserverless if the job has been assigned to run then the\nnode ID will be \"serverless\".", + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] } }, "required": [ @@ -18848,13 +19991,29 @@ "type": "object", "properties": { "end": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "Refer to the description for the `end` query parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "start": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "Refer to the description for the `start` query parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Refer to the description for the `timeout` query parameter.", + "default": "20s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } } }, @@ -18876,7 +20035,12 @@ "type": "object", "properties": { "node": { - "$ref": "#/components/schemas/_types.NodeIds" + "description": "The ID of the node that the job was started on. In serverless this will be the \"serverless\".\nIf the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeIds" + } + ] }, "started": { "description": "For a successful response, this value is always `true`. On failure, an exception is returned instead.", @@ -18999,7 +20163,12 @@ "type": "object", "properties": { "adaptive_allocations": { - "$ref": "#/components/schemas/ml._types.AdaptiveAllocationsSettings" + "description": "Adaptive allocations configuration. When enabled, the number of allocations\nis set based on the current load.\nIf adaptive_allocations is enabled, do not set the number of allocations manually.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AdaptiveAllocationsSettings" + } + ] } } } @@ -19015,7 +20184,11 @@ "type": "object", "properties": { "assignment": { - "$ref": "#/components/schemas/ml._types.TrainedModelAssignment" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelAssignment" + } + ] } }, "required": [ @@ -19183,7 +20356,13 @@ "type": "boolean" }, "timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Refer to the description for the `timeout` query parameter.", + "default": "20s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } } }, @@ -19362,16 +20541,28 @@ "type": "object", "properties": { "authorization": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsAuthorization" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsAuthorization" + } + ] }, "allow_lazy_start": { "type": "boolean" }, "analysis": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer" + } + ] }, "analyzed_fields": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields" + } + ] }, "create_time": { "type": "number" @@ -19380,10 +20571,18 @@ "type": "string" }, "dest": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsDestination" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsDestination" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "max_num_threads": { "type": "number" @@ -19392,10 +20591,18 @@ "type": "string" }, "source": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] } }, "required": [ @@ -19498,13 +20705,28 @@ } }, "chunking_config": { - "$ref": "#/components/schemas/ml._types.ChunkingConfig" + "description": "Datafeeds might search over long time periods, for several months or years. This search is split into time\nchunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of\nthese time chunks are calculated; it is an advanced configuration option.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ChunkingConfig" + } + ] }, "delayed_data_check_config": { - "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig" + "description": "Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally\nsearch over indices that have already been read in an effort to determine whether any data has subsequently been\nadded to the index. If missing data is found, it is a good indication that the `query_delay` is set too low and\nthe data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time\ndatafeeds.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig" + } + ] }, "frequency": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The interval at which scheduled queries are made while the datafeed runs in real time. The default value is\neither the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket\nspan. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are\nwritten then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value\nmust be divisible by the interval of the date histogram aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "indices": { "description": "An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine\nlearning nodes must have the `remote_cluster_client` role.", @@ -19514,23 +20736,48 @@ } }, "indices_options": { - "$ref": "#/components/schemas/_types.IndicesOptions" + "description": "Specifies index expansion options that are used during search.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndicesOptions" + } + ] }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "max_empty_searches": { "description": "If a real-time datafeed has never seen any data (including during any initial training period), it automatically\nstops and closes the associated job after this many real-time searches return no documents. In other words,\nit stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no\nend time that sees no data remains started until it is explicitly stopped. By default, it is not set.", "type": "number" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an\nElasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this\nobject is passed verbatim to Elasticsearch. Note that if you change the query, the analyzed data is also\nchanged. Therefore, the time required to learn might be long and the understandability of the results is\nunpredictable. If you want to make significant changes to the source data, it is recommended that you\nclone the job and datafeed and make the amendments in the clone. Let both run in parallel and close one\nwhen you are satisfied with the results of the job.", + "default": "{\"match_all\": {\"boost\": 1}}", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "query_delay": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might\nnot be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default\nvalue is randomly selected between `60s` and `120s`. This randomness improves the query performance\nwhen there are multiple jobs running on the same node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "description": "Specifies runtime fields for the datafeed search.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "script_fields": { "description": "Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.\nThe detector configuration objects in a job can contain functions that use these script fields.", @@ -19565,7 +20812,11 @@ "type": "object", "properties": { "authorization": { - "$ref": "#/components/schemas/ml._types.DatafeedAuthorization" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DatafeedAuthorization" + } + ] }, "aggregations": { "type": "object", @@ -19574,16 +20825,32 @@ } }, "chunking_config": { - "$ref": "#/components/schemas/ml._types.ChunkingConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ChunkingConfig" + } + ] }, "delayed_data_check_config": { - "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig" + } + ] }, "datafeed_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "frequency": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "indices": { "type": "array", @@ -19592,22 +20859,42 @@ } }, "indices_options": { - "$ref": "#/components/schemas/_types.IndicesOptions" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndicesOptions" + } + ] }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "max_empty_searches": { "type": "number" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "query_delay": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "script_fields": { "type": "object", @@ -19711,7 +20998,11 @@ "type": "string" }, "filter_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "items": { "type": "array", @@ -19772,10 +21063,19 @@ "type": "boolean" }, "analysis_limits": { - "$ref": "#/components/schemas/ml._types.AnalysisMemoryLimit" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AnalysisMemoryLimit" + } + ] }, "background_persist_interval": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Advanced configuration option. The time between each periodic persistence\nof the model.\nThe default value is a randomized value between 3 to 4 hours, which\navoids all jobs persisting at exactly the same time. The smallest allowed\nvalue is 1 hour.\nFor very large models (several GB), persistence could take 10-20 minutes,\nso do not set the value too low.\nIf the job is open when you make the update, you must stop the datafeed,\nclose the job, then reopen the job and restart the datafeed for the\nchanges to take effect.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "custom_settings": { "description": "Advanced configuration option. Contains custom meta data about the job.\nFor example, it can contain custom URL information as shown in Adding\ncustom URLs to machine learning results.", @@ -19795,10 +21095,18 @@ "type": "string" }, "model_plot_config": { - "$ref": "#/components/schemas/ml._types.ModelPlotConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ModelPlotConfig" + } + ] }, "model_prune_window": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "daily_model_snapshot_retention_after_days": { "description": "Advanced configuration option, which affects the automatic removal of old\nmodel snapshots for this job. It specifies a period of time (in days)\nafter which only the first snapshot per day is retained. This period is\nrelative to the timestamp of the most recent snapshot for this job. Valid\nvalues range from 0 to `model_snapshot_retention_days`. For jobs created\nbefore version 7.8.0, the default value matches\n`model_snapshot_retention_days`.", @@ -19833,7 +21141,12 @@ } }, "per_partition_categorization": { - "$ref": "#/components/schemas/ml._types.PerPartitionCategorization" + "description": "Settings related to how categorization interacts with partition fields.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.PerPartitionCategorization" + } + ] } } }, @@ -19859,19 +21172,39 @@ "type": "boolean" }, "analysis_config": { - "$ref": "#/components/schemas/ml._types.AnalysisConfigRead" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AnalysisConfigRead" + } + ] }, "analysis_limits": { - "$ref": "#/components/schemas/ml._types.AnalysisLimits" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AnalysisLimits" + } + ] }, "background_persist_interval": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "create_time": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "finished_time": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "custom_settings": { "type": "object", @@ -19883,10 +21216,18 @@ "type": "number" }, "data_description": { - "$ref": "#/components/schemas/ml._types.DataDescription" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataDescription" + } + ] }, "datafeed_config": { - "$ref": "#/components/schemas/ml._types.Datafeed" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Datafeed" + } + ] }, "description": { "type": "string" @@ -19898,19 +21239,35 @@ } }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "job_type": { "type": "string" }, "job_version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "model_plot_config": { - "$ref": "#/components/schemas/ml._types.ModelPlotConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ModelPlotConfig" + } + ] }, "model_snapshot_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "model_snapshot_retention_days": { "type": "number" @@ -19919,7 +21276,11 @@ "type": "number" }, "results_index_name": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "results_retention_days": { "type": "number" @@ -19995,7 +21356,12 @@ "type": "number" }, "adaptive_allocations": { - "$ref": "#/components/schemas/ml._types.AdaptiveAllocationsSettings" + "description": "Adaptive allocations configuration. When enabled, the number of allocations\nis set based on the current load.\nIf adaptive_allocations is enabled, do not set the number of allocations manually.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AdaptiveAllocationsSettings" + } + ] } } }, @@ -20017,7 +21383,11 @@ "type": "object", "properties": { "assignment": { - "$ref": "#/components/schemas/ml._types.TrainedModelAssignment" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelAssignment" + } + ] } }, "required": [ @@ -20854,7 +22224,12 @@ "type": "object", "properties": { "index_filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Filter indices if the provided query rewrites to `match_none` on every shard.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } } } @@ -20870,10 +22245,19 @@ "type": "object", "properties": { "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "description": "Shards used to create the PIT", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] } }, "required": [ @@ -21090,7 +22474,12 @@ "type": "object", "properties": { "type": { - "$ref": "#/components/schemas/query_rules._types.QueryRuleType" + "description": "The type of rule.", + "allOf": [ + { + "$ref": "#/components/schemas/query_rules._types.QueryRuleType" + } + ] }, "criteria": { "description": "The criteria that must be met for the rule to be applied.\nIf multiple criteria are specified for a rule, all criteria must be met for the rule to be applied.", @@ -21107,7 +22496,12 @@ ] }, "actions": { - "$ref": "#/components/schemas/query_rules._types.QueryRuleActions" + "description": "The actions to take when the rule is matched.\nThe format of this action depends on the rule type.", + "allOf": [ + { + "$ref": "#/components/schemas/query_rules._types.QueryRuleActions" + } + ] }, "priority": { "type": "number" @@ -21138,7 +22532,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -21323,7 +22721,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -21815,23 +23217,44 @@ "type": "object", "properties": { "conflicts": { - "$ref": "#/components/schemas/_types.Conflicts" + "description": "Indicates whether to continue reindexing even when there are conflicts.", + "default": "abort", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Conflicts" + } + ] }, "dest": { - "$ref": "#/components/schemas/_global.reindex.Destination" + "description": "The destination you are copying to.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.reindex.Destination" + } + ] }, "max_docs": { "description": "The maximum number of documents to reindex.\nBy default, all documents are reindexed.\nIf it is a value less then or equal to `scroll_size`, a scroll will not be used to retrieve the results for the operation.\n\nIf `conflicts` is set to `proceed`, the reindex operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query.", "type": "number" }, "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "The script to run to update the document source or metadata when reindexing.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "size": { "type": "number" }, "source": { - "$ref": "#/components/schemas/_global.reindex.Source" + "description": "The source you are copying from.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.reindex.Source" + } + ] } }, "required": [ @@ -21942,7 +23365,12 @@ "type": "number" }, "retries": { - "$ref": "#/components/schemas/_types.Retries" + "description": "The number of retries attempted by reindex.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Retries" + } + ] }, "requests_per_second": { "description": "The number of requests per second effectively run during the reindex.", @@ -21952,20 +23380,39 @@ "type": "number" }, "task": { - "$ref": "#/components/schemas/_types.TaskId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TaskId" + } + ] }, "throttled_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The number of milliseconds the request slept to conform to `requests_per_second`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "throttled_until_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "This field should always be equal to zero in a reindex response.\nIt has meaning only when using the task API, where it indicates the next time (in milliseconds since epoch) that a throttled request will be run again in order to conform to `requests_per_second`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "timed_out": { "description": "If any of the requests that ran during the reindex timed out, it is `true`.", "type": "boolean" }, "took": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The total milliseconds the entire operation took.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "total": { "description": "The number of documents that were successfully processed.", @@ -22904,7 +24351,11 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] } }, "required": [ @@ -23677,10 +25128,18 @@ "type": "object", "properties": { "api_key": { - "$ref": "#/components/schemas/security.authenticate.AuthenticateApiKey" + "allOf": [ + { + "$ref": "#/components/schemas/security.authenticate.AuthenticateApiKey" + } + ] }, "authentication_realm": { - "$ref": "#/components/schemas/security._types.RealmInfo" + "allOf": [ + { + "$ref": "#/components/schemas/security._types.RealmInfo" + } + ] }, "email": { "oneOf": [ @@ -23705,10 +25164,18 @@ ] }, "lookup_realm": { - "$ref": "#/components/schemas/security._types.RealmInfo" + "allOf": [ + { + "$ref": "#/components/schemas/security._types.RealmInfo" + } + ] }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "roles": { "type": "array", @@ -23717,7 +25184,11 @@ } }, "username": { - "$ref": "#/components/schemas/_types.Username" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Username" + } + ] }, "enabled": { "type": "boolean" @@ -23726,7 +25197,12 @@ "type": "string" }, "token": { - "$ref": "#/components/schemas/security.authenticate.Token" + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/security.authenticate.Token" + } + ] } }, "required": [ @@ -23972,7 +25448,11 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "ids": { "description": "A list of API key ids.\nThis parameter cannot be used with any of `name`, `realm_name`, or `username`.", @@ -23982,7 +25462,12 @@ } }, "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "An API key name.\nThis parameter cannot be used with any of `ids`, `realm_name` or `username`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "owner": { "description": "Query API keys owned by the currently authenticated user.\nThe `realm_name` or `username` parameters cannot be specified when this parameter is set to `true` as they are assumed to be the currently authenticated ones.\n\nNOTE: At least one of `ids`, `name`, `username`, and `realm_name` must be specified if `owner` is `false`.", @@ -23994,7 +25479,12 @@ "type": "string" }, "username": { - "$ref": "#/components/schemas/_types.Username" + "description": "The username of a user.\nThis parameter cannot be used with either `ids` or `name` or when `owner` flag is set to `true`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Username" + } + ] } } }, @@ -24619,10 +26109,20 @@ } }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Arbitrary metadata that you want to associate with the API key.\nIt supports a nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.\nWhen specified, this value fully replaces the metadata previously associated with the API key.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "expiration": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The expiration time for the API key.\nBy default, API keys never expire.\nThis property can be omitted to leave the expiration unchanged.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } } }, @@ -24851,7 +26351,12 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Identifier for the search.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-ID` HTTP header.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "is_running": { "description": "If `true`, the search is still running.\nIf `false`, the search has finished.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header.", @@ -24930,7 +26435,12 @@ "type": "object", "properties": { "expiration_time_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The timestamp, in milliseconds since the Unix epoch, when Elasticsearch will delete the search and its results, even if the search is still running.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "id": { "description": "The identifier for the search.", @@ -24945,10 +26455,20 @@ "type": "boolean" }, "start_time_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The timestamp, in milliseconds since the Unix epoch, when the search started.\nThe API returns this property only for running searches.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "completion_status": { - "$ref": "#/components/schemas/_types.uint" + "description": "The HTTP status code for the search.\nThe API returns this property only for completed searches.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] } }, "required": [ @@ -25224,10 +26744,20 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "description": "The update operation result.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] }, "reload_analyzers_details": { - "$ref": "#/components/schemas/indices.reload_search_analyzers.ReloadResult" + "description": "Updating a synonyms set can reload the associated analyzers in case refresh is set to true.\nThis information is the analyzers reloading result.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.reload_search_analyzers.ReloadResult" + } + ] } }, "required": [ @@ -25383,7 +26913,15 @@ "type": "object", "properties": { "synonyms": { - "$ref": "#/components/schemas/synonyms._types.SynonymString" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/text-analysis/analysis-synonym-graph-tokenfilter#analysis-synonym-graph-define-synonyms" + }, + "description": "The synonym rule information definition, which must be in Solr format.", + "allOf": [ + { + "$ref": "#/components/schemas/synonyms._types.SynonymString" + } + ] } }, "required": [ @@ -25612,13 +27150,21 @@ "type": "boolean" }, "task": { - "$ref": "#/components/schemas/tasks._types.TaskInfo" + "allOf": [ + { + "$ref": "#/components/schemas/tasks._types.TaskInfo" + } + ] }, "response": { "type": "object" }, "error": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] } }, "required": [ @@ -26064,35 +27610,81 @@ "type": "object", "properties": { "dest": { - "$ref": "#/components/schemas/transform._types.Destination" + "description": "The destination for the transform.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Destination" + } + ] }, "description": { "description": "Free text description of the transform.", "type": "string" }, "frequency": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The interval between checks for changes in the source indices when the transform is running continuously. Also\ndetermines the retry interval in the event of transient failures while the transform is searching or indexing.\nThe minimum value is `1s` and the maximum is `1h`.", + "default": "1m", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "latest": { - "$ref": "#/components/schemas/transform._types.Latest" + "description": "The latest method transforms the data by finding the latest document for each unique key.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Latest" + } + ] }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Defines optional transform metadata.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "pivot": { - "$ref": "#/components/schemas/transform._types.Pivot" + "description": "The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields\nand the aggregation to reduce the data.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Pivot" + } + ] }, "retention_policy": { - "$ref": "#/components/schemas/transform._types.RetentionPolicyContainer" + "description": "Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the\ndestination index.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.RetentionPolicyContainer" + } + ] }, "settings": { - "$ref": "#/components/schemas/transform._types.Settings" + "description": "Defines optional transform settings.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Settings" + } + ] }, "source": { - "$ref": "#/components/schemas/transform._types.Source" + "description": "The source of the data for the transform.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Source" + } + ] }, "sync": { - "$ref": "#/components/schemas/transform._types.SyncContainer" + "description": "Defines the properties transforms require to run continuously.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.SyncContainer" + } + ] } }, "required": [ @@ -26820,26 +28412,57 @@ "type": "object", "properties": { "dest": { - "$ref": "#/components/schemas/transform._types.Destination" + "description": "The destination for the transform.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Destination" + } + ] }, "description": { "description": "Free text description of the transform.", "type": "string" }, "frequency": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is 1s and the maximum is 1h.", + "default": "1m", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Defines optional transform metadata.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "source": { - "$ref": "#/components/schemas/transform._types.Source" + "description": "The source of the data for the transform.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Source" + } + ] }, "settings": { - "$ref": "#/components/schemas/transform._types.Settings" + "description": "Defines optional transform settings.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Settings" + } + ] }, "sync": { - "$ref": "#/components/schemas/transform._types.SyncContainer" + "description": "Defines the properties transforms require to run continuously.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.SyncContainer" + } + ] }, "retention_policy": { "description": "Defines a retention policy for the transform. Data that meets the defined\ncriteria is deleted from the destination index.", @@ -26874,7 +28497,11 @@ "type": "object", "properties": { "authorization": { - "$ref": "#/components/schemas/ml._types.TransformAuthorization" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TransformAuthorization" + } + ] }, "create_time": { "type": "number" @@ -26883,37 +28510,81 @@ "type": "string" }, "dest": { - "$ref": "#/components/schemas/_global.reindex.Destination" + "allOf": [ + { + "$ref": "#/components/schemas/_global.reindex.Destination" + } + ] }, "frequency": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "latest": { - "$ref": "#/components/schemas/transform._types.Latest" + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Latest" + } + ] }, "pivot": { - "$ref": "#/components/schemas/transform._types.Pivot" + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Pivot" + } + ] }, "retention_policy": { - "$ref": "#/components/schemas/transform._types.RetentionPolicyContainer" + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.RetentionPolicyContainer" + } + ] }, "settings": { - "$ref": "#/components/schemas/transform._types.Settings" + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Settings" + } + ] }, "source": { - "$ref": "#/components/schemas/_global.reindex.Source" + "allOf": [ + { + "$ref": "#/components/schemas/_global.reindex.Source" + } + ] }, "sync": { - "$ref": "#/components/schemas/transform._types.SyncContainer" + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.SyncContainer" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] } }, "required": [ @@ -27132,7 +28803,12 @@ "type": "boolean" }, "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "The script to run to update the document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "scripted_upsert": { "description": "If `true`, run the script whether or not the document exists.", @@ -27140,7 +28816,13 @@ "type": "boolean" }, "_source": { - "$ref": "#/components/schemas/_global.search._types.SourceConfig" + "description": "If `false`, turn off source retrieval.\nYou can also specify a comma-separated list of the fields you want to retrieve.", + "default": "true", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.SourceConfig" + } + ] }, "upsert": { "description": "If the document does not already exist, the contents of 'upsert' are inserted as a new document.\nIf the document exists, the 'script' is run.", @@ -27589,16 +29271,37 @@ "type": "number" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "The documents to update using the Query DSL.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "The script to run to update the document source or metadata when updating.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "slice": { - "$ref": "#/components/schemas/_types.SlicedScroll" + "description": "Slice the request manually using the provided slice ID and total number of slices.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SlicedScroll" + } + ] }, "conflicts": { - "$ref": "#/components/schemas/_types.Conflicts" + "description": "The preferred behavior when update by query hits version conflicts: `abort` or `proceed`.", + "default": "abort", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Conflicts" + } + ] } } }, @@ -27659,17 +29362,31 @@ "type": "number" }, "retries": { - "$ref": "#/components/schemas/_types.Retries" + "description": "The number of retries attempted by update by query.\n`bulk` is the number of bulk actions retried.\n`search` is the number of search actions retried.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Retries" + } + ] }, "task": { - "$ref": "#/components/schemas/_types.TaskId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TaskId" + } + ] }, "timed_out": { "description": "If true, some requests timed out during the update by query.", "type": "boolean" }, "took": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The number of milliseconds from start to end of the whole operation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "total": { "description": "The number of documents that were successfully processed.", @@ -27684,16 +29401,34 @@ "type": "number" }, "throttled": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "throttled_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The number of milliseconds the request slept to conform to `requests_per_second`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "throttled_until": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "throttled_until_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "This field should always be equal to zero in an _update_by_query response.\nIt only has meaning when using the task API, where it indicates the next time (in milliseconds since epoch) a throttled request will be run again in order to conform to `requests_per_second`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } } } @@ -27757,7 +29492,11 @@ "type": "object", "properties": { "response": { - "$ref": "#/components/schemas/async_search._types.AsyncSearch" + "allOf": [ + { + "$ref": "#/components/schemas/async_search._types.AsyncSearch" + } + ] } }, "required": [ @@ -27777,7 +29516,11 @@ } }, "_clusters": { - "$ref": "#/components/schemas/_types.ClusterStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ClusterStatistics" + } + ] }, "fields": { "type": "object", @@ -27786,7 +29529,11 @@ } }, "hits": { - "$ref": "#/components/schemas/_global.search._types.HitsMetadata" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.HitsMetadata" + } + ] }, "max_score": { "type": "number" @@ -27796,16 +29543,33 @@ "type": "number" }, "profile": { - "$ref": "#/components/schemas/_global.search._types.Profile" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.Profile" + } + ] }, "pit_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_scroll_id": { - "$ref": "#/components/schemas/_types.ScrollId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScrollId" + } + ] }, "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "description": "Indicates how many shards have run the query.\nNote that in order for shard results to be included in the search response, they need to be reduced first.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] }, "suggest": { "type": "object", @@ -28072,7 +29836,11 @@ "type": "object", "properties": { "meta": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] } } }, @@ -28101,7 +29869,11 @@ "type": "object", "properties": { "values": { - "$ref": "#/components/schemas/_types.aggregations.Percentiles" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.Percentiles" + } + ] } }, "required": [ @@ -28525,7 +30297,11 @@ ] }, "std_deviation_bounds": { - "$ref": "#/components/schemas/_types.aggregations.StandardDeviationBounds" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.StandardDeviationBounds" + } + ] }, "sum_of_squares_as_string": { "type": "string" @@ -28543,7 +30319,11 @@ "type": "string" }, "std_deviation_bounds_as_string": { - "$ref": "#/components/schemas/_types.aggregations.StandardDeviationBoundsAsString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.StandardDeviationBoundsAsString" + } + ] } }, "required": [ @@ -28687,7 +30467,11 @@ "type": "object", "properties": { "bounds": { - "$ref": "#/components/schemas/_types.GeoBounds" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoBounds" + } + ] } } } @@ -28737,10 +30521,18 @@ "type": "object", "properties": { "top_left": { - "$ref": "#/components/schemas/_types.GeoLocation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoLocation" + } + ] }, "bottom_right": { - "$ref": "#/components/schemas/_types.GeoLocation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoLocation" + } + ] } }, "required": [ @@ -28789,7 +30581,11 @@ "type": "object", "properties": { "geohash": { - "$ref": "#/components/schemas/_types.GeoHash" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoHash" + } + ] } }, "required": [ @@ -28803,10 +30599,18 @@ "type": "object", "properties": { "top_right": { - "$ref": "#/components/schemas/_types.GeoLocation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoLocation" + } + ] }, "bottom_left": { - "$ref": "#/components/schemas/_types.GeoLocation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoLocation" + } + ] } }, "required": [ @@ -28837,7 +30641,11 @@ "type": "number" }, "location": { - "$ref": "#/components/schemas/_types.GeoLocation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoLocation" + } + ] } }, "required": [ @@ -28865,7 +30673,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsHistogramBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsHistogramBucket" + } + ] } }, "required": [ @@ -28943,7 +30755,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsDateHistogramBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsDateHistogramBucket" + } + ] } }, "required": [ @@ -28981,7 +30797,11 @@ "type": "string" }, "key": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] } }, "required": [ @@ -29010,7 +30830,11 @@ "type": "object", "properties": { "interval": { - "$ref": "#/components/schemas/_types.DurationLarge" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationLarge" + } + ] } }, "required": [ @@ -29042,7 +30866,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsVariableWidthHistogramBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsVariableWidthHistogramBucket" + } + ] } }, "required": [ @@ -29141,7 +30969,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsStringTermsBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsStringTermsBucket" + } + ] } }, "required": [ @@ -29176,7 +31008,11 @@ "type": "object", "properties": { "key": { - "$ref": "#/components/schemas/_types.FieldValue" + "allOf": [ + { + "$ref": "#/components/schemas/_types.FieldValue" + } + ] } }, "required": [ @@ -29259,7 +31095,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsLongTermsBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsLongTermsBucket" + } + ] } }, "required": [ @@ -29344,7 +31184,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsDoubleTermsBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsDoubleTermsBucket" + } + ] } }, "required": [ @@ -29429,7 +31273,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsVoid" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsVoid" + } + ] } }, "required": [ @@ -29479,7 +31327,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsLongRareTermsBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsLongRareTermsBucket" + } + ] } }, "required": [ @@ -29546,7 +31398,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsStringRareTermsBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsStringRareTermsBucket" + } + ] } }, "required": [ @@ -29638,7 +31494,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsMultiTermsBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsMultiTermsBucket" + } + ] } }, "required": [ @@ -29819,7 +31679,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsGeoHashGridBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsGeoHashGridBucket" + } + ] } }, "required": [ @@ -29854,7 +31718,11 @@ "type": "object", "properties": { "key": { - "$ref": "#/components/schemas/_types.GeoHash" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoHash" + } + ] } }, "required": [ @@ -29882,7 +31750,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsGeoTileGridBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsGeoTileGridBucket" + } + ] } }, "required": [ @@ -29917,7 +31789,11 @@ "type": "object", "properties": { "key": { - "$ref": "#/components/schemas/_types.GeoTile" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoTile" + } + ] } }, "required": [ @@ -29949,7 +31825,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsGeoHexGridBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsGeoHexGridBucket" + } + ] } }, "required": [ @@ -29984,7 +31864,11 @@ "type": "object", "properties": { "key": { - "$ref": "#/components/schemas/_types.GeoHexCell" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoHexCell" + } + ] } }, "required": [ @@ -30016,7 +31900,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsRangeBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsRangeBucket" + } + ] } }, "required": [ @@ -30111,7 +31999,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsIpRangeBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsIpRangeBucket" + } + ] } }, "required": [ @@ -30177,7 +32069,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsIpPrefixBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsIpPrefixBucket" + } + ] } }, "required": [ @@ -30251,7 +32147,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsFiltersBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsFiltersBucket" + } + ] } }, "required": [ @@ -30311,7 +32211,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsAdjacencyMatrixBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsAdjacencyMatrixBucket" + } + ] } }, "required": [ @@ -30392,7 +32296,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsSignificantLongTermsBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsSignificantLongTermsBucket" + } + ] } }, "required": [ @@ -30498,7 +32406,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsSignificantStringTermsBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsSignificantStringTermsBucket" + } + ] } }, "required": [ @@ -30580,7 +32492,11 @@ "type": "object", "properties": { "after_key": { - "$ref": "#/components/schemas/_types.aggregations.CompositeAggregateKey" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CompositeAggregateKey" + } + ] } } } @@ -30601,7 +32517,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsCompositeBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsCompositeBucket" + } + ] } }, "required": [ @@ -30636,7 +32556,11 @@ "type": "object", "properties": { "key": { - "$ref": "#/components/schemas/_types.aggregations.CompositeAggregateKey" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CompositeAggregateKey" + } + ] } }, "required": [ @@ -30664,7 +32588,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsFrequentItemSetsBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsFrequentItemSetsBucket" + } + ] } }, "required": [ @@ -30737,7 +32665,11 @@ "type": "object", "properties": { "buckets": { - "$ref": "#/components/schemas/_types.aggregations.BucketsTimeSeriesBucket" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsTimeSeriesBucket" + } + ] } }, "required": [ @@ -30811,7 +32743,11 @@ "type": "object", "properties": { "hits": { - "$ref": "#/components/schemas/_global.search._types.HitsMetadata" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.HitsMetadata" + } + ] } }, "required": [ @@ -30860,7 +32796,11 @@ "type": "object", "properties": { "relation": { - "$ref": "#/components/schemas/_global.search._types.TotalHitsRelation" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.TotalHitsRelation" + } + ] }, "value": { "type": "number" @@ -30882,10 +32822,18 @@ "type": "object", "properties": { "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_score": { "oneOf": [ @@ -30899,7 +32847,11 @@ ] }, "_explanation": { - "$ref": "#/components/schemas/_global.explain.Explanation" + "allOf": [ + { + "$ref": "#/components/schemas/_global.explain.Explanation" + } + ] }, "fields": { "type": "object", @@ -30939,7 +32891,11 @@ ] }, "_nested": { - "$ref": "#/components/schemas/_global.search._types.NestedIdentity" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.NestedIdentity" + } + ] }, "_ignored": { "type": "array", @@ -30972,16 +32928,28 @@ "type": "number" }, "_seq_no": { - "$ref": "#/components/schemas/_types.SequenceNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SequenceNumber" + } + ] }, "_primary_term": { "type": "number" }, "_version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "sort": { - "$ref": "#/components/schemas/_types.SortResults" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortResults" + } + ] } }, "required": [ @@ -31038,7 +33006,11 @@ "type": "object", "properties": { "hits": { - "$ref": "#/components/schemas/_global.search._types.HitsMetadata" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.HitsMetadata" + } + ] } }, "required": [ @@ -31049,13 +33021,21 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "offset": { "type": "number" }, "_nested": { - "$ref": "#/components/schemas/_global.search._types.NestedIdentity" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.NestedIdentity" + } + ] } }, "required": [ @@ -31088,7 +33068,11 @@ "type": "object", "properties": { "value": { - "$ref": "#/components/schemas/_types.FieldValue" + "allOf": [ + { + "$ref": "#/components/schemas/_types.FieldValue" + } + ] }, "feature_importance": { "type": "array", @@ -31148,7 +33132,11 @@ "type": "object", "properties": { "class_name": { - "$ref": "#/components/schemas/_types.FieldValue" + "allOf": [ + { + "$ref": "#/components/schemas/_types.FieldValue" + } + ] }, "class_probability": { "type": "number" @@ -31473,7 +33461,11 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "count": { "type": "number" @@ -31526,7 +33518,11 @@ "type": "string" }, "geometry": { - "$ref": "#/components/schemas/_types.GeoLine" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoLine" + } + ] }, "properties": { "type": "object" @@ -31605,19 +33601,31 @@ "type": "object", "properties": { "status": { - "$ref": "#/components/schemas/_types.ClusterSearchStatus" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ClusterSearchStatus" + } + ] }, "indices": { "type": "string" }, "took": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "timed_out": { "type": "boolean" }, "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] }, "failures": { "type": "array", @@ -31653,13 +33661,28 @@ "type": "object", "properties": { "failed": { - "$ref": "#/components/schemas/_types.uint" + "description": "The number of shards the operation or search attempted to run on but failed.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "successful": { - "$ref": "#/components/schemas/_types.uint" + "description": "The number of shards the operation or search succeeded on.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "total": { - "$ref": "#/components/schemas/_types.uint" + "description": "The number of shards the operation or search will run on overall.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "failures": { "type": "array", @@ -31668,7 +33691,11 @@ } }, "skipped": { - "$ref": "#/components/schemas/_types.uint" + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] } }, "required": [ @@ -31684,13 +33711,21 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "node": { "type": "string" }, "reason": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] }, "shard": { "type": "number" @@ -31729,7 +33764,11 @@ "type": "string" }, "caused_by": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] }, "root_cause": { "type": "array", @@ -31775,19 +33814,35 @@ "type": "string" }, "dfs": { - "$ref": "#/components/schemas/_global.search._types.DfsProfile" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.DfsProfile" + } + ] }, "fetch": { - "$ref": "#/components/schemas/_global.search._types.FetchProfile" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.FetchProfile" + } + ] }, "id": { "type": "string" }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "node_id": { - "$ref": "#/components/schemas/_types.NodeId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] }, "searches": { "type": "array", @@ -31813,19 +33868,31 @@ "type": "object", "properties": { "breakdown": { - "$ref": "#/components/schemas/_global.search._types.AggregationBreakdown" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.AggregationBreakdown" + } + ] }, "description": { "type": "string" }, "time_in_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "type": { "type": "string" }, "debug": { - "$ref": "#/components/schemas/_global.search._types.AggregationProfileDebug" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.AggregationProfileDebug" + } + ] }, "children": { "type": "array", @@ -31933,7 +34000,11 @@ "type": "string" }, "delegate_debug": { - "$ref": "#/components/schemas/_global.search._types.AggregationProfileDebug" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.AggregationProfileDebug" + } + ] }, "chars_fetched": { "type": "number" @@ -32033,7 +34104,11 @@ "type": "object", "properties": { "statistics": { - "$ref": "#/components/schemas/_global.search._types.DfsStatisticsProfile" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.DfsStatisticsProfile" + } + ] }, "knn": { "type": "array", @@ -32053,13 +34128,25 @@ "type": "string" }, "time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "time_in_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "breakdown": { - "$ref": "#/components/schemas/_global.search._types.DfsStatisticsBreakdown" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.DfsStatisticsBreakdown" + } + ] }, "debug": { "type": "object", @@ -32158,13 +34245,25 @@ "type": "string" }, "time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "time_in_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "breakdown": { - "$ref": "#/components/schemas/_global.search._types.KnnQueryProfileBreakdown" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.KnnQueryProfileBreakdown" + } + ] }, "debug": { "type": "object", @@ -32283,10 +34382,18 @@ "type": "string" }, "time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "time_in_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "children": { "type": "array", @@ -32311,13 +34418,25 @@ "type": "string" }, "time_in_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "breakdown": { - "$ref": "#/components/schemas/_global.search._types.FetchProfileBreakdown" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.FetchProfileBreakdown" + } + ] }, "debug": { - "$ref": "#/components/schemas/_global.search._types.FetchProfileDebug" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.FetchProfileDebug" + } + ] }, "children": { "type": "array", @@ -32414,7 +34533,11 @@ "type": "string" }, "time_in_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "children": { "type": "array", @@ -32433,13 +34556,21 @@ "type": "object", "properties": { "breakdown": { - "$ref": "#/components/schemas/_global.search._types.QueryBreakdown" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.QueryBreakdown" + } + ] }, "description": { "type": "string" }, "time_in_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "type": { "type": "string" @@ -32614,10 +34745,18 @@ "type": "string" }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "_routing": { - "$ref": "#/components/schemas/_types.Routing" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "_score": { "type": "number" @@ -32775,7 +34914,11 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "is_partial": { "description": "When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards.\nWhile the query is running, `is_partial` is always set to `true`.", @@ -32786,22 +34929,48 @@ "type": "boolean" }, "expiration_time": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "Indicates when the async search will expire.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "expiration_time_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "start_time": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "start_time_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "completion_time": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "Indicates when the async search completed.\nIt is present only when the search has completed.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "completion_time_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] } }, "required": [ @@ -32831,10 +35000,20 @@ "type": "object", "properties": { "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "description": "The number of shards that have run the query so far.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] }, "_clusters": { - "$ref": "#/components/schemas/_types.ClusterStatistics" + "description": "Metadata about clusters involved in the cross-cluster search.\nIt is not shown for local-only searches.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ClusterStatistics" + } + ] }, "completion_status": { "description": "If the async search completed, this field shows the status code of the search.\nFor example, `200` indicates that the async search was successfully completed.\n`503` indicates that the async search was completed with an error.", @@ -32955,7 +35134,11 @@ } }, "meta": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] } } }, @@ -32963,235 +35146,844 @@ "type": "object", "properties": { "adjacency_matrix": { - "$ref": "#/components/schemas/_types.aggregations.AdjacencyMatrixAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-adjacency-matrix-aggregation" + }, + "description": "A bucket aggregation returning a form of adjacency matrix.\nThe request provides a collection of named filter expressions, similar to the `filters` aggregation.\nEach bucket in the response represents a non-empty cell in the matrix of intersecting filters.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.AdjacencyMatrixAggregation" + } + ] }, "auto_date_histogram": { - "$ref": "#/components/schemas/_types.aggregations.AutoDateHistogramAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-autodatehistogram-aggregation" + }, + "description": "A multi-bucket aggregation similar to the date histogram, except instead of providing an interval to use as the width of each bucket, a target number of buckets is provided.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.AutoDateHistogramAggregation" + } + ] }, "avg": { - "$ref": "#/components/schemas/_types.aggregations.AverageAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-avg-aggregation" + }, + "description": "A single-value metrics aggregation that computes the average of numeric values that are extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.AverageAggregation" + } + ] }, "avg_bucket": { - "$ref": "#/components/schemas/_types.aggregations.AverageBucketAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-avg-bucket-aggregation" + }, + "description": "A sibling pipeline aggregation which calculates the mean value of a specified metric in a sibling aggregation.\nThe specified metric must be numeric and the sibling aggregation must be a multi-bucket aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.AverageBucketAggregation" + } + ] }, "boxplot": { - "$ref": "#/components/schemas/_types.aggregations.BoxplotAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-boxplot-aggregation" + }, + "description": "A metrics aggregation that computes a box plot of numeric values extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BoxplotAggregation" + } + ] }, "bucket_script": { - "$ref": "#/components/schemas/_types.aggregations.BucketScriptAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-script-aggregation" + }, + "description": "A parent pipeline aggregation which runs a script which can perform per bucket computations on metrics in the parent multi-bucket aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketScriptAggregation" + } + ] }, "bucket_selector": { - "$ref": "#/components/schemas/_types.aggregations.BucketSelectorAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-selector-aggregation" + }, + "description": "A parent pipeline aggregation which runs a script to determine whether the current bucket will be retained in the parent multi-bucket aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketSelectorAggregation" + } + ] }, "bucket_sort": { - "$ref": "#/components/schemas/_types.aggregations.BucketSortAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-sort-aggregation" + }, + "description": "A parent pipeline aggregation which sorts the buckets of its parent multi-bucket aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketSortAggregation" + } + ] }, "bucket_count_ks_test": { - "$ref": "#/components/schemas/_types.aggregations.BucketKsAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-count-ks-test-aggregation" + }, + "description": "A sibling pipeline aggregation which runs a two sample Kolmogorov–Smirnov test (\"K-S test\") against a provided distribution and the distribution implied by the documents counts in the configured sibling aggregation.", + "x-state": "Technical preview", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketKsAggregation" + } + ] }, "bucket_correlation": { - "$ref": "#/components/schemas/_types.aggregations.BucketCorrelationAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-correlation-aggregation" + }, + "description": "A sibling pipeline aggregation which runs a correlation function on the configured sibling multi-bucket aggregation.", + "x-state": "Technical preview", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketCorrelationAggregation" + } + ] }, "cardinality": { - "$ref": "#/components/schemas/_types.aggregations.CardinalityAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-cardinality-aggregation" + }, + "description": "A single-value metrics aggregation that calculates an approximate count of distinct values.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CardinalityAggregation" + } + ] }, "categorize_text": { - "$ref": "#/components/schemas/_types.aggregations.CategorizeTextAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-categorize-text-aggregation" + }, + "description": "A multi-bucket aggregation that groups semi-structured text into buckets.", + "x-state": "Technical preview", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CategorizeTextAggregation" + } + ] }, "children": { - "$ref": "#/components/schemas/_types.aggregations.ChildrenAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-children-aggregation" + }, + "description": "A single bucket aggregation that selects child documents that have the specified type, as defined in a `join` field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ChildrenAggregation" + } + ] }, "composite": { - "$ref": "#/components/schemas/_types.aggregations.CompositeAggregation" + "description": "A multi-bucket aggregation that creates composite buckets from different sources.\nUnlike the other multi-bucket aggregations, you can use the `composite` aggregation to paginate *all* buckets from a multi-level aggregation efficiently.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CompositeAggregation" + } + ] }, "cumulative_cardinality": { - "$ref": "#/components/schemas/_types.aggregations.CumulativeCardinalityAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-cumulative-cardinality-aggregation" + }, + "description": "A parent pipeline aggregation which calculates the cumulative cardinality in a parent `histogram` or `date_histogram` aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CumulativeCardinalityAggregation" + } + ] }, "cumulative_sum": { - "$ref": "#/components/schemas/_types.aggregations.CumulativeSumAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-cumulative-sum-aggregation" + }, + "description": "A parent pipeline aggregation which calculates the cumulative sum of a specified metric in a parent `histogram` or `date_histogram` aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CumulativeSumAggregation" + } + ] }, "date_histogram": { - "$ref": "#/components/schemas/_types.aggregations.DateHistogramAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-datehistogram-aggregation" + }, + "description": "A multi-bucket values source based aggregation that can be applied on date values or date range values extracted from the documents.\nIt dynamically builds fixed size (interval) buckets over the values.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.DateHistogramAggregation" + } + ] }, "date_range": { - "$ref": "#/components/schemas/_types.aggregations.DateRangeAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-daterange-aggregation" + }, + "description": "A multi-bucket value source based aggregation that enables the user to define a set of date ranges - each representing a bucket.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.DateRangeAggregation" + } + ] }, "derivative": { - "$ref": "#/components/schemas/_types.aggregations.DerivativeAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-derivative-aggregation" + }, + "description": "A parent pipeline aggregation which calculates the derivative of a specified metric in a parent `histogram` or `date_histogram` aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.DerivativeAggregation" + } + ] }, "diversified_sampler": { - "$ref": "#/components/schemas/_types.aggregations.DiversifiedSamplerAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-diversified-sampler-aggregation" + }, + "description": "A filtering aggregation used to limit any sub aggregations' processing to a sample of the top-scoring documents.\nSimilar to the `sampler` aggregation, but adds the ability to limit the number of matches that share a common value.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.DiversifiedSamplerAggregation" + } + ] }, "extended_stats": { - "$ref": "#/components/schemas/_types.aggregations.ExtendedStatsAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-extendedstats-aggregation" + }, + "description": "A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ExtendedStatsAggregation" + } + ] }, "extended_stats_bucket": { - "$ref": "#/components/schemas/_types.aggregations.ExtendedStatsBucketAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-extended-stats-bucket-aggregation" + }, + "description": "A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ExtendedStatsBucketAggregation" + } + ] }, "frequent_item_sets": { - "$ref": "#/components/schemas/_types.aggregations.FrequentItemSetsAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-frequent-item-sets-aggregation" + }, + "description": "A bucket aggregation which finds frequent item sets, a form of association rules mining that identifies items that often occur together.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.FrequentItemSetsAggregation" + } + ] }, "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filter-aggregation" + }, + "description": "A single bucket aggregation that narrows the set of documents to those that match a query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "filters": { - "$ref": "#/components/schemas/_types.aggregations.FiltersAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filters-aggregation" + }, + "description": "A multi-bucket aggregation where each bucket contains the documents that match a query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.FiltersAggregation" + } + ] }, "geo_bounds": { - "$ref": "#/components/schemas/_types.aggregations.GeoBoundsAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geobounds-aggregation" + }, + "description": "A metric aggregation that computes the geographic bounding box containing all values for a Geopoint or Geoshape field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GeoBoundsAggregation" + } + ] }, "geo_centroid": { - "$ref": "#/components/schemas/_types.aggregations.GeoCentroidAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geocentroid-aggregation" + }, + "description": "A metric aggregation that computes the weighted centroid from all coordinate values for geo fields.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GeoCentroidAggregation" + } + ] }, "geo_distance": { - "$ref": "#/components/schemas/_types.aggregations.GeoDistanceAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geodistance-aggregation" + }, + "description": "A multi-bucket aggregation that works on `geo_point` fields.\nEvaluates the distance of each document value from an origin point and determines the buckets it belongs to, based on ranges defined in the request.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GeoDistanceAggregation" + } + ] }, "geohash_grid": { - "$ref": "#/components/schemas/_types.aggregations.GeoHashGridAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geohashgrid-aggregation" + }, + "description": "A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid.\nEach cell is labeled using a geohash which is of user-definable precision.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GeoHashGridAggregation" + } + ] }, "geo_line": { - "$ref": "#/components/schemas/_types.aggregations.GeoLineAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geo-line" + }, + "description": "Aggregates all `geo_point` values within a bucket into a `LineString` ordered by the chosen sort field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GeoLineAggregation" + } + ] }, "geotile_grid": { - "$ref": "#/components/schemas/_types.aggregations.GeoTileGridAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geotilegrid-aggregation" + }, + "description": "A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid.\nEach cell corresponds to a map tile as used by many online map sites.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GeoTileGridAggregation" + } + ] }, "geohex_grid": { - "$ref": "#/components/schemas/_types.aggregations.GeohexGridAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geohexgrid-aggregation" + }, + "description": "A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid.\nEach cell corresponds to a H3 cell index and is labeled using the H3Index representation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GeohexGridAggregation" + } + ] }, "global": { - "$ref": "#/components/schemas/_types.aggregations.GlobalAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-global-aggregation" + }, + "description": "Defines a single bucket of all the documents within the search execution context.\nThis context is defined by the indices and the document types you’re searching on, but is not influenced by the search query itself.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GlobalAggregation" + } + ] }, "histogram": { - "$ref": "#/components/schemas/_types.aggregations.HistogramAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-histogram-aggregation" + }, + "description": "A multi-bucket values source based aggregation that can be applied on numeric values or numeric range values extracted from the documents.\nIt dynamically builds fixed size (interval) buckets over the values.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.HistogramAggregation" + } + ] }, "ip_range": { - "$ref": "#/components/schemas/_types.aggregations.IpRangeAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-iprange-aggregation" + }, + "description": "A multi-bucket value source based aggregation that enables the user to define a set of IP ranges - each representing a bucket.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.IpRangeAggregation" + } + ] }, "ip_prefix": { - "$ref": "#/components/schemas/_types.aggregations.IpPrefixAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-ipprefix-aggregation" + }, + "description": "A bucket aggregation that groups documents based on the network or sub-network of an IP address.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.IpPrefixAggregation" + } + ] }, "inference": { - "$ref": "#/components/schemas/_types.aggregations.InferenceAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-inference-bucket-aggregation" + }, + "description": "A parent pipeline aggregation which loads a pre-trained model and performs inference on the collated result fields from the parent bucket aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.InferenceAggregation" + } + ] }, "line": { - "$ref": "#/components/schemas/_types.aggregations.GeoLineAggregation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GeoLineAggregation" + } + ] }, "matrix_stats": { - "$ref": "#/components/schemas/_types.aggregations.MatrixStatsAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-matrix-stats-aggregation" + }, + "description": "A numeric aggregation that computes the following statistics over a set of document fields: `count`, `mean`, `variance`, `skewness`, `kurtosis`, `covariance`, and `covariance`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MatrixStatsAggregation" + } + ] }, "max": { - "$ref": "#/components/schemas/_types.aggregations.MaxAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-max-aggregation" + }, + "description": "A single-value metrics aggregation that returns the maximum value among the numeric values extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MaxAggregation" + } + ] }, "max_bucket": { - "$ref": "#/components/schemas/_types.aggregations.MaxBucketAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-max-bucket-aggregation" + }, + "description": "A sibling pipeline aggregation which identifies the bucket(s) with the maximum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MaxBucketAggregation" + } + ] }, "median_absolute_deviation": { - "$ref": "#/components/schemas/_types.aggregations.MedianAbsoluteDeviationAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-median-absolute-deviation-aggregation" + }, + "description": "A single-value aggregation that approximates the median absolute deviation of its search results.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MedianAbsoluteDeviationAggregation" + } + ] }, "min": { - "$ref": "#/components/schemas/_types.aggregations.MinAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-min-aggregation" + }, + "description": "A single-value metrics aggregation that returns the minimum value among numeric values extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MinAggregation" + } + ] }, "min_bucket": { - "$ref": "#/components/schemas/_types.aggregations.MinBucketAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-min-bucket-aggregation" + }, + "description": "A sibling pipeline aggregation which identifies the bucket(s) with the minimum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MinBucketAggregation" + } + ] }, "missing": { - "$ref": "#/components/schemas/_types.aggregations.MissingAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-missing-aggregation" + }, + "description": "A field data based single bucket aggregation, that creates a bucket of all documents in the current document set context that are missing a field value (effectively, missing a field or having the configured NULL value set).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MissingAggregation" + } + ] }, "moving_avg": { - "$ref": "#/components/schemas/_types.aggregations.MovingAverageAggregation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MovingAverageAggregation" + } + ] }, "moving_percentiles": { - "$ref": "#/components/schemas/_types.aggregations.MovingPercentilesAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-moving-percentiles-aggregation" + }, + "description": "Given an ordered series of percentiles, \"slides\" a window across those percentiles and computes cumulative percentiles.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MovingPercentilesAggregation" + } + ] }, "moving_fn": { - "$ref": "#/components/schemas/_types.aggregations.MovingFunctionAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-movfn-aggregation" + }, + "description": "Given an ordered series of data, \"slides\" a window across the data and runs a custom script on each window of data.\nFor convenience, a number of common functions are predefined such as `min`, `max`, and moving averages.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MovingFunctionAggregation" + } + ] }, "multi_terms": { - "$ref": "#/components/schemas/_types.aggregations.MultiTermsAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-multi-terms-aggregation" + }, + "description": "A multi-bucket value source based aggregation where buckets are dynamically built - one per unique set of values.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MultiTermsAggregation" + } + ] }, "nested": { - "$ref": "#/components/schemas/_types.aggregations.NestedAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-nested-aggregation" + }, + "description": "A special single bucket aggregation that enables aggregating nested documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.NestedAggregation" + } + ] }, "normalize": { - "$ref": "#/components/schemas/_types.aggregations.NormalizeAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-normalize-aggregation" + }, + "description": "A parent pipeline aggregation which calculates the specific normalized/rescaled value for a specific bucket value.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.NormalizeAggregation" + } + ] }, "parent": { - "$ref": "#/components/schemas/_types.aggregations.ParentAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-parent-aggregation" + }, + "description": "A special single bucket aggregation that selects parent documents that have the specified type, as defined in a `join` field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ParentAggregation" + } + ] }, "percentile_ranks": { - "$ref": "#/components/schemas/_types.aggregations.PercentileRanksAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-percentile-rank-aggregation" + }, + "description": "A multi-value metrics aggregation that calculates one or more percentile ranks over numeric values extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.PercentileRanksAggregation" + } + ] }, "percentiles": { - "$ref": "#/components/schemas/_types.aggregations.PercentilesAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-percentile-aggregation" + }, + "description": "A multi-value metrics aggregation that calculates one or more percentiles over numeric values extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.PercentilesAggregation" + } + ] }, "percentiles_bucket": { - "$ref": "#/components/schemas/_types.aggregations.PercentilesBucketAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-percentiles-bucket-aggregation" + }, + "description": "A sibling pipeline aggregation which calculates percentiles across all bucket of a specified metric in a sibling aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.PercentilesBucketAggregation" + } + ] }, "range": { - "$ref": "#/components/schemas/_types.aggregations.RangeAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-range-aggregation" + }, + "description": "A multi-bucket value source based aggregation that enables the user to define a set of ranges - each representing a bucket.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.RangeAggregation" + } + ] }, "rare_terms": { - "$ref": "#/components/schemas/_types.aggregations.RareTermsAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-rare-terms-aggregation" + }, + "description": "A multi-bucket value source based aggregation which finds \"rare\" terms — terms that are at the long-tail of the distribution and are not frequent.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.RareTermsAggregation" + } + ] }, "rate": { - "$ref": "#/components/schemas/_types.aggregations.RateAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-rate-aggregation" + }, + "description": "Calculates a rate of documents or a field in each bucket.\nCan only be used inside a `date_histogram` or `composite` aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.RateAggregation" + } + ] }, "reverse_nested": { - "$ref": "#/components/schemas/_types.aggregations.ReverseNestedAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-reverse-nested-aggregation" + }, + "description": "A special single bucket aggregation that enables aggregating on parent documents from nested documents.\nShould only be defined inside a `nested` aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ReverseNestedAggregation" + } + ] }, "sampler": { - "$ref": "#/components/schemas/_types.aggregations.SamplerAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-sampler-aggregation" + }, + "description": "A filtering aggregation used to limit any sub aggregations' processing to a sample of the top-scoring documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.SamplerAggregation" + } + ] }, "scripted_metric": { - "$ref": "#/components/schemas/_types.aggregations.ScriptedMetricAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-scripted-metric-aggregation" + }, + "description": "A metric aggregation that uses scripts to provide a metric output.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ScriptedMetricAggregation" + } + ] }, "serial_diff": { - "$ref": "#/components/schemas/_types.aggregations.SerialDifferencingAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-serialdiff-aggregation" + }, + "description": "An aggregation that subtracts values in a time series from themselves at different time lags or periods.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.SerialDifferencingAggregation" + } + ] }, "significant_terms": { - "$ref": "#/components/schemas/_types.aggregations.SignificantTermsAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significantterms-aggregation" + }, + "description": "Returns interesting or unusual occurrences of terms in a set.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.SignificantTermsAggregation" + } + ] }, "significant_text": { - "$ref": "#/components/schemas/_types.aggregations.SignificantTextAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significanttext-aggregation" + }, + "description": "Returns interesting or unusual occurrences of free-text terms in a set.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.SignificantTextAggregation" + } + ] }, "stats": { - "$ref": "#/components/schemas/_types.aggregations.StatsAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-stats-aggregation" + }, + "description": "A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.StatsAggregation" + } + ] }, "stats_bucket": { - "$ref": "#/components/schemas/_types.aggregations.StatsBucketAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-stats-bucket-aggregation" + }, + "description": "A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.StatsBucketAggregation" + } + ] }, "string_stats": { - "$ref": "#/components/schemas/_types.aggregations.StringStatsAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-string-stats-aggregation" + }, + "description": "A multi-value metrics aggregation that computes statistics over string values extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.StringStatsAggregation" + } + ] }, "sum": { - "$ref": "#/components/schemas/_types.aggregations.SumAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-sum-aggregation" + }, + "description": "A single-value metrics aggregation that sums numeric values that are extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.SumAggregation" + } + ] }, "sum_bucket": { - "$ref": "#/components/schemas/_types.aggregations.SumBucketAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-sum-bucket-aggregation" + }, + "description": "A sibling pipeline aggregation which calculates the sum of a specified metric across all buckets in a sibling aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.SumBucketAggregation" + } + ] }, "terms": { - "$ref": "#/components/schemas/_types.aggregations.TermsAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-terms-aggregation" + }, + "description": "A multi-bucket value source based aggregation where buckets are dynamically built - one per unique value.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsAggregation" + } + ] }, "time_series": { - "$ref": "#/components/schemas/_types.aggregations.TimeSeriesAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-time-series-aggregation" + }, + "description": "The time series aggregation queries data created using a time series index.\nThis is typically data such as metrics or other data streams with a time component, and requires creating an index using the time series mode.", + "x-state": "Technical preview", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TimeSeriesAggregation" + } + ] }, "top_hits": { - "$ref": "#/components/schemas/_types.aggregations.TopHitsAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-top-hits-aggregation" + }, + "description": "A metric aggregation that returns the top matching documents per bucket.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TopHitsAggregation" + } + ] }, "t_test": { - "$ref": "#/components/schemas/_types.aggregations.TTestAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-ttest-aggregation" + }, + "description": "A metrics aggregation that performs a statistical hypothesis test in which the test statistic follows a Student’s t-distribution under the null hypothesis on numeric values extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TTestAggregation" + } + ] }, "top_metrics": { - "$ref": "#/components/schemas/_types.aggregations.TopMetricsAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-top-metrics" + }, + "description": "A metric aggregation that selects metrics from the document with the largest or smallest sort value.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TopMetricsAggregation" + } + ] }, "value_count": { - "$ref": "#/components/schemas/_types.aggregations.ValueCountAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-valuecount-aggregation" + }, + "description": "A single-value metrics aggregation that counts the number of values that are extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ValueCountAggregation" + } + ] }, "weighted_avg": { - "$ref": "#/components/schemas/_types.aggregations.WeightedAverageAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-weight-avg-aggregation" + }, + "description": "A single-value metrics aggregation that computes the weighted average of numeric values that are extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.WeightedAverageAggregation" + } + ] }, "variable_width_histogram": { - "$ref": "#/components/schemas/_types.aggregations.VariableWidthHistogramAggregation" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-variablewidthhistogram-aggregation" + }, + "description": "A multi-bucket aggregation similar to the histogram, except instead of providing an interval to use as the width of each bucket, a target number of buckets is provided.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.VariableWidthHistogramAggregation" + } + ] } }, "minProperties": 1, @@ -33230,10 +36022,26 @@ "type": "object", "properties": { "bool": { - "$ref": "#/components/schemas/_types.query_dsl.BoolQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-bool-query" + }, + "description": "matches documents matching boolean combinations of other queries.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.BoolQuery" + } + ] }, "boosting": { - "$ref": "#/components/schemas/_types.query_dsl.BoostingQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-boosting-query" + }, + "description": "Returns documents matching a `positive` query while reducing the relevance score of documents that also match a `negative` query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.BoostingQuery" + } + ] }, "common": { "deprecated": true, @@ -33245,22 +36053,71 @@ "maxProperties": 1 }, "combined_fields": { - "$ref": "#/components/schemas/_types.query_dsl.CombinedFieldsQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-combined-fields-query" + }, + "description": "The `combined_fields` query supports searching multiple text fields as if their contents had been indexed into one combined field.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.CombinedFieldsQuery" + } + ] }, "constant_score": { - "$ref": "#/components/schemas/_types.query_dsl.ConstantScoreQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-constant-score-query" + }, + "description": "Wraps a filter query and returns every matching document with a relevance score equal to the `boost` parameter value.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ConstantScoreQuery" + } + ] }, "dis_max": { - "$ref": "#/components/schemas/_types.query_dsl.DisMaxQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-dis-max-query" + }, + "description": "Returns documents matching one or more wrapped queries, called query clauses or clauses.\nIf a returned document matches multiple query clauses, the `dis_max` query assigns the document the highest relevance score from any matching clause, plus a tie breaking increment for any additional matching subqueries.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.DisMaxQuery" + } + ] }, "distance_feature": { - "$ref": "#/components/schemas/_types.query_dsl.DistanceFeatureQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-distance-feature-query" + }, + "description": "Boosts the relevance score of documents closer to a provided origin date or point.\nFor example, you can use this query to give more weight to documents closer to a certain date or location.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.DistanceFeatureQuery" + } + ] }, "exists": { - "$ref": "#/components/schemas/_types.query_dsl.ExistsQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-exists-query" + }, + "description": "Returns documents that contain an indexed value for a field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ExistsQuery" + } + ] }, "function_score": { - "$ref": "#/components/schemas/_types.query_dsl.FunctionScoreQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-function-score-query" + }, + "description": "The `function_score` enables you to modify the score of documents that are retrieved by a query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.FunctionScoreQuery" + } + ] }, "fuzzy": { "externalDocs": { @@ -33275,10 +36132,26 @@ "maxProperties": 1 }, "geo_bounding_box": { - "$ref": "#/components/schemas/_types.query_dsl.GeoBoundingBoxQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-bounding-box-query" + }, + "description": "Matches geo_point and geo_shape values that intersect a bounding box.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.GeoBoundingBoxQuery" + } + ] }, "geo_distance": { - "$ref": "#/components/schemas/_types.query_dsl.GeoDistanceQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-distance-query" + }, + "description": "Matches `geo_point` and `geo_shape` values within a given distance of a geopoint.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.GeoDistanceQuery" + } + ] }, "geo_grid": { "description": "Matches `geo_point` and `geo_shape` values that intersect a grid cell from a GeoGrid aggregation.", @@ -33290,19 +36163,56 @@ "maxProperties": 1 }, "geo_polygon": { - "$ref": "#/components/schemas/_types.query_dsl.GeoPolygonQuery" + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.GeoPolygonQuery" + } + ] }, "geo_shape": { - "$ref": "#/components/schemas/_types.query_dsl.GeoShapeQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-shape-query" + }, + "description": "Filter documents indexed using either the `geo_shape` or the `geo_point` type.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.GeoShapeQuery" + } + ] }, "has_child": { - "$ref": "#/components/schemas/_types.query_dsl.HasChildQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-has-child-query" + }, + "description": "Returns parent documents whose joined child documents match a provided query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.HasChildQuery" + } + ] }, "has_parent": { - "$ref": "#/components/schemas/_types.query_dsl.HasParentQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-has-parent-query" + }, + "description": "Returns child documents whose joined parent document matches a provided query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.HasParentQuery" + } + ] }, "ids": { - "$ref": "#/components/schemas/_types.query_dsl.IdsQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-ids-query" + }, + "description": "Returns documents based on their IDs.\nThis query uses document IDs stored in the `_id` field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IdsQuery" + } + ] }, "intervals": { "externalDocs": { @@ -33317,7 +36227,15 @@ "maxProperties": 1 }, "knn": { - "$ref": "#/components/schemas/_types.KnnQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-knn-query" + }, + "description": "Finds the k nearest vectors to a query vector, as measured by a similarity\nmetric. knn query finds nearest vectors through approximate search on indexed\ndense_vectors.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.KnnQuery" + } + ] }, "match": { "externalDocs": { @@ -33332,7 +36250,15 @@ "maxProperties": 1 }, "match_all": { - "$ref": "#/components/schemas/_types.query_dsl.MatchAllQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query" + }, + "description": "Matches all documents, giving them all a `_score` of 1.0.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.MatchAllQuery" + } + ] }, "match_bool_prefix": { "externalDocs": { @@ -33347,7 +36273,15 @@ "maxProperties": 1 }, "match_none": { - "$ref": "#/components/schemas/_types.query_dsl.MatchNoneQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query#query-dsl-match-none-query" + }, + "description": "Matches no documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.MatchNoneQuery" + } + ] }, "match_phrase": { "externalDocs": { @@ -33374,22 +36308,70 @@ "maxProperties": 1 }, "more_like_this": { - "$ref": "#/components/schemas/_types.query_dsl.MoreLikeThisQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-mlt-query" + }, + "description": "Returns documents that are \"like\" a given set of documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.MoreLikeThisQuery" + } + ] }, "multi_match": { - "$ref": "#/components/schemas/_types.query_dsl.MultiMatchQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-match-query" + }, + "description": "Enables you to search for a provided text, number, date or boolean value across multiple fields.\nThe provided text is analyzed before matching.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.MultiMatchQuery" + } + ] }, "nested": { - "$ref": "#/components/schemas/_types.query_dsl.NestedQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-nested-query" + }, + "description": "Wraps another query to search nested fields.\nIf an object matches the search, the nested query returns the root parent document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.NestedQuery" + } + ] }, "parent_id": { - "$ref": "#/components/schemas/_types.query_dsl.ParentIdQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-parent-id-query" + }, + "description": "Returns child documents joined to a specific parent document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ParentIdQuery" + } + ] }, "percolate": { - "$ref": "#/components/schemas/_types.query_dsl.PercolateQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-percolate-query" + }, + "description": "Matches queries stored in an index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.PercolateQuery" + } + ] }, "pinned": { - "$ref": "#/components/schemas/_types.query_dsl.PinnedQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-pinned-query" + }, + "description": "Promotes selected documents to rank higher than those matching a given query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.PinnedQuery" + } + ] }, "prefix": { "externalDocs": { @@ -33404,7 +36386,15 @@ "maxProperties": 1 }, "query_string": { - "$ref": "#/components/schemas/_types.query_dsl.QueryStringQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-query-string-query" + }, + "description": "Returns documents based on a provided query string, using a parser with a strict syntax.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryStringQuery" + } + ] }, "range": { "externalDocs": { @@ -33419,7 +36409,15 @@ "maxProperties": 1 }, "rank_feature": { - "$ref": "#/components/schemas/_types.query_dsl.RankFeatureQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-rank-feature-query" + }, + "description": "Boosts the relevance score of documents based on the numeric value of a `rank_feature` or `rank_features` field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.RankFeatureQuery" + } + ] }, "regexp": { "externalDocs": { @@ -33434,43 +36432,141 @@ "maxProperties": 1 }, "rule": { - "$ref": "#/components/schemas/_types.query_dsl.RuleQuery" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.RuleQuery" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.query_dsl.ScriptQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-script-query" + }, + "description": "Filters documents based on a provided script.\nThe script query is typically used in a filter context.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ScriptQuery" + } + ] }, "script_score": { - "$ref": "#/components/schemas/_types.query_dsl.ScriptScoreQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-script-score-query" + }, + "description": "Uses a script to provide a custom score for returned documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ScriptScoreQuery" + } + ] }, "semantic": { - "$ref": "#/components/schemas/_types.query_dsl.SemanticQuery" + "description": "A semantic query to semantic_text field types", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SemanticQuery" + } + ] }, "shape": { - "$ref": "#/components/schemas/_types.query_dsl.ShapeQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-shape-query" + }, + "description": "Queries documents that contain fields indexed using the `shape` type.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ShapeQuery" + } + ] }, "simple_query_string": { - "$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-simple-query-string-query" + }, + "description": "Returns documents based on a provided query string, using a parser with a limited but fault-tolerant syntax.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringQuery" + } + ] }, "span_containing": { - "$ref": "#/components/schemas/_types.query_dsl.SpanContainingQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-containing-query" + }, + "description": "Returns matches which enclose another span query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanContainingQuery" + } + ] }, "span_field_masking": { - "$ref": "#/components/schemas/_types.query_dsl.SpanFieldMaskingQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-field-masking-query" + }, + "description": "Wrapper to allow span queries to participate in composite single-field span queries by _lying_ about their search field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanFieldMaskingQuery" + } + ] }, "span_first": { - "$ref": "#/components/schemas/_types.query_dsl.SpanFirstQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-first-query" + }, + "description": "Matches spans near the beginning of a field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanFirstQuery" + } + ] }, "span_multi": { - "$ref": "#/components/schemas/_types.query_dsl.SpanMultiTermQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-multi-term-query" + }, + "description": "Allows you to wrap a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query) as a `span` query, so it can be nested.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanMultiTermQuery" + } + ] }, "span_near": { - "$ref": "#/components/schemas/_types.query_dsl.SpanNearQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-near-query" + }, + "description": "Matches spans which are near one another.\nYou can specify `slop`, the maximum number of intervening unmatched positions, as well as whether matches are required to be in-order.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanNearQuery" + } + ] }, "span_not": { - "$ref": "#/components/schemas/_types.query_dsl.SpanNotQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-not-query" + }, + "description": "Removes matches which overlap with another span query or which are within x tokens before (controlled by the parameter `pre`) or y tokens after (controlled by the parameter `post`) another span query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanNotQuery" + } + ] }, "span_or": { - "$ref": "#/components/schemas/_types.query_dsl.SpanOrQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-query" + }, + "description": "Matches the union of its span clauses.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanOrQuery" + } + ] }, "span_term": { "externalDocs": { @@ -33485,10 +36581,27 @@ "maxProperties": 1 }, "span_within": { - "$ref": "#/components/schemas/_types.query_dsl.SpanWithinQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-within-query" + }, + "description": "Returns matches which are enclosed inside another span query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanWithinQuery" + } + ] }, "sparse_vector": { - "$ref": "#/components/schemas/_types.query_dsl.SparseVectorQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-sparse-vector-query" + }, + "description": "Using input query vectors or a natural language processing model to convert a query into a list of token-weight pairs, queries against a sparse vector field.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SparseVectorQuery" + } + ] }, "term": { "externalDocs": { @@ -33503,7 +36616,15 @@ "maxProperties": 1 }, "terms": { - "$ref": "#/components/schemas/_types.query_dsl.TermsQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-query" + }, + "description": "Returns documents that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.TermsQuery" + } + ] }, "terms_set": { "externalDocs": { @@ -33558,10 +36679,23 @@ "maxProperties": 1 }, "wrapper": { - "$ref": "#/components/schemas/_types.query_dsl.WrapperQuery" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wrapper-query" + }, + "description": "A query that accepts any other query as base64 encoded string.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.WrapperQuery" + } + ] }, "type": { - "$ref": "#/components/schemas/_types.query_dsl.TypeQuery" + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.TypeQuery" + } + ] } }, "minProperties": 1, @@ -33590,7 +36724,12 @@ ] }, "minimum_should_match": { - "$ref": "#/components/schemas/_types.MinimumShouldMatch" + "description": "Specifies the number or percentage of `should` clauses returned documents must match.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MinimumShouldMatch" + } + ] }, "must": { "description": "The clause (query) must appear in matching documents and will contribute to the score.", @@ -33675,10 +36814,20 @@ "type": "number" }, "negative": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Query used to decrease the relevance score of matching documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "positive": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Any returned documents must match this query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } }, "required": [ @@ -33704,13 +36853,25 @@ "type": "number" }, "high_freq_operator": { - "$ref": "#/components/schemas/_types.query_dsl.Operator" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.Operator" + } + ] }, "low_freq_operator": { - "$ref": "#/components/schemas/_types.query_dsl.Operator" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.Operator" + } + ] }, "minimum_should_match": { - "$ref": "#/components/schemas/_types.MinimumShouldMatch" + "allOf": [ + { + "$ref": "#/components/schemas/_types.MinimumShouldMatch" + } + ] }, "query": { "type": "string" @@ -33747,13 +36908,33 @@ "type": "boolean" }, "operator": { - "$ref": "#/components/schemas/_types.query_dsl.CombinedFieldsOperator" + "description": "Boolean logic used to interpret text in the query value.", + "default": "or", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.CombinedFieldsOperator" + } + ] }, "minimum_should_match": { - "$ref": "#/components/schemas/_types.MinimumShouldMatch" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match" + }, + "description": "Minimum number of clauses that must match for a document to be returned.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MinimumShouldMatch" + } + ] }, "zero_terms_query": { - "$ref": "#/components/schemas/_types.query_dsl.CombinedFieldsZeroTerms" + "description": "Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter.", + "default": "none", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.CombinedFieldsZeroTerms" + } + ] } }, "required": [ @@ -33786,7 +36967,12 @@ "type": "object", "properties": { "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Filter query you wish to run. Any returned documents must match this query.\nFilter queries do not calculate relevance scores.\nTo speed up performance, Elasticsearch automatically caches frequently used filter queries.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } }, "required": [ @@ -33865,7 +37051,12 @@ "type": "object" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Name of the field used to calculate distances. This field must meet the following criteria:\nbe a `date`, `date_nanos` or `geo_point` field;\nhave an `index` mapping parameter value of `true`, which is the default;\nhave an `doc_values` mapping parameter value of `true`, which is the default.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -33895,13 +37086,28 @@ "type": "object", "properties": { "origin": { - "$ref": "#/components/schemas/_types.GeoLocation" + "description": "Date or point of origin used to calculate distances.\nIf the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.\nDate Math, such as `now-1h`, is supported.\nIf the field value is a `geo_point` field, the `origin` value must be a geopoint.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoLocation" + } + ] }, "pivot": { - "$ref": "#/components/schemas/_types.Distance" + "description": "Distance from the `origin` at which relevance scores receive half of the `boost` value.\nIf the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Distance" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Name of the field used to calculate distances. This field must meet the following criteria:\nbe a `date`, `date_nanos` or `geo_point` field;\nhave an `index` mapping parameter value of `true`, which is the default;\nhave an `doc_values` mapping parameter value of `true`, which is the default.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -33934,13 +37140,28 @@ "type": "object", "properties": { "origin": { - "$ref": "#/components/schemas/_types.DateMath" + "description": "Date or point of origin used to calculate distances.\nIf the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.\nDate Math, such as `now-1h`, is supported.\nIf the field value is a `geo_point` field, the `origin` value must be a geopoint.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateMath" + } + ] }, "pivot": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Distance from the `origin` at which relevance scores receive half of the `boost` value.\nIf the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Name of the field used to calculate distances. This field must meet the following criteria:\nbe a `date`, `date_nanos` or `geo_point` field;\nhave an `index` mapping parameter value of `true`, which is the default;\nhave an `doc_values` mapping parameter value of `true`, which is the default.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -33963,7 +37184,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Name of the field you wish to search.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -33981,7 +37207,13 @@ "type": "object", "properties": { "boost_mode": { - "$ref": "#/components/schemas/_types.query_dsl.FunctionBoostMode" + "description": "Defines how he newly computed score is combined with the score of the query", + "default": "multiply", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.FunctionBoostMode" + } + ] }, "functions": { "description": "One or more functions that compute a new score for each document returned by the query.", @@ -33999,10 +37231,21 @@ "type": "number" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "A query that determines the documents for which a new score is computed.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "score_mode": { - "$ref": "#/components/schemas/_types.query_dsl.FunctionScoreMode" + "description": "Specifies how the computed scores are combined", + "default": "multiply", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.FunctionScoreMode" + } + ] } } } @@ -34025,7 +37268,11 @@ "type": "object", "properties": { "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "weight": { "type": "number" @@ -34036,22 +37283,52 @@ "type": "object", "properties": { "exp": { - "$ref": "#/components/schemas/_types.query_dsl.DecayFunction" + "description": "Function that scores a document with a exponential decay, depending on the distance of a numeric field value of the document from an origin.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.DecayFunction" + } + ] }, "gauss": { - "$ref": "#/components/schemas/_types.query_dsl.DecayFunction" + "description": "Function that scores a document with a normal decay, depending on the distance of a numeric field value of the document from an origin.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.DecayFunction" + } + ] }, "linear": { - "$ref": "#/components/schemas/_types.query_dsl.DecayFunction" + "description": "Function that scores a document with a linear decay, depending on the distance of a numeric field value of the document from an origin.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.DecayFunction" + } + ] }, "field_value_factor": { - "$ref": "#/components/schemas/_types.query_dsl.FieldValueFactorScoreFunction" + "description": "Function allows you to use a field from a document to influence the score.\nIt’s similar to using the script_score function, however, it avoids the overhead of scripting.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.FieldValueFactorScoreFunction" + } + ] }, "random_score": { - "$ref": "#/components/schemas/_types.query_dsl.RandomScoreFunction" + "description": "Generates scores that are uniformly distributed from 0 up to but not including 1.\nIn case you want scores to be reproducible, it is possible to provide a `seed` and `field`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.RandomScoreFunction" + } + ] }, "script_score": { - "$ref": "#/components/schemas/_types.query_dsl.ScriptScoreFunction" + "description": "Enables you to wrap another query and customize the scoring of it optionally with a computation derived from other numeric field values in the doc using a script expression.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ScriptScoreFunction" + } + ] } }, "minProperties": 1, @@ -34089,7 +37366,13 @@ "type": "object", "properties": { "multi_value_mode": { - "$ref": "#/components/schemas/_types.query_dsl.MultiValueMode" + "description": "Determines how the distance is calculated when a field used for computing the decay contains multiple values.", + "default": "min", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.MultiValueMode" + } + ] } } }, @@ -34116,7 +37399,13 @@ "type": "object", "properties": { "multi_value_mode": { - "$ref": "#/components/schemas/_types.query_dsl.MultiValueMode" + "description": "Determines how the distance is calculated when a field used for computing the decay contains multiple values.", + "default": "min", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.MultiValueMode" + } + ] } } }, @@ -34134,7 +37423,13 @@ "type": "object", "properties": { "multi_value_mode": { - "$ref": "#/components/schemas/_types.query_dsl.MultiValueMode" + "description": "Determines how the distance is calculated when a field used for computing the decay contains multiple values.", + "default": "min", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.MultiValueMode" + } + ] } } }, @@ -34152,7 +37447,13 @@ "type": "object", "properties": { "multi_value_mode": { - "$ref": "#/components/schemas/_types.query_dsl.MultiValueMode" + "description": "Determines how the distance is calculated when a field used for computing the decay contains multiple values.", + "default": "min", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.MultiValueMode" + } + ] } } }, @@ -34160,7 +37461,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field to be extracted from the document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "factor": { "description": "Optional factor to multiply the field value with.", @@ -34172,7 +37478,12 @@ "type": "number" }, "modifier": { - "$ref": "#/components/schemas/_types.query_dsl.FieldValueFactorModifier" + "description": "Modifier to apply to the field value.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.FieldValueFactorModifier" + } + ] } }, "required": [ @@ -34198,7 +37509,11 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "seed": { "oneOf": [ @@ -34216,7 +37531,12 @@ "type": "object", "properties": { "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "A script that computes a score.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } }, "required": [ @@ -34227,10 +37547,20 @@ "type": "object", "properties": { "source": { - "$ref": "#/components/schemas/_types.ScriptSource" + "description": "The script source.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptSource" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The `id` for a stored script.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "params": { "description": "Specifies any named parameters that are passed into the script as variables.\nUse parameters instead of hard-coded values to decrease compile time.", @@ -34240,7 +37570,13 @@ } }, "lang": { - "$ref": "#/components/schemas/_types.ScriptLanguage" + "description": "Specifies the language the script is written in.", + "default": "painless", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptLanguage" + } + ] }, "options": { "type": "object", @@ -34274,7 +37610,12 @@ } }, "collapse": { - "$ref": "#/components/schemas/_global.search._types.FieldCollapse" + "description": "Collapses search results the values of the specified field.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.FieldCollapse" + } + ] }, "explain": { "description": "If `true`, the request returns detailed information about score computation as part of a hit.", @@ -34294,10 +37635,24 @@ "type": "number" }, "highlight": { - "$ref": "#/components/schemas/_global.search._types.Highlight" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/highlighting" + }, + "description": "Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.Highlight" + } + ] }, "track_total_hits": { - "$ref": "#/components/schemas/_global.search._types.TrackHits" + "description": "Number of hits matching the query to count accurately.\nIf `true`, the exact number of hits is returned at the cost of some performance.\nIf `false`, the response does not include the total number of hits matching the query.", + "default": "10000", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.TrackHits" + } + ] }, "indices_boost": { "externalDocs": { @@ -34347,7 +37702,12 @@ "type": "number" }, "post_filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Use the `post_filter` parameter to filter search results.\nThe search hits are filtered after the aggregations are calculated.\nA post filter has no impact on the aggregation results.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "profile": { "description": "Set to `true` to return detailed timing information about the execution of individual components in a search request.\nNOTE: This is a debugging tool and adds significant overhead to search execution.", @@ -34355,7 +37715,15 @@ "type": "boolean" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl" + }, + "description": "The search definition using the Query DSL.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "rescore": { "description": "Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases.", @@ -34372,7 +37740,16 @@ ] }, "retriever": { - "$ref": "#/components/schemas/_types.RetrieverContainer" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrievers" + }, + "description": "A retriever is a specification to describe top documents returned from a search.\nA retriever replaces other elements of the search API that also return top documents such as `query` and `knn`.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RetrieverContainer" + } + ] }, "script_fields": { "description": "Retrieve a script evaluation (based on different fields) for each hit.", @@ -34382,7 +37759,12 @@ } }, "search_after": { - "$ref": "#/components/schemas/_types.SortResults" + "description": "Used to retrieve the next page of hits using a set of sort values from the previous page.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortResults" + } + ] }, "size": { "description": "The number of hits to return, which must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` property.", @@ -34390,13 +37772,34 @@ "type": "number" }, "slice": { - "$ref": "#/components/schemas/_types.SlicedScroll" + "description": "Split a scrolled search into multiple slices that can be consumed independently.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SlicedScroll" + } + ] }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results" + }, + "description": "A comma-separated list of : pairs.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] }, "_source": { - "$ref": "#/components/schemas/_global.search._types.SourceConfig" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#source-filtering" + }, + "description": "The source fields that are returned for matching documents.\nThese fields are returned in the `hits._source` property of the search response.\nIf the `stored_fields` property is specified, the `_source` property defaults to `false`.\nOtherwise, it defaults to `true`.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.SourceConfig" + } + ] }, "fields": { "description": "An array of wildcard (`*`) field patterns.\nThe request returns values for field names matching these patterns in the `hits.fields` property of the response.", @@ -34406,7 +37809,12 @@ } }, "suggest": { - "$ref": "#/components/schemas/_global.search._types.Suggester" + "description": "Defines a suggester that provides similar looking terms based on a provided text.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.Suggester" + } + ] }, "terminate_after": { "description": "The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this property to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this property for requests that target data streams with backing indices across multiple data tiers.\n\nIf set to `0` (default), the query does not terminate early.", @@ -34435,13 +37843,34 @@ "type": "boolean" }, "stored_fields": { - "$ref": "#/components/schemas/_types.Fields" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#stored-fields" + }, + "description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` property defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "pit": { - "$ref": "#/components/schemas/_global.search._types.PointInTimeReference" + "description": "Limit the search to a point in time (PIT).\nIf you provide a PIT, you cannot specify an `` in the request path.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.PointInTimeReference" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "externalDocs": { + "url": "https://www.elastic.co/docs/manage-data/data-store/mapping/define-runtime-fields-in-search-request" + }, + "description": "One or more runtime fields in the search request.\nThese fields take precedence over mapped fields with the same name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "stats": { "description": "The stats groups to associate with the search.\nEach group maintains a statistics aggregation for its associated searches.\nYou can retrieve these stats using the indices stats API.", @@ -34456,7 +37885,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to collapse the result set on", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "inner_hits": { "description": "The number of inner hits and their sort order", @@ -34477,7 +37911,11 @@ "type": "number" }, "collapse": { - "$ref": "#/components/schemas/_global.search._types.FieldCollapse" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.FieldCollapse" + } + ] } }, "required": [ @@ -34488,7 +37926,12 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The name for the particular inner hit definition in the response.\nUseful when a search request contains multiple inner hits.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "size": { "description": "The maximum number of hits to return per `inner_hits`.", @@ -34501,7 +37944,11 @@ "type": "number" }, "collapse": { - "$ref": "#/components/schemas/_global.search._types.FieldCollapse" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.FieldCollapse" + } + ] }, "docvalue_fields": { "type": "array", @@ -34513,7 +37960,11 @@ "type": "boolean" }, "highlight": { - "$ref": "#/components/schemas/_global.search._types.Highlight" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.Highlight" + } + ] }, "ignore_unmapped": { "type": "boolean" @@ -34534,13 +37985,26 @@ } }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "description": "How the inner hits should be sorted per `inner_hits`.\nBy default, inner hits are sorted by score.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] }, "_source": { - "$ref": "#/components/schemas/_global.search._types.SourceConfig" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.SourceConfig" + } + ] }, "stored_fields": { - "$ref": "#/components/schemas/_types.Fields" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "track_scores": { "default": false, @@ -34559,7 +38023,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "A wildcard pattern. The request returns values for field names matching this pattern.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "format": { "description": "The format in which the values are returned.", @@ -34582,7 +38051,11 @@ "type": "object", "properties": { "encoder": { - "$ref": "#/components/schemas/_global.search._types.HighlighterEncoder" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.HighlighterEncoder" + } + ] }, "fields": { "oneOf": [ @@ -34633,7 +38106,11 @@ "type": "number" }, "matched_fields": { - "$ref": "#/components/schemas/_types.Fields" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] } } } @@ -34643,7 +38120,11 @@ "type": "object", "properties": { "type": { - "$ref": "#/components/schemas/_global.search._types.HighlighterType" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.HighlighterType" + } + ] }, "boundary_chars": { "description": "A string that contains each boundary character.", @@ -34656,7 +38137,12 @@ "type": "number" }, "boundary_scanner": { - "$ref": "#/components/schemas/_global.search._types.BoundaryScanner" + "description": "Specifies how to break the highlighted fragments: chars, sentence, or word.\nOnly valid for the unified and fvh highlighters.\nDefaults to `sentence` for the `unified` highlighter. Defaults to `chars` for the `fvh` highlighter.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.BoundaryScanner" + } + ] }, "boundary_scanner_locale": { "description": "Controls which locale is used to search for sentence and word boundaries.\nThis parameter takes a form of a language tag, for example: `\"en-US\"`, `\"fr-FR\"`, `\"ja-JP\"`.", @@ -34668,7 +38154,13 @@ "type": "boolean" }, "fragmenter": { - "$ref": "#/components/schemas/_global.search._types.HighlighterFragmenter" + "description": "Specifies how text should be broken up in highlight snippets: `simple` or `span`.\nOnly valid for the `plain` highlighter.", + "default": "span", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.HighlighterFragmenter" + } + ] }, "fragment_size": { "description": "The size of the highlighted fragment in characters.", @@ -34679,7 +38171,12 @@ "type": "boolean" }, "highlight_query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Highlight matches for a query other than the search query.\nThis is especially useful if you use a rescore query because those are not taken into account by highlighting by default.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "max_fragment_length": { "type": "number" @@ -34705,7 +38202,13 @@ } }, "order": { - "$ref": "#/components/schemas/_global.search._types.HighlighterOrder" + "description": "Sorts highlighted fragments by score when set to `score`.\nBy default, fragments will be output in the order they appear in the field (order: `none`).\nSetting this option to `score` will output the most relevant fragments first.\nEach highlighter applies its own logic to compute relevancy scores.", + "default": "none", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.HighlighterOrder" + } + ] }, "phrase_limit": { "description": "Controls the number of matching phrases in a document that are considered.\nPrevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory.\nWhen using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory.\nOnly supported by the `fvh` highlighter.", @@ -34732,7 +38235,12 @@ "type": "boolean" }, "tags_schema": { - "$ref": "#/components/schemas/_global.search._types.HighlighterTagsSchema" + "description": "Set to `styled` to use the built-in tag schema.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.HighlighterTagsSchema" + } + ] } } }, @@ -34782,7 +38290,11 @@ "type": "object", "properties": { "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "ignore_failure": { "type": "boolean" @@ -34819,16 +38331,32 @@ "type": "object", "properties": { "_score": { - "$ref": "#/components/schemas/_types.ScoreSort" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScoreSort" + } + ] }, "_doc": { - "$ref": "#/components/schemas/_types.ScoreSort" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScoreSort" + } + ] }, "_geo_distance": { - "$ref": "#/components/schemas/_types.GeoDistanceSort" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoDistanceSort" + } + ] }, "_script": { - "$ref": "#/components/schemas/_types.ScriptSort" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptSort" + } + ] } }, "minProperties": 1, @@ -34838,7 +38366,11 @@ "type": "object", "properties": { "order": { - "$ref": "#/components/schemas/_types.SortOrder" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortOrder" + } + ] } } }, @@ -34853,22 +38385,42 @@ "type": "object", "properties": { "mode": { - "$ref": "#/components/schemas/_types.SortMode" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortMode" + } + ] }, "distance_type": { - "$ref": "#/components/schemas/_types.GeoDistanceType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoDistanceType" + } + ] }, "ignore_unmapped": { "type": "boolean" }, "order": { - "$ref": "#/components/schemas/_types.SortOrder" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortOrder" + } + ] }, "unit": { - "$ref": "#/components/schemas/_types.DistanceUnit" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DistanceUnit" + } + ] }, "nested": { - "$ref": "#/components/schemas/_types.NestedSortValue" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NestedSortValue" + } + ] } } }, @@ -34907,16 +38459,28 @@ "type": "object", "properties": { "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "max_children": { "type": "number" }, "nested": { - "$ref": "#/components/schemas/_types.NestedSortValue" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NestedSortValue" + } + ] }, "path": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -34927,19 +38491,39 @@ "type": "object", "properties": { "order": { - "$ref": "#/components/schemas/_types.SortOrder" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortOrder" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "type": { - "$ref": "#/components/schemas/_types.ScriptSortType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptSortType" + } + ] }, "mode": { - "$ref": "#/components/schemas/_types.SortMode" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortMode" + } + ] }, "nested": { - "$ref": "#/components/schemas/_types.NestedSortValue" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NestedSortValue" + } + ] } }, "required": [ @@ -34973,10 +38557,20 @@ "type": "boolean" }, "excludes": { - "$ref": "#/components/schemas/_types.Fields" + "description": "A list of fields to exclude from the returned source.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "includes": { - "$ref": "#/components/schemas/_types.Fields" + "description": "A list of fields to include in the returned source.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] } } }, @@ -34984,13 +38578,28 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The name of the vector field to search against", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "query_vector": { - "$ref": "#/components/schemas/_types.QueryVector" + "description": "The query vector", + "allOf": [ + { + "$ref": "#/components/schemas/_types.QueryVector" + } + ] }, "query_vector_builder": { - "$ref": "#/components/schemas/_types.QueryVectorBuilder" + "description": "The query vector builder. You must provide a query_vector_builder or query_vector, but not both.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.QueryVectorBuilder" + } + ] }, "k": { "description": "The final number of nearest neighbors to return as top hits", @@ -35023,10 +38632,21 @@ "type": "number" }, "inner_hits": { - "$ref": "#/components/schemas/_global.search._types.InnerHits" + "description": "If defined, each search hit will contain inner hits.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.InnerHits" + } + ] }, "rescore_vector": { - "$ref": "#/components/schemas/_types.RescoreVector" + "description": "Apply oversampling and rescoring to quantized vectors", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RescoreVector" + } + ] } }, "required": [ @@ -35043,7 +38663,11 @@ "type": "object", "properties": { "text_embedding": { - "$ref": "#/components/schemas/_types.TextEmbedding" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TextEmbedding" + } + ] } }, "minProperties": 1, @@ -35090,10 +38714,18 @@ "type": "object", "properties": { "query": { - "$ref": "#/components/schemas/_global.search._types.RescoreQuery" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.RescoreQuery" + } + ] }, "learning_to_rank": { - "$ref": "#/components/schemas/_global.search._types.LearningToRank" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.LearningToRank" + } + ] } }, "minProperties": 1, @@ -35105,7 +38737,12 @@ "type": "object", "properties": { "rescore_query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "The query to use for rescoring.\nThis query is only run on the Top-K results returned by the `query` and `post_filter` phases.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "query_weight": { "description": "Relative importance of the original query versus the rescore query.", @@ -35118,7 +38755,13 @@ "type": "number" }, "score_mode": { - "$ref": "#/components/schemas/_global.search._types.ScoreMode" + "description": "Determines how scores are combined.", + "default": "total", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.ScoreMode" + } + ] } }, "required": [ @@ -35158,28 +38801,68 @@ "type": "object", "properties": { "standard": { - "$ref": "#/components/schemas/_types.StandardRetriever" + "description": "A retriever that replaces the functionality of a traditional query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.StandardRetriever" + } + ] }, "knn": { - "$ref": "#/components/schemas/_types.KnnRetriever" + "description": "A retriever that replaces the functionality of a knn search.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.KnnRetriever" + } + ] }, "rrf": { - "$ref": "#/components/schemas/_types.RRFRetriever" + "description": "A retriever that produces top documents from reciprocal rank fusion (RRF).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RRFRetriever" + } + ] }, "text_similarity_reranker": { - "$ref": "#/components/schemas/_types.TextSimilarityReranker" + "description": "A retriever that reranks the top documents based on a reranking model using the InferenceAPI", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TextSimilarityReranker" + } + ] }, "rule": { - "$ref": "#/components/schemas/_types.RuleRetriever" + "description": "A retriever that replaces the functionality of a rule query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RuleRetriever" + } + ] }, "rescorer": { - "$ref": "#/components/schemas/_types.RescorerRetriever" + "description": "A retriever that re-scores only the results produced by its child retriever.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RescorerRetriever" + } + ] }, "linear": { - "$ref": "#/components/schemas/_types.LinearRetriever" + "description": "A retriever that supports the combination of different retrievers through a weighted linear combination.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.LinearRetriever" + } + ] }, "pinned": { - "$ref": "#/components/schemas/_types.PinnedRetriever" + "description": "A pinned retriever applies pinned documents to the underlying retriever.\nThis retriever will rewrite to a PinnedQueryBuilder.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.PinnedRetriever" + } + ] } }, "minProperties": 1, @@ -35194,20 +38877,40 @@ "type": "object", "properties": { "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Defines a query to retrieve a set of top documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "search_after": { - "$ref": "#/components/schemas/_types.SortResults" + "description": "Defines a search after object parameter used for pagination.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortResults" + } + ] }, "terminate_after": { "description": "Maximum number of documents to collect for each shard.", "type": "number" }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "description": "A sort object that that specifies the order of matching documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] }, "collapse": { - "$ref": "#/components/schemas/_global.search._types.FieldCollapse" + "description": "Collapses the top documents by a specified key into a single top document per key.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.FieldCollapse" + } + ] } } } @@ -35253,10 +38956,20 @@ "type": "string" }, "query_vector": { - "$ref": "#/components/schemas/_types.QueryVector" + "description": "Query vector. Must have the same number of dimensions as the vector field you are searching against. You must provide a query_vector_builder or query_vector, but not both.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.QueryVector" + } + ] }, "query_vector_builder": { - "$ref": "#/components/schemas/_types.QueryVectorBuilder" + "description": "Defines a model to build a query vector.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.QueryVectorBuilder" + } + ] }, "k": { "description": "Number of nearest neighbors to return as top hits.", @@ -35271,7 +38984,13 @@ "type": "number" }, "rescore_vector": { - "$ref": "#/components/schemas/_types.RescoreVector" + "description": "Apply oversampling and rescoring to quantized vectors", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RescoreVector" + } + ] } }, "required": [ @@ -35330,7 +39049,12 @@ "type": "object", "properties": { "retriever": { - "$ref": "#/components/schemas/_types.RetrieverContainer" + "description": "The nested retriever which will produce the first-level results, that will later be used for reranking.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RetrieverContainer" + } + ] }, "rank_window_size": { "description": "This value determines how many documents we will consider from the nested retriever.", @@ -35384,7 +39108,12 @@ "type": "object" }, "retriever": { - "$ref": "#/components/schemas/_types.RetrieverContainer" + "description": "The retriever whose results rules should be applied to.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RetrieverContainer" + } + ] }, "rank_window_size": { "description": "This value determines the size of the individual result set.", @@ -35408,7 +39137,12 @@ "type": "object", "properties": { "retriever": { - "$ref": "#/components/schemas/_types.RetrieverContainer" + "description": "Inner retriever.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RetrieverContainer" + } + ] }, "rescore": { "oneOf": [ @@ -35459,7 +39193,11 @@ } }, "normalizer": { - "$ref": "#/components/schemas/_types.ScoreNormalizer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScoreNormalizer" + } + ] } } } @@ -35469,13 +39207,21 @@ "type": "object", "properties": { "retriever": { - "$ref": "#/components/schemas/_types.RetrieverContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.RetrieverContainer" + } + ] }, "weight": { "type": "number" }, "normalizer": { - "$ref": "#/components/schemas/_types.ScoreNormalizer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScoreNormalizer" + } + ] } }, "required": [ @@ -35501,7 +39247,12 @@ "type": "object", "properties": { "retriever": { - "$ref": "#/components/schemas/_types.RetrieverContainer" + "description": "Inner retriever.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RetrieverContainer" + } + ] }, "ids": { "type": "array", @@ -35529,10 +39280,18 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] } }, "required": [ @@ -35543,10 +39302,18 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "max": { "type": "number" @@ -35570,10 +39337,18 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "keep_alive": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } }, "required": [ @@ -35608,19 +39383,44 @@ "type": "string" }, "input_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "For type `lookup`", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "For type `lookup`", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "target_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "For type `lookup`", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "Painless script executed at query time.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "type": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFieldType" + "description": "Field type, which can be: `boolean`, `composite`, `date`, `double`, `geo_point`, `ip`,`keyword`, `long`, or `lookup`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFieldType" + } + ] } }, "required": [ @@ -35631,7 +39431,11 @@ "type": "object", "properties": { "type": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFieldType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFieldType" + } + ] } }, "required": [ @@ -35657,7 +39461,11 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "format": { "type": "string" @@ -35713,7 +39521,13 @@ "type": "number" }, "rewrite": { - "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + "description": "Number of beginning characters left unchanged when creating expansions.", + "default": "constant_score", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + } + ] }, "transpositions": { "description": "Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`).", @@ -35721,7 +39535,12 @@ "type": "boolean" }, "fuzziness": { - "$ref": "#/components/schemas/_types.Fuzziness" + "description": "Maximum edit distance allowed for matching.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fuzziness" + } + ] }, "value": { "description": "Term you wish to find in the provided field.", @@ -35766,10 +39585,21 @@ "type": "object", "properties": { "type": { - "$ref": "#/components/schemas/_types.query_dsl.GeoExecution" + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.GeoExecution" + } + ] }, "validation_method": { - "$ref": "#/components/schemas/_types.query_dsl.GeoValidationMethod" + "description": "Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.\nSet to `COERCE` to also try to infer correct latitude or longitude.", + "default": "'strict'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.GeoValidationMethod" + } + ] }, "ignore_unmapped": { "description": "Set to `true` to ignore an unmapped field and not match any documents for this query.\nSet to `false` to throw an exception if the field is not mapped.", @@ -35804,13 +39634,30 @@ "type": "object", "properties": { "distance": { - "$ref": "#/components/schemas/_types.Distance" + "description": "The radius of the circle centred on the specified location.\nPoints which fall into this circle are considered to be matches.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Distance" + } + ] }, "distance_type": { - "$ref": "#/components/schemas/_types.GeoDistanceType" + "description": "How to compute the distance.\nSet to `plane` for a faster calculation that's inaccurate on long distances and close to the poles.", + "default": "'arc'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoDistanceType" + } + ] }, "validation_method": { - "$ref": "#/components/schemas/_types.query_dsl.GeoValidationMethod" + "description": "Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.\nSet to `COERCE` to also try to infer correct latitude or longitude.", + "default": "'strict'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.GeoValidationMethod" + } + ] }, "ignore_unmapped": { "description": "Set to `true` to ignore an unmapped field and not match any documents for this query.\nSet to `false` to throw an exception if the field is not mapped.", @@ -35833,13 +39680,25 @@ "type": "object", "properties": { "geotile": { - "$ref": "#/components/schemas/_types.GeoTile" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoTile" + } + ] }, "geohash": { - "$ref": "#/components/schemas/_types.GeoHash" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoHash" + } + ] }, "geohex": { - "$ref": "#/components/schemas/_types.GeoHexCell" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoHexCell" + } + ] } }, "minProperties": 1, @@ -35856,7 +39715,12 @@ "type": "object", "properties": { "validation_method": { - "$ref": "#/components/schemas/_types.query_dsl.GeoValidationMethod" + "default": "'strict'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.GeoValidationMethod" + } + ] }, "ignore_unmapped": { "type": "boolean" @@ -35896,7 +39760,12 @@ "type": "boolean" }, "inner_hits": { - "$ref": "#/components/schemas/_global.search._types.InnerHits" + "description": "If defined, each search hit will contain inner hits.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.InnerHits" + } + ] }, "max_children": { "description": "Maximum number of child documents that match the query allowed for a returned parent document.\nIf the parent document exceeds this limit, it is excluded from the search results.", @@ -35907,13 +39776,29 @@ "type": "number" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Query you wish to run on child documents of the `type` field.\nIf a child document matches the search, the query returns the parent document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "score_mode": { - "$ref": "#/components/schemas/_types.query_dsl.ChildScoreMode" + "description": "Indicates how scores for matching child documents affect the root parent document’s relevance score.", + "default": "'none'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ChildScoreMode" + } + ] }, "type": { - "$ref": "#/components/schemas/_types.RelationName" + "description": "Name of the child relationship mapped for the `join` field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RelationName" + } + ] } }, "required": [ @@ -35950,13 +39835,28 @@ "type": "boolean" }, "inner_hits": { - "$ref": "#/components/schemas/_global.search._types.InnerHits" + "description": "If defined, each search hit will contain inner hits.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.InnerHits" + } + ] }, "parent_type": { - "$ref": "#/components/schemas/_types.RelationName" + "description": "Name of the parent relationship mapped for the `join` field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RelationName" + } + ] }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Query you wish to run on parent documents of the `parent_type` field.\nIf a parent document matches the search, the query returns its child documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "score": { "description": "Indicates whether the relevance score of a matching parent document is aggregated into its child documents.", @@ -35980,7 +39880,12 @@ "type": "object", "properties": { "values": { - "$ref": "#/components/schemas/_types.Ids" + "description": "An array of document IDs.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Ids" + } + ] } } } @@ -36011,28 +39916,66 @@ "type": "object", "properties": { "all_of": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsAllOf" + "description": "Returns matches that span a combination of other rules.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsAllOf" + } + ] }, "any_of": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsAnyOf" + "description": "Returns intervals produced by any of its sub-rules.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsAnyOf" + } + ] }, "fuzzy": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsFuzzy" + "description": "Matches terms that are similar to the provided term, within an edit distance defined by `fuzziness`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsFuzzy" + } + ] }, "match": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsMatch" + "description": "Matches analyzed text.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsMatch" + } + ] }, "prefix": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsPrefix" + "description": "Matches terms that start with a specified set of characters.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsPrefix" + } + ] }, "range": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsRange" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsRange" + } + ] }, "regexp": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsRegexp" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsRegexp" + } + ] }, "wildcard": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsWildcard" + "description": "Matches terms using a wildcard pattern.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsWildcard" + } + ] } }, "minProperties": 1, @@ -36061,7 +40004,12 @@ "type": "boolean" }, "filter": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsFilter" + "description": "Rule used to filter returned intervals.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsFilter" + } + ] } }, "required": [ @@ -36072,28 +40020,66 @@ "type": "object", "properties": { "all_of": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsAllOf" + "description": "Returns matches that span a combination of other rules.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsAllOf" + } + ] }, "any_of": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsAnyOf" + "description": "Returns intervals produced by any of its sub-rules.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsAnyOf" + } + ] }, "fuzzy": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsFuzzy" + "description": "Matches analyzed text.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsFuzzy" + } + ] }, "match": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsMatch" + "description": "Matches analyzed text.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsMatch" + } + ] }, "prefix": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsPrefix" + "description": "Matches terms that start with a specified set of characters.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsPrefix" + } + ] }, "range": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsRange" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsRange" + } + ] }, "regexp": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsRegexp" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsRegexp" + } + ] }, "wildcard": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsWildcard" + "description": "Matches terms using a wildcard pattern.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsWildcard" + } + ] } }, "minProperties": 1, @@ -36110,7 +40096,12 @@ } }, "filter": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsFilter" + "description": "Rule used to filter returned intervals.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsFilter" + } + ] } }, "required": [ @@ -36121,31 +40112,76 @@ "type": "object", "properties": { "after": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + "description": "Query used to return intervals that follow an interval from the `filter` rule.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + } + ] }, "before": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + "description": "Query used to return intervals that occur before an interval from the `filter` rule.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + } + ] }, "contained_by": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + "description": "Query used to return intervals contained by an interval from the `filter` rule.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + } + ] }, "containing": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + "description": "Query used to return intervals that contain an interval from the `filter` rule.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + } + ] }, "not_contained_by": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + "description": "Query used to return intervals that are **not** contained by an interval from the `filter` rule.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + } + ] }, "not_containing": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + "description": "Query used to return intervals that do **not** contain an interval from the `filter` rule.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + } + ] }, "not_overlapping": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + "description": "Query used to return intervals that do **not** overlap with an interval from the `filter` rule.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + } + ] }, "overlapping": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + "description": "Query used to return intervals that overlap with an interval from the `filter` rule.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "Script used to return matching documents.\nThis script must return a boolean value: `true` or `false`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } }, "minProperties": 1, @@ -36159,7 +40195,13 @@ "type": "string" }, "fuzziness": { - "$ref": "#/components/schemas/_types.Fuzziness" + "description": "Maximum edit distance allowed for matching.", + "default": "auto", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fuzziness" + } + ] }, "prefix_length": { "description": "Number of beginning characters left unchanged when creating expansions.", @@ -36176,7 +40218,12 @@ "type": "boolean" }, "use_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "If specified, match intervals from this field rather than the top-level field.\nThe `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -36205,10 +40252,20 @@ "type": "string" }, "use_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "If specified, match intervals from this field rather than the top-level field.\nThe `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "filter": { - "$ref": "#/components/schemas/_types.query_dsl.IntervalsFilter" + "description": "An optional interval filter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IntervalsFilter" + } + ] } }, "required": [ @@ -36227,7 +40284,12 @@ "type": "string" }, "use_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "If specified, match intervals from this field rather than the top-level field.\nThe `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -36258,7 +40320,12 @@ "type": "string" }, "use_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "If specified, match intervals from this field rather than the top-level field.\nThe `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } } }, @@ -36274,7 +40341,12 @@ "type": "string" }, "use_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "If specified, match intervals from this field rather than the top-level field.\nThe `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -36293,7 +40365,12 @@ "type": "string" }, "use_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "If specified, match intervals from this field rather than the top-level field.\nThe `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -36309,13 +40386,28 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The name of the vector field to search against", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "query_vector": { - "$ref": "#/components/schemas/_types.QueryVector" + "description": "The query vector", + "allOf": [ + { + "$ref": "#/components/schemas/_types.QueryVector" + } + ] }, "query_vector_builder": { - "$ref": "#/components/schemas/_types.QueryVectorBuilder" + "description": "The query vector builder. You must provide a query_vector_builder or query_vector, but not both.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.QueryVectorBuilder" + } + ] }, "num_candidates": { "description": "The number of nearest neighbor candidates to consider per shard", @@ -36344,7 +40436,13 @@ "type": "number" }, "rescore_vector": { - "$ref": "#/components/schemas/_types.RescoreVector" + "description": "Apply oversampling and rescoring to quantized vectors", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RescoreVector" + } + ] } }, "required": [ @@ -36375,10 +40473,20 @@ "type": "number" }, "fuzziness": { - "$ref": "#/components/schemas/_types.Fuzziness" + "description": "Maximum edit distance allowed for matching.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fuzziness" + } + ] }, "fuzzy_rewrite": { - "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + "description": "Method used to rewrite the query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + } + ] }, "fuzzy_transpositions": { "description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).", @@ -36396,10 +40504,21 @@ "type": "number" }, "minimum_should_match": { - "$ref": "#/components/schemas/_types.MinimumShouldMatch" + "description": "Minimum number of clauses that must match for a document to be returned.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MinimumShouldMatch" + } + ] }, "operator": { - "$ref": "#/components/schemas/_types.query_dsl.Operator" + "description": "Boolean logic used to interpret text in the query value.", + "default": "'or'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.Operator" + } + ] }, "prefix_length": { "description": "Number of beginning characters left unchanged for fuzzy matching.", @@ -36421,7 +40540,13 @@ ] }, "zero_terms_query": { - "$ref": "#/components/schemas/_types.query_dsl.ZeroTermsQuery" + "description": "Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter.", + "default": "'none'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ZeroTermsQuery" + } + ] } }, "required": [ @@ -36460,10 +40585,20 @@ "type": "string" }, "fuzziness": { - "$ref": "#/components/schemas/_types.Fuzziness" + "description": "Maximum edit distance allowed for matching.\nCan be applied to the term subqueries constructed for all terms but the final term.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fuzziness" + } + ] }, "fuzzy_rewrite": { - "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + "description": "Method used to rewrite the query.\nCan be applied to the term subqueries constructed for all terms but the final term.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + } + ] }, "fuzzy_transpositions": { "description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).\nCan be applied to the term subqueries constructed for all terms but the final term.", @@ -36476,10 +40611,21 @@ "type": "number" }, "minimum_should_match": { - "$ref": "#/components/schemas/_types.MinimumShouldMatch" + "description": "Minimum number of clauses that must match for a document to be returned.\nApplied to the constructed bool query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MinimumShouldMatch" + } + ] }, "operator": { - "$ref": "#/components/schemas/_types.query_dsl.Operator" + "description": "Boolean logic used to interpret text in the query value.\nApplied to the constructed bool query.", + "default": "'or'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.Operator" + } + ] }, "prefix_length": { "description": "Number of beginning characters left unchanged for fuzzy matching.\nCan be applied to the term subqueries constructed for all terms but the final term.", @@ -36529,7 +40675,13 @@ "type": "number" }, "zero_terms_query": { - "$ref": "#/components/schemas/_types.query_dsl.ZeroTermsQuery" + "description": "Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter.", + "default": "'none'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ZeroTermsQuery" + } + ] } }, "required": [ @@ -36565,7 +40717,13 @@ "type": "number" }, "zero_terms_query": { - "$ref": "#/components/schemas/_types.query_dsl.ZeroTermsQuery" + "description": "Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter.", + "default": "none", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ZeroTermsQuery" + } + ] } }, "required": [ @@ -36645,7 +40803,12 @@ "type": "number" }, "minimum_should_match": { - "$ref": "#/components/schemas/_types.MinimumShouldMatch" + "description": "After the disjunctive query has been formed, this parameter controls the number of terms that must match.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MinimumShouldMatch" + } + ] }, "min_term_freq": { "description": "The minimum term frequency below which the terms are ignored from the input document.", @@ -36658,10 +40821,19 @@ "type": "number" }, "routing": { - "$ref": "#/components/schemas/_types.Routing" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "stop_words": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "description": "An array of stop words.\nAny word in this set is ignored.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "unlike": { "description": "Used in combination with `like` to exclude documents that match a set of terms.", @@ -36678,10 +40850,19 @@ ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "version_type": { - "$ref": "#/components/schemas/_types.VersionType" + "default": "'internal'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionType" + } + ] } }, "required": [ @@ -36715,10 +40896,20 @@ } }, "_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "ID of a document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "Index of a document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "per_field_analyzer": { "description": "Overrides the default analyzer.", @@ -36728,13 +40919,26 @@ } }, "routing": { - "$ref": "#/components/schemas/_types.Routing" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "version_type": { - "$ref": "#/components/schemas/_types.VersionType" + "default": "'internal'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionType" + } + ] } } }, @@ -36825,13 +41029,28 @@ "type": "number" }, "fields": { - "$ref": "#/components/schemas/_types.Fields" + "description": "The fields to be queried.\nDefaults to the `index.query.default_field` index settings, which in turn defaults to `*`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "fuzziness": { - "$ref": "#/components/schemas/_types.Fuzziness" + "description": "Maximum edit distance allowed for matching.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fuzziness" + } + ] }, "fuzzy_rewrite": { - "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + "description": "Method used to rewrite the query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + } + ] }, "fuzzy_transpositions": { "description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).\nCan be applied to the term subqueries constructed for all terms but the final term.", @@ -36849,10 +41068,21 @@ "type": "number" }, "minimum_should_match": { - "$ref": "#/components/schemas/_types.MinimumShouldMatch" + "description": "Minimum number of clauses that must match for a document to be returned.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MinimumShouldMatch" + } + ] }, "operator": { - "$ref": "#/components/schemas/_types.query_dsl.Operator" + "description": "Boolean logic used to interpret text in the query value.", + "default": "'or'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.Operator" + } + ] }, "prefix_length": { "description": "Number of beginning characters left unchanged for fuzzy matching.", @@ -36874,10 +41104,22 @@ "type": "number" }, "type": { - "$ref": "#/components/schemas/_types.query_dsl.TextQueryType" + "description": "How `the` multi_match query is executed internally.", + "default": "'best_fields'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.TextQueryType" + } + ] }, "zero_terms_query": { - "$ref": "#/components/schemas/_types.query_dsl.ZeroTermsQuery" + "description": "Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter.", + "default": "'none'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ZeroTermsQuery" + } + ] } }, "required": [ @@ -36911,16 +41153,37 @@ "type": "boolean" }, "inner_hits": { - "$ref": "#/components/schemas/_global.search._types.InnerHits" + "description": "If defined, each search hit will contain inner hits.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.InnerHits" + } + ] }, "path": { - "$ref": "#/components/schemas/_types.Field" + "description": "Path to the nested object you wish to search.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Query you wish to run on nested objects in the path.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "score_mode": { - "$ref": "#/components/schemas/_types.query_dsl.ChildScoreMode" + "description": "How scores for matching child objects affect the root parent document’s relevance score.", + "default": "'avg'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ChildScoreMode" + } + ] } }, "required": [ @@ -36939,7 +41202,12 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "ID of the parent document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "ignore_unmapped": { "description": "Indicates whether to ignore an unmapped `type` and not return any documents instead of an error.", @@ -36947,7 +41215,12 @@ "type": "boolean" }, "type": { - "$ref": "#/components/schemas/_types.RelationName" + "description": "Name of the child relationship mapped for the `join` field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RelationName" + } + ] } } } @@ -36973,13 +41246,28 @@ } }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field that holds the indexed queries. The field must use the `percolator` mapping type.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The ID of a stored document to percolate.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The index of a stored document to percolate.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "name": { "description": "The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified.", @@ -36990,10 +41278,20 @@ "type": "string" }, "routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "Routing used to fetch document to percolate.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "The expected version of a stored document to percolate.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] } }, "required": [ @@ -37016,7 +41314,12 @@ "type": "object", "properties": { "organic": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Any choice of query used to rank documents which will be ranked below the \"pinned\" documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } }, "required": [ @@ -37052,10 +41355,20 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The unique document ID.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The index that contains the document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] } }, "required": [ @@ -37071,7 +41384,12 @@ "type": "object", "properties": { "rewrite": { - "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + "description": "Method used to rewrite the query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + } + ] }, "value": { "description": "Beginning characters of terms you wish to find in the provided field.", @@ -37118,10 +41436,21 @@ "type": "boolean" }, "default_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Default field to search if no field is provided in the query string.\nSupports wildcards (`*`).\nDefaults to the `index.query.default_field` index setting, which has a default value of `*`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "default_operator": { - "$ref": "#/components/schemas/_types.query_dsl.Operator" + "description": "Default boolean logic used to interpret text in the query string if no operators are specified.", + "default": "'or'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.Operator" + } + ] }, "enable_position_increments": { "description": "If `true`, enable position increments in queries constructed from a `query_string` search.", @@ -37140,7 +41469,12 @@ } }, "fuzziness": { - "$ref": "#/components/schemas/_types.Fuzziness" + "description": "Maximum edit distance allowed for fuzzy matching.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fuzziness" + } + ] }, "fuzzy_max_expansions": { "description": "Maximum number of terms to which the query expands for fuzzy matching.", @@ -37153,7 +41487,12 @@ "type": "number" }, "fuzzy_rewrite": { - "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + "description": "Method used to rewrite the query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + } + ] }, "fuzzy_transpositions": { "description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).", @@ -37171,7 +41510,12 @@ "type": "number" }, "minimum_should_match": { - "$ref": "#/components/schemas/_types.MinimumShouldMatch" + "description": "Minimum number of clauses that must match for a document to be returned.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MinimumShouldMatch" + } + ] }, "phrase_slop": { "description": "Maximum number of positions allowed between matching tokens for phrases.", @@ -37191,17 +41535,33 @@ "type": "string" }, "rewrite": { - "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + "description": "Method used to rewrite the query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + } + ] }, "tie_breaker": { "description": "How to combine the queries generated from the individual search terms in the resulting `dis_max` query.", "type": "number" }, "time_zone": { - "$ref": "#/components/schemas/_types.TimeZone" + "description": "Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TimeZone" + } + ] }, "type": { - "$ref": "#/components/schemas/_types.query_dsl.TextQueryType" + "description": "Determines how the query matches and scores documents.", + "default": "'best_fields'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.TextQueryType" + } + ] } }, "required": [ @@ -37241,10 +41601,20 @@ "type": "object", "properties": { "format": { - "$ref": "#/components/schemas/_types.DateFormat" + "description": "Date format used to convert `date` values in the query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateFormat" + } + ] }, "time_zone": { - "$ref": "#/components/schemas/_types.TimeZone" + "description": "Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TimeZone" + } + ] } } } @@ -37262,7 +41632,13 @@ "type": "object", "properties": { "relation": { - "$ref": "#/components/schemas/_types.query_dsl.RangeRelation" + "description": "Indicates how the range query matches values for `range` fields.", + "default": "intersects", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.RangeRelation" + } + ] }, "gt": { "description": "Greater than.", @@ -37301,10 +41677,20 @@ "type": "object", "properties": { "format": { - "$ref": "#/components/schemas/_types.DateFormat" + "description": "Date format used to convert `date` values in the query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateFormat" + } + ] }, "time_zone": { - "$ref": "#/components/schemas/_types.TimeZone" + "description": "Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TimeZone" + } + ] } } } @@ -37319,19 +41705,45 @@ "type": "object", "properties": { "relation": { - "$ref": "#/components/schemas/_types.query_dsl.RangeRelation" + "description": "Indicates how the range query matches values for `range` fields.", + "default": "intersects", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.RangeRelation" + } + ] }, "gt": { - "$ref": "#/components/schemas/_types.DateMath" + "description": "Greater than.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateMath" + } + ] }, "gte": { - "$ref": "#/components/schemas/_types.DateMath" + "description": "Greater than or equal to.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateMath" + } + ] }, "lt": { - "$ref": "#/components/schemas/_types.DateMath" + "description": "Less than.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateMath" + } + ] }, "lte": { - "$ref": "#/components/schemas/_types.DateMath" + "description": "Less than or equal to.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateMath" + } + ] } } } @@ -37356,7 +41768,13 @@ "type": "object", "properties": { "relation": { - "$ref": "#/components/schemas/_types.query_dsl.RangeRelation" + "description": "Indicates how the range query matches values for `range` fields.", + "default": "intersects", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.RangeRelation" + } + ] }, "gt": { "description": "Greater than.", @@ -37397,7 +41815,13 @@ "type": "object", "properties": { "relation": { - "$ref": "#/components/schemas/_types.query_dsl.RangeRelation" + "description": "Indicates how the range query matches values for `range` fields.", + "default": "intersects", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.RangeRelation" + } + ] }, "gt": { "description": "Greater than.", @@ -37428,19 +41852,44 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "`rank_feature` or `rank_features` field used to boost relevance scores.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "saturation": { - "$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunctionSaturation" + "description": "Saturation function used to boost relevance scores based on the value of the rank feature `field`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunctionSaturation" + } + ] }, "log": { - "$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunctionLogarithm" + "description": "Logarithmic function used to boost relevance scores based on the value of the rank feature `field`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunctionLogarithm" + } + ] }, "linear": { - "$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunctionLinear" + "description": "Linear function used to boost relevance scores based on the value of the rank feature `field`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunctionLinear" + } + ] }, "sigmoid": { - "$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunctionSigmoid" + "description": "Sigmoid function used to boost relevance scores based on the value of the rank feature `field`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunctionSigmoid" + } + ] } }, "required": [ @@ -37545,7 +41994,12 @@ "type": "number" }, "rewrite": { - "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + "description": "Method used to rewrite the query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + } + ] }, "value": { "description": "Regular expression for terms you wish to find in the provided field.", @@ -37567,7 +42021,11 @@ "type": "object", "properties": { "organic": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "ruleset_ids": { "oneOf": [ @@ -37605,7 +42063,12 @@ "type": "object", "properties": { "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "Contains a script to run as a query.\nThis script must return a boolean value, `true` or `false`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } }, "required": [ @@ -37627,10 +42090,20 @@ "type": "number" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Query used to return documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "Script used to compute the score of documents returned by the query.\nImportant: final relevance scores from the `script_score` query cannot be negative.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } }, "required": [ @@ -37703,7 +42176,13 @@ "type": "boolean" }, "default_operator": { - "$ref": "#/components/schemas/_types.query_dsl.Operator" + "description": "Default boolean logic used to interpret text in the query string if no operators are specified.", + "default": "'or'", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.Operator" + } + ] }, "fields": { "description": "Array of fields you wish to search.\nAccepts wildcard expressions.\nYou also can boost relevance scores for matches to particular fields using a caret (`^`) notation.\nDefaults to the `index.query.default_field index` setting, which has a default value of `*`.", @@ -37713,7 +42192,13 @@ } }, "flags": { - "$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringFlags" + "description": "List of enabled operators for the simple query string syntax.", + "default": "ALL", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringFlags" + } + ] }, "fuzzy_max_expansions": { "description": "Maximum number of terms to which the query expands for fuzzy matching.", @@ -37735,7 +42220,12 @@ "type": "boolean" }, "minimum_should_match": { - "$ref": "#/components/schemas/_types.MinimumShouldMatch" + "description": "Minimum number of clauses that must match for a document to be returned.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MinimumShouldMatch" + } + ] }, "query": { "description": "Query string in the simple query string syntax you wish to parse and use for search.", @@ -37798,10 +42288,20 @@ "type": "object", "properties": { "big": { - "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + "description": "Can be any span query.\nMatching spans from `big` that contain matches from `little` are returned.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + } + ] }, "little": { - "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + "description": "Can be any span query.\nMatching spans from `big` that contain matches from `little` are returned.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + } + ] } }, "required": [ @@ -37815,28 +42315,67 @@ "type": "object", "properties": { "span_containing": { - "$ref": "#/components/schemas/_types.query_dsl.SpanContainingQuery" + "description": "Accepts a list of span queries, but only returns those spans which also match a second span query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanContainingQuery" + } + ] }, "span_field_masking": { - "$ref": "#/components/schemas/_types.query_dsl.SpanFieldMaskingQuery" + "description": "Allows queries like `span_near` or `span_or` across different fields.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanFieldMaskingQuery" + } + ] }, "span_first": { - "$ref": "#/components/schemas/_types.query_dsl.SpanFirstQuery" + "description": "Accepts another span query whose matches must appear within the first N positions of the field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanFirstQuery" + } + ] }, "span_gap": { - "$ref": "#/components/schemas/_types.query_dsl.SpanGapQuery" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanGapQuery" + } + ] }, "span_multi": { - "$ref": "#/components/schemas/_types.query_dsl.SpanMultiTermQuery" + "description": "Wraps a `term`, `range`, `prefix`, `wildcard`, `regexp`, or `fuzzy` query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanMultiTermQuery" + } + ] }, "span_near": { - "$ref": "#/components/schemas/_types.query_dsl.SpanNearQuery" + "description": "Accepts multiple span queries whose matches must be within the specified distance of each other, and possibly in the same order.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanNearQuery" + } + ] }, "span_not": { - "$ref": "#/components/schemas/_types.query_dsl.SpanNotQuery" + "description": "Wraps another span query, and excludes any documents which match that query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanNotQuery" + } + ] }, "span_or": { - "$ref": "#/components/schemas/_types.query_dsl.SpanOrQuery" + "description": "Combines multiple span queries and returns documents which match any of the specified queries.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanOrQuery" + } + ] }, "span_term": { "description": "The equivalent of the `term` query but for use with other span queries.", @@ -37848,7 +42387,12 @@ "maxProperties": 1 }, "span_within": { - "$ref": "#/components/schemas/_types.query_dsl.SpanWithinQuery" + "description": "The result from a single span query is returned as long is its span falls within the spans returned by a list of other span queries.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanWithinQuery" + } + ] } }, "minProperties": 1, @@ -37863,10 +42407,18 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + } + ] } }, "required": [ @@ -37889,7 +42441,12 @@ "type": "number" }, "match": { - "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + "description": "Can be any other span type query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + } + ] } }, "required": [ @@ -37917,7 +42474,12 @@ "type": "object", "properties": { "match": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Should be a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } }, "required": [ @@ -37969,10 +42531,20 @@ "type": "number" }, "exclude": { - "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + "description": "Span query whose matches must not overlap those returned.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + } + ] }, "include": { - "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + "description": "Span query whose matches are filtered.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + } + ] }, "post": { "description": "The number of tokens after the include span that can’t have overlap with the exclude span.", @@ -38023,7 +42595,11 @@ "type": "object", "properties": { "value": { - "$ref": "#/components/schemas/_types.FieldValue" + "allOf": [ + { + "$ref": "#/components/schemas/_types.FieldValue" + } + ] } }, "required": [ @@ -38041,10 +42617,20 @@ "type": "object", "properties": { "big": { - "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + "description": "Can be any span query.\nMatching spans from `little` that are enclosed within `big` are returned.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + } + ] }, "little": { - "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + "description": "Can be any span query.\nMatching spans from `little` that are enclosed within `big` are returned.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SpanQuery" + } + ] } }, "required": [ @@ -38068,7 +42654,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The name of the field that contains the token-weight pairs to be searched against.\nThis field must be a mapped sparse_vector field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "query": { "description": "The query text you want to use for search.\nIf inference_id is specified, query must also be specified.", @@ -38080,7 +42671,13 @@ "type": "boolean" }, "pruning_config": { - "$ref": "#/components/schemas/_types.TokenPruningConfig" + "description": "Optional pruning configuration.\nIf enabled, this will omit non-significant tokens from the query in order to improve query performance.\nThis is only used if prune is set to true.\nIf prune is set to true but pruning_config is not specified, default values will be used.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TokenPruningConfig" + } + ] } }, "required": [ @@ -38098,7 +42695,12 @@ } }, "inference_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The inference ID to use to convert the query text into token-weight pairs.\nIt must be the same inference ID that was used to create the tokens from the input text.\nOnly one of inference_id and query_vector is allowed.\nIf inference_id is specified, query must also be specified.\nOnly one of inference_id or query_vector may be supplied in a request.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] } }, "minProperties": 1, @@ -38137,7 +42739,12 @@ "type": "object", "properties": { "value": { - "$ref": "#/components/schemas/_types.FieldValue" + "description": "Term you wish to find in the provided field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.FieldValue" + } + ] }, "case_insensitive": { "description": "Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.\nWhen `false`, the case sensitivity of matching depends on the underlying field’s mapping.", @@ -38171,13 +42778,29 @@ "type": "object", "properties": { "minimum_should_match": { - "$ref": "#/components/schemas/_types.MinimumShouldMatch" + "description": "Specification describing number of matching terms required to return a document.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MinimumShouldMatch" + } + ] }, "minimum_should_match_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Numeric field containing the number of matching terms required to return a document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "minimum_should_match_script": { - "$ref": "#/components/schemas/_types.Script" + "description": "Custom script containing the number of matching terms required to return a document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "terms": { "description": "Array of terms you wish to find in the provided field.", @@ -38210,7 +42833,13 @@ "type": "string" }, "pruning_config": { - "$ref": "#/components/schemas/_types.TokenPruningConfig" + "description": "Token pruning configurations", + "x-state": "Technical preview", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TokenPruningConfig" + } + ] } }, "required": [ @@ -38249,7 +42878,12 @@ ] }, "pruning_config": { - "$ref": "#/components/schemas/_types.TokenPruningConfig" + "description": "Token pruning configurations", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TokenPruningConfig" + } + ] } }, "required": [ @@ -38272,7 +42906,12 @@ "type": "boolean" }, "rewrite": { - "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + "description": "Method used to rewrite the query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.MultiTermQueryRewrite" + } + ] }, "value": { "description": "Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set.", @@ -38351,17 +42990,32 @@ "type": "number" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field on which to run the aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "format": { "description": "The date format used to format `key_as_string` in the response.\nIf no `format` is specified, the first date format specified in the field mapping is used.", "type": "string" }, "minimum_interval": { - "$ref": "#/components/schemas/_types.aggregations.MinimumInterval" + "description": "The minimum rounding interval.\nThis can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower than `minimum_interval`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MinimumInterval" + } + ] }, "missing": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "offset": { "description": "Time zone specified as a ISO 8601 UTC offset.", @@ -38374,10 +43028,19 @@ } }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "time_zone": { - "$ref": "#/components/schemas/_types.TimeZone" + "description": "Time zone ID.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TimeZone" + } + ] } } } @@ -38423,13 +43086,27 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field on which to run the aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "missing": { - "$ref": "#/components/schemas/_types.aggregations.Missing" + "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.Missing" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } } }, @@ -38472,7 +43149,13 @@ "type": "string" }, "gap_policy": { - "$ref": "#/components/schemas/_types.aggregations.GapPolicy" + "description": "Policy to apply when gaps are found in the data.", + "default": "skip", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GapPolicy" + } + ] } } } @@ -38495,7 +43178,12 @@ "type": "object", "properties": { "buckets_path": { - "$ref": "#/components/schemas/_types.aggregations.BucketsPath" + "description": "Path to the buckets that contain one set of values to correlate.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsPath" + } + ] } } } @@ -38534,7 +43222,13 @@ "type": "number" }, "execution_hint": { - "$ref": "#/components/schemas/_types.aggregations.TDigestExecutionHint" + "description": "The default implementation of TDigest is optimized for performance, scaling to millions or even billions of sample values while maintaining acceptable accuracy levels (close to 1% relative error for millions of samples in some cases).\nTo use an implementation optimized for accuracy, set this parameter to high_accuracy instead.", + "default": "default", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TDigestExecutionHint" + } + ] } } } @@ -38556,7 +43250,12 @@ "type": "object", "properties": { "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "The script to run for this aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } } } @@ -38571,7 +43270,12 @@ "type": "object", "properties": { "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "The script to run for this aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } } } @@ -38590,14 +43294,25 @@ "type": "number" }, "gap_policy": { - "$ref": "#/components/schemas/_types.aggregations.GapPolicy" + "description": "The policy to apply when gaps are found in the data.", + "default": "skip", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GapPolicy" + } + ] }, "size": { "description": "The number of buckets to return.\nDefaults to all buckets of the parent aggregation.", "type": "number" }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "description": "The list of fields to sort on.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] } } } @@ -38644,7 +43359,12 @@ "type": "object", "properties": { "function": { - "$ref": "#/components/schemas/_types.aggregations.BucketCorrelationFunction" + "description": "The correlation function to execute.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketCorrelationFunction" + } + ] } }, "required": [ @@ -38657,7 +43377,12 @@ "type": "object", "properties": { "count_correlation": { - "$ref": "#/components/schemas/_types.aggregations.BucketCorrelationFunctionCountCorrelation" + "description": "The configuration to calculate a count correlation. This function is designed for determining the correlation of a term value and a given metric.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketCorrelationFunctionCountCorrelation" + } + ] } }, "required": [ @@ -38668,7 +43393,12 @@ "type": "object", "properties": { "indicator": { - "$ref": "#/components/schemas/_types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator" + "description": "The indicator with which to correlate the configured `bucket_path` values.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator" + } + ] } }, "required": [ @@ -38719,7 +43449,12 @@ "type": "boolean" }, "execution_hint": { - "$ref": "#/components/schemas/_types.aggregations.CardinalityExecutionMode" + "description": "Mechanism by which cardinality aggregations is run.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CardinalityExecutionMode" + } + ] } } } @@ -38745,7 +43480,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The semi-structured text field to categorize.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "max_unique_tokens": { "description": "The maximum number of unique tokens at any position up to max_matched_tokens. Must be larger than 1.\nSmaller values use less memory and create fewer categories. Larger values will use more memory and\ncreate narrower categories. Max allowed value is 100.", @@ -38770,7 +43510,15 @@ } }, "categorization_analyzer": { - "$ref": "#/components/schemas/_types.aggregations.CategorizeTextAnalyzer" + "externalDocs": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-analyze" + }, + "description": "The categorization analyzer specifies how the text is analyzed and tokenized before being categorized.\nThe syntax is very similar to that used to define the analyzer in the analyze API. This property\ncannot be used at the same time as `categorization_filters`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CategorizeTextAnalyzer" + } + ] }, "shard_size": { "description": "The number of categorization buckets to return from each shard before merging all the results.", @@ -38835,7 +43583,12 @@ "type": "object", "properties": { "type": { - "$ref": "#/components/schemas/_types.RelationName" + "description": "The child type that should be selected.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RelationName" + } + ] } } } @@ -38850,7 +43603,12 @@ "type": "object", "properties": { "after": { - "$ref": "#/components/schemas/_types.aggregations.CompositeAggregateKey" + "description": "When paginating, use the `after_key` value returned in the previous response to retrieve the next page.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CompositeAggregateKey" + } + ] }, "size": { "description": "The number of composite buckets that should be returned.", @@ -38875,16 +43633,36 @@ "type": "object", "properties": { "terms": { - "$ref": "#/components/schemas/_types.aggregations.CompositeTermsAggregation" + "description": "A terms aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CompositeTermsAggregation" + } + ] }, "histogram": { - "$ref": "#/components/schemas/_types.aggregations.CompositeHistogramAggregation" + "description": "A histogram aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CompositeHistogramAggregation" + } + ] }, "date_histogram": { - "$ref": "#/components/schemas/_types.aggregations.CompositeDateHistogramAggregation" + "description": "A date histogram aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CompositeDateHistogramAggregation" + } + ] }, "geotile_grid": { - "$ref": "#/components/schemas/_types.aggregations.CompositeGeoTileGridAggregation" + "description": "A geotile grid aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CompositeGeoTileGridAggregation" + } + ] } } }, @@ -38902,22 +43680,44 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Either `field` or `script` must be present", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "missing_bucket": { "type": "boolean" }, "missing_order": { - "$ref": "#/components/schemas/_types.aggregations.MissingOrder" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MissingOrder" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "Either `field` or `script` must be present", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "value_type": { - "$ref": "#/components/schemas/_types.aggregations.ValueType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ValueType" + } + ] }, "order": { - "$ref": "#/components/schemas/_types.SortOrder" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortOrder" + } + ] } } }, @@ -38974,16 +43774,34 @@ "type": "string" }, "calendar_interval": { - "$ref": "#/components/schemas/_types.DurationLarge" + "description": "Either `calendar_interval` or `fixed_interval` must be present", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationLarge" + } + ] }, "fixed_interval": { - "$ref": "#/components/schemas/_types.DurationLarge" + "description": "Either `calendar_interval` or `fixed_interval` must be present", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationLarge" + } + ] }, "offset": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "time_zone": { - "$ref": "#/components/schemas/_types.TimeZone" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TimeZone" + } + ] } } } @@ -39001,7 +43819,11 @@ "type": "number" }, "bounds": { - "$ref": "#/components/schemas/_types.GeoBounds" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoBounds" + } + ] } } } @@ -39036,39 +43858,84 @@ "type": "object", "properties": { "calendar_interval": { - "$ref": "#/components/schemas/_types.aggregations.CalendarInterval" + "description": "Calendar-aware interval.\nCan be specified using the unit name, such as `month`, or as a single unit quantity, such as `1M`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CalendarInterval" + } + ] }, "extended_bounds": { - "$ref": "#/components/schemas/_types.aggregations.ExtendedBoundsFieldDateMath" + "description": "Enables extending the bounds of the histogram beyond the data itself.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ExtendedBoundsFieldDateMath" + } + ] }, "hard_bounds": { - "$ref": "#/components/schemas/_types.aggregations.ExtendedBoundsFieldDateMath" + "description": "Limits the histogram to specified bounds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ExtendedBoundsFieldDateMath" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The date field whose values are use to build a histogram.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "fixed_interval": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "format": { "description": "The date format used to format `key_as_string` in the response.\nIf no `format` is specified, the first date format specified in the field mapping is used.", "type": "string" }, "interval": { - "$ref": "#/components/schemas/_types.Duration" + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "min_doc_count": { "description": "Only returns buckets that have `min_doc_count` number of documents.\nBy default, all buckets between the first bucket that matches documents and the last one are returned.", "type": "number" }, "missing": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "offset": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Changes the start value of each bucket by the specified positive (`+`) or negative offset (`-`) duration.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "order": { - "$ref": "#/components/schemas/_types.aggregations.AggregateOrder" + "description": "The sort order of the returned buckets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.AggregateOrder" + } + ] }, "params": { "type": "object", @@ -39077,10 +43944,19 @@ } }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "time_zone": { - "$ref": "#/components/schemas/_types.TimeZone" + "description": "Time zone used for bucketing and rounding.\nDefaults to Coordinated Universal Time (UTC).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TimeZone" + } + ] }, "keyed": { "description": "Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array.", @@ -39115,10 +43991,20 @@ "type": "object", "properties": { "max": { - "$ref": "#/components/schemas/_types.aggregations.FieldDateMath" + "description": "Maximum value for the bound.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.FieldDateMath" + } + ] }, "min": { - "$ref": "#/components/schemas/_types.aggregations.FieldDateMath" + "description": "Minimum value for the bound.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.FieldDateMath" + } + ] } } }, @@ -39165,14 +44051,24 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The date field whose values are use to build ranges.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "format": { "description": "The date format used to format `from` and `to` in the response.", "type": "string" }, "missing": { - "$ref": "#/components/schemas/_types.aggregations.Missing" + "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.Missing" + } + ] }, "ranges": { "description": "Array of date ranges.", @@ -39182,7 +44078,12 @@ } }, "time_zone": { - "$ref": "#/components/schemas/_types.TimeZone" + "description": "Time zone used to convert dates from another time zone to UTC.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TimeZone" + } + ] }, "keyed": { "description": "Set to `true` to associate a unique string key with each bucket and returns the ranges as a hash rather than an array.", @@ -39196,14 +44097,24 @@ "type": "object", "properties": { "from": { - "$ref": "#/components/schemas/_types.aggregations.FieldDateMath" + "description": "Start of the range (inclusive).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.FieldDateMath" + } + ] }, "key": { "description": "Custom key to return the range with.", "type": "string" }, "to": { - "$ref": "#/components/schemas/_types.aggregations.FieldDateMath" + "description": "End of the range (exclusive).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.FieldDateMath" + } + ] } } }, @@ -39226,7 +44137,13 @@ "type": "object", "properties": { "execution_hint": { - "$ref": "#/components/schemas/_types.aggregations.SamplerAggregationExecutionHint" + "description": "The type of value used for de-duplication.", + "default": "global_ordinals", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.SamplerAggregationExecutionHint" + } + ] }, "max_docs_per_value": { "description": "Limits how many documents are permitted per choice of de-duplicating value.", @@ -39234,7 +44151,11 @@ "type": "number" }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "shard_size": { "description": "Limits how many top-scoring documents are collected in the sample processed on each shard.", @@ -39242,7 +44163,12 @@ "type": "number" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field used to provide values used for de-duplication.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } } } @@ -39314,7 +44240,12 @@ "type": "number" }, "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Query that filters documents from analysis.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } }, "required": [ @@ -39325,13 +44256,27 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "exclude": { - "$ref": "#/components/schemas/_types.aggregations.TermsExclude" + "description": "Values to exclude.\nCan be regular expression strings or arrays of strings of exact terms.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsExclude" + } + ] }, "include": { - "$ref": "#/components/schemas/_types.aggregations.TermsInclude" + "description": "Values to include.\nCan be regular expression strings or arrays of strings of exact terms.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsInclude" + } + ] } }, "required": [ @@ -39393,7 +44338,12 @@ "type": "object", "properties": { "filters": { - "$ref": "#/components/schemas/_types.aggregations.BucketsQueryContainer" + "description": "Collection of queries from which to build buckets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsQueryContainer" + } + ] }, "other_bucket": { "description": "Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters.", @@ -39459,7 +44409,11 @@ "type": "number" }, "location": { - "$ref": "#/components/schemas/_types.GeoLocation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoLocation" + } + ] } } } @@ -39474,13 +44428,29 @@ "type": "object", "properties": { "distance_type": { - "$ref": "#/components/schemas/_types.GeoDistanceType" + "description": "The distance calculation type.", + "default": "arc", + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoDistanceType" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "A field of type `geo_point` used to evaluate the distance.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "origin": { - "$ref": "#/components/schemas/_types.GeoLocation" + "description": "The origin used to evaluate the distance.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoLocation" + } + ] }, "ranges": { "description": "An array of ranges used to bucket documents.", @@ -39490,7 +44460,13 @@ } }, "unit": { - "$ref": "#/components/schemas/_types.DistanceUnit" + "description": "The distance unit.", + "default": "m", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DistanceUnit" + } + ] } } } @@ -39538,13 +44514,29 @@ "type": "object", "properties": { "bounds": { - "$ref": "#/components/schemas/_types.GeoBounds" + "description": "The bounding box to filter the points in each bucket.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoBounds" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing indexed `geo_point` or `geo_shape` values.\nIf the field contains an array, `geohash_grid` aggregates all array values.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "precision": { - "$ref": "#/components/schemas/_types.GeoHashPrecision" + "description": "The string length of the geohashes used to define cells/buckets in the results.", + "default": "5", + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoHashPrecision" + } + ] }, "shard_size": { "description": "Allows for more accurate counting of the top cells returned in the final result the aggregation.\nDefaults to returning `max(10,(size x number-of-shards))` buckets from each shard.", @@ -39574,17 +44566,33 @@ "type": "object", "properties": { "point": { - "$ref": "#/components/schemas/_types.aggregations.GeoLinePoint" + "description": "The name of the geo_point field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GeoLinePoint" + } + ] }, "sort": { - "$ref": "#/components/schemas/_types.aggregations.GeoLineSort" + "description": "The name of the numeric field to use as the sort key for ordering the points.\nWhen the `geo_line` aggregation is nested inside a `time_series` aggregation, this field defaults to `@timestamp`, and any other value will result in error.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GeoLineSort" + } + ] }, "include_sort": { "description": "When `true`, returns an additional array of the sort values in the feature properties.", "type": "boolean" }, "sort_order": { - "$ref": "#/components/schemas/_types.SortOrder" + "description": "The order in which the line is sorted (ascending or descending).", + "default": "asc", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortOrder" + } + ] }, "size": { "description": "The maximum length of the line represented in the aggregation.\nValid sizes are between 1 and 10000.", @@ -39601,7 +44609,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The name of the geo_point field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -39612,7 +44625,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The name of the numeric field to use as the sort key for ordering the points.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -39628,10 +44646,21 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing indexed `geo_point` or `geo_shape` values.\nIf the field contains an array, `geotile_grid` aggregates all array values.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "precision": { - "$ref": "#/components/schemas/_types.GeoTilePrecision" + "description": "Integer zoom of the key used to define cells/buckets in the results.\nValues outside of the range [0,29] will be rejected.", + "default": "7", + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoTilePrecision" + } + ] }, "shard_size": { "description": "Allows for more accurate counting of the top cells returned in the final result the aggregation.\nDefaults to returning `max(10,(size x number-of-shards))` buckets from each shard.", @@ -39643,7 +44672,12 @@ "type": "number" }, "bounds": { - "$ref": "#/components/schemas/_types.GeoBounds" + "description": "A bounding box to filter the geo-points or geo-shapes in each bucket.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoBounds" + } + ] } } } @@ -39661,7 +44695,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing indexed `geo_point` or `geo_shape` values.\nIf the field contains an array, `geohex_grid` aggregates all array values.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "precision": { "description": "Integer zoom of the key used to defined cells or buckets\nin the results. Value should be between 0-15.", @@ -39669,7 +44708,12 @@ "type": "number" }, "bounds": { - "$ref": "#/components/schemas/_types.GeoBounds" + "description": "Bounding box used to filter the geo-points in each bucket.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoBounds" + } + ] }, "size": { "description": "Maximum number of buckets to return.", @@ -39706,13 +44750,28 @@ "type": "object", "properties": { "extended_bounds": { - "$ref": "#/components/schemas/_types.aggregations.ExtendedBoundsdouble" + "description": "Enables extending the bounds of the histogram beyond the data itself.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ExtendedBoundsdouble" + } + ] }, "hard_bounds": { - "$ref": "#/components/schemas/_types.aggregations.ExtendedBoundsdouble" + "description": "Limits the range of buckets in the histogram.\nIt is particularly useful in the case of open data ranges that can result in a very large number of buckets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ExtendedBoundsdouble" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The name of the field to aggregate on.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "interval": { "description": "The interval for the buckets.\nMust be a positive decimal.", @@ -39731,10 +44790,19 @@ "type": "number" }, "order": { - "$ref": "#/components/schemas/_types.aggregations.AggregateOrder" + "description": "The sort order of the returned buckets.\nBy default, the returned buckets are sorted by their key ascending.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.AggregateOrder" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "format": { "type": "string" @@ -39770,7 +44838,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The date field whose values are used to build ranges.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ranges": { "description": "Array of IP ranges.", @@ -39825,7 +44898,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The IP address field to aggregation on. The field mapping type must be `ip`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "prefix_length": { "description": "Length of the network prefix. For IPv4 addresses the accepted range is [0, 32].\nFor IPv6 addresses the accepted range is [0, 128].", @@ -39867,10 +44945,20 @@ "type": "object", "properties": { "model_id": { - "$ref": "#/components/schemas/_types.Name" + "description": "The ID or alias for the trained model.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "inference_config": { - "$ref": "#/components/schemas/_types.aggregations.InferenceConfigContainer" + "description": "Contains the inference type and its options.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.InferenceConfigContainer" + } + ] } }, "required": [ @@ -39883,10 +44971,20 @@ "type": "object", "properties": { "regression": { - "$ref": "#/components/schemas/ml._types.RegressionInferenceOptions" + "description": "Regression configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.RegressionInferenceOptions" + } + ] }, "classification": { - "$ref": "#/components/schemas/ml._types.ClassificationInferenceOptions" + "description": "Classification configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ClassificationInferenceOptions" + } + ] } }, "minProperties": 1, @@ -39896,7 +44994,12 @@ "type": "object", "properties": { "results_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "num_top_feature_importance_values": { "description": "Specifies the maximum number of feature importance values per document.", @@ -39940,7 +45043,13 @@ "type": "object", "properties": { "mode": { - "$ref": "#/components/schemas/_types.SortMode" + "description": "Array value the aggregation will use for array or multi-valued fields.", + "default": "avg", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortMode" + } + ] } } } @@ -39955,7 +45064,12 @@ "type": "object", "properties": { "fields": { - "$ref": "#/components/schemas/_types.Fields" + "description": "An array of fields for computing the statistics.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "missing": { "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", @@ -40002,7 +45116,13 @@ "type": "number" }, "execution_hint": { - "$ref": "#/components/schemas/_types.aggregations.TDigestExecutionHint" + "description": "The default implementation of TDigest is optimized for performance, scaling to millions or even billions of sample values while maintaining acceptable accuracy levels (close to 1% relative error for millions of samples in some cases).\nTo use an implementation optimized for accuracy, set this parameter to high_accuracy instead.", + "default": "default", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TDigestExecutionHint" + } + ] } } } @@ -40037,10 +45157,19 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The name of the field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "missing": { - "$ref": "#/components/schemas/_types.aggregations.Missing" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.Missing" + } + ] } } } @@ -40083,7 +45212,11 @@ ] }, "settings": { - "$ref": "#/components/schemas/_types.EmptyObject" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EmptyObject" + } + ] } }, "required": [ @@ -40133,7 +45266,11 @@ ] }, "settings": { - "$ref": "#/components/schemas/_types.EmptyObject" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EmptyObject" + } + ] } }, "required": [ @@ -40158,7 +45295,11 @@ ] }, "settings": { - "$ref": "#/components/schemas/_types.aggregations.EwmaModelSettings" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.EwmaModelSettings" + } + ] } }, "required": [ @@ -40191,7 +45332,11 @@ ] }, "settings": { - "$ref": "#/components/schemas/_types.aggregations.HoltLinearModelSettings" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.HoltLinearModelSettings" + } + ] } }, "required": [ @@ -40227,7 +45372,11 @@ ] }, "settings": { - "$ref": "#/components/schemas/_types.aggregations.HoltWintersModelSettings" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.HoltWintersModelSettings" + } + ] } }, "required": [ @@ -40256,7 +45405,11 @@ "type": "number" }, "type": { - "$ref": "#/components/schemas/_types.aggregations.HoltWintersType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.HoltWintersType" + } + ] } } }, @@ -40325,10 +45478,21 @@ "type": "object", "properties": { "collect_mode": { - "$ref": "#/components/schemas/_types.aggregations.TermsAggregationCollectMode" + "description": "Specifies the strategy for data collection.", + "default": "breadth_first", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsAggregationCollectMode" + } + ] }, "order": { - "$ref": "#/components/schemas/_types.aggregations.AggregateOrder" + "description": "Specifies the sort order of the buckets.\nDefaults to sorting by descending document count.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.AggregateOrder" + } + ] }, "min_doc_count": { "description": "The minimum number of documents in a bucket for it to be returned.", @@ -40379,10 +45543,20 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "A fields from which to retrieve terms.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "missing": { - "$ref": "#/components/schemas/_types.aggregations.Missing" + "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.Missing" + } + ] } }, "required": [ @@ -40398,7 +45572,12 @@ "type": "object", "properties": { "path": { - "$ref": "#/components/schemas/_types.Field" + "description": "The path to the field of type `nested`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } } } @@ -40413,7 +45592,12 @@ "type": "object", "properties": { "method": { - "$ref": "#/components/schemas/_types.aggregations.NormalizeMethod" + "description": "The specific method to apply.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.NormalizeMethod" + } + ] } } } @@ -40439,7 +45623,12 @@ "type": "object", "properties": { "type": { - "$ref": "#/components/schemas/_types.RelationName" + "description": "The child type that should be selected.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RelationName" + } + ] } } } @@ -40474,10 +45663,20 @@ ] }, "hdr": { - "$ref": "#/components/schemas/_types.aggregations.HdrMethod" + "description": "Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.HdrMethod" + } + ] }, "tdigest": { - "$ref": "#/components/schemas/_types.aggregations.TDigest" + "description": "Sets parameters for the default TDigest algorithm used to calculate percentile ranks.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TDigest" + } + ] } } } @@ -40500,7 +45699,13 @@ "type": "number" }, "execution_hint": { - "$ref": "#/components/schemas/_types.aggregations.TDigestExecutionHint" + "description": "The default implementation of TDigest is optimized for performance, scaling to millions or even billions of sample values while maintaining acceptable accuracy levels (close to 1% relative error for millions of samples in some cases).\nTo use an implementation optimized for accuracy, set this parameter to high_accuracy instead.", + "default": "default", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TDigestExecutionHint" + } + ] } } }, @@ -40525,10 +45730,20 @@ } }, "hdr": { - "$ref": "#/components/schemas/_types.aggregations.HdrMethod" + "description": "Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.HdrMethod" + } + ] }, "tdigest": { - "$ref": "#/components/schemas/_types.aggregations.TDigest" + "description": "Sets parameters for the default TDigest algorithm used to calculate percentiles.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TDigest" + } + ] } } } @@ -40562,7 +45777,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The date field whose values are use to build ranges.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "missing": { "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", @@ -40576,7 +45796,11 @@ } }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "keyed": { "description": "Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array.", @@ -40598,13 +45822,28 @@ "type": "object", "properties": { "exclude": { - "$ref": "#/components/schemas/_types.aggregations.TermsExclude" + "description": "Terms that should be excluded from the aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsExclude" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field from which to return rare terms.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "include": { - "$ref": "#/components/schemas/_types.aggregations.TermsInclude" + "description": "Terms that should be included in the aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsInclude" + } + ] }, "max_doc_count": { "description": "The maximum number of documents a term should appear in.", @@ -40612,7 +45851,12 @@ "type": "number" }, "missing": { - "$ref": "#/components/schemas/_types.aggregations.Missing" + "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.Missing" + } + ] }, "precision": { "description": "The precision of the internal CuckooFilters.\nSmaller precision leads to better approximation, but higher memory usage.", @@ -40635,10 +45879,21 @@ "type": "object", "properties": { "unit": { - "$ref": "#/components/schemas/_types.aggregations.CalendarInterval" + "description": "The interval used to calculate the rate.\nBy default, the interval of the `date_histogram` is used.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CalendarInterval" + } + ] }, "mode": { - "$ref": "#/components/schemas/_types.aggregations.RateMode" + "description": "How the rate is calculated.", + "default": "sum", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.RateMode" + } + ] } } } @@ -40660,7 +45915,12 @@ "type": "object", "properties": { "path": { - "$ref": "#/components/schemas/_types.Field" + "description": "Defines the nested object field that should be joined back to.\nThe default is empty, which means that it joins back to the root/main document level.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } } } @@ -40692,13 +45952,28 @@ "type": "object", "properties": { "combine_script": { - "$ref": "#/components/schemas/_types.Script" + "description": "Runs once on each shard after document collection is complete.\nAllows the aggregation to consolidate the state returned from each shard.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "init_script": { - "$ref": "#/components/schemas/_types.Script" + "description": "Runs prior to any collection of documents.\nAllows the aggregation to set up any initial state.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "map_script": { - "$ref": "#/components/schemas/_types.Script" + "description": "Run once per document collected.\nIf no `combine_script` is specified, the resulting state needs to be stored in the `state` object.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "params": { "description": "A global object with script parameters for `init`, `map` and `combine` scripts.\nIt is shared between the scripts.", @@ -40708,7 +45983,12 @@ } }, "reduce_script": { - "$ref": "#/components/schemas/_types.Script" + "description": "Runs once on the coordinating node after all shards have returned their results.\nThe script is provided with access to a variable `states`, which is an array of the result of the `combine_script` on each shard.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } } } @@ -40739,28 +46019,68 @@ "type": "object", "properties": { "background_filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "chi_square": { - "$ref": "#/components/schemas/_types.aggregations.ChiSquareHeuristic" + "description": "Use Chi square, as described in \"Information Retrieval\", Manning et al., Chapter 13.5.2, as the significance score.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ChiSquareHeuristic" + } + ] }, "exclude": { - "$ref": "#/components/schemas/_types.aggregations.TermsExclude" + "description": "Terms to exclude.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsExclude" + } + ] }, "execution_hint": { - "$ref": "#/components/schemas/_types.aggregations.TermsAggregationExecutionHint" + "description": "Mechanism by which the aggregation should be executed: using field values directly or using global ordinals.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsAggregationExecutionHint" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field from which to return significant terms.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "gnd": { - "$ref": "#/components/schemas/_types.aggregations.GoogleNormalizedDistanceHeuristic" + "description": "Use Google normalized distance as described in \"The Google Similarity Distance\", Cilibrasi and Vitanyi, 2007, as the significance score.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GoogleNormalizedDistanceHeuristic" + } + ] }, "include": { - "$ref": "#/components/schemas/_types.aggregations.TermsInclude" + "description": "Terms to include.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsInclude" + } + ] }, "jlh": { - "$ref": "#/components/schemas/_types.EmptyObject" + "description": "Use JLH score as the significance score.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EmptyObject" + } + ] }, "min_doc_count": { "description": "Only return terms that are found in more than `min_doc_count` hits.", @@ -40768,13 +46088,28 @@ "type": "number" }, "mutual_information": { - "$ref": "#/components/schemas/_types.aggregations.MutualInformationHeuristic" + "description": "Use mutual information as described in \"Information Retrieval\", Manning et al., Chapter 13.5.1, as the significance score.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MutualInformationHeuristic" + } + ] }, "percentage": { - "$ref": "#/components/schemas/_types.aggregations.PercentageScoreHeuristic" + "description": "A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.PercentageScoreHeuristic" + } + ] }, "script_heuristic": { - "$ref": "#/components/schemas/_types.aggregations.ScriptedHeuristic" + "description": "Customized score, implemented via a script.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ScriptedHeuristic" + } + ] }, "shard_min_doc_count": { "description": "Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`.\nTerms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`.", @@ -40847,7 +46182,11 @@ "type": "object", "properties": { "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } }, "required": [ @@ -40863,32 +46202,72 @@ "type": "object", "properties": { "background_filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "chi_square": { - "$ref": "#/components/schemas/_types.aggregations.ChiSquareHeuristic" + "description": "Use Chi square, as described in \"Information Retrieval\", Manning et al., Chapter 13.5.2, as the significance score.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ChiSquareHeuristic" + } + ] }, "exclude": { - "$ref": "#/components/schemas/_types.aggregations.TermsExclude" + "description": "Values to exclude.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsExclude" + } + ] }, "execution_hint": { - "$ref": "#/components/schemas/_types.aggregations.TermsAggregationExecutionHint" + "description": "Determines whether the aggregation will use field values directly or global ordinals.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsAggregationExecutionHint" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field from which to return significant text.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "filter_duplicate_text": { "description": "Whether to out duplicate text to deal with noisy data.", "type": "boolean" }, "gnd": { - "$ref": "#/components/schemas/_types.aggregations.GoogleNormalizedDistanceHeuristic" + "description": "Use Google normalized distance as described in \"The Google Similarity Distance\", Cilibrasi and Vitanyi, 2007, as the significance score.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GoogleNormalizedDistanceHeuristic" + } + ] }, "include": { - "$ref": "#/components/schemas/_types.aggregations.TermsInclude" + "description": "Values to include.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsInclude" + } + ] }, "jlh": { - "$ref": "#/components/schemas/_types.EmptyObject" + "description": "Use JLH score as the significance score.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EmptyObject" + } + ] }, "min_doc_count": { "description": "Only return values that are found in more than `min_doc_count` hits.", @@ -40896,13 +46275,28 @@ "type": "number" }, "mutual_information": { - "$ref": "#/components/schemas/_types.aggregations.MutualInformationHeuristic" + "description": "Use mutual information as described in \"Information Retrieval\", Manning et al., Chapter 13.5.1, as the significance score.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MutualInformationHeuristic" + } + ] }, "percentage": { - "$ref": "#/components/schemas/_types.aggregations.PercentageScoreHeuristic" + "description": "A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.PercentageScoreHeuristic" + } + ] }, "script_heuristic": { - "$ref": "#/components/schemas/_types.aggregations.ScriptedHeuristic" + "description": "Customized score, implemented via a script.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ScriptedHeuristic" + } + ] }, "shard_min_doc_count": { "description": "Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count.\nValues will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`.", @@ -40917,7 +46311,12 @@ "type": "number" }, "source_fields": { - "$ref": "#/components/schemas/_types.Fields" + "description": "Overrides the JSON `_source` fields from which text will be analyzed.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] } } } @@ -40989,19 +46388,44 @@ "type": "object", "properties": { "collect_mode": { - "$ref": "#/components/schemas/_types.aggregations.TermsAggregationCollectMode" + "description": "Determines how child aggregations should be calculated: breadth-first or depth-first.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsAggregationCollectMode" + } + ] }, "exclude": { - "$ref": "#/components/schemas/_types.aggregations.TermsExclude" + "description": "Values to exclude.\nAccepts regular expressions and partitions.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsExclude" + } + ] }, "execution_hint": { - "$ref": "#/components/schemas/_types.aggregations.TermsAggregationExecutionHint" + "description": "Determines whether the aggregation will use field values directly or global ordinals.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsAggregationExecutionHint" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field from which to return terms.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "include": { - "$ref": "#/components/schemas/_types.aggregations.TermsInclude" + "description": "Values to include.\nAccepts regular expressions and partitions.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsInclude" + } + ] }, "min_doc_count": { "description": "Only return values that are found in more than `min_doc_count` hits.", @@ -41009,10 +46433,19 @@ "type": "number" }, "missing": { - "$ref": "#/components/schemas/_types.aggregations.Missing" + "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.Missing" + } + ] }, "missing_order": { - "$ref": "#/components/schemas/_types.aggregations.MissingOrder" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MissingOrder" + } + ] }, "missing_bucket": { "type": "boolean" @@ -41022,10 +46455,19 @@ "type": "string" }, "order": { - "$ref": "#/components/schemas/_types.aggregations.AggregateOrder" + "description": "Specifies the sort order of the buckets.\nDefaults to sorting by descending document count.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.AggregateOrder" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "shard_min_doc_count": { "description": "Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`.\nTerms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`.", @@ -41105,7 +46547,12 @@ "type": "number" }, "highlight": { - "$ref": "#/components/schemas/_global.search._types.Highlight" + "description": "Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.Highlight" + } + ] }, "script_fields": { "description": "Returns the result of one or more script evaluations for each hit.", @@ -41120,13 +46567,28 @@ "type": "number" }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "description": "Sort order of the top matching hits.\nBy default, the hits are sorted by the score of the main query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] }, "_source": { - "$ref": "#/components/schemas/_global.search._types.SourceConfig" + "description": "Selects the fields of the source that are returned.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.SourceConfig" + } + ] }, "stored_fields": { - "$ref": "#/components/schemas/_types.Fields" + "description": "Returns values for the specified stored fields (fields that use the `store` mapping option).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "track_scores": { "description": "If `true`, calculates and returns document scores, even if the scores are not used for sorting.", @@ -41155,13 +46617,29 @@ "type": "object", "properties": { "a": { - "$ref": "#/components/schemas/_types.aggregations.TestPopulation" + "description": "Test population A.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TestPopulation" + } + ] }, "b": { - "$ref": "#/components/schemas/_types.aggregations.TestPopulation" + "description": "Test population B.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TestPopulation" + } + ] }, "type": { - "$ref": "#/components/schemas/_types.aggregations.TTestType" + "description": "The type of test.", + "default": "heteroscedastic", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TTestType" + } + ] } } } @@ -41171,13 +46649,27 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to aggregate.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "A filter used to define a set of records to run unpaired t-test on.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } }, "required": [ @@ -41220,7 +46712,12 @@ "type": "number" }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "description": "The sort order of the documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] } } } @@ -41230,7 +46727,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "A field to return as a metric.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -41275,13 +46777,27 @@ "type": "string" }, "value": { - "$ref": "#/components/schemas/_types.aggregations.WeightedAverageValue" + "description": "Configuration for the field that provides the values.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.WeightedAverageValue" + } + ] }, "value_type": { - "$ref": "#/components/schemas/_types.aggregations.ValueType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ValueType" + } + ] }, "weight": { - "$ref": "#/components/schemas/_types.aggregations.WeightedAverageValue" + "description": "Configuration for the field or script that provides the weights.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.WeightedAverageValue" + } + ] } } } @@ -41291,14 +46807,23 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field from which to extract the values or weights.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "missing": { "description": "A value or weight to use if the field is missing.", "type": "number" }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } } }, @@ -41306,7 +46831,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The name of the field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "buckets": { "description": "The target number of buckets.", @@ -41322,7 +46852,11 @@ "type": "number" }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } } }, @@ -41355,16 +46889,36 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_global.bulk.IndexOperation" + "description": "Index the specified document.\nIf the document exists, it replaces the document and increments the version.\nThe following line must contain the source data to be indexed.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.bulk.IndexOperation" + } + ] }, "create": { - "$ref": "#/components/schemas/_global.bulk.CreateOperation" + "description": "Index the specified document if it does not already exist.\nThe following line must contain the source data to be indexed.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.bulk.CreateOperation" + } + ] }, "update": { - "$ref": "#/components/schemas/_global.bulk.UpdateOperation" + "description": "Perform a partial document update.\nThe following line must contain the partial document and update options.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.bulk.UpdateOperation" + } + ] }, "delete": { - "$ref": "#/components/schemas/_global.bulk.DeleteOperation" + "description": "Remove the specified document from the index.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.bulk.DeleteOperation" + } + ] } }, "minProperties": 1, @@ -41412,25 +46966,52 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The document ID.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The name of the index or index alias to perform the action on.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "A custom value used to route operations to a specific shard.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "if_primary_term": { "type": "number" }, "if_seq_no": { - "$ref": "#/components/schemas/_types.SequenceNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SequenceNumber" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "version_type": { - "$ref": "#/components/schemas/_types.VersionType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionType" + } + ] } } }, @@ -41493,7 +47074,12 @@ "type": "boolean" }, "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "The script to run to update the document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "scripted_upsert": { "description": "Set to `true` to run the script whether or not the document exists.", @@ -41501,7 +47087,13 @@ "type": "boolean" }, "_source": { - "$ref": "#/components/schemas/_global.search._types.SourceConfig" + "description": "If `false`, source retrieval is turned off.\nYou can also specify a comma-separated list of the fields you want to retrieve.", + "default": "true", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.SourceConfig" + } + ] }, "upsert": { "description": "If the document does not already exist, the contents of `upsert` are inserted as a new document.\nIf the document exists, the `script` is run.", @@ -41533,10 +47125,19 @@ "type": "number" }, "failure_store": { - "$ref": "#/components/schemas/_global.bulk.FailureStoreStatus" + "allOf": [ + { + "$ref": "#/components/schemas/_global.bulk.FailureStoreStatus" + } + ] }, "error": { - "$ref": "#/components/schemas/_types.ErrorCause" + "description": "Additional information about the failed operation.\nThe property is returned only for failed operations.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] }, "_primary_term": { "description": "The primary term assigned to the document for the operation.\nThis property is returned only for successful operations.", @@ -41547,19 +47148,38 @@ "type": "string" }, "_seq_no": { - "$ref": "#/components/schemas/_types.SequenceNumber" + "description": "The sequence number assigned to the document for the operation.\nSequence numbers are used to ensure an older version of a document doesn't overwrite a newer version.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SequenceNumber" + } + ] }, "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "description": "Shard information for the operation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] }, "_version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "The document version associated with the operation.\nThe document version is incremented each time the document is updated.\nThis property is returned only for successful actions.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "forced_refresh": { "type": "boolean" }, "get": { - "$ref": "#/components/schemas/_types.InlineGetDictUserDefined" + "allOf": [ + { + "$ref": "#/components/schemas/_types.InlineGetDictUserDefined" + } + ] } }, "required": [ @@ -41589,13 +47209,21 @@ "type": "boolean" }, "_seq_no": { - "$ref": "#/components/schemas/_types.SequenceNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SequenceNumber" + } + ] }, "_primary_term": { "type": "number" }, "_routing": { - "$ref": "#/components/schemas/_types.Routing" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "_source": { "type": "object", @@ -41671,7 +47299,12 @@ "type": "string" }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "index alias points to", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "filter": { "description": "filter", @@ -41813,10 +47446,20 @@ "type": "object", "properties": { "epoch": { - "$ref": "#/components/schemas/_spec_utils.StringifiedEpochTimeUnitSeconds" + "description": "seconds since 1970-01-01 00:00:00", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.StringifiedEpochTimeUnitSeconds" + } + ] }, "timestamp": { - "$ref": "#/components/schemas/_types.TimeOfDay" + "description": "time in HH:MM:SS", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TimeOfDay" + } + ] }, "count": { "description": "the document count", @@ -42562,7 +48205,12 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The identifier for the job.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "type": { "description": "The type of analysis that the job performs.", @@ -42573,13 +48221,28 @@ "type": "string" }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "The version of Elasticsearch when the job was created.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "source_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The name of the source index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "dest_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The name of the destination index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "description": { "description": "A description of the job.", @@ -42606,13 +48269,28 @@ "type": "string" }, "node.id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The unique identifier of the assigned node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "node.name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The name of the assigned node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "node.ephemeral_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The ephemeral identifier of the assigned node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "node.address": { "description": "The network address of the assigned node.", @@ -42681,7 +48359,12 @@ "type": "string" }, "state": { - "$ref": "#/components/schemas/ml._types.DatafeedState" + "description": "The status of the datafeed.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DatafeedState" + } + ] }, "assignment_explanation": { "description": "For started datafeeds only, contains messages relating to the selection of a node.", @@ -42931,10 +48614,20 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The anomaly detection job identifier.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "state": { - "$ref": "#/components/schemas/ml._types.JobState" + "description": "The status of the anomaly detection job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobState" + } + ] }, "opened_time": { "description": "For open jobs only, the amount of time the job has been opened.", @@ -42953,7 +48646,12 @@ "type": "string" }, "data.input_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The number of bytes of input data posted to the anomaly detection job.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "data.input_records": { "description": "The number of input documents posted to the anomaly detection job.", @@ -43008,13 +48706,28 @@ "type": "string" }, "model.bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The number of bytes of memory used by the models.\nThis is the maximum value since the last time the model was persisted.\nIf the job is closed, this value indicates the latest size.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "model.memory_status": { - "$ref": "#/components/schemas/ml._types.MemoryStatus" + "description": "The status of the mathematical models.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.MemoryStatus" + } + ] }, "model.bytes_exceeded": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The number of bytes over the high limit for memory usage at the last allocation failure.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "model.memory_limit": { "description": "The upper limit for model memory usage, checked on increasing values.", @@ -43037,7 +48750,12 @@ "type": "string" }, "model.categorization_status": { - "$ref": "#/components/schemas/ml._types.CategorizationStatus" + "description": "The status of categorization for the job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.CategorizationStatus" + } + ] }, "model.categorized_doc_count": { "description": "The number of documents that have had a field categorized.", @@ -43124,14 +48842,24 @@ "type": "string" }, "node.id": { - "$ref": "#/components/schemas/_types.NodeId" + "description": "The uniqe identifier of the assigned node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] }, "node.name": { "description": "The name of the assigned node.", "type": "string" }, "node.ephemeral_id": { - "$ref": "#/components/schemas/_types.NodeId" + "description": "The ephemeral identifier of the assigned node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] }, "node.address": { "description": "The network address of the assigned node.", @@ -43257,14 +48985,24 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The model identifier.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "created_by": { "description": "Information about the creator of the model.", "type": "string" }, "heap_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The estimated heap size to keep the model in memory.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "operations": { "description": "The estimated number of operations to use the model.\nThis number helps to measure the computational complexity of the model.", @@ -43275,10 +49013,20 @@ "type": "string" }, "create_time": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The time the model was created.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "The version of Elasticsearch when the model was created.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "description": { "description": "A description of the model.", @@ -43419,7 +49167,12 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The transform identifier.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "state": { "description": "The status of the transform.\nReturned values include:\n`aborting`: The transform is aborting.\n`failed: The transform failed. For more information about the failure, check the `reason` field.\n`indexing`: The transform is actively processing data and creating new documents.\n`started`: The transform is running but not actively indexing data.\n`stopped`: The transform is stopped.\n`stopping`: The transform is stopping.", @@ -43474,7 +49227,12 @@ "type": "string" }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "The version of Elasticsearch that existed on the node when the transform was created.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "source_index": { "description": "The source indices for the transform.", @@ -43591,10 +49349,18 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "component_template": { - "$ref": "#/components/schemas/cluster._types.ComponentTemplateNode" + "allOf": [ + { + "$ref": "#/components/schemas/cluster._types.ComponentTemplateNode" + } + ] } }, "required": [ @@ -43606,13 +49372,25 @@ "type": "object", "properties": { "template": { - "$ref": "#/components/schemas/cluster._types.ComponentTemplateSummary" + "allOf": [ + { + "$ref": "#/components/schemas/cluster._types.ComponentTemplateSummary" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "deprecated": { "type": "boolean" @@ -43626,10 +49404,18 @@ "type": "object", "properties": { "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "settings": { "type": "object", @@ -43638,7 +49424,11 @@ } }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "aliases": { "type": "object", @@ -43647,7 +49437,12 @@ } }, "lifecycle": { - "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover" + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover" + } + ] }, "data_stream_options": { "x-state": "Generally available", @@ -43667,7 +49462,11 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] }, "mode": { "type": "string" @@ -43686,23 +49485,41 @@ ] }, "soft_deletes": { - "$ref": "#/components/schemas/indices._types.SoftDeletes" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.SoftDeletes" + } + ] }, "sort": { - "$ref": "#/components/schemas/indices._types.IndexSegmentSort" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSegmentSort" + } + ] }, "number_of_routing_shards": { "type": "number" }, "check_on_startup": { - "$ref": "#/components/schemas/indices._types.IndexCheckOnStartup" + "default": "false", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexCheckOnStartup" + } + ] }, "codec": { "default": "LZ4", "type": "string" }, "routing_partition_size": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + "default": "1", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + } + ] }, "load_fixed_bitset_filters_eagerly": { "default": true, @@ -43731,13 +49548,26 @@ ] }, "merge": { - "$ref": "#/components/schemas/indices._types.Merge" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.Merge" + } + ] }, "search": { - "$ref": "#/components/schemas/indices._types.SettingsSearch" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.SettingsSearch" + } + ] }, "refresh_interval": { - "$ref": "#/components/schemas/_types.Duration" + "default": "1s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "max_result_window": { "default": 10000.0, @@ -43768,16 +49598,32 @@ "type": "number" }, "blocks": { - "$ref": "#/components/schemas/indices._types.IndexSettingBlocks" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettingBlocks" + } + ] }, "max_refresh_listeners": { "type": "number" }, "analyze": { - "$ref": "#/components/schemas/indices._types.SettingsAnalyze" + "externalDocs": { + "url": "https://www.elastic.co/docs/manage-data/data-store/text-analysis/specify-an-analyzer#update-analyzers-on-existing-indices" + }, + "description": "Settings to define analyzers, tokenizers, token filters and character filters.\nRefer to the linked documentation for step-by-step examples of updating analyzers on existing indices.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.SettingsAnalyze" + } + ] }, "highlight": { - "$ref": "#/components/schemas/indices._types.SettingsHighlight" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.SettingsHighlight" + } + ] }, "max_terms_count": { "default": 65536.0, @@ -43788,34 +49634,77 @@ "type": "number" }, "routing": { - "$ref": "#/components/schemas/indices._types.IndexRouting" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexRouting" + } + ] }, "gc_deletes": { - "$ref": "#/components/schemas/_types.Duration" + "default": "60s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "default_pipeline": { - "$ref": "#/components/schemas/_types.PipelineName" + "default": "_none", + "allOf": [ + { + "$ref": "#/components/schemas/_types.PipelineName" + } + ] }, "final_pipeline": { - "$ref": "#/components/schemas/_types.PipelineName" + "default": "_none", + "allOf": [ + { + "$ref": "#/components/schemas/_types.PipelineName" + } + ] }, "lifecycle": { - "$ref": "#/components/schemas/indices._types.IndexSettingsLifecycle" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettingsLifecycle" + } + ] }, "provided_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "creation_date": { - "$ref": "#/components/schemas/_spec_utils.StringifiedEpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.StringifiedEpochTimeUnitMillis" + } + ] }, "creation_date_string": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "uuid": { - "$ref": "#/components/schemas/_types.Uuid" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Uuid" + } + ] }, "version": { - "$ref": "#/components/schemas/indices._types.IndexVersioning" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexVersioning" + } + ] }, "verified_before_close": { "oneOf": [ @@ -43841,10 +49730,18 @@ "type": "number" }, "translog": { - "$ref": "#/components/schemas/indices._types.Translog" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.Translog" + } + ] }, "query_string": { - "$ref": "#/components/schemas/indices._types.SettingsQueryString" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.SettingsQueryString" + } + ] }, "priority": { "oneOf": [ @@ -43860,16 +49757,32 @@ "type": "number" }, "analysis": { - "$ref": "#/components/schemas/indices._types.IndexSettingsAnalysis" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettingsAnalysis" + } + ] }, "settings": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] }, "time_series": { - "$ref": "#/components/schemas/indices._types.IndexSettingsTimeSeries" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettingsTimeSeries" + } + ] }, "queries": { - "$ref": "#/components/schemas/indices._types.Queries" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.Queries" + } + ] }, "similarity": { "description": "Configure custom similarity settings to customize how search results are scored.", @@ -43879,16 +49792,35 @@ } }, "mapping": { - "$ref": "#/components/schemas/indices._types.MappingLimitSettings" + "description": "Enable or disable dynamic mapping for an index.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.MappingLimitSettings" + } + ] }, "indexing.slowlog": { - "$ref": "#/components/schemas/indices._types.IndexingSlowlogSettings" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexingSlowlogSettings" + } + ] }, "indexing_pressure": { - "$ref": "#/components/schemas/indices._types.IndexingPressure" + "description": "Configure indexing back pressure limits.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexingPressure" + } + ] }, "store": { - "$ref": "#/components/schemas/indices._types.Storage" + "description": "The store module allows you to control how index data is stored and accessed on disk.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.Storage" + } + ] } } }, @@ -43901,7 +49833,12 @@ "type": "boolean" }, "retention_lease": { - "$ref": "#/components/schemas/indices._types.RetentionLease" + "description": "The maximum period to retain a shard history retention lease before it is considered expired.\nShard history retention leases ensure that soft deletes are retained during merges on the Lucene\nindex. If a soft delete is merged away before it can be replicated to a follower the following\nprocess will fail due to incomplete history on the leader.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.RetentionLease" + } + ] } } }, @@ -43909,7 +49846,11 @@ "type": "object", "properties": { "period": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } }, "required": [ @@ -43920,7 +49861,11 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Fields" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "order": { "oneOf": [ @@ -44016,7 +49961,11 @@ "type": "object", "properties": { "scheduler": { - "$ref": "#/components/schemas/indices._types.MergeScheduler" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.MergeScheduler" + } + ] } } }, @@ -44024,10 +49973,18 @@ "type": "object", "properties": { "max_thread_count": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + } + ] }, "max_merge_count": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + } + ] } } }, @@ -44035,10 +49992,18 @@ "type": "object", "properties": { "idle": { - "$ref": "#/components/schemas/indices._types.SearchIdle" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.SearchIdle" + } + ] }, "slowlog": { - "$ref": "#/components/schemas/indices._types.SlowlogSettings" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.SlowlogSettings" + } + ] } } }, @@ -44046,7 +50011,12 @@ "type": "object", "properties": { "after": { - "$ref": "#/components/schemas/_types.Duration" + "default": "30s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } } }, @@ -44063,7 +50033,11 @@ "type": "boolean" }, "threshold": { - "$ref": "#/components/schemas/indices._types.SlowlogTresholds" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.SlowlogTresholds" + } + ] } } }, @@ -44071,10 +50045,18 @@ "type": "object", "properties": { "query": { - "$ref": "#/components/schemas/indices._types.SlowlogTresholdLevels" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.SlowlogTresholdLevels" + } + ] }, "fetch": { - "$ref": "#/components/schemas/indices._types.SlowlogTresholdLevels" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.SlowlogTresholdLevels" + } + ] } } }, @@ -44082,16 +50064,32 @@ "type": "object", "properties": { "warn": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "info": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "debug": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "trace": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } } }, @@ -44099,19 +50097,39 @@ "type": "object", "properties": { "read_only": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] }, "read_only_allow_delete": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] }, "read": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] }, "write": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] }, "metadata": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] } } }, @@ -44130,7 +50148,12 @@ "type": "object", "properties": { "max_token_count": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + "default": "10000", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + } + ] } } }, @@ -44147,10 +50170,18 @@ "type": "object", "properties": { "allocation": { - "$ref": "#/components/schemas/indices._types.IndexRoutingAllocation" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexRoutingAllocation" + } + ] }, "rebalance": { - "$ref": "#/components/schemas/indices._types.IndexRoutingRebalance" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexRoutingRebalance" + } + ] } } }, @@ -44158,16 +50189,32 @@ "type": "object", "properties": { "enable": { - "$ref": "#/components/schemas/indices._types.IndexRoutingAllocationOptions" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexRoutingAllocationOptions" + } + ] }, "include": { - "$ref": "#/components/schemas/indices._types.IndexRoutingAllocationInclude" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexRoutingAllocationInclude" + } + ] }, "initial_recovery": { - "$ref": "#/components/schemas/indices._types.IndexRoutingAllocationInitialRecovery" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexRoutingAllocationInitialRecovery" + } + ] }, "disk": { - "$ref": "#/components/schemas/indices._types.IndexRoutingAllocationDisk" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexRoutingAllocationDisk" + } + ] } } }, @@ -44187,7 +50234,11 @@ "type": "string" }, "_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] } } }, @@ -44195,7 +50246,11 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] } } }, @@ -44218,7 +50273,11 @@ "type": "object", "properties": { "enable": { - "$ref": "#/components/schemas/indices._types.IndexRoutingRebalanceOptions" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexRoutingRebalanceOptions" + } + ] } }, "required": [ @@ -44241,10 +50300,21 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The name of the policy to use to manage the index. For information about how Elasticsearch applies policy changes, see Policy updates.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "indexing_complete": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "description": "Indicates whether or not the index has been rolled over. Automatically set to true when ILM completes the rollover action.\nYou can explicitly set it to skip rollover.", + "default": "false", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] }, "origination_date": { "description": "If specified, this is the timestamp used to calculate the index age for its phase transitions. Use this setting\nif you create a new index that contains old data and want to use the original creation date to calculate the index\nage. Specified as a Unix epoch value in milliseconds.", @@ -44256,7 +50326,11 @@ "type": "boolean" }, "step": { - "$ref": "#/components/schemas/indices._types.IndexSettingsLifecycleStep" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettingsLifecycleStep" + } + ] }, "rollover_alias": { "description": "The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action.\nWhen the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more\ninformation about rolling indices, see Rollover.", @@ -44281,7 +50355,12 @@ "type": "object", "properties": { "wait_time_threshold": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Time to wait for the cluster to resolve allocation issues during an ILM shrink action. Must be greater than 1h (1 hour).\nSee Shard allocation for shrink.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } } }, @@ -44303,7 +50382,11 @@ "type": "object", "properties": { "created": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "created_string": { "type": "string" @@ -44314,16 +50397,38 @@ "type": "object", "properties": { "sync_interval": { - "$ref": "#/components/schemas/_types.Duration" + "description": "How often the translog is fsynced to disk and committed, regardless of write operations.\nValues less than 100ms are not allowed.", + "default": "5s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "durability": { - "$ref": "#/components/schemas/indices._types.TranslogDurability" + "description": "Whether or not to `fsync` and commit the translog after every index, delete, update, or bulk request.", + "default": "string", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.TranslogDurability" + } + ] }, "flush_threshold_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The translog stores all operations that are not yet safely persisted in Lucene (i.e., are not\npart of a Lucene commit point). Although these operations are available for reads, they will need\nto be replayed if the shard was stopped and had to be recovered. This setting controls the\nmaximum total size of these operations, to prevent recoveries from taking too long. Once the\nmaximum size has been reached a flush will happen, generating a new Lucene commit point.", + "default": "512mb", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "retention": { - "$ref": "#/components/schemas/indices._types.TranslogRetention" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.TranslogRetention" + } + ] } } }, @@ -44340,10 +50445,22 @@ "type": "object", "properties": { "size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "This controls the total size of translog files to keep for each shard. Keeping more translog files increases\nthe chance of performing an operation based sync when recovering a replica. If the translog files are not\nsufficient, replica recovery will fall back to a file based sync. This setting is ignored, and should not be\nset, if soft deletes are enabled. Soft deletes are enabled by default in indices created in Elasticsearch\nversions 7.0.0 and later.", + "default": "512mb", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "age": { - "$ref": "#/components/schemas/_types.Duration" + "description": "This controls the maximum duration for which translog files are kept by each shard. Keeping more\ntranslog files increases the chance of performing an operation based sync when recovering replicas. If\nthe translog files are not sufficient, replica recovery will fall back to a file based sync. This setting\nis ignored, and should not be set, if soft deletes are enabled. Soft deletes are enabled by default in\nindices created in Elasticsearch versions 7.0.0 and later.", + "default": "12h", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } } }, @@ -44351,7 +50468,11 @@ "type": "object", "properties": { "lenient": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] } }, "required": [ @@ -44607,7 +50728,12 @@ ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "max_output_size": { "description": "The maximum token size to emit. Tokens larger than this size will be discarded.\nDefaults to `255`", @@ -44619,7 +50745,13 @@ "type": "string" }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.", + "default": "_none_", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "description": "The path to a file containing stop words.", @@ -44640,7 +50772,12 @@ ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] } }, "required": [ @@ -44657,10 +50794,19 @@ ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "decompound_mode": { - "$ref": "#/components/schemas/_types.analysis.NoriDecompoundMode" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.NoriDecompoundMode" + } + ] }, "stoptags": { "type": "array", @@ -44694,7 +50840,12 @@ ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "flags": { "description": "Java regular expression flags. Flags should be pipe-separated, eg \"CASE_INSENSITIVE|COMMENTS\".", @@ -44711,7 +50862,13 @@ "type": "string" }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.", + "default": "_none_", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "description": "The path to a file containing stop words.", @@ -44732,7 +50889,12 @@ ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] } }, "required": [ @@ -44754,7 +50916,13 @@ "type": "number" }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.", + "default": "_none_", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "description": "The path to a file containing stop words.", @@ -44775,10 +50943,21 @@ ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.", + "default": "_none_", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "description": "The path to a file containing stop words.", @@ -44799,7 +50978,12 @@ ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] } }, "required": [ @@ -44816,10 +51000,18 @@ ] }, "method": { - "$ref": "#/components/schemas/_types.analysis.IcuNormalizationType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuNormalizationType" + } + ] }, "mode": { - "$ref": "#/components/schemas/_types.analysis.IcuNormalizationMode" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuNormalizationMode" + } + ] } }, "required": [ @@ -44853,7 +51045,11 @@ ] }, "mode": { - "$ref": "#/components/schemas/_types.analysis.KuromojiTokenizationMode" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.KuromojiTokenizationMode" + } + ] }, "user_dictionary": { "type": "string" @@ -44882,13 +51078,26 @@ ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "language": { - "$ref": "#/components/schemas/_types.analysis.SnowballLanguage" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.SnowballLanguage" + } + ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] } }, "required": [ @@ -44938,7 +51147,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -44964,7 +51177,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -44990,7 +51207,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45016,7 +51237,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45042,7 +51267,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45062,7 +51291,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45088,7 +51321,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45114,7 +51351,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45134,7 +51375,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45154,7 +51399,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45180,7 +51429,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45200,7 +51453,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45226,7 +51483,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45252,7 +51513,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45272,7 +51537,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45298,7 +51567,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45324,7 +51597,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45350,7 +51627,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45376,7 +51657,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45396,7 +51681,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45422,7 +51711,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45448,7 +51741,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45474,7 +51771,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45500,7 +51801,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45526,7 +51831,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45552,7 +51861,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45578,7 +51891,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45604,7 +51921,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45624,7 +51945,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45650,7 +51975,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45676,7 +52005,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45702,7 +52035,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45728,7 +52065,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45754,7 +52095,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45780,7 +52125,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45806,7 +52155,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45832,7 +52185,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "type": "string" @@ -45908,7 +52265,11 @@ "type": "object", "properties": { "version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] } } }, @@ -45988,10 +52349,18 @@ ] }, "mode": { - "$ref": "#/components/schemas/_types.analysis.IcuNormalizationMode" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuNormalizationMode" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.analysis.IcuNormalizationType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuNormalizationType" + } + ] }, "unicode_set_filter": { "type": "string" @@ -46299,7 +52668,11 @@ "type": "object", "properties": { "version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] } } }, @@ -46360,7 +52733,12 @@ ] }, "preserve_original": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "description": "If `true`, emit both original tokens and folded tokens. Defaults to `false`.", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] } }, "required": [ @@ -46556,7 +52934,12 @@ } }, "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "Predicate script used to apply token filters. If a token matches this script, the filters in the `filter` parameter are applied to the token.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } }, "required": [ @@ -46628,7 +53011,12 @@ "type": "string" }, "encoding": { - "$ref": "#/components/schemas/_types.analysis.DelimitedPayloadEncoding" + "description": "Data type for the stored payload.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.DelimitedPayloadEncoding" + } + ] } }, "required": [ @@ -46689,10 +53077,20 @@ "type": "number" }, "side": { - "$ref": "#/components/schemas/_types.analysis.EdgeNGramSide" + "description": "Indicates whether to truncate tokens from the `front` or `back`. Defaults to `front`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.EdgeNGramSide" + } + ] }, "preserve_original": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "description": "Emits original token when set to `true`. Defaults to `false`.", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] } }, "required": [ @@ -46734,7 +53132,12 @@ "type": "string" }, "articles_case": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "description": "If `true`, elision matching is case insensitive. If `false`, elision matching is case sensitive. Defaults to `false`.", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] } }, "required": [ @@ -47024,7 +53427,12 @@ ] }, "mode": { - "$ref": "#/components/schemas/_types.analysis.KeepTypesMode" + "description": "Indicates whether to keep or remove the specified token types.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.KeepTypesMode" + } + ] }, "types": { "description": "List of token types to keep or remove.", @@ -47221,7 +53629,12 @@ "type": "boolean" }, "max_token_count": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + "description": "Maximum number of tokens to keep. Once this limit is reached, any remaining tokens are excluded from the output. Defaults to `1`.", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + } + ] } }, "required": [ @@ -47245,7 +53658,12 @@ ] }, "language": { - "$ref": "#/components/schemas/_types.analysis.LowercaseTokenFilterLanguages" + "description": "Language-specific lowercase token filter to use.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.LowercaseTokenFilterLanguages" + } + ] } }, "required": [ @@ -47321,7 +53739,12 @@ } }, "preserve_original": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "description": "If `true` (the default) then emit the original token in addition to the filtered tokens.", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] } }, "required": [ @@ -47354,7 +53777,12 @@ "type": "number" }, "preserve_original": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "description": "Emits original token when set to `true`. Defaults to `false`.", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] } }, "required": [ @@ -47413,7 +53841,12 @@ } }, "preserve_original": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "description": "If set to `true` (the default) it will emit the original token.", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] } }, "required": [ @@ -47538,7 +53971,12 @@ ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "Script containing a condition used to filter incoming tokens. Only tokens that match this script are included in the output.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } }, "required": [ @@ -47693,10 +54131,20 @@ "type": "string" }, "max_shingle_size": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + "description": "Maximum number of tokens to concatenate when creating shingles. Defaults to `2`.", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + } + ] }, "min_shingle_size": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + "description": "Minimum number of tokens to concatenate when creating shingles. Defaults to `2`.", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + } + ] }, "output_unigrams": { "description": "If `true`, the output includes the original input tokens. If `false`, the output only includes shingles; the original input tokens are removed. Defaults to `true`.", @@ -47732,7 +54180,12 @@ ] }, "language": { - "$ref": "#/components/schemas/_types.analysis.SnowballLanguage" + "description": "Controls the language used by the stemmer.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.SnowballLanguage" + } + ] } }, "required": [ @@ -47841,7 +54294,12 @@ "type": "boolean" }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "description": "Language value, such as `_arabic_` or `_thai_`. Defaults to `_english_`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] }, "stopwords_path": { "description": "Path to a file that contains a list of stop words to remove.\nThis path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each stop word in the file must be separated by a line break.", @@ -47888,7 +54346,12 @@ "type": "boolean" }, "format": { - "$ref": "#/components/schemas/_types.analysis.SynonymFormat" + "description": "Sets the synonym rules format.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.SynonymFormat" + } + ] }, "lenient": { "description": "If `true` ignores errors while parsing the synonym rules. It is important to note that only those synonym rules which cannot get parsed are ignored. Defaults to the value of the `updateable` setting.", @@ -48100,7 +54563,12 @@ "type": "boolean" }, "preserve_original": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "description": "If `true`, the filter includes the original version of any split tokens in the output. This original version includes non-alphanumeric delimiters. Defaults to `false`.", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] }, "protected_words": { "description": "Array of tokens the filter won’t split.", @@ -48176,7 +54644,11 @@ ] }, "stopwords": { - "$ref": "#/components/schemas/_types.analysis.StopWords" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.StopWords" + } + ] } }, "required": [ @@ -48278,10 +54750,18 @@ ] }, "alternate": { - "$ref": "#/components/schemas/_types.analysis.IcuCollationAlternate" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuCollationAlternate" + } + ] }, "caseFirst": { - "$ref": "#/components/schemas/_types.analysis.IcuCollationCaseFirst" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuCollationCaseFirst" + } + ] }, "caseLevel": { "type": "boolean" @@ -48290,7 +54770,11 @@ "type": "string" }, "decomposition": { - "$ref": "#/components/schemas/_types.analysis.IcuCollationDecomposition" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuCollationDecomposition" + } + ] }, "hiraganaQuaternaryMode": { "type": "boolean" @@ -48305,7 +54789,11 @@ "type": "string" }, "strength": { - "$ref": "#/components/schemas/_types.analysis.IcuCollationStrength" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuCollationStrength" + } + ] }, "variableTop": { "type": "string" @@ -48391,7 +54879,11 @@ ] }, "name": { - "$ref": "#/components/schemas/_types.analysis.IcuNormalizationType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuNormalizationType" + } + ] } }, "required": [ @@ -48416,7 +54908,11 @@ ] }, "dir": { - "$ref": "#/components/schemas/_types.analysis.IcuTransformDirection" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuTransformDirection" + } + ] }, "id": { "type": "string" @@ -48451,7 +54947,11 @@ ] }, "encoder": { - "$ref": "#/components/schemas/_types.analysis.PhoneticEncoder" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.PhoneticEncoder" + } + ] }, "languageset": { "oneOf": [ @@ -48470,13 +54970,21 @@ "type": "number" }, "name_type": { - "$ref": "#/components/schemas/_types.analysis.PhoneticNameType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.PhoneticNameType" + } + ] }, "replace": { "type": "boolean" }, "rule_type": { - "$ref": "#/components/schemas/_types.analysis.PhoneticRuleType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.PhoneticRuleType" + } + ] } }, "required": [ @@ -48718,7 +55226,11 @@ "type": "object", "properties": { "version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] } } }, @@ -48913,7 +55425,11 @@ ] }, "buffer_size": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + } + ] }, "delimiter": { "type": "string" @@ -48922,10 +55438,18 @@ "type": "string" }, "reverse": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean" + } + ] }, "skip": { - "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger" + } + ] } }, "required": [ @@ -49148,7 +55672,11 @@ "type": "boolean" }, "mode": { - "$ref": "#/components/schemas/_types.analysis.KuromojiTokenizationMode" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.KuromojiTokenizationMode" + } + ] }, "nbest_cost": { "type": "number" @@ -49191,7 +55719,11 @@ ] }, "decompound_mode": { - "$ref": "#/components/schemas/_types.analysis.NoriDecompoundMode" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.NoriDecompoundMode" + } + ] }, "discard_punctuation": { "type": "boolean" @@ -49216,10 +55748,18 @@ "type": "object", "properties": { "end_time": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "start_time": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] } } }, @@ -49227,7 +55767,11 @@ "type": "object", "properties": { "cache": { - "$ref": "#/components/schemas/indices._types.CacheQueries" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.CacheQueries" + } + ] } } }, @@ -49320,7 +55864,11 @@ ] }, "independence_measure": { - "$ref": "#/components/schemas/_types.DFIIndependenceMeasure" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DFIIndependenceMeasure" + } + ] } }, "required": [ @@ -49346,13 +55894,25 @@ ] }, "after_effect": { - "$ref": "#/components/schemas/_types.DFRAfterEffect" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DFRAfterEffect" + } + ] }, "basic_model": { - "$ref": "#/components/schemas/_types.DFRBasicModel" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DFRBasicModel" + } + ] }, "normalization": { - "$ref": "#/components/schemas/_types.Normalization" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Normalization" + } + ] } }, "required": [ @@ -49402,13 +55962,25 @@ ] }, "distribution": { - "$ref": "#/components/schemas/_types.IBDistribution" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IBDistribution" + } + ] }, "lambda": { - "$ref": "#/components/schemas/_types.IBLambda" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IBLambda" + } + ] }, "normalization": { - "$ref": "#/components/schemas/_types.Normalization" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Normalization" + } + ] } }, "required": [ @@ -49476,10 +56048,18 @@ ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "weight_script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } }, "required": [ @@ -49495,25 +56075,53 @@ "type": "boolean" }, "total_fields": { - "$ref": "#/components/schemas/indices._types.MappingLimitSettingsTotalFields" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.MappingLimitSettingsTotalFields" + } + ] }, "depth": { - "$ref": "#/components/schemas/indices._types.MappingLimitSettingsDepth" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.MappingLimitSettingsDepth" + } + ] }, "nested_fields": { - "$ref": "#/components/schemas/indices._types.MappingLimitSettingsNestedFields" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.MappingLimitSettingsNestedFields" + } + ] }, "nested_objects": { - "$ref": "#/components/schemas/indices._types.MappingLimitSettingsNestedObjects" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.MappingLimitSettingsNestedObjects" + } + ] }, "field_name_length": { - "$ref": "#/components/schemas/indices._types.MappingLimitSettingsFieldNameLength" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.MappingLimitSettingsFieldNameLength" + } + ] }, "dimension_fields": { - "$ref": "#/components/schemas/indices._types.MappingLimitSettingsDimensionFields" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.MappingLimitSettingsDimensionFields" + } + ] }, "source": { - "$ref": "#/components/schemas/indices._types.MappingLimitSettingsSourceFields" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.MappingLimitSettingsSourceFields" + } + ] }, "ignore_malformed": { "oneOf": [ @@ -49608,7 +56216,11 @@ "type": "object", "properties": { "mode": { - "$ref": "#/components/schemas/indices._types.SourceMode" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.SourceMode" + } + ] } }, "required": [ @@ -49636,7 +56248,11 @@ "type": "boolean" }, "threshold": { - "$ref": "#/components/schemas/indices._types.IndexingSlowlogTresholds" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexingSlowlogTresholds" + } + ] } } }, @@ -49644,7 +56260,12 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/indices._types.SlowlogTresholdLevels" + "description": "The indexing slow log, similar in functionality to the search slow log. The log file name ends with `_index_indexing_slowlog.json`.\nLog and the thresholds are configured in the same way as the search slowlog.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.SlowlogTresholdLevels" + } + ] } } }, @@ -49652,7 +56273,11 @@ "type": "object", "properties": { "memory": { - "$ref": "#/components/schemas/indices._types.IndexingPressureMemory" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexingPressureMemory" + } + ] } }, "required": [ @@ -49672,14 +56297,23 @@ "type": "object", "properties": { "type": { - "$ref": "#/components/schemas/indices._types.StorageType" + "allOf": [ + { + "$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" }, "stats_refresh_interval": { - "$ref": "#/components/schemas/_types.Duration" + "description": "How often store statistics are refreshed", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } }, "required": [ @@ -49706,13 +56340,21 @@ "type": "object", "properties": { "all_field": { - "$ref": "#/components/schemas/_types.mapping.AllField" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.AllField" + } + ] }, "date_detection": { "type": "boolean" }, "dynamic": { - "$ref": "#/components/schemas/_types.mapping.DynamicMapping" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.DynamicMapping" + } + ] }, "dynamic_date_formats": { "type": "array", @@ -49732,13 +56374,25 @@ } }, "_field_names": { - "$ref": "#/components/schemas/_types.mapping.FieldNamesField" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.FieldNamesField" + } + ] }, "index_field": { - "$ref": "#/components/schemas/_types.mapping.IndexField" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.IndexField" + } + ] }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "numeric_detection": { "type": "boolean" @@ -49750,13 +56404,25 @@ } }, "_routing": { - "$ref": "#/components/schemas/_types.mapping.RoutingField" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RoutingField" + } + ] }, "_size": { - "$ref": "#/components/schemas/_types.mapping.SizeField" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.SizeField" + } + ] }, "_source": { - "$ref": "#/components/schemas/_types.mapping.SourceField" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.SourceField" + } + ] }, "runtime": { "type": "object", @@ -49768,10 +56434,19 @@ "type": "boolean" }, "subobjects": { - "$ref": "#/components/schemas/_types.mapping.Subobjects" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.Subobjects" + } + ] }, "_data_stream_timestamp": { - "$ref": "#/components/schemas/_types.mapping.DataStreamTimestamp" + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.DataStreamTimestamp" + } + ] } } }, @@ -49915,7 +56590,11 @@ ] }, "match_pattern": { - "$ref": "#/components/schemas/_types.mapping.MatchType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.MatchType" + } + ] } } }, @@ -49923,10 +56602,18 @@ "type": "object", "properties": { "mapping": { - "$ref": "#/components/schemas/_types.mapping.Property" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.Property" + } + ] }, "runtime": { - "$ref": "#/components/schemas/_types.mapping.RuntimeField" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeField" + } + ] } }, "minProperties": 1, @@ -50142,7 +56829,11 @@ "type": "object", "properties": { "copy_to": { - "$ref": "#/components/schemas/_types.Fields" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "store": { "type": "boolean" @@ -50171,7 +56862,11 @@ "type": "number" }, "dynamic": { - "$ref": "#/components/schemas/_types.mapping.DynamicMapping" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.DynamicMapping" + } + ] }, "fields": { "type": "object", @@ -50180,7 +56875,11 @@ } }, "synthetic_source_keep": { - "$ref": "#/components/schemas/_types.mapping.SyntheticSourceKeepEnum" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.SyntheticSourceKeepEnum" + } + ] } } }, @@ -50204,7 +56903,11 @@ "type": "number" }, "fielddata": { - "$ref": "#/components/schemas/indices._types.NumericFielddata" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.NumericFielddata" + } + ] }, "index": { "type": "boolean" @@ -50216,10 +56919,18 @@ "type": "boolean" }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "on_script_error": { - "$ref": "#/components/schemas/_types.mapping.OnScriptError" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.OnScriptError" + } + ] }, "time_series_dimension": { "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.", @@ -50243,7 +56954,11 @@ "type": "object", "properties": { "format": { - "$ref": "#/components/schemas/indices._types.NumericFielddataFormat" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.NumericFielddataFormat" + } + ] } }, "required": [ @@ -50282,7 +56997,11 @@ "type": "boolean" }, "null_value": { - "$ref": "#/components/schemas/_types.FieldValue" + "allOf": [ + { + "$ref": "#/components/schemas/_types.FieldValue" + } + ] }, "boost": { "type": "number" @@ -50291,16 +57010,28 @@ "type": "boolean" }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "on_script_error": { - "$ref": "#/components/schemas/_types.mapping.OnScriptError" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.OnScriptError" + } + ] }, "ignore_malformed": { "type": "boolean" }, "time_series_metric": { - "$ref": "#/components/schemas/_types.mapping.TimeSeriesMetricType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TimeSeriesMetricType" + } + ] }, "analyzer": { "type": "string" @@ -50312,7 +57043,11 @@ "type": "boolean" }, "index_options": { - "$ref": "#/components/schemas/_types.mapping.IndexOptions" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.IndexOptions" + } + ] }, "index_phrases": { "type": "boolean" @@ -50341,7 +57076,11 @@ "type": "string" }, "term_vector": { - "$ref": "#/components/schemas/_types.mapping.TermVectorOption" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TermVectorOption" + } + ] }, "format": { "type": "string" @@ -50463,13 +57202,25 @@ "type": "boolean" }, "index_options": { - "$ref": "#/components/schemas/_types.mapping.IndexOptions" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.IndexOptions" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "on_script_error": { - "$ref": "#/components/schemas/_types.mapping.OnScriptError" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.OnScriptError" + } + ] }, "normalizer": { "type": "string" @@ -50537,7 +57288,12 @@ } }, "copy_to": { - "$ref": "#/components/schemas/_types.Fields" + "description": "Allows you to copy the values of multiple fields into a group\nfield, which can then be queried as a single field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] } }, "required": [ @@ -50628,7 +57384,11 @@ "type": "boolean" }, "index_options": { - "$ref": "#/components/schemas/_types.mapping.IndexOptions" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.IndexOptions" + } + ] }, "max_shingle_size": { "type": "number" @@ -50654,7 +57414,11 @@ ] }, "term_vector": { - "$ref": "#/components/schemas/_types.mapping.TermVectorOption" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TermVectorOption" + } + ] }, "type": { "type": "string", @@ -50690,13 +57454,21 @@ "type": "boolean" }, "fielddata_frequency_filter": { - "$ref": "#/components/schemas/indices._types.FielddataFrequencyFilter" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.FielddataFrequencyFilter" + } + ] }, "index": { "type": "boolean" }, "index_options": { - "$ref": "#/components/schemas/_types.mapping.IndexOptions" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.IndexOptions" + } + ] }, "index_phrases": { "type": "boolean" @@ -50736,7 +57508,11 @@ ] }, "term_vector": { - "$ref": "#/components/schemas/_types.mapping.TermVectorOption" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TermVectorOption" + } + ] }, "type": { "type": "string", @@ -50837,13 +57613,25 @@ "type": "boolean" }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "on_script_error": { - "$ref": "#/components/schemas/_types.mapping.OnScriptError" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.OnScriptError" + } + ] }, "null_value": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "precision_step": { "type": "number" @@ -50873,7 +57661,11 @@ "type": "number" }, "fielddata": { - "$ref": "#/components/schemas/indices._types.NumericFielddata" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.NumericFielddata" + } + ] }, "format": { "type": "string" @@ -50885,13 +57677,25 @@ "type": "boolean" }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "on_script_error": { - "$ref": "#/components/schemas/_types.mapping.OnScriptError" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.OnScriptError" + } + ] }, "null_value": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "precision_step": { "type": "number" @@ -50939,7 +57743,11 @@ } }, "time_series_metric": { - "$ref": "#/components/schemas/_types.mapping.TimeSeriesMetricType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TimeSeriesMetricType" + } + ] } }, "required": [ @@ -50969,7 +57777,13 @@ "type": "number" }, "element_type": { - "$ref": "#/components/schemas/_types.mapping.DenseVectorElementType" + "description": "The data type used to encode vectors. The supported data types are `float` (default), `byte`, and `bit`.", + "default": "float", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.DenseVectorElementType" + } + ] }, "index": { "description": "If `true`, you can search this field using the kNN search API.", @@ -50977,10 +57791,20 @@ "type": "boolean" }, "index_options": { - "$ref": "#/components/schemas/_types.mapping.DenseVectorIndexOptions" + "description": "An optional section that configures the kNN indexing algorithm. The HNSW algorithm has two internal parameters\nthat influence how the data structure is built. These can be adjusted to improve the accuracy of results, at the\nexpense of slower indexing speed.\n\nThis parameter can only be specified when `index` is `true`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.DenseVectorIndexOptions" + } + ] }, "similarity": { - "$ref": "#/components/schemas/_types.mapping.DenseVectorSimilarity" + "description": "The vector similarity metric to use in kNN search.\n\nDocuments are ranked by their vector field's similarity to the query vector. The `_score` of each document will\nbe derived from the similarity, in a way that ensures scores are positive and that a larger score corresponds\nto a higher ranking.\n\nDefaults to `l2_norm` when `element_type` is `bit` otherwise defaults to `cosine`.\n\n`bit` vectors only support `l2_norm` as their similarity metric.\n\nThis parameter can only be specified when `index` is `true`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.DenseVectorSimilarity" + } + ] } }, "required": [ @@ -51015,10 +57839,20 @@ "type": "number" }, "type": { - "$ref": "#/components/schemas/_types.mapping.DenseVectorIndexOptionsType" + "description": "The type of kNN algorithm to use.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.DenseVectorIndexOptionsType" + } + ] }, "rescore_vector": { - "$ref": "#/components/schemas/_types.mapping.DenseVectorIndexOptionsRescoreVector" + "description": "The rescore vector options. This is only applicable to `bbq_hnsw`, `int4_hnsw`, `int8_hnsw`, `bbq_flat`, `int4_flat`, and `int8_flat` index types.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.DenseVectorIndexOptionsRescoreVector" + } + ] } }, "required": [ @@ -51083,7 +57917,11 @@ "type": "boolean" }, "index_options": { - "$ref": "#/components/schemas/_types.mapping.IndexOptions" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.IndexOptions" + } + ] }, "null_value": { "type": "string" @@ -51155,7 +57993,11 @@ "type": "boolean" }, "subobjects": { - "$ref": "#/components/schemas/_types.mapping.Subobjects" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.Subobjects" + } + ] }, "type": { "type": "string", @@ -51217,7 +58059,11 @@ ] }, "element_type": { - "$ref": "#/components/schemas/_types.mapping.RankVectorElementType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RankVectorElementType" + } + ] }, "dims": { "type": "number" @@ -51253,16 +58099,37 @@ } }, "inference_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Inference endpoint that will be used to generate embeddings for the field.\nThis parameter cannot be updated. Use the Create inference API to create the endpoint.\nIf `search_inference_id` is specified, the inference endpoint will only be used at index time.", + "default": ".elser-2-elasticsearch", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "search_inference_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Inference endpoint that will be used to generate embeddings at query time.\nYou can update this parameter by using the Update mapping API. Use the Create inference API to create the endpoint.\nIf not specified, the inference endpoint defined by inference_id will be used at both index and query time.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "index_options": { - "$ref": "#/components/schemas/_types.mapping.SemanticTextIndexOptions" + "description": "Settings for index_options that override any defaults used by semantic_text, for example\nspecific quantization settings.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.SemanticTextIndexOptions" + } + ] }, "chunking_settings": { - "$ref": "#/components/schemas/_types.mapping.ChunkingSettings" + "description": "Settings for chunking text into smaller passages. If specified, these will override the\nchunking settings sent in the inference endpoint associated with inference_id. If chunking settings are updated,\nthey will not be applied to existing documents until they are reindexed.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.ChunkingSettings" + } + ] } }, "required": [ @@ -51273,7 +58140,11 @@ "type": "object", "properties": { "dense_vector": { - "$ref": "#/components/schemas/_types.mapping.DenseVectorIndexOptions" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.DenseVectorIndexOptions" + } + ] } } }, @@ -51340,7 +58211,13 @@ ] }, "index_options": { - "$ref": "#/components/schemas/_types.mapping.SparseVectorIndexOptions" + "description": "Additional index options for the sparse vector field that controls the\ntoken pruning behavior of the sparse vector field.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.SparseVectorIndexOptions" + } + ] } }, "required": [ @@ -51358,7 +58235,13 @@ "type": "boolean" }, "pruning_config": { - "$ref": "#/components/schemas/_types.TokenPruningConfig" + "description": "Optional pruning configuration.\nIf enabled, this will omit non-significant tokens from the query in order to improve query performance.\nThis is only used if prune is set to true.\nIf prune is set to true but pruning_config is not specified, default values will be used.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TokenPruningConfig" + } + ] } } }, @@ -51408,10 +58291,18 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "path": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "type": { "type": "string" @@ -51489,7 +58380,11 @@ "type": "object", "properties": { "path": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "type": { "type": "string", @@ -51549,10 +58444,18 @@ "type": "string" }, "on_script_error": { - "$ref": "#/components/schemas/_types.mapping.OnScriptError" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.OnScriptError" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "time_series_dimension": { "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.", @@ -51644,16 +58547,28 @@ "type": "boolean" }, "null_value": { - "$ref": "#/components/schemas/_types.GeoLocation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoLocation" + } + ] }, "index": { "type": "boolean" }, "on_script_error": { - "$ref": "#/components/schemas/_types.mapping.OnScriptError" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.OnScriptError" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "type": { "type": "string", @@ -51662,7 +58577,11 @@ ] }, "time_series_metric": { - "$ref": "#/components/schemas/_types.mapping.GeoPointMetricType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.GeoPointMetricType" + } + ] } }, "required": [ @@ -51701,10 +58620,18 @@ "type": "boolean" }, "orientation": { - "$ref": "#/components/schemas/_types.mapping.GeoOrientation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.GeoOrientation" + } + ] }, "strategy": { - "$ref": "#/components/schemas/_types.mapping.GeoStrategy" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.GeoStrategy" + } + ] }, "type": { "type": "string", @@ -51788,7 +58715,11 @@ "type": "boolean" }, "orientation": { - "$ref": "#/components/schemas/_types.mapping.GeoOrientation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.GeoOrientation" + } + ] }, "type": { "type": "string", @@ -51818,7 +58749,11 @@ ] }, "null_value": { - "$ref": "#/components/schemas/_types.byte" + "allOf": [ + { + "$ref": "#/components/schemas/_types.byte" + } + ] } }, "required": [ @@ -51851,13 +58786,27 @@ "type": "boolean" }, "on_script_error": { - "$ref": "#/components/schemas/_types.mapping.OnScriptError" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.OnScriptError" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "time_series_metric": { - "$ref": "#/components/schemas/_types.mapping.TimeSeriesMetricType" + "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.", + "x-state": "Technical preview", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TimeSeriesMetricType" + } + ] }, "time_series_dimension": { "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.", @@ -52031,7 +58980,11 @@ ] }, "null_value": { - "$ref": "#/components/schemas/_types.short" + "allOf": [ + { + "$ref": "#/components/schemas/_types.short" + } + ] } }, "required": [ @@ -52058,7 +59011,11 @@ ] }, "null_value": { - "$ref": "#/components/schemas/_types.ulong" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ulong" + } + ] } }, "required": [ @@ -52238,7 +59195,11 @@ "type": "boolean" }, "index_options": { - "$ref": "#/components/schemas/_types.mapping.IndexOptions" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.IndexOptions" + } + ] }, "index": { "description": "Should the field be searchable?", @@ -52261,19 +59222,35 @@ "type": "string" }, "strength": { - "$ref": "#/components/schemas/_types.analysis.IcuCollationStrength" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuCollationStrength" + } + ] }, "decomposition": { - "$ref": "#/components/schemas/_types.analysis.IcuCollationDecomposition" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuCollationDecomposition" + } + ] }, "alternate": { - "$ref": "#/components/schemas/_types.analysis.IcuCollationAlternate" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuCollationAlternate" + } + ] }, "case_level": { "type": "boolean" }, "case_first": { - "$ref": "#/components/schemas/_types.analysis.IcuCollationCaseFirst" + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.IcuCollationCaseFirst" + } + ] }, "numeric": { "type": "boolean" @@ -52367,7 +59344,11 @@ } }, "mode": { - "$ref": "#/components/schemas/_types.mapping.SourceFieldMode" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.SourceFieldMode" + } + ] } } }, @@ -52394,7 +59375,12 @@ "type": "object", "properties": { "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Query used to limit documents the alias can access.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "index_routing": { "description": "Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.", @@ -52431,7 +59417,12 @@ "type": "object", "properties": { "rollover": { - "$ref": "#/components/schemas/indices._types.DataStreamLifecycleRolloverConditions" + "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.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamLifecycleRolloverConditions" + } + ] } } } @@ -52441,7 +59432,11 @@ "type": "object", "properties": { "min_age": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "max_age": { "type": "string" @@ -52453,16 +59448,32 @@ "type": "number" }, "min_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "max_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "min_primary_shard_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "max_primary_shard_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "min_primary_shard_docs": { "type": "number" @@ -52477,10 +59488,20 @@ "type": "object", "properties": { "data_retention": { - "$ref": "#/components/schemas/_types.Duration" + "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.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "downsampling": { - "$ref": "#/components/schemas/indices._types.DataStreamLifecycleDownsampling" + "description": "The downsampling configuration to execute for the managed backing index after rollover.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamLifecycleDownsampling" + } + ] }, "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.", @@ -52508,10 +59529,20 @@ "type": "object", "properties": { "after": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The duration since rollover when this downsampling round should execute", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "config": { - "$ref": "#/components/schemas/indices._types.DownsampleConfig" + "description": "The downsample configuration to execute.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DownsampleConfig" + } + ] } }, "required": [ @@ -52523,7 +59554,12 @@ "type": "object", "properties": { "fixed_interval": { - "$ref": "#/components/schemas/_types.DurationLarge" + "description": "The interval at which to aggregate the original time series index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationLarge" + } + ] } }, "required": [ @@ -52704,7 +59740,12 @@ } }, "total": { - "$ref": "#/components/schemas/nodes._types.IngestTotal" + "description": "Contains statistics about ingest operations for the node.", + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.IngestTotal" + } + ] } } }, @@ -52734,7 +59775,12 @@ } }, "time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "ingested_as_first_pipeline_in_bytes": { "description": "Total number of bytes of all documents ingested by the pipeline.\nThis field is only present on pipelines which are the first to process a document.\nThus, it is not present on pipelines which only serve as a final pipeline after a default pipeline, a pipeline run after a reroute processor, or pipelines in pipeline processors.", @@ -52761,7 +59807,11 @@ "type": "object", "properties": { "stats": { - "$ref": "#/components/schemas/nodes._types.Processor" + "allOf": [ + { + "$ref": "#/components/schemas/nodes._types.Processor" + } + ] }, "type": { "type": "string" @@ -52784,7 +59834,12 @@ "type": "number" }, "time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "Time, in milliseconds, spent by the processor transforming documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } } }, @@ -52804,7 +59859,12 @@ "type": "number" }, "time_in_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } }, "required": [ @@ -52900,19 +59960,42 @@ } }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "settings": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] }, "defaults": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "description": "Default settings, included when the request's `include_default` is `true`.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] }, "data_stream": { - "$ref": "#/components/schemas/_types.DataStreamName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DataStreamName" + } + ] }, "lifecycle": { - "$ref": "#/components/schemas/indices._types.DataStreamLifecycle" + "description": "Data stream lifecycle applicable if this is a data stream.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamLifecycle" + } + ] } } }, @@ -52920,10 +60003,20 @@ "type": "object", "properties": { "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Query used to limit documents the alias can access.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "index_routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "is_hidden": { "description": "If `true`, the alias is hidden.\nAll indices for the alias must have the same `is_hidden` value.", @@ -52936,10 +60029,20 @@ "type": "boolean" }, "routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "Value used to route indexing and search operations to a specific shard.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "search_routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] } } }, @@ -52966,10 +60069,18 @@ "type": "string" }, "configuration": { - "$ref": "#/components/schemas/connector._types.ConnectorConfiguration" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.ConnectorConfiguration" + } + ] }, "custom_scheduling": { - "$ref": "#/components/schemas/connector._types.ConnectorCustomScheduling" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.ConnectorCustomScheduling" + } + ] }, "deleted": { "type": "boolean" @@ -52989,7 +60100,11 @@ ] }, "features": { - "$ref": "#/components/schemas/connector._types.ConnectorFeatures" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.ConnectorFeatures" + } + ] }, "filtering": { "type": "array", @@ -52998,7 +60113,11 @@ } }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "index_name": { "oneOf": [ @@ -53021,49 +60140,89 @@ "type": "string" }, "last_access_control_sync_scheduled_at": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "last_access_control_sync_status": { - "$ref": "#/components/schemas/connector._types.SyncStatus" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.SyncStatus" + } + ] }, "last_deleted_document_count": { "type": "number" }, "last_incremental_sync_scheduled_at": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "last_indexed_document_count": { "type": "number" }, "last_seen": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "last_sync_error": { "type": "string" }, "last_sync_scheduled_at": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "last_sync_status": { - "$ref": "#/components/schemas/connector._types.SyncStatus" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.SyncStatus" + } + ] }, "last_synced": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "name": { "type": "string" }, "pipeline": { - "$ref": "#/components/schemas/connector._types.IngestPipelineParams" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.IngestPipelineParams" + } + ] }, "scheduling": { - "$ref": "#/components/schemas/connector._types.SchedulingConfiguration" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.SchedulingConfiguration" + } + ] }, "service_type": { "type": "string" }, "status": { - "$ref": "#/components/schemas/connector._types.ConnectorStatus" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.ConnectorStatus" + } + ] }, "sync_cursor": { "type": "object" @@ -53096,7 +60255,11 @@ "type": "string" }, "default_value": { - "$ref": "#/components/schemas/_types.ScalarValue" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScalarValue" + } + ] }, "depends_on": { "type": "array", @@ -53105,7 +60268,11 @@ } }, "display": { - "$ref": "#/components/schemas/connector._types.DisplayType" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.DisplayType" + } + ] }, "label": { "type": "string" @@ -53140,7 +60307,11 @@ ] }, "type": { - "$ref": "#/components/schemas/connector._types.ConnectorFieldType" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.ConnectorFieldType" + } + ] }, "ui_restrictions": { "type": "array", @@ -53197,7 +60368,11 @@ "type": "string" }, "value": { - "$ref": "#/components/schemas/_types.ScalarValue" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScalarValue" + } + ] } }, "required": [ @@ -53222,7 +60397,11 @@ "type": "string" }, "value": { - "$ref": "#/components/schemas/_types.ScalarValue" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScalarValue" + } + ] } }, "required": [ @@ -53364,7 +60543,11 @@ "type": "object", "properties": { "configuration_overrides": { - "$ref": "#/components/schemas/connector._types.CustomSchedulingConfigurationOverrides" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.CustomSchedulingConfigurationOverrides" + } + ] }, "enabled": { "type": "boolean" @@ -53373,7 +60556,11 @@ "type": "string" }, "last_synced": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "name": { "type": "string" @@ -53419,16 +60606,35 @@ "type": "object", "properties": { "document_level_security": { - "$ref": "#/components/schemas/connector._types.FeatureEnabled" + "description": "Indicates whether document-level security is enabled.", + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FeatureEnabled" + } + ] }, "incremental_sync": { - "$ref": "#/components/schemas/connector._types.FeatureEnabled" + "description": "Indicates whether incremental syncs are enabled.", + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FeatureEnabled" + } + ] }, "native_connector_api_keys": { - "$ref": "#/components/schemas/connector._types.FeatureEnabled" + "description": "Indicates whether managed connector API keys are enabled.", + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FeatureEnabled" + } + ] }, "sync_rules": { - "$ref": "#/components/schemas/connector._types.SyncRulesFeature" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.SyncRulesFeature" + } + ] } } }, @@ -53447,10 +60653,20 @@ "type": "object", "properties": { "advanced": { - "$ref": "#/components/schemas/connector._types.FeatureEnabled" + "description": "Indicates whether advanced sync rules are enabled.", + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FeatureEnabled" + } + ] }, "basic": { - "$ref": "#/components/schemas/connector._types.FeatureEnabled" + "description": "Indicates whether basic sync rules are enabled.", + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FeatureEnabled" + } + ] } } }, @@ -53458,13 +60674,21 @@ "type": "object", "properties": { "active": { - "$ref": "#/components/schemas/connector._types.FilteringRules" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FilteringRules" + } + ] }, "domain": { "type": "string" }, "draft": { - "$ref": "#/components/schemas/connector._types.FilteringRules" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FilteringRules" + } + ] } }, "required": [ @@ -53476,7 +60700,11 @@ "type": "object", "properties": { "advanced_snippet": { - "$ref": "#/components/schemas/connector._types.FilteringAdvancedSnippet" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FilteringAdvancedSnippet" + } + ] }, "rules": { "type": "array", @@ -53485,7 +60713,11 @@ } }, "validation": { - "$ref": "#/components/schemas/connector._types.FilteringRulesValidation" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FilteringRulesValidation" + } + ] } }, "required": [ @@ -53498,10 +60730,18 @@ "type": "object", "properties": { "created_at": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "updated_at": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "value": { "type": "object" @@ -53515,25 +60755,49 @@ "type": "object", "properties": { "created_at": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "order": { "type": "number" }, "policy": { - "$ref": "#/components/schemas/connector._types.FilteringPolicy" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FilteringPolicy" + } + ] }, "rule": { - "$ref": "#/components/schemas/connector._types.FilteringRuleRule" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FilteringRuleRule" + } + ] }, "updated_at": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "value": { "type": "string" @@ -53577,7 +60841,11 @@ } }, "state": { - "$ref": "#/components/schemas/connector._types.FilteringValidationState" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FilteringValidationState" + } + ] } }, "required": [ @@ -53653,13 +60921,25 @@ "type": "object", "properties": { "access_control": { - "$ref": "#/components/schemas/connector._types.ConnectorScheduling" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.ConnectorScheduling" + } + ] }, "full": { - "$ref": "#/components/schemas/connector._types.ConnectorScheduling" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.ConnectorScheduling" + } + ] }, "incremental": { - "$ref": "#/components/schemas/connector._types.ConnectorScheduling" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.ConnectorScheduling" + } + ] } } }, @@ -53693,19 +60973,39 @@ "type": "object", "properties": { "cancelation_requested_at": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "canceled_at": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "completed_at": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "connector": { - "$ref": "#/components/schemas/connector._types.SyncJobConnectorReference" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.SyncJobConnectorReference" + } + ] }, "created_at": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "deleted_document_count": { "type": "number" @@ -53714,7 +61014,11 @@ "type": "string" }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "indexed_document_count": { "type": "number" @@ -53723,10 +61027,18 @@ "type": "number" }, "job_type": { - "$ref": "#/components/schemas/connector._types.SyncJobType" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.SyncJobType" + } + ] }, "last_seen": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "metadata": { "type": "object", @@ -53735,16 +61047,28 @@ } }, "started_at": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "status": { - "$ref": "#/components/schemas/connector._types.SyncStatus" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.SyncStatus" + } + ] }, "total_document_count": { "type": "number" }, "trigger_method": { - "$ref": "#/components/schemas/connector._types.SyncJobTriggerMethod" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.SyncJobTriggerMethod" + } + ] }, "worker_hostname": { "type": "string" @@ -53768,13 +61092,25 @@ "type": "object", "properties": { "configuration": { - "$ref": "#/components/schemas/connector._types.ConnectorConfiguration" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.ConnectorConfiguration" + } + ] }, "filtering": { - "$ref": "#/components/schemas/connector._types.FilteringRules" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.FilteringRules" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "index_name": { "type": "string" @@ -53783,7 +61119,11 @@ "type": "string" }, "pipeline": { - "$ref": "#/components/schemas/connector._types.IngestPipelineParams" + "allOf": [ + { + "$ref": "#/components/schemas/connector._types.IngestPipelineParams" + } + ] }, "service_type": { "type": "string" @@ -53819,26 +61159,56 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The unique identifier for the added document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The name of the index the document was added to.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "_primary_term": { "description": "The primary term assigned to the document for the indexing operation.", "type": "number" }, "result": { - "$ref": "#/components/schemas/_types.Result" + "description": "The result of the indexing operation: `created` or `updated`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] }, "_seq_no": { - "$ref": "#/components/schemas/_types.SequenceNumber" + "description": "The sequence number assigned to the document for the indexing operation.\nSequence numbers are used to ensure an older version of a document doesn't overwrite a newer version.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SequenceNumber" + } + ] }, "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "description": "Information about the replication process of the operation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] }, "_version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "The document version, which is incremented each time the document is updated.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "forced_refresh": { "type": "boolean" @@ -53880,13 +61250,25 @@ "type": "object", "properties": { "cause": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "status": { "type": "number" @@ -53923,7 +61305,11 @@ "type": "object", "properties": { "phase": { - "$ref": "#/components/schemas/enrich.execute_policy.EnrichPolicyPhase" + "allOf": [ + { + "$ref": "#/components/schemas/enrich.execute_policy.EnrichPolicyPhase" + } + ] }, "step": { "type": "string" @@ -53963,19 +61349,39 @@ "type": "object", "properties": { "enrich_fields": { - "$ref": "#/components/schemas/_types.Fields" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "indices": { - "$ref": "#/components/schemas/_types.Indices" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "match_field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "elasticsearch_version": { "type": "string" @@ -53991,7 +61397,12 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Identifier for the search.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "is_partial": { "description": "If true, the response does not contain complete search results.", @@ -54002,14 +61413,24 @@ "type": "boolean" }, "took": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "Milliseconds it took Elasticsearch to execute the request.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "timed_out": { "description": "If true, the request timed out before completion.", "type": "boolean" }, "hits": { - "$ref": "#/components/schemas/eql._types.EqlHits" + "description": "Contains matching events and sequences. Also contains related metadata.", + "allOf": [ + { + "$ref": "#/components/schemas/eql._types.EqlHits" + } + ] }, "shard_failures": { "description": "Contains information about shard failures (if any), in case allow_partial_search_results=true", @@ -54027,7 +61448,12 @@ "type": "object", "properties": { "total": { - "$ref": "#/components/schemas/_global.search._types.TotalHits" + "description": "Metadata about the number of matching events or sequences.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.TotalHits" + } + ] }, "events": { "description": "Contains events matching the query. Each object represents a matching event.", @@ -54049,10 +61475,20 @@ "type": "object", "properties": { "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "Name of the index containing the event.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Unique identifier for the event. This ID is only unique within the index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_source": { "description": "Original JSON body passed for the event at index time.", @@ -54114,7 +61550,11 @@ "type": "number" }, "node": { - "$ref": "#/components/schemas/_types.NodeId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] }, "start_time_millis": { "type": "number" @@ -54234,7 +61674,11 @@ "type": "object", "properties": { "took": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "is_partial": { "type": "boolean" @@ -54261,7 +61705,12 @@ } }, "_clusters": { - "$ref": "#/components/schemas/esql._types.EsqlClusterInfo" + "description": "Cross-cluster search information. Present if `include_ccs_metadata` was `true` in the request\nand a cross-cluster search was performed.", + "allOf": [ + { + "$ref": "#/components/schemas/esql._types.EsqlClusterInfo" + } + ] }, "profile": { "description": "Profiling information. Present if `profile` was `true` in the request.\nThe contents of this field are currently unstable.", @@ -54330,16 +61779,28 @@ "type": "object", "properties": { "status": { - "$ref": "#/components/schemas/esql._types.EsqlClusterStatus" + "allOf": [ + { + "$ref": "#/components/schemas/esql._types.EsqlClusterStatus" + } + ] }, "indices": { "type": "string" }, "took": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "_shards": { - "$ref": "#/components/schemas/esql._types.EsqlShardInfo" + "allOf": [ + { + "$ref": "#/components/schemas/esql._types.EsqlShardInfo" + } + ] }, "failures": { "type": "array", @@ -54401,10 +61862,18 @@ ] }, "node": { - "$ref": "#/components/schemas/_types.NodeId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] }, "reason": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] } }, "required": [ @@ -54426,13 +61895,21 @@ "type": "boolean" }, "_seq_no": { - "$ref": "#/components/schemas/_types.SequenceNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SequenceNumber" + } + ] }, "_primary_term": { "type": "number" }, "_routing": { - "$ref": "#/components/schemas/_types.Routing" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "_source": { "type": "object" @@ -54450,16 +61927,36 @@ "type": "boolean" }, "indices": { - "$ref": "#/components/schemas/_types.Indices" + "description": "The list of indices where this field has the same type family, or null if all indices have the same type family for the field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "meta": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Merged metadata across all indices as a map of string keys to arrays of values. A value length of 1 indicates that all indices had the same value for this key, while a length of 2 or more indicates that not all indices had the same value for this key.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "non_aggregatable_indices": { - "$ref": "#/components/schemas/_types.Indices" + "description": "The list of indices where this field is not aggregatable, or null if all indices have the same definition for the field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "non_searchable_indices": { - "$ref": "#/components/schemas/_types.Indices" + "description": "The list of indices where this field is not searchable, or null if all indices have the same definition for the field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "searchable": { "description": "Whether this field is indexed for search on all indices.", @@ -54478,7 +61975,13 @@ "type": "boolean" }, "time_series_metric": { - "$ref": "#/components/schemas/_types.mapping.TimeSeriesMetricType" + "description": "Contains metric type if this fields is used as a time series\nmetrics, absent if the field is not used as metric.", + "x-state": "Technical preview", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TimeSeriesMetricType" + } + ] }, "non_dimension_indices": { "description": "If this list is present in response then some indices have the\nfield marked as a dimension and other indices, the ones in this list, do not.", @@ -54507,7 +62010,12 @@ "type": "object", "properties": { "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The name of the index the document belongs to.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "fields": { "description": "If the `stored_fields` parameter is set to `true` and `found` is `true`, it contains the document fields stored in the index.", @@ -54527,7 +62035,12 @@ "type": "boolean" }, "_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The unique identifier for the document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_primary_term": { "description": "The primary term assigned to the document for the indexing operation.", @@ -54538,14 +62051,24 @@ "type": "string" }, "_seq_no": { - "$ref": "#/components/schemas/_types.SequenceNumber" + "description": "The sequence number assigned to the document for the indexing operation.\nSequence numbers are used to ensure an older version of a document doesn't overwrite a newer version.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SequenceNumber" + } + ] }, "_source": { "description": "If `found` is `true`, it contains the document data formatted in JSON.\nIf the `_source` parameter is set to `false` or the `stored_fields` parameter is set to `true`, it is excluded.", "type": "object" }, "_version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "The document version, which is ncremented each time the document is updated.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] } }, "required": [ @@ -54558,7 +62081,12 @@ "type": "object", "properties": { "lang": { - "$ref": "#/components/schemas/_types.ScriptLanguage" + "description": "The language the script is written in.\nFor search templates, use `mustache`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptLanguage" + } + ] }, "options": { "type": "object", @@ -54567,7 +62095,12 @@ } }, "source": { - "$ref": "#/components/schemas/_types.ScriptSource" + "description": "The script source.\nFor search templates, an object containing the search template.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptSource" + } + ] } }, "required": [ @@ -54579,10 +62112,20 @@ "type": "object", "properties": { "connections": { - "$ref": "#/components/schemas/graph._types.Hop" + "description": "Specifies one or more fields from which you want to extract terms that are associated with the specified vertices.", + "allOf": [ + { + "$ref": "#/components/schemas/graph._types.Hop" + } + ] }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "An optional guiding query that constrains the Graph API as it explores connected terms.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "vertices": { "description": "Contains the fields you are interested in.", @@ -54607,7 +62150,12 @@ } }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Identifies a field in the documents of interest.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "include": { "description": "Identifies the terms of interest that form the starting points from which you want to spider out.", @@ -54654,7 +62202,12 @@ "type": "object", "properties": { "sample_diversity": { - "$ref": "#/components/schemas/graph._types.SampleDiversity" + "description": "To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample.\nYou can do this by selecting a single-value field and setting a maximum number of documents per value for that field.", + "allOf": [ + { + "$ref": "#/components/schemas/graph._types.SampleDiversity" + } + ] }, "sample_size": { "description": "Each hop considers a sample of the best-matching documents on each shard.\nUsing samples improves the speed of execution and keeps exploration focused on meaningfully-connected terms.\nVery small values (less than 50) might not provide sufficient weight-of-evidence to identify significant connections between terms.\nVery large sample sizes can dilute the quality of the results and increase execution times.", @@ -54662,7 +62215,12 @@ "type": "number" }, "timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned.\nThis timeout is honored on a best-effort basis.\nExecution might overrun this timeout if, for example, a long pause is encountered while FieldData is loaded for a field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "use_significance": { "description": "Filters associated terms so only those that are significantly associated with your query are included.", @@ -54677,7 +62235,11 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "max_docs_per_value": { "type": "number" @@ -54718,7 +62280,11 @@ "type": "number" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "term": { "type": "string" @@ -54754,7 +62320,11 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "blocked": { "type": "boolean" @@ -54782,7 +62352,11 @@ "type": "object", "properties": { "analyzer": { - "$ref": "#/components/schemas/indices.analyze.AnalyzerDetail" + "allOf": [ + { + "$ref": "#/components/schemas/indices.analyze.AnalyzerDetail" + } + ] }, "charfilters": { "type": "array", @@ -54800,7 +62374,11 @@ } }, "tokenizer": { - "$ref": "#/components/schemas/indices.analyze.TokenDetail" + "allOf": [ + { + "$ref": "#/components/schemas/indices.analyze.TokenDetail" + } + ] } }, "required": [ @@ -54942,7 +62520,11 @@ "type": "object", "properties": { "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] } } } @@ -54980,28 +62562,56 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "managed_by_lifecycle": { "type": "boolean" }, "index_creation_date_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "time_since_index_creation": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "rollover_date_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "time_since_rollover": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "lifecycle": { - "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover" + } + ] }, "generation_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "error": { "type": "string" @@ -55051,10 +62661,18 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.DataStreamName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DataStreamName" + } + ] }, "lifecycle": { - "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover" + } + ] } }, "required": [ @@ -55065,14 +62683,24 @@ "type": "object", "properties": { "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Custom metadata for the stream, copied from the `_meta` object of the stream’s matching index template.\nIf empty, the response omits this property.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "allow_custom_routing": { "description": "If `true`, the data stream allows custom routing on write request.", "type": "boolean" }, "failure_store": { - "$ref": "#/components/schemas/indices._types.FailureStore" + "description": "Information about failure store backing indices", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.FailureStore" + } + ] }, "generation": { "description": "Current generation for the data stream. This number acts as a cumulative count of the stream’s rollovers, starting at 1.", @@ -55083,10 +62711,20 @@ "type": "boolean" }, "ilm_policy": { - "$ref": "#/components/schemas/_types.Name" + "description": "Name of the current ILM lifecycle policy in the stream’s matching index template.\nThis lifecycle policy is set in the `index.lifecycle.name` setting.\nIf the template does not include a lifecycle policy, this property is not included in the response.\nNOTE: A data stream’s backing indices may be assigned different lifecycle policies. To retrieve the lifecycle policy for individual backing indices, use the get index settings API.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "next_generation_managed_by": { - "$ref": "#/components/schemas/indices._types.ManagedBy" + "description": "Name of the lifecycle system that'll manage the next generation of the data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.ManagedBy" + } + ] }, "prefer_ilm": { "description": "Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream.", @@ -55100,10 +62738,21 @@ } }, "lifecycle": { - "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover" + "description": "Contains the configuration for the data stream lifecycle of this data stream.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.DataStreamName" + "description": "Name of the data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DataStreamName" + } + ] }, "replicated": { "description": "If `true`, the data stream is created and managed by cross-cluster replication and the local cluster can not write into this data stream or change its mappings.", @@ -55114,13 +62763,28 @@ "type": "boolean" }, "settings": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "description": "The settings specific to this data stream that will take precedence over the settings in the matching index\ntemplate.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "description": "The mappings specific to this data stream that will take precedence over the mappings in the matching index\ntemplate.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "status": { - "$ref": "#/components/schemas/_types.HealthStatus" + "description": "Health status of the data stream.\nThis health status is based on the state of the primary and replica shards of the stream’s backing indices.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.HealthStatus" + } + ] }, "system": { "description": "If `true`, the data stream is created and managed by an Elastic stack component and cannot be modified through normal user interaction.", @@ -55128,13 +62792,28 @@ "type": "boolean" }, "template": { - "$ref": "#/components/schemas/_types.Name" + "description": "Name of the index template used to create the data stream’s backing indices.\nThe template’s index pattern must match the name of this data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "timestamp_field": { - "$ref": "#/components/schemas/indices._types.DataStreamTimestampField" + "description": "Information about the `@timestamp` field in the data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamTimestampField" + } + ] }, "index_mode": { - "$ref": "#/components/schemas/indices._types.IndexMode" + "description": "The index mode for the data stream that will be used for newly created backing indices.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexMode" + } + ] } }, "required": [ @@ -55177,23 +62856,48 @@ "type": "object", "properties": { "index_name": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "Name of the backing index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "index_uuid": { - "$ref": "#/components/schemas/_types.Uuid" + "description": "Universally unique identifier (UUID) for the index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Uuid" + } + ] }, "ilm_policy": { - "$ref": "#/components/schemas/_types.Name" + "description": "Name of the current ILM lifecycle policy configured for this backing index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "managed_by": { - "$ref": "#/components/schemas/indices._types.ManagedBy" + "description": "Name of the lifecycle system that's currently managing this backing index.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.ManagedBy" + } + ] }, "prefer_ilm": { "description": "Indicates if ILM should take precedence over DSL in case both are configured to manage this index.", "type": "boolean" }, "index_mode": { - "$ref": "#/components/schemas/indices._types.IndexMode" + "description": "The index mode of this backing index of the data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexMode" + } + ] } }, "required": [ @@ -55222,7 +62926,12 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Field" + "description": "Name of the timestamp field for the data stream, which must be `@timestamp`. The `@timestamp` field must be included in every document indexed to the data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -55237,10 +62946,20 @@ "type": "string" }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "description": "The settings specific to this data stream", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "effective_mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "description": "The settings specific to this data stream merged with the settings from its template. These `effective_settings`\nare the settings that will be used when a new index is created for this data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] } }, "required": [ @@ -55253,10 +62972,18 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.DataStreamName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DataStreamName" + } + ] }, "options": { - "$ref": "#/components/schemas/indices._types.DataStreamOptions" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamOptions" + } + ] } }, "required": [ @@ -55268,7 +62995,12 @@ "type": "object", "properties": { "failure_store": { - "$ref": "#/components/schemas/indices._types.DataStreamFailureStore" + "description": "If defined, it specifies configuration for the failure store of this data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamFailureStore" + } + ] } } }, @@ -55282,7 +63014,12 @@ "type": "boolean" }, "lifecycle": { - "$ref": "#/components/schemas/indices._types.FailureStoreLifecycle" + "description": "If defined, it specifies the lifecycle configuration for the failure store of this data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.FailureStoreLifecycle" + } + ] } } }, @@ -55291,7 +63028,12 @@ "type": "object", "properties": { "data_retention": { - "$ref": "#/components/schemas/_types.Duration" + "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.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "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.", @@ -55308,10 +63050,20 @@ "type": "string" }, "settings": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "description": "The settings specific to this data stream", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] }, "effective_settings": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "description": "The settings specific to this data stream merged with the settings from its template. These `effective_settings`\nare the settings that will be used when a new index is created for this data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] } }, "required": [ @@ -55324,10 +63076,18 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "index_template": { - "$ref": "#/components/schemas/indices._types.IndexTemplate" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexTemplate" + } + ] } }, "required": [ @@ -55339,7 +63099,12 @@ "type": "object", "properties": { "index_patterns": { - "$ref": "#/components/schemas/_types.Names" + "description": "Name of the index template.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Names" + } + ] }, "composed_of": { "description": "An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence.", @@ -55349,23 +63114,43 @@ } }, "template": { - "$ref": "#/components/schemas/indices._types.IndexTemplateSummary" + "description": "Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexTemplateSummary" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "priority": { "description": "Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch.", "type": "number" }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Optional user metadata about the index template. May have any contents.\nThis map is not automatically generated by Elasticsearch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "allow_auto_create": { "type": "boolean" }, "data_stream": { - "$ref": "#/components/schemas/indices._types.IndexTemplateDataStreamConfiguration" + "description": "If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexTemplateDataStreamConfiguration" + } + ] }, "deprecated": { "description": "Marks this index template as deprecated.\nWhen creating or updating a non-deprecated index template that uses deprecated components,\nElasticsearch will emit a deprecation warning.", @@ -55373,7 +63158,13 @@ "type": "boolean" }, "ignore_missing_component_templates": { - "$ref": "#/components/schemas/_types.Names" + "description": "A list of component template names that are allowed to be absent.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Names" + } + ] } }, "required": [ @@ -55392,13 +63183,28 @@ } }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "description": "Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping parameters.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "settings": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "description": "Configuration options for the index.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] }, "lifecycle": { - "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover" + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover" + } + ] }, "data_stream_options": { "x-state": "Generally available", @@ -55433,10 +63239,18 @@ "type": "object", "properties": { "item": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] } }, "required": [ @@ -55447,10 +63261,20 @@ "type": "object", "properties": { "add_backing_index": { - "$ref": "#/components/schemas/indices.modify_data_stream.IndexAndDataStreamAction" + "description": "Adds an existing index as a backing index for a data stream.\nThe index is hidden as part of this operation.\nWARNING: Adding indices with the `add_backing_index` action can potentially result in improper data stream behavior.\nThis should be considered an expert level API.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.modify_data_stream.IndexAndDataStreamAction" + } + ] }, "remove_backing_index": { - "$ref": "#/components/schemas/indices.modify_data_stream.IndexAndDataStreamAction" + "description": "Removes a backing index from a data stream.\nThe index is unhidden as part of this operation.\nA data stream’s write index cannot be removed.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.modify_data_stream.IndexAndDataStreamAction" + } + ] } }, "minProperties": 1, @@ -55460,10 +63284,20 @@ "type": "object", "properties": { "data_stream": { - "$ref": "#/components/schemas/_types.DataStreamName" + "description": "Data stream targeted by the action.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DataStreamName" + } + ] }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "Index for the action.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] } }, "required": [ @@ -55475,7 +63309,12 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The data stream name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "applied_to_data_stream": { "description": "If the mappings were successfully applied to the data stream (or would have been, if running in `dry_run`\nmode), it is `true`. If an error occurred, it is `false`.", @@ -55486,10 +63325,20 @@ "type": "string" }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "description": "The mappings that are specfic to this data stream that will override any mappings from the matching index template.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "effective_mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "description": "The mappings that are effective on this data stream, taking into account the mappings from the matching index\ntemplate and the mappings specific to this data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] } }, "required": [ @@ -55501,7 +63350,12 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The data stream name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "applied_to_data_stream": { "description": "If the settings were successfully applied to the data stream (or would have been, if running in `dry_run`\nmode), it is `true`. If an error occurred, it is `false`.", @@ -55512,13 +63366,28 @@ "type": "string" }, "settings": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "description": "The settings that are specfic to this data stream that will override any settings from the matching index template.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] }, "effective_settings": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "description": "The settings that are effective on this data stream, taking into account the settings from the matching index\ntemplate and the settings specific to this data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] }, "index_settings_results": { - "$ref": "#/components/schemas/indices.put_data_stream_settings.IndexSettingResults" + "description": "Information about whether and where each setting was applied.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.put_data_stream_settings.IndexSettingResults" + } + ] } }, "required": [ @@ -55562,7 +63431,11 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "error": { "description": "A message explaining why the settings could not be applied to specific indices.", @@ -55585,13 +63458,28 @@ } }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "description": "Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping parameters.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "settings": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "description": "Configuration options for the index.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] }, "lifecycle": { - "$ref": "#/components/schemas/indices._types.DataStreamLifecycle" + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamLifecycle" + } + ] } } }, @@ -55610,7 +63498,11 @@ "type": "object", "properties": { "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] } } }, @@ -55618,13 +63510,21 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "unblocked": { "type": "boolean" }, "exception": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] } }, "required": [ @@ -55635,7 +63535,11 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "aliases": { "type": "array", @@ -55650,7 +63554,11 @@ } }, "data_stream": { - "$ref": "#/components/schemas/_types.DataStreamName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DataStreamName" + } + ] } }, "required": [ @@ -55662,10 +63570,18 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "indices": { - "$ref": "#/components/schemas/_types.Indices" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] } }, "required": [ @@ -55677,13 +63593,25 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.DataStreamName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DataStreamName" + } + ] }, "timestamp_field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "backing_indices": { - "$ref": "#/components/schemas/_types.Indices" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] } }, "required": [ @@ -55699,13 +63627,25 @@ "type": "object", "properties": { "min_age": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "max_age": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "max_age_millis": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "min_docs": { "type": "number" @@ -55714,25 +63654,41 @@ "type": "number" }, "max_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "max_size_bytes": { "type": "number" }, "min_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "min_size_bytes": { "type": "number" }, "max_primary_shard_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "max_primary_shard_size_bytes": { "type": "number" }, "min_primary_shard_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "min_primary_shard_size_bytes": { "type": "number" @@ -55749,7 +63705,11 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "index_patterns": { "type": "array", @@ -55773,10 +63733,18 @@ } }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "settings": { - "$ref": "#/components/schemas/indices._types.IndexSettings" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexSettings" + } + ] } }, "required": [ @@ -55789,13 +63757,28 @@ "type": "object", "properties": { "add": { - "$ref": "#/components/schemas/indices.update_aliases.AddAction" + "description": "Adds a data stream or index to an alias.\nIf the alias doesn’t exist, the `add` action creates it.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.update_aliases.AddAction" + } + ] }, "remove": { - "$ref": "#/components/schemas/indices.update_aliases.RemoveAction" + "description": "Removes a data stream or index from an alias.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.update_aliases.RemoveAction" + } + ] }, "remove_index": { - "$ref": "#/components/schemas/indices.update_aliases.RemoveIndexAction" + "description": "Deletes an index.\nYou cannot use this action on aliases or data streams.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.update_aliases.RemoveIndexAction" + } + ] } }, "minProperties": 1, @@ -55805,7 +63788,12 @@ "type": "object", "properties": { "alias": { - "$ref": "#/components/schemas/_types.IndexAlias" + "description": "Alias for the action.\nIndex alias names support date math.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexAlias" + } + ] }, "aliases": { "description": "Aliases for the action.\nIndex alias names support date math.", @@ -55822,16 +63810,36 @@ ] }, "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Query used to limit documents the alias can access.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "Data stream or index for the action.\nSupports wildcards (`*`).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "indices": { - "$ref": "#/components/schemas/_types.Indices" + "description": "Data streams or indices for the action.\nSupports wildcards (`*`).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "index_routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.\nData stream aliases don’t support this parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "is_hidden": { "description": "If `true`, the alias is hidden.", @@ -55843,10 +63851,20 @@ "type": "boolean" }, "routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "Value used to route indexing and search operations to a specific shard.\nData stream aliases don’t support this parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "search_routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.\nData stream aliases don’t support this parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "must_exist": { "description": "If `true`, the alias must exist to perform the action.", @@ -55859,7 +63877,12 @@ "type": "object", "properties": { "alias": { - "$ref": "#/components/schemas/_types.IndexAlias" + "description": "Alias for the action.\nIndex alias names support date math.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexAlias" + } + ] }, "aliases": { "description": "Aliases for the action.\nIndex alias names support date math.", @@ -55876,10 +63899,20 @@ ] }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "Data stream or index for the action.\nSupports wildcards (`*`).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "indices": { - "$ref": "#/components/schemas/_types.Indices" + "description": "Data streams or indices for the action.\nSupports wildcards (`*`).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "must_exist": { "description": "If `true`, the alias must exist to perform the action.", @@ -55892,10 +63925,20 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "Data stream or index for the action.\nSupports wildcards (`*`).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "indices": { - "$ref": "#/components/schemas/_types.Indices" + "description": "Data streams or indices for the action.\nSupports wildcards (`*`).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "must_exist": { "description": "If `true`, the alias must exist to perform the action.", @@ -55914,7 +63957,11 @@ "type": "string" }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "valid": { "type": "boolean" @@ -55955,7 +64002,12 @@ "type": "number" }, "tool_choice": { - "$ref": "#/components/schemas/inference._types.CompletionToolType" + "description": "Controls which tool is called by the model.\nString representation: One of `auto`, `none`, or `requrired`. `auto` allows the model to choose between calling tools and generating a message. `none` causes the model to not call any tools. `required` forces the model to call one or more tools.\nExample (object representation):\n```\n{\n \"tool_choice\": {\n \"type\": \"function\",\n \"function\": {\n \"name\": \"get_current_weather\"\n }\n }\n}\n```", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CompletionToolType" + } + ] }, "tools": { "description": "A list of tools that the model can call.\nExample:\n```\n{\n \"tools\": [\n {\n \"type\": \"function\",\n \"function\": {\n \"name\": \"get_price_of_item\",\n \"description\": \"Get the current price of an item\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"item\": {\n \"id\": \"12345\"\n },\n \"unit\": {\n \"type\": \"currency\"\n }\n }\n }\n }\n }\n ]\n}\n```", @@ -55978,14 +64030,24 @@ "type": "object", "properties": { "content": { - "$ref": "#/components/schemas/inference._types.MessageContent" + "description": "The content of the message.\n\nString example:\n```\n{\n \"content\": \"Some string\"\n}\n```\n\nObject example:\n```\n{\n \"content\": [\n {\n \"text\": \"Some text\",\n \"type\": \"text\"\n }\n ]\n}\n```", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.MessageContent" + } + ] }, "role": { "description": "The role of the message author. Valid values are `user`, `assistant`, `system`, and `tool`.", "type": "string" }, "tool_call_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Only for `tool` role messages. The tool call that this message is responding to.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "tool_calls": { "description": "Only for `assistant` role messages. The tool calls generated by the model. If it's specified, the `content` field is optional.\nExample:\n```\n{\n \"tool_calls\": [\n {\n \"id\": \"call_KcAjWtAww20AihPHphUh46Gd\",\n \"type\": \"function\",\n \"function\": {\n \"name\": \"get_current_weather\",\n \"arguments\": \"{\\\"location\\\":\\\"Boston, MA\\\"}\"\n }\n }\n ]\n}\n```", @@ -56035,10 +64097,20 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The identifier of the tool call.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "function": { - "$ref": "#/components/schemas/inference._types.ToolCallFunction" + "description": "The function that the model called.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.ToolCallFunction" + } + ] }, "type": { "description": "The type of the tool call.", @@ -56088,7 +64160,12 @@ "type": "string" }, "function": { - "$ref": "#/components/schemas/inference._types.CompletionToolChoiceFunction" + "description": "The tool choice function.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CompletionToolChoiceFunction" + } + ] } }, "required": [ @@ -56118,7 +64195,12 @@ "type": "string" }, "function": { - "$ref": "#/components/schemas/inference._types.CompletionToolFunction" + "description": "The function definition.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CompletionToolFunction" + } + ] } }, "required": [ @@ -56230,7 +64312,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskType" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskType" + } + ] } }, "required": [ @@ -56245,17 +64332,32 @@ "type": "object", "properties": { "chunking_settings": { - "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + "description": "Chunking configuration object", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings" + } + ] }, "service": { "description": "The service type", "type": "string" }, "service_settings": { - "$ref": "#/components/schemas/inference._types.ServiceSettings" + "description": "Settings specific to the service", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.ServiceSettings" + } + ] }, "task_settings": { - "$ref": "#/components/schemas/inference._types.TaskSettings" + "description": "Task settings specific to the service and task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskSettings" + } + ] } }, "required": [ @@ -56359,7 +64461,11 @@ "type": "object", "properties": { "embedding": { - "$ref": "#/components/schemas/inference._types.DenseByteVector" + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.DenseByteVector" + } + ] } }, "required": [ @@ -56378,7 +64484,11 @@ "type": "object", "properties": { "embedding": { - "$ref": "#/components/schemas/inference._types.DenseVector" + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.DenseVector" + } + ] } }, "required": [ @@ -56396,7 +64506,11 @@ "type": "object", "properties": { "embedding": { - "$ref": "#/components/schemas/inference._types.SparseVector" + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.SparseVector" + } + ] } }, "required": [ @@ -56457,7 +64571,15 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "externalDocs": { + "url": "https://docs.ai21.com/reference/api-rate-limits" + }, + "description": "This setting helps to minimize the number of rate limit errors returned from the AI21 API.\nBy default, the `ai21` service sets the number of requests allowed per minute to 200. Please refer to AI21 documentation for more details.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] } }, "required": [ @@ -56487,7 +64609,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeAi21" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeAi21" + } + ] } }, "required": [ @@ -56534,7 +64661,12 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "description": "This setting helps to minimize the number of rate limit errors returned from AlibabaCloud AI Search.\nBy default, the `alibabacloud-ai-search` service sets the number of requests allowed per minute to `1000`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] }, "service_id": { "description": "The name of the model service to use for the inference task.\nThe following service IDs are available for the `completion` task:\n\n* `ops-qwen-turbo`\n* `qwen-turbo`\n* `qwen-plus`\n* `qwen-max ÷ qwen-max-longcontext`\n\nThe following service ID is available for the `rerank` task:\n\n* `ops-bge-reranker-larger`\n\nThe following service ID is available for the `sparse_embedding` task:\n\n* `ops-text-sparse-embedding-001`\n\nThe following service IDs are available for the `text_embedding` task:\n\n`ops-text-embedding-001`\n`ops-text-embedding-zh-001`\n`ops-text-embedding-en-001`\n`ops-text-embedding-002`", @@ -56578,7 +64710,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeAlibabaCloudAI" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeAlibabaCloudAI" + } + ] } }, "required": [ @@ -56636,7 +64773,12 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "description": "This setting helps to minimize the number of rate limit errors returned from Watsonx.\nBy default, the `watsonxai` service sets the number of requests allowed per minute to 120.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] }, "secret_key": { "externalDocs": { @@ -56688,7 +64830,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeAmazonBedrock" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeAmazonBedrock" + } + ] } }, "required": [ @@ -56736,7 +64883,12 @@ "type": "string" }, "api": { - "$ref": "#/components/schemas/inference._types.AmazonSageMakerApi" + "description": "The API format to use when calling SageMaker.\nElasticsearch will convert the POST _inference request to this data format when invoking the SageMaker endpoint.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AmazonSageMakerApi" + } + ] }, "region": { "externalDocs": { @@ -56851,7 +65003,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeAmazonSageMaker" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeAmazonSageMaker" + } + ] } }, "required": [ @@ -56885,7 +65042,12 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "description": "This setting helps to minimize the number of rate limit errors returned from Anthropic.\nBy default, the `anthropic` service sets the number of requests allowed per minute to 50.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] } }, "required": [ @@ -56933,7 +65095,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeAnthropic" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeAnthropic" + } + ] } }, "required": [ @@ -56989,7 +65156,12 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "description": "This setting helps to minimize the number of rate limit errors returned from Azure AI Studio.\nBy default, the `azureaistudio` service sets the number of requests allowed per minute to 240.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] } }, "required": [ @@ -57046,7 +65218,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeAzureAIStudio" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeAzureAIStudio" + } + ] } }, "required": [ @@ -57106,7 +65283,15 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "externalDocs": { + "url": "https://learn.microsoft.com/en-us/azure/ai-services/openai/quotas-limits" + }, + "description": "This setting helps to minimize the number of rate limit errors returned from Azure.\nThe `azureopenai` service sets a default number of requests allowed per minute depending on the task type.\nFor `text_embedding`, it is set to `1440`.\nFor `completion`, it is set to `120`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] }, "resource_name": { "externalDocs": { @@ -57144,7 +65329,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeAzureOpenAI" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeAzureOpenAI" + } + ] } }, "required": [ @@ -57186,17 +65376,33 @@ "type": "string" }, "embedding_type": { - "$ref": "#/components/schemas/inference._types.CohereEmbeddingType" + "description": "For a `text_embedding` task, the types of embeddings you want to get back.\nUse `binary` for binary embeddings, which are encoded as bytes with signed int8 precision.\nUse `bit` for binary embeddings, which are encoded as bytes with signed int8 precision (this is a synonym of `binary`).\nUse `byte` for signed int8 embeddings (this is a synonym of `int8`).\nUse `float` for the default float embeddings.\nUse `int8` for signed int8 embeddings.", + "default": "float", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CohereEmbeddingType" + } + ] }, "model_id": { "description": "For a `completion`, `rerank`, or `text_embedding` task, the name of the model to use for the inference task.\n\n* For the available `completion` models, refer to the [Cohere command docs](https://docs.cohere.com/docs/models#command).\n* For the available `rerank` models, refer to the [Cohere rerank docs](https://docs.cohere.com/reference/rerank-1).\n* For the available `text_embedding` models, refer to [Cohere embed docs](https://docs.cohere.com/reference/embed).", "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "description": "This setting helps to minimize the number of rate limit errors returned from Cohere.\nBy default, the `cohere` service sets the number of requests allowed per minute to 10000.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] }, "similarity": { - "$ref": "#/components/schemas/inference._types.CohereSimilarityType" + "description": "The similarity measure.\nIf the `embedding_type` is `float`, the default value is `dot_product`.\nIf the `embedding_type` is `int8` or `byte`, the default value is `cosine`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CohereSimilarityType" + } + ] } }, "required": [ @@ -57226,7 +65432,12 @@ "type": "object", "properties": { "input_type": { - "$ref": "#/components/schemas/inference._types.CohereInputType" + "description": "For a `text_embedding` task, the type of input passed to the model.\nValid values are:\n\n* `classification`: Use it for embeddings passed through a text classifier.\n* `clustering`: Use it for the embeddings run through a clustering algorithm.\n* `ingest`: Use it for storing document embeddings in a vector database.\n* `search`: Use it for storing embeddings of search queries run against a vector database to find relevant documents.\n\nIMPORTANT: The `input_type` field is required when using embedding models `v3` and higher.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CohereInputType" + } + ] }, "return_documents": { "description": "For a `rerank` task, return doc text within the results.", @@ -57237,7 +65448,12 @@ "type": "number" }, "truncate": { - "$ref": "#/components/schemas/inference._types.CohereTruncateType" + "description": "For a `text_embedding` task, the method to handle inputs longer than the maximum token length.\nValid values are:\n\n* `END`: When the input exceeds the maximum input token length, the end of the input is discarded.\n* `NONE`: When the input exceeds the maximum input token length, an error is returned.\n* `START`: When the input exceeds the maximum input token length, the start of the input is discarded.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CohereTruncateType" + } + ] } }, "required": [ @@ -57274,7 +65490,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeCohere" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeCohere" + } + ] } }, "required": [ @@ -57323,10 +65544,20 @@ "type": "object" }, "request": { - "$ref": "#/components/schemas/inference._types.CustomRequestParams" + "description": "The request configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CustomRequestParams" + } + ] }, "response": { - "$ref": "#/components/schemas/inference._types.CustomResponseParams" + "description": "The response configuration object.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.CustomResponseParams" + } + ] }, "secret_parameters": { "description": "Specifies secret parameters, like `api_key` or `api_token`, that are required to access the custom service.\nFor example:\n```\n\"secret_parameters\":{\n \"api_key\":\"\"\n}\n```", @@ -57389,7 +65620,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeCustom" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeCustom" + } + ] } }, "required": [ @@ -57458,7 +65694,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeDeepSeek" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeDeepSeek" + } + ] } }, "required": [ @@ -57486,7 +65727,12 @@ "type": "object", "properties": { "adaptive_allocations": { - "$ref": "#/components/schemas/inference._types.AdaptiveAllocations" + "description": "Adaptive allocations configuration details.\nIf `enabled` is true, the number of allocations of the model is set based on the current load the process gets.\nWhen the load is high, a new model allocation is automatically created, respecting the value of `max_number_of_allocations` if it's set.\nWhen the load is low, a model allocation is automatically removed, respecting the value of `min_number_of_allocations` if it's set.\nIf `enabled` is true, do not set the number of allocations manually.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AdaptiveAllocations" + } + ] }, "deployment_id": { "description": "The deployment identifier for a trained model deployment.\nWhen `deployment_id` is used the `model_id` is optional.", @@ -57554,7 +65800,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeElasticsearch" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeElasticsearch" + } + ] } }, "required": [ @@ -57588,7 +65839,12 @@ "type": "object", "properties": { "adaptive_allocations": { - "$ref": "#/components/schemas/inference._types.AdaptiveAllocations" + "description": "Adaptive allocations configuration details.\nIf `enabled` is true, the number of allocations of the model is set based on the current load the process gets.\nWhen the load is high, a new model allocation is automatically created, respecting the value of `max_number_of_allocations` if it's set.\nWhen the load is low, a model allocation is automatically removed, respecting the value of `min_number_of_allocations` if it's set.\nIf `enabled` is true, do not set the number of allocations manually.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.AdaptiveAllocations" + } + ] }, "num_allocations": { "description": "The total number of allocations this model is assigned across machine learning nodes.\nIncreasing this value generally increases the throughput.\nIf adaptive allocations is enabled, do not set this value because it's automatically set.", @@ -57617,7 +65873,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeELSER" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeELSER" + } + ] } }, "required": [ @@ -57661,7 +65922,12 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "description": "This setting helps to minimize the number of rate limit errors returned from Google AI Studio.\nBy default, the `googleaistudio` service sets the number of requests allowed per minute to 360.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] } }, "required": [ @@ -57682,7 +65948,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeGoogleAIStudio" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeGoogleAIStudio" + } + ] } }, "required": [ @@ -57736,7 +66007,12 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "description": "This setting helps to minimize the number of rate limit errors returned from Google Vertex AI.\nBy default, the `googlevertexai` service sets the number of requests allowed per minute to 30.000.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] }, "service_account_json": { "description": "A valid service account in JSON format for the Google Vertex AI API.", @@ -57776,7 +66052,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeGoogleVertexAI" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeGoogleVertexAI" + } + ] } }, "required": [ @@ -57819,7 +66100,12 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "description": "This setting helps to minimize the number of rate limit errors returned from Hugging Face.\nBy default, the `hugging_face` service sets the number of requests allowed per minute to 3000 for all supported tasks.\nHugging Face does not publish a universal rate limit — actual limits may vary.\nIt is recommended to adjust this value based on the capacity and limits of your specific deployment environment.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] }, "url": { "externalDocs": { @@ -57864,7 +66150,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeHuggingFace" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeHuggingFace" + } + ] } }, "required": [ @@ -57911,10 +66202,23 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "externalDocs": { + "url": "https://jina.ai/contact-sales/#rate-limit" + }, + "description": "This setting helps to minimize the number of rate limit errors returned from JinaAI.\nBy default, the `jinaai` service sets the number of requests allowed per minute to 2000 for all task types.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] }, "similarity": { - "$ref": "#/components/schemas/inference._types.JinaAISimilarityType" + "description": "For a `text_embedding` task, the similarity measure. One of cosine, dot_product, l2_norm.\nThe default values varies with the embedding type.\nFor example, a float embedding type uses a `dot_product` similarity measure by default.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.JinaAISimilarityType" + } + ] } }, "required": [ @@ -57937,7 +66241,12 @@ "type": "boolean" }, "task": { - "$ref": "#/components/schemas/inference._types.JinaAITextEmbeddingTask" + "description": "For a `text_embedding` task, the task passed to the model.\nValid values are:\n\n* `classification`: Use it for embeddings passed through a text classifier.\n* `clustering`: Use it for the embeddings run through a clustering algorithm.\n* `ingest`: Use it for storing document embeddings in a vector database.\n* `search`: Use it for storing embeddings of search queries run against a vector database to find relevant documents.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.JinaAITextEmbeddingTask" + } + ] }, "top_n": { "description": "For a `rerank` task, the number of most relevant documents to return.\nIt defaults to the number of the documents.\nIf this inference endpoint is used in a `text_similarity_reranker` retriever query and `top_n` is set, it must be greater than or equal to `rank_window_size` in the query.", @@ -57967,7 +66276,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeJinaAi" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeJinaAi" + } + ] } }, "required": [ @@ -58017,10 +66331,20 @@ "type": "number" }, "similarity": { - "$ref": "#/components/schemas/inference._types.LlamaSimilarityType" + "description": "For a `text_embedding` task, the similarity measure. One of cosine, dot_product, l2_norm.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.LlamaSimilarityType" + } + ] }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "description": "This setting helps to minimize the number of rate limit errors returned from the Llama API.\nBy default, the `llama` service sets the number of requests allowed per minute to 3000.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] } }, "required": [ @@ -58049,7 +66373,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeLlama" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeLlama" + } + ] } }, "required": [ @@ -58103,7 +66432,12 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "description": "This setting helps to minimize the number of rate limit errors returned from the Mistral API.\nBy default, the `mistral` service sets the number of requests allowed per minute to 240.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] } }, "required": [ @@ -58124,7 +66458,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeMistral" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeMistral" + } + ] } }, "required": [ @@ -58182,7 +66521,12 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "description": "This setting helps to minimize the number of rate limit errors returned from OpenAI.\nThe `openai` service sets a default number of requests allowed per minute depending on the task type.\nFor `text_embedding`, it is set to `3000`.\nFor `completion`, it is set to `500`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] }, "url": { "description": "The URL endpoint to use for the requests.\nIt can be changed for testing purposes.", @@ -58217,7 +66561,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeOpenAI" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeOpenAI" + } + ] } }, "required": [ @@ -58266,7 +66615,12 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "description": "This setting helps to minimize the number of rate limit errors returned from VoyageAI.\nThe `voyageai` service sets a default number of requests allowed per minute depending on the task type.\nFor both `text_embedding` and `rerank`, it is set to `2000`.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] }, "embedding_type": { "externalDocs": { @@ -58316,7 +66670,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeVoyageAI" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeVoyageAI" + } + ] } }, "required": [ @@ -58376,7 +66735,12 @@ "type": "string" }, "rate_limit": { - "$ref": "#/components/schemas/inference._types.RateLimitSetting" + "description": "This setting helps to minimize the number of rate limit errors returned from Watsonx.\nBy default, the `watsonxai` service sets the number of requests allowed per minute to 120.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.RateLimitSetting" + } + ] }, "url": { "description": "The URL of the inference endpoint that you created on Watsonx.", @@ -58404,7 +66768,12 @@ "type": "string" }, "task_type": { - "$ref": "#/components/schemas/inference._types.TaskTypeWatsonx" + "description": "The task type", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskTypeWatsonx" + } + ] } }, "required": [ @@ -58482,7 +66851,12 @@ "type": "object", "properties": { "build_date": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The Elasticsearch Git commit's date.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "build_flavor": { "description": "The build flavor. For example, `default`.", @@ -58501,13 +66875,28 @@ "type": "string" }, "lucene_version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "The version number of Elasticsearch's underlying Lucene software.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "minimum_index_compatibility_version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "The minimum index version with which the responding node can read from disk.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "minimum_wire_compatibility_version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "The minimum node version with which the responding node can communicate.\nAlso the minimum version from which you can perform a rolling upgrade.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "number": { "description": "The Elasticsearch version number.\n\n::: IMPORTANT: For Serverless deployments, this static value is always `8.11.0` and is used solely for backward compatibility with legacy clients.\n Serverless environments are versionless and automatically upgraded, so this value can be safely ignored.", @@ -58548,7 +66937,12 @@ } }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "Version number used by external systems to track ingest pipelines.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "deprecated": { "description": "Marks this ingest pipeline as deprecated.\nWhen a deprecated ingest pipeline is referenced as the default or final pipeline when creating or updating a non-deprecated index template, Elasticsearch will emit a deprecation warning.", @@ -58556,7 +66950,12 @@ "type": "boolean" }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Arbitrary metadata about the ingest pipeline. This map is not automatically generated by Elasticsearch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] } } }, @@ -58564,139 +66963,364 @@ "type": "object", "properties": { "append": { - "$ref": "#/components/schemas/ingest._types.AppendProcessor" + "description": "Appends one or more values to an existing array if the field already exists and it is an array.\nConverts a scalar to an array and appends one or more values to it if the field exists and it is a scalar.\nCreates an array containing the provided values if the field doesn’t exist.\nAccepts a single value or an array of values.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.AppendProcessor" + } + ] }, "attachment": { - "$ref": "#/components/schemas/ingest._types.AttachmentProcessor" + "description": "The attachment processor lets Elasticsearch extract file attachments in common formats (such as PPT, XLS, and PDF) by using the Apache text extraction library Tika.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.AttachmentProcessor" + } + ] }, "bytes": { - "$ref": "#/components/schemas/ingest._types.BytesProcessor" + "description": "Converts a human readable byte value (for example `1kb`) to its value in bytes (for example `1024`).\nIf the field is an array of strings, all members of the array will be converted.\nSupported human readable units are \"b\", \"kb\", \"mb\", \"gb\", \"tb\", \"pb\" case insensitive.\nAn error will occur if the field is not a supported format or resultant value exceeds 2^63.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.BytesProcessor" + } + ] }, "circle": { - "$ref": "#/components/schemas/ingest._types.CircleProcessor" + "description": "Converts circle definitions of shapes to regular polygons which approximate them.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.CircleProcessor" + } + ] }, "community_id": { - "$ref": "#/components/schemas/ingest._types.CommunityIDProcessor" + "description": "Computes the Community ID for network flow data as defined in the\nCommunity ID Specification. You can use a community ID to correlate network\nevents related to a single flow.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.CommunityIDProcessor" + } + ] }, "convert": { - "$ref": "#/components/schemas/ingest._types.ConvertProcessor" + "description": "Converts a field in the currently ingested document to a different type, such as converting a string to an integer.\nIf the field value is an array, all members will be converted.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.ConvertProcessor" + } + ] }, "csv": { - "$ref": "#/components/schemas/ingest._types.CsvProcessor" + "description": "Extracts fields from CSV line out of a single text field within a document.\nAny empty field in CSV will be skipped.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.CsvProcessor" + } + ] }, "date": { - "$ref": "#/components/schemas/ingest._types.DateProcessor" + "description": "Parses dates from fields, and then uses the date or timestamp as the timestamp for the document.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.DateProcessor" + } + ] }, "date_index_name": { - "$ref": "#/components/schemas/ingest._types.DateIndexNameProcessor" + "description": "The purpose of this processor is to point documents to the right time based index based on a date or timestamp field in a document by using the date math index name support.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.DateIndexNameProcessor" + } + ] }, "dissect": { - "$ref": "#/components/schemas/ingest._types.DissectProcessor" + "description": "Extracts structured fields out of a single text field by matching the text field against a delimiter-based pattern.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.DissectProcessor" + } + ] }, "dot_expander": { - "$ref": "#/components/schemas/ingest._types.DotExpanderProcessor" + "description": "Expands a field with dots into an object field.\nThis processor allows fields with dots in the name to be accessible by other processors in the pipeline.\nOtherwise these fields can’t be accessed by any processor.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.DotExpanderProcessor" + } + ] }, "drop": { - "$ref": "#/components/schemas/ingest._types.DropProcessor" + "description": "Drops the document without raising any errors.\nThis is useful to prevent the document from getting indexed based on some condition.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.DropProcessor" + } + ] }, "enrich": { - "$ref": "#/components/schemas/ingest._types.EnrichProcessor" + "description": "The `enrich` processor can enrich documents with data from another index.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.EnrichProcessor" + } + ] }, "fail": { - "$ref": "#/components/schemas/ingest._types.FailProcessor" + "description": "Raises an exception.\nThis is useful for when you expect a pipeline to fail and want to relay a specific message to the requester.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.FailProcessor" + } + ] }, "fingerprint": { - "$ref": "#/components/schemas/ingest._types.FingerprintProcessor" + "description": "Computes a hash of the document’s content. You can use this hash for\ncontent fingerprinting.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.FingerprintProcessor" + } + ] }, "foreach": { - "$ref": "#/components/schemas/ingest._types.ForeachProcessor" + "description": "Runs an ingest processor on each element of an array or object.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.ForeachProcessor" + } + ] }, "ip_location": { - "$ref": "#/components/schemas/ingest._types.IpLocationProcessor" + "description": "Currently an undocumented alias for GeoIP Processor.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.IpLocationProcessor" + } + ] }, "geo_grid": { - "$ref": "#/components/schemas/ingest._types.GeoGridProcessor" + "description": "Converts geo-grid definitions of grid tiles or cells to regular bounding boxes or polygons which describe their shape.\nThis is useful if there is a need to interact with the tile shapes as spatially indexable fields.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.GeoGridProcessor" + } + ] }, "geoip": { - "$ref": "#/components/schemas/ingest._types.GeoIpProcessor" + "description": "The `geoip` processor adds information about the geographical location of an IPv4 or IPv6 address.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.GeoIpProcessor" + } + ] }, "grok": { - "$ref": "#/components/schemas/ingest._types.GrokProcessor" + "description": "Extracts structured fields out of a single text field within a document.\nYou choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.GrokProcessor" + } + ] }, "gsub": { - "$ref": "#/components/schemas/ingest._types.GsubProcessor" + "description": "Converts a string field by applying a regular expression and a replacement.\nIf the field is an array of string, all members of the array will be converted.\nIf any non-string values are encountered, the processor will throw an exception.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.GsubProcessor" + } + ] }, "html_strip": { - "$ref": "#/components/schemas/ingest._types.HtmlStripProcessor" + "description": "Removes HTML tags from the field.\nIf the field is an array of strings, HTML tags will be removed from all members of the array.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.HtmlStripProcessor" + } + ] }, "inference": { - "$ref": "#/components/schemas/ingest._types.InferenceProcessor" + "description": "Uses a pre-trained data frame analytics model or a model deployed for natural language processing tasks to infer against the data that is being ingested in the pipeline.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.InferenceProcessor" + } + ] }, "join": { - "$ref": "#/components/schemas/ingest._types.JoinProcessor" + "description": "Joins each element of an array into a single string using a separator character between each element.\nThrows an error when the field is not an array.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.JoinProcessor" + } + ] }, "json": { - "$ref": "#/components/schemas/ingest._types.JsonProcessor" + "description": "Converts a JSON string into a structured JSON object.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.JsonProcessor" + } + ] }, "kv": { - "$ref": "#/components/schemas/ingest._types.KeyValueProcessor" + "description": "This processor helps automatically parse messages (or specific event fields) which are of the `foo=bar` variety.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.KeyValueProcessor" + } + ] }, "lowercase": { - "$ref": "#/components/schemas/ingest._types.LowercaseProcessor" + "description": "Converts a string to its lowercase equivalent.\nIf the field is an array of strings, all members of the array will be converted.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.LowercaseProcessor" + } + ] }, "network_direction": { - "$ref": "#/components/schemas/ingest._types.NetworkDirectionProcessor" + "description": "Calculates the network direction given a source IP address, destination IP\naddress, and a list of internal networks.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.NetworkDirectionProcessor" + } + ] }, "pipeline": { - "$ref": "#/components/schemas/ingest._types.PipelineProcessor" + "description": "Executes another pipeline.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.PipelineProcessor" + } + ] }, "redact": { - "$ref": "#/components/schemas/ingest._types.RedactProcessor" + "description": "The Redact processor uses the Grok rules engine to obscure text in the input document matching the given Grok patterns.\nThe processor can be used to obscure Personal Identifying Information (PII) by configuring it to detect known patterns such as email or IP addresses.\nText that matches a Grok pattern is replaced with a configurable string such as `` where an email address is matched or simply replace all matches with the text `` if preferred.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.RedactProcessor" + } + ] }, "registered_domain": { - "$ref": "#/components/schemas/ingest._types.RegisteredDomainProcessor" + "description": "Extracts the registered domain (also known as the effective top-level\ndomain or eTLD), sub-domain, and top-level domain from a fully qualified\ndomain name (FQDN). Uses the registered domains defined in the Mozilla\nPublic Suffix List.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.RegisteredDomainProcessor" + } + ] }, "remove": { - "$ref": "#/components/schemas/ingest._types.RemoveProcessor" + "description": "Removes existing fields.\nIf one field doesn’t exist, an exception will be thrown.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.RemoveProcessor" + } + ] }, "rename": { - "$ref": "#/components/schemas/ingest._types.RenameProcessor" + "description": "Renames an existing field.\nIf the field doesn’t exist or the new name is already used, an exception will be thrown.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.RenameProcessor" + } + ] }, "reroute": { - "$ref": "#/components/schemas/ingest._types.RerouteProcessor" + "description": "Routes a document to another target index or data stream.\nWhen setting the `destination` option, the target is explicitly specified and the dataset and namespace options can’t be set.\nWhen the `destination` option is not set, this processor is in a data stream mode. Note that in this mode, the reroute processor can only be used on data streams that follow the data stream naming scheme.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.RerouteProcessor" + } + ] }, "script": { - "$ref": "#/components/schemas/ingest._types.ScriptProcessor" + "description": "Runs an inline or stored script on incoming documents.\nThe script runs in the `ingest` context.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.ScriptProcessor" + } + ] }, "set": { - "$ref": "#/components/schemas/ingest._types.SetProcessor" + "description": "Adds a field with the specified value.\nIf the field already exists, its value will be replaced with the provided one.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.SetProcessor" + } + ] }, "set_security_user": { - "$ref": "#/components/schemas/ingest._types.SetSecurityUserProcessor" + "description": "Sets user-related details (such as `username`, `roles`, `email`, `full_name`, `metadata`, `api_key`, `realm` and `authentication_type`) from the current authenticated user to the current document by pre-processing the ingest.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.SetSecurityUserProcessor" + } + ] }, "sort": { - "$ref": "#/components/schemas/ingest._types.SortProcessor" + "description": "Sorts the elements of an array ascending or descending.\nHomogeneous arrays of numbers will be sorted numerically, while arrays of strings or heterogeneous arrays of strings + numbers will be sorted lexicographically.\nThrows an error when the field is not an array.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.SortProcessor" + } + ] }, "split": { - "$ref": "#/components/schemas/ingest._types.SplitProcessor" + "description": "Splits a field into an array using a separator character.\nOnly works on string fields.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.SplitProcessor" + } + ] }, "terminate": { - "$ref": "#/components/schemas/ingest._types.TerminateProcessor" + "description": "Terminates the current ingest pipeline, causing no further processors to be run.\nThis will normally be executed conditionally, using the `if` option.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.TerminateProcessor" + } + ] }, "trim": { - "$ref": "#/components/schemas/ingest._types.TrimProcessor" + "description": "Trims whitespace from a field.\nIf the field is an array of strings, all members of the array will be trimmed.\nThis only works on leading and trailing whitespace.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.TrimProcessor" + } + ] }, "uppercase": { - "$ref": "#/components/schemas/ingest._types.UppercaseProcessor" + "description": "Converts a string to its uppercase equivalent.\nIf the field is an array of strings, all members of the array will be converted.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.UppercaseProcessor" + } + ] }, "urldecode": { - "$ref": "#/components/schemas/ingest._types.UrlDecodeProcessor" + "description": "URL-decodes a string.\nIf the field is an array of strings, all members of the array will be decoded.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.UrlDecodeProcessor" + } + ] }, "uri_parts": { - "$ref": "#/components/schemas/ingest._types.UriPartsProcessor" + "description": "Parses a Uniform Resource Identifier (URI) string and extracts its components as an object.\nThis URI object includes properties for the URI’s domain, path, fragment, port, query, scheme, user info, username, and password.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.UriPartsProcessor" + } + ] }, "user_agent": { - "$ref": "#/components/schemas/ingest._types.UserAgentProcessor" + "description": "The `user_agent` processor extracts details from the user agent string a browser sends with its web requests.\nThis processor adds this information by default under the `user_agent` field.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.UserAgentProcessor" + } + ] } }, "minProperties": 1, @@ -58711,7 +67335,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to be appended to.\nSupports template snippets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "value": { "description": "The value to be appended. Supports template snippets.", @@ -58748,7 +67377,12 @@ "type": "string" }, "if": { - "$ref": "#/components/schemas/_types.Script" + "description": "Conditionally execute the processor.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] }, "ignore_failure": { "description": "Ignore failures for the processor.", @@ -58776,7 +67410,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to get the base64 encoded field from.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and field does not exist, the processor quietly exits without modifying the document.", @@ -58789,7 +67428,13 @@ "type": "number" }, "indexed_chars_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field name from which you can overwrite the number of chars being used for extraction.", + "default": "null", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "properties": { "description": "Array of properties to select to be stored.\nCan be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`.", @@ -58799,7 +67444,13 @@ } }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field that will hold the attachment information.", + "default": "attachment", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "remove_binary": { "description": "If true, the binary field will be removed from the document", @@ -58826,7 +67477,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to convert.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", @@ -58834,7 +67490,13 @@ "type": "boolean" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.", + "default": "field", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -58856,7 +67518,12 @@ "type": "number" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", @@ -58864,10 +67531,20 @@ "type": "boolean" }, "shape_type": { - "$ref": "#/components/schemas/ingest._types.ShapeType" + "description": "Which field mapping type is to be used when processing the circle: `geo_shape` or `shape`.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.ShapeType" + } + ] }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to assign the polygon shape to\nBy default, the field is updated in-place.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -58894,31 +67571,85 @@ "type": "object", "properties": { "source_ip": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing the source IP address.", + "default": "source.ip", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "source_port": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing the source port.", + "default": "source.port", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "destination_ip": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing the destination IP address.", + "default": "destination.ip", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "destination_port": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing the destination port.", + "default": "destination.port", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "iana_number": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing the IANA number.", + "default": "network.iana_number", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "icmp_type": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing the ICMP type.", + "default": "icmp.type", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "icmp_code": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing the ICMP code.", + "default": "icmp.code", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "transport": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing the transport protocol name or number. Used only when the\niana_number field is not present. The following protocol names are currently\nsupported: eigrp, gre, icmp, icmpv6, igmp, ipv6-icmp, ospf, pim, sctp, tcp, udp", + "default": "network.transport", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Output field for the community ID.", + "default": "network.community_id", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "seed": { "description": "Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The\nseed can prevent hash collisions between network domains, such as a staging\nand production network that use the same addressing scheme.", @@ -58943,7 +67674,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field whose value is to be converted.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", @@ -58951,10 +67687,21 @@ "type": "boolean" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to assign the converted value to.\nBy default, the `field` is updated in-place.", + "default": "field", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "type": { - "$ref": "#/components/schemas/ingest._types.ConvertType" + "description": "The type to convert the existing value to.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.ConvertType" + } + ] } }, "required": [ @@ -58990,7 +67737,12 @@ "type": "object" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to extract data from.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", @@ -59007,7 +67759,12 @@ "type": "string" }, "target_fields": { - "$ref": "#/components/schemas/_types.Fields" + "description": "The array of fields to assign extracted values to.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "trim": { "description": "Trim whitespaces in unquoted fields.", @@ -59030,7 +67787,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to get the date from.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "formats": { "description": "An array of the expected date formats.\nCan be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N.", @@ -59045,7 +67807,13 @@ "type": "string" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field that will hold the parsed date.", + "default": "`@timestamp`", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "timezone": { "description": "The timezone to use when parsing the date.\nSupports template snippets.", @@ -59085,7 +67853,12 @@ "type": "string" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to get the date or timestamp from.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "index_name_format": { "description": "The format to be used when printing the parsed date into the index name.\nA valid java time pattern is expected here.\nSupports template snippets.", @@ -59128,7 +67901,12 @@ "type": "string" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to dissect.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", @@ -59156,7 +67934,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to expand into an object field.\nIf set to `*`, all top-level fields will be expanded.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "override": { "description": "Controls the behavior when there is already an existing nested object that conflicts with the expanded field.\nWhen `false`, the processor will merge conflicts by combining the old and the new values into an array.\nWhen `true`, the value from the expanded field will overwrite the existing value.", @@ -59193,7 +67976,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field in the input document that matches the policies match_field used to retrieve the enrichment data.\nSupports template snippets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", @@ -59215,10 +68003,21 @@ "type": "string" }, "shape_relation": { - "$ref": "#/components/schemas/_types.GeoShapeRelation" + "description": "A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index.\nThis option is only used for `geo_match` enrich policy types.", + "default": "INTERSECTS", + "allOf": [ + { + "$ref": "#/components/schemas/_types.GeoShapeRelation" + } + ] }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.\nSupports template snippets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -59266,17 +68065,34 @@ "type": "object", "properties": { "fields": { - "$ref": "#/components/schemas/_types.Fields" + "description": "Array of fields to include in the fingerprint. For objects, the processor\nhashes both the field key and value. For other fields, the processor hashes\nonly the field value.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Output field for the fingerprint.", + "default": "fingerprint", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "salt": { "description": "Salt value for the hash function.", "type": "string" }, "method": { - "$ref": "#/components/schemas/ingest._types.FingerprintDigest" + "description": "The hash method used to compute the fingerprint. Must be one of MD5, SHA-1,\nSHA-256, SHA-512, or MurmurHash3.", + "default": "SHA-1", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.FingerprintDigest" + } + ] }, "ignore_missing": { "description": "If true, the processor ignores any missing fields. If all fields are\nmissing, the processor silently exits without modifying the document.", @@ -59309,7 +68125,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing array or object values.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true`, the processor silently exits without changing the document if the `field` is `null` or missing.", @@ -59317,7 +68138,12 @@ "type": "boolean" }, "processor": { - "$ref": "#/components/schemas/ingest._types.ProcessorContainer" + "description": "Ingest processor to run on each element.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.ProcessorContainer" + } + ] } }, "required": [ @@ -59341,7 +68167,12 @@ "type": "string" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to get the ip address from for the geographical lookup.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "first_only": { "description": "If `true`, only the first found IP location data will be returned, even if the field contains an array.", @@ -59361,7 +68192,13 @@ } }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field that will hold the geographical information looked up from the MaxMind database.", + "default": "geoip", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "download_database_on_pipeline_creation": { "description": "If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created.\nElse, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index.", @@ -59387,22 +68224,53 @@ "type": "string" }, "tile_type": { - "$ref": "#/components/schemas/ingest._types.GeoGridTileType" + "description": "Three tile formats are understood: geohash, geotile and geohex.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.GeoGridTileType" + } + ] }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to assign the polygon shape to, by default, the `field` is updated in-place.", + "default": "field", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "parent_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "If specified and a parent tile exists, save that tile address to this field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "children_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "If specified and children tiles exist, save those tile addresses to this field as an array of strings.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "non_children_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "If specified and intersecting non-child tiles exist, save their addresses to this field as an array of strings.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "precision_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "If specified, save the tile precision (zoom) as an integer to this field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", @@ -59410,7 +68278,13 @@ "type": "boolean" }, "target_format": { - "$ref": "#/components/schemas/ingest._types.GeoGridTargetFormat" + "description": "Which format to save the generated polygon in.", + "default": "geojson", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.GeoGridTargetFormat" + } + ] } }, "required": [ @@ -59449,7 +68323,12 @@ "type": "string" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to get the ip address from for the geographical lookup.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "first_only": { "description": "If `true`, only the first found geoip data will be returned, even if the field contains an array.", @@ -59469,7 +68348,13 @@ } }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field that will hold the geographical information looked up from the MaxMind database.", + "default": "geoip", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "download_database_on_pipeline_creation": { "description": "If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created.\nElse, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index.", @@ -59496,7 +68381,12 @@ "type": "string" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to use for grok expression parsing.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", @@ -59542,7 +68432,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to apply the replacement to.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", @@ -59558,7 +68453,13 @@ "type": "string" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to assign the converted value to\nBy default, the `field` is updated in-place.", + "default": "field", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -59578,7 +68479,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The string-valued field to remove HTML tags from.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document,", @@ -59586,7 +68492,13 @@ "type": "boolean" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to assign the converted value to\nBy default, the `field` is updated in-place.", + "default": "field", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -59604,10 +68516,21 @@ "type": "object", "properties": { "model_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The ID or alias for the trained model, or the ID of the deployment.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field added to incoming documents to contain results objects.", + "default": "ml.inference.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "field_map": { "description": "Maps the document field names to the known field names of the model.\nThis mapping takes precedence over any default mappings provided in the model configuration.", @@ -59617,7 +68540,12 @@ } }, "inference_config": { - "$ref": "#/components/schemas/ingest._types.InferenceConfig" + "description": "Contains the inference type and its options.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.InferenceConfig" + } + ] }, "input_output": { "description": "Input fields for inference and output (destination) fields for the inference results.\nThis option is incompatible with the target_field and field_map options.", @@ -59648,10 +68576,20 @@ "type": "object", "properties": { "regression": { - "$ref": "#/components/schemas/ingest._types.InferenceConfigRegression" + "description": "Regression configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.InferenceConfigRegression" + } + ] }, "classification": { - "$ref": "#/components/schemas/ingest._types.InferenceConfigClassification" + "description": "Classification configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.InferenceConfigClassification" + } + ] } }, "minProperties": 1, @@ -59661,7 +68599,13 @@ "type": "object", "properties": { "results_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field that is added to incoming documents to contain the inference prediction.", + "default": "_prediction", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "num_top_feature_importance_values": { "description": "Specifies the maximum number of feature importance values per document.", @@ -59684,10 +68628,22 @@ "type": "number" }, "results_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field that is added to incoming documents to contain the inference prediction.", + "default": "_prediction", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "top_classes_results_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Specifies the field to which the top classes are written.", + "default": "top_classes", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "prediction_field_type": { "description": "Specifies the type of the predicted field to write.\nValid values are: `string`, `number`, `boolean`.", @@ -59719,14 +68675,25 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing array values to join.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "separator": { "description": "The separator character.", "type": "string" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to assign the joined value to.\nBy default, the field is updated in-place.", + "default": "field", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -59750,7 +68717,12 @@ "type": "boolean" }, "add_to_root_conflict_strategy": { - "$ref": "#/components/schemas/ingest._types.JsonProcessorConflictStrategy" + "description": "When set to `replace`, root fields that conflict with fields from the parsed JSON will be overridden.\nWhen set to `merge`, conflicting fields will be merged.\nOnly applicable `if add_to_root` is set to true.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.JsonProcessorConflictStrategy" + } + ] }, "allow_duplicate_keys": { "description": "When set to `true`, the JSON parser will not fail if the JSON contains duplicate keys.\nInstead, the last encountered value for any duplicate key wins.", @@ -59758,10 +68730,21 @@ "type": "boolean" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to be parsed.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field that the converted structured object will be written into.\nAny existing content in this field will be overwritten.", + "default": "field", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -59793,7 +68776,12 @@ } }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to be parsed.\nSupports template snippets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "field_split": { "description": "Regex pattern to use for splitting key-value pairs.", @@ -59822,7 +68810,12 @@ "type": "boolean" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to insert the extracted keys into.\nDefaults to the root of the document.\nSupports template snippets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "trim_key": { "description": "String of characters to trim from extracted keys.", @@ -59854,7 +68847,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to make lowercase.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", @@ -59862,7 +68860,13 @@ "type": "boolean" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.", + "default": "field", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -59880,13 +68884,31 @@ "type": "object", "properties": { "source_ip": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing the source IP address.", + "default": "source.ip", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "destination_ip": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing the destination IP address.", + "default": "destination.ip", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Output field for the network direction.", + "default": "network.direction", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "internal_networks": { "description": "List of internal networks. Supports IPv4 and IPv6 addresses and ranges in\nCIDR notation. Also supports the named ranges listed below. These may be\nconstructed with template snippets. Must specify only one of\ninternal_networks or internal_networks_field.", @@ -59896,7 +68918,12 @@ } }, "internal_networks_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "A field on the given document to read the internal_networks configuration\nfrom.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If true and any required fields are missing, the processor quietly exits\nwithout modifying the document.", @@ -59916,7 +68943,12 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The name of the pipeline to execute.\nSupports template snippets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "ignore_missing_pipeline": { "description": "Whether to ignore missing pipelines instead of failing.", @@ -59939,7 +68971,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to be redacted", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "patterns": { "description": "A list of grok expressions to match and redact named captures with", @@ -59997,10 +69034,20 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing the source FQDN.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Object field containing extracted domain components. If an empty string,\nthe processor adds components to the document’s root.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If true and any required fields are missing, the processor quietly exits\nwithout modifying the document.", @@ -60023,10 +69070,20 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Fields" + "description": "Fields to be removed. Supports template snippets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "keep": { - "$ref": "#/components/schemas/_types.Fields" + "description": "Fields to be kept. When set, all fields other than those specified are removed.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", @@ -60049,7 +69106,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to be renamed.\nSupports template snippets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", @@ -60057,7 +69119,12 @@ "type": "boolean" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The new name of the field.\nSupports template snippets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -60120,10 +69187,21 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "ID of a stored script.\nIf no `source` is specified, this parameter is required.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "lang": { - "$ref": "#/components/schemas/_types.ScriptLanguage" + "description": "Script language.", + "default": "painless", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptLanguage" + } + ] }, "params": { "description": "Object containing parameters for the script.", @@ -60133,7 +69211,12 @@ } }, "source": { - "$ref": "#/components/schemas/_types.ScriptSource" + "description": "Inline script.\nIf no `id` is specified, this parameter is required.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptSource" + } + ] } } } @@ -60148,10 +69231,20 @@ "type": "object", "properties": { "copy_from": { - "$ref": "#/components/schemas/_types.Field" + "description": "The origin field which will be copied to `field`, cannot set `value` simultaneously.\nSupported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to insert, upsert, or update.\nSupports template snippets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_empty_value": { "description": "If `true` and `value` is a template snippet that evaluates to `null` or the empty string, the processor quietly exits without modifying the document.", @@ -60187,7 +69280,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to store the user information into.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "properties": { "description": "Controls what user related properties are added to the field.", @@ -60212,13 +69310,29 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to be sorted.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "order": { - "$ref": "#/components/schemas/_types.SortOrder" + "description": "The sort order to use.\nAccepts `\"asc\"` or `\"desc\"`.", + "default": "asc", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortOrder" + } + ] }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to assign the sorted value to.\nBy default, the field is updated in-place.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -60236,7 +69350,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to split.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", @@ -60253,7 +69372,13 @@ "type": "string" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to assign the split value to.\nBy default, the field is updated in-place.", + "default": "field", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -60282,7 +69407,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The string-valued field to trim whitespace from.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", @@ -60290,7 +69420,13 @@ "type": "boolean" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to assign the trimmed value to.\nBy default, the field is updated in-place.", + "default": "field", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -60308,7 +69444,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to make uppercase.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", @@ -60316,7 +69457,13 @@ "type": "boolean" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.", + "default": "field", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -60334,7 +69481,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to decode.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", @@ -60342,7 +69494,13 @@ "type": "boolean" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.", + "default": "field", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -60360,7 +69518,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing the URI string.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", @@ -60378,7 +69541,13 @@ "type": "boolean" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Output field for the URI object.", + "default": "url", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -60396,7 +69565,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field containing the user agent string.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "ignore_missing": { "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", @@ -60408,7 +69582,13 @@ "type": "string" }, "target_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field that will be filled with the user agent details.", + "default": "user_agent", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "properties": { "description": "Controls what properties are added to `target_field`.", @@ -60456,10 +69636,20 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Unique identifier for the document.\nThis ID must be unique within the `_index`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "Name of the index containing the document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "_source": { "description": "JSON body for the document.", @@ -60474,10 +69664,18 @@ "type": "object", "properties": { "doc": { - "$ref": "#/components/schemas/ingest._types.DocumentSimulation" + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.DocumentSimulation" + } + ] }, "error": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] }, "processor_results": { "type": "array", @@ -60492,13 +69690,27 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Unique identifier for the document. This ID must be unique within the `_index`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "Name of the index containing the document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "_ingest": { - "$ref": "#/components/schemas/ingest._types.Ingest" + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.Ingest" + } + ] }, "_routing": { "description": "Value used to send the document to a specific primary shard.", @@ -60512,10 +69724,19 @@ } }, "_version": { - "$ref": "#/components/schemas/_spec_utils.StringifiedVersionNumber" + "description": "", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils.StringifiedVersionNumber" + } + ] }, "_version_type": { - "$ref": "#/components/schemas/_types.VersionType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionType" + } + ] } }, "required": [ @@ -60529,13 +69750,26 @@ "type": "object", "properties": { "_redact": { - "$ref": "#/components/schemas/ingest._types.Redact" + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.Redact" + } + ] }, "timestamp": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "pipeline": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] } }, "required": [ @@ -60569,7 +69803,11 @@ "type": "object", "properties": { "doc": { - "$ref": "#/components/schemas/ingest._types.DocumentSimulation" + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.DocumentSimulation" + } + ] }, "tag": { "type": "string" @@ -60578,16 +69816,28 @@ "type": "string" }, "status": { - "$ref": "#/components/schemas/ingest._types.PipelineSimulationStatusOptions" + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.PipelineSimulationStatusOptions" + } + ] }, "description": { "type": "string" }, "ignored_error": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] }, "error": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] } } }, @@ -60605,16 +69855,32 @@ "type": "object", "properties": { "expiry_date": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "expiry_date_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "issue_date": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "issue_date_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "issued_to": { "type": "string" @@ -60645,16 +69911,32 @@ ] }, "status": { - "$ref": "#/components/schemas/license._types.LicenseStatus" + "allOf": [ + { + "$ref": "#/components/schemas/license._types.LicenseStatus" + } + ] }, "type": { - "$ref": "#/components/schemas/license._types.LicenseType" + "allOf": [ + { + "$ref": "#/components/schemas/license._types.LicenseType" + } + ] }, "uid": { - "$ref": "#/components/schemas/_types.Uuid" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Uuid" + } + ] }, "start_date_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] } }, "required": [ @@ -60700,7 +69982,12 @@ "type": "string" }, "last_modified": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The date the pipeline was last updated.\nIt must be in the `yyyy-MM-dd'T'HH:mm:ss.SSSZZ` strict_date_time format.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "pipeline": { "externalDocs": { @@ -60710,10 +69997,23 @@ "type": "string" }, "pipeline_metadata": { - "$ref": "#/components/schemas/logstash._types.PipelineMetadata" + "description": "Optional metadata about the pipeline, which can have any contents.\nThis metadata is not generated or used by Elasticsearch or Logstash.", + "allOf": [ + { + "$ref": "#/components/schemas/logstash._types.PipelineMetadata" + } + ] }, "pipeline_settings": { - "$ref": "#/components/schemas/logstash._types.PipelineSettings" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/logstash/logstash-settings-file" + }, + "description": "Settings for the pipeline.\nIt supports only flat keys in dot notation.", + "allOf": [ + { + "$ref": "#/components/schemas/logstash._types.PipelineSettings" + } + ] }, "username": { "description": "The user who last updated the pipeline.", @@ -60785,25 +70085,58 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The unique document ID.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The index that contains the document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "The key for the primary shard the document resides on. Required if routing is used during indexing.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "_source": { - "$ref": "#/components/schemas/_global.search._types.SourceConfig" + "description": "If `false`, excludes all _source fields.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.SourceConfig" + } + ] }, "stored_fields": { - "$ref": "#/components/schemas/_types.Fields" + "description": "The stored fields you want to retrieve.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "version_type": { - "$ref": "#/components/schemas/_types.VersionType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionType" + } + ] } }, "required": [ @@ -60824,13 +70157,25 @@ "type": "object", "properties": { "error": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] }, "_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] } }, "required": [ @@ -60843,13 +70188,29 @@ "type": "object", "properties": { "bucket_span": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The size of the interval that the analysis is aggregated into, typically between `5m` and `1h`. This value should be either a whole number of days or equate to a\nwhole number of buckets in one day. If the anomaly detection job uses a datafeed with aggregations, this value must also be divisible by the interval of the date histogram aggregation.", + "default": "5m", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "categorization_analyzer": { - "$ref": "#/components/schemas/ml._types.CategorizationAnalyzer" + "description": "If `categorization_field_name` is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as `categorization_filters`. The categorization analyzer specifies how the `categorization_field` is interpreted by the categorization process. The `categorization_analyzer` field can be specified either as a string or as an object. If it is a string, it must refer to a built-in analyzer or one added by another plugin.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.CategorizationAnalyzer" + } + ] }, "categorization_field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "categorization_filters": { "description": "If `categorization_field_name` is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as `categorization_analyzer`. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the `categorization_analyzer` property instead and include the filters as pattern_replace character filters. The effect is exactly the same.", @@ -60873,20 +70234,41 @@ } }, "latency": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second. NOTE: Latency is applicable only when you send data by using the post data API.", + "default": "0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "model_prune_window": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of the `bucket_span`. If set too low, important information may be removed from the model. For jobs created in 8.1 and later, the default value is the greater of `30d` or 20 times `bucket_span`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "multivariate_by_fields": { "description": "This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to `true`, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. For example, suppose CPU and memory usage on host A is usually highly correlated with the same metrics on host B. Perhaps this correlation occurs because they are running a load-balanced application. If you enable this property, anomalies will be reported when, for example, CPU usage on host A is high and the value of CPU usage on host B is low. That is to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU of host B. To use the `multivariate_by_fields` property, you must also specify `by_field_name` in your detector.", "type": "boolean" }, "per_partition_categorization": { - "$ref": "#/components/schemas/ml._types.PerPartitionCategorization" + "description": "Settings related to how categorization interacts with partition fields.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.PerPartitionCategorization" + } + ] }, "summary_count_field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -60921,7 +70303,15 @@ } }, "tokenizer": { - "$ref": "#/components/schemas/_types.analysis.Tokenizer" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/text-analysis/tokenizer-reference" + }, + "description": "The name or definition of the tokenizer to use after character filters are applied. This property is compulsory if `categorization_analyzer` is specified as an object. Machine learning provides a tokenizer called `ml_standard` that tokenizes in a way that has been determined to produce good categorization results on a variety of log file formats for logs in English. If you want to use that tokenizer but change the character or token filters, specify \"tokenizer\": \"ml_standard\" in your `categorization_analyzer`. Additionally, the `ml_classic` tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2). `ml_classic` was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify \"tokenizer\": \"ml_classic\" in your `categorization_analyzer`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.Tokenizer" + } + ] } } }, @@ -60929,7 +70319,12 @@ "type": "object", "properties": { "by_field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "custom_rules": { "description": "Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules.", @@ -60947,20 +70342,40 @@ "type": "number" }, "exclude_frequent": { - "$ref": "#/components/schemas/ml._types.ExcludeFrequent" + "description": "If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, you can set `exclude_frequent` to `all` for both fields, or to `by` or `over` for those specific fields.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ExcludeFrequent" + } + ] }, "field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "function": { "description": "The analysis function that is used. For example, `count`, `rare`, `mean`, `min`, `max`, or `sum`.", "type": "string" }, "over_field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "partition_field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "use_null": { "description": "Defines whether a new series is used as the null series when there is no value for the by or partition fields.", @@ -61009,10 +70424,20 @@ "type": "object", "properties": { "applies_to": { - "$ref": "#/components/schemas/ml._types.AppliesTo" + "description": "Specifies the result property to which the condition applies. If your detector uses `lat_long`, `metric`, `rare`, or `freq_rare` functions, you can only specify conditions that apply to time.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AppliesTo" + } + ] }, "operator": { - "$ref": "#/components/schemas/ml._types.ConditionOperator" + "description": "Specifies the condition operator. The available options are greater than, greater than or equals, less than, and less than or equals.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ConditionOperator" + } + ] }, "value": { "description": "The value that is compared against the `applies_to` field using the operator.", @@ -61047,10 +70472,21 @@ "type": "object", "properties": { "filter_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The identifier for the filter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "filter_type": { - "$ref": "#/components/schemas/ml._types.FilterType" + "description": "If set to `include`, the rule applies for values in the filter. If set to `exclude`, the rule applies for values not in the filter.", + "default": "include", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.FilterType" + } + ] } }, "required": [ @@ -61090,13 +70526,28 @@ "type": "object", "properties": { "classification": { - "$ref": "#/components/schemas/ml._types.DataframeEvaluationClassification" + "description": "Classification evaluation evaluates the results of a classification analysis which outputs a prediction that identifies to which of the classes each document belongs.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeEvaluationClassification" + } + ] }, "outlier_detection": { - "$ref": "#/components/schemas/ml._types.DataframeEvaluationOutlierDetection" + "description": "Outlier detection evaluates the results of an outlier detection analysis which outputs the probability that each document is an outlier.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeEvaluationOutlierDetection" + } + ] }, "regression": { - "$ref": "#/components/schemas/ml._types.DataframeEvaluationRegression" + "description": "Regression evaluation evaluates the results of a regression analysis which outputs a prediction of values.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeEvaluationRegression" + } + ] } }, "minProperties": 1, @@ -61106,16 +70557,36 @@ "type": "object", "properties": { "actual_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "predicted_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field in the index which contains the predicted value, in other words the results of the classification analysis.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "top_classes_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field of the index which is an array of documents of the form { \"class_name\": XXX, \"class_probability\": YYY }. This field must be defined as nested in the mappings.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "metrics": { - "$ref": "#/components/schemas/ml._types.DataframeEvaluationClassificationMetrics" + "description": "Specifies the metrics that are used for the evaluation.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeEvaluationClassificationMetrics" + } + ] } }, "required": [ @@ -61152,7 +70623,12 @@ "type": "object", "properties": { "auc_roc": { - "$ref": "#/components/schemas/ml._types.DataframeEvaluationClassificationMetricsAucRoc" + "description": "The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as \"class_name\") treated as positive.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeEvaluationClassificationMetricsAucRoc" + } + ] }, "precision": { "description": "Precision of predictions (per-class and average).", @@ -61174,7 +70650,12 @@ "type": "object", "properties": { "class_name": { - "$ref": "#/components/schemas/_types.Name" + "description": "Name of the only class that is treated as positive during AUC ROC calculation. Other classes are treated as negative (\"one-vs-all\" strategy). All the evaluated documents must have class_name in the list of their top classes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "include_curve": { "description": "Whether or not the curve should be returned in addition to the score. Default value is false.", @@ -61186,13 +70667,28 @@ "type": "object", "properties": { "actual_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true).", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "predicted_probability_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "metrics": { - "$ref": "#/components/schemas/ml._types.DataframeEvaluationOutlierDetectionMetrics" + "description": "Specifies the metrics that are used for the evaluation.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeEvaluationOutlierDetectionMetrics" + } + ] } }, "required": [ @@ -61223,13 +70719,28 @@ "type": "object", "properties": { "actual_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field of the index which contains the ground truth. The data type of this field must be numerical.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "predicted_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field in the index that contains the predicted value, in other words the results of the regression analysis.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "metrics": { - "$ref": "#/components/schemas/ml._types.DataframeEvaluationRegressionMetrics" + "description": "Specifies the metrics that are used for the evaluation. For more information on mse, msle, and huber, consult the Jupyter notebook on regression loss functions.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeEvaluationRegressionMetrics" + } + ] } }, "required": [ @@ -61248,10 +70759,20 @@ } }, "msle": { - "$ref": "#/components/schemas/ml._types.DataframeEvaluationRegressionMetricsMsle" + "description": "Average squared difference between the logarithm of the predicted values and the logarithm of the actual (ground truth) value.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeEvaluationRegressionMetricsMsle" + } + ] }, "huber": { - "$ref": "#/components/schemas/ml._types.DataframeEvaluationRegressionMetricsHuber" + "description": "Pseudo Huber loss function.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeEvaluationRegressionMetricsHuber" + } + ] }, "r_squared": { "description": "Proportion of the variance in the dependent variable that is predictable from the independent variables.", @@ -61284,19 +70805,44 @@ "type": "object", "properties": { "auc_roc": { - "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationSummaryAucRoc" + "description": "The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve.\nIt is calculated for a specific class (provided as \"class_name\") treated as positive.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationSummaryAucRoc" + } + ] }, "accuracy": { - "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummaryAccuracy" + "description": "Accuracy of predictions (per-class and overall).", + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummaryAccuracy" + } + ] }, "multiclass_confusion_matrix": { - "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummaryMulticlassConfusionMatrix" + "description": "Multiclass confusion matrix.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummaryMulticlassConfusionMatrix" + } + ] }, "precision": { - "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummaryPrecision" + "description": "Precision of predictions (per-class and average).", + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummaryPrecision" + } + ] }, "recall": { - "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummaryRecall" + "description": "Recall of predictions (per-class and average).", + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummaryRecall" + } + ] } } }, @@ -61375,7 +70921,11 @@ "type": "object", "properties": { "class_name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] } }, "required": [ @@ -61406,7 +70956,11 @@ "type": "object", "properties": { "actual_class": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "actual_class_doc_count": { "type": "number" @@ -61432,7 +70986,11 @@ "type": "object", "properties": { "predicted_class": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "count": { "type": "number" @@ -61483,7 +71041,13 @@ "type": "object", "properties": { "auc_roc": { - "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationSummaryAucRoc" + "description": "The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve.", + "default": "{\"include_curve\": false}", + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationSummaryAucRoc" + } + ] }, "precision": { "description": "Set the different thresholds of the outlier score at where the metric is calculated.", @@ -61539,16 +71103,36 @@ "type": "object", "properties": { "huber": { - "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue" + "description": "Pseudo Huber loss function.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue" + } + ] }, "mse": { - "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue" + "description": "Average squared difference between the predicted values and the actual (`ground truth`) value.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue" + } + ] }, "msle": { - "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue" + "description": "Average squared difference between the logarithm of the predicted values and the logarithm of the actual (`ground truth`) value.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue" + } + ] }, "r_squared": { - "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue" + "description": "Proportion of the variance in the dependent variable that is predictable from the independent variables.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue" + } + ] } } }, @@ -61556,20 +71140,39 @@ "type": "object", "properties": { "calendar_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "A string that uniquely identifies a calendar.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "event_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "description": { "description": "A description of the scheduled event.", "type": "string" }, "end_time": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The timestamp for the end of the scheduled event in milliseconds since the epoch or ISO 8601 format.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "start_time": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The timestamp for the beginning of the scheduled event in milliseconds since the epoch or ISO 8601 format.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "skip_result": { "description": "When true the model will not create results for this calendar period.", @@ -61611,7 +71214,12 @@ "type": "object", "properties": { "calendar_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "A string that uniquely identifies a calendar.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "description": { "description": "A description of the calendar.", @@ -61637,25 +71245,50 @@ "type": "boolean" }, "analysis": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer" + } + ] }, "analyzed_fields": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields" + } + ] }, "authorization": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsAuthorization" + "description": "The security privileges that the job uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the job, this property is omitted.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsAuthorization" + } + ] }, "create_time": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "description": { "type": "string" }, "dest": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsDestination" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsDestination" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "max_num_threads": { "type": "number" @@ -61664,13 +71297,25 @@ "type": "string" }, "source": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] } }, "required": [ @@ -61684,13 +71329,28 @@ "type": "object", "properties": { "classification": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisClassification" + "description": "The configuration information necessary to perform classification.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisClassification" + } + ] }, "outlier_detection": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisOutlierDetection" + "description": "The configuration information necessary to perform outlier detection. NOTE: Advanced parameters are for fine-tuning classification analysis. They are set automatically by hyperparameter optimization to give the minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisOutlierDetection" + } + ] }, "regression": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisRegression" + "description": "The configuration information necessary to perform regression. NOTE: Advanced parameters are for fine-tuning regression analysis. They are set automatically by hyperparameter optimization to give the minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisRegression" + } + ] } }, "minProperties": 1, @@ -61777,7 +71437,12 @@ "type": "number" }, "prediction_field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "Defines the name of the prediction field in the results. Defaults to `_prediction`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "randomize_seed": { "description": "Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as `source` and `analyzed_fields` are the same).", @@ -61792,7 +71457,13 @@ "type": "number" }, "training_percent": { - "$ref": "#/components/schemas/_types.Percentage" + "description": "Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage.", + "default": 100.0, + "allOf": [ + { + "$ref": "#/components/schemas/_types.Percentage" + } + ] } }, "required": [ @@ -61803,19 +71474,44 @@ "type": "object", "properties": { "frequency_encoding": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorFrequencyEncoding" + "description": "The configuration information necessary to perform frequency encoding.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorFrequencyEncoding" + } + ] }, "multi_encoding": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorMultiEncoding" + "description": "The configuration information necessary to perform multi encoding. It allows multiple processors to be changed together. This way the output of a processor can then be passed to another as an input.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorMultiEncoding" + } + ] }, "n_gram_encoding": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorNGramEncoding" + "description": "The configuration information necessary to perform n-gram encoding. Features created by this encoder have the following name format: .. For example, if the feature_prefix is f, the feature name for the second unigram in a string is f.11.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorNGramEncoding" + } + ] }, "one_hot_encoding": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorOneHotEncoding" + "description": "The configuration information necessary to perform one hot encoding.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorOneHotEncoding" + } + ] }, "target_mean_encoding": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorTargetMeanEncoding" + "description": "The configuration information necessary to perform target mean encoding.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorTargetMeanEncoding" + } + ] } }, "minProperties": 1, @@ -61825,10 +71521,19 @@ "type": "object", "properties": { "feature_name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The resulting feature name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "frequency_map": { "description": "The resulting frequency map for the field value. If the field value is missing from the frequency_map, the resulting value is 0.", @@ -61867,7 +71572,12 @@ "type": "string" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The name of the text field to encode.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "length": { "description": "Specifies the length of the n-gram substring. Defaults to 50. Must be greater than 0.", @@ -61897,7 +71607,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The name of the field to encode.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "hot_map": { "description": "The one hot map mapping the field value with the column name.", @@ -61917,10 +71632,20 @@ "type": "number" }, "feature_name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The resulting feature name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The name of the field to encode.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "target_map": { "description": "The field value to target mean transition map.", @@ -62024,7 +71749,12 @@ "type": "object", "properties": { "api_key": { - "$ref": "#/components/schemas/ml._types.ApiKeyAuthorization" + "description": "If an API key was used for the most recent update to the job, its name and identifier are listed in the response.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ApiKeyAuthorization" + } + ] }, "roles": { "description": "If a user ID was used for the most recent update to the job, its roles at the time of the update are listed in the response.", @@ -62060,10 +71790,20 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "Defines the destination index to store the results of the data frame analytics job.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "results_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Defines the name of the field in which to store the results of the analysis. Defaults to `ml`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -62074,16 +71814,36 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.Indices" + "description": "Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. NOTE: If your source indices contain documents with the same IDs, only the document that is indexed last appears in the destination index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {\"match_all\": {}}.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "description": "Definitions of runtime fields that will become part of the mapping of the destination index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "_source": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields" + "description": "Specify `includes` and/or `excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields" + } + ] } }, "required": [ @@ -62094,20 +71854,40 @@ "type": "object", "properties": { "analysis_stats": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsContainer" + "description": "An object containing information about the analysis job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsContainer" + } + ] }, "assignment_explanation": { "description": "For running jobs only, contains messages relating to the selection of a node to run the job.", "type": "string" }, "data_counts": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsDataCounts" + "description": "An object that provides counts for the quantity of documents skipped, used in training, or available for testing.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsDataCounts" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The unique identifier of the data frame analytics job.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "memory_usage": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsMemoryUsage" + "description": "An object describing memory usage of the analytics. It is present only after the job is started and memory usage is reported.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsMemoryUsage" + } + ] }, "progress": { "description": "The progress report of the data frame analytics job by phase.", @@ -62117,7 +71897,12 @@ } }, "state": { - "$ref": "#/components/schemas/ml._types.DataframeState" + "description": "The status of the data frame analytics job, which can be one of the following values: failed, started, starting, stopping, stopped.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeState" + } + ] } }, "required": [ @@ -62132,13 +71917,28 @@ "type": "object", "properties": { "classification_stats": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsHyperparameters" + "description": "An object containing information about the classification analysis job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsHyperparameters" + } + ] }, "outlier_detection_stats": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsOutlierDetection" + "description": "An object containing information about the outlier detection job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsOutlierDetection" + } + ] }, "regression_stats": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsHyperparameters" + "description": "An object containing information about the regression analysis.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsHyperparameters" + } + ] } }, "minProperties": 1, @@ -62148,20 +71948,40 @@ "type": "object", "properties": { "hyperparameters": { - "$ref": "#/components/schemas/ml._types.Hyperparameters" + "description": "An object containing the parameters of the classification analysis job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Hyperparameters" + } + ] }, "iteration": { "description": "The number of iterations on the analysis.", "type": "number" }, "timestamp": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The timestamp when the statistics were reported in milliseconds since the epoch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "timing_stats": { - "$ref": "#/components/schemas/ml._types.TimingStats" + "description": "An object containing time statistics about the data frame analytics job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TimingStats" + } + ] }, "validation_loss": { - "$ref": "#/components/schemas/ml._types.ValidationLoss" + "description": "An object containing information about validation loss.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ValidationLoss" + } + ] } }, "required": [ @@ -62237,10 +72057,20 @@ "type": "object", "properties": { "elapsed_time": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "Runtime of the analysis in milliseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "iteration_time": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "Runtime of the latest iteration of the analysis in milliseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } }, "required": [ @@ -62271,13 +72101,28 @@ "type": "object", "properties": { "parameters": { - "$ref": "#/components/schemas/ml._types.OutlierDetectionParameters" + "description": "The list of job parameters specified by the user or determined by algorithmic heuristics.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.OutlierDetectionParameters" + } + ] }, "timestamp": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The timestamp when the statistics were reported in milliseconds since the epoch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "timing_stats": { - "$ref": "#/components/schemas/ml._types.TimingStats" + "description": "An object containing time statistics about the data frame analytics job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TimingStats" + } + ] } }, "required": [ @@ -62356,7 +72201,12 @@ "type": "string" }, "timestamp": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The timestamp when memory usage was calculated.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] } }, "required": [ @@ -62399,16 +72249,36 @@ "type": "string" }, "datafeed_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "A numerical character string that uniquely identifies the datafeed.\nThis identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.\nIt must start and end with alphanumeric characters.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "state": { - "$ref": "#/components/schemas/ml._types.DatafeedState" + "description": "The status of the datafeed, which can be one of the following values: `starting`, `started`, `stopping`, `stopped`.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DatafeedState" + } + ] }, "timing_stats": { - "$ref": "#/components/schemas/ml._types.DatafeedTimingStats" + "description": "An object that provides statistical information about timing aspect of this datafeed.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DatafeedTimingStats" + } + ] }, "running_state": { - "$ref": "#/components/schemas/ml._types.DatafeedRunningState" + "description": "An object containing the running state for this datafeed.\nIt is only provided if the datafeed is started.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DatafeedRunningState" + } + ] } }, "required": [ @@ -62424,23 +72294,47 @@ "type": "number" }, "exponential_average_search_time_per_hour_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "description": "The exponential average search time per hour, in milliseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] }, "exponential_average_calculation_context": { - "$ref": "#/components/schemas/ml._types.ExponentialAverageCalculationContext" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ExponentialAverageCalculationContext" + } + ] }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Identifier for the anomaly detection job.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "search_count": { "description": "The number of searches run by the datafeed.", "type": "number" }, "total_search_time_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "description": "The total time the datafeed spent searching, in milliseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] }, "average_search_time_per_bucket_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "description": "The average search time per bucket, in milliseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] } }, "required": [ @@ -62466,13 +72360,25 @@ "type": "object", "properties": { "incremental_metric_value_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] }, "latest_timestamp": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "previous_exponential_average_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] } }, "required": [ @@ -62491,7 +72397,12 @@ "type": "boolean" }, "search_interval": { - "$ref": "#/components/schemas/ml._types.RunningStateSearchInterval" + "description": "Provides the latest time interval the datafeed has searched.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.RunningStateSearchInterval" + } + ] } }, "required": [ @@ -62503,16 +72414,36 @@ "type": "object", "properties": { "end": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The end time.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "end_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The end time as an epoch in milliseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "start": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The start time.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "start_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "description": "The start time as an epoch in milliseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] } }, "required": [ @@ -62530,16 +72461,33 @@ } }, "authorization": { - "$ref": "#/components/schemas/ml._types.DatafeedAuthorization" + "description": "The security privileges that the datafeed uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the datafeed, this property is omitted.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DatafeedAuthorization" + } + ] }, "chunking_config": { - "$ref": "#/components/schemas/ml._types.ChunkingConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ChunkingConfig" + } + ] }, "datafeed_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "frequency": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "indices": { "type": "array", @@ -62554,16 +72502,31 @@ } }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "max_empty_searches": { "type": "number" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl" + }, + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "query_delay": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "script_fields": { "type": "object", @@ -62575,13 +72538,25 @@ "type": "number" }, "delayed_data_check_config": { - "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "indices_options": { - "$ref": "#/components/schemas/_types.IndicesOptions" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndicesOptions" + } + ] } }, "required": [ @@ -62596,7 +72571,12 @@ "type": "object", "properties": { "api_key": { - "$ref": "#/components/schemas/ml._types.ApiKeyAuthorization" + "description": "If an API key was used for the most recent update to the datafeed, its name and identifier are listed in the response.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ApiKeyAuthorization" + } + ] }, "roles": { "description": "If a user ID was used for the most recent update to the datafeed, its roles at the time of the update are listed in the response.", @@ -62615,10 +72595,21 @@ "type": "object", "properties": { "mode": { - "$ref": "#/components/schemas/ml._types.ChunkingMode" + "description": "If the mode is `auto`, the chunk size is dynamically calculated;\nthis is the recommended value when the datafeed does not use aggregations.\nIf the mode is `manual`, chunking is applied according to the specified `time_span`;\nuse this mode when the datafeed uses aggregations. If the mode is `off`, no chunking is applied.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ChunkingMode" + } + ] }, "time_span": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The time span that each search will be querying. This setting is applicable only when the `mode` is set to `manual`.", + "default": "3h", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } }, "required": [ @@ -62637,7 +72628,12 @@ "type": "object", "properties": { "check_window": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The window of time that is searched for late data. This window of time ends with the latest finalized bucket.\nIt defaults to null, which causes an appropriate `check_window` to be calculated when the real-time datafeed runs.\nIn particular, the default `check_window` span calculation is based on the maximum of `2h` or `8 * bucket_span`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "enabled": { "description": "Specifies whether the datafeed periodically checks for delayed data.", @@ -62657,7 +72653,12 @@ "type": "boolean" }, "expand_wildcards": { - "$ref": "#/components/schemas/_types.ExpandWildcards" + "description": "Type of index that wildcard patterns can match. If the request can target data streams, this argument\ndetermines whether wildcard expressions match hidden data streams. Supports comma-separated values,\nsuch as `open,hidden`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ExpandWildcards" + } + ] }, "ignore_unavailable": { "description": "If true, missing or closed indices are not included in the response.", @@ -62679,7 +72680,12 @@ "type": "string" }, "filter_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "A string that uniquely identifies a filter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "items": { "description": "An array of strings which is the filter item list.", @@ -62702,26 +72708,56 @@ "type": "string" }, "data_counts": { - "$ref": "#/components/schemas/ml._types.DataCounts" + "description": "An object that describes the quantity of input to the job and any related error counts.\nThe `data_count` values are cumulative for the lifetime of a job.\nIf a model snapshot is reverted or old results are deleted, the job counts are not reset.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataCounts" + } + ] }, "forecasts_stats": { - "$ref": "#/components/schemas/ml._types.JobForecastStatistics" + "description": "An object that provides statistical information about forecasts belonging to this job.\nSome statistics are omitted if no forecasts have been made.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobForecastStatistics" + } + ] }, "job_id": { "description": "Identifier for the anomaly detection job.", "type": "string" }, "model_size_stats": { - "$ref": "#/components/schemas/ml._types.ModelSizeStats" + "description": "An object that provides information about the size and contents of the model.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ModelSizeStats" + } + ] }, "open_time": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "For open jobs only, the elapsed time for which the job has been open.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "state": { - "$ref": "#/components/schemas/ml._types.JobState" + "description": "The status of the anomaly detection job, which can be one of the following values: `closed`, `closing`, `failed`, `opened`, `opening`.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobState" + } + ] }, "timing_stats": { - "$ref": "#/components/schemas/ml._types.JobTimingStats" + "description": "An object that provides statistical information about timing aspect of this job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobTimingStats" + } + ] }, "deleting": { "description": "Indicates that the process of deleting the job is in progress but not yet completed. It is only reported when `true`.", @@ -62762,7 +72798,11 @@ "type": "number" }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "last_data_time": { "type": "number" @@ -62817,13 +72857,25 @@ "type": "object", "properties": { "memory_bytes": { - "$ref": "#/components/schemas/ml._types.JobStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobStatistics" + } + ] }, "processing_time_ms": { - "$ref": "#/components/schemas/ml._types.JobStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobStatistics" + } + ] }, "records": { - "$ref": "#/components/schemas/ml._types.JobStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobStatistics" + } + ] }, "status": { "type": "object", @@ -62873,28 +72925,60 @@ "type": "number" }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "log_time": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "memory_status": { - "$ref": "#/components/schemas/ml._types.MemoryStatus" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.MemoryStatus" + } + ] }, "model_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "model_bytes_exceeded": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "model_bytes_memory_limit": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "output_memory_allocator_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "peak_model_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "assignment_memory_basis": { "type": "string" @@ -62912,7 +72996,11 @@ "type": "number" }, "categorization_status": { - "$ref": "#/components/schemas/ml._types.CategorizationStatus" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.CategorizationStatus" + } + ] }, "categorized_doc_count": { "type": "number" @@ -62959,28 +73047,56 @@ "type": "object", "properties": { "average_bucket_processing_time_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] }, "bucket_count": { "type": "number" }, "exponential_average_bucket_processing_time_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] }, "exponential_average_bucket_processing_time_per_hour_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "total_bucket_processing_time_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] }, "maximum_bucket_processing_time_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] }, "minimum_bucket_processing_time_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] } }, "required": [ @@ -62998,22 +73114,50 @@ "type": "boolean" }, "analysis_config": { - "$ref": "#/components/schemas/ml._types.AnalysisConfig" + "description": "The analysis configuration, which specifies how to analyze the data.\nAfter you create a job, you cannot change the analysis configuration; all the properties are informational.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AnalysisConfig" + } + ] }, "analysis_limits": { - "$ref": "#/components/schemas/ml._types.AnalysisLimits" + "description": "Limits can be applied for the resources required to hold the mathematical models in memory.\nThese limits are approximate and can be set per job.\nThey do not control the memory used by other processes, for example the Elasticsearch Java processes.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AnalysisLimits" + } + ] }, "background_persist_interval": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Advanced configuration option.\nThe time between each periodic persistence of the model.\nThe default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time.\nThe smallest allowed value is 1 hour.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "blocked": { - "$ref": "#/components/schemas/ml._types.JobBlocked" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobBlocked" + } + ] }, "create_time": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "custom_settings": { - "$ref": "#/components/schemas/ml._types.CustomSettings" + "description": "Advanced configuration option.\nContains custom metadata about the job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.CustomSettings" + } + ] }, "daily_model_snapshot_retention_after_days": { "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job.\nIt specifies a period of time (in days) after which only the first snapshot per day is retained.\nThis period is relative to the timestamp of the most recent snapshot for this job.\nValid values range from 0 to `model_snapshot_retention_days`.", @@ -63021,10 +73165,20 @@ "type": "number" }, "data_description": { - "$ref": "#/components/schemas/ml._types.DataDescription" + "description": "The data description defines the format of the input data when you send data to the job by using the post data API.\nNote that when configuring a datafeed, these properties are automatically set.\nWhen data is received via the post data API, it is not stored in Elasticsearch.\nOnly the results for anomaly detection are retained.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataDescription" + } + ] }, "datafeed_config": { - "$ref": "#/components/schemas/ml._types.Datafeed" + "description": "The datafeed, which retrieves data from Elasticsearch for analysis by the job.\nYou can associate only one datafeed with each anomaly detection job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Datafeed" + } + ] }, "deleting": { "description": "Indicates that the process of deleting the job is in progress but not yet completed.\nIt is only reported when `true`.", @@ -63035,7 +73189,12 @@ "type": "string" }, "finished_time": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "If the job closed or failed, this is the time the job finished, otherwise it is `null`.\nThis property is informational; you cannot change its value.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "groups": { "description": "A list of job groups.\nA job can belong to no groups or many.", @@ -63045,20 +73204,39 @@ } }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Identifier for the anomaly detection job.\nThis identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.\nIt must start and end with alphanumeric characters.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "job_type": { "description": "Reserved for future use, currently set to `anomaly_detector`.", "type": "string" }, "job_version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "The machine learning configuration version number at which the the job was created.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "model_plot_config": { - "$ref": "#/components/schemas/ml._types.ModelPlotConfig" + "description": "This advanced configuration option stores model information along with the results.\nIt provides a more detailed view into anomaly detection.\nModel plot provides a simplified and indicative view of the model and its bounds.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ModelPlotConfig" + } + ] }, "model_snapshot_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "model_snapshot_retention_days": { "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job.\nIt specifies the maximum period of time (in days) that snapshots are retained.\nThis period is relative to the timestamp of the most recent snapshot for this job.\nBy default, snapshots ten days older than the newest snapshot are deleted.", @@ -63069,7 +73247,12 @@ "type": "number" }, "results_index_name": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "A text string that affects the name of the machine learning results index.\nThe default value is `shared`, which generates an index named `.ml-anomalies-shared`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "results_retention_days": { "description": "Advanced configuration option.\nThe period of time (in days) that results are retained.\nAge is calculated relative to the timestamp of the latest bucket result.\nIf this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch.\nThe default value is null, which means all results are retained.\nAnnotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results.\nAnnotations added by users are retained forever.", @@ -63094,7 +73277,13 @@ "type": "number" }, "model_memory_limit": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The approximate maximum amount of memory resources that are required for analytical processing. Once this limit is approached, data pruning becomes more aggressive. Upon exceeding this limit, new entities are not modeled. If the `xpack.ml.max_model_memory_limit` setting has a value greater than 0 and less than 1024mb, that value is used instead of the default. The default value is relatively small to ensure that high resource usage is a conscious decision. If you have jobs that are expected to analyze high cardinality fields, you will likely need to use a higher value. If you specify a number instead of a string, the units are assumed to be MiB. Specifying a string is recommended for clarity. If you specify a byte size unit of `b` or `kb` and the number does not equate to a discrete number of megabytes, it is rounded down to the closest MiB. The minimum valid value is 1 MiB. If you specify a value less than 1 MiB, an error occurs. If you specify a value for the `xpack.ml.max_model_memory_limit` setting, an error occurs when you try to create jobs that have `model_memory_limit` values greater than that setting value.", + "default": "1024mb", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] } } }, @@ -63102,10 +73291,18 @@ "type": "object", "properties": { "reason": { - "$ref": "#/components/schemas/ml._types.JobBlockedReason" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobBlockedReason" + } + ] }, "task_id": { - "$ref": "#/components/schemas/_types.TaskId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TaskId" + } + ] } }, "required": [ @@ -63132,7 +73329,13 @@ "type": "string" }, "time_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The name of the field that contains the timestamp.", + "default": "time", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "time_format": { "description": "The time format, which can be `epoch`, `epoch_ms`, or a custom pattern. The value `epoch` refers to UNIX or Epoch time (the number of seconds since 1 Jan 1970). The value `epoch_ms` indicates that time is measured in milliseconds since the epoch. The `epoch` and `epoch_ms` time formats accept either integer or real values. Custom patterns must conform to the Java DateTimeFormatter class. When you use date-time formatting patterns, it is recommended that you provide the full date, time and time zone. For example: `yyyy-MM-dd'T'HH:mm:ssX`. If the pattern that you specify is not sufficient to produce a complete timestamp, job creation fails.", @@ -63159,7 +73362,13 @@ "type": "boolean" }, "terms": { - "$ref": "#/components/schemas/_types.Field" + "description": "Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } } }, @@ -63167,7 +73376,12 @@ "type": "object", "properties": { "bucket_span": { - "$ref": "#/components/schemas/_types.DurationValueUnitSeconds" + "description": "The length of the bucket in seconds. Matches the job with the longest bucket_span value.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitSeconds" + } + ] }, "is_interim": { "description": "If true, this is an interim result. In other words, the results are calculated based on partial input data.", @@ -63189,10 +73403,20 @@ "type": "string" }, "timestamp": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The start time of the bucket for which these results were calculated.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "timestamp_string": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The start time of the bucket for which these results were calculated.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] } }, "required": [ @@ -63215,7 +73439,11 @@ "type": "object", "properties": { "job_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "max_anomaly_score": { "type": "number" @@ -63240,10 +73468,20 @@ "type": "object", "properties": { "model_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Identifier for the trained model.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "model_type": { - "$ref": "#/components/schemas/ml._types.TrainedModelType" + "description": "The model type", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelType" + } + ] }, "tags": { "description": "A comma delimited string of tags. A trained model can have many tags, or none.", @@ -63253,7 +73491,12 @@ } }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "The Elasticsearch version number in which the trained model was created.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "compressed_definition": { "type": "string" @@ -63263,7 +73506,12 @@ "type": "string" }, "create_time": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The time when the trained model was created.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "default_field_map": { "description": "Any field map described in the inference configuration takes precedence.", @@ -63289,32 +73537,63 @@ "type": "boolean" }, "inference_config": { - "$ref": "#/components/schemas/ml._types.InferenceConfigCreateContainer" + "description": "The default configuration for inference. This can be either a regression, classification, or one of the many NLP focused configurations. It must match the underlying definition.trained_model's target_type. For pre-packaged models such as ELSER the config is not required.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.InferenceConfigCreateContainer" + } + ] }, "input": { - "$ref": "#/components/schemas/ml._types.TrainedModelConfigInput" + "description": "The input field names for the model definition.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelConfigInput" + } + ] }, "license_level": { "description": "The license level of the trained model.", "type": "string" }, "metadata": { - "$ref": "#/components/schemas/ml._types.TrainedModelConfigMetadata" + "description": "An object containing metadata about the trained model. For example, models created by data frame analytics contain analysis_config and input objects.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelConfigMetadata" + } + ] }, "model_size_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "model_package": { - "$ref": "#/components/schemas/ml._types.ModelPackageConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ModelPackageConfig" + } + ] }, "location": { - "$ref": "#/components/schemas/ml._types.TrainedModelLocation" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelLocation" + } + ] }, "platform_architecture": { "type": "string" }, "prefix_strings": { - "$ref": "#/components/schemas/ml._types.TrainedModelPrefixStrings" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelPrefixStrings" + } + ] } }, "required": [ @@ -63336,37 +73615,99 @@ "type": "object", "properties": { "regression": { - "$ref": "#/components/schemas/ml._types.RegressionInferenceOptions" + "description": "Regression configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.RegressionInferenceOptions" + } + ] }, "classification": { - "$ref": "#/components/schemas/ml._types.ClassificationInferenceOptions" + "description": "Classification configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ClassificationInferenceOptions" + } + ] }, "text_classification": { - "$ref": "#/components/schemas/ml._types.TextClassificationInferenceOptions" + "description": "Text classification configuration for inference.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TextClassificationInferenceOptions" + } + ] }, "zero_shot_classification": { - "$ref": "#/components/schemas/ml._types.ZeroShotClassificationInferenceOptions" + "description": "Zeroshot classification configuration for inference.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ZeroShotClassificationInferenceOptions" + } + ] }, "fill_mask": { - "$ref": "#/components/schemas/ml._types.FillMaskInferenceOptions" + "description": "Fill mask configuration for inference.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.FillMaskInferenceOptions" + } + ] }, "learning_to_rank": { - "$ref": "#/components/schemas/ml._types.LearningToRankConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.LearningToRankConfig" + } + ] }, "ner": { - "$ref": "#/components/schemas/ml._types.NerInferenceOptions" + "description": "Named entity recognition configuration for inference.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NerInferenceOptions" + } + ] }, "pass_through": { - "$ref": "#/components/schemas/ml._types.PassThroughInferenceOptions" + "description": "Pass through configuration for inference.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.PassThroughInferenceOptions" + } + ] }, "text_embedding": { - "$ref": "#/components/schemas/ml._types.TextEmbeddingInferenceOptions" + "description": "Text embedding configuration for inference.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TextEmbeddingInferenceOptions" + } + ] }, "text_expansion": { - "$ref": "#/components/schemas/ml._types.TextExpansionInferenceOptions" + "description": "Text expansion configuration for inference.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TextExpansionInferenceOptions" + } + ] }, "question_answering": { - "$ref": "#/components/schemas/ml._types.QuestionAnsweringInferenceOptions" + "description": "Question answering configuration for inference.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.QuestionAnsweringInferenceOptions" + } + ] } }, "minProperties": 1, @@ -63381,7 +73722,12 @@ "type": "number" }, "tokenization": { - "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + "description": "The tokenization options", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", @@ -63395,7 +73741,11 @@ } }, "vocabulary": { - "$ref": "#/components/schemas/ml._types.Vocabulary" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Vocabulary" + } + ] } } }, @@ -63404,19 +73754,45 @@ "type": "object", "properties": { "bert": { - "$ref": "#/components/schemas/ml._types.NlpBertTokenizationConfig" + "description": "Indicates BERT tokenization and its options", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NlpBertTokenizationConfig" + } + ] }, "bert_ja": { - "$ref": "#/components/schemas/ml._types.NlpBertTokenizationConfig" + "description": "Indicates BERT Japanese tokenization and its options", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NlpBertTokenizationConfig" + } + ] }, "mpnet": { - "$ref": "#/components/schemas/ml._types.NlpBertTokenizationConfig" + "description": "Indicates MPNET tokenization and its options", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NlpBertTokenizationConfig" + } + ] }, "roberta": { - "$ref": "#/components/schemas/ml._types.NlpRobertaTokenizationConfig" + "description": "Indicates RoBERTa tokenization and its options", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NlpRobertaTokenizationConfig" + } + ] }, "xlm_roberta": { - "$ref": "#/components/schemas/ml._types.XlmRobertaTokenizationConfig" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.XlmRobertaTokenizationConfig" + } + ] } }, "minProperties": 1, @@ -63452,7 +73828,13 @@ "type": "number" }, "truncate": { - "$ref": "#/components/schemas/ml._types.TokenizationTruncate" + "description": "Should tokenization input be automatically truncated before sending to the model for inference", + "default": "first", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TokenizationTruncate" + } + ] }, "with_special_tokens": { "description": "Is tokenization completed with special tokens", @@ -63501,7 +73883,11 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] } }, "required": [ @@ -63513,7 +73899,12 @@ "type": "object", "properties": { "tokenization": { - "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + "description": "The tokenization options to update when inferring", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + } + ] }, "hypothesis_template": { "description": "Hypothesis template used when tokenizing labels for prediction", @@ -63561,14 +73952,23 @@ "type": "number" }, "tokenization": { - "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + "description": "The tokenization options to update when inferring", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", "type": "string" }, "vocabulary": { - "$ref": "#/components/schemas/ml._types.Vocabulary" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Vocabulary" + } + ] } }, "required": [ @@ -63618,7 +74018,11 @@ "type": "string" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } }, "required": [ @@ -63631,7 +74035,12 @@ "type": "object", "properties": { "tokenization": { - "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + "description": "The tokenization options", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", @@ -63645,7 +74054,11 @@ } }, "vocabulary": { - "$ref": "#/components/schemas/ml._types.Vocabulary" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Vocabulary" + } + ] } } }, @@ -63654,14 +74067,23 @@ "type": "object", "properties": { "tokenization": { - "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + "description": "The tokenization options", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", "type": "string" }, "vocabulary": { - "$ref": "#/components/schemas/ml._types.Vocabulary" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Vocabulary" + } + ] } } }, @@ -63674,14 +74096,23 @@ "type": "number" }, "tokenization": { - "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + "description": "The tokenization options", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", "type": "string" }, "vocabulary": { - "$ref": "#/components/schemas/ml._types.Vocabulary" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Vocabulary" + } + ] } }, "required": [ @@ -63693,14 +74124,23 @@ "type": "object", "properties": { "tokenization": { - "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + "description": "The tokenization options", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", "type": "string" }, "vocabulary": { - "$ref": "#/components/schemas/ml._types.Vocabulary" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Vocabulary" + } + ] } }, "required": [ @@ -63716,7 +74156,12 @@ "type": "number" }, "tokenization": { - "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + "description": "The tokenization options to update when inferring", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", @@ -63783,7 +74228,12 @@ "type": "number" }, "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "Name of the hyperparameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "relative_importance": { "description": "A number between 0 and 1 showing the proportion of influence on the variation of the loss function among all tuned hyperparameters. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization.", @@ -63808,7 +74258,12 @@ "type": "object", "properties": { "feature_name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The feature for which this importance was calculated.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "importance": { "description": "A collection of feature importance statistics related to the training data set for this particular feature.", @@ -63857,7 +74312,12 @@ "type": "object", "properties": { "class_name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The target class value. Could be a string, boolean, or number.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "importance": { "description": "A collection of feature importance statistics related to the training data set for this particular feature.", @@ -63876,7 +74336,11 @@ "type": "object", "properties": { "create_time": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "description": { "type": "string" @@ -63888,7 +74352,11 @@ } }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "minimum_version": { "type": "string" @@ -63900,16 +74368,28 @@ "type": "string" }, "packaged_model_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "platform_architecture": { "type": "string" }, "prefix_strings": { - "$ref": "#/components/schemas/ml._types.TrainedModelPrefixStrings" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelPrefixStrings" + } + ] }, "size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "sha256": { "type": "string" @@ -63945,7 +74425,11 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/ml._types.TrainedModelLocationIndex" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelLocationIndex" + } + ] } }, "required": [ @@ -63956,7 +74440,11 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] } }, "required": [ @@ -63967,10 +74455,20 @@ "type": "object", "properties": { "deployment_stats": { - "$ref": "#/components/schemas/ml._types.TrainedModelDeploymentStats" + "description": "A collection of deployment stats, which is present when the models are deployed.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelDeploymentStats" + } + ] }, "inference_stats": { - "$ref": "#/components/schemas/ml._types.TrainedModelInferenceStats" + "description": "A collection of inference stats fields.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelInferenceStats" + } + ] }, "ingest": { "description": "A collection of ingest stats for the model across all nodes.\nThe values are summations of the individual node statistics.\nThe format matches the ingest section in the nodes stats API.", @@ -63980,10 +74478,20 @@ } }, "model_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The unique identifier of the trained model.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "model_size_stats": { - "$ref": "#/components/schemas/ml._types.TrainedModelSizeStats" + "description": "A collection of model size stats.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelSizeStats" + } + ] }, "pipeline_count": { "description": "The number of ingest pipelines that currently refer to the model.", @@ -64000,16 +74508,34 @@ "type": "object", "properties": { "adaptive_allocations": { - "$ref": "#/components/schemas/ml._types.AdaptiveAllocationsSettings" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AdaptiveAllocationsSettings" + } + ] }, "allocation_status": { - "$ref": "#/components/schemas/ml._types.TrainedModelDeploymentAllocationStatus" + "description": "The detailed allocation status for the deployment.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelDeploymentAllocationStatus" + } + ] }, "cache_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "deployment_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The unique identifier for the trained model deployment.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "error_count": { "description": "The sum of `error_count` for all nodes in the deployment.", @@ -64020,7 +74546,12 @@ "type": "number" }, "model_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The unique identifier for the trained model.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "nodes": { "description": "The deployment stats for each node that currently has the model allocated.\nIn serverless, stats are reported for a single unnamed virtual node.", @@ -64037,7 +74568,11 @@ "type": "number" }, "priority": { - "$ref": "#/components/schemas/ml._types.TrainingPriority" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainingPriority" + } + ] }, "queue_capacity": { "description": "The number of inference requests that can be queued before new requests are rejected.", @@ -64052,10 +74587,20 @@ "type": "string" }, "start_time": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The epoch timestamp when the deployment started.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "state": { - "$ref": "#/components/schemas/ml._types.DeploymentAssignmentState" + "description": "The overall state of the deployment.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DeploymentAssignmentState" + } + ] }, "threads_per_allocation": { "description": "The number of threads used be each allocation during inference.", @@ -64103,7 +74648,12 @@ "type": "number" }, "state": { - "$ref": "#/components/schemas/ml._types.DeploymentAllocationState" + "description": "The detailed allocation state related to the nodes.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DeploymentAllocationState" + } + ] }, "target_allocation_count": { "description": "The desired number of nodes for model allocation.", @@ -64128,13 +74678,27 @@ "type": "object", "properties": { "average_inference_time_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "description": "The average time for each inference call to complete on this node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] }, "average_inference_time_ms_last_minute": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] }, "average_inference_time_ms_excluding_cache_hits": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "description": "The average time for each inference call to complete on this node, excluding cache", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] }, "error_count": { "description": "The number of errors when evaluating the trained model.", @@ -64151,7 +74715,12 @@ "type": "number" }, "last_access": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The epoch time stamp of the last inference call for the model on this node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "number_of_allocations": { "description": "The number of allocations assigned to this node.", @@ -64169,10 +74738,20 @@ "type": "number" }, "routing_state": { - "$ref": "#/components/schemas/ml._types.TrainedModelAssignmentRoutingStateAndReason" + "description": "The current routing state and reason for the current routing state for this allocation.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelAssignmentRoutingStateAndReason" + } + ] }, "start_time": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The epoch timestamp when the allocation started.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "threads_per_allocation": { "description": "The number of threads used by each allocation during inference.", @@ -64200,7 +74779,12 @@ "type": "string" }, "routing_state": { - "$ref": "#/components/schemas/ml._types.RoutingState" + "description": "The current routing state.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.RoutingState" + } + ] } }, "required": [ @@ -64253,7 +74837,12 @@ "type": "number" }, "timestamp": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The time when the statistics were last updated.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] } }, "required": [ @@ -64268,10 +74857,20 @@ "type": "object", "properties": { "model_size_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The size of the model in bytes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "required_native_memory_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The amount of memory required to load the model in bytes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] } }, "required": [ @@ -64283,34 +74882,84 @@ "type": "object", "properties": { "regression": { - "$ref": "#/components/schemas/ml._types.RegressionInferenceOptions" + "description": "Regression configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.RegressionInferenceOptions" + } + ] }, "classification": { - "$ref": "#/components/schemas/ml._types.ClassificationInferenceOptions" + "description": "Classification configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ClassificationInferenceOptions" + } + ] }, "text_classification": { - "$ref": "#/components/schemas/ml._types.TextClassificationInferenceUpdateOptions" + "description": "Text classification configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TextClassificationInferenceUpdateOptions" + } + ] }, "zero_shot_classification": { - "$ref": "#/components/schemas/ml._types.ZeroShotClassificationInferenceUpdateOptions" + "description": "Zeroshot classification configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ZeroShotClassificationInferenceUpdateOptions" + } + ] }, "fill_mask": { - "$ref": "#/components/schemas/ml._types.FillMaskInferenceUpdateOptions" + "description": "Fill mask configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.FillMaskInferenceUpdateOptions" + } + ] }, "ner": { - "$ref": "#/components/schemas/ml._types.NerInferenceUpdateOptions" + "description": "Named entity recognition configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NerInferenceUpdateOptions" + } + ] }, "pass_through": { - "$ref": "#/components/schemas/ml._types.PassThroughInferenceUpdateOptions" + "description": "Pass through configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.PassThroughInferenceUpdateOptions" + } + ] }, "text_embedding": { - "$ref": "#/components/schemas/ml._types.TextEmbeddingInferenceUpdateOptions" + "description": "Text embedding configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TextEmbeddingInferenceUpdateOptions" + } + ] }, "text_expansion": { - "$ref": "#/components/schemas/ml._types.TextExpansionInferenceUpdateOptions" + "description": "Text expansion configuration for inference.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TextExpansionInferenceUpdateOptions" + } + ] }, "question_answering": { - "$ref": "#/components/schemas/ml._types.QuestionAnsweringInferenceUpdateOptions" + "description": "Question answering configuration for inference", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.QuestionAnsweringInferenceUpdateOptions" + } + ] } }, "minProperties": 1, @@ -64324,7 +74973,12 @@ "type": "number" }, "tokenization": { - "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + "description": "The tokenization options to update when inferring", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", @@ -64343,7 +74997,12 @@ "type": "object", "properties": { "truncate": { - "$ref": "#/components/schemas/ml._types.TokenizationTruncate" + "description": "Truncate options to apply", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TokenizationTruncate" + } + ] }, "span": { "description": "Span options to apply", @@ -64355,7 +75014,12 @@ "type": "object", "properties": { "tokenization": { - "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + "description": "The tokenization options to update when inferring", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", @@ -64385,7 +75049,12 @@ "type": "number" }, "tokenization": { - "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + "description": "The tokenization options to update when inferring", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", @@ -64397,7 +75066,12 @@ "type": "object", "properties": { "tokenization": { - "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + "description": "The tokenization options to update when inferring", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", @@ -64409,7 +75083,12 @@ "type": "object", "properties": { "tokenization": { - "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + "description": "The tokenization options to update when inferring", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", @@ -64421,7 +75100,11 @@ "type": "object", "properties": { "tokenization": { - "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", @@ -64433,7 +75116,11 @@ "type": "object", "properties": { "tokenization": { - "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", @@ -64453,7 +75140,12 @@ "type": "number" }, "tokenization": { - "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + "description": "The tokenization options to update when inferring", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions" + } + ] }, "results_field": { "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", @@ -64626,10 +75318,18 @@ "type": "object", "properties": { "source": { - "$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource" + } + ] }, "analysis": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer" + } + ] }, "model_memory_limit": { "type": "string" @@ -64638,7 +75338,11 @@ "type": "number" }, "analyzed_fields": { - "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields" + } + ] } }, "required": [ @@ -64657,38 +75361,87 @@ } }, "chunking_config": { - "$ref": "#/components/schemas/ml._types.ChunkingConfig" + "description": "Datafeeds might be required to search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated and is an advanced configuration option.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ChunkingConfig" + } + ] }, "datafeed_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. The default value is the job identifier.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "delayed_data_check_config": { - "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig" + "description": "Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that the `query_delay` option is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig" + } + ] }, "frequency": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: `150s`. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "indices": { - "$ref": "#/components/schemas/_types.Indices" + "description": "An array of index names. Wildcards are supported. If any indices are in remote clusters, the machine learning nodes must have the `remote_cluster_client` role.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "indices_options": { - "$ref": "#/components/schemas/_types.IndicesOptions" + "description": "Specifies index expansion options that are used during search.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndicesOptions" + } + ] }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "max_empty_searches": { "description": "If a real-time datafeed has never seen any data (including during any initial training period) then it will automatically stop itself and close its associated job after this many real-time searches that return no documents. In other words, it will stop after `frequency` times `max_empty_searches` of real-time operation. If not set then a datafeed with no end time that sees no data will remain started until it is explicitly stopped.", "type": "number" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "query_delay": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between `60s` and `120s`. This randomness improves the query performance when there are multiple jobs running on the same node.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "description": "Specifies runtime fields for the datafeed search.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "script_fields": { "description": "Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields.", @@ -64713,16 +75466,36 @@ "type": "boolean" }, "analysis_config": { - "$ref": "#/components/schemas/ml._types.AnalysisConfig" + "description": "The analysis configuration, which specifies how to analyze the data.\nAfter you create a job, you cannot change the analysis configuration; all the properties are informational.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AnalysisConfig" + } + ] }, "analysis_limits": { - "$ref": "#/components/schemas/ml._types.AnalysisLimits" + "description": "Limits can be applied for the resources required to hold the mathematical models in memory.\nThese limits are approximate and can be set per job.\nThey do not control the memory used by other processes, for example the Elasticsearch Java processes.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.AnalysisLimits" + } + ] }, "background_persist_interval": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Advanced configuration option.\nThe time between each periodic persistence of the model.\nThe default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time.\nThe smallest allowed value is 1 hour.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "custom_settings": { - "$ref": "#/components/schemas/ml._types.CustomSettings" + "description": "Advanced configuration option.\nContains custom metadata about the job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.CustomSettings" + } + ] }, "daily_model_snapshot_retention_after_days": { "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job.\nIt specifies a period of time (in days) after which only the first snapshot per day is retained.\nThis period is relative to the timestamp of the most recent snapshot for this job.", @@ -64730,10 +75503,20 @@ "type": "number" }, "data_description": { - "$ref": "#/components/schemas/ml._types.DataDescription" + "description": "The data description defines the format of the input data when you send data to the job by using the post data API.\nNote that when configure a datafeed, these properties are automatically set.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DataDescription" + } + ] }, "datafeed_config": { - "$ref": "#/components/schemas/ml._types.DatafeedConfig" + "description": "The datafeed, which retrieves data from Elasticsearch for analysis by the job.\nYou can associate only one datafeed with each anomaly detection job.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DatafeedConfig" + } + ] }, "description": { "description": "A description of the job.", @@ -64747,14 +75530,24 @@ } }, "job_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Identifier for the anomaly detection job.\nThis identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.\nIt must start and end with alphanumeric characters.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "job_type": { "description": "Reserved for future use, currently set to `anomaly_detector`.", "type": "string" }, "model_plot_config": { - "$ref": "#/components/schemas/ml._types.ModelPlotConfig" + "description": "This advanced configuration option stores model information along with the results.\nIt provides a more detailed view into anomaly detection.\nModel plot provides a simplified and indicative view of the model and its bounds.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ModelPlotConfig" + } + ] }, "model_snapshot_retention_days": { "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job.\nIt specifies the maximum period of time (in days) that snapshots are retained.\nThis period is relative to the timestamp of the most recent snapshot for this job.\nThe default value is `10`, which means snapshots ten days older than the newest snapshot are deleted.", @@ -64766,7 +75559,13 @@ "type": "number" }, "results_index_name": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "A text string that affects the name of the machine learning results index.\nThe default value is `shared`, which generates an index named `.ml-anomalies-shared`.", + "default": "shared", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "results_retention_days": { "description": "Advanced configuration option.\nThe period of time (in days) that results are retained.\nAge is calculated relative to the timestamp of the latest bucket result.\nIf this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch.\nThe default value is null, which means all results are retained.\nAnnotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results.\nAnnotations added by users are retained forever.", @@ -64798,13 +75597,29 @@ "type": "object", "properties": { "bucket_span": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The size of the interval that the analysis is aggregated into, typically between `5m` and `1h`.", + "default": "5m", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "categorization_analyzer": { - "$ref": "#/components/schemas/ml._types.CategorizationAnalyzer" + "description": "If `categorization_field_name` is specified, you can also define the analyzer that is used to interpret the categorization field.\nThis property cannot be used at the same time as `categorization_filters`.\nThe categorization analyzer specifies how the `categorization_field` is interpreted by the categorization process.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.CategorizationAnalyzer" + } + ] }, "categorization_field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "If this property is specified, the values of the specified field will be categorized.\nThe resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "categorization_filters": { "description": "If `categorization_field_name` is specified, you can also define optional filters.\nThis property expects an array of regular expressions.\nThe expressions are used to filter out matching sequences from the categorization field values.", @@ -64828,20 +75643,41 @@ } }, "model_prune_window": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Advanced configuration option.\nAffects the pruning of models that have not been updated for the given time duration.\nThe value must be set to a multiple of the `bucket_span`.\nIf set too low, important information may be removed from the model.\nTypically, set to `30d` or longer.\nIf not set, model pruning only occurs if the model memory status reaches the soft limit or the hard limit.\nFor jobs created in 8.1 and later, the default value is the greater of `30d` or 20 times `bucket_span`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "latency": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The size of the window in which to expect data that is out of time order.\nDefaults to no latency.\nIf you specify a non-zero value, it must be greater than or equal to one second.", + "default": "0", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "multivariate_by_fields": { "description": "This functionality is reserved for internal use.\nIt is not supported for use in customer environments and is not subject to the support SLA of official GA features.\nIf set to `true`, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold.", "type": "boolean" }, "per_partition_categorization": { - "$ref": "#/components/schemas/ml._types.PerPartitionCategorization" + "description": "Settings related to how categorization interacts with partition fields.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.PerPartitionCategorization" + } + ] }, "summary_count_field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "If this property is specified, the data that is fed to the job is expected to be pre-summarized.\nThis property value is the name of the field that contains the count of raw data points that have been summarized.\nThe same `summary_count_field_name` applies to all detectors in the job.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -64854,7 +75690,12 @@ "type": "object", "properties": { "by_field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field used to split the data.\nIn particular, this property is used for analyzing the splits with respect to their own history.\nIt is used for finding unusual values in the context of the split.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "custom_rules": { "description": "An array of custom rule objects, which enable you to customize the way detectors operate.\nFor example, a rule may dictate to the detector conditions under which results should be skipped.\nKibana refers to custom rules as job rules.", @@ -64872,20 +75713,40 @@ "type": "number" }, "exclude_frequent": { - "$ref": "#/components/schemas/ml._types.ExcludeFrequent" + "description": "Contains one of the following values: `all`, `none`, `by`, or `over`.\nIf set, frequent entities are excluded from influencing the anomaly results.\nEntities can be considered frequent over time or frequent in a population.\nIf you are working with both over and by fields, then you can set `exclude_frequent` to all for both fields, or to `by` or `over` for those specific fields.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ExcludeFrequent" + } + ] }, "field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field that the detector uses in the function.\nIf you use an event rate function such as `count` or `rare`, do not specify this field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "function": { "description": "The analysis function that is used.\nFor example, `count`, `rare`, `mean`, `min`, `max`, and `sum`.", "type": "string" }, "over_field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field used to split the data.\nIn particular, this property is used for analyzing the splits with respect to the history of all splits.\nIt is used for finding unusual values in the population of all splits.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "partition_field_name": { - "$ref": "#/components/schemas/_types.Field" + "description": "The field used to segment the analysis.\nWhen you use this property, you have completely independent baselines for each value of this field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "use_null": { "description": "Defines whether a new series is used as the null series when there is no value for the by or partition fields.", @@ -64908,7 +75769,12 @@ } }, "trained_model": { - "$ref": "#/components/schemas/ml.put_trained_model.TrainedModel" + "description": "The definition of the trained model.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.TrainedModel" + } + ] } }, "required": [ @@ -64919,13 +75785,25 @@ "type": "object", "properties": { "frequency_encoding": { - "$ref": "#/components/schemas/ml.put_trained_model.FrequencyEncodingPreprocessor" + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.FrequencyEncodingPreprocessor" + } + ] }, "one_hot_encoding": { - "$ref": "#/components/schemas/ml.put_trained_model.OneHotEncodingPreprocessor" + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.OneHotEncodingPreprocessor" + } + ] }, "target_mean_encoding": { - "$ref": "#/components/schemas/ml.put_trained_model.TargetMeanEncodingPreprocessor" + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.TargetMeanEncodingPreprocessor" + } + ] } }, "minProperties": 1, @@ -65001,13 +75879,28 @@ "type": "object", "properties": { "tree": { - "$ref": "#/components/schemas/ml.put_trained_model.TrainedModelTree" + "description": "The definition for a binary decision tree.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.TrainedModelTree" + } + ] }, "tree_node": { - "$ref": "#/components/schemas/ml.put_trained_model.TrainedModelTreeNode" + "description": "The definition of a node in a tree.\nThere are two major types of nodes: leaf nodes and not-leaf nodes.\n- Leaf nodes only need node_index and leaf_value defined.\n- All other nodes need split_feature, left_child, right_child, threshold, decision_type, and default_left defined.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.TrainedModelTreeNode" + } + ] }, "ensemble": { - "$ref": "#/components/schemas/ml.put_trained_model.Ensemble" + "description": "The definition for an ensemble model", + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.Ensemble" + } + ] } } }, @@ -65080,7 +75973,11 @@ "type": "object", "properties": { "aggregate_output": { - "$ref": "#/components/schemas/ml.put_trained_model.AggregateOutput" + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.AggregateOutput" + } + ] }, "classification_labels": { "type": "array", @@ -65112,16 +76009,32 @@ "type": "object", "properties": { "logistic_regression": { - "$ref": "#/components/schemas/ml.put_trained_model.Weights" + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.Weights" + } + ] }, "weighted_sum": { - "$ref": "#/components/schemas/ml.put_trained_model.Weights" + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.Weights" + } + ] }, "weighted_mode": { - "$ref": "#/components/schemas/ml.put_trained_model.Weights" + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.Weights" + } + ] }, "exponent": { - "$ref": "#/components/schemas/ml.put_trained_model.Weights" + "allOf": [ + { + "$ref": "#/components/schemas/ml.put_trained_model.Weights" + } + ] } } }, @@ -65140,7 +76053,11 @@ "type": "object", "properties": { "field_names": { - "$ref": "#/components/schemas/_types.Names" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Names" + } + ] } }, "required": [ @@ -65175,7 +76092,12 @@ ] }, "assignment_state": { - "$ref": "#/components/schemas/ml._types.DeploymentAssignmentState" + "description": "The overall assignment state.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DeploymentAssignmentState" + } + ] }, "max_assigned_allocations": { "type": "number" @@ -65191,10 +76113,19 @@ } }, "start_time": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "The timestamp when the deployment started.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "task_parameters": { - "$ref": "#/components/schemas/ml._types.TrainedModelAssignmentTaskParameters" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainedModelAssignmentTaskParameters" + } + ] } }, "required": [ @@ -65212,7 +76143,12 @@ "type": "string" }, "routing_state": { - "$ref": "#/components/schemas/ml._types.RoutingState" + "description": "The current routing state.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.RoutingState" + } + ] }, "current_allocations": { "description": "Current number of allocations.", @@ -65233,29 +76169,62 @@ "type": "object", "properties": { "model_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The size of the trained model in bytes.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "model_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The unique identifier for the trained model.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "deployment_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The unique identifier for the trained model deployment.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "cache_size": { - "$ref": "#/components/schemas/_types.ByteSize" + "description": "The size of the trained model cache.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "number_of_allocations": { "description": "The total number of allocations this model is assigned across ML nodes.", "type": "number" }, "priority": { - "$ref": "#/components/schemas/ml._types.TrainingPriority" + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TrainingPriority" + } + ] }, "per_deployment_memory_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "per_allocation_memory_bytes": { - "$ref": "#/components/schemas/_types.ByteSize" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ByteSize" + } + ] }, "queue_capacity": { "description": "Number of inference requests are allowed in the queue at a time.", @@ -65331,13 +76300,21 @@ "type": "boolean" }, "expand_wildcards": { - "$ref": "#/components/schemas/_types.ExpandWildcards" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ExpandWildcards" + } + ] }, "ignore_unavailable": { "type": "boolean" }, "index": { - "$ref": "#/components/schemas/_types.Indices" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "preference": { "type": "string" @@ -65346,10 +76323,18 @@ "type": "boolean" }, "routing": { - "$ref": "#/components/schemas/_types.Routing" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "search_type": { - "$ref": "#/components/schemas/_types.SearchType" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SearchType" + } + ] }, "ccs_minimize_roundtrips": { "type": "boolean" @@ -65417,10 +76402,20 @@ "type": "boolean" }, "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "description": "A count of shards used for the request.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] }, "hits": { - "$ref": "#/components/schemas/_global.search._types.HitsMetadata" + "description": "The returned documents and metadata.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.HitsMetadata" + } + ] }, "aggregations": { "type": "object", @@ -65429,7 +76424,11 @@ } }, "_clusters": { - "$ref": "#/components/schemas/_types.ClusterStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ClusterStatistics" + } + ] }, "fields": { "type": "object", @@ -65444,13 +76443,29 @@ "type": "number" }, "profile": { - "$ref": "#/components/schemas/_global.search._types.Profile" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.Profile" + } + ] }, "pit_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_scroll_id": { - "$ref": "#/components/schemas/_types.ScrollId" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results" + }, + "description": "The identifier for the search and its search context.\nYou can use this scroll ID with the scroll API to retrieve the next batch of search results for the request.\nThis property is returned only if the `scroll` query parameter is specified in the request.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScrollId" + } + ] }, "suggest": { "type": "object", @@ -65477,7 +76492,11 @@ "type": "object", "properties": { "error": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] }, "status": { "type": "number" @@ -65507,7 +76526,12 @@ "type": "boolean" }, "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The ID of the search template to use. If no `source` is specified,\nthis parameter is required.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "params": { "description": "Key-value pairs used to replace Mustache variables in the template.\nThe key is the variable name.\nThe value is the variable value.", @@ -65522,7 +76546,12 @@ "type": "boolean" }, "source": { - "$ref": "#/components/schemas/_types.ScriptSource" + "description": "An inline search template. Supports the same parameters as the search API's\nrequest body. It also supports Mustache variables. If no `id` is specified, this\nparameter is required.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptSource" + } + ] } } }, @@ -65530,17 +76559,32 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The ID of the document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The index of the document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "doc": { "description": "An artificial document (a document not present in the index) for which you want to retrieve term vectors.", "type": "object" }, "fields": { - "$ref": "#/components/schemas/_types.Fields" + "description": "Comma-separated list or wildcard expressions of fields to include in the statistics.\nUsed as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "field_statistics": { "description": "If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies.", @@ -65548,7 +76592,12 @@ "type": "boolean" }, "filter": { - "$ref": "#/components/schemas/_global.termvectors.Filter" + "description": "Filter terms based on their tf-idf scores.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.termvectors.Filter" + } + ] }, "offsets": { "description": "If `true`, the response includes term offsets.", @@ -65566,7 +76615,12 @@ "type": "boolean" }, "routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "Custom value used to route operations to a specific shard.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "term_statistics": { "description": "If true, the response includes term frequency and document frequency.", @@ -65574,10 +76628,20 @@ "type": "boolean" }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "If `true`, returns the document version as part of a hit.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "version_type": { - "$ref": "#/components/schemas/_types.VersionType" + "description": "Specific version type.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionType" + } + ] } } }, @@ -65623,13 +76687,25 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "_version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "took": { "type": "number" @@ -65644,7 +76720,11 @@ } }, "error": { - "$ref": "#/components/schemas/_types.ErrorCause" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ErrorCause" + } + ] } }, "required": [ @@ -65655,7 +76735,11 @@ "type": "object", "properties": { "field_statistics": { - "$ref": "#/components/schemas/_global.termvectors.FieldStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_global.termvectors.FieldStatistics" + } + ] }, "terms": { "type": "object", @@ -65737,10 +76821,20 @@ "type": "object", "properties": { "rule_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "A unique identifier for the rule.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "type": { - "$ref": "#/components/schemas/query_rules._types.QueryRuleType" + "description": "The type of rule.\n`pinned` will identify and pin specific documents to the top of search results.\n`exclude` will exclude specific documents from search results.", + "allOf": [ + { + "$ref": "#/components/schemas/query_rules._types.QueryRuleType" + } + ] }, "criteria": { "description": "The criteria that must be met for the rule to be applied.\nIf multiple criteria are specified for a rule, all criteria must be met for the rule to be applied.", @@ -65757,7 +76851,12 @@ ] }, "actions": { - "$ref": "#/components/schemas/query_rules._types.QueryRuleActions" + "description": "The actions to take when the rule is matched.\nThe format of this action depends on the rule type.", + "allOf": [ + { + "$ref": "#/components/schemas/query_rules._types.QueryRuleActions" + } + ] }, "priority": { "type": "number" @@ -65781,7 +76880,12 @@ "type": "object", "properties": { "type": { - "$ref": "#/components/schemas/query_rules._types.QueryRuleCriteriaType" + "description": "The type of criteria. The following criteria types are supported:\n\n* `always`: Matches all queries, regardless of input.\n* `contains`: Matches that contain this value anywhere in the field meet the criteria defined by the rule. Only applicable for string values.\n* `exact`: Only exact matches meet the criteria defined by the rule. Applicable for string or numerical values.\n* `fuzzy`: Exact matches or matches within the allowed Levenshtein Edit Distance meet the criteria defined by the rule. Only applicable for string values.\n* `gt`: Matches with a value greater than this value meet the criteria defined by the rule. Only applicable for numerical values.\n* `gte`: Matches with a value greater than or equal to this value meet the criteria defined by the rule. Only applicable for numerical values.\n* `lt`: Matches with a value less than this value meet the criteria defined by the rule. Only applicable for numerical values.\n* `lte`: Matches with a value less than or equal to this value meet the criteria defined by the rule. Only applicable for numerical values.\n* `prefix`: Matches that start with this value meet the criteria defined by the rule. Only applicable for string values.\n* `suffix`: Matches that end with this value meet the criteria defined by the rule. Only applicable for string values.", + "allOf": [ + { + "$ref": "#/components/schemas/query_rules._types.QueryRuleCriteriaType" + } + ] }, "metadata": { "description": "The metadata field to match against.\nThis metadata will be used to match against `match_criteria` sent in the rule.\nIt is required for all criteria types except `always`.", @@ -65839,7 +76943,12 @@ "type": "object", "properties": { "ruleset_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "A unique identifier for the ruleset.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "rules": { "description": "Rules associated with the query ruleset.", @@ -65858,7 +76967,12 @@ "type": "object", "properties": { "ruleset_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "A unique identifier for the ruleset.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "rule_total_count": { "description": "The number of rules associated with the ruleset.", @@ -65890,10 +77004,20 @@ "type": "object", "properties": { "ruleset_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Ruleset unique identifier", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "rule_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Rule unique identifier within that ruleset", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] } }, "required": [ @@ -65905,10 +77029,20 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The search request’s ID, used to group result details later.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "request": { - "$ref": "#/components/schemas/_global.rank_eval.RankEvalQuery" + "description": "The query being evaluated.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.rank_eval.RankEvalQuery" + } + ] }, "ratings": { "description": "List of document ratings", @@ -65918,7 +77052,12 @@ } }, "template_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The search template Id", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "params": { "description": "The search template parameters.", @@ -65937,7 +77076,11 @@ "type": "object", "properties": { "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "size": { "type": "number" @@ -65951,10 +77094,20 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The document ID.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The document’s index. For data streams, this should be the document’s backing index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "rating": { "description": "The document’s relevance with regard to this search request.", @@ -65971,19 +77124,39 @@ "type": "object", "properties": { "precision": { - "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricPrecision" + "allOf": [ + { + "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricPrecision" + } + ] }, "recall": { - "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricRecall" + "allOf": [ + { + "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricRecall" + } + ] }, "mean_reciprocal_rank": { - "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricMeanReciprocalRank" + "allOf": [ + { + "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricMeanReciprocalRank" + } + ] }, "dcg": { - "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricDiscountedCumulativeGain" + "allOf": [ + { + "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricDiscountedCumulativeGain" + } + ] }, "expected_reciprocal_rank": { - "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricExpectedReciprocalRank" + "allOf": [ + { + "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricExpectedReciprocalRank" + } + ] } } }, @@ -66135,10 +77308,18 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] } }, "required": [ @@ -66150,7 +77331,11 @@ "type": "object", "properties": { "hit": { - "$ref": "#/components/schemas/_global.rank_eval.RankEvalHit" + "allOf": [ + { + "$ref": "#/components/schemas/_global.rank_eval.RankEvalHit" + } + ] }, "rating": { "oneOf": [ @@ -66172,10 +77357,18 @@ "type": "object", "properties": { "_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "_score": { "type": "number" @@ -66191,20 +77384,42 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The name of the data stream, index, or index alias you are copying to.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "op_type": { - "$ref": "#/components/schemas/_types.OpType" + "description": "If it is `create`, the operation will only index documents that do not already exist (also known as \"put if absent\").\n\nIMPORTANT: To reindex to a data stream destination, this argument must be `create`.", + "default": "index", + "allOf": [ + { + "$ref": "#/components/schemas/_types.OpType" + } + ] }, "pipeline": { "description": "The name of the pipeline to use.", "type": "string" }, "routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "By default, a document's routing is preserved unless it's changed by the script.\nIf it is `keep`, the routing on the bulk request sent for each match is set to the routing on the match.\nIf it is `discard`, the routing on the bulk request sent for each match is set to `null`.\nIf it is `=value`, the routing on the bulk request sent for each match is set to all value specified after the equals sign (`=`).", + "default": "keep", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "version_type": { - "$ref": "#/components/schemas/_types.VersionType" + "description": "The versioning to use for the indexing operation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionType" + } + ] } }, "required": [ @@ -66215,13 +77430,28 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.Indices" + "description": "The name of the data stream, index, or alias you are copying from.\nIt accepts a comma-separated list to reindex from multiple sources.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "The documents to reindex, which is defined with Query DSL.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "remote": { - "$ref": "#/components/schemas/_global.reindex.RemoteSource" + "description": "A remote instance of Elasticsearch that you want to index from.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.reindex.RemoteSource" + } + ] }, "size": { "description": "The number of documents to index per batch.\nUse it when you are indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB.", @@ -66229,16 +77459,37 @@ "type": "number" }, "slice": { - "$ref": "#/components/schemas/_types.SlicedScroll" + "description": "Slice the reindex request manually using the provided slice ID and total number of slices.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SlicedScroll" + } + ] }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "deprecated": true, + "description": "A comma-separated list of `:` pairs to sort by before indexing.\nUse it in conjunction with `max_docs` to control what documents are reindexed.\n\nWARNING: Sort in reindex is deprecated.\nSorting in reindex was never guaranteed to index documents in order and prevents further development of reindex such as resilience and performance improvements.\nIf used in combination with `max_docs`, consider using a query filter instead.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] }, "_source": { - "$ref": "#/components/schemas/_types.Fields" + "description": "If `true`, reindex all source fields.\nSet it to a list to reindex select fields.", + "default": "true", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] } }, "required": [ @@ -66249,7 +77500,13 @@ "type": "object", "properties": { "connect_timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The remote connection timeout.", + "default": "30s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "headers": { "description": "An object containing the headers of the request.", @@ -66259,16 +77516,37 @@ } }, "host": { - "$ref": "#/components/schemas/_types.Host" + "description": "The URL for the remote instance of Elasticsearch that you want to index from.\nThis information is required when you're indexing from remote.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Host" + } + ] }, "username": { - "$ref": "#/components/schemas/_types.Username" + "description": "The username to use for authentication with the remote host.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Username" + } + ] }, "password": { - "$ref": "#/components/schemas/_types.Password" + "description": "The password to use for authentication with the remote host.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Password" + } + ] }, "socket_timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The remote socket read timeout.", + "default": "30s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } }, "required": [ @@ -66308,10 +77586,20 @@ "type": "object" }, "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "Index containing a mapping that's compatible with the indexed document.\nYou may specify a remote index by prefixing the index with the remote cluster alias.\nFor example, `remote1:my_index` indicates that you want to run the painless script against the \"my_index\" index on the \"remote1\" cluster.\nThis request will be forwarded to the \"remote1\" cluster if you have configured a connection to that remote cluster.\n\nNOTE: Wildcards are not accepted in the index expression for this endpoint.\nThe expression `*:myindex` will return the error \"No such remote cluster\" and the expression `logs*` or `remote1:logs*` will return the error \"index not found\".", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Use this parameter to specify a query for computing a score.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } }, "required": [ @@ -66328,10 +77616,20 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "Search Application name", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "updated_at_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "Last time the Search Application was updated.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] } }, "required": [ @@ -66352,10 +77650,20 @@ } }, "analytics_collection_name": { - "$ref": "#/components/schemas/_types.Name" + "description": "Analytics collection associated to the Search Application.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "template": { - "$ref": "#/components/schemas/search_application._types.SearchApplicationTemplate" + "description": "Search template to use on search operations.", + "allOf": [ + { + "$ref": "#/components/schemas/search_application._types.SearchApplicationTemplate" + } + ] } }, "required": [ @@ -66366,7 +77674,12 @@ "type": "object", "properties": { "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "The associated mustache template.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } }, "required": [ @@ -66377,7 +77690,12 @@ "type": "object", "properties": { "event_data_stream": { - "$ref": "#/components/schemas/search_application._types.EventDataStream" + "description": "Data stream for the collection.", + "allOf": [ + { + "$ref": "#/components/schemas/search_application._types.EventDataStream" + } + ] } }, "required": [ @@ -66388,7 +77706,11 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] } }, "required": [ @@ -66404,7 +77726,12 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "The name of the analytics collection created or updated", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] } }, "required": [ @@ -66441,10 +77768,18 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] } }, "required": [ @@ -66455,7 +77790,11 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "type": { "type": "string" @@ -66470,7 +77809,11 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "type": { "x-state": "Generally available", @@ -66506,7 +77849,12 @@ } }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Optional meta-data. Within the metadata object, keys that begin with `_` are reserved for system usage.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "run_as": { "externalDocs": { @@ -66523,7 +77871,12 @@ "type": "string" }, "restriction": { - "$ref": "#/components/schemas/security._types.Restriction" + "description": "Restriction for when the role descriptor is allowed to be effective.", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.Restriction" + } + ] }, "transient_metadata": { "type": "object", @@ -66578,7 +77931,15 @@ "type": "object", "properties": { "field_security": { - "$ref": "#/components/schemas/security._types.FieldSecurity" + "externalDocs": { + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level" + }, + "description": "The document fields that the owners of the role have read access to.", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.FieldSecurity" + } + ] }, "names": { "description": "A list of indices (or index name patterns) to which the permissions in this entry apply.", @@ -66602,7 +77963,12 @@ } }, "query": { - "$ref": "#/components/schemas/security._types.IndicesPrivilegesQuery" + "description": "A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role.", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.IndicesPrivilegesQuery" + } + ] } }, "required": [ @@ -66614,10 +77980,18 @@ "type": "object", "properties": { "except": { - "$ref": "#/components/schemas/_types.Fields" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "grant": { - "$ref": "#/components/schemas/_types.Fields" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] } } }, @@ -66667,7 +78041,15 @@ "type": "object", "properties": { "template": { - "$ref": "#/components/schemas/security._types.RoleTemplateScript" + "externalDocs": { + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level#templating-role-query" + }, + "description": "When you create a role, you can specify a query that defines the document level security permissions. You can optionally\nuse Mustache templates in the role query to insert the username of the current authenticated user into the role.\nLike other places in Elasticsearch that support templating or scripting, you can specify inline, stored, or file-based\ntemplates and define custom parameters. You access the details for the current authenticated user through the _user parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.RoleTemplateScript" + } + ] } } }, @@ -66675,10 +78057,19 @@ "type": "object", "properties": { "source": { - "$ref": "#/components/schemas/security._types.RoleTemplateInlineQuery" + "allOf": [ + { + "$ref": "#/components/schemas/security._types.RoleTemplateInlineQuery" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The `id` for a stored script.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "params": { "description": "Specifies any named parameters that are passed into the script as variables.\nUse parameters instead of hard-coded values to decrease compile time.", @@ -66688,7 +78079,13 @@ } }, "lang": { - "$ref": "#/components/schemas/_types.ScriptLanguage" + "description": "Specifies the language the script is written in.", + "default": "painless", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptLanguage" + } + ] }, "options": { "type": "object", @@ -66768,29 +78165,66 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Id for the API key", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "Name of the API key.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "type": { - "$ref": "#/components/schemas/security._types.ApiKeyType" + "description": "The type of the API key (e.g. `rest` or `cross_cluster`).", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.ApiKeyType" + } + ] }, "creation": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "Creation time for the API key in milliseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "expiration": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "Expiration time for the API key in milliseconds.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "invalidated": { "description": "Invalidation status for the API key.\nIf the key has been invalidated, it has a value of `true`. Otherwise, it is `false`.", "type": "boolean" }, "invalidation": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "If the key has been invalidated, invalidation time in milliseconds.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "username": { - "$ref": "#/components/schemas/_types.Username" + "description": "Principal for which this API key was created", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Username" + } + ] }, "realm": { "description": "Realm name of the principal for which this API key was created.", @@ -66802,7 +78236,13 @@ "type": "string" }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Metadata of the API key", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "role_descriptors": { "description": "The role descriptors assigned to this API key when it was created or last updated.\nAn empty role descriptor means the API key inherits the owner user’s permissions.", @@ -66823,7 +78263,13 @@ } }, "access": { - "$ref": "#/components/schemas/security._types.Access" + "description": "The access granted to cross-cluster API keys.\nThe access is composed of permissions for cross cluster search and cross cluster replication.\nAt least one of them must be specified.\nWhen specified, the new access assignment fully replaces the previously assigned access.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.Access" + } + ] }, "profile_uid": { "description": "The profile uid for the API key owner principal, if requested and if it exists", @@ -66831,7 +78277,12 @@ "type": "string" }, "_sort": { - "$ref": "#/components/schemas/_types.SortResults" + "description": "Sorting values when using the `sort` parameter with the `security.query_api_keys` API.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortResults" + } + ] } }, "required": [ @@ -66902,7 +78353,15 @@ "type": "object", "properties": { "field_security": { - "$ref": "#/components/schemas/security._types.FieldSecurity" + "externalDocs": { + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level" + }, + "description": "The document fields that the owners of the role have read access to.", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.FieldSecurity" + } + ] }, "names": { "description": "A list of indices (or index name patterns) to which the permissions in this entry apply.", @@ -66919,7 +78378,12 @@ ] }, "query": { - "$ref": "#/components/schemas/security._types.IndicesPrivilegesQuery" + "description": "A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role.", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.IndicesPrivilegesQuery" + } + ] } }, "required": [ @@ -66942,7 +78406,11 @@ } }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "description": { "type": "string" @@ -66999,10 +78467,18 @@ "type": "object", "properties": { "format": { - "$ref": "#/components/schemas/security._types.TemplateFormat" + "allOf": [ + { + "$ref": "#/components/schemas/security._types.TemplateFormat" + } + ] }, "template": { - "$ref": "#/components/schemas/_types.Script" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } }, "required": [ @@ -67048,7 +78524,12 @@ "type": "object", "properties": { "names": { - "$ref": "#/components/schemas/_types.Indices" + "description": "A list of indices.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "privileges": { "description": "A list of the privileges that you want to check for the specified indices.", @@ -67109,7 +78590,11 @@ } }, "meta": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] } } }, @@ -67117,31 +78602,75 @@ "type": "object", "properties": { "cardinality": { - "$ref": "#/components/schemas/_types.aggregations.CardinalityAggregation" + "description": "A single-value metrics aggregation that calculates an approximate count of distinct values.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CardinalityAggregation" + } + ] }, "composite": { - "$ref": "#/components/schemas/_types.aggregations.CompositeAggregation" + "description": "A multi-bucket aggregation that creates composite buckets from different sources.\nUnlike the other multi-bucket aggregations, you can use the `composite` aggregation to paginate *all* buckets from a multi-level aggregation efficiently.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.CompositeAggregation" + } + ] }, "date_range": { - "$ref": "#/components/schemas/_types.aggregations.DateRangeAggregation" + "description": "A multi-bucket value source based aggregation that enables the user to define a set of date ranges - each representing a bucket.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.DateRangeAggregation" + } + ] }, "filter": { - "$ref": "#/components/schemas/security.query_api_keys.ApiKeyQueryContainer" + "description": "A single bucket aggregation that narrows the set of documents to those that match a query.", + "allOf": [ + { + "$ref": "#/components/schemas/security.query_api_keys.ApiKeyQueryContainer" + } + ] }, "filters": { - "$ref": "#/components/schemas/security.query_api_keys.ApiKeyFiltersAggregation" + "description": "A multi-bucket aggregation where each bucket contains the documents that match a query.", + "allOf": [ + { + "$ref": "#/components/schemas/security.query_api_keys.ApiKeyFiltersAggregation" + } + ] }, "missing": { - "$ref": "#/components/schemas/_types.aggregations.MissingAggregation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.MissingAggregation" + } + ] }, "range": { - "$ref": "#/components/schemas/_types.aggregations.RangeAggregation" + "description": "A multi-bucket value source based aggregation that enables the user to define a set of ranges - each representing a bucket.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.RangeAggregation" + } + ] }, "terms": { - "$ref": "#/components/schemas/_types.aggregations.TermsAggregation" + "description": "A multi-bucket value source based aggregation where buckets are dynamically built - one per unique value.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsAggregation" + } + ] }, "value_count": { - "$ref": "#/components/schemas/_types.aggregations.ValueCountAggregation" + "description": "A single-value metrics aggregation that counts the number of values that are extracted from the aggregated documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.ValueCountAggregation" + } + ] } }, "minProperties": 1, @@ -67153,13 +78682,28 @@ "type": "object", "properties": { "bool": { - "$ref": "#/components/schemas/_types.query_dsl.BoolQuery" + "description": "Matches documents matching boolean combinations of other queries.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.BoolQuery" + } + ] }, "exists": { - "$ref": "#/components/schemas/_types.query_dsl.ExistsQuery" + "description": "Returns documents that contain an indexed value for a field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ExistsQuery" + } + ] }, "ids": { - "$ref": "#/components/schemas/_types.query_dsl.IdsQuery" + "description": "Returns documents based on their IDs.\nThis query uses document IDs stored in the `_id` field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IdsQuery" + } + ] }, "match": { "description": "Returns documents that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.", @@ -67171,7 +78715,12 @@ "maxProperties": 1 }, "match_all": { - "$ref": "#/components/schemas/_types.query_dsl.MatchAllQuery" + "description": "Matches all documents, giving them all a `_score` of 1.0.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.MatchAllQuery" + } + ] }, "prefix": { "description": "Returns documents that contain a specific prefix in a provided field.", @@ -67192,7 +78741,12 @@ "maxProperties": 1 }, "simple_query_string": { - "$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringQuery" + "description": "Returns documents based on a provided query string, using a parser with a limited but fault-tolerant syntax.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringQuery" + } + ] }, "term": { "description": "Returns documents that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.", @@ -67204,7 +78758,12 @@ "maxProperties": 1 }, "terms": { - "$ref": "#/components/schemas/_types.query_dsl.TermsQuery" + "description": "Returns documents that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.TermsQuery" + } + ] }, "wildcard": { "description": "Returns documents that contain terms matching a wildcard pattern.", @@ -67228,7 +78787,12 @@ "type": "object", "properties": { "filters": { - "$ref": "#/components/schemas/_types.aggregations.BucketsApiKeyQueryContainer" + "description": "Collection of queries from which to build buckets.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.BucketsApiKeyQueryContainer" + } + ] }, "other_bucket": { "description": "Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters.", @@ -67312,13 +78876,28 @@ "type": "object", "properties": { "bool": { - "$ref": "#/components/schemas/_types.query_dsl.BoolQuery" + "description": "matches roles matching boolean combinations of other queries.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.BoolQuery" + } + ] }, "exists": { - "$ref": "#/components/schemas/_types.query_dsl.ExistsQuery" + "description": "Returns roles that contain an indexed value for a field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.ExistsQuery" + } + ] }, "ids": { - "$ref": "#/components/schemas/_types.query_dsl.IdsQuery" + "description": "Returns roles based on their IDs.\nThis query uses role document IDs stored in the `_id` field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.IdsQuery" + } + ] }, "match": { "description": "Returns roles that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.", @@ -67330,7 +78909,12 @@ "maxProperties": 1 }, "match_all": { - "$ref": "#/components/schemas/_types.query_dsl.MatchAllQuery" + "description": "Matches all roles, giving them all a `_score` of 1.0.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.MatchAllQuery" + } + ] }, "prefix": { "description": "Returns roles that contain a specific prefix in a provided field.", @@ -67351,7 +78935,12 @@ "maxProperties": 1 }, "simple_query_string": { - "$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringQuery" + "description": "Returns roles based on a provided query string, using a parser with a limited but fault-tolerant syntax.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringQuery" + } + ] }, "term": { "description": "Returns roles that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.", @@ -67363,7 +78952,12 @@ "maxProperties": 1 }, "terms": { - "$ref": "#/components/schemas/_types.query_dsl.TermsQuery" + "description": "Returns roles that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.TermsQuery" + } + ] }, "wildcard": { "description": "Returns roles that contain terms matching a wildcard pattern.", @@ -67387,7 +78981,11 @@ "type": "object", "properties": { "_sort": { - "$ref": "#/components/schemas/_types.SortResults" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortResults" + } + ] }, "name": { "description": "Name of the role.", @@ -67404,7 +79002,11 @@ "type": "object", "properties": { "name": { - "$ref": "#/components/schemas/_types.Name" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "type": { "type": "string" @@ -67437,10 +79039,20 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "description": "The update operation result.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] }, "reload_analyzers_details": { - "$ref": "#/components/schemas/indices.reload_search_analyzers.ReloadResult" + "description": "Updating synonyms in a synonym set can reload the associated analyzers in case refresh is set to true.\nThis information is the analyzers reloading result.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.reload_search_analyzers.ReloadResult" + } + ] } }, "required": [ @@ -67457,7 +79069,11 @@ } }, "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] } }, "required": [ @@ -67494,10 +79110,23 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Synonym Rule identifier", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "synonyms": { - "$ref": "#/components/schemas/synonyms._types.SynonymString" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/text-analysis/analysis-synonym-graph-tokenfilter#_solr_format_2" + }, + "description": "Synonyms, in Solr format, that conform the synonym rule.", + "allOf": [ + { + "$ref": "#/components/schemas/synonyms._types.SynonymString" + } + ] } }, "required": [ @@ -67512,7 +79141,12 @@ "type": "object", "properties": { "synonyms_set": { - "$ref": "#/components/schemas/_types.Id" + "description": "Synonyms set identifier", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "count": { "description": "Number of synonym rules that the synonym set contains", @@ -67528,10 +79162,23 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The identifier for the synonym rule.\nIf you do not specify a synonym rule ID when you create a rule, an identifier is created automatically by Elasticsearch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "synonyms": { - "$ref": "#/components/schemas/synonyms._types.SynonymString" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/text-analysis/analysis-synonym-graph-tokenfilter#analysis-synonym-graph-define-synonyms" + }, + "description": "The synonyms that conform the synonym rule in Solr format.", + "allOf": [ + { + "$ref": "#/components/schemas/synonyms._types.SynonymString" + } + ] } }, "required": [ @@ -67564,16 +79211,32 @@ "type": "number" }, "node": { - "$ref": "#/components/schemas/_types.NodeId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.NodeId" + } + ] }, "running_time": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "running_time_in_nanos": { - "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitNanos" + } + ] }, "start_time_in_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "status": { "description": "The internal status of the task, which varies from task to task.\nThe format also varies.\nWhile the goal is to keep the status for a particular task consistent from version to version, this is not always possible because sometimes the implementation changes.\nFields might be removed from the status for a particular request so any parsing you do of the status might break in minor releases.", @@ -67583,7 +79246,11 @@ "type": "string" }, "parent_task_id": { - "$ref": "#/components/schemas/_types.TaskId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.TaskId" + } + ] } }, "required": [ @@ -67601,50 +79268,114 @@ "type": "object", "properties": { "authorization": { - "$ref": "#/components/schemas/ml._types.TransformAuthorization" + "description": "The security privileges that the transform uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the transform, this property is omitted.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.TransformAuthorization" + } + ] }, "create_time": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The time the transform was created.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "create_time_string": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "description": { "description": "Free text description of the transform.", "type": "string" }, "dest": { - "$ref": "#/components/schemas/_global.reindex.Destination" + "description": "The destination for the transform.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.reindex.Destination" + } + ] }, "frequency": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "latest": { - "$ref": "#/components/schemas/transform._types.Latest" + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Latest" + } + ] }, "pivot": { - "$ref": "#/components/schemas/transform._types.Pivot" + "description": "The pivot method transforms the data by aggregating and grouping it.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Pivot" + } + ] }, "retention_policy": { - "$ref": "#/components/schemas/transform._types.RetentionPolicyContainer" + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.RetentionPolicyContainer" + } + ] }, "settings": { - "$ref": "#/components/schemas/transform._types.Settings" + "description": "Defines optional transform settings.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Settings" + } + ] }, "source": { - "$ref": "#/components/schemas/transform._types.Source" + "description": "The source of the data for the transform.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Source" + } + ] }, "sync": { - "$ref": "#/components/schemas/transform._types.SyncContainer" + "description": "Defines the properties transforms require to run continuously.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.SyncContainer" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionString" + "description": "The version of Elasticsearch that existed on the node when the transform was created.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionString" + } + ] }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] } }, "required": [ @@ -67657,7 +79388,12 @@ "type": "object", "properties": { "api_key": { - "$ref": "#/components/schemas/ml._types.ApiKeyAuthorization" + "description": "If an API key was used for the most recent update to the transform, its name and identifier are listed in the response.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.ApiKeyAuthorization" + } + ] }, "roles": { "description": "If a user ID was used for the most recent update to the transform, its roles at the time of the update are listed in the response.", @@ -67676,7 +79412,12 @@ "type": "object", "properties": { "sort": { - "$ref": "#/components/schemas/_types.Field" + "description": "Specifies the date field that is used to identify the latest documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "unique_key": { "description": "Specifies an array of one or more fields that are used to group the data.", @@ -67714,16 +79455,32 @@ "type": "object", "properties": { "date_histogram": { - "$ref": "#/components/schemas/_types.aggregations.DateHistogramAggregation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.DateHistogramAggregation" + } + ] }, "geotile_grid": { - "$ref": "#/components/schemas/_types.aggregations.GeoTileGridAggregation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.GeoTileGridAggregation" + } + ] }, "histogram": { - "$ref": "#/components/schemas/_types.aggregations.HistogramAggregation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.HistogramAggregation" + } + ] }, "terms": { - "$ref": "#/components/schemas/_types.aggregations.TermsAggregation" + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations.TermsAggregation" + } + ] } }, "minProperties": 1, @@ -67733,7 +79490,12 @@ "type": "object", "properties": { "time": { - "$ref": "#/components/schemas/transform._types.RetentionPolicy" + "description": "Specifies that the transform uses a time field to set the retention policy.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.RetentionPolicy" + } + ] } }, "minProperties": 1, @@ -67743,10 +79505,20 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The date field that is used to calculate the age of the document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "max_age": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Specifies the maximum age of a document in the destination index. Documents that are older than the configured\nvalue are removed from the destination index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } }, "required": [ @@ -67794,13 +79566,29 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.Indices" + "description": "The source indices for the transform. It can be a single index, an index pattern (for example, `\"my-index-*\"\"`), an\narray of indices (for example, `[\"my-index-000001\", \"my-index-000002\"]`), or an array of index patterns (for\nexample, `[\"my-index-*\", \"my-other-index-*\"]`. For remote indices use the syntax `\"remote_name:index_name\"`. If\nany indices are in remote clusters then the master node and at least one transform node must have the `remote_cluster_client` node role.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "A query clause that retrieves a subset of data from the source index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "description": "Definitions of search-time runtime fields that can be used by the transform. For search runtime fields all data\nnodes, including remote nodes, must be 7.12 or later.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] } }, "required": [ @@ -67811,7 +79599,12 @@ "type": "object", "properties": { "time": { - "$ref": "#/components/schemas/transform._types.TimeSync" + "description": "Specifies that the transform uses a time field to synchronize the source and destination indices.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.TimeSync" + } + ] } }, "minProperties": 1, @@ -67821,10 +79614,21 @@ "type": "object", "properties": { "delay": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The time delay between the current time and the latest input data time.", + "default": "60s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field\nthat contains the ingest timestamp. If you use a different field, you might need to set the delay such that it\naccounts for data transmission delays.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] } }, "required": [ @@ -67835,13 +79639,25 @@ "type": "object", "properties": { "checkpointing": { - "$ref": "#/components/schemas/transform.get_transform_stats.Checkpointing" + "allOf": [ + { + "$ref": "#/components/schemas/transform.get_transform_stats.Checkpointing" + } + ] }, "health": { - "$ref": "#/components/schemas/transform.get_transform_stats.TransformStatsHealth" + "allOf": [ + { + "$ref": "#/components/schemas/transform.get_transform_stats.TransformStatsHealth" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "reason": { "type": "string" @@ -67850,7 +79666,11 @@ "type": "string" }, "stats": { - "$ref": "#/components/schemas/transform.get_transform_stats.TransformIndexerStats" + "allOf": [ + { + "$ref": "#/components/schemas/transform.get_transform_stats.TransformIndexerStats" + } + ] } }, "required": [ @@ -67867,13 +79687,25 @@ "type": "number" }, "changes_last_detected_at_string": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "last": { - "$ref": "#/components/schemas/transform.get_transform_stats.CheckpointStats" + "allOf": [ + { + "$ref": "#/components/schemas/transform.get_transform_stats.CheckpointStats" + } + ] }, "next": { - "$ref": "#/components/schemas/transform.get_transform_stats.CheckpointStats" + "allOf": [ + { + "$ref": "#/components/schemas/transform.get_transform_stats.CheckpointStats" + } + ] }, "operations_behind": { "type": "number" @@ -67882,7 +79714,11 @@ "type": "number" }, "last_search_time_string": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] } }, "required": [ @@ -67896,19 +79732,39 @@ "type": "number" }, "checkpoint_progress": { - "$ref": "#/components/schemas/transform.get_transform_stats.TransformProgress" + "allOf": [ + { + "$ref": "#/components/schemas/transform.get_transform_stats.TransformProgress" + } + ] }, "timestamp": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "timestamp_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "time_upper_bound": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "time_upper_bound_millis": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] } }, "required": [ @@ -67943,7 +79799,11 @@ "type": "object", "properties": { "status": { - "$ref": "#/components/schemas/_types.HealthStatus" + "allOf": [ + { + "$ref": "#/components/schemas/_types.HealthStatus" + } + ] }, "issues": { "description": "If a non-healthy status is returned, contains a list of issues of the transform.", @@ -67977,10 +79837,19 @@ "type": "number" }, "first_occurrence": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "description": "The timestamp this issue occurred for for the first time", + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "first_occurence_string": { - "$ref": "#/components/schemas/_types.DateTime" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] } }, "required": [ @@ -67993,7 +79862,11 @@ "type": "object", "properties": { "delete_time_in_ms": { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" + } + ] }, "documents_indexed": { "type": "number" @@ -68005,7 +79878,11 @@ "type": "number" }, "exponential_avg_checkpoint_duration_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis" + } + ] }, "exponential_avg_documents_indexed": { "type": "number" @@ -68017,7 +79894,11 @@ "type": "number" }, "index_time_in_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "index_total": { "type": "number" @@ -68026,7 +79907,11 @@ "type": "number" }, "processing_time_in_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "processing_total": { "type": "number" @@ -68035,7 +79920,11 @@ "type": "number" }, "search_time_in_ms": { - "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + "allOf": [ + { + "$ref": "#/components/schemas/_types.DurationValueUnitMillis" + } + ] }, "search_total": { "type": "number" @@ -68066,7 +79955,12 @@ "type": "object", "properties": { "index": { - "$ref": "#/components/schemas/_types.IndexName" + "description": "The destination index for the transform. The mappings of the destination index are deduced based on the source\nfields when possible. If alternate mappings are required, use the create index API prior to starting the\ntransform.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "pipeline": { "description": "The unique identifier for an ingest pipeline.", @@ -68083,7 +79977,11 @@ "type": "object", "properties": { "get": { - "$ref": "#/components/schemas/_types.InlineGet" + "allOf": [ + { + "$ref": "#/components/schemas/_types.InlineGet" + } + ] } } } @@ -68403,10 +80301,18 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/_types.Result" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Result" + } + ] }, "id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] } }, "required": [ @@ -68433,7 +80339,11 @@ "type": "number" }, "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] } }, "required": [ @@ -68512,19 +80422,35 @@ "type": "object", "properties": { "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "matched": { "type": "boolean" }, "explanation": { - "$ref": "#/components/schemas/_global.explain.ExplanationDetail" + "allOf": [ + { + "$ref": "#/components/schemas/_global.explain.ExplanationDetail" + } + ] }, "get": { - "$ref": "#/components/schemas/_types.InlineGet" + "allOf": [ + { + "$ref": "#/components/schemas/_types.InlineGet" + } + ] } }, "required": [ @@ -68550,7 +80476,12 @@ "type": "object", "properties": { "indices": { - "$ref": "#/components/schemas/_types.Indices" + "description": "The list of indices where this field has the same type family, or null if all indices have the same type family for the field.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "fields": { "type": "object", @@ -68655,7 +80586,11 @@ "type": "object", "properties": { "detail": { - "$ref": "#/components/schemas/indices.analyze.AnalyzeDetail" + "allOf": [ + { + "$ref": "#/components/schemas/indices.analyze.AnalyzeDetail" + } + ] }, "tokens": { "type": "array", @@ -68892,7 +80827,11 @@ } }, "template": { - "$ref": "#/components/schemas/indices.simulate_template.Template" + "allOf": [ + { + "$ref": "#/components/schemas/indices.simulate_template.Template" + } + ] } }, "required": [ @@ -68922,7 +80861,11 @@ } }, "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] }, "valid": { "type": "boolean" @@ -69621,10 +81564,18 @@ "type": "boolean" }, "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] }, "hits": { - "$ref": "#/components/schemas/_global.search._types.HitsMetadata" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.HitsMetadata" + } + ] }, "aggregations": { "type": "object", @@ -69633,7 +81584,11 @@ } }, "_clusters": { - "$ref": "#/components/schemas/_types.ClusterStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ClusterStatistics" + } + ] }, "fields": { "type": "object", @@ -69648,13 +81603,25 @@ "type": "number" }, "profile": { - "$ref": "#/components/schemas/_global.search._types.Profile" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.Profile" + } + ] }, "pit_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_scroll_id": { - "$ref": "#/components/schemas/_types.ScrollId" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScrollId" + } + ] }, "suggest": { "type": "object", @@ -69695,10 +81662,20 @@ "type": "number" }, "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "Unique ID for this API key.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "Specifies the name for this API key.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "encoded": { "description": "API key credentials which is the base64-encoding of\nthe UTF-8 representation of `id` and `api_key` joined\nby a colon (`:`).", @@ -69749,7 +81726,11 @@ "type": "object", "properties": { "application": { - "$ref": "#/components/schemas/security.has_privileges.ApplicationsPrivileges" + "allOf": [ + { + "$ref": "#/components/schemas/security.has_privileges.ApplicationsPrivileges" + } + ] }, "cluster": { "type": "object", @@ -69767,7 +81748,11 @@ } }, "username": { - "$ref": "#/components/schemas/_types.Username" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Username" + } + ] } }, "required": [ @@ -69795,7 +81780,12 @@ "type": "object", "properties": { "role": { - "$ref": "#/components/schemas/security._types.CreatedStatus" + "description": "When an existing role is updated, `created` is set to `false`.", + "allOf": [ + { + "$ref": "#/components/schemas/security._types.CreatedStatus" + } + ] } }, "required": [ @@ -69930,7 +81920,12 @@ "type": "string" }, "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The identifier for the search.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-ID` HTTP header.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "is_running": { "description": "If `true`, the search is still running.\nIf `false`, the search has finished.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header.", @@ -69972,7 +81967,11 @@ "type": "number" }, "_source": { - "$ref": "#/components/schemas/_global.search._types.SourceConfig" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.SourceConfig" + } + ] }, "fields": { "type": "array", @@ -69981,10 +81980,18 @@ } }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] } } } @@ -69999,7 +82006,11 @@ "type": "object", "properties": { "_shards": { - "$ref": "#/components/schemas/_types.ShardStatistics" + "allOf": [ + { + "$ref": "#/components/schemas/_types.ShardStatistics" + } + ] }, "terms": { "type": "array", @@ -70038,10 +82049,18 @@ "type": "boolean" }, "_id": { - "$ref": "#/components/schemas/_types.Id" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "_index": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "term_vectors": { "type": "object", @@ -70053,7 +82072,11 @@ "type": "number" }, "_version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] } }, "required": [ @@ -70122,7 +82145,11 @@ "type": "object", "properties": { "generated_dest_index": { - "$ref": "#/components/schemas/indices._types.IndexState" + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexState" + } + ] }, "preview": { "type": "array", @@ -75645,7 +87672,11 @@ } }, "collapse": { - "$ref": "#/components/schemas/_global.search._types.FieldCollapse" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.FieldCollapse" + } + ] }, "explain": { "description": "If true, returns detailed information about score computation as part of a hit.", @@ -75665,10 +87696,19 @@ "type": "number" }, "highlight": { - "$ref": "#/components/schemas/_global.search._types.Highlight" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.Highlight" + } + ] }, "track_total_hits": { - "$ref": "#/components/schemas/_global.search._types.TrackHits" + "description": "Number of hits matching the query to count accurately. If true, the exact\nnumber of hits is returned at the cost of some performance. If false, the\nresponse does not include the total number of hits matching the query.\nDefaults to 10,000 hits.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.TrackHits" + } + ] }, "indices_boost": { "description": "Boosts the _score of documents from specified indices.", @@ -75709,13 +87749,22 @@ "type": "number" }, "post_filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "profile": { "type": "boolean" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Defines the search definition using the Query DSL.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "rescore": { "oneOf": [ @@ -75738,7 +87787,11 @@ } }, "search_after": { - "$ref": "#/components/schemas/_types.SortResults" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortResults" + } + ] }, "size": { "description": "The number of hits to return. By default, you cannot page through more\nthan 10,000 hits using the from and size parameters. To page through more\nhits, use the search_after parameter.", @@ -75746,13 +87799,26 @@ "type": "number" }, "slice": { - "$ref": "#/components/schemas/_types.SlicedScroll" + "allOf": [ + { + "$ref": "#/components/schemas/_types.SlicedScroll" + } + ] }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] }, "_source": { - "$ref": "#/components/schemas/_global.search._types.SourceConfig" + "description": "Indicates which source fields are returned for matching documents. These\nfields are returned in the hits._source property of the search response.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.SourceConfig" + } + ] }, "fields": { "description": "Array of wildcard (*) patterns. The request returns values for field names\nmatching these patterns in the hits.fields property of the response.", @@ -75762,7 +87828,11 @@ } }, "suggest": { - "$ref": "#/components/schemas/_global.search._types.Suggester" + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.Suggester" + } + ] }, "terminate_after": { "description": "Maximum number of documents to collect for each shard. If a query reaches this\nlimit, Elasticsearch terminates the query early. Elasticsearch collects documents\nbefore sorting. Defaults to 0, which does not terminate query execution early.", @@ -75788,13 +87858,28 @@ "type": "boolean" }, "stored_fields": { - "$ref": "#/components/schemas/_types.Fields" + "description": "List of stored fields to return as part of a hit. If no fields are specified,\nno stored fields are included in the response. If this field is specified, the _source\nparameter defaults to false. You can pass _source: true to return both source fields\nand stored fields in the search response.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "pit": { - "$ref": "#/components/schemas/_global.search._types.PointInTimeReference" + "description": "Limits the search to a point in time (PIT). If you provide a PIT, you\ncannot specify an in the request path.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.PointInTimeReference" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "description": "Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "stats": { "description": "Stats groups to associate with the search. Each group maintains a statistics\naggregation for its associated searches. You can retrieve these stats using\nthe indices stats API.", @@ -75866,7 +87951,12 @@ "type": "object", "properties": { "scroll_id": { - "$ref": "#/components/schemas/_types.ScrollIds" + "description": "The scroll IDs to clear.\nTo clear all scroll IDs, use `_all`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScrollIds" + } + ] } } }, @@ -75886,13 +87976,28 @@ "type": "object", "properties": { "template": { - "$ref": "#/components/schemas/indices._types.IndexState" + "description": "The template to be applied which includes mappings, settings, or aliases configuration.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.IndexState" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "Version number used to manage component templates externally.\nThis number isn't automatically generated or incremented by Elasticsearch.\nTo unset a version, replace the template without specifying a version.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Optional user metadata about the component template.\nIt may have any contents. This map is not automatically generated by Elasticsearch.\nThis information is stored in the cluster state, so keeping it short is preferable.\nTo unset `_meta`, replace the template without specifying this information.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "deprecated": { "description": "Marks this index template as deprecated. When creating or updating a non-deprecated index template\nthat uses deprecated components, Elasticsearch will emit a deprecation warning.", @@ -75928,7 +88033,11 @@ "type": "string" }, "index_name": { - "$ref": "#/components/schemas/_types.IndexName" + "allOf": [ + { + "$ref": "#/components/schemas/_types.IndexName" + } + ] }, "is_native": { "type": "boolean" @@ -75962,7 +88071,12 @@ "type": "object", "properties": { "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Defines the search query using Query DSL. A request body query cannot be used\nwith the `q` query string parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } } }, @@ -76005,16 +88119,38 @@ "type": "boolean" }, "event_category_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing the event classification, such as process, file, or network.", + "default": "event.category", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "tiebreaker_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field used to sort hits with the same timestamp in ascending order", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "timestamp_field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field containing event timestamp. Default \"@timestamp\"", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "fetch_size": { - "$ref": "#/components/schemas/_types.uint" + "description": "Maximum number of events to search at a time for sequence queries.", + "default": 1000.0, + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "filter": { "description": "Query, written in Query DSL, used to filter the events on which the EQL query runs.", @@ -76031,13 +88167,21 @@ ] }, "keep_alive": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "keep_on_completion": { "type": "boolean" }, "wait_for_completion_timeout": { - "$ref": "#/components/schemas/_types.Duration" + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "allow_partial_search_results": { "description": "Allow query execution also in case of shard failures.\nIf true, the query will keep running and will return results based on the available shards.\nFor sequences, the behavior can be further refined using allow_partial_sequence_results", @@ -76050,7 +88194,12 @@ "type": "boolean" }, "size": { - "$ref": "#/components/schemas/_types.uint" + "description": "For basic queries, the maximum number of matching events to return. Defaults to 10", + "allOf": [ + { + "$ref": "#/components/schemas/_types.uint" + } + ] }, "fields": { "description": "Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit.", @@ -76067,10 +88216,20 @@ ] }, "result_position": { - "$ref": "#/components/schemas/eql.search.ResultPosition" + "default": "tail", + "allOf": [ + { + "$ref": "#/components/schemas/eql.search.ResultPosition" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "max_samples_per_key": { "description": "By default, the response of a sample query contains up to `10` samples, with one sample per unique set of join keys. Use the `size`\nparameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the\n`max_samples_per_key` parameter. Pipes are not supported for sample queries.", @@ -76105,7 +88264,12 @@ "type": "object", "properties": { "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Defines the search definition using the Query DSL.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } } }, @@ -76125,13 +88289,30 @@ "type": "object", "properties": { "fields": { - "$ref": "#/components/schemas/_types.Fields" + "description": "A list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "index_filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Filter indices if the provided query rewrites to `match_none` on every shard.\n\nIMPORTANT: The filtering is done on a best-effort basis, it uses index statistics and mappings to rewrite queries to `match_none` instead of fully running the request.\nFor instance a range query over a date field can rewrite to `match_none` if all documents within a shard (including deleted documents) are outside of the provided range.\nHowever, not all queries can rewrite to `match_none` so this API may return an index even if the provided filter matches no document.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "description": "Define ad-hoc runtime fields in the request similar to the way it is done in search requests.\nThese fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] } } }, @@ -76151,13 +88332,28 @@ "type": "object", "properties": { "connections": { - "$ref": "#/components/schemas/graph._types.Hop" + "description": "Specifies or more fields from which you want to extract terms that are associated with the specified vertices.", + "allOf": [ + { + "$ref": "#/components/schemas/graph._types.Hop" + } + ] }, "controls": { - "$ref": "#/components/schemas/graph._types.ExploreControls" + "description": "Direct the Graph API how to build the graph.", + "allOf": [ + { + "$ref": "#/components/schemas/graph._types.ExploreControls" + } + ] }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "A seed query that identifies the documents of interest. Can be any valid Elasticsearch query.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "vertices": { "description": "Specifies one or more fields that contain the terms you want to include in the graph as vertices.", @@ -76229,7 +88425,12 @@ "type": "boolean" }, "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "Field used to derive the analyzer.\nTo use this parameter, you must specify an index.\nIf specified, the `analyzer` parameter overrides this value.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "filter": { "description": "Array of token filters used to apply after the tokenizer.", @@ -76243,10 +88444,20 @@ "type": "string" }, "text": { - "$ref": "#/components/schemas/indices.analyze.TextToAnalyze" + "description": "Text to analyze.\nIf an array of strings is provided, it is analyzed as a multi-value field.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.analyze.TextToAnalyze" + } + ] }, "tokenizer": { - "$ref": "#/components/schemas/_types.analysis.Tokenizer" + "description": "Tokenizer to use to convert text into tokens.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis.Tokenizer" + } + ] } } }, @@ -76297,20 +88508,40 @@ "type": "object", "properties": { "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Query used to limit documents the alias can access.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "index_routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.\nData stream aliases don’t support this parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "is_write_index": { "description": "If `true`, sets the write index or data stream for the alias.\nIf an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests.\nIf an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index.\nData stream aliases don’t automatically set a write data stream, even if the alias points to one data stream.", "type": "boolean" }, "routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "Value used to route indexing and search operations to a specific shard.\nData stream aliases don’t support this parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "search_routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.\nData stream aliases don’t support this parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] } } }, @@ -76329,7 +88560,12 @@ "type": "object", "properties": { "index_patterns": { - "$ref": "#/components/schemas/_types.Indices" + "description": "Name of the index template to create.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "composed_of": { "description": "An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence.", @@ -76339,20 +88575,40 @@ } }, "template": { - "$ref": "#/components/schemas/indices.put_index_template.IndexTemplateMapping" + "description": "Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.put_index_template.IndexTemplateMapping" + } + ] }, "data_stream": { - "$ref": "#/components/schemas/indices._types.DataStreamVisibility" + "description": "If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamVisibility" + } + ] }, "priority": { "description": "Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch.", "type": "number" }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.\nExternal systems can use these version numbers to simplify template management.\nTo unset a version, replace the template without specifying one.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Optional user metadata about the index template.\nIt may have any contents.\nIt is not automatically generated or used by Elasticsearch.\nThis user-defined object is stored in the cluster state, so keeping it short is preferable\nTo unset the metadata, replace the template without specifying it.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "allow_auto_create": { "description": "This setting overrides the value of the `action.auto_create_index` cluster setting.\nIf set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.\nIf set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.", @@ -76397,7 +88653,12 @@ "type": "boolean" }, "dynamic": { - "$ref": "#/components/schemas/_types.mapping.DynamicMapping" + "description": "Controls whether new fields are added dynamically.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.DynamicMapping" + } + ] }, "dynamic_date_formats": { "description": "If date detection is enabled then new string fields are checked\nagainst 'dynamic_date_formats' and if the value matches then\na new date field is added instead of string.", @@ -76419,10 +88680,20 @@ } }, "_field_names": { - "$ref": "#/components/schemas/_types.mapping.FieldNamesField" + "description": "Control whether field names are enabled for the index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.FieldNamesField" + } + ] }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "A mapping type can have custom meta data associated with it. These are\nnot used at all by Elasticsearch, but can be used to store\napplication-specific metadata.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "numeric_detection": { "description": "Automatically map strings into numeric data types for all fields.", @@ -76437,13 +88708,28 @@ } }, "_routing": { - "$ref": "#/components/schemas/_types.mapping.RoutingField" + "description": "Enable making a routing value required on indexed documents.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RoutingField" + } + ] }, "_source": { - "$ref": "#/components/schemas/_types.mapping.SourceField" + "description": "Control whether the _source field is enabled on the index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.SourceField" + } + ] }, "runtime": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "description": "Mapping of runtime fields for the index.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] } } }, @@ -76498,10 +88784,20 @@ } }, "conditions": { - "$ref": "#/components/schemas/indices.rollover.RolloverConditions" + "description": "Conditions for the rollover.\nIf specified, Elasticsearch only performs the rollover if the current index satisfies these conditions.\nIf this parameter is not specified, Elasticsearch performs the rollover unconditionally.\nIf conditions are specified, at least one of them must be a `max_*` condition.\nThe index will rollover if any `max_*` condition is satisfied and all `min_*` conditions are satisfied.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.rollover.RolloverConditions" + } + ] }, "mappings": { - "$ref": "#/components/schemas/_types.mapping.TypeMapping" + "description": "Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping paramaters.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.TypeMapping" + } + ] }, "settings": { "description": "Configuration options for the index.\nData streams do not support this parameter.", @@ -76532,7 +88828,12 @@ "type": "boolean" }, "index_patterns": { - "$ref": "#/components/schemas/_types.Indices" + "description": "Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Indices" + } + ] }, "composed_of": { "description": "An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence.", @@ -76542,20 +88843,40 @@ } }, "template": { - "$ref": "#/components/schemas/indices.put_index_template.IndexTemplateMapping" + "description": "Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.", + "allOf": [ + { + "$ref": "#/components/schemas/indices.put_index_template.IndexTemplateMapping" + } + ] }, "data_stream": { - "$ref": "#/components/schemas/indices._types.DataStreamVisibility" + "description": "If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamVisibility" + } + ] }, "priority": { "description": "Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch.", "type": "number" }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "_meta": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Optional user metadata about the index template.\nMay have any contents.\nThis map is not automatically generated by Elasticsearch.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "ignore_missing_component_templates": { "description": "The configuration option ignore_missing_component_templates can be used when an index template\nreferences a component template that might not exist", @@ -76586,7 +88907,12 @@ "type": "object", "properties": { "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Query in the Lucene query string syntax.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] } } } @@ -76622,7 +88948,12 @@ "type": "string" }, "task_settings": { - "$ref": "#/components/schemas/inference._types.TaskSettings" + "description": "Task settings for the individual inference request.\nThese settings are specific to the task type you specified and override the task settings specified when initializing the service.", + "allOf": [ + { + "$ref": "#/components/schemas/inference._types.TaskSettings" + } + ] } }, "required": [ @@ -76662,7 +88993,12 @@ } }, "pipeline": { - "$ref": "#/components/schemas/ingest._types.Pipeline" + "description": "The pipeline to test.\nIf you don't specify the `pipeline` request path parameter, this parameter is required.\nIf you specify both this and the request path parameter, the API only uses the request path parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types.Pipeline" + } + ] } }, "required": [ @@ -76694,7 +89030,12 @@ } }, "ids": { - "$ref": "#/components/schemas/_types.Ids" + "description": "The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Ids" + } + ] } } }, @@ -76731,7 +89072,12 @@ "type": "object", "properties": { "page": { - "$ref": "#/components/schemas/ml._types.Page" + "description": "This object is supported only when you omit the calendar identifier.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.Page" + } + ] } } } @@ -76750,10 +89096,20 @@ "type": "boolean" }, "bucket_span": { - "$ref": "#/components/schemas/_types.Duration" + "description": "Refer to the description for the `bucket_span` query parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "end": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "Refer to the description for the `end` query parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "exclude_interim": { "description": "Refer to the description for the `exclude_interim` query parameter.", @@ -76772,7 +89128,12 @@ ] }, "start": { - "$ref": "#/components/schemas/_types.DateTime" + "description": "Refer to the description for the `start` query parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.DateTime" + } + ] }, "top_n": { "description": "Refer to the description for the `top_n` query parameter.", @@ -76797,7 +89158,12 @@ "type": "object", "properties": { "config": { - "$ref": "#/components/schemas/ml.preview_data_frame_analytics.DataframePreviewConfig" + "description": "A data frame analytics config as described in create data frame analytics\njobs. Note that `id` and `dest` don’t need to be provided in the context of\nthis API.", + "allOf": [ + { + "$ref": "#/components/schemas/ml.preview_data_frame_analytics.DataframePreviewConfig" + } + ] } } }, @@ -76817,10 +89183,20 @@ "type": "object", "properties": { "datafeed_config": { - "$ref": "#/components/schemas/ml._types.DatafeedConfig" + "description": "The datafeed definition to preview.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.DatafeedConfig" + } + ] }, "job_config": { - "$ref": "#/components/schemas/ml._types.JobConfig" + "description": "The configuration details for the anomaly detection job that is associated with the datafeed. If the\n`datafeed_config` object does not include a `job_id` that references an existing anomaly detection job, you must\nsupply this `job_config` object. If you include both a `job_id` and a `job_config`, the latter information is\nused. You cannot specify a `job_config` object unless you also supply a `datafeed_config` object.", + "allOf": [ + { + "$ref": "#/components/schemas/ml._types.JobConfig" + } + ] } } } @@ -76914,7 +89290,12 @@ "type": "object", "properties": { "script": { - "$ref": "#/components/schemas/_types.StoredScript" + "description": "The script or search template, its parameters, and its language.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.StoredScript" + } + ] } }, "required": [ @@ -76951,7 +89332,12 @@ } }, "metric": { - "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetric" + "description": "Definition of the evaluation metric to calculate.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetric" + } + ] } }, "required": [ @@ -76975,7 +89361,12 @@ "type": "object", "properties": { "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The ID of the search template to render.\nIf no `source` is specified, this or the `` request path parameter is required.\nIf you specify both this parameter and the `` parameter, the API uses only ``.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "file": { "type": "string" @@ -76988,7 +89379,12 @@ } }, "source": { - "$ref": "#/components/schemas/_types.ScriptSource" + "description": "An inline search template.\nIt supports the same parameters as the search API's request body.\nThese parameters also support Mustache variables.\nIf no `id` or `` is specified, this parameter is required.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptSource" + } + ] } } }, @@ -77008,13 +89404,29 @@ "type": "object", "properties": { "context": { - "$ref": "#/components/schemas/_global.scripts_painless_execute.PainlessContext" + "description": "The context that the script should run in.\nNOTE: Result ordering in the field contexts is not guaranteed.", + "default": "painless_test", + "allOf": [ + { + "$ref": "#/components/schemas/_global.scripts_painless_execute.PainlessContext" + } + ] }, "context_setup": { - "$ref": "#/components/schemas/_global.scripts_painless_execute.PainlessContextSetup" + "description": "Additional parameters for the `context`.\nNOTE: This parameter is required for all contexts except `painless_test`, which is the default if no value is provided for `context`.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.scripts_painless_execute.PainlessContextSetup" + } + ] }, "script": { - "$ref": "#/components/schemas/_types.Script" + "description": "The Painless script to run.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Script" + } + ] } } }, @@ -77045,10 +89457,21 @@ "type": "object", "properties": { "scroll": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The period to retain the search context for scrolling.", + "default": "1d", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "scroll_id": { - "$ref": "#/components/schemas/_types.ScrollId" + "description": "The scroll ID of the search.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScrollId" + } + ] } }, "required": [ @@ -77081,7 +89504,12 @@ } }, "collapse": { - "$ref": "#/components/schemas/_global.search._types.FieldCollapse" + "description": "Collapses search results the values of the specified field.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.FieldCollapse" + } + ] }, "explain": { "description": "If `true`, the request returns detailed information about score computation as part of a hit.", @@ -77101,10 +89529,24 @@ "type": "number" }, "highlight": { - "$ref": "#/components/schemas/_global.search._types.Highlight" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/highlighting" + }, + "description": "Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.Highlight" + } + ] }, "track_total_hits": { - "$ref": "#/components/schemas/_global.search._types.TrackHits" + "description": "Number of hits matching the query to count accurately.\nIf `true`, the exact number of hits is returned at the cost of some performance.\nIf `false`, the response does not include the total number of hits matching the query.", + "default": "10000", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.TrackHits" + } + ] }, "indices_boost": { "externalDocs": { @@ -77154,7 +89596,12 @@ "type": "number" }, "post_filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Use the `post_filter` parameter to filter search results.\nThe search hits are filtered after the aggregations are calculated.\nA post filter has no impact on the aggregation results.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "profile": { "description": "Set to `true` to return detailed timing information about the execution of individual components in a search request.\nNOTE: This is a debugging tool and adds significant overhead to search execution.", @@ -77162,7 +89609,15 @@ "type": "boolean" }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl" + }, + "description": "The search definition using the Query DSL.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "rescore": { "description": "Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases.", @@ -77179,7 +89634,16 @@ ] }, "retriever": { - "$ref": "#/components/schemas/_types.RetrieverContainer" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrievers" + }, + "description": "A retriever is a specification to describe top documents returned from a search.\nA retriever replaces other elements of the search API that also return top documents such as `query` and `knn`.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.RetrieverContainer" + } + ] }, "script_fields": { "description": "Retrieve a script evaluation (based on different fields) for each hit.", @@ -77189,7 +89653,12 @@ } }, "search_after": { - "$ref": "#/components/schemas/_types.SortResults" + "description": "Used to retrieve the next page of hits using a set of sort values from the previous page.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortResults" + } + ] }, "size": { "description": "The number of hits to return, which must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` property.", @@ -77197,13 +89666,34 @@ "type": "number" }, "slice": { - "$ref": "#/components/schemas/_types.SlicedScroll" + "description": "Split a scrolled search into multiple slices that can be consumed independently.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SlicedScroll" + } + ] }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results" + }, + "description": "A comma-separated list of : pairs.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] }, "_source": { - "$ref": "#/components/schemas/_global.search._types.SourceConfig" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#source-filtering" + }, + "description": "The source fields that are returned for matching documents.\nThese fields are returned in the `hits._source` property of the search response.\nIf the `stored_fields` property is specified, the `_source` property defaults to `false`.\nOtherwise, it defaults to `true`.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.SourceConfig" + } + ] }, "fields": { "description": "An array of wildcard (`*`) field patterns.\nThe request returns values for field names matching these patterns in the `hits.fields` property of the response.", @@ -77213,7 +89703,12 @@ } }, "suggest": { - "$ref": "#/components/schemas/_global.search._types.Suggester" + "description": "Defines a suggester that provides similar looking terms based on a provided text.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.Suggester" + } + ] }, "terminate_after": { "description": "The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this property to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this property for requests that target data streams with backing indices across multiple data tiers.\n\nIf set to `0` (default), the query does not terminate early.", @@ -77242,13 +89737,34 @@ "type": "boolean" }, "stored_fields": { - "$ref": "#/components/schemas/_types.Fields" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#stored-fields" + }, + "description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` property defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "pit": { - "$ref": "#/components/schemas/_global.search._types.PointInTimeReference" + "description": "Limit the search to a point in time (PIT).\nIf you provide a PIT, you cannot specify an `` in the request path.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.PointInTimeReference" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "externalDocs": { + "url": "https://www.elastic.co/docs/manage-data/data-store/mapping/define-runtime-fields-in-search-request" + }, + "description": "One or more runtime fields in the search request.\nThese fields take precedence over mapped fields with the same name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "stats": { "description": "The stats groups to associate with the search.\nEach group maintains a statistics aggregation for its associated searches.\nYou can retrieve these stats using the indices stats API.", @@ -77332,10 +89848,20 @@ "type": "number" }, "fields": { - "$ref": "#/components/schemas/_types.Fields" + "description": "The fields to return in the `hits` layer.\nIt supports wildcards (`*`).\nThis parameter does not support fields with array values. Fields with array\nvalues may return inconsistent results.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Fields" + } + ] }, "grid_agg": { - "$ref": "#/components/schemas/_global.search_mvt._types.GridAggregationType" + "description": "The aggregation used to create a grid for the `field`.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search_mvt._types.GridAggregationType" + } + ] }, "grid_precision": { "description": "Additional zoom levels available through the aggs layer. For example, if `` is `7`\nand `grid_precision` is `8`, you can zoom in up to level 15. Accepts 0-8. If 0, results\ndon't include the aggs layer.", @@ -77343,13 +89869,29 @@ "type": "number" }, "grid_type": { - "$ref": "#/components/schemas/_global.search_mvt._types.GridType" + "description": "Determines the geometry type for features in the aggs layer. In the aggs layer,\neach feature represents a `geotile_grid` cell. If `grid, each feature is a polygon\nof the cells bounding box. If `point`, each feature is a Point that is the centroid\nof the cell.", + "default": "grid", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search_mvt._types.GridType" + } + ] }, "query": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "The query DSL used to filter documents for the search.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "description": "Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "size": { "description": "The maximum number of features to return in the hits layer. Accepts 0-10000.\nIf 0, results don't include the hits layer.", @@ -77357,10 +89899,21 @@ "type": "number" }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "description": "Sort the features in the hits layer. By default, the API calculates a bounding\nbox for each feature. It sorts features based on this box's diagonal length,\nfrom longest to shortest.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] }, "track_total_hits": { - "$ref": "#/components/schemas/_global.search._types.TrackHits" + "description": "The number of hits matching the query to count accurately. If `true`, the exact number\nof hits is returned at the cost of some performance. If `false`, the response does\nnot include the total number of hits matching the query.", + "default": "10000", + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types.TrackHits" + } + ] }, "with_labels": { "description": "If `true`, the hits and aggs layers will contain additional point features representing\nsuggested label positions for the original features.\n\n* `Point` and `MultiPoint` features will have one of the points selected.\n* `Polygon` and `MultiPolygon` features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree.\n* `LineString` features will likewise provide a roughly central point selected from the triangle-tree.\n* The aggregation results will provide one central point for each aggregation bucket.\n\nAll attributes from the original features will also be copied to the new label features.\nIn addition, the new features will be distinguishable using the tag `_mvt_label_position`.", @@ -77389,7 +89942,12 @@ "type": "boolean" }, "id": { - "$ref": "#/components/schemas/_types.Id" + "description": "The ID of the search template to use. If no `source` is specified,\nthis parameter is required.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Id" + } + ] }, "params": { "description": "Key-value pairs used to replace Mustache variables in the template.\nThe key is the variable name.\nThe value is the variable value.", @@ -77404,7 +89962,12 @@ "type": "boolean" }, "source": { - "$ref": "#/components/schemas/_types.ScriptSource" + "description": "An inline search template. Supports the same parameters as the search API's\nrequest body. It also supports Mustache variables. If no `id` is specified, this\nparameter is required.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.ScriptSource" + } + ] } } }, @@ -77425,10 +89988,20 @@ "type": "object", "properties": { "expiration": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The expiration time for the API key.\nBy default, API keys never expire.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "name": { - "$ref": "#/components/schemas/_types.Name" + "description": "A name for the API key.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Name" + } + ] }, "role_descriptors": { "externalDocs": { @@ -77441,7 +90014,13 @@ } }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with `_` are reserved for system usage.", + "x-state": "Generally available", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] } } }, @@ -77520,7 +90099,12 @@ } }, "metadata": { - "$ref": "#/components/schemas/_types.Metadata" + "description": "Optional metadata. Within the metadata object, keys that begin with an underscore (`_`) are reserved for system use.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Metadata" + } + ] }, "run_as": { "externalDocs": { @@ -77580,7 +90164,12 @@ } }, "query": { - "$ref": "#/components/schemas/security.query_api_keys.ApiKeyQueryContainer" + "description": "A query to filter which API keys to return.\nIf the query parameter is missing, it is equivalent to a `match_all` query.\nThe query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`,\n`ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`.\nYou can query the following public information associated with an API key: `id`, `type`, `name`,\n`creation`, `expiration`, `invalidated`, `invalidation`, `username`, `realm`, and `metadata`.\n\nNOTE: The queryable string values associated with API keys are internally mapped as keywords.\nConsequently, if no `analyzer` parameter is specified for a `match` query, then the provided match query string is interpreted as a single keyword value.\nSuch a match query is hence equivalent to a `term` query.", + "allOf": [ + { + "$ref": "#/components/schemas/security.query_api_keys.ApiKeyQueryContainer" + } + ] }, "from": { "description": "The starting document offset.\nIt must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", @@ -77588,7 +90177,15 @@ "type": "number" }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results" + }, + "description": "The sort definition.\nOther than `id`, all public fields of an API key are eligible for sorting.\nIn addition, sort can also be applied to the `_doc` field to sort by index order.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] }, "size": { "description": "The number of hits to return.\nIt must not be negative.\nThe `size` parameter can be set to `0`, in which case no API key matches are returned, only the aggregation results.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", @@ -77596,7 +90193,15 @@ "type": "number" }, "search_after": { - "$ref": "#/components/schemas/_types.SortResults" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#search-after" + }, + "description": "The search after definition.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortResults" + } + ] } } }, @@ -77627,7 +90232,12 @@ "type": "object", "properties": { "query": { - "$ref": "#/components/schemas/security.query_role.RoleQueryContainer" + "description": "A query to filter which roles to return.\nIf the query parameter is missing, it is equivalent to a `match_all` query.\nThe query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`,\n`ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`.\nYou can query the following information associated with roles: `name`, `description`, `metadata`,\n`applications.application`, `applications.privileges`, and `applications.resources`.", + "allOf": [ + { + "$ref": "#/components/schemas/security.query_role.RoleQueryContainer" + } + ] }, "from": { "description": "The starting document offset.\nIt must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", @@ -77635,7 +90245,12 @@ "type": "number" }, "sort": { - "$ref": "#/components/schemas/_types.Sort" + "description": "The sort definition.\nYou can sort on `username`, `roles`, or `enabled`.\nIn addition, sort can also be applied to the `_doc` field to sort by index order.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Sort" + } + ] }, "size": { "description": "The number of hits to return.\nIt must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", @@ -77643,7 +90258,15 @@ "type": "number" }, "search_after": { - "$ref": "#/components/schemas/_types.SortResults" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#search-after" + }, + "description": "The search after definition.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.SortResults" + } + ] } } }, @@ -77700,7 +90323,16 @@ "type": "boolean" }, "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/sql-rest-filtering" + }, + "description": "The Elasticsearch query DSL for additional filtering.", + "default": "none", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "index_using_frozen": { "description": "If `true`, the search can run on frozen indices.", @@ -77708,7 +90340,13 @@ "type": "boolean" }, "keep_alive": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The retention period for an async or saved synchronous search.", + "default": "5d", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "keep_on_completion": { "description": "If `true`, Elasticsearch stores synchronous searches if you also specify the `wait_for_completion_timeout` parameter.\nIf `false`, Elasticsearch only stores async searches that don't finish before the `wait_for_completion_timeout`.", @@ -77716,7 +90354,13 @@ "type": "boolean" }, "page_timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The minimum retention period for the scroll cursor.\nAfter this time period, a pagination request might fail because the scroll cursor is no longer available.\nSubsequent scroll requests prolong the lifetime of the scroll cursor by the duration of `page_timeout` in the scroll request.", + "default": "45s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "params": { "description": "The values for parameters in the query.", @@ -77733,16 +90377,41 @@ "type": "string" }, "request_timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The timeout before the request fails.", + "default": "90s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "runtime_mappings": { - "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + "description": "One or more runtime fields for the search request.\nThese fields take precedence over mapped fields with the same name.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping.RuntimeFields" + } + ] }, "time_zone": { - "$ref": "#/components/schemas/_types.TimeZone" + "externalDocs": { + "url": "https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html" + }, + "description": "The ISO-8601 time zone ID for the search.", + "default": "Z", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TimeZone" + } + ] }, "wait_for_completion_timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The period to wait for complete results.\nIt defaults to no timeout, meaning the request waits for complete search results.\nIf the search doesn't finish within this period, the search becomes async.\n\nTo save a synchronous search, you must specify this parameter and the `keep_on_completion` parameter.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] } } }, @@ -77768,14 +90437,32 @@ "type": "number" }, "filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/sql-rest-filtering" + }, + "description": "The Elasticsearch query DSL for additional filtering.", + "default": "none", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "query": { "description": "The SQL query to run.", "type": "string" }, "time_zone": { - "$ref": "#/components/schemas/_types.TimeZone" + "externalDocs": { + "url": "https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html" + }, + "description": "The ISO-8601 time zone ID for the search.", + "default": "Z", + "allOf": [ + { + "$ref": "#/components/schemas/_types.TimeZone" + } + ] } }, "required": [ @@ -77800,7 +90487,12 @@ "type": "object", "properties": { "field": { - "$ref": "#/components/schemas/_types.Field" + "description": "The string to match at the start of indexed terms. If not provided, all terms in the field are considered.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Field" + } + ] }, "size": { "description": "The number of matching terms to return.", @@ -77808,7 +90500,13 @@ "type": "number" }, "timeout": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The maximum length of time to spend collecting results.\nIf the timeout is exceeded the `complete` flag set to `false` in the response and the results may be partial or empty.", + "default": "1s", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "case_insensitive": { "description": "When `true`, the provided search string is matched against index terms without case sensitivity.", @@ -77816,7 +90514,12 @@ "type": "boolean" }, "index_filter": { - "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + "description": "Filter an index shard if the provided query rewrites to `match_none`.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl.QueryContainer" + } + ] }, "string": { "description": "The string to match at the start of indexed terms.\nIf it is not provided, all terms in the field are considered.\n\n> info\n> The prefix string cannot be larger than the largest possible keyword value, which is Lucene's term byte-length limit of 32766.", @@ -77851,7 +90554,15 @@ "type": "object" }, "filter": { - "$ref": "#/components/schemas/_global.termvectors.Filter" + "externalDocs": { + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-mlt-query" + }, + "description": "Filter terms based on their tf-idf scores.\nThis could be useful in order find out a good characteristic vector of a document.\nThis feature works in a similar manner to the second phase of the More Like This Query.", + "allOf": [ + { + "$ref": "#/components/schemas/_global.termvectors.Filter" + } + ] }, "per_field_analyzer": { "description": "Override the default per-field analyzer.\nThis is useful in order to generate term vectors in any fashion, especially when using artificial documents.\nWhen providing an analyzer for a field that already stores term vectors, the term vectors will be regenerated.", @@ -77893,13 +90604,28 @@ "type": "boolean" }, "routing": { - "$ref": "#/components/schemas/_types.Routing" + "description": "A custom value that is used to route operations to a specific shard.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Routing" + } + ] }, "version": { - "$ref": "#/components/schemas/_types.VersionNumber" + "description": "If `true`, returns the document version as part of a hit.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionNumber" + } + ] }, "version_type": { - "$ref": "#/components/schemas/_types.VersionType" + "description": "The version type.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.VersionType" + } + ] } } }, @@ -77940,32 +90666,73 @@ "type": "object", "properties": { "dest": { - "$ref": "#/components/schemas/transform._types.Destination" + "description": "The destination for the transform.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Destination" + } + ] }, "description": { "description": "Free text description of the transform.", "type": "string" }, "frequency": { - "$ref": "#/components/schemas/_types.Duration" + "description": "The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is 1s and the maximum is 1h.", + "default": "1m", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] }, "pivot": { - "$ref": "#/components/schemas/transform._types.Pivot" + "description": "The pivot method transforms the data by aggregating and grouping it.\nThese objects define the group by fields and the aggregation to reduce\nthe data.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Pivot" + } + ] }, "source": { - "$ref": "#/components/schemas/transform._types.Source" + "description": "The source of the data for the transform.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Source" + } + ] }, "settings": { - "$ref": "#/components/schemas/transform._types.Settings" + "description": "Defines optional transform settings.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Settings" + } + ] }, "sync": { - "$ref": "#/components/schemas/transform._types.SyncContainer" + "description": "Defines the properties transforms require to run continuously.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.SyncContainer" + } + ] }, "retention_policy": { - "$ref": "#/components/schemas/transform._types.RetentionPolicyContainer" + "description": "Defines a retention policy for the transform. Data that meets the defined\ncriteria is deleted from the destination index.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.RetentionPolicyContainer" + } + ] }, "latest": { - "$ref": "#/components/schemas/transform._types.Latest" + "description": "The latest method transforms the data by finding the latest document for\neach unique key.", + "allOf": [ + { + "$ref": "#/components/schemas/transform._types.Latest" + } + ] } } },