From 8e91c0692c0235474a0c21bb7e9716a8430e8533 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Tue, 6 Aug 2024 10:02:48 -0700 Subject: [PATCH] Add transform API via overlay (#2755) --- Makefile | 4 +- ...ticsearch-serverless-openapi-overlays.yaml | 20 +- ...ticsearch-serverless-openapi.examples.json | 62475 ++++++++++++++++ 3 files changed, 62497 insertions(+), 2 deletions(-) create mode 100644 output/openapi/elasticsearch-serverless-openapi.examples.json diff --git a/Makefile b/Makefile index 6f42c3b17c..619952dfb2 100644 --- a/Makefile +++ b/Makefile @@ -60,7 +60,9 @@ dump-routes: ## Create a new schema with all generics expanded contrib: | generate license-check spec-format-fix transform-to-openapi filter-for-serverless ## Pre contribution target overlay-docs: ## Apply overlays to OpenAPI documents - @npx bump overlay "output/openapi/elasticsearch-serverless-openapi.json" "docs/overlays/elasticsearch-serverless-openapi-overlays.yaml" > "output/openapi/elasticsearch-serverless-openapi.new.json" + @npx bump overlay "output/openapi/elasticsearch-serverless-openapi.json" "docs/overlays/elasticsearch-serverless-openapi-overlays.yaml" > "output/openapi/elasticsearch-serverless-openapi.tmp.json" + @npx @redocly/cli bundle output/openapi/elasticsearch-serverless-openapi.tmp.json --ext json -o output/openapi/elasticsearch-serverless-openapi.examples.json + rm output/openapi/elasticsearch-serverless-openapi.tmp.json lint-docs: ## Lint the OpenAPI documents @npx @stoplight/spectral-cli lint output/openapi/*.json --ruleset .spectral.yaml diff --git a/docs/overlays/elasticsearch-serverless-openapi-overlays.yaml b/docs/overlays/elasticsearch-serverless-openapi-overlays.yaml index e79f9947d7..0f9be46158 100644 --- a/docs/overlays/elasticsearch-serverless-openapi-overlays.yaml +++ b/docs/overlays/elasticsearch-serverless-openapi-overlays.yaml @@ -11,5 +11,23 @@ actions: **Technical preview** This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. - + - target: "$.paths['/_transform/{transform_id}']['put']" + description: "Update create transform operation" + update: + requestBody: + content: + application/json: + examples: + createTransformRequestExample1: + $ref: "../../specification/transform/put_transform/examples/request/PutTransformRequestExample1.json" + createTransformRequestExample2: + $ref: "../../specification/transform/put_transform/examples/request/PutTransformRequestExample2.json" + responses: + 200: + content: + application/json: + examples: + createTransformResponseExample1: + $ref: "../../specification/transform/put_transform/examples/200_response/PutTransformResponseExample1.json" + diff --git a/output/openapi/elasticsearch-serverless-openapi.examples.json b/output/openapi/elasticsearch-serverless-openapi.examples.json new file mode 100644 index 0000000000..913b405a6a --- /dev/null +++ b/output/openapi/elasticsearch-serverless-openapi.examples.json @@ -0,0 +1,62475 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "Elasticsearch Request & Response Specification", + "license": { + "name": "Apache 2.0", + "url": "https://github.com/elastic/elasticsearch-specification/blob/main/LICENSE" + }, + "version": "", + "description": "**Technical preview** This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n" + }, + "paths": { + "/_async_search/{id}": { + "get": { + "tags": [ + "async_search.get" + ], + "summary": "Retrieves the results of a previously submitted async search request given its identifier", + "description": "If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html" + }, + "operationId": "async-search-get", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "A unique identifier for the async search.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "keep_alive", + "description": "Specifies how long the async search should be available in the cluster.\nWhen not specified, the `keep_alive` set with the corresponding submit async request will be used.\nOtherwise, it is possible to override the value and extend the validity of the request.\nWhen this period expires, the search, if still running, is cancelled.\nIf the search is completed, its saved results are deleted.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "typed_keys", + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "wait_for_completion_timeout", + "description": "Specifies to wait for the search to be completed up until the provided timeout.\nFinal results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires.\nBy default no timeout is set meaning that the currently available results will be returned without any additional wait.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/async_search._types:AsyncSearchDocumentResponseBase" + } + } + } + } + }, + "x-available-since": "7.7.0" + }, + "delete": { + "tags": [ + "async_search.delete" + ], + "summary": "Deletes an async search by identifier", + "description": "If the search is still running, the search request will be cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html" + }, + "operationId": "async-search-delete", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "A unique identifier for the async search.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "7.7.0" + } + }, + "/_async_search/status/{id}": { + "get": { + "tags": [ + "async_search.status" + ], + "summary": "Get async search status\n", + "description": "Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html" + }, + "operationId": "async-search-status", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "A unique identifier for the async search.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/async_search.status:StatusResponseBase" + } + } + } + } + }, + "x-available-since": "7.11.0" + } + }, + "/_async_search": { + "post": { + "tags": [ + "async_search.submit" + ], + "summary": "Runs a search request asynchronously", + "description": "When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html" + }, + "operationId": "async-search-submit", + "parameters": [ + { + "$ref": "#/components/parameters/async_search.submit#wait_for_completion_timeout" + }, + { + "$ref": "#/components/parameters/async_search.submit#keep_on_completion" + }, + { + "$ref": "#/components/parameters/async_search.submit#keep_alive" + }, + { + "$ref": "#/components/parameters/async_search.submit#allow_no_indices" + }, + { + "$ref": "#/components/parameters/async_search.submit#allow_partial_search_results" + }, + { + "$ref": "#/components/parameters/async_search.submit#analyzer" + }, + { + "$ref": "#/components/parameters/async_search.submit#analyze_wildcard" + }, + { + "$ref": "#/components/parameters/async_search.submit#batched_reduce_size" + }, + { + "$ref": "#/components/parameters/async_search.submit#ccs_minimize_roundtrips" + }, + { + "$ref": "#/components/parameters/async_search.submit#default_operator" + }, + { + "$ref": "#/components/parameters/async_search.submit#df" + }, + { + "$ref": "#/components/parameters/async_search.submit#docvalue_fields" + }, + { + "$ref": "#/components/parameters/async_search.submit#expand_wildcards" + }, + { + "$ref": "#/components/parameters/async_search.submit#explain" + }, + { + "$ref": "#/components/parameters/async_search.submit#ignore_throttled" + }, + { + "$ref": "#/components/parameters/async_search.submit#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/async_search.submit#lenient" + }, + { + "$ref": "#/components/parameters/async_search.submit#max_concurrent_shard_requests" + }, + { + "$ref": "#/components/parameters/async_search.submit#min_compatible_shard_node" + }, + { + "$ref": "#/components/parameters/async_search.submit#preference" + }, + { + "$ref": "#/components/parameters/async_search.submit#pre_filter_shard_size" + }, + { + "$ref": "#/components/parameters/async_search.submit#request_cache" + }, + { + "$ref": "#/components/parameters/async_search.submit#routing" + }, + { + "$ref": "#/components/parameters/async_search.submit#scroll" + }, + { + "$ref": "#/components/parameters/async_search.submit#search_type" + }, + { + "$ref": "#/components/parameters/async_search.submit#stats" + }, + { + "$ref": "#/components/parameters/async_search.submit#stored_fields" + }, + { + "$ref": "#/components/parameters/async_search.submit#suggest_field" + }, + { + "$ref": "#/components/parameters/async_search.submit#suggest_mode" + }, + { + "$ref": "#/components/parameters/async_search.submit#suggest_size" + }, + { + "$ref": "#/components/parameters/async_search.submit#suggest_text" + }, + { + "$ref": "#/components/parameters/async_search.submit#terminate_after" + }, + { + "$ref": "#/components/parameters/async_search.submit#timeout" + }, + { + "$ref": "#/components/parameters/async_search.submit#track_total_hits" + }, + { + "$ref": "#/components/parameters/async_search.submit#track_scores" + }, + { + "$ref": "#/components/parameters/async_search.submit#typed_keys" + }, + { + "$ref": "#/components/parameters/async_search.submit#rest_total_hits_as_int" + }, + { + "$ref": "#/components/parameters/async_search.submit#version" + }, + { + "$ref": "#/components/parameters/async_search.submit#_source" + }, + { + "$ref": "#/components/parameters/async_search.submit#_source_excludes" + }, + { + "$ref": "#/components/parameters/async_search.submit#_source_includes" + }, + { + "$ref": "#/components/parameters/async_search.submit#seq_no_primary_term" + }, + { + "$ref": "#/components/parameters/async_search.submit#q" + }, + { + "$ref": "#/components/parameters/async_search.submit#size" + }, + { + "$ref": "#/components/parameters/async_search.submit#from" + }, + { + "$ref": "#/components/parameters/async_search.submit#sort" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/async_search.submit" + }, + "responses": { + "200": { + "$ref": "#/components/responses/async_search.submit#200" + } + }, + "x-available-since": "7.7.0" + } + }, + "/{index}/_async_search": { + "post": { + "tags": [ + "async_search.submit" + ], + "summary": "Runs a search request asynchronously", + "description": "When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html" + }, + "operationId": "async-search-submit-1", + "parameters": [ + { + "$ref": "#/components/parameters/async_search.submit#index" + }, + { + "$ref": "#/components/parameters/async_search.submit#wait_for_completion_timeout" + }, + { + "$ref": "#/components/parameters/async_search.submit#keep_on_completion" + }, + { + "$ref": "#/components/parameters/async_search.submit#keep_alive" + }, + { + "$ref": "#/components/parameters/async_search.submit#allow_no_indices" + }, + { + "$ref": "#/components/parameters/async_search.submit#allow_partial_search_results" + }, + { + "$ref": "#/components/parameters/async_search.submit#analyzer" + }, + { + "$ref": "#/components/parameters/async_search.submit#analyze_wildcard" + }, + { + "$ref": "#/components/parameters/async_search.submit#batched_reduce_size" + }, + { + "$ref": "#/components/parameters/async_search.submit#ccs_minimize_roundtrips" + }, + { + "$ref": "#/components/parameters/async_search.submit#default_operator" + }, + { + "$ref": "#/components/parameters/async_search.submit#df" + }, + { + "$ref": "#/components/parameters/async_search.submit#docvalue_fields" + }, + { + "$ref": "#/components/parameters/async_search.submit#expand_wildcards" + }, + { + "$ref": "#/components/parameters/async_search.submit#explain" + }, + { + "$ref": "#/components/parameters/async_search.submit#ignore_throttled" + }, + { + "$ref": "#/components/parameters/async_search.submit#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/async_search.submit#lenient" + }, + { + "$ref": "#/components/parameters/async_search.submit#max_concurrent_shard_requests" + }, + { + "$ref": "#/components/parameters/async_search.submit#min_compatible_shard_node" + }, + { + "$ref": "#/components/parameters/async_search.submit#preference" + }, + { + "$ref": "#/components/parameters/async_search.submit#pre_filter_shard_size" + }, + { + "$ref": "#/components/parameters/async_search.submit#request_cache" + }, + { + "$ref": "#/components/parameters/async_search.submit#routing" + }, + { + "$ref": "#/components/parameters/async_search.submit#scroll" + }, + { + "$ref": "#/components/parameters/async_search.submit#search_type" + }, + { + "$ref": "#/components/parameters/async_search.submit#stats" + }, + { + "$ref": "#/components/parameters/async_search.submit#stored_fields" + }, + { + "$ref": "#/components/parameters/async_search.submit#suggest_field" + }, + { + "$ref": "#/components/parameters/async_search.submit#suggest_mode" + }, + { + "$ref": "#/components/parameters/async_search.submit#suggest_size" + }, + { + "$ref": "#/components/parameters/async_search.submit#suggest_text" + }, + { + "$ref": "#/components/parameters/async_search.submit#terminate_after" + }, + { + "$ref": "#/components/parameters/async_search.submit#timeout" + }, + { + "$ref": "#/components/parameters/async_search.submit#track_total_hits" + }, + { + "$ref": "#/components/parameters/async_search.submit#track_scores" + }, + { + "$ref": "#/components/parameters/async_search.submit#typed_keys" + }, + { + "$ref": "#/components/parameters/async_search.submit#rest_total_hits_as_int" + }, + { + "$ref": "#/components/parameters/async_search.submit#version" + }, + { + "$ref": "#/components/parameters/async_search.submit#_source" + }, + { + "$ref": "#/components/parameters/async_search.submit#_source_excludes" + }, + { + "$ref": "#/components/parameters/async_search.submit#_source_includes" + }, + { + "$ref": "#/components/parameters/async_search.submit#seq_no_primary_term" + }, + { + "$ref": "#/components/parameters/async_search.submit#q" + }, + { + "$ref": "#/components/parameters/async_search.submit#size" + }, + { + "$ref": "#/components/parameters/async_search.submit#from" + }, + { + "$ref": "#/components/parameters/async_search.submit#sort" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/async_search.submit" + }, + "responses": { + "200": { + "$ref": "#/components/responses/async_search.submit#200" + } + }, + "x-available-since": "7.7.0" + } + }, + "/_bulk": { + "put": { + "tags": [ + "bulk" + ], + "summary": "Bulk index or delete documents", + "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html" + }, + "operationId": "bulk-1", + "parameters": [ + { + "$ref": "#/components/parameters/bulk#pipeline" + }, + { + "$ref": "#/components/parameters/bulk#refresh" + }, + { + "$ref": "#/components/parameters/bulk#routing" + }, + { + "$ref": "#/components/parameters/bulk#_source" + }, + { + "$ref": "#/components/parameters/bulk#_source_excludes" + }, + { + "$ref": "#/components/parameters/bulk#_source_includes" + }, + { + "$ref": "#/components/parameters/bulk#timeout" + }, + { + "$ref": "#/components/parameters/bulk#wait_for_active_shards" + }, + { + "$ref": "#/components/parameters/bulk#require_alias" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/bulk" + }, + "responses": { + "200": { + "$ref": "#/components/responses/bulk#200" + } + } + }, + "post": { + "tags": [ + "bulk" + ], + "summary": "Bulk index or delete documents", + "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html" + }, + "operationId": "bulk", + "parameters": [ + { + "$ref": "#/components/parameters/bulk#pipeline" + }, + { + "$ref": "#/components/parameters/bulk#refresh" + }, + { + "$ref": "#/components/parameters/bulk#routing" + }, + { + "$ref": "#/components/parameters/bulk#_source" + }, + { + "$ref": "#/components/parameters/bulk#_source_excludes" + }, + { + "$ref": "#/components/parameters/bulk#_source_includes" + }, + { + "$ref": "#/components/parameters/bulk#timeout" + }, + { + "$ref": "#/components/parameters/bulk#wait_for_active_shards" + }, + { + "$ref": "#/components/parameters/bulk#require_alias" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/bulk" + }, + "responses": { + "200": { + "$ref": "#/components/responses/bulk#200" + } + } + } + }, + "/{index}/_bulk": { + "put": { + "tags": [ + "bulk" + ], + "summary": "Bulk index or delete documents", + "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html" + }, + "operationId": "bulk-3", + "parameters": [ + { + "$ref": "#/components/parameters/bulk#index" + }, + { + "$ref": "#/components/parameters/bulk#pipeline" + }, + { + "$ref": "#/components/parameters/bulk#refresh" + }, + { + "$ref": "#/components/parameters/bulk#routing" + }, + { + "$ref": "#/components/parameters/bulk#_source" + }, + { + "$ref": "#/components/parameters/bulk#_source_excludes" + }, + { + "$ref": "#/components/parameters/bulk#_source_includes" + }, + { + "$ref": "#/components/parameters/bulk#timeout" + }, + { + "$ref": "#/components/parameters/bulk#wait_for_active_shards" + }, + { + "$ref": "#/components/parameters/bulk#require_alias" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/bulk" + }, + "responses": { + "200": { + "$ref": "#/components/responses/bulk#200" + } + } + }, + "post": { + "tags": [ + "bulk" + ], + "summary": "Bulk index or delete documents", + "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html" + }, + "operationId": "bulk-2", + "parameters": [ + { + "$ref": "#/components/parameters/bulk#index" + }, + { + "$ref": "#/components/parameters/bulk#pipeline" + }, + { + "$ref": "#/components/parameters/bulk#refresh" + }, + { + "$ref": "#/components/parameters/bulk#routing" + }, + { + "$ref": "#/components/parameters/bulk#_source" + }, + { + "$ref": "#/components/parameters/bulk#_source_excludes" + }, + { + "$ref": "#/components/parameters/bulk#_source_includes" + }, + { + "$ref": "#/components/parameters/bulk#timeout" + }, + { + "$ref": "#/components/parameters/bulk#wait_for_active_shards" + }, + { + "$ref": "#/components/parameters/bulk#require_alias" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/bulk" + }, + "responses": { + "200": { + "$ref": "#/components/responses/bulk#200" + } + } + } + }, + "/_cat/aliases": { + "get": { + "tags": [ + "cat.aliases" + ], + "summary": "Get aliases", + "description": "Retrieves the cluster’s index aliases, including filter and routing information.\nThe API does not return data stream aliases.\n\nCAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-alias.html" + }, + "operationId": "cat-aliases", + "parameters": [ + { + "$ref": "#/components/parameters/cat.aliases#expand_wildcards" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/cat.aliases#200" + } + } + } + }, + "/_cat/aliases/{name}": { + "get": { + "tags": [ + "cat.aliases" + ], + "summary": "Get aliases", + "description": "Retrieves the cluster’s index aliases, including filter and routing information.\nThe API does not return data stream aliases.\n\nCAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-alias.html" + }, + "operationId": "cat-aliases-1", + "parameters": [ + { + "$ref": "#/components/parameters/cat.aliases#name" + }, + { + "$ref": "#/components/parameters/cat.aliases#expand_wildcards" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/cat.aliases#200" + } + } + } + }, + "/_cat/component_templates": { + "get": { + "tags": [ + "cat.component_templates" + ], + "summary": "Get component templates", + "description": "Returns information about component templates in a cluster.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nCAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get component template API.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html" + }, + "operationId": "cat-component-templates", + "responses": { + "200": { + "$ref": "#/components/responses/cat.component_templates#200" + } + }, + "x-available-since": "5.1.0" + } + }, + "/_cat/component_templates/{name}": { + "get": { + "tags": [ + "cat.component_templates" + ], + "summary": "Get component templates", + "description": "Returns information about component templates in a cluster.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nCAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get component template API.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html" + }, + "operationId": "cat-component-templates-1", + "parameters": [ + { + "$ref": "#/components/parameters/cat.component_templates#name" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/cat.component_templates#200" + } + }, + "x-available-since": "5.1.0" + } + }, + "/_cat/count": { + "get": { + "tags": [ + "cat.count" + ], + "summary": "Get a document count", + "description": "Provides quick access to a document count for a data stream, an index, or an entire cluster.n/\nThe document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\n\nCAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the count API.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-count.html" + }, + "operationId": "cat-count", + "responses": { + "200": { + "$ref": "#/components/responses/cat.count#200" + } + } + } + }, + "/_cat/count/{index}": { + "get": { + "tags": [ + "cat.count" + ], + "summary": "Get a document count", + "description": "Provides quick access to a document count for a data stream, an index, or an entire cluster.n/\nThe document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\n\nCAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the count API.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-count.html" + }, + "operationId": "cat-count-1", + "parameters": [ + { + "$ref": "#/components/parameters/cat.count#index" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/cat.count#200" + } + } + } + }, + "/_cat": { + "get": { + "tags": [ + "cat.help" + ], + "summary": "Get CAT help", + "description": "Returns help for the CAT APIs.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat.html" + }, + "operationId": "cat-help", + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/cat.help:HelpRecord" + } + } + } + } + } + } + } + }, + "/_cat/indices": { + "get": { + "tags": [ + "cat.indices" + ], + "summary": "Get index information", + "description": "Returns high-level information about indices in a cluster, including backing indices for data streams.\n\nUse this request to get the following information for each index in a cluster:\n- shard count\n- document count\n- deleted document count\n- primary store size\n- total store size of all shards, including shard replicas\n\nThese metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents.\nTo get an accurate count of Elasticsearch documents, use the cat count or count APIs.\n\nCAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use an index endpoint.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html" + }, + "operationId": "cat-indices", + "parameters": [ + { + "$ref": "#/components/parameters/cat.indices#bytes" + }, + { + "$ref": "#/components/parameters/cat.indices#expand_wildcards" + }, + { + "$ref": "#/components/parameters/cat.indices#health" + }, + { + "$ref": "#/components/parameters/cat.indices#include_unloaded_segments" + }, + { + "$ref": "#/components/parameters/cat.indices#pri" + }, + { + "$ref": "#/components/parameters/cat.indices#time" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/cat.indices#200" + } + } + } + }, + "/_cat/indices/{index}": { + "get": { + "tags": [ + "cat.indices" + ], + "summary": "Get index information", + "description": "Returns high-level information about indices in a cluster, including backing indices for data streams.\n\nUse this request to get the following information for each index in a cluster:\n- shard count\n- document count\n- deleted document count\n- primary store size\n- total store size of all shards, including shard replicas\n\nThese metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents.\nTo get an accurate count of Elasticsearch documents, use the cat count or count APIs.\n\nCAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use an index endpoint.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html" + }, + "operationId": "cat-indices-1", + "parameters": [ + { + "$ref": "#/components/parameters/cat.indices#index" + }, + { + "$ref": "#/components/parameters/cat.indices#bytes" + }, + { + "$ref": "#/components/parameters/cat.indices#expand_wildcards" + }, + { + "$ref": "#/components/parameters/cat.indices#health" + }, + { + "$ref": "#/components/parameters/cat.indices#include_unloaded_segments" + }, + { + "$ref": "#/components/parameters/cat.indices#pri" + }, + { + "$ref": "#/components/parameters/cat.indices#time" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/cat.indices#200" + } + } + } + }, + "/_cat/ml/data_frame/analytics": { + "get": { + "tags": [ + "cat.ml_data_frame_analytics" + ], + "summary": "Get data frame analytics jobs", + "description": "Returns configuration and usage information about data frame analytics jobs.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get data frame analytics jobs statistics API.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html" + }, + "operationId": "cat-ml-data-frame-analytics", + "parameters": [ + { + "$ref": "#/components/parameters/cat.ml_data_frame_analytics#allow_no_match" + }, + { + "$ref": "#/components/parameters/cat.ml_data_frame_analytics#bytes" + }, + { + "$ref": "#/components/parameters/cat.ml_data_frame_analytics#h" + }, + { + "$ref": "#/components/parameters/cat.ml_data_frame_analytics#s" + }, + { + "$ref": "#/components/parameters/cat.ml_data_frame_analytics#time" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/cat.ml_data_frame_analytics#200" + } + }, + "x-available-since": "7.7.0" + } + }, + "/_cat/ml/data_frame/analytics/{id}": { + "get": { + "tags": [ + "cat.ml_data_frame_analytics" + ], + "summary": "Get data frame analytics jobs", + "description": "Returns configuration and usage information about data frame analytics jobs.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get data frame analytics jobs statistics API.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html" + }, + "operationId": "cat-ml-data-frame-analytics-1", + "parameters": [ + { + "$ref": "#/components/parameters/cat.ml_data_frame_analytics#id" + }, + { + "$ref": "#/components/parameters/cat.ml_data_frame_analytics#allow_no_match" + }, + { + "$ref": "#/components/parameters/cat.ml_data_frame_analytics#bytes" + }, + { + "$ref": "#/components/parameters/cat.ml_data_frame_analytics#h" + }, + { + "$ref": "#/components/parameters/cat.ml_data_frame_analytics#s" + }, + { + "$ref": "#/components/parameters/cat.ml_data_frame_analytics#time" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/cat.ml_data_frame_analytics#200" + } + }, + "x-available-since": "7.7.0" + } + }, + "/_cat/ml/datafeeds": { + "get": { + "tags": [ + "cat.ml_datafeeds" + ], + "summary": "Get datafeeds", + "description": "Returns configuration and usage information about datafeeds.\nThis API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get datafeed statistics API.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html" + }, + "operationId": "cat-ml-datafeeds", + "parameters": [ + { + "$ref": "#/components/parameters/cat.ml_datafeeds#allow_no_match" + }, + { + "$ref": "#/components/parameters/cat.ml_datafeeds#h" + }, + { + "$ref": "#/components/parameters/cat.ml_datafeeds#s" + }, + { + "$ref": "#/components/parameters/cat.ml_datafeeds#time" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/cat.ml_datafeeds#200" + } + }, + "x-available-since": "7.7.0" + } + }, + "/_cat/ml/datafeeds/{datafeed_id}": { + "get": { + "tags": [ + "cat.ml_datafeeds" + ], + "summary": "Get datafeeds", + "description": "Returns configuration and usage information about datafeeds.\nThis API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get datafeed statistics API.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html" + }, + "operationId": "cat-ml-datafeeds-1", + "parameters": [ + { + "$ref": "#/components/parameters/cat.ml_datafeeds#datafeed_id" + }, + { + "$ref": "#/components/parameters/cat.ml_datafeeds#allow_no_match" + }, + { + "$ref": "#/components/parameters/cat.ml_datafeeds#h" + }, + { + "$ref": "#/components/parameters/cat.ml_datafeeds#s" + }, + { + "$ref": "#/components/parameters/cat.ml_datafeeds#time" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/cat.ml_datafeeds#200" + } + }, + "x-available-since": "7.7.0" + } + }, + "/_cat/ml/anomaly_detectors": { + "get": { + "tags": [ + "cat.ml_jobs" + ], + "summary": "Get anomaly detection jobs", + "description": "Returns configuration and usage information for anomaly detection jobs.\nThis API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get anomaly detection job statistics API.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html" + }, + "operationId": "cat-ml-jobs", + "parameters": [ + { + "$ref": "#/components/parameters/cat.ml_jobs#allow_no_match" + }, + { + "$ref": "#/components/parameters/cat.ml_jobs#bytes" + }, + { + "$ref": "#/components/parameters/cat.ml_jobs#h" + }, + { + "$ref": "#/components/parameters/cat.ml_jobs#s" + }, + { + "$ref": "#/components/parameters/cat.ml_jobs#time" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/cat.ml_jobs#200" + } + }, + "x-available-since": "7.7.0" + } + }, + "/_cat/ml/anomaly_detectors/{job_id}": { + "get": { + "tags": [ + "cat.ml_jobs" + ], + "summary": "Get anomaly detection jobs", + "description": "Returns configuration and usage information for anomaly detection jobs.\nThis API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get anomaly detection job statistics API.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html" + }, + "operationId": "cat-ml-jobs-1", + "parameters": [ + { + "$ref": "#/components/parameters/cat.ml_jobs#job_id" + }, + { + "$ref": "#/components/parameters/cat.ml_jobs#allow_no_match" + }, + { + "$ref": "#/components/parameters/cat.ml_jobs#bytes" + }, + { + "$ref": "#/components/parameters/cat.ml_jobs#h" + }, + { + "$ref": "#/components/parameters/cat.ml_jobs#s" + }, + { + "$ref": "#/components/parameters/cat.ml_jobs#time" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/cat.ml_jobs#200" + } + }, + "x-available-since": "7.7.0" + } + }, + "/_cat/ml/trained_models": { + "get": { + "tags": [ + "cat.ml_trained_models" + ], + "summary": "Get trained models", + "description": "Returns configuration and usage information about inference trained models.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get trained models statistics API.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html" + }, + "operationId": "cat-ml-trained-models", + "parameters": [ + { + "$ref": "#/components/parameters/cat.ml_trained_models#allow_no_match" + }, + { + "$ref": "#/components/parameters/cat.ml_trained_models#bytes" + }, + { + "$ref": "#/components/parameters/cat.ml_trained_models#h" + }, + { + "$ref": "#/components/parameters/cat.ml_trained_models#s" + }, + { + "$ref": "#/components/parameters/cat.ml_trained_models#from" + }, + { + "$ref": "#/components/parameters/cat.ml_trained_models#size" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/cat.ml_trained_models#200" + } + }, + "x-available-since": "7.7.0" + } + }, + "/_cat/ml/trained_models/{model_id}": { + "get": { + "tags": [ + "cat.ml_trained_models" + ], + "summary": "Get trained models", + "description": "Returns configuration and usage information about inference trained models.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get trained models statistics API.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html" + }, + "operationId": "cat-ml-trained-models-1", + "parameters": [ + { + "$ref": "#/components/parameters/cat.ml_trained_models#model_id" + }, + { + "$ref": "#/components/parameters/cat.ml_trained_models#allow_no_match" + }, + { + "$ref": "#/components/parameters/cat.ml_trained_models#bytes" + }, + { + "$ref": "#/components/parameters/cat.ml_trained_models#h" + }, + { + "$ref": "#/components/parameters/cat.ml_trained_models#s" + }, + { + "$ref": "#/components/parameters/cat.ml_trained_models#from" + }, + { + "$ref": "#/components/parameters/cat.ml_trained_models#size" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/cat.ml_trained_models#200" + } + }, + "x-available-since": "7.7.0" + } + }, + "/_cat/transforms": { + "get": { + "tags": [ + "cat.transforms" + ], + "summary": "Get transforms", + "description": "Returns configuration and usage information about transforms.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html" + }, + "operationId": "cat-transforms", + "parameters": [ + { + "$ref": "#/components/parameters/cat.transforms#allow_no_match" + }, + { + "$ref": "#/components/parameters/cat.transforms#from" + }, + { + "$ref": "#/components/parameters/cat.transforms#h" + }, + { + "$ref": "#/components/parameters/cat.transforms#s" + }, + { + "$ref": "#/components/parameters/cat.transforms#time" + }, + { + "$ref": "#/components/parameters/cat.transforms#size" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/cat.transforms#200" + } + }, + "x-available-since": "7.7.0" + } + }, + "/_cat/transforms/{transform_id}": { + "get": { + "tags": [ + "cat.transforms" + ], + "summary": "Get transforms", + "description": "Returns configuration and usage information about transforms.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html" + }, + "operationId": "cat-transforms-1", + "parameters": [ + { + "$ref": "#/components/parameters/cat.transforms#transform_id" + }, + { + "$ref": "#/components/parameters/cat.transforms#allow_no_match" + }, + { + "$ref": "#/components/parameters/cat.transforms#from" + }, + { + "$ref": "#/components/parameters/cat.transforms#h" + }, + { + "$ref": "#/components/parameters/cat.transforms#s" + }, + { + "$ref": "#/components/parameters/cat.transforms#time" + }, + { + "$ref": "#/components/parameters/cat.transforms#size" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/cat.transforms#200" + } + }, + "x-available-since": "7.7.0" + } + }, + "/_search/scroll": { + "get": { + "tags": [ + "scroll" + ], + "summary": "Allows to retrieve a large numbers of results from a single search request", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll" + }, + "operationId": "scroll", + "parameters": [ + { + "$ref": "#/components/parameters/scroll#scroll" + }, + { + "$ref": "#/components/parameters/scroll#scroll_id_" + }, + { + "$ref": "#/components/parameters/scroll#rest_total_hits_as_int" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/scroll" + }, + "responses": { + "200": { + "$ref": "#/components/responses/scroll#200" + } + } + }, + "post": { + "tags": [ + "scroll" + ], + "summary": "Allows to retrieve a large numbers of results from a single search request", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll" + }, + "operationId": "scroll-1", + "parameters": [ + { + "$ref": "#/components/parameters/scroll#scroll" + }, + { + "$ref": "#/components/parameters/scroll#scroll_id_" + }, + { + "$ref": "#/components/parameters/scroll#rest_total_hits_as_int" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/scroll" + }, + "responses": { + "200": { + "$ref": "#/components/responses/scroll#200" + } + } + }, + "delete": { + "tags": [ + "clear_scroll" + ], + "summary": "Clears the search context and results for a scrolling search", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-scroll-api.html" + }, + "operationId": "clear-scroll", + "requestBody": { + "$ref": "#/components/requestBodies/clear_scroll" + }, + "responses": { + "200": { + "$ref": "#/components/responses/clear_scroll#200" + } + } + } + }, + "/_search/scroll/{scroll_id}": { + "get": { + "tags": [ + "scroll" + ], + "summary": "Allows to retrieve a large numbers of results from a single search request", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll" + }, + "operationId": "scroll-2", + "parameters": [ + { + "$ref": "#/components/parameters/scroll#scroll_id" + }, + { + "$ref": "#/components/parameters/scroll#scroll" + }, + { + "$ref": "#/components/parameters/scroll#scroll_id_" + }, + { + "$ref": "#/components/parameters/scroll#rest_total_hits_as_int" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/scroll" + }, + "responses": { + "200": { + "$ref": "#/components/responses/scroll#200" + } + } + }, + "post": { + "tags": [ + "scroll" + ], + "summary": "Allows to retrieve a large numbers of results from a single search request", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll" + }, + "operationId": "scroll-3", + "parameters": [ + { + "$ref": "#/components/parameters/scroll#scroll_id" + }, + { + "$ref": "#/components/parameters/scroll#scroll" + }, + { + "$ref": "#/components/parameters/scroll#scroll_id_" + }, + { + "$ref": "#/components/parameters/scroll#rest_total_hits_as_int" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/scroll" + }, + "responses": { + "200": { + "$ref": "#/components/responses/scroll#200" + } + } + }, + "delete": { + "tags": [ + "clear_scroll" + ], + "summary": "Clears the search context and results for a scrolling search", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-scroll-api.html" + }, + "operationId": "clear-scroll-1", + "parameters": [ + { + "$ref": "#/components/parameters/clear_scroll#scroll_id" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/clear_scroll" + }, + "responses": { + "200": { + "$ref": "#/components/responses/clear_scroll#200" + } + } + } + }, + "/_pit": { + "delete": { + "tags": [ + "close_point_in_time" + ], + "summary": "Closes a point-in-time", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html" + }, + "operationId": "close-point-in-time", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/_types:Id" + } + }, + "required": [ + "id" + ] + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "succeeded": { + "type": "boolean" + }, + "num_freed": { + "type": "number" + } + }, + "required": [ + "succeeded", + "num_freed" + ] + } + } + } + } + }, + "x-available-since": "7.10.0" + } + }, + "/_component_template/{name}": { + "get": { + "tags": [ + "cluster.get_component_template" + ], + "summary": "Get component templates", + "description": "Retrieves information about component templates.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html" + }, + "operationId": "cluster-get-component-template-1", + "parameters": [ + { + "$ref": "#/components/parameters/cluster.get_component_template#name" + }, + { + "$ref": "#/components/parameters/cluster.get_component_template#flat_settings" + }, + { + "$ref": "#/components/parameters/cluster.get_component_template#include_defaults" + }, + { + "$ref": "#/components/parameters/cluster.get_component_template#local" + }, + { + "$ref": "#/components/parameters/cluster.get_component_template#master_timeout" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/cluster.get_component_template#200" + } + }, + "x-available-since": "7.8.0" + }, + "put": { + "tags": [ + "cluster.put_component_template" + ], + "summary": "Create or update a component template", + "description": "Creates or updates a component template.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html" + }, + "operationId": "cluster-put-component-template", + "parameters": [ + { + "$ref": "#/components/parameters/cluster.put_component_template#name" + }, + { + "$ref": "#/components/parameters/cluster.put_component_template#create" + }, + { + "$ref": "#/components/parameters/cluster.put_component_template#master_timeout" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/cluster.put_component_template" + }, + "responses": { + "200": { + "$ref": "#/components/responses/cluster.put_component_template#200" + } + }, + "x-available-since": "7.8.0" + }, + "post": { + "tags": [ + "cluster.put_component_template" + ], + "summary": "Create or update a component template", + "description": "Creates or updates a component template.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html" + }, + "operationId": "cluster-put-component-template-1", + "parameters": [ + { + "$ref": "#/components/parameters/cluster.put_component_template#name" + }, + { + "$ref": "#/components/parameters/cluster.put_component_template#create" + }, + { + "$ref": "#/components/parameters/cluster.put_component_template#master_timeout" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/cluster.put_component_template" + }, + "responses": { + "200": { + "$ref": "#/components/responses/cluster.put_component_template#200" + } + }, + "x-available-since": "7.8.0" + }, + "delete": { + "tags": [ + "cluster.delete_component_template" + ], + "summary": "Delete component templates", + "description": "Deletes component templates.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html" + }, + "operationId": "cluster-delete-component-template", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "Comma-separated list or wildcard expression of component template names used to limit the request.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "simple" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "7.8.0" + }, + "head": { + "tags": [ + "cluster.exists_component_template" + ], + "summary": "Check component templates", + "description": "Returns information about whether a particular component template exists.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html" + }, + "operationId": "cluster-exists-component-template", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "Comma-separated list of component template names used to limit the request.\nWildcard (*) expressions are supported.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "simple" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "local", + "description": "If true, the request retrieves information from the local node only.\nDefaults to false, which means information is retrieved from the master node.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": {} + } + } + }, + "x-available-since": "7.8.0" + } + }, + "/_component_template": { + "get": { + "tags": [ + "cluster.get_component_template" + ], + "summary": "Get component templates", + "description": "Retrieves information about component templates.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html" + }, + "operationId": "cluster-get-component-template", + "parameters": [ + { + "$ref": "#/components/parameters/cluster.get_component_template#flat_settings" + }, + { + "$ref": "#/components/parameters/cluster.get_component_template#include_defaults" + }, + { + "$ref": "#/components/parameters/cluster.get_component_template#local" + }, + { + "$ref": "#/components/parameters/cluster.get_component_template#master_timeout" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/cluster.get_component_template#200" + } + }, + "x-available-since": "7.8.0" + } + }, + "/_info/{target}": { + "get": { + "tags": [ + "cluster.info" + ], + "summary": "Get cluster info", + "description": "Returns basic information about the cluster.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-info.html" + }, + "operationId": "cluster-info", + "parameters": [ + { + "in": "path", + "name": "target", + "description": "Limits the information returned to the specific target. Supports a comma-separated list, such as http,ingest.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ClusterInfoTargets" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cluster_name": { + "$ref": "#/components/schemas/_types:Name" + }, + "http": { + "$ref": "#/components/schemas/nodes._types:Http" + }, + "ingest": { + "$ref": "#/components/schemas/nodes._types:Ingest" + }, + "thread_pool": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/nodes._types:ThreadCount" + } + }, + "script": { + "$ref": "#/components/schemas/nodes._types:Scripting" + } + }, + "required": [ + "cluster_name" + ] + } + } + } + } + }, + "x-available-since": "8.9.0" + } + }, + "/_connector/{connector_id}/_check_in": { + "put": { + "tags": [ + "connector.check_in" + ], + "summary": "Updates the last_seen field in the connector, and sets it to current timestamp", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/check-in-connector-api.html" + }, + "operationId": "connector-check-in", + "parameters": [ + { + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector to be checked in", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } + } + }, + "x-technical-preview": true, + "x-available-since": "8.12.0" + } + }, + "/_connector/{connector_id}": { + "get": { + "tags": [ + "connector.get" + ], + "summary": "Retrieves a connector", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-connector-api.html" + }, + "operationId": "connector-get", + "parameters": [ + { + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/connector._types:Connector" + } + } + } + } + }, + "x-beta": true, + "x-available-since": "8.12.0" + }, + "put": { + "tags": [ + "connector.put" + ], + "summary": "Creates or updates a connector", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/create-connector-api.html" + }, + "operationId": "connector-put", + "parameters": [ + { + "$ref": "#/components/parameters/connector.put#connector_id" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/connector.put" + }, + "responses": { + "200": { + "$ref": "#/components/responses/connector.put#200" + } + }, + "x-beta": true, + "x-available-since": "8.12.0" + }, + "delete": { + "tags": [ + "connector.delete" + ], + "summary": "Deletes a connector", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-connector-api.html" + }, + "operationId": "connector-delete", + "parameters": [ + { + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector to be deleted", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "delete_sync_jobs", + "description": "A flag indicating if associated sync jobs should be also removed. Defaults to false.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-beta": true, + "x-available-since": "8.12.0" + } + }, + "/_connector": { + "get": { + "tags": [ + "connector.list" + ], + "summary": "Returns existing connectors", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/list-connector-api.html" + }, + "operationId": "connector-list", + "parameters": [ + { + "in": "query", + "name": "from", + "description": "Starting offset (default: 0)", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "size", + "description": "Specifies a max number of results to get", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "index_name", + "description": "A comma-separated list of connector index names to fetch connector documents for", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "form" + }, + { + "in": "query", + "name": "connector_name", + "description": "A comma-separated list of connector names to fetch connector documents for", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, + { + "in": "query", + "name": "service_type", + "description": "A comma-separated list of connector service types to fetch connector documents for", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "form" + }, + { + "in": "query", + "name": "query", + "description": "A wildcard query string that filters connectors with matching name, description or index name", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/connector._types:Connector" + } + } + }, + "required": [ + "count", + "results" + ] + } + } + } + } + }, + "x-beta": true, + "x-available-since": "8.12.0" + }, + "put": { + "tags": [ + "connector.put" + ], + "summary": "Creates or updates a connector", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/create-connector-api.html" + }, + "operationId": "connector-put-1", + "requestBody": { + "$ref": "#/components/requestBodies/connector.put" + }, + "responses": { + "200": { + "$ref": "#/components/responses/connector.put#200" + } + }, + "x-beta": true, + "x-available-since": "8.12.0" + }, + "post": { + "tags": [ + "connector.post" + ], + "summary": "Creates a connector", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/create-connector-api.html" + }, + "operationId": "connector-post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "index_name": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "is_native": { + "type": "boolean" + }, + "language": { + "type": "string" + }, + "name": { + "type": "string" + }, + "service_type": { + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + }, + "id": { + "$ref": "#/components/schemas/_types:Id" + } + }, + "required": [ + "result", + "id" + ] + } + } + } + } + }, + "x-beta": true, + "x-available-since": "8.12.0" + } + }, + "/_connector/_sync_job/{connector_sync_job_id}/_cancel": { + "put": { + "tags": [ + "connector.sync_job_cancel" + ], + "summary": "Cancels a connector sync job", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cancel-connector-sync-job-api.html" + }, + "operationId": "connector-sync-job-cancel", + "parameters": [ + { + "in": "path", + "name": "connector_sync_job_id", + "description": "The unique identifier of the connector sync job", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } + } + }, + "x-beta": true, + "x-available-since": "8.12.0" + } + }, + "/_connector/_sync_job/{connector_sync_job_id}": { + "get": { + "tags": [ + "connector.sync_job_get" + ], + "summary": "Retrieves a connector sync job", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-connector-sync-job-api.html" + }, + "operationId": "connector-sync-job-get", + "parameters": [ + { + "in": "path", + "name": "connector_sync_job_id", + "description": "The unique identifier of the connector sync job", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/connector._types:ConnectorSyncJob" + } + } + } + } + }, + "x-beta": true, + "x-available-since": "8.12.0" + }, + "delete": { + "tags": [ + "connector.sync_job_delete" + ], + "summary": "Deletes a connector sync job", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-connector-sync-job-api.html" + }, + "operationId": "connector-sync-job-delete", + "parameters": [ + { + "in": "path", + "name": "connector_sync_job_id", + "description": "The unique identifier of the connector sync job to be deleted", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-beta": true, + "x-available-since": "8.12.0" + } + }, + "/_connector/_sync_job": { + "get": { + "tags": [ + "connector.sync_job_list" + ], + "summary": "Lists connector sync jobs", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/list-connector-sync-jobs-api.html" + }, + "operationId": "connector-sync-job-list", + "parameters": [ + { + "in": "query", + "name": "from", + "description": "Starting offset (default: 0)", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "size", + "description": "Specifies a max number of results to get", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "status", + "description": "A sync job status to fetch connector sync jobs for", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/connector._types:SyncStatus" + }, + "style": "form" + }, + { + "in": "query", + "name": "connector_id", + "description": "A connector id to fetch connector sync jobs for", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "form" + }, + { + "in": "query", + "name": "job_type", + "description": "A comma-separated list of job types to fetch the sync jobs for", + "deprecated": false, + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/connector._types:SyncJobType" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/connector._types:SyncJobType" + } + } + ] + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/connector._types:ConnectorSyncJob" + } + } + }, + "required": [ + "count", + "results" + ] + } + } + } + } + }, + "x-beta": true, + "x-available-since": "8.12.0" + }, + "post": { + "tags": [ + "connector.sync_job_post" + ], + "summary": "Creates a connector sync job", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/create-connector-sync-job-api.html" + }, + "operationId": "connector-sync-job-post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "job_type": { + "$ref": "#/components/schemas/connector._types:SyncJobType" + }, + "trigger_method": { + "$ref": "#/components/schemas/connector._types:SyncJobTriggerMethod" + } + }, + "required": [ + "id" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/_types:Id" + } + }, + "required": [ + "id" + ] + } + } + } + } + }, + "x-beta": true, + "x-available-since": "8.12.0" + } + }, + "/_connector/{connector_id}/_filtering/_activate": { + "put": { + "tags": [ + "connector.update_active_filtering" + ], + "summary": "Activates the valid draft filtering for a connector", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-filtering-api.html" + }, + "operationId": "connector-update-active-filtering", + "parameters": [ + { + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector to be updated", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } + } + }, + "x-technical-preview": true, + "x-available-since": "8.12.0" + } + }, + "/_connector/{connector_id}/_api_key_id": { + "put": { + "tags": [ + "connector.update_api_key_id" + ], + "summary": "Updates the API key id in the connector document", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-api-key-id-api.html" + }, + "operationId": "connector-update-api-key-id", + "parameters": [ + { + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector to be updated", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "api_key_id": { + "type": "string" + }, + "api_key_secret_id": { + "type": "string" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } + } + }, + "x-beta": true, + "x-available-since": "8.12.0" + } + }, + "/_connector/{connector_id}/_configuration": { + "put": { + "tags": [ + "connector.update_configuration" + ], + "summary": "Updates the configuration field in the connector document", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-configuration-api.html" + }, + "operationId": "connector-update-configuration", + "parameters": [ + { + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector to be updated", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "configuration": { + "$ref": "#/components/schemas/connector._types:ConnectorConfiguration" + }, + "values": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } + } + }, + "x-beta": true, + "x-available-since": "8.12.0" + } + }, + "/_connector/{connector_id}/_error": { + "put": { + "tags": [ + "connector.update_error" + ], + "summary": "Updates the filtering field in the connector document", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-error-api.html" + }, + "operationId": "connector-update-error", + "parameters": [ + { + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector to be updated", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/_spec_utils:NullValue" + } + ] + } + }, + "required": [ + "error" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } + } + }, + "x-technical-preview": true, + "x-available-since": "8.12.0" + } + }, + "/_connector/{connector_id}/_filtering": { + "put": { + "tags": [ + "connector.update_filtering" + ], + "summary": "Updates the filtering field in the connector document", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-filtering-api.html" + }, + "operationId": "connector-update-filtering", + "parameters": [ + { + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector to be updated", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "filtering": { + "type": "array", + "items": { + "$ref": "#/components/schemas/connector._types:FilteringConfig" + } + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/connector._types:FilteringRule" + } + }, + "advanced_snippet": { + "$ref": "#/components/schemas/connector._types:FilteringAdvancedSnippet" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } + } + }, + "x-beta": true, + "x-available-since": "8.12.0" + } + }, + "/_connector/{connector_id}/_filtering/_validation": { + "put": { + "tags": [ + "connector.update_filtering_validation" + ], + "summary": "Updates the draft filtering validation info for a connector", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-filtering-validation-api.html" + }, + "operationId": "connector-update-filtering-validation", + "parameters": [ + { + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector to be updated", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "validation": { + "$ref": "#/components/schemas/connector._types:FilteringRulesValidation" + } + }, + "required": [ + "validation" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } + } + }, + "x-technical-preview": true, + "x-available-since": "8.12.0" + } + }, + "/_connector/{connector_id}/_index_name": { + "put": { + "tags": [ + "connector.update_index_name" + ], + "summary": "Updates the index_name in the connector document", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-index-name-api.html" + }, + "operationId": "connector-update-index-name", + "parameters": [ + { + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector to be updated", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "index_name": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types:IndexName" + }, + { + "$ref": "#/components/schemas/_spec_utils:NullValue" + } + ] + } + }, + "required": [ + "index_name" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } + } + }, + "x-beta": true, + "x-available-since": "8.12.0" + } + }, + "/_connector/{connector_id}/_name": { + "put": { + "tags": [ + "connector.update_name" + ], + "summary": "Updates the name and description fields in the connector document", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-name-description-api.html" + }, + "operationId": "connector-update-name", + "parameters": [ + { + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector to be updated", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } + } + }, + "x-beta": true, + "x-available-since": "8.12.0" + } + }, + "/_connector/{connector_id}/_native": { + "put": { + "tags": [ + "connector.update_native" + ], + "summary": "Updates the is_native flag in the connector document", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-native-api.html" + }, + "operationId": "connector-update-native", + "parameters": [ + { + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector to be updated", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "is_native": { + "type": "boolean" + } + }, + "required": [ + "is_native" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } + } + }, + "x-beta": true, + "x-available-since": "8.12.0" + } + }, + "/_connector/{connector_id}/_pipeline": { + "put": { + "tags": [ + "connector.update_pipeline" + ], + "summary": "Updates the pipeline field in the connector document", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-pipeline-api.html" + }, + "operationId": "connector-update-pipeline", + "parameters": [ + { + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector to be updated", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pipeline": { + "$ref": "#/components/schemas/connector._types:IngestPipelineParams" + } + }, + "required": [ + "pipeline" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } + } + }, + "x-beta": true, + "x-available-since": "8.12.0" + } + }, + "/_connector/{connector_id}/_scheduling": { + "put": { + "tags": [ + "connector.update_scheduling" + ], + "summary": "Updates the scheduling field in the connector document", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-scheduling-api.html" + }, + "operationId": "connector-update-scheduling", + "parameters": [ + { + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector to be updated", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "scheduling": { + "$ref": "#/components/schemas/connector._types:SchedulingConfiguration" + } + }, + "required": [ + "scheduling" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } + } + }, + "x-beta": true, + "x-available-since": "8.12.0" + } + }, + "/_connector/{connector_id}/_service_type": { + "put": { + "tags": [ + "connector.update_service_type" + ], + "summary": "Updates the service type of the connector", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-service-type-api.html" + }, + "operationId": "connector-update-service-type", + "parameters": [ + { + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector to be updated", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "service_type": { + "type": "string" + } + }, + "required": [ + "service_type" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } + } + }, + "x-beta": true, + "x-available-since": "8.12.0" + } + }, + "/_connector/{connector_id}/_status": { + "put": { + "tags": [ + "connector.update_status" + ], + "summary": "Updates the status of the connector", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-status-api.html" + }, + "operationId": "connector-update-status", + "parameters": [ + { + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector to be updated", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/connector._types:ConnectorStatus" + } + }, + "required": [ + "status" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } + } + }, + "x-technical-preview": true, + "x-available-since": "8.12.0" + } + }, + "/_count": { + "get": { + "tags": [ + "count" + ], + "summary": "Returns number of documents matching a query", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html" + }, + "operationId": "count-1", + "parameters": [ + { + "$ref": "#/components/parameters/count#allow_no_indices" + }, + { + "$ref": "#/components/parameters/count#analyzer" + }, + { + "$ref": "#/components/parameters/count#analyze_wildcard" + }, + { + "$ref": "#/components/parameters/count#default_operator" + }, + { + "$ref": "#/components/parameters/count#df" + }, + { + "$ref": "#/components/parameters/count#expand_wildcards" + }, + { + "$ref": "#/components/parameters/count#ignore_throttled" + }, + { + "$ref": "#/components/parameters/count#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/count#lenient" + }, + { + "$ref": "#/components/parameters/count#min_score" + }, + { + "$ref": "#/components/parameters/count#preference" + }, + { + "$ref": "#/components/parameters/count#routing" + }, + { + "$ref": "#/components/parameters/count#terminate_after" + }, + { + "$ref": "#/components/parameters/count#q" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/count" + }, + "responses": { + "200": { + "$ref": "#/components/responses/count#200" + } + } + }, + "post": { + "tags": [ + "count" + ], + "summary": "Returns number of documents matching a query", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html" + }, + "operationId": "count", + "parameters": [ + { + "$ref": "#/components/parameters/count#allow_no_indices" + }, + { + "$ref": "#/components/parameters/count#analyzer" + }, + { + "$ref": "#/components/parameters/count#analyze_wildcard" + }, + { + "$ref": "#/components/parameters/count#default_operator" + }, + { + "$ref": "#/components/parameters/count#df" + }, + { + "$ref": "#/components/parameters/count#expand_wildcards" + }, + { + "$ref": "#/components/parameters/count#ignore_throttled" + }, + { + "$ref": "#/components/parameters/count#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/count#lenient" + }, + { + "$ref": "#/components/parameters/count#min_score" + }, + { + "$ref": "#/components/parameters/count#preference" + }, + { + "$ref": "#/components/parameters/count#routing" + }, + { + "$ref": "#/components/parameters/count#terminate_after" + }, + { + "$ref": "#/components/parameters/count#q" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/count" + }, + "responses": { + "200": { + "$ref": "#/components/responses/count#200" + } + } + } + }, + "/{index}/_count": { + "get": { + "tags": [ + "count" + ], + "summary": "Returns number of documents matching a query", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html" + }, + "operationId": "count-3", + "parameters": [ + { + "$ref": "#/components/parameters/count#index" + }, + { + "$ref": "#/components/parameters/count#allow_no_indices" + }, + { + "$ref": "#/components/parameters/count#analyzer" + }, + { + "$ref": "#/components/parameters/count#analyze_wildcard" + }, + { + "$ref": "#/components/parameters/count#default_operator" + }, + { + "$ref": "#/components/parameters/count#df" + }, + { + "$ref": "#/components/parameters/count#expand_wildcards" + }, + { + "$ref": "#/components/parameters/count#ignore_throttled" + }, + { + "$ref": "#/components/parameters/count#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/count#lenient" + }, + { + "$ref": "#/components/parameters/count#min_score" + }, + { + "$ref": "#/components/parameters/count#preference" + }, + { + "$ref": "#/components/parameters/count#routing" + }, + { + "$ref": "#/components/parameters/count#terminate_after" + }, + { + "$ref": "#/components/parameters/count#q" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/count" + }, + "responses": { + "200": { + "$ref": "#/components/responses/count#200" + } + } + }, + "post": { + "tags": [ + "count" + ], + "summary": "Returns number of documents matching a query", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html" + }, + "operationId": "count-2", + "parameters": [ + { + "$ref": "#/components/parameters/count#index" + }, + { + "$ref": "#/components/parameters/count#allow_no_indices" + }, + { + "$ref": "#/components/parameters/count#analyzer" + }, + { + "$ref": "#/components/parameters/count#analyze_wildcard" + }, + { + "$ref": "#/components/parameters/count#default_operator" + }, + { + "$ref": "#/components/parameters/count#df" + }, + { + "$ref": "#/components/parameters/count#expand_wildcards" + }, + { + "$ref": "#/components/parameters/count#ignore_throttled" + }, + { + "$ref": "#/components/parameters/count#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/count#lenient" + }, + { + "$ref": "#/components/parameters/count#min_score" + }, + { + "$ref": "#/components/parameters/count#preference" + }, + { + "$ref": "#/components/parameters/count#routing" + }, + { + "$ref": "#/components/parameters/count#terminate_after" + }, + { + "$ref": "#/components/parameters/count#q" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/count" + }, + "responses": { + "200": { + "$ref": "#/components/responses/count#200" + } + } + } + }, + "/{index}/_create/{id}": { + "put": { + "tags": [ + "create" + ], + "summary": "Index a document", + "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html" + }, + "operationId": "create", + "parameters": [ + { + "$ref": "#/components/parameters/create#index" + }, + { + "$ref": "#/components/parameters/create#id" + }, + { + "$ref": "#/components/parameters/create#pipeline" + }, + { + "$ref": "#/components/parameters/create#refresh" + }, + { + "$ref": "#/components/parameters/create#routing" + }, + { + "$ref": "#/components/parameters/create#timeout" + }, + { + "$ref": "#/components/parameters/create#version" + }, + { + "$ref": "#/components/parameters/create#version_type" + }, + { + "$ref": "#/components/parameters/create#wait_for_active_shards" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/create" + }, + "responses": { + "200": { + "$ref": "#/components/responses/create#200" + } + }, + "x-available-since": "5.0.0" + }, + "post": { + "tags": [ + "create" + ], + "summary": "Index a document", + "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html" + }, + "operationId": "create-1", + "parameters": [ + { + "$ref": "#/components/parameters/create#index" + }, + { + "$ref": "#/components/parameters/create#id" + }, + { + "$ref": "#/components/parameters/create#pipeline" + }, + { + "$ref": "#/components/parameters/create#refresh" + }, + { + "$ref": "#/components/parameters/create#routing" + }, + { + "$ref": "#/components/parameters/create#timeout" + }, + { + "$ref": "#/components/parameters/create#version" + }, + { + "$ref": "#/components/parameters/create#version_type" + }, + { + "$ref": "#/components/parameters/create#wait_for_active_shards" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/create" + }, + "responses": { + "200": { + "$ref": "#/components/responses/create#200" + } + }, + "x-available-since": "5.0.0" + } + }, + "/{index}/_doc/{id}": { + "get": { + "tags": [ + "get" + ], + "summary": "Get a document by its ID", + "description": "Retrieves the document with the specified ID from an index.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html" + }, + "operationId": "get", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "Name of the index that contains the document.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "style": "simple" + }, + { + "in": "path", + "name": "id", + "description": "Unique identifier of the document.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "preference", + "description": "Specifies the node or shard the operation should be performed on. Random by default.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "realtime", + "description": "If `true`, the request is real-time as opposed to near-real-time.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "refresh", + "description": "If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "routing", + "description": "Target the specified primary shard.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Routing" + }, + "style": "form" + }, + { + "in": "query", + "name": "_source", + "description": "True or false to return the _source field or not, or a list of fields to return.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_global.search._types:SourceConfigParam" + }, + "style": "form" + }, + { + "in": "query", + "name": "_source_excludes", + "description": "A comma-separated list of source fields to exclude in the response.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + { + "in": "query", + "name": "_source_includes", + "description": "A comma-separated list of source fields to include in the response.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + { + "in": "query", + "name": "stored_fields", + "description": "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` parameter defaults to false.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + { + "in": "query", + "name": "version", + "description": "Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "style": "form" + }, + { + "in": "query", + "name": "version_type", + "description": "Specific version type: internal, external, external_gte.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:VersionType" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_global.get:GetResult" + } + } + } + } + } + }, + "put": { + "tags": [ + "index" + ], + "summary": "Index a document", + "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html" + }, + "operationId": "index", + "parameters": [ + { + "$ref": "#/components/parameters/index#index" + }, + { + "$ref": "#/components/parameters/index#id" + }, + { + "$ref": "#/components/parameters/index#if_primary_term" + }, + { + "$ref": "#/components/parameters/index#if_seq_no" + }, + { + "$ref": "#/components/parameters/index#op_type" + }, + { + "$ref": "#/components/parameters/index#pipeline" + }, + { + "$ref": "#/components/parameters/index#refresh" + }, + { + "$ref": "#/components/parameters/index#routing" + }, + { + "$ref": "#/components/parameters/index#timeout" + }, + { + "$ref": "#/components/parameters/index#version" + }, + { + "$ref": "#/components/parameters/index#version_type" + }, + { + "$ref": "#/components/parameters/index#wait_for_active_shards" + }, + { + "$ref": "#/components/parameters/index#require_alias" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/index" + }, + "responses": { + "200": { + "$ref": "#/components/responses/index#200" + } + } + }, + "post": { + "tags": [ + "index" + ], + "summary": "Index a document", + "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html" + }, + "operationId": "index-1", + "parameters": [ + { + "$ref": "#/components/parameters/index#index" + }, + { + "$ref": "#/components/parameters/index#id" + }, + { + "$ref": "#/components/parameters/index#if_primary_term" + }, + { + "$ref": "#/components/parameters/index#if_seq_no" + }, + { + "$ref": "#/components/parameters/index#op_type" + }, + { + "$ref": "#/components/parameters/index#pipeline" + }, + { + "$ref": "#/components/parameters/index#refresh" + }, + { + "$ref": "#/components/parameters/index#routing" + }, + { + "$ref": "#/components/parameters/index#timeout" + }, + { + "$ref": "#/components/parameters/index#version" + }, + { + "$ref": "#/components/parameters/index#version_type" + }, + { + "$ref": "#/components/parameters/index#wait_for_active_shards" + }, + { + "$ref": "#/components/parameters/index#require_alias" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/index" + }, + "responses": { + "200": { + "$ref": "#/components/responses/index#200" + } + } + }, + "delete": { + "tags": [ + "delete" + ], + "summary": "Delete a document", + "description": "Removes a JSON document from the specified index.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html" + }, + "operationId": "delete", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "Name of the target index.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "style": "simple" + }, + { + "in": "path", + "name": "id", + "description": "Unique identifier for the document.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "if_primary_term", + "description": "Only perform the operation if the document has this primary term.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "if_seq_no", + "description": "Only perform the operation if the document has this sequence number.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:SequenceNumber" + }, + "style": "form" + }, + { + "in": "query", + "name": "refresh", + "description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.\nValid values: `true`, `false`, `wait_for`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Refresh" + }, + "style": "form" + }, + { + "in": "query", + "name": "routing", + "description": "Custom value used to route operations to a specific shard.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Routing" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Period to wait for active shards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "version", + "description": "Explicit version number for concurrency control.\nThe specified version must match the current version of the document for the request to succeed.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "style": "form" + }, + { + "in": "query", + "name": "version_type", + "description": "Specific version type: `external`, `external_gte`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:VersionType" + }, + "style": "form" + }, + { + "in": "query", + "name": "wait_for_active_shards", + "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:WaitForActiveShards" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:WriteResponseBase" + } + } + } + } + } + }, + "head": { + "tags": [ + "exists" + ], + "summary": "Check a document", + "description": "Checks if a specified document exists.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html" + }, + "operationId": "exists", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "Comma-separated list of data streams, indices, and aliases.\nSupports wildcards (`*`).", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "style": "simple" + }, + { + "in": "path", + "name": "id", + "description": "Identifier of the document.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "preference", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "realtime", + "description": "If `true`, the request is real-time as opposed to near-real-time.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "refresh", + "description": "If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "routing", + "description": "Target the specified primary shard.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Routing" + }, + "style": "form" + }, + { + "in": "query", + "name": "_source", + "description": "`true` or `false` to return the `_source` field or not, or a list of fields to return.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_global.search._types:SourceConfigParam" + }, + "style": "form" + }, + { + "in": "query", + "name": "_source_excludes", + "description": "A comma-separated list of source fields to exclude in the response.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + { + "in": "query", + "name": "_source_includes", + "description": "A comma-separated list of source fields to include in the response.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + { + "in": "query", + "name": "stored_fields", + "description": "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` parameter defaults to false.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + { + "in": "query", + "name": "version", + "description": "Explicit version number for concurrency control.\nThe specified version must match the current version of the document for the request to succeed.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "style": "form" + }, + { + "in": "query", + "name": "version_type", + "description": "Specific version type: `external`, `external_gte`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:VersionType" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": {} + } + } + } + } + }, + "/{index}/_delete_by_query": { + "post": { + "tags": [ + "delete_by_query" + ], + "summary": "Delete documents", + "description": "Deletes documents that match the specified query.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html" + }, + "operationId": "delete-by-query", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "Comma-separated list of data streams, indices, and aliases to search.\nSupports wildcards (`*`).\nTo search all data streams or indices, omit this parameter or use `*` or `_all`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + { + "in": "query", + "name": "allow_no_indices", + "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.\nFor example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "analyzer", + "description": "Analyzer to use for the query string.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "analyze_wildcard", + "description": "If `true`, wildcard and prefix queries are analyzed.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "conflicts", + "description": "What to do if delete by query hits version conflicts: `abort` or `proceed`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Conflicts" + }, + "style": "form" + }, + { + "in": "query", + "name": "default_operator", + "description": "The default operator for query string query: `AND` or `OR`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types.query_dsl:Operator" + }, + "style": "form" + }, + { + "in": "query", + "name": "df", + "description": "Field to use as default where no field prefix is given in the query string.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "expand_wildcards", + "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + { + "in": "query", + "name": "from", + "description": "Starting offset (default: 0)", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "ignore_unavailable", + "description": "If `false`, the request returns an error if it targets a missing or closed index.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "lenient", + "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "max_docs", + "description": "Maximum number of documents to process.\nDefaults to all documents.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "preference", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "refresh", + "description": "If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "request_cache", + "description": "If `true`, the request cache is used for this request.\nDefaults to the index-level setting.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "requests_per_second", + "description": "The throttle for this request in sub-requests per second.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "routing", + "description": "Custom value used to route operations to a specific shard.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Routing" + }, + "style": "form" + }, + { + "in": "query", + "name": "q", + "description": "Query in the Lucene query string syntax.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "scroll", + "description": "Period to retain the search context for scrolling.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "scroll_size", + "description": "Size of the scroll request that powers the operation.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "search_timeout", + "description": "Explicit timeout for each search request.\nDefaults to no timeout.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "search_type", + "description": "The type of the search operation.\nAvailable options: `query_then_fetch`, `dfs_query_then_fetch`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:SearchType" + }, + "style": "form" + }, + { + "in": "query", + "name": "slices", + "description": "The number of slices this task should be divided into.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Slices" + }, + "style": "form" + }, + { + "in": "query", + "name": "sort", + "description": "A comma-separated list of : pairs.", + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form" + }, + { + "in": "query", + "name": "stats", + "description": "Specific `tag` of the request for logging and statistical purposes.", + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form" + }, + { + "in": "query", + "name": "terminate_after", + "description": "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.\nUse with caution.\nElasticsearch applies this parameter to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Period each deletion request waits for active shards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "version", + "description": "If `true`, returns the document version as part of a hit.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "wait_for_active_shards", + "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:WaitForActiveShards" + }, + "style": "form" + }, + { + "in": "query", + "name": "wait_for_completion", + "description": "If `true`, the request blocks until the operation is complete.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "max_docs": { + "description": "The maximum number of documents to delete.", + "type": "number" + }, + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "slice": { + "$ref": "#/components/schemas/_types:SlicedScroll" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "batches": { + "type": "number" + }, + "deleted": { + "type": "number" + }, + "failures": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:BulkIndexByScrollFailure" + } + }, + "noops": { + "type": "number" + }, + "requests_per_second": { + "type": "number" + }, + "retries": { + "$ref": "#/components/schemas/_types:Retries" + }, + "slice_id": { + "type": "number" + }, + "task": { + "$ref": "#/components/schemas/_types:TaskId" + }, + "throttled": { + "$ref": "#/components/schemas/_types:Duration" + }, + "throttled_millis": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + }, + "throttled_until": { + "$ref": "#/components/schemas/_types:Duration" + }, + "throttled_until_millis": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + }, + "timed_out": { + "type": "boolean" + }, + "took": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + }, + "total": { + "type": "number" + }, + "version_conflicts": { + "type": "number" + } + } + } + } + } + } + }, + "x-available-since": "5.0.0" + } + }, + "/_scripts/{id}": { + "get": { + "tags": [ + "get_script" + ], + "summary": "Get a script or search template", + "description": "Retrieves a stored script or search template.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html" + }, + "operationId": "get-script", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Identifier for the stored script or search template.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Specify timeout for connection to master", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "found": { + "type": "boolean" + }, + "script": { + "$ref": "#/components/schemas/_types:StoredScript" + } + }, + "required": [ + "_id", + "found" + ] + } + } + } + } + } + }, + "put": { + "tags": [ + "put_script" + ], + "summary": "Create or update a script or search template", + "description": "Creates or updates a stored script or search template.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html" + }, + "operationId": "put-script", + "parameters": [ + { + "$ref": "#/components/parameters/put_script#id" + }, + { + "$ref": "#/components/parameters/put_script#master_timeout" + }, + { + "$ref": "#/components/parameters/put_script#timeout" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/put_script" + }, + "responses": { + "200": { + "$ref": "#/components/responses/put_script#200" + } + } + }, + "post": { + "tags": [ + "put_script" + ], + "summary": "Create or update a script or search template", + "description": "Creates or updates a stored script or search template.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html" + }, + "operationId": "put-script-1", + "parameters": [ + { + "$ref": "#/components/parameters/put_script#id" + }, + { + "$ref": "#/components/parameters/put_script#master_timeout" + }, + { + "$ref": "#/components/parameters/put_script#timeout" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/put_script" + }, + "responses": { + "200": { + "$ref": "#/components/responses/put_script#200" + } + } + }, + "delete": { + "tags": [ + "delete_script" + ], + "summary": "Delete a script or search template", + "description": "Deletes a stored script or search template.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html" + }, + "operationId": "delete-script", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Identifier for the stored script or search template.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + } + } + }, + "/_enrich/policy/{name}": { + "get": { + "tags": [ + "enrich.get_policy" + ], + "summary": "Get an enrich policy", + "description": "Returns information about an enrich policy.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html" + }, + "operationId": "enrich-get-policy", + "parameters": [ + { + "$ref": "#/components/parameters/enrich.get_policy#name" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/enrich.get_policy#200" + } + }, + "x-available-since": "7.5.0" + }, + "put": { + "tags": [ + "enrich.put_policy" + ], + "summary": "Create an enrich policy", + "description": "Creates an enrich policy.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-enrich-policy-api.html" + }, + "operationId": "enrich-put-policy", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "Name of the enrich policy to create or update.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "geo_match": { + "$ref": "#/components/schemas/enrich._types:Policy" + }, + "match": { + "$ref": "#/components/schemas/enrich._types:Policy" + }, + "range": { + "$ref": "#/components/schemas/enrich._types:Policy" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "7.5.0" + }, + "delete": { + "tags": [ + "enrich.delete_policy" + ], + "summary": "Delete an enrich policy", + "description": "Deletes an existing enrich policy and its enrich index.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-enrich-policy-api.html" + }, + "operationId": "enrich-delete-policy", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "Enrich policy to delete.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "7.5.0" + } + }, + "/_enrich/policy/{name}/_execute": { + "put": { + "tags": [ + "enrich.execute_policy" + ], + "summary": "Creates the enrich index for an existing enrich policy", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/execute-enrich-policy-api.html" + }, + "operationId": "enrich-execute-policy", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "Enrich policy to execute.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" + }, + { + "in": "query", + "name": "wait_for_completion", + "description": "If `true`, the request blocks other enrich policy execution requests until complete.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/enrich.execute_policy:ExecuteEnrichPolicyStatus" + }, + "task_id": { + "$ref": "#/components/schemas/_types:TaskId" + } + } + } + } + } + } + }, + "x-available-since": "7.5.0" + } + }, + "/_enrich/policy": { + "get": { + "tags": [ + "enrich.get_policy" + ], + "summary": "Get an enrich policy", + "description": "Returns information about an enrich policy.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html" + }, + "operationId": "enrich-get-policy-1", + "responses": { + "200": { + "$ref": "#/components/responses/enrich.get_policy#200" + } + }, + "x-available-since": "7.5.0" + } + }, + "/_enrich/_stats": { + "get": { + "tags": [ + "enrich.stats" + ], + "summary": "Get enrich stats", + "description": "Returns enrich coordinator statistics and information about enrich policies that are currently executing.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html" + }, + "operationId": "enrich-stats", + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "coordinator_stats": { + "description": "Objects containing information about each coordinating ingest node for configured enrich processors.", + "type": "array", + "items": { + "$ref": "#/components/schemas/enrich.stats:CoordinatorStats" + } + }, + "executing_policies": { + "description": "Objects containing information about each enrich policy that is currently executing.", + "type": "array", + "items": { + "$ref": "#/components/schemas/enrich.stats:ExecutingPolicy" + } + }, + "cache_stats": { + "description": "Objects containing information about the enrich cache stats on each ingest node.", + "x-available-since": "7.16.0", + "type": "array", + "items": { + "$ref": "#/components/schemas/enrich.stats:CacheStats" + } + } + }, + "required": [ + "coordinator_stats", + "executing_policies" + ] + } + } + } + } + }, + "x-available-since": "7.5.0" + } + }, + "/_eql/search/{id}": { + "get": { + "tags": [ + "eql.get" + ], + "summary": "Returns the current status and available results for an async EQL search or a stored synchronous EQL search", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-async-eql-search-api.html" + }, + "operationId": "eql-get", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Identifier for the search.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "keep_alive", + "description": "Period for which the search and its results are stored on the cluster.\nDefaults to the keep_alive value set by the search’s EQL search API request.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "wait_for_completion_timeout", + "description": "Timeout duration to wait for the request to finish.\nDefaults to no timeout, meaning the request waits for complete search results.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/eql._types:EqlSearchResponseBase" + } + } + } + } + }, + "x-available-since": "7.9.0" + }, + "delete": { + "tags": [ + "eql.delete" + ], + "summary": "Deletes an async EQL search or a stored synchronous EQL search", + "description": "The API also deletes results for the search.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html" + }, + "operationId": "eql-delete", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Identifier for the search to delete.\nA search ID is provided in the EQL search API's response for an async search.\nA search ID is also provided if the request’s `keep_on_completion` parameter is `true`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "7.9.0" + } + }, + "/_eql/search/status/{id}": { + "get": { + "tags": [ + "eql.get_status" + ], + "summary": "Returns the current status for an async EQL search or a stored synchronous EQL search without returning results", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-async-eql-status-api.html" + }, + "operationId": "eql-get-status", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Identifier for the search.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "is_partial": { + "description": "If true, the search request is still executing. If false, the search is completed.", + "type": "boolean" + }, + "is_running": { + "description": "If true, the response does not contain complete search results. This could be because either the search is still running (is_running status is false), or because it is already completed (is_running status is true) and results are partial due to failures or timeouts.", + "type": "boolean" + }, + "start_time_in_millis": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "expiration_time_in_millis": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "completion_status": { + "description": "For a completed search shows the http status code of the completed search.", + "type": "number" + } + }, + "required": [ + "id", + "is_partial", + "is_running" + ] + } + } + } + } + }, + "x-available-since": "7.9.0" + } + }, + "/{index}/_eql/search": { + "get": { + "tags": [ + "eql.search" + ], + "summary": "Returns results matching a query expressed in Event Query Language (EQL)", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html" + }, + "operationId": "eql-search", + "parameters": [ + { + "$ref": "#/components/parameters/eql.search#index" + }, + { + "$ref": "#/components/parameters/eql.search#allow_no_indices" + }, + { + "$ref": "#/components/parameters/eql.search#expand_wildcards" + }, + { + "$ref": "#/components/parameters/eql.search#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/eql.search#keep_alive" + }, + { + "$ref": "#/components/parameters/eql.search#keep_on_completion" + }, + { + "$ref": "#/components/parameters/eql.search#wait_for_completion_timeout" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/eql.search" + }, + "responses": { + "200": { + "$ref": "#/components/responses/eql.search#200" + } + }, + "x-available-since": "7.9.0" + }, + "post": { + "tags": [ + "eql.search" + ], + "summary": "Returns results matching a query expressed in Event Query Language (EQL)", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html" + }, + "operationId": "eql-search-1", + "parameters": [ + { + "$ref": "#/components/parameters/eql.search#index" + }, + { + "$ref": "#/components/parameters/eql.search#allow_no_indices" + }, + { + "$ref": "#/components/parameters/eql.search#expand_wildcards" + }, + { + "$ref": "#/components/parameters/eql.search#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/eql.search#keep_alive" + }, + { + "$ref": "#/components/parameters/eql.search#keep_on_completion" + }, + { + "$ref": "#/components/parameters/eql.search#wait_for_completion_timeout" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/eql.search" + }, + "responses": { + "200": { + "$ref": "#/components/responses/eql.search#200" + } + }, + "x-available-since": "7.9.0" + } + }, + "/_query": { + "post": { + "tags": [ + "esql.query" + ], + "summary": "Executes an ES|QL request", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-rest.html" + }, + "operationId": "esql-query", + "parameters": [ + { + "in": "query", + "name": "format", + "description": "A short version of the Accept header, e.g. json, yaml.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "delimiter", + "description": "The character to use between values within a CSV row. Only valid for the CSV format.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "drop_null_columns", + "description": "Should columns that are entirely `null` be removed from the `columns` and `values` portion of the results?\nDefaults to `false`. If `true` then the response will include an extra section under the name `all_columns` which has the name of all columns.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "columnar": { + "description": "By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results.", + "type": "boolean" + }, + "filter": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "locale": { + "type": "string" + }, + "params": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-rest.html#esql-rest-params" + }, + "description": "To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:FieldValue" + } + }, + "profile": { + "description": "If provided and `true` the response will include an extra `profile` object\nwith information on how the query was executed. This information is for human debugging\nand its format can change at any time but it can give some insight into the performance\nof each part of the query.", + "type": "boolean" + }, + "query": { + "description": "The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results.", + "type": "string" + }, + "tables": { + "description": "Tables to use with the LOOKUP operation. The top level key is the table\nname and the next level key is the column name.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/esql._types:TableValuesContainer" + } + } + } + }, + "required": [ + "query" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:EsqlColumns" + } + } + } + } + }, + "x-available-since": "8.11.0" + } + }, + "/{index}/_source/{id}": { + "get": { + "tags": [ + "get_source" + ], + "summary": "Get a document's source", + "description": "Returns the source of a document.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html" + }, + "operationId": "get-source", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "Name of the index that contains the document.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "style": "simple" + }, + { + "in": "path", + "name": "id", + "description": "Unique identifier of the document.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "preference", + "description": "Specifies the node or shard the operation should be performed on. Random by default.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "realtime", + "description": "Boolean) If true, the request is real-time as opposed to near-real-time.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "refresh", + "description": "If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "routing", + "description": "Target the specified primary shard.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Routing" + }, + "style": "form" + }, + { + "in": "query", + "name": "_source", + "description": "True or false to return the _source field or not, or a list of fields to return.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_global.search._types:SourceConfigParam" + }, + "style": "form" + }, + { + "in": "query", + "name": "_source_excludes", + "description": "A comma-separated list of source fields to exclude in the response.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + { + "in": "query", + "name": "_source_includes", + "description": "A comma-separated list of source fields to include in the response.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + { + "in": "query", + "name": "stored_fields", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + { + "in": "query", + "name": "version", + "description": "Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "style": "form" + }, + { + "in": "query", + "name": "version_type", + "description": "Specific version type: internal, external, external_gte.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:VersionType" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } + }, + "head": { + "tags": [ + "exists_source" + ], + "summary": "Check for a document source", + "description": "Checks if a document's `_source` is stored.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html" + }, + "operationId": "exists-source", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "Comma-separated list of data streams, indices, and aliases.\nSupports wildcards (`*`).", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "style": "simple" + }, + { + "in": "path", + "name": "id", + "description": "Identifier of the document.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "preference", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "realtime", + "description": "If true, the request is real-time as opposed to near-real-time.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "refresh", + "description": "If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "routing", + "description": "Target the specified primary shard.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Routing" + }, + "style": "form" + }, + { + "in": "query", + "name": "_source", + "description": "`true` or `false` to return the `_source` field or not, or a list of fields to return.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_global.search._types:SourceConfigParam" + }, + "style": "form" + }, + { + "in": "query", + "name": "_source_excludes", + "description": "A comma-separated list of source fields to exclude in the response.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + { + "in": "query", + "name": "_source_includes", + "description": "A comma-separated list of source fields to include in the response.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + { + "in": "query", + "name": "version", + "description": "Explicit version number for concurrency control.\nThe specified version must match the current version of the document for the request to succeed.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "style": "form" + }, + { + "in": "query", + "name": "version_type", + "description": "Specific version type: `external`, `external_gte`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:VersionType" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": {} + } + } + }, + "x-available-since": "5.4.0" + } + }, + "/{index}/_explain/{id}": { + "get": { + "tags": [ + "explain" + ], + "summary": "Explain a document match result", + "description": "Returns information about why a specific document matches, or doesn’t match, a query.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html" + }, + "operationId": "explain", + "parameters": [ + { + "$ref": "#/components/parameters/explain#index" + }, + { + "$ref": "#/components/parameters/explain#id" + }, + { + "$ref": "#/components/parameters/explain#analyzer" + }, + { + "$ref": "#/components/parameters/explain#analyze_wildcard" + }, + { + "$ref": "#/components/parameters/explain#default_operator" + }, + { + "$ref": "#/components/parameters/explain#df" + }, + { + "$ref": "#/components/parameters/explain#lenient" + }, + { + "$ref": "#/components/parameters/explain#preference" + }, + { + "$ref": "#/components/parameters/explain#routing" + }, + { + "$ref": "#/components/parameters/explain#_source" + }, + { + "$ref": "#/components/parameters/explain#_source_excludes" + }, + { + "$ref": "#/components/parameters/explain#_source_includes" + }, + { + "$ref": "#/components/parameters/explain#stored_fields" + }, + { + "$ref": "#/components/parameters/explain#q" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/explain" + }, + "responses": { + "200": { + "$ref": "#/components/responses/explain#200" + } + } + }, + "post": { + "tags": [ + "explain" + ], + "summary": "Explain a document match result", + "description": "Returns information about why a specific document matches, or doesn’t match, a query.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html" + }, + "operationId": "explain-1", + "parameters": [ + { + "$ref": "#/components/parameters/explain#index" + }, + { + "$ref": "#/components/parameters/explain#id" + }, + { + "$ref": "#/components/parameters/explain#analyzer" + }, + { + "$ref": "#/components/parameters/explain#analyze_wildcard" + }, + { + "$ref": "#/components/parameters/explain#default_operator" + }, + { + "$ref": "#/components/parameters/explain#df" + }, + { + "$ref": "#/components/parameters/explain#lenient" + }, + { + "$ref": "#/components/parameters/explain#preference" + }, + { + "$ref": "#/components/parameters/explain#routing" + }, + { + "$ref": "#/components/parameters/explain#_source" + }, + { + "$ref": "#/components/parameters/explain#_source_excludes" + }, + { + "$ref": "#/components/parameters/explain#_source_includes" + }, + { + "$ref": "#/components/parameters/explain#stored_fields" + }, + { + "$ref": "#/components/parameters/explain#q" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/explain" + }, + "responses": { + "200": { + "$ref": "#/components/responses/explain#200" + } + } + } + }, + "/_field_caps": { + "get": { + "tags": [ + "field_caps" + ], + "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", + "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html" + }, + "operationId": "field-caps", + "parameters": [ + { + "$ref": "#/components/parameters/field_caps#allow_no_indices" + }, + { + "$ref": "#/components/parameters/field_caps#expand_wildcards" + }, + { + "$ref": "#/components/parameters/field_caps#fields" + }, + { + "$ref": "#/components/parameters/field_caps#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/field_caps#include_unmapped" + }, + { + "$ref": "#/components/parameters/field_caps#filters" + }, + { + "$ref": "#/components/parameters/field_caps#types" + }, + { + "$ref": "#/components/parameters/field_caps#include_empty_fields" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/field_caps" + }, + "responses": { + "200": { + "$ref": "#/components/responses/field_caps#200" + } + }, + "x-available-since": "5.4.0" + }, + "post": { + "tags": [ + "field_caps" + ], + "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", + "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html" + }, + "operationId": "field-caps-1", + "parameters": [ + { + "$ref": "#/components/parameters/field_caps#allow_no_indices" + }, + { + "$ref": "#/components/parameters/field_caps#expand_wildcards" + }, + { + "$ref": "#/components/parameters/field_caps#fields" + }, + { + "$ref": "#/components/parameters/field_caps#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/field_caps#include_unmapped" + }, + { + "$ref": "#/components/parameters/field_caps#filters" + }, + { + "$ref": "#/components/parameters/field_caps#types" + }, + { + "$ref": "#/components/parameters/field_caps#include_empty_fields" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/field_caps" + }, + "responses": { + "200": { + "$ref": "#/components/responses/field_caps#200" + } + }, + "x-available-since": "5.4.0" + } + }, + "/{index}/_field_caps": { + "get": { + "tags": [ + "field_caps" + ], + "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", + "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html" + }, + "operationId": "field-caps-2", + "parameters": [ + { + "$ref": "#/components/parameters/field_caps#index" + }, + { + "$ref": "#/components/parameters/field_caps#allow_no_indices" + }, + { + "$ref": "#/components/parameters/field_caps#expand_wildcards" + }, + { + "$ref": "#/components/parameters/field_caps#fields" + }, + { + "$ref": "#/components/parameters/field_caps#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/field_caps#include_unmapped" + }, + { + "$ref": "#/components/parameters/field_caps#filters" + }, + { + "$ref": "#/components/parameters/field_caps#types" + }, + { + "$ref": "#/components/parameters/field_caps#include_empty_fields" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/field_caps" + }, + "responses": { + "200": { + "$ref": "#/components/responses/field_caps#200" + } + }, + "x-available-since": "5.4.0" + }, + "post": { + "tags": [ + "field_caps" + ], + "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", + "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html" + }, + "operationId": "field-caps-3", + "parameters": [ + { + "$ref": "#/components/parameters/field_caps#index" + }, + { + "$ref": "#/components/parameters/field_caps#allow_no_indices" + }, + { + "$ref": "#/components/parameters/field_caps#expand_wildcards" + }, + { + "$ref": "#/components/parameters/field_caps#fields" + }, + { + "$ref": "#/components/parameters/field_caps#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/field_caps#include_unmapped" + }, + { + "$ref": "#/components/parameters/field_caps#filters" + }, + { + "$ref": "#/components/parameters/field_caps#types" + }, + { + "$ref": "#/components/parameters/field_caps#include_empty_fields" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/field_caps" + }, + "responses": { + "200": { + "$ref": "#/components/responses/field_caps#200" + } + }, + "x-available-since": "5.4.0" + } + }, + "/{index}/_graph/explore": { + "get": { + "tags": [ + "graph.explore" + ], + "summary": "Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html" + }, + "operationId": "graph-explore", + "parameters": [ + { + "$ref": "#/components/parameters/graph.explore#index" + }, + { + "$ref": "#/components/parameters/graph.explore#routing" + }, + { + "$ref": "#/components/parameters/graph.explore#timeout" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/graph.explore" + }, + "responses": { + "200": { + "$ref": "#/components/responses/graph.explore#200" + } + } + }, + "post": { + "tags": [ + "graph.explore" + ], + "summary": "Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html" + }, + "operationId": "graph-explore-1", + "parameters": [ + { + "$ref": "#/components/parameters/graph.explore#index" + }, + { + "$ref": "#/components/parameters/graph.explore#routing" + }, + { + "$ref": "#/components/parameters/graph.explore#timeout" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/graph.explore" + }, + "responses": { + "200": { + "$ref": "#/components/responses/graph.explore#200" + } + } + } + }, + "/{index}/_doc": { + "post": { + "tags": [ + "index" + ], + "summary": "Index a document", + "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html" + }, + "operationId": "index-2", + "parameters": [ + { + "$ref": "#/components/parameters/index#index" + }, + { + "$ref": "#/components/parameters/index#if_primary_term" + }, + { + "$ref": "#/components/parameters/index#if_seq_no" + }, + { + "$ref": "#/components/parameters/index#op_type" + }, + { + "$ref": "#/components/parameters/index#pipeline" + }, + { + "$ref": "#/components/parameters/index#refresh" + }, + { + "$ref": "#/components/parameters/index#routing" + }, + { + "$ref": "#/components/parameters/index#timeout" + }, + { + "$ref": "#/components/parameters/index#version" + }, + { + "$ref": "#/components/parameters/index#version_type" + }, + { + "$ref": "#/components/parameters/index#wait_for_active_shards" + }, + { + "$ref": "#/components/parameters/index#require_alias" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/index" + }, + "responses": { + "200": { + "$ref": "#/components/responses/index#200" + } + } + } + }, + "/{index}/_block/{block}": { + "put": { + "tags": [ + "indices.add_block" + ], + "summary": "Add an index block", + "description": "Limits the operations allowed on an index by blocking specific operation types.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-modules-blocks.html" + }, + "operationId": "indices-add-block", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma separated list of indices to add a block to", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "style": "simple" + }, + { + "in": "path", + "name": "block", + "description": "The block to add (one of read, write, read_only or metadata)", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/indices.add_block:IndicesBlockOptions" + }, + "style": "simple" + }, + { + "in": "query", + "name": "allow_no_indices", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "expand_wildcards", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + { + "in": "query", + "name": "ignore_unavailable", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Specify timeout for connection to master", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Explicit operation timeout", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "acknowledged": { + "type": "boolean" + }, + "shards_acknowledged": { + "type": "boolean" + }, + "indices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.add_block:IndicesBlockStatus" + } + } + }, + "required": [ + "acknowledged", + "shards_acknowledged", + "indices" + ] + } + } + } + } + }, + "x-available-since": "7.9.0" + } + }, + "/_analyze": { + "get": { + "tags": [ + "indices.analyze" + ], + "summary": "Performs analysis on a text string and returns the resulting tokens", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-analyze.html" + }, + "operationId": "indices-analyze", + "requestBody": { + "$ref": "#/components/requestBodies/indices.analyze" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.analyze#200" + } + } + }, + "post": { + "tags": [ + "indices.analyze" + ], + "summary": "Performs analysis on a text string and returns the resulting tokens", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-analyze.html" + }, + "operationId": "indices-analyze-1", + "requestBody": { + "$ref": "#/components/requestBodies/indices.analyze" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.analyze#200" + } + } + } + }, + "/{index}/_analyze": { + "get": { + "tags": [ + "indices.analyze" + ], + "summary": "Performs analysis on a text string and returns the resulting tokens", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-analyze.html" + }, + "operationId": "indices-analyze-2", + "parameters": [ + { + "$ref": "#/components/parameters/indices.analyze#index" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.analyze" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.analyze#200" + } + } + }, + "post": { + "tags": [ + "indices.analyze" + ], + "summary": "Performs analysis on a text string and returns the resulting tokens", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-analyze.html" + }, + "operationId": "indices-analyze-3", + "parameters": [ + { + "$ref": "#/components/parameters/indices.analyze#index" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.analyze" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.analyze#200" + } + } + } + }, + "/{index}": { + "get": { + "tags": [ + "indices.get" + ], + "summary": "Get index information", + "description": "Returns information about one or more indices. For data streams, the API returns information about the\nstream’s backing indices.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html" + }, + "operationId": "indices-get", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "Comma-separated list of data streams, indices, and index aliases used to limit the request.\nWildcard expressions (*) are supported.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + { + "in": "query", + "name": "allow_no_indices", + "description": "If false, the request returns an error if any wildcard expression, index alias, or _all value targets only\nmissing or closed indices. This behavior applies even if the request targets other open indices. For example,\na request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "expand_wildcards", + "description": "Type of index that wildcard expressions 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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + { + "in": "query", + "name": "flat_settings", + "description": "If true, returns settings in flat format.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "ignore_unavailable", + "description": "If false, requests that target a missing index return an error.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "include_defaults", + "description": "If true, return all default settings in the response.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "local", + "description": "If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "features", + "description": "Return only information on specified index features", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/indices.get:Features" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/indices._types:IndexState" + } + } + } + } + } + } + }, + "put": { + "tags": [ + "indices.create" + ], + "summary": "Create an index", + "description": "Creates a new index.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html" + }, + "operationId": "indices-create", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "Name of the index you wish to create.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "style": "simple" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "wait_for_active_shards", + "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:WaitForActiveShards" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aliases": { + "description": "Aliases for the index.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/indices._types:Alias" + } + }, + "mappings": { + "$ref": "#/components/schemas/_types.mapping:TypeMapping" + }, + "settings": { + "$ref": "#/components/schemas/indices._types:IndexSettings" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "shards_acknowledged": { + "type": "boolean" + }, + "acknowledged": { + "type": "boolean" + } + }, + "required": [ + "index", + "shards_acknowledged", + "acknowledged" + ] + } + } + } + } + } + }, + "delete": { + "tags": [ + "indices.delete" + ], + "summary": "Delete indices", + "description": "Deletes one or more indices.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html" + }, + "operationId": "indices-delete", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "Comma-separated list of indices to delete.\nYou cannot specify index aliases.\nBy default, this parameter does not support wildcards (`*`) or `_all`.\nTo use wildcards or `_all`, set the `action.destructive_requires_name` cluster setting to `false`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + { + "in": "query", + "name": "allow_no_indices", + "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "expand_wildcards", + "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + { + "in": "query", + "name": "ignore_unavailable", + "description": "If `false`, the request returns an error if it targets a missing or closed index.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:IndicesResponseBase" + } + } + } + } + } + }, + "head": { + "tags": [ + "indices.exists" + ], + "summary": "Check indices", + "description": "Checks if one or more indices, index aliases, or data streams exist.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html" + }, + "operationId": "indices-exists", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`).", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + { + "in": "query", + "name": "allow_no_indices", + "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "expand_wildcards", + "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + { + "in": "query", + "name": "flat_settings", + "description": "If `true`, returns settings in flat format.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "ignore_unavailable", + "description": "If `false`, the request returns an error if it targets a missing or closed index.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "include_defaults", + "description": "If `true`, return all default settings in the response.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "local", + "description": "If `true`, the request retrieves information from the local node only.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": {} + } + } + } + } + }, + "/_data_stream/{name}": { + "get": { + "tags": [ + "indices.get_data_stream" + ], + "summary": "Get data streams", + "description": "Retrieves information about one or more data streams.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" + }, + "operationId": "indices-get-data-stream-1", + "parameters": [ + { + "$ref": "#/components/parameters/indices.get_data_stream#name" + }, + { + "$ref": "#/components/parameters/indices.get_data_stream#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.get_data_stream#include_defaults" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/indices.get_data_stream#200" + } + }, + "x-available-since": "7.9.0" + }, + "put": { + "tags": [ + "indices.create_data_stream" + ], + "summary": "Create a data stream", + "description": "Creates a data stream.\nYou must have a matching index template with data stream enabled.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" + }, + "operationId": "indices-create-data-stream", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "Name of the data stream, which must meet the following criteria:\nLowercase only;\nCannot include `\\`, `/`, `*`, `?`, `\"`, `<`, `>`, `|`, `,`, `#`, `:`, or a space character;\nCannot start with `-`, `_`, `+`, or `.ds-`;\nCannot be `.` or `..`;\nCannot be longer than 255 bytes. Multi-byte characters count towards this limit faster.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DataStreamName" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "7.9.0" + }, + "delete": { + "tags": [ + "indices.delete_data_stream" + ], + "summary": "Delete data streams", + "description": "Deletes one or more data streams and their backing indices.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" + }, + "operationId": "indices-delete-data-stream", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "Comma-separated list of data streams to delete. Wildcard (`*`) expressions are supported.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DataStreamNames" + }, + "style": "simple" + }, + { + "in": "query", + "name": "expand_wildcards", + "description": "Type of data stream that wildcard patterns can match. Supports comma-separated values,such as `open,hidden`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "7.9.0" + } + }, + "/_data_stream/_stats": { + "get": { + "tags": [ + "indices.data_streams_stats" + ], + "summary": "Get data stream stats", + "description": "Retrieves statistics for one or more data streams.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" + }, + "operationId": "indices-data-streams-stats", + "parameters": [ + { + "$ref": "#/components/parameters/indices.data_streams_stats#expand_wildcards" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/indices.data_streams_stats#200" + } + }, + "x-available-since": "7.9.0" + } + }, + "/_data_stream/{name}/_stats": { + "get": { + "tags": [ + "indices.data_streams_stats" + ], + "summary": "Get data stream stats", + "description": "Retrieves statistics for one or more data streams.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" + }, + "operationId": "indices-data-streams-stats-1", + "parameters": [ + { + "$ref": "#/components/parameters/indices.data_streams_stats#name" + }, + { + "$ref": "#/components/parameters/indices.data_streams_stats#expand_wildcards" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/indices.data_streams_stats#200" + } + }, + "x-available-since": "7.9.0" + } + }, + "/{index}/_alias/{name}": { + "get": { + "tags": [ + "indices.get_alias" + ], + "summary": "Get aliases", + "description": "Retrieves information for one or more data stream or index aliases.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" + }, + "operationId": "indices-get-alias-2", + "parameters": [ + { + "$ref": "#/components/parameters/indices.get_alias#index" + }, + { + "$ref": "#/components/parameters/indices.get_alias#name" + }, + { + "$ref": "#/components/parameters/indices.get_alias#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.get_alias#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.get_alias#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.get_alias#local" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/indices.get_alias#200" + } + } + }, + "put": { + "tags": [ + "indices.put_alias" + ], + "summary": "Create or update an alias", + "description": "Adds a data stream or index to an alias.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" + }, + "operationId": "indices-put-alias", + "parameters": [ + { + "$ref": "#/components/parameters/indices.put_alias#index" + }, + { + "$ref": "#/components/parameters/indices.put_alias#name" + }, + { + "$ref": "#/components/parameters/indices.put_alias#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.put_alias#timeout" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.put_alias" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.put_alias#200" + } + } + }, + "post": { + "tags": [ + "indices.put_alias" + ], + "summary": "Create or update an alias", + "description": "Adds a data stream or index to an alias.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" + }, + "operationId": "indices-put-alias-1", + "parameters": [ + { + "$ref": "#/components/parameters/indices.put_alias#index" + }, + { + "$ref": "#/components/parameters/indices.put_alias#name" + }, + { + "$ref": "#/components/parameters/indices.put_alias#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.put_alias#timeout" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.put_alias" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.put_alias#200" + } + } + }, + "delete": { + "tags": [ + "indices.delete_alias" + ], + "summary": "Delete an alias", + "description": "Removes a data stream or index from an alias.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" + }, + "operationId": "indices-delete-alias", + "parameters": [ + { + "$ref": "#/components/parameters/indices.delete_alias#index" + }, + { + "$ref": "#/components/parameters/indices.delete_alias#name" + }, + { + "$ref": "#/components/parameters/indices.delete_alias#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.delete_alias#timeout" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/indices.delete_alias#200" + } + } + }, + "head": { + "tags": [ + "indices.exists_alias" + ], + "summary": "Check aliases", + "description": "Checks if one or more data stream or index aliases exist.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" + }, + "operationId": "indices-exists-alias-1", + "parameters": [ + { + "$ref": "#/components/parameters/indices.exists_alias#index" + }, + { + "$ref": "#/components/parameters/indices.exists_alias#name" + }, + { + "$ref": "#/components/parameters/indices.exists_alias#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.exists_alias#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.exists_alias#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.exists_alias#local" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/indices.exists_alias#200" + } + } + } + }, + "/{index}/_aliases/{name}": { + "put": { + "tags": [ + "indices.put_alias" + ], + "summary": "Create or update an alias", + "description": "Adds a data stream or index to an alias.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" + }, + "operationId": "indices-put-alias-2", + "parameters": [ + { + "$ref": "#/components/parameters/indices.put_alias#index" + }, + { + "$ref": "#/components/parameters/indices.put_alias#name" + }, + { + "$ref": "#/components/parameters/indices.put_alias#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.put_alias#timeout" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.put_alias" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.put_alias#200" + } + } + }, + "post": { + "tags": [ + "indices.put_alias" + ], + "summary": "Create or update an alias", + "description": "Adds a data stream or index to an alias.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" + }, + "operationId": "indices-put-alias-3", + "parameters": [ + { + "$ref": "#/components/parameters/indices.put_alias#index" + }, + { + "$ref": "#/components/parameters/indices.put_alias#name" + }, + { + "$ref": "#/components/parameters/indices.put_alias#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.put_alias#timeout" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.put_alias" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.put_alias#200" + } + } + }, + "delete": { + "tags": [ + "indices.delete_alias" + ], + "summary": "Delete an alias", + "description": "Removes a data stream or index from an alias.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" + }, + "operationId": "indices-delete-alias-1", + "parameters": [ + { + "$ref": "#/components/parameters/indices.delete_alias#index" + }, + { + "$ref": "#/components/parameters/indices.delete_alias#name" + }, + { + "$ref": "#/components/parameters/indices.delete_alias#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.delete_alias#timeout" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/indices.delete_alias#200" + } + } + } + }, + "/_data_stream/{name}/_lifecycle": { + "get": { + "tags": [ + "indices.get_data_lifecycle" + ], + "summary": "Get data stream lifecycles", + "description": "Retrieves the data stream lifecycle configuration of one or more data streams.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-get-lifecycle.html" + }, + "operationId": "indices-get-data-lifecycle", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "Comma-separated list of data streams to limit the request.\nSupports wildcards (`*`).\nTo target all data streams, omit this parameter or use `*` or `_all`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DataStreamNames" + }, + "style": "simple" + }, + { + "in": "query", + "name": "expand_wildcards", + "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + { + "in": "query", + "name": "include_defaults", + "description": "If `true`, return all default settings in the response.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data_streams": { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.get_data_lifecycle:DataStreamWithLifecycle" + } + } + }, + "required": [ + "data_streams" + ] + } + } + } + } + }, + "x-available-since": "8.11.0" + }, + "put": { + "tags": [ + "indices.put_data_lifecycle" + ], + "summary": "Update data stream lifecycles", + "description": "Update the data stream lifecycle of the specified data streams.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-put-lifecycle.html" + }, + "operationId": "indices-put-data-lifecycle", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "Comma-separated list of data streams used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams use `*` or `_all`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DataStreamNames" + }, + "style": "simple" + }, + { + "in": "query", + "name": "expand_wildcards", + "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `hidden`, `open`, `closed`, `none`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data_retention": { + "$ref": "#/components/schemas/_types:Duration" + }, + "downsampling": { + "$ref": "#/components/schemas/indices._types:DataStreamLifecycleDownsampling" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "8.11.0" + }, + "delete": { + "tags": [ + "indices.delete_data_lifecycle" + ], + "summary": "Delete data stream lifecycles", + "description": "Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-delete-lifecycle.html" + }, + "operationId": "indices-delete-data-lifecycle", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "A comma-separated list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DataStreamNames" + }, + "style": "simple" + }, + { + "in": "query", + "name": "expand_wildcards", + "description": "Whether wildcard expressions should get expanded to open or closed indices (default: open)", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Specify timeout for connection to master", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Explicit timestamp for the document", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "8.11.0" + } + }, + "/_index_template/{name}": { + "get": { + "tags": [ + "indices.get_index_template" + ], + "summary": "Get index templates", + "description": "Returns information about one or more index templates.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template.html" + }, + "operationId": "indices-get-index-template-1", + "parameters": [ + { + "$ref": "#/components/parameters/indices.get_index_template#name" + }, + { + "$ref": "#/components/parameters/indices.get_index_template#local" + }, + { + "$ref": "#/components/parameters/indices.get_index_template#flat_settings" + }, + { + "$ref": "#/components/parameters/indices.get_index_template#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.get_index_template#include_defaults" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/indices.get_index_template#200" + } + }, + "x-available-since": "7.9.0" + }, + "put": { + "tags": [ + "indices.put_index_template" + ], + "summary": "Create or update an index template", + "description": "Index templates define settings, mappings, and aliases that can be applied automatically to new indices.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-template.html" + }, + "operationId": "indices-put-index-template", + "parameters": [ + { + "$ref": "#/components/parameters/indices.put_index_template#name" + }, + { + "$ref": "#/components/parameters/indices.put_index_template#create" + }, + { + "$ref": "#/components/parameters/indices.put_index_template#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.put_index_template#cause" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.put_index_template" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.put_index_template#200" + } + }, + "x-available-since": "7.9.0" + }, + "post": { + "tags": [ + "indices.put_index_template" + ], + "summary": "Create or update an index template", + "description": "Index templates define settings, mappings, and aliases that can be applied automatically to new indices.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-template.html" + }, + "operationId": "indices-put-index-template-1", + "parameters": [ + { + "$ref": "#/components/parameters/indices.put_index_template#name" + }, + { + "$ref": "#/components/parameters/indices.put_index_template#create" + }, + { + "$ref": "#/components/parameters/indices.put_index_template#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.put_index_template#cause" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.put_index_template" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.put_index_template#200" + } + }, + "x-available-since": "7.9.0" + }, + "delete": { + "tags": [ + "indices.delete_index_template" + ], + "summary": "Delete an index template", + "description": "The provided may contain multiple template names separated by a comma. If multiple template\nnames are specified then there is no wildcard support and the provided names should match completely with\nexisting templates.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template.html" + }, + "operationId": "indices-delete-index-template", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "simple" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "7.8.0" + }, + "head": { + "tags": [ + "indices.exists_index_template" + ], + "summary": "Returns information about whether a particular index template exists", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-templates.html" + }, + "operationId": "indices-exists-index-template", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": {} + } + } + } + } + }, + "/_alias/{name}": { + "get": { + "tags": [ + "indices.get_alias" + ], + "summary": "Get aliases", + "description": "Retrieves information for one or more data stream or index aliases.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" + }, + "operationId": "indices-get-alias-1", + "parameters": [ + { + "$ref": "#/components/parameters/indices.get_alias#name" + }, + { + "$ref": "#/components/parameters/indices.get_alias#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.get_alias#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.get_alias#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.get_alias#local" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/indices.get_alias#200" + } + } + }, + "head": { + "tags": [ + "indices.exists_alias" + ], + "summary": "Check aliases", + "description": "Checks if one or more data stream or index aliases exist.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" + }, + "operationId": "indices-exists-alias", + "parameters": [ + { + "$ref": "#/components/parameters/indices.exists_alias#name" + }, + { + "$ref": "#/components/parameters/indices.exists_alias#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.exists_alias#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.exists_alias#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.exists_alias#local" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/indices.exists_alias#200" + } + } + } + }, + "/{index}/_lifecycle/explain": { + "get": { + "tags": [ + "indices.explain_data_lifecycle" + ], + "summary": "Get the status for a data stream lifecycle", + "description": "Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-explain-lifecycle.html" + }, + "operationId": "indices-explain-data-lifecycle", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "The name of the index to explain", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + { + "in": "query", + "name": "include_defaults", + "description": "indicates if the API should return the default values the system uses for the index's lifecycle", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Specify timeout for connection to master", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "indices": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/indices.explain_data_lifecycle:DataStreamLifecycleExplain" + } + } + }, + "required": [ + "indices" + ] + } + } + } + } + }, + "x-available-since": "8.11.0" + } + }, + "/_alias": { + "get": { + "tags": [ + "indices.get_alias" + ], + "summary": "Get aliases", + "description": "Retrieves information for one or more data stream or index aliases.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" + }, + "operationId": "indices-get-alias", + "parameters": [ + { + "$ref": "#/components/parameters/indices.get_alias#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.get_alias#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.get_alias#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.get_alias#local" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/indices.get_alias#200" + } + } + } + }, + "/{index}/_alias": { + "get": { + "tags": [ + "indices.get_alias" + ], + "summary": "Get aliases", + "description": "Retrieves information for one or more data stream or index aliases.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" + }, + "operationId": "indices-get-alias-3", + "parameters": [ + { + "$ref": "#/components/parameters/indices.get_alias#index" + }, + { + "$ref": "#/components/parameters/indices.get_alias#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.get_alias#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.get_alias#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.get_alias#local" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/indices.get_alias#200" + } + } + } + }, + "/_data_stream": { + "get": { + "tags": [ + "indices.get_data_stream" + ], + "summary": "Get data streams", + "description": "Retrieves information about one or more data streams.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" + }, + "operationId": "indices-get-data-stream", + "parameters": [ + { + "$ref": "#/components/parameters/indices.get_data_stream#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.get_data_stream#include_defaults" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/indices.get_data_stream#200" + } + }, + "x-available-since": "7.9.0" + } + }, + "/_index_template": { + "get": { + "tags": [ + "indices.get_index_template" + ], + "summary": "Get index templates", + "description": "Returns information about one or more index templates.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template.html" + }, + "operationId": "indices-get-index-template", + "parameters": [ + { + "$ref": "#/components/parameters/indices.get_index_template#local" + }, + { + "$ref": "#/components/parameters/indices.get_index_template#flat_settings" + }, + { + "$ref": "#/components/parameters/indices.get_index_template#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.get_index_template#include_defaults" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/indices.get_index_template#200" + } + }, + "x-available-since": "7.9.0" + } + }, + "/_mapping": { + "get": { + "tags": [ + "indices.get_mapping" + ], + "summary": "Get mapping definitions", + "description": "Retrieves mapping definitions for one or more indices.\nFor data streams, the API retrieves mappings for the stream’s backing indices.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html" + }, + "operationId": "indices-get-mapping", + "parameters": [ + { + "$ref": "#/components/parameters/indices.get_mapping#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.get_mapping#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.get_mapping#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.get_mapping#local" + }, + { + "$ref": "#/components/parameters/indices.get_mapping#master_timeout" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/indices.get_mapping#200" + } + } + } + }, + "/{index}/_mapping": { + "get": { + "tags": [ + "indices.get_mapping" + ], + "summary": "Get mapping definitions", + "description": "Retrieves mapping definitions for one or more indices.\nFor data streams, the API retrieves mappings for the stream’s backing indices.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html" + }, + "operationId": "indices-get-mapping-1", + "parameters": [ + { + "$ref": "#/components/parameters/indices.get_mapping#index" + }, + { + "$ref": "#/components/parameters/indices.get_mapping#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.get_mapping#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.get_mapping#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.get_mapping#local" + }, + { + "$ref": "#/components/parameters/indices.get_mapping#master_timeout" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/indices.get_mapping#200" + } + } + }, + "put": { + "tags": [ + "indices.put_mapping" + ], + "summary": "Update field mappings", + "description": "Adds new fields to an existing data stream or index.\nYou can also use this API to change the search settings of existing fields.\nFor data streams, these changes are applied to all backing indices by default.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html" + }, + "operationId": "indices-put-mapping", + "parameters": [ + { + "$ref": "#/components/parameters/indices.put_mapping#index" + }, + { + "$ref": "#/components/parameters/indices.put_mapping#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.put_mapping#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.put_mapping#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.put_mapping#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.put_mapping#timeout" + }, + { + "$ref": "#/components/parameters/indices.put_mapping#write_index_only" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.put_mapping" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.put_mapping#200" + } + } + }, + "post": { + "tags": [ + "indices.put_mapping" + ], + "summary": "Update field mappings", + "description": "Adds new fields to an existing data stream or index.\nYou can also use this API to change the search settings of existing fields.\nFor data streams, these changes are applied to all backing indices by default.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html" + }, + "operationId": "indices-put-mapping-1", + "parameters": [ + { + "$ref": "#/components/parameters/indices.put_mapping#index" + }, + { + "$ref": "#/components/parameters/indices.put_mapping#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.put_mapping#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.put_mapping#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.put_mapping#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.put_mapping#timeout" + }, + { + "$ref": "#/components/parameters/indices.put_mapping#write_index_only" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.put_mapping" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.put_mapping#200" + } + } + } + }, + "/_settings": { + "get": { + "tags": [ + "indices.get_settings" + ], + "summary": "Get index settings", + "description": "Returns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" + }, + "operationId": "indices-get-settings", + "parameters": [ + { + "$ref": "#/components/parameters/indices.get_settings#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.get_settings#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.get_settings#flat_settings" + }, + { + "$ref": "#/components/parameters/indices.get_settings#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.get_settings#include_defaults" + }, + { + "$ref": "#/components/parameters/indices.get_settings#local" + }, + { + "$ref": "#/components/parameters/indices.get_settings#master_timeout" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/indices.get_settings#200" + } + } + }, + "put": { + "tags": [ + "indices.put_settings" + ], + "summary": "Update index settings", + "description": "Changes dynamic index settings in real time. For data streams, index setting\nchanges are applied to all backing indices by default.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html" + }, + "operationId": "indices-put-settings", + "parameters": [ + { + "$ref": "#/components/parameters/indices.put_settings#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.put_settings#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.put_settings#flat_settings" + }, + { + "$ref": "#/components/parameters/indices.put_settings#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.put_settings#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.put_settings#preserve_existing" + }, + { + "$ref": "#/components/parameters/indices.put_settings#timeout" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.put_settings" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.put_settings#200" + } + } + } + }, + "/{index}/_settings": { + "get": { + "tags": [ + "indices.get_settings" + ], + "summary": "Get index settings", + "description": "Returns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" + }, + "operationId": "indices-get-settings-1", + "parameters": [ + { + "$ref": "#/components/parameters/indices.get_settings#index" + }, + { + "$ref": "#/components/parameters/indices.get_settings#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.get_settings#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.get_settings#flat_settings" + }, + { + "$ref": "#/components/parameters/indices.get_settings#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.get_settings#include_defaults" + }, + { + "$ref": "#/components/parameters/indices.get_settings#local" + }, + { + "$ref": "#/components/parameters/indices.get_settings#master_timeout" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/indices.get_settings#200" + } + } + }, + "put": { + "tags": [ + "indices.put_settings" + ], + "summary": "Update index settings", + "description": "Changes dynamic index settings in real time. For data streams, index setting\nchanges are applied to all backing indices by default.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html" + }, + "operationId": "indices-put-settings-1", + "parameters": [ + { + "$ref": "#/components/parameters/indices.put_settings#index" + }, + { + "$ref": "#/components/parameters/indices.put_settings#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.put_settings#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.put_settings#flat_settings" + }, + { + "$ref": "#/components/parameters/indices.put_settings#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.put_settings#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.put_settings#preserve_existing" + }, + { + "$ref": "#/components/parameters/indices.put_settings#timeout" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.put_settings" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.put_settings#200" + } + } + } + }, + "/{index}/_settings/{name}": { + "get": { + "tags": [ + "indices.get_settings" + ], + "summary": "Get index settings", + "description": "Returns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" + }, + "operationId": "indices-get-settings-2", + "parameters": [ + { + "$ref": "#/components/parameters/indices.get_settings#index" + }, + { + "$ref": "#/components/parameters/indices.get_settings#name" + }, + { + "$ref": "#/components/parameters/indices.get_settings#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.get_settings#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.get_settings#flat_settings" + }, + { + "$ref": "#/components/parameters/indices.get_settings#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.get_settings#include_defaults" + }, + { + "$ref": "#/components/parameters/indices.get_settings#local" + }, + { + "$ref": "#/components/parameters/indices.get_settings#master_timeout" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/indices.get_settings#200" + } + } + } + }, + "/_settings/{name}": { + "get": { + "tags": [ + "indices.get_settings" + ], + "summary": "Get index settings", + "description": "Returns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" + }, + "operationId": "indices-get-settings-3", + "parameters": [ + { + "$ref": "#/components/parameters/indices.get_settings#name" + }, + { + "$ref": "#/components/parameters/indices.get_settings#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.get_settings#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.get_settings#flat_settings" + }, + { + "$ref": "#/components/parameters/indices.get_settings#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.get_settings#include_defaults" + }, + { + "$ref": "#/components/parameters/indices.get_settings#local" + }, + { + "$ref": "#/components/parameters/indices.get_settings#master_timeout" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/indices.get_settings#200" + } + } + } + }, + "/_data_stream/_migrate/{name}": { + "post": { + "tags": [ + "indices.migrate_to_data_stream" + ], + "summary": "Convert an index alias to a data stream", + "description": "Converts an index alias to a data stream.\nYou must have a matching index template that is data stream enabled.\nThe alias must meet the following criteria:\nThe alias must have a write index;\nAll indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;\nThe alias must not have any filters;\nThe alias must not use custom routing.\nIf successful, the request removes the alias and creates a data stream with the same name.\nThe indices for the alias become hidden backing indices for the stream.\nThe write index for the alias becomes the write index for the stream.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" + }, + "operationId": "indices-migrate-to-data-stream", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "Name of the index alias to convert to a data stream.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "7.9.0" + } + }, + "/_data_stream/_modify": { + "post": { + "tags": [ + "indices.modify_data_stream" + ], + "summary": "Update data streams", + "description": "Performs one or more data stream modification actions in a single atomic operation.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" + }, + "operationId": "indices-modify-data-stream", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "actions": { + "description": "Actions to perform.", + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.modify_data_stream:Action" + } + } + }, + "required": [ + "actions" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "7.16.0" + } + }, + "/_template/{name}": { + "put": { + "tags": [ + "indices.put_template" + ], + "summary": "Create or update an index template", + "description": "Index templates define settings, mappings, and aliases that can be applied automatically to new indices.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html" + }, + "operationId": "indices-put-template", + "parameters": [ + { + "$ref": "#/components/parameters/indices.put_template#name" + }, + { + "$ref": "#/components/parameters/indices.put_template#create" + }, + { + "$ref": "#/components/parameters/indices.put_template#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.put_template#order" + }, + { + "$ref": "#/components/parameters/indices.put_template#cause" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.put_template" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.put_template#200" + } + } + }, + "post": { + "tags": [ + "indices.put_template" + ], + "summary": "Create or update an index template", + "description": "Index templates define settings, mappings, and aliases that can be applied automatically to new indices.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html" + }, + "operationId": "indices-put-template-1", + "parameters": [ + { + "$ref": "#/components/parameters/indices.put_template#name" + }, + { + "$ref": "#/components/parameters/indices.put_template#create" + }, + { + "$ref": "#/components/parameters/indices.put_template#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.put_template#order" + }, + { + "$ref": "#/components/parameters/indices.put_template#cause" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.put_template" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.put_template#200" + } + } + } + }, + "/_refresh": { + "get": { + "tags": [ + "indices.refresh" + ], + "summary": "Refresh an index", + "description": "A refresh makes recent operations performed on one or more indices available for search.\nFor data streams, the API runs the refresh operation on the stream’s backing indices.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" + }, + "operationId": "indices-refresh-1", + "parameters": [ + { + "$ref": "#/components/parameters/indices.refresh#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.refresh#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.refresh#ignore_unavailable" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/indices.refresh#200" + } + } + }, + "post": { + "tags": [ + "indices.refresh" + ], + "summary": "Refresh an index", + "description": "A refresh makes recent operations performed on one or more indices available for search.\nFor data streams, the API runs the refresh operation on the stream’s backing indices.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" + }, + "operationId": "indices-refresh", + "parameters": [ + { + "$ref": "#/components/parameters/indices.refresh#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.refresh#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.refresh#ignore_unavailable" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/indices.refresh#200" + } + } + } + }, + "/{index}/_refresh": { + "get": { + "tags": [ + "indices.refresh" + ], + "summary": "Refresh an index", + "description": "A refresh makes recent operations performed on one or more indices available for search.\nFor data streams, the API runs the refresh operation on the stream’s backing indices.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" + }, + "operationId": "indices-refresh-3", + "parameters": [ + { + "$ref": "#/components/parameters/indices.refresh#index" + }, + { + "$ref": "#/components/parameters/indices.refresh#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.refresh#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.refresh#ignore_unavailable" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/indices.refresh#200" + } + } + }, + "post": { + "tags": [ + "indices.refresh" + ], + "summary": "Refresh an index", + "description": "A refresh makes recent operations performed on one or more indices available for search.\nFor data streams, the API runs the refresh operation on the stream’s backing indices.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" + }, + "operationId": "indices-refresh-2", + "parameters": [ + { + "$ref": "#/components/parameters/indices.refresh#index" + }, + { + "$ref": "#/components/parameters/indices.refresh#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.refresh#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.refresh#ignore_unavailable" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/indices.refresh#200" + } + } + } + }, + "/_resolve/index/{name}": { + "get": { + "tags": [ + "indices.resolve_index" + ], + "summary": "Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams", + "description": "Multiple patterns and remote clusters are supported.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-index-api.html" + }, + "operationId": "indices-resolve-index", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve.\nResources on remote clusters can be specified using the ``:`` syntax.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "simple" + }, + { + "in": "query", + "name": "expand_wildcards", + "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "indices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.resolve_index:ResolveIndexItem" + } + }, + "aliases": { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.resolve_index:ResolveIndexAliasItem" + } + }, + "data_streams": { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.resolve_index:ResolveIndexDataStreamsItem" + } + } + }, + "required": [ + "indices", + "aliases", + "data_streams" + ] + } + } + } + } + }, + "x-available-since": "7.9.0" + } + }, + "/{alias}/_rollover": { + "post": { + "tags": [ + "indices.rollover" + ], + "summary": "Roll over to a new index", + "description": "Creates a new index for a data stream or index alias.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-rollover-index.html" + }, + "operationId": "indices-rollover", + "parameters": [ + { + "$ref": "#/components/parameters/indices.rollover#alias" + }, + { + "$ref": "#/components/parameters/indices.rollover#dry_run" + }, + { + "$ref": "#/components/parameters/indices.rollover#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.rollover#timeout" + }, + { + "$ref": "#/components/parameters/indices.rollover#wait_for_active_shards" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.rollover" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.rollover#200" + } + }, + "x-available-since": "5.0.0" + } + }, + "/{alias}/_rollover/{new_index}": { + "post": { + "tags": [ + "indices.rollover" + ], + "summary": "Roll over to a new index", + "description": "Creates a new index for a data stream or index alias.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-rollover-index.html" + }, + "operationId": "indices-rollover-1", + "parameters": [ + { + "$ref": "#/components/parameters/indices.rollover#alias" + }, + { + "$ref": "#/components/parameters/indices.rollover#new_index" + }, + { + "$ref": "#/components/parameters/indices.rollover#dry_run" + }, + { + "$ref": "#/components/parameters/indices.rollover#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.rollover#timeout" + }, + { + "$ref": "#/components/parameters/indices.rollover#wait_for_active_shards" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.rollover" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.rollover#200" + } + }, + "x-available-since": "5.0.0" + } + }, + "/_index_template/_simulate_index/{name}": { + "post": { + "tags": [ + "indices.simulate_index_template" + ], + "summary": "Simulate an index", + "description": "Returns the index configuration that would be applied to the specified index from an existing index template.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-index.html" + }, + "operationId": "indices-simulate-index-template", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "Name of the index to simulate", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "include_defaults", + "description": "If true, returns all relevant default configurations for the index template.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "overlapping": { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.simulate_template:Overlapping" + } + }, + "template": { + "$ref": "#/components/schemas/indices.simulate_template:Template" + } + }, + "required": [ + "template" + ] + } + } + } + } + }, + "x-available-since": "7.9.0" + } + }, + "/_index_template/_simulate": { + "post": { + "tags": [ + "indices.simulate_template" + ], + "summary": "Simulate an index template", + "description": "Returns the index configuration that would be applied by a particular index template.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-template.html" + }, + "operationId": "indices-simulate-template", + "parameters": [ + { + "$ref": "#/components/parameters/indices.simulate_template#create" + }, + { + "$ref": "#/components/parameters/indices.simulate_template#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.simulate_template#include_defaults" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.simulate_template" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.simulate_template#200" + } + } + } + }, + "/_index_template/_simulate/{name}": { + "post": { + "tags": [ + "indices.simulate_template" + ], + "summary": "Simulate an index template", + "description": "Returns the index configuration that would be applied by a particular index template.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-template.html" + }, + "operationId": "indices-simulate-template-1", + "parameters": [ + { + "$ref": "#/components/parameters/indices.simulate_template#name" + }, + { + "$ref": "#/components/parameters/indices.simulate_template#create" + }, + { + "$ref": "#/components/parameters/indices.simulate_template#master_timeout" + }, + { + "$ref": "#/components/parameters/indices.simulate_template#include_defaults" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.simulate_template" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.simulate_template#200" + } + } + } + }, + "/_aliases": { + "post": { + "tags": [ + "indices.update_aliases" + ], + "summary": "Create or update an alias", + "description": "Adds a data stream or index to an alias.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" + }, + "operationId": "indices-update-aliases", + "parameters": [ + { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "actions": { + "description": "Actions to perform.", + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.update_aliases:Action" + } + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "1.3.0" + } + }, + "/_validate/query": { + "get": { + "tags": [ + "indices.validate_query" + ], + "summary": "Validate a query", + "description": "Validates a query without running it.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html" + }, + "operationId": "indices-validate-query", + "parameters": [ + { + "$ref": "#/components/parameters/indices.validate_query#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.validate_query#all_shards" + }, + { + "$ref": "#/components/parameters/indices.validate_query#analyzer" + }, + { + "$ref": "#/components/parameters/indices.validate_query#analyze_wildcard" + }, + { + "$ref": "#/components/parameters/indices.validate_query#default_operator" + }, + { + "$ref": "#/components/parameters/indices.validate_query#df" + }, + { + "$ref": "#/components/parameters/indices.validate_query#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.validate_query#explain" + }, + { + "$ref": "#/components/parameters/indices.validate_query#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.validate_query#lenient" + }, + { + "$ref": "#/components/parameters/indices.validate_query#rewrite" + }, + { + "$ref": "#/components/parameters/indices.validate_query#q" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.validate_query" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.validate_query#200" + } + }, + "x-available-since": "1.3.0" + }, + "post": { + "tags": [ + "indices.validate_query" + ], + "summary": "Validate a query", + "description": "Validates a query without running it.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html" + }, + "operationId": "indices-validate-query-1", + "parameters": [ + { + "$ref": "#/components/parameters/indices.validate_query#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.validate_query#all_shards" + }, + { + "$ref": "#/components/parameters/indices.validate_query#analyzer" + }, + { + "$ref": "#/components/parameters/indices.validate_query#analyze_wildcard" + }, + { + "$ref": "#/components/parameters/indices.validate_query#default_operator" + }, + { + "$ref": "#/components/parameters/indices.validate_query#df" + }, + { + "$ref": "#/components/parameters/indices.validate_query#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.validate_query#explain" + }, + { + "$ref": "#/components/parameters/indices.validate_query#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.validate_query#lenient" + }, + { + "$ref": "#/components/parameters/indices.validate_query#rewrite" + }, + { + "$ref": "#/components/parameters/indices.validate_query#q" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.validate_query" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.validate_query#200" + } + }, + "x-available-since": "1.3.0" + } + }, + "/{index}/_validate/query": { + "get": { + "tags": [ + "indices.validate_query" + ], + "summary": "Validate a query", + "description": "Validates a query without running it.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html" + }, + "operationId": "indices-validate-query-2", + "parameters": [ + { + "$ref": "#/components/parameters/indices.validate_query#index" + }, + { + "$ref": "#/components/parameters/indices.validate_query#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.validate_query#all_shards" + }, + { + "$ref": "#/components/parameters/indices.validate_query#analyzer" + }, + { + "$ref": "#/components/parameters/indices.validate_query#analyze_wildcard" + }, + { + "$ref": "#/components/parameters/indices.validate_query#default_operator" + }, + { + "$ref": "#/components/parameters/indices.validate_query#df" + }, + { + "$ref": "#/components/parameters/indices.validate_query#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.validate_query#explain" + }, + { + "$ref": "#/components/parameters/indices.validate_query#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.validate_query#lenient" + }, + { + "$ref": "#/components/parameters/indices.validate_query#rewrite" + }, + { + "$ref": "#/components/parameters/indices.validate_query#q" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.validate_query" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.validate_query#200" + } + }, + "x-available-since": "1.3.0" + }, + "post": { + "tags": [ + "indices.validate_query" + ], + "summary": "Validate a query", + "description": "Validates a query without running it.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html" + }, + "operationId": "indices-validate-query-3", + "parameters": [ + { + "$ref": "#/components/parameters/indices.validate_query#index" + }, + { + "$ref": "#/components/parameters/indices.validate_query#allow_no_indices" + }, + { + "$ref": "#/components/parameters/indices.validate_query#all_shards" + }, + { + "$ref": "#/components/parameters/indices.validate_query#analyzer" + }, + { + "$ref": "#/components/parameters/indices.validate_query#analyze_wildcard" + }, + { + "$ref": "#/components/parameters/indices.validate_query#default_operator" + }, + { + "$ref": "#/components/parameters/indices.validate_query#df" + }, + { + "$ref": "#/components/parameters/indices.validate_query#expand_wildcards" + }, + { + "$ref": "#/components/parameters/indices.validate_query#explain" + }, + { + "$ref": "#/components/parameters/indices.validate_query#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/indices.validate_query#lenient" + }, + { + "$ref": "#/components/parameters/indices.validate_query#rewrite" + }, + { + "$ref": "#/components/parameters/indices.validate_query#q" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/indices.validate_query" + }, + "responses": { + "200": { + "$ref": "#/components/responses/indices.validate_query#200" + } + }, + "x-available-since": "1.3.0" + } + }, + "/_inference/{inference_id}": { + "get": { + "tags": [ + "inference.get" + ], + "summary": "Get an inference endpoint", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html" + }, + "operationId": "inference-get-1", + "parameters": [ + { + "$ref": "#/components/parameters/inference.get#inference_id" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/inference.get#200" + } + }, + "x-technical-preview": true, + "x-available-since": "8.11.0" + }, + "put": { + "tags": [ + "inference.put" + ], + "summary": "Create an inference endpoint", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html" + }, + "operationId": "inference-put", + "parameters": [ + { + "$ref": "#/components/parameters/inference.put#inference_id" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/inference.put" + }, + "responses": { + "200": { + "$ref": "#/components/responses/inference.put#200" + } + }, + "x-technical-preview": true, + "x-available-since": "8.11.0" + }, + "post": { + "tags": [ + "inference.inference" + ], + "summary": "Perform inference on the service", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html" + }, + "operationId": "inference-inference", + "parameters": [ + { + "$ref": "#/components/parameters/inference.inference#inference_id" + }, + { + "$ref": "#/components/parameters/inference.inference#timeout" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/inference.inference" + }, + "responses": { + "200": { + "$ref": "#/components/responses/inference.inference#200" + } + }, + "x-technical-preview": true, + "x-available-since": "8.11.0" + }, + "delete": { + "tags": [ + "inference.delete" + ], + "summary": "Delete an inference endpoint", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-inference-api.html" + }, + "operationId": "inference-delete", + "parameters": [ + { + "$ref": "#/components/parameters/inference.delete#inference_id" + }, + { + "$ref": "#/components/parameters/inference.delete#dry_run" + }, + { + "$ref": "#/components/parameters/inference.delete#force" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/inference.delete#200" + } + }, + "x-technical-preview": true, + "x-available-since": "8.11.0" + } + }, + "/_inference/{task_type}/{inference_id}": { + "get": { + "tags": [ + "inference.get" + ], + "summary": "Get an inference endpoint", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html" + }, + "operationId": "inference-get-2", + "parameters": [ + { + "$ref": "#/components/parameters/inference.get#task_type" + }, + { + "$ref": "#/components/parameters/inference.get#inference_id" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/inference.get#200" + } + }, + "x-technical-preview": true, + "x-available-since": "8.11.0" + }, + "put": { + "tags": [ + "inference.put" + ], + "summary": "Create an inference endpoint", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html" + }, + "operationId": "inference-put-1", + "parameters": [ + { + "$ref": "#/components/parameters/inference.put#task_type" + }, + { + "$ref": "#/components/parameters/inference.put#inference_id" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/inference.put" + }, + "responses": { + "200": { + "$ref": "#/components/responses/inference.put#200" + } + }, + "x-technical-preview": true, + "x-available-since": "8.11.0" + }, + "post": { + "tags": [ + "inference.inference" + ], + "summary": "Perform inference on the service", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html" + }, + "operationId": "inference-inference-1", + "parameters": [ + { + "$ref": "#/components/parameters/inference.inference#task_type" + }, + { + "$ref": "#/components/parameters/inference.inference#inference_id" + }, + { + "$ref": "#/components/parameters/inference.inference#timeout" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/inference.inference" + }, + "responses": { + "200": { + "$ref": "#/components/responses/inference.inference#200" + } + }, + "x-technical-preview": true, + "x-available-since": "8.11.0" + }, + "delete": { + "tags": [ + "inference.delete" + ], + "summary": "Delete an inference endpoint", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-inference-api.html" + }, + "operationId": "inference-delete-1", + "parameters": [ + { + "$ref": "#/components/parameters/inference.delete#task_type" + }, + { + "$ref": "#/components/parameters/inference.delete#inference_id" + }, + { + "$ref": "#/components/parameters/inference.delete#dry_run" + }, + { + "$ref": "#/components/parameters/inference.delete#force" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/inference.delete#200" + } + }, + "x-technical-preview": true, + "x-available-since": "8.11.0" + } + }, + "/_inference": { + "get": { + "tags": [ + "inference.get" + ], + "summary": "Get an inference endpoint", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html" + }, + "operationId": "inference-get", + "responses": { + "200": { + "$ref": "#/components/responses/inference.get#200" + } + }, + "x-technical-preview": true, + "x-available-since": "8.11.0" + } + }, + "/": { + "get": { + "tags": [ + "info" + ], + "summary": "Get cluster info", + "description": "Returns basic information about the cluster.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" + }, + "operationId": "info", + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cluster_name": { + "$ref": "#/components/schemas/_types:Name" + }, + "cluster_uuid": { + "$ref": "#/components/schemas/_types:Uuid" + }, + "name": { + "$ref": "#/components/schemas/_types:Name" + }, + "tagline": { + "type": "string" + }, + "version": { + "$ref": "#/components/schemas/_types:ElasticsearchVersionInfo" + } + }, + "required": [ + "cluster_name", + "cluster_uuid", + "name", + "tagline", + "version" + ] + } + } + } + } + } + }, + "head": { + "tags": [ + "ping" + ], + "summary": "Ping the cluster", + "description": "Returns whether the cluster is running.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" + }, + "operationId": "ping", + "responses": { + "200": { + "description": "", + "content": { + "application/json": {} + } + } + } + } + }, + "/_ingest/pipeline/{id}": { + "get": { + "tags": [ + "ingest.get_pipeline" + ], + "summary": "Returns information about one or more ingest pipelines", + "description": "This API returns a local reference of the pipeline.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html" + }, + "operationId": "ingest-get-pipeline-1", + "parameters": [ + { + "$ref": "#/components/parameters/ingest.get_pipeline#id" + }, + { + "$ref": "#/components/parameters/ingest.get_pipeline#master_timeout" + }, + { + "$ref": "#/components/parameters/ingest.get_pipeline#summary" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/ingest.get_pipeline#200" + } + }, + "x-available-since": "5.0.0" + }, + "put": { + "tags": [ + "ingest.put_pipeline" + ], + "summary": "Creates or updates an ingest pipeline", + "description": "Changes made using this API take effect immediately.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html" + }, + "operationId": "ingest-put-pipeline", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "ID of the ingest pipeline to create or update.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "if_version", + "description": "Required version for optimistic concurrency control for pipeline updates", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "_meta": { + "$ref": "#/components/schemas/_types:Metadata" + }, + "description": { + "description": "Description of the ingest pipeline.", + "type": "string" + }, + "on_failure": { + "description": "Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ingest._types:ProcessorContainer" + } + }, + "processors": { + "description": "Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ingest._types:ProcessorContainer" + } + }, + "version": { + "$ref": "#/components/schemas/_types:VersionNumber" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "5.0.0" + }, + "delete": { + "tags": [ + "ingest.delete_pipeline" + ], + "summary": "Deletes one or more existing ingest pipeline", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html" + }, + "operationId": "ingest-delete-pipeline", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Pipeline ID or wildcard expression of pipeline IDs used to limit the request.\nTo delete all ingest pipelines in a cluster, use a value of `*`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "5.0.0" + } + }, + "/_ingest/pipeline": { + "get": { + "tags": [ + "ingest.get_pipeline" + ], + "summary": "Returns information about one or more ingest pipelines", + "description": "This API returns a local reference of the pipeline.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html" + }, + "operationId": "ingest-get-pipeline", + "parameters": [ + { + "$ref": "#/components/parameters/ingest.get_pipeline#master_timeout" + }, + { + "$ref": "#/components/parameters/ingest.get_pipeline#summary" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/ingest.get_pipeline#200" + } + }, + "x-available-since": "5.0.0" + } + }, + "/_ingest/processor/grok": { + "get": { + "tags": [ + "ingest.processor_grok" + ], + "summary": "Extracts structured fields out of a single text field within a document", + "description": "You 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.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html" + }, + "operationId": "ingest-processor-grok", + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "patterns": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "patterns" + ] + } + } + } + } + }, + "x-available-since": "6.1.0" + } + }, + "/_ingest/pipeline/_simulate": { + "get": { + "tags": [ + "ingest.simulate" + ], + "summary": "Executes an ingest pipeline against a set of provided documents", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html" + }, + "operationId": "ingest-simulate", + "parameters": [ + { + "$ref": "#/components/parameters/ingest.simulate#verbose" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/ingest.simulate" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ingest.simulate#200" + } + }, + "x-available-since": "5.0.0" + }, + "post": { + "tags": [ + "ingest.simulate" + ], + "summary": "Executes an ingest pipeline against a set of provided documents", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html" + }, + "operationId": "ingest-simulate-1", + "parameters": [ + { + "$ref": "#/components/parameters/ingest.simulate#verbose" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/ingest.simulate" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ingest.simulate#200" + } + }, + "x-available-since": "5.0.0" + } + }, + "/_ingest/pipeline/{id}/_simulate": { + "get": { + "tags": [ + "ingest.simulate" + ], + "summary": "Executes an ingest pipeline against a set of provided documents", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html" + }, + "operationId": "ingest-simulate-2", + "parameters": [ + { + "$ref": "#/components/parameters/ingest.simulate#id" + }, + { + "$ref": "#/components/parameters/ingest.simulate#verbose" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/ingest.simulate" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ingest.simulate#200" + } + }, + "x-available-since": "5.0.0" + }, + "post": { + "tags": [ + "ingest.simulate" + ], + "summary": "Executes an ingest pipeline against a set of provided documents", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html" + }, + "operationId": "ingest-simulate-3", + "parameters": [ + { + "$ref": "#/components/parameters/ingest.simulate#id" + }, + { + "$ref": "#/components/parameters/ingest.simulate#verbose" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/ingest.simulate" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ingest.simulate#200" + } + }, + "x-available-since": "5.0.0" + } + }, + "/_license": { + "get": { + "tags": [ + "license.get" + ], + "summary": "Get license information", + "description": "Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires.\nFor more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions).", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html" + }, + "operationId": "license-get", + "parameters": [ + { + "in": "query", + "name": "accept_enterprise", + "description": "If `true`, this parameter returns enterprise for Enterprise license types. If `false`, this parameter returns platinum for both platinum and enterprise license types. This behavior is maintained for backwards compatibility.\nThis parameter is deprecated and will always be set to true in 8.x.", + "deprecated": true, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "local", + "description": "Specifies whether to retrieve local information. The default value is `false`, which means the information is retrieved from the master node.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "license": { + "$ref": "#/components/schemas/license.get:LicenseInformation" + } + }, + "required": [ + "license" + ] + } + } + } + } + } + } + }, + "/_logstash/pipeline/{id}": { + "get": { + "tags": [ + "logstash.get_pipeline" + ], + "summary": "Retrieves pipelines used for Logstash Central Management", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-get-pipeline.html" + }, + "operationId": "logstash-get-pipeline-1", + "parameters": [ + { + "$ref": "#/components/parameters/logstash.get_pipeline#id" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/logstash.get_pipeline#200" + } + }, + "x-available-since": "7.12.0" + }, + "put": { + "tags": [ + "logstash.put_pipeline" + ], + "summary": "Creates or updates a pipeline used for Logstash Central Management", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-put-pipeline.html" + }, + "operationId": "logstash-put-pipeline", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Identifier for the pipeline.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/logstash._types:Pipeline" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": {} + } + } + }, + "x-available-since": "7.12.0" + }, + "delete": { + "tags": [ + "logstash.delete_pipeline" + ], + "summary": "Deletes a pipeline used for Logstash Central Management", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-delete-pipeline.html" + }, + "operationId": "logstash-delete-pipeline", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Identifier for the pipeline.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": {} + } + } + }, + "x-available-since": "7.12.0" + } + }, + "/_logstash/pipeline": { + "get": { + "tags": [ + "logstash.get_pipeline" + ], + "summary": "Retrieves pipelines used for Logstash Central Management", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-get-pipeline.html" + }, + "operationId": "logstash-get-pipeline", + "responses": { + "200": { + "$ref": "#/components/responses/logstash.get_pipeline#200" + } + }, + "x-available-since": "7.12.0" + } + }, + "/_mget": { + "get": { + "tags": [ + "mget" + ], + "summary": "Allows to get multiple documents in one request", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html" + }, + "operationId": "mget", + "parameters": [ + { + "$ref": "#/components/parameters/mget#preference" + }, + { + "$ref": "#/components/parameters/mget#realtime" + }, + { + "$ref": "#/components/parameters/mget#refresh" + }, + { + "$ref": "#/components/parameters/mget#routing" + }, + { + "$ref": "#/components/parameters/mget#_source" + }, + { + "$ref": "#/components/parameters/mget#_source_excludes" + }, + { + "$ref": "#/components/parameters/mget#_source_includes" + }, + { + "$ref": "#/components/parameters/mget#stored_fields" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/mget" + }, + "responses": { + "200": { + "$ref": "#/components/responses/mget#200" + } + }, + "x-available-since": "1.3.0" + }, + "post": { + "tags": [ + "mget" + ], + "summary": "Allows to get multiple documents in one request", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html" + }, + "operationId": "mget-1", + "parameters": [ + { + "$ref": "#/components/parameters/mget#preference" + }, + { + "$ref": "#/components/parameters/mget#realtime" + }, + { + "$ref": "#/components/parameters/mget#refresh" + }, + { + "$ref": "#/components/parameters/mget#routing" + }, + { + "$ref": "#/components/parameters/mget#_source" + }, + { + "$ref": "#/components/parameters/mget#_source_excludes" + }, + { + "$ref": "#/components/parameters/mget#_source_includes" + }, + { + "$ref": "#/components/parameters/mget#stored_fields" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/mget" + }, + "responses": { + "200": { + "$ref": "#/components/responses/mget#200" + } + }, + "x-available-since": "1.3.0" + } + }, + "/{index}/_mget": { + "get": { + "tags": [ + "mget" + ], + "summary": "Allows to get multiple documents in one request", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html" + }, + "operationId": "mget-2", + "parameters": [ + { + "$ref": "#/components/parameters/mget#index" + }, + { + "$ref": "#/components/parameters/mget#preference" + }, + { + "$ref": "#/components/parameters/mget#realtime" + }, + { + "$ref": "#/components/parameters/mget#refresh" + }, + { + "$ref": "#/components/parameters/mget#routing" + }, + { + "$ref": "#/components/parameters/mget#_source" + }, + { + "$ref": "#/components/parameters/mget#_source_excludes" + }, + { + "$ref": "#/components/parameters/mget#_source_includes" + }, + { + "$ref": "#/components/parameters/mget#stored_fields" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/mget" + }, + "responses": { + "200": { + "$ref": "#/components/responses/mget#200" + } + }, + "x-available-since": "1.3.0" + }, + "post": { + "tags": [ + "mget" + ], + "summary": "Allows to get multiple documents in one request", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html" + }, + "operationId": "mget-3", + "parameters": [ + { + "$ref": "#/components/parameters/mget#index" + }, + { + "$ref": "#/components/parameters/mget#preference" + }, + { + "$ref": "#/components/parameters/mget#realtime" + }, + { + "$ref": "#/components/parameters/mget#refresh" + }, + { + "$ref": "#/components/parameters/mget#routing" + }, + { + "$ref": "#/components/parameters/mget#_source" + }, + { + "$ref": "#/components/parameters/mget#_source_excludes" + }, + { + "$ref": "#/components/parameters/mget#_source_includes" + }, + { + "$ref": "#/components/parameters/mget#stored_fields" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/mget" + }, + "responses": { + "200": { + "$ref": "#/components/responses/mget#200" + } + }, + "x-available-since": "1.3.0" + } + }, + "/_ml/anomaly_detectors/{job_id}/_close": { + "post": { + "tags": [ + "ml.close_job" + ], + "summary": "Close anomaly detection jobs", + "description": "A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.\nWhen you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.\nIf you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.\nWhen a datafeed that has a specified end date stops, it automatically closes its associated job.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html" + }, + "operationId": "ml-close-job", + "parameters": [ + { + "in": "path", + "name": "job_id", + "description": "Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. You can close multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can close all jobs by using `_all` or by specifying `*` as the job identifier.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "allow_no_match", + "description": "Specifies what to do when the request: contains wildcard expressions and there are no jobs that match; contains the `_all` string or no identifiers and there are no matches; or contains wildcard expressions and there are only partial matches. By default, it returns an empty jobs array when there are no matches and the subset of results when there are partial matches.\nIf `false`, the request returns a 404 status code when there are no matches or only partial matches.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "force", + "description": "Use to close a failed job, or to forcefully close a job which has not responded to its initial close request; the request returns without performing the associated actions such as flushing buffers and persisting the model snapshots.\nIf you want the job to be in a consistent state after the close job API returns, do not set to `true`. This parameter should be used only in situations where the job has already failed or where you are not interested in results the job might have recently produced or might produce in the future.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Controls the time to wait until a job has closed.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "allow_no_match": { + "description": "Refer to the description for the `allow_no_match` query parameter.", + "type": "boolean" + }, + "force": { + "description": "Refer to the descriptiion for the `force` query parameter.", + "type": "boolean" + }, + "timeout": { + "$ref": "#/components/schemas/_types:Duration" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "closed": { + "type": "boolean" + } + }, + "required": [ + "closed" + ] + } + } + } + } + }, + "x-available-since": "5.4.0" + } + }, + "/_ml/calendars/{calendar_id}": { + "get": { + "tags": [ + "ml.get_calendars" + ], + "summary": "Retrieves configuration information for calendars", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html" + }, + "operationId": "ml-get-calendars-2", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_calendars#calendar_id" + }, + { + "$ref": "#/components/parameters/ml.get_calendars#from" + }, + { + "$ref": "#/components/parameters/ml.get_calendars#size" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/ml.get_calendars" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ml.get_calendars#200" + } + }, + "x-available-since": "6.2.0" + }, + "put": { + "tags": [ + "ml.put_calendar" + ], + "summary": "Creates a calendar", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html" + }, + "operationId": "ml-put-calendar", + "parameters": [ + { + "in": "path", + "name": "calendar_id", + "description": "A string that uniquely identifies a calendar.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "job_ids": { + "description": "An array of anomaly detection job identifiers.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Id" + } + }, + "description": { + "description": "A description of the calendar.", + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "calendar_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "description": { + "description": "A description of the calendar.", + "type": "string" + }, + "job_ids": { + "$ref": "#/components/schemas/_types:Ids" + } + }, + "required": [ + "calendar_id", + "job_ids" + ] + } + } + } + } + }, + "x-available-since": "6.2.0" + }, + "post": { + "tags": [ + "ml.get_calendars" + ], + "summary": "Retrieves configuration information for calendars", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html" + }, + "operationId": "ml-get-calendars-3", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_calendars#calendar_id" + }, + { + "$ref": "#/components/parameters/ml.get_calendars#from" + }, + { + "$ref": "#/components/parameters/ml.get_calendars#size" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/ml.get_calendars" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ml.get_calendars#200" + } + }, + "x-available-since": "6.2.0" + }, + "delete": { + "tags": [ + "ml.delete_calendar" + ], + "summary": "Delete a calendar", + "description": "Removes all scheduled events from a calendar, then deletes it.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar.html" + }, + "operationId": "ml-delete-calendar", + "parameters": [ + { + "in": "path", + "name": "calendar_id", + "description": "A string that uniquely identifies a calendar.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "6.2.0" + } + }, + "/_ml/calendars/{calendar_id}/events/{event_id}": { + "delete": { + "tags": [ + "ml.delete_calendar_event" + ], + "summary": "Delete events from a calendar", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-event.html" + }, + "operationId": "ml-delete-calendar-event", + "parameters": [ + { + "in": "path", + "name": "calendar_id", + "description": "A string that uniquely identifies a calendar.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "path", + "name": "event_id", + "description": "Identifier for the scheduled event.\nYou can obtain this identifier by using the get calendar events API.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "6.2.0" + } + }, + "/_ml/calendars/{calendar_id}/jobs/{job_id}": { + "put": { + "tags": [ + "ml.put_calendar_job" + ], + "summary": "Adds an anomaly detection job to a calendar", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html" + }, + "operationId": "ml-put-calendar-job", + "parameters": [ + { + "in": "path", + "name": "calendar_id", + "description": "A string that uniquely identifies a calendar.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "path", + "name": "job_id", + "description": "An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Ids" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "calendar_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "description": { + "description": "A description of the calendar.", + "type": "string" + }, + "job_ids": { + "$ref": "#/components/schemas/_types:Ids" + } + }, + "required": [ + "calendar_id", + "job_ids" + ] + } + } + } + } + }, + "x-available-since": "6.2.0" + }, + "delete": { + "tags": [ + "ml.delete_calendar_job" + ], + "summary": "Delete anomaly jobs from a calendar", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-job.html" + }, + "operationId": "ml-delete-calendar-job", + "parameters": [ + { + "in": "path", + "name": "calendar_id", + "description": "A string that uniquely identifies a calendar.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "path", + "name": "job_id", + "description": "An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a\ncomma-separated list of jobs or groups.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Ids" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "calendar_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "description": { + "description": "A description of the calendar.", + "type": "string" + }, + "job_ids": { + "$ref": "#/components/schemas/_types:Ids" + } + }, + "required": [ + "calendar_id", + "job_ids" + ] + } + } + } + } + }, + "x-available-since": "6.2.0" + } + }, + "/_ml/data_frame/analytics/{id}": { + "get": { + "tags": [ + "ml.get_data_frame_analytics" + ], + "summary": "Retrieves configuration information for data frame analytics jobs", + "description": "You can get information for multiple data frame analytics jobs in a single\nAPI request by using a comma-separated list of data frame analytics jobs or a\nwildcard expression.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html" + }, + "operationId": "ml-get-data-frame-analytics", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics#id" + }, + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics#allow_no_match" + }, + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics#from" + }, + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics#size" + }, + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics#exclude_generated" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/ml.get_data_frame_analytics#200" + } + }, + "x-available-since": "7.3.0" + }, + "put": { + "tags": [ + "ml.put_data_frame_analytics" + ], + "summary": "Instantiates a data frame analytics job", + "description": "This API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html" + }, + "operationId": "ml-put-data-frame-analytics", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Identifier for the data frame analytics job. This identifier can contain\nlowercase alphanumeric characters (a-z and 0-9), hyphens, and\nunderscores. It must start and end with alphanumeric characters.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "allow_lazy_start": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html" + }, + "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node. If\nset to `false` and a machine learning node with capacity to run the job\ncannot be immediately found, the API returns an error. If set to `true`,\nthe API does not return an error; the job waits in the `starting` state\nuntil sufficient machine learning node capacity is available. This\nbehavior is also affected by the cluster-wide\n`xpack.ml.max_lazy_ml_nodes` setting.", + "type": "boolean" + }, + "analysis": { + "$ref": "#/components/schemas/ml._types:DataframeAnalysisContainer" + }, + "analyzed_fields": { + "$ref": "#/components/schemas/ml._types:DataframeAnalysisAnalyzedFields" + }, + "description": { + "description": "A description of the job.", + "type": "string" + }, + "dest": { + "$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.", + "type": "number" + }, + "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.", + "type": "string" + }, + "source": { + "$ref": "#/components/schemas/ml._types:DataframeAnalyticsSource" + }, + "headers": { + "$ref": "#/components/schemas/_types:HttpHeaders" + }, + "version": { + "$ref": "#/components/schemas/_types:VersionString" + } + }, + "required": [ + "analysis", + "dest", + "source" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "authorization": { + "$ref": "#/components/schemas/ml._types:DataframeAnalyticsAuthorization" + }, + "allow_lazy_start": { + "type": "boolean" + }, + "analysis": { + "$ref": "#/components/schemas/ml._types:DataframeAnalysisContainer" + }, + "analyzed_fields": { + "$ref": "#/components/schemas/ml._types:DataframeAnalysisAnalyzedFields" + }, + "create_time": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "description": { + "type": "string" + }, + "dest": { + "$ref": "#/components/schemas/ml._types:DataframeAnalyticsDestination" + }, + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "max_num_threads": { + "type": "number" + }, + "model_memory_limit": { + "type": "string" + }, + "source": { + "$ref": "#/components/schemas/ml._types:DataframeAnalyticsSource" + }, + "version": { + "$ref": "#/components/schemas/_types:VersionString" + } + }, + "required": [ + "allow_lazy_start", + "analysis", + "create_time", + "dest", + "id", + "max_num_threads", + "model_memory_limit", + "source", + "version" + ] + } + } + } + } + }, + "x-available-since": "7.3.0" + }, + "delete": { + "tags": [ + "ml.delete_data_frame_analytics" + ], + "summary": "Delete a data frame analytics job", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html" + }, + "operationId": "ml-delete-data-frame-analytics", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Identifier for the data frame analytics job.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "force", + "description": "If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "The time to wait for the job to be deleted.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "7.3.0" + } + }, + "/_ml/datafeeds/{datafeed_id}": { + "get": { + "tags": [ + "ml.get_datafeeds" + ], + "summary": "Retrieves configuration information for datafeeds", + "description": "You can get information for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget information for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``.\nThis API returns a maximum of 10,000 datafeeds.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html" + }, + "operationId": "ml-get-datafeeds", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_datafeeds#datafeed_id" + }, + { + "$ref": "#/components/parameters/ml.get_datafeeds#allow_no_match" + }, + { + "$ref": "#/components/parameters/ml.get_datafeeds#exclude_generated" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/ml.get_datafeeds#200" + } + }, + "x-available-since": "5.5.0" + }, + "put": { + "tags": [ + "ml.put_datafeed" + ], + "summary": "Instantiates a datafeed", + "description": "Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.\nYou can associate only one datafeed with each anomaly detection job.\nThe datafeed contains a query that runs at a defined interval (`frequency`).\nIf you are concerned about delayed data, you can add a delay (`query_delay') at each interval.\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had\nat the time of creation and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.\nYou must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed\ndirectly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html" + }, + "operationId": "ml-put-datafeed", + "parameters": [ + { + "in": "path", + "name": "datafeed_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.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "allow_no_indices", + "description": "If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the `_all`\nstring or when no indices are specified.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "expand_wildcards", + "description": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines\nwhether wildcard expressions match hidden data streams. Supports comma-separated values.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + { + "in": "query", + "name": "ignore_throttled", + "description": "If true, concrete, expanded, or aliased indices are ignored when frozen.", + "deprecated": true, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "ignore_unavailable", + "description": "If true, unavailable indices (missing or closed) are ignored.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "description": "If set, the datafeed performs aggregation searches.\nSupport for aggregations is limited and should be used only with low cardinality data.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:AggregationContainer" + } + }, + "chunking_config": { + "$ref": "#/components/schemas/ml._types:ChunkingConfig" + }, + "delayed_data_check_config": { + "$ref": "#/components/schemas/ml._types:DelayedDataCheckConfig" + }, + "frequency": { + "$ref": "#/components/schemas/_types:Duration" + }, + "indices": { + "$ref": "#/components/schemas/_types:Indices" + }, + "indices_options": { + "$ref": "#/components/schemas/_types:IndicesOptions" + }, + "job_id": { + "$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" + }, + "query_delay": { + "$ref": "#/components/schemas/_types:Duration" + }, + "runtime_mappings": { + "$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.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types:ScriptField" + } + }, + "scroll_size": { + "description": "The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations.\nThe maximum value is the value of `index.max_result_window`, which is 10,000 by default.", + "type": "number" + }, + "headers": { + "$ref": "#/components/schemas/_types:HttpHeaders" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:AggregationContainer" + } + }, + "authorization": { + "$ref": "#/components/schemas/ml._types:DatafeedAuthorization" + }, + "chunking_config": { + "$ref": "#/components/schemas/ml._types:ChunkingConfig" + }, + "delayed_data_check_config": { + "$ref": "#/components/schemas/ml._types:DelayedDataCheckConfig" + }, + "datafeed_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "frequency": { + "$ref": "#/components/schemas/_types:Duration" + }, + "indices": { + "type": "array", + "items": { + "type": "string" + } + }, + "job_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "indices_options": { + "$ref": "#/components/schemas/_types:IndicesOptions" + }, + "max_empty_searches": { + "type": "number" + }, + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "query_delay": { + "$ref": "#/components/schemas/_types:Duration" + }, + "runtime_mappings": { + "$ref": "#/components/schemas/_types.mapping:RuntimeFields" + }, + "script_fields": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types:ScriptField" + } + }, + "scroll_size": { + "type": "number" + } + }, + "required": [ + "chunking_config", + "datafeed_id", + "indices", + "job_id", + "query", + "query_delay", + "scroll_size" + ] + } + } + } + } + }, + "x-available-since": "5.4.0" + }, + "delete": { + "tags": [ + "ml.delete_datafeed" + ], + "summary": "Delete a datafeed", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html" + }, + "operationId": "ml-delete-datafeed", + "parameters": [ + { + "in": "path", + "name": "datafeed_id", + "description": "A numerical character string that uniquely identifies the datafeed. This\nidentifier can contain lowercase alphanumeric characters (a-z and 0-9),\nhyphens, and underscores. It must start and end with alphanumeric\ncharacters.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "force", + "description": "Use to forcefully delete a started datafeed; this method is quicker than\nstopping and deleting the datafeed.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "5.4.0" + } + }, + "/_ml/filters/{filter_id}": { + "get": { + "tags": [ + "ml.get_filters" + ], + "summary": "Retrieves filters", + "description": "You can get a single filter or all filters.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html" + }, + "operationId": "ml-get-filters-1", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_filters#filter_id" + }, + { + "$ref": "#/components/parameters/ml.get_filters#from" + }, + { + "$ref": "#/components/parameters/ml.get_filters#size" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/ml.get_filters#200" + } + }, + "x-available-since": "5.5.0" + }, + "put": { + "tags": [ + "ml.put_filter" + ], + "summary": "Instantiates a filter", + "description": "A filter contains a list of strings. It can be used by one or more anomaly detection jobs.\nSpecifically, filters are referenced in the `custom_rules` property of detector configuration objects.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html" + }, + "operationId": "ml-put-filter", + "parameters": [ + { + "in": "path", + "name": "filter_id", + "description": "A string that uniquely identifies a filter.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "description": { + "description": "A description of the filter.", + "type": "string" + }, + "items": { + "description": "The items of the filter. A wildcard `*` can be used at the beginning or the end of an item.\nUp to 10000 items are allowed in each filter.", + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "filter_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "items": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "description", + "filter_id", + "items" + ] + } + } + } + } + }, + "x-available-since": "5.4.0" + }, + "delete": { + "tags": [ + "ml.delete_filter" + ], + "summary": "Delete a filter", + "description": "If an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html" + }, + "operationId": "ml-delete-filter", + "parameters": [ + { + "in": "path", + "name": "filter_id", + "description": "A string that uniquely identifies a filter.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "5.4.0" + } + }, + "/_ml/anomaly_detectors/{job_id}": { + "get": { + "tags": [ + "ml.get_jobs" + ], + "summary": "Retrieves configuration information for anomaly detection jobs", + "description": "You can get information for multiple anomaly detection jobs in a single API\nrequest by using a group name, a comma-separated list of jobs, or a wildcard\nexpression. You can get information for all anomaly detection jobs by using\n`_all`, by specifying `*` as the ``, or by omitting the ``.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html" + }, + "operationId": "ml-get-jobs", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_jobs#job_id" + }, + { + "$ref": "#/components/parameters/ml.get_jobs#allow_no_match" + }, + { + "$ref": "#/components/parameters/ml.get_jobs#exclude_generated" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/ml.get_jobs#200" + } + }, + "x-available-since": "5.5.0" + }, + "put": { + "tags": [ + "ml.put_job" + ], + "summary": "Create an anomaly detection job", + "description": "If you include a `datafeed_config`, you must have read index privileges on the source index.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html" + }, + "operationId": "ml-put-job", + "parameters": [ + { + "in": "path", + "name": "job_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.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "allow_lazy_open": { + "description": "Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available.", + "type": "boolean" + }, + "analysis_config": { + "$ref": "#/components/schemas/ml._types:AnalysisConfig" + }, + "analysis_limits": { + "$ref": "#/components/schemas/ml._types:AnalysisLimits" + }, + "background_persist_interval": { + "$ref": "#/components/schemas/_types:Duration" + }, + "custom_settings": { + "$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`.", + "type": "number" + }, + "data_description": { + "$ref": "#/components/schemas/ml._types:DataDescription" + }, + "datafeed_config": { + "$ref": "#/components/schemas/ml._types:DatafeedConfig" + }, + "description": { + "description": "A description of the job.", + "type": "string" + }, + "groups": { + "description": "A list of job groups. A job can belong to no groups or many.", + "type": "array", + "items": { + "type": "string" + } + }, + "model_plot_config": { + "$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.", + "type": "number" + }, + "renormalization_window_days": { + "description": "Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket spans.", + "type": "number" + }, + "results_index_name": { + "$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.", + "type": "number" + } + }, + "required": [ + "analysis_config", + "data_description" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "allow_lazy_open": { + "type": "boolean" + }, + "analysis_config": { + "$ref": "#/components/schemas/ml._types:AnalysisConfigRead" + }, + "analysis_limits": { + "$ref": "#/components/schemas/ml._types:AnalysisLimits" + }, + "background_persist_interval": { + "$ref": "#/components/schemas/_types:Duration" + }, + "create_time": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "custom_settings": { + "$ref": "#/components/schemas/ml._types:CustomSettings" + }, + "daily_model_snapshot_retention_after_days": { + "type": "number" + }, + "data_description": { + "$ref": "#/components/schemas/ml._types:DataDescription" + }, + "datafeed_config": { + "$ref": "#/components/schemas/ml._types:Datafeed" + }, + "description": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string" + } + }, + "job_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "job_type": { + "type": "string" + }, + "job_version": { + "type": "string" + }, + "model_plot_config": { + "$ref": "#/components/schemas/ml._types:ModelPlotConfig" + }, + "model_snapshot_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "model_snapshot_retention_days": { + "type": "number" + }, + "renormalization_window_days": { + "type": "number" + }, + "results_index_name": { + "type": "string" + }, + "results_retention_days": { + "type": "number" + } + }, + "required": [ + "allow_lazy_open", + "analysis_config", + "analysis_limits", + "create_time", + "daily_model_snapshot_retention_after_days", + "data_description", + "job_id", + "job_type", + "job_version", + "model_snapshot_retention_days", + "results_index_name" + ] + } + } + } + } + }, + "x-available-since": "5.4.0" + }, + "delete": { + "tags": [ + "ml.delete_job" + ], + "summary": "Delete an anomaly detection job", + "description": "All job configuration, model state and results are deleted.\nIt is not currently possible to delete multiple jobs using wildcards or a\ncomma separated list. If you delete a job that has a datafeed, the request\nfirst tries to delete the datafeed. This behavior is equivalent to calling\nthe delete datafeed API with the same timeout and force parameters as the\ndelete job request.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html" + }, + "operationId": "ml-delete-job", + "parameters": [ + { + "in": "path", + "name": "job_id", + "description": "Identifier for the anomaly detection job.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "force", + "description": "Use to forcefully delete an opened job; this method is quicker than\nclosing and deleting the job.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "delete_user_annotations", + "description": "Specifies whether annotations that have been added by the\nuser should be deleted along with any auto-generated annotations when the job is\nreset.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "wait_for_completion", + "description": "Specifies whether the request should return immediately or wait until the\njob deletion completes.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "5.4.0" + } + }, + "/_ml/trained_models/{model_id}": { + "get": { + "tags": [ + "ml.get_trained_models" + ], + "summary": "Retrieves configuration information for a trained model", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html" + }, + "operationId": "ml-get-trained-models", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_trained_models#model_id" + }, + { + "$ref": "#/components/parameters/ml.get_trained_models#allow_no_match" + }, + { + "$ref": "#/components/parameters/ml.get_trained_models#decompress_definition" + }, + { + "$ref": "#/components/parameters/ml.get_trained_models#exclude_generated" + }, + { + "$ref": "#/components/parameters/ml.get_trained_models#from" + }, + { + "$ref": "#/components/parameters/ml.get_trained_models#include" + }, + { + "$ref": "#/components/parameters/ml.get_trained_models#size" + }, + { + "$ref": "#/components/parameters/ml.get_trained_models#tags" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/ml.get_trained_models#200" + } + }, + "x-available-since": "7.10.0" + }, + "put": { + "tags": [ + "ml.put_trained_model" + ], + "summary": "Enables you to supply a trained model that is not created by data frame analytics", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html" + }, + "operationId": "ml-put-trained-model", + "parameters": [ + { + "in": "path", + "name": "model_id", + "description": "The unique identifier of the trained model.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "defer_definition_decompression", + "description": "If set to `true` and a `compressed_definition` is provided,\nthe request defers definition decompression and skips relevant\nvalidations.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "wait_for_completion", + "description": "Whether to wait for all child operations (e.g. model download)\nto complete.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "compressed_definition": { + "description": "The compressed (GZipped and Base64 encoded) inference definition of the\nmodel. If compressed_definition is specified, then definition cannot be\nspecified.", + "type": "string" + }, + "definition": { + "$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" + }, + "input": { + "$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" + }, + "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.", + "type": "number" + }, + "platform_architecture": { + "description": "The platform architecture (if applicable) of the trained mode. If the model\nonly works on one platform, because it is heavily optimized for a particular\nprocessor architecture and OS combination, then this field specifies which.\nThe format of the string must match the platform identifiers used by Elasticsearch,\nso one of, `linux-x86_64`, `linux-aarch64`, `darwin-x86_64`, `darwin-aarch64`,\nor `windows-x86_64`. For portable models (those that work independent of processor\narchitecture or OS features), leave this field unset.", + "type": "string" + }, + "tags": { + "description": "An array of tags to organize the model.", + "type": "array", + "items": { + "type": "string" + } + }, + "prefix_strings": { + "$ref": "#/components/schemas/ml._types:TrainedModelPrefixStrings" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ml._types:TrainedModelConfig" + } + } + } + } + }, + "x-available-since": "7.10.0" + }, + "delete": { + "tags": [ + "ml.delete_trained_model" + ], + "summary": "Delete an unreferenced trained model", + "description": "The request deletes a trained inference model that is not referenced by an ingest pipeline.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html" + }, + "operationId": "ml-delete-trained-model", + "parameters": [ + { + "in": "path", + "name": "model_id", + "description": "The unique identifier of the trained model.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "force", + "description": "Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "7.10.0" + } + }, + "/_ml/trained_models/{model_id}/model_aliases/{model_alias}": { + "put": { + "tags": [ + "ml.put_trained_model_alias" + ], + "summary": "Creates or updates a trained model alias", + "description": "A trained model alias is a logical\nname used to reference a single trained model.\nYou can use aliases instead of trained model identifiers to make it easier to\nreference your models. For example, you can use aliases in inference\naggregations and processors.\nAn alias must be unique and refer to only a single trained model. However,\nyou can have multiple aliases for each trained model.\nIf you use this API to update an alias such that it references a different\ntrained model ID and the model uses a different type of data frame analytics,\nan error occurs. For example, this situation occurs if you have a trained\nmodel for regression analysis and a trained model for classification\nanalysis; you cannot reassign an alias from one type of trained model to\nanother.\nIf you use this API to update an alias and there are very few input fields in\ncommon between the old and new trained models for the model alias, the API\nreturns a warning.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models-aliases.html" + }, + "operationId": "ml-put-trained-model-alias", + "parameters": [ + { + "in": "path", + "name": "model_id", + "description": "The identifier for the trained model that the alias refers to.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "path", + "name": "model_alias", + "description": "The alias to create or update. This value cannot end in numbers.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" + }, + { + "in": "query", + "name": "reassign", + "description": "Specifies whether the alias gets reassigned to the specified trained\nmodel if it is already assigned to a different model. If the alias is\nalready assigned and this parameter is false, the API returns an error.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "7.13.0" + }, + "delete": { + "tags": [ + "ml.delete_trained_model_alias" + ], + "summary": "Delete a trained model alias", + "description": "This API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html" + }, + "operationId": "ml-delete-trained-model-alias", + "parameters": [ + { + "in": "path", + "name": "model_id", + "description": "The trained model ID to which the model alias refers.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "path", + "name": "model_alias", + "description": "The model alias to delete.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "7.13.0" + } + }, + "/_ml/anomaly_detectors/_estimate_model_memory": { + "post": { + "tags": [ + "ml.estimate_model_memory" + ], + "summary": "Estimate job model memory usage", + "description": "Makes an estimation of the memory usage for an anomaly detection job model.\nIt is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html" + }, + "operationId": "ml-estimate-model-memory", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "analysis_config": { + "$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.", + "type": "object", + "additionalProperties": { + "type": "number" + } + }, + "overall_cardinality": { + "description": "Estimates of the cardinality that is observed for fields over the whole\ntime period that the job analyzes data. To produce a good answer, values\nmust be provided for fields referenced in the `by_field_name`,\n`over_field_name` and `partition_field_name` of any detectors. Providing\nvalues for other fields has no effect on the estimation. It can be\nomitted from the request if no detectors have a `by_field_name`,\n`over_field_name` or `partition_field_name`.", + "type": "object", + "additionalProperties": { + "type": "number" + } + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "model_memory_estimate": { + "type": "string" + } + }, + "required": [ + "model_memory_estimate" + ] + } + } + } + } + }, + "x-available-since": "7.7.0" + } + }, + "/_ml/data_frame/_evaluate": { + "post": { + "tags": [ + "ml.evaluate_data_frame" + ], + "summary": "Evaluate data frame analytics", + "description": "The API packages together commonly used evaluation metrics for various types\nof machine learning features. This has been designed for use on indexes\ncreated by data frame analytics. Evaluation requires both a ground truth\nfield and an analytics result field to be present.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html" + }, + "operationId": "ml-evaluate-data-frame", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "evaluation": { + "$ref": "#/components/schemas/ml._types:DataframeEvaluationContainer" + }, + "index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + } + }, + "required": [ + "evaluation", + "index" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "classification": { + "$ref": "#/components/schemas/ml.evaluate_data_frame:DataframeClassificationSummary" + }, + "outlier_detection": { + "$ref": "#/components/schemas/ml.evaluate_data_frame:DataframeOutlierDetectionSummary" + }, + "regression": { + "$ref": "#/components/schemas/ml.evaluate_data_frame:DataframeRegressionSummary" + } + } + } + } + } + } + }, + "x-available-since": "7.3.0" + } + }, + "/_ml/anomaly_detectors/{job_id}/_flush": { + "post": { + "tags": [ + "ml.flush_job" + ], + "summary": "Forces any buffered data to be processed by the job", + "description": "The flush jobs API is only applicable when sending data for analysis using\nthe post data API. Depending on the content of the buffer, then it might\nadditionally calculate new results. Both flush and close operations are\nsimilar, however the flush is more efficient if you are expecting to send\nmore data for analysis. When flushing, the job remains open and is available\nto continue analyzing data. A close operation additionally prunes and\npersists the model state to disk and the job must be opened again before\nanalyzing further data.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html" + }, + "operationId": "ml-flush-job", + "parameters": [ + { + "in": "path", + "name": "job_id", + "description": "Identifier for the anomaly detection job.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "advance_time", + "description": "Specifies to advance to a particular time value. Results are generated\nand the model is updated for data from the specified time interval.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "style": "form" + }, + { + "in": "query", + "name": "calc_interim", + "description": "If true, calculates the interim results for the most recent bucket or all\nbuckets within the latency period.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "end", + "description": "When used in conjunction with `calc_interim` and `start`, specifies the\nrange of buckets on which to calculate interim results.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "style": "form" + }, + { + "in": "query", + "name": "skip_time", + "description": "Specifies to skip to a particular time value. Results are not generated\nand the model is not updated for data from the specified time interval.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "style": "form" + }, + { + "in": "query", + "name": "start", + "description": "When used in conjunction with `calc_interim`, specifies the range of\nbuckets on which to calculate interim results.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "advance_time": { + "$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" + }, + "skip_time": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "start": { + "$ref": "#/components/schemas/_types:DateTime" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "flushed": { + "type": "boolean" + }, + "last_finalized_bucket_end": { + "description": "Provides the timestamp (in milliseconds since the epoch) of the end of\nthe last bucket that was processed.", + "type": "number" + } + }, + "required": [ + "flushed" + ] + } + } + } + } + }, + "x-available-since": "5.4.0" + } + }, + "/_ml/calendars/{calendar_id}/events": { + "get": { + "tags": [ + "ml.get_calendar_events" + ], + "summary": "Retrieves information about the scheduled events in calendars", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html" + }, + "operationId": "ml-get-calendar-events", + "parameters": [ + { + "in": "path", + "name": "calendar_id", + "description": "A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using `_all` or `*` or by omitting the calendar identifier.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "end", + "description": "Specifies to get events with timestamps earlier than this time.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "style": "form" + }, + { + "in": "query", + "name": "from", + "description": "Skips the specified number of events.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "job_id", + "description": "Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of `_all` or `*`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "form" + }, + { + "in": "query", + "name": "size", + "description": "Specifies the maximum number of events to obtain.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "start", + "description": "Specifies to get events with timestamps after this time.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "events": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:CalendarEvent" + } + } + }, + "required": [ + "count", + "events" + ] + } + } + } + } + }, + "x-available-since": "6.2.0" + }, + "post": { + "tags": [ + "ml.post_calendar_events" + ], + "summary": "Adds scheduled events to a calendar", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-event.html" + }, + "operationId": "ml-post-calendar-events", + "parameters": [ + { + "in": "path", + "name": "calendar_id", + "description": "A string that uniquely identifies a calendar.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "events": { + "description": "A list of one of more scheduled events. The event’s start and end times can be specified as integer milliseconds since the epoch or as a string in ISO 8601 format.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:CalendarEvent" + } + } + }, + "required": [ + "events" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "events": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:CalendarEvent" + } + } + }, + "required": [ + "events" + ] + } + } + } + } + }, + "x-available-since": "6.2.0" + } + }, + "/_ml/calendars": { + "get": { + "tags": [ + "ml.get_calendars" + ], + "summary": "Retrieves configuration information for calendars", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html" + }, + "operationId": "ml-get-calendars", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_calendars#from" + }, + { + "$ref": "#/components/parameters/ml.get_calendars#size" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/ml.get_calendars" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ml.get_calendars#200" + } + }, + "x-available-since": "6.2.0" + }, + "post": { + "tags": [ + "ml.get_calendars" + ], + "summary": "Retrieves configuration information for calendars", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html" + }, + "operationId": "ml-get-calendars-1", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_calendars#from" + }, + { + "$ref": "#/components/parameters/ml.get_calendars#size" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/ml.get_calendars" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ml.get_calendars#200" + } + }, + "x-available-since": "6.2.0" + } + }, + "/_ml/data_frame/analytics": { + "get": { + "tags": [ + "ml.get_data_frame_analytics" + ], + "summary": "Retrieves configuration information for data frame analytics jobs", + "description": "You can get information for multiple data frame analytics jobs in a single\nAPI request by using a comma-separated list of data frame analytics jobs or a\nwildcard expression.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html" + }, + "operationId": "ml-get-data-frame-analytics-1", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics#allow_no_match" + }, + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics#from" + }, + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics#size" + }, + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics#exclude_generated" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/ml.get_data_frame_analytics#200" + } + }, + "x-available-since": "7.3.0" + } + }, + "/_ml/data_frame/analytics/_stats": { + "get": { + "tags": [ + "ml.get_data_frame_analytics_stats" + ], + "summary": "Retrieves usage information for data frame analytics jobs", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html" + }, + "operationId": "ml-get-data-frame-analytics-stats", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#allow_no_match" + }, + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#from" + }, + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#size" + }, + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#verbose" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/ml.get_data_frame_analytics_stats#200" + } + }, + "x-available-since": "7.3.0" + } + }, + "/_ml/data_frame/analytics/{id}/_stats": { + "get": { + "tags": [ + "ml.get_data_frame_analytics_stats" + ], + "summary": "Retrieves usage information for data frame analytics jobs", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html" + }, + "operationId": "ml-get-data-frame-analytics-stats-1", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#id" + }, + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#allow_no_match" + }, + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#from" + }, + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#size" + }, + { + "$ref": "#/components/parameters/ml.get_data_frame_analytics_stats#verbose" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/ml.get_data_frame_analytics_stats#200" + } + }, + "x-available-since": "7.3.0" + } + }, + "/_ml/datafeeds/{datafeed_id}/_stats": { + "get": { + "tags": [ + "ml.get_datafeed_stats" + ], + "summary": "Retrieves usage information for datafeeds", + "description": "You can get statistics for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget statistics for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``. If the datafeed is stopped, the\nonly information you receive is the `datafeed_id` and the `state`.\nThis API returns a maximum of 10,000 datafeeds.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html" + }, + "operationId": "ml-get-datafeed-stats", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_datafeed_stats#datafeed_id" + }, + { + "$ref": "#/components/parameters/ml.get_datafeed_stats#allow_no_match" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/ml.get_datafeed_stats#200" + } + }, + "x-available-since": "5.5.0" + } + }, + "/_ml/datafeeds/_stats": { + "get": { + "tags": [ + "ml.get_datafeed_stats" + ], + "summary": "Retrieves usage information for datafeeds", + "description": "You can get statistics for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget statistics for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``. If the datafeed is stopped, the\nonly information you receive is the `datafeed_id` and the `state`.\nThis API returns a maximum of 10,000 datafeeds.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html" + }, + "operationId": "ml-get-datafeed-stats-1", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_datafeed_stats#allow_no_match" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/ml.get_datafeed_stats#200" + } + }, + "x-available-since": "5.5.0" + } + }, + "/_ml/datafeeds": { + "get": { + "tags": [ + "ml.get_datafeeds" + ], + "summary": "Retrieves configuration information for datafeeds", + "description": "You can get information for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget information for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``.\nThis API returns a maximum of 10,000 datafeeds.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html" + }, + "operationId": "ml-get-datafeeds-1", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_datafeeds#allow_no_match" + }, + { + "$ref": "#/components/parameters/ml.get_datafeeds#exclude_generated" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/ml.get_datafeeds#200" + } + }, + "x-available-since": "5.5.0" + } + }, + "/_ml/filters": { + "get": { + "tags": [ + "ml.get_filters" + ], + "summary": "Retrieves filters", + "description": "You can get a single filter or all filters.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html" + }, + "operationId": "ml-get-filters", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_filters#from" + }, + { + "$ref": "#/components/parameters/ml.get_filters#size" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/ml.get_filters#200" + } + }, + "x-available-since": "5.5.0" + } + }, + "/_ml/anomaly_detectors/_stats": { + "get": { + "tags": [ + "ml.get_job_stats" + ], + "summary": "Retrieves usage information for anomaly detection jobs", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html" + }, + "operationId": "ml-get-job-stats", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_job_stats#allow_no_match" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/ml.get_job_stats#200" + } + }, + "x-available-since": "5.5.0" + } + }, + "/_ml/anomaly_detectors/{job_id}/_stats": { + "get": { + "tags": [ + "ml.get_job_stats" + ], + "summary": "Retrieves usage information for anomaly detection jobs", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html" + }, + "operationId": "ml-get-job-stats-1", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_job_stats#job_id" + }, + { + "$ref": "#/components/parameters/ml.get_job_stats#allow_no_match" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/ml.get_job_stats#200" + } + }, + "x-available-since": "5.5.0" + } + }, + "/_ml/anomaly_detectors": { + "get": { + "tags": [ + "ml.get_jobs" + ], + "summary": "Retrieves configuration information for anomaly detection jobs", + "description": "You can get information for multiple anomaly detection jobs in a single API\nrequest by using a group name, a comma-separated list of jobs, or a wildcard\nexpression. You can get information for all anomaly detection jobs by using\n`_all`, by specifying `*` as the ``, or by omitting the ``.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html" + }, + "operationId": "ml-get-jobs-1", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_jobs#allow_no_match" + }, + { + "$ref": "#/components/parameters/ml.get_jobs#exclude_generated" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/ml.get_jobs#200" + } + }, + "x-available-since": "5.5.0" + } + }, + "/_ml/anomaly_detectors/{job_id}/results/overall_buckets": { + "get": { + "tags": [ + "ml.get_overall_buckets" + ], + "summary": "Retrieves overall bucket results that summarize the bucket results of\n", + "description": "multiple anomaly detection jobs.\n\nThe `overall_score` is calculated by combining the scores of all the\nbuckets within the overall bucket span. First, the maximum\n`anomaly_score` per anomaly detection job in the overall bucket is\ncalculated. Then the `top_n` of those scores are averaged to result in\nthe `overall_score`. This means that you can fine-tune the\n`overall_score` so that it is more or less sensitive to the number of\njobs that detect an anomaly at the same time. For example, if you set\n`top_n` to `1`, the `overall_score` is the maximum bucket score in the\noverall bucket. Alternatively, if you set `top_n` to the number of jobs,\nthe `overall_score` is high only when all jobs detect anomalies in that\noverall bucket. If you set the `bucket_span` parameter (to a value\ngreater than its default), the `overall_score` is the maximum\n`overall_score` of the overall buckets that have a span equal to the\njobs' largest bucket span.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html" + }, + "operationId": "ml-get-overall-buckets", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_overall_buckets#job_id" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#allow_no_match" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#bucket_span" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#end" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#exclude_interim" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#overall_score" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#start" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#top_n" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/ml.get_overall_buckets" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ml.get_overall_buckets#200" + } + }, + "x-available-since": "6.1.0" + }, + "post": { + "tags": [ + "ml.get_overall_buckets" + ], + "summary": "Retrieves overall bucket results that summarize the bucket results of\n", + "description": "multiple anomaly detection jobs.\n\nThe `overall_score` is calculated by combining the scores of all the\nbuckets within the overall bucket span. First, the maximum\n`anomaly_score` per anomaly detection job in the overall bucket is\ncalculated. Then the `top_n` of those scores are averaged to result in\nthe `overall_score`. This means that you can fine-tune the\n`overall_score` so that it is more or less sensitive to the number of\njobs that detect an anomaly at the same time. For example, if you set\n`top_n` to `1`, the `overall_score` is the maximum bucket score in the\noverall bucket. Alternatively, if you set `top_n` to the number of jobs,\nthe `overall_score` is high only when all jobs detect anomalies in that\noverall bucket. If you set the `bucket_span` parameter (to a value\ngreater than its default), the `overall_score` is the maximum\n`overall_score` of the overall buckets that have a span equal to the\njobs' largest bucket span.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html" + }, + "operationId": "ml-get-overall-buckets-1", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_overall_buckets#job_id" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#allow_no_match" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#bucket_span" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#end" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#exclude_interim" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#overall_score" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#start" + }, + { + "$ref": "#/components/parameters/ml.get_overall_buckets#top_n" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/ml.get_overall_buckets" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ml.get_overall_buckets#200" + } + }, + "x-available-since": "6.1.0" + } + }, + "/_ml/trained_models": { + "get": { + "tags": [ + "ml.get_trained_models" + ], + "summary": "Retrieves configuration information for a trained model", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html" + }, + "operationId": "ml-get-trained-models-1", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_trained_models#allow_no_match" + }, + { + "$ref": "#/components/parameters/ml.get_trained_models#decompress_definition" + }, + { + "$ref": "#/components/parameters/ml.get_trained_models#exclude_generated" + }, + { + "$ref": "#/components/parameters/ml.get_trained_models#from" + }, + { + "$ref": "#/components/parameters/ml.get_trained_models#include" + }, + { + "$ref": "#/components/parameters/ml.get_trained_models#size" + }, + { + "$ref": "#/components/parameters/ml.get_trained_models#tags" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/ml.get_trained_models#200" + } + }, + "x-available-since": "7.10.0" + } + }, + "/_ml/trained_models/{model_id}/_stats": { + "get": { + "tags": [ + "ml.get_trained_models_stats" + ], + "summary": "Retrieves usage information for trained models", + "description": "You can get usage information for multiple trained\nmodels in a single API request by using a comma-separated list of model IDs or a wildcard expression.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html" + }, + "operationId": "ml-get-trained-models-stats", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_trained_models_stats#model_id" + }, + { + "$ref": "#/components/parameters/ml.get_trained_models_stats#allow_no_match" + }, + { + "$ref": "#/components/parameters/ml.get_trained_models_stats#from" + }, + { + "$ref": "#/components/parameters/ml.get_trained_models_stats#size" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/ml.get_trained_models_stats#200" + } + }, + "x-available-since": "7.10.0" + } + }, + "/_ml/trained_models/_stats": { + "get": { + "tags": [ + "ml.get_trained_models_stats" + ], + "summary": "Retrieves usage information for trained models", + "description": "You can get usage information for multiple trained\nmodels in a single API request by using a comma-separated list of model IDs or a wildcard expression.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html" + }, + "operationId": "ml-get-trained-models-stats-1", + "parameters": [ + { + "$ref": "#/components/parameters/ml.get_trained_models_stats#allow_no_match" + }, + { + "$ref": "#/components/parameters/ml.get_trained_models_stats#from" + }, + { + "$ref": "#/components/parameters/ml.get_trained_models_stats#size" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/ml.get_trained_models_stats#200" + } + }, + "x-available-since": "7.10.0" + } + }, + "/_ml/trained_models/{model_id}/_infer": { + "post": { + "tags": [ + "ml.infer_trained_model" + ], + "summary": "Evaluates a trained model", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/infer-trained-model.html" + }, + "operationId": "ml-infer-trained-model", + "parameters": [ + { + "$ref": "#/components/parameters/ml.infer_trained_model#model_id" + }, + { + "$ref": "#/components/parameters/ml.infer_trained_model#timeout" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/ml.infer_trained_model" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ml.infer_trained_model#200" + } + }, + "x-available-since": "8.3.0" + } + }, + "/_ml/trained_models/{model_id}/deployment/_infer": { + "post": { + "tags": [ + "ml.infer_trained_model" + ], + "summary": "Evaluates a trained model", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/infer-trained-model.html" + }, + "operationId": "ml-infer-trained-model-1", + "parameters": [ + { + "$ref": "#/components/parameters/ml.infer_trained_model#model_id" + }, + { + "$ref": "#/components/parameters/ml.infer_trained_model#timeout" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/ml.infer_trained_model" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ml.infer_trained_model#200" + } + }, + "x-available-since": "8.3.0" + } + }, + "/_ml/anomaly_detectors/{job_id}/_open": { + "post": { + "tags": [ + "ml.open_job" + ], + "summary": "Open anomaly detection jobs", + "description": "An anomaly detection job must be opened in order for it to be ready to\nreceive and analyze data. It can be opened and closed multiple times\nthroughout its lifecycle.\nWhen you open a new job, it starts with an empty model.\nWhen you open an existing job, the most recent model state is automatically\nloaded. The job is ready to resume its analysis from where it left off, once\nnew data is received.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html" + }, + "operationId": "ml-open-job", + "parameters": [ + { + "in": "path", + "name": "job_id", + "description": "Identifier for the anomaly detection job.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "timeout", + "description": "Controls the time to wait until a job has opened.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "timeout": { + "$ref": "#/components/schemas/_types:Duration" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "opened": { + "type": "boolean" + }, + "node": { + "$ref": "#/components/schemas/_types:NodeId" + } + }, + "required": [ + "opened", + "node" + ] + } + } + } + } + }, + "x-available-since": "5.4.0" + } + }, + "/_ml/data_frame/analytics/_preview": { + "get": { + "tags": [ + "ml.preview_data_frame_analytics" + ], + "summary": "Previews the extracted features used by a data frame analytics config", + "externalDocs": { + "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html" + }, + "operationId": "ml-preview-data-frame-analytics", + "requestBody": { + "$ref": "#/components/requestBodies/ml.preview_data_frame_analytics" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ml.preview_data_frame_analytics#200" + } + }, + "x-available-since": "7.13.0" + }, + "post": { + "tags": [ + "ml.preview_data_frame_analytics" + ], + "summary": "Previews the extracted features used by a data frame analytics config", + "externalDocs": { + "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html" + }, + "operationId": "ml-preview-data-frame-analytics-1", + "requestBody": { + "$ref": "#/components/requestBodies/ml.preview_data_frame_analytics" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ml.preview_data_frame_analytics#200" + } + }, + "x-available-since": "7.13.0" + } + }, + "/_ml/data_frame/analytics/{id}/_preview": { + "get": { + "tags": [ + "ml.preview_data_frame_analytics" + ], + "summary": "Previews the extracted features used by a data frame analytics config", + "externalDocs": { + "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html" + }, + "operationId": "ml-preview-data-frame-analytics-2", + "parameters": [ + { + "$ref": "#/components/parameters/ml.preview_data_frame_analytics#id" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/ml.preview_data_frame_analytics" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ml.preview_data_frame_analytics#200" + } + }, + "x-available-since": "7.13.0" + }, + "post": { + "tags": [ + "ml.preview_data_frame_analytics" + ], + "summary": "Previews the extracted features used by a data frame analytics config", + "externalDocs": { + "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html" + }, + "operationId": "ml-preview-data-frame-analytics-3", + "parameters": [ + { + "$ref": "#/components/parameters/ml.preview_data_frame_analytics#id" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/ml.preview_data_frame_analytics" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ml.preview_data_frame_analytics#200" + } + }, + "x-available-since": "7.13.0" + } + }, + "/_ml/datafeeds/{datafeed_id}/_preview": { + "get": { + "tags": [ + "ml.preview_datafeed" + ], + "summary": "Previews a datafeed", + "description": "This API returns the first \"page\" of search results from a datafeed.\nYou can preview an existing datafeed or provide configuration details for a datafeed\nand anomaly detection job in the API. The preview shows the structure of the data\nthat will be passed to the anomaly detection engine.\nIMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that\ncalled the API. However, when the datafeed starts it uses the roles of the last user that created or updated the\ndatafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials.\nYou can also use secondary authorization headers to supply the credentials.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" + }, + "operationId": "ml-preview-datafeed", + "parameters": [ + { + "$ref": "#/components/parameters/ml.preview_datafeed#datafeed_id" + }, + { + "$ref": "#/components/parameters/ml.preview_datafeed#start" + }, + { + "$ref": "#/components/parameters/ml.preview_datafeed#end" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/ml.preview_datafeed" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ml.preview_datafeed#200" + } + }, + "x-available-since": "5.4.0" + }, + "post": { + "tags": [ + "ml.preview_datafeed" + ], + "summary": "Previews a datafeed", + "description": "This API returns the first \"page\" of search results from a datafeed.\nYou can preview an existing datafeed or provide configuration details for a datafeed\nand anomaly detection job in the API. The preview shows the structure of the data\nthat will be passed to the anomaly detection engine.\nIMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that\ncalled the API. However, when the datafeed starts it uses the roles of the last user that created or updated the\ndatafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials.\nYou can also use secondary authorization headers to supply the credentials.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" + }, + "operationId": "ml-preview-datafeed-1", + "parameters": [ + { + "$ref": "#/components/parameters/ml.preview_datafeed#datafeed_id" + }, + { + "$ref": "#/components/parameters/ml.preview_datafeed#start" + }, + { + "$ref": "#/components/parameters/ml.preview_datafeed#end" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/ml.preview_datafeed" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ml.preview_datafeed#200" + } + }, + "x-available-since": "5.4.0" + } + }, + "/_ml/datafeeds/_preview": { + "get": { + "tags": [ + "ml.preview_datafeed" + ], + "summary": "Previews a datafeed", + "description": "This API returns the first \"page\" of search results from a datafeed.\nYou can preview an existing datafeed or provide configuration details for a datafeed\nand anomaly detection job in the API. The preview shows the structure of the data\nthat will be passed to the anomaly detection engine.\nIMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that\ncalled the API. However, when the datafeed starts it uses the roles of the last user that created or updated the\ndatafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials.\nYou can also use secondary authorization headers to supply the credentials.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" + }, + "operationId": "ml-preview-datafeed-2", + "parameters": [ + { + "$ref": "#/components/parameters/ml.preview_datafeed#start" + }, + { + "$ref": "#/components/parameters/ml.preview_datafeed#end" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/ml.preview_datafeed" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ml.preview_datafeed#200" + } + }, + "x-available-since": "5.4.0" + }, + "post": { + "tags": [ + "ml.preview_datafeed" + ], + "summary": "Previews a datafeed", + "description": "This API returns the first \"page\" of search results from a datafeed.\nYou can preview an existing datafeed or provide configuration details for a datafeed\nand anomaly detection job in the API. The preview shows the structure of the data\nthat will be passed to the anomaly detection engine.\nIMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that\ncalled the API. However, when the datafeed starts it uses the roles of the last user that created or updated the\ndatafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials.\nYou can also use secondary authorization headers to supply the credentials.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" + }, + "operationId": "ml-preview-datafeed-3", + "parameters": [ + { + "$ref": "#/components/parameters/ml.preview_datafeed#start" + }, + { + "$ref": "#/components/parameters/ml.preview_datafeed#end" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/ml.preview_datafeed" + }, + "responses": { + "200": { + "$ref": "#/components/responses/ml.preview_datafeed#200" + } + }, + "x-available-since": "5.4.0" + } + }, + "/_ml/trained_models/{model_id}/definition/{part}": { + "put": { + "tags": [ + "ml.put_trained_model_definition_part" + ], + "summary": "Creates part of a trained model definition", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-definition-part.html" + }, + "operationId": "ml-put-trained-model-definition-part", + "parameters": [ + { + "in": "path", + "name": "model_id", + "description": "The unique identifier of the trained model.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "path", + "name": "part", + "description": "The definition part number. When the definition is loaded for inference the definition parts are streamed in the\norder of their part number. The first part must be `0` and the final part must be `total_parts - 1`.", + "required": true, + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "definition": { + "description": "The definition part for the model. Must be a base64 encoded string.", + "type": "string" + }, + "total_definition_length": { + "description": "The total uncompressed definition length in bytes. Not base64 encoded.", + "type": "number" + }, + "total_parts": { + "description": "The total number of parts that will be uploaded. Must be greater than 0.", + "type": "number" + } + }, + "required": [ + "definition", + "total_definition_length", + "total_parts" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "8.0.0" + } + }, + "/_ml/trained_models/{model_id}/vocabulary": { + "put": { + "tags": [ + "ml.put_trained_model_vocabulary" + ], + "summary": "Creates a trained model vocabulary", + "description": "This API is supported only for natural language processing (NLP) models.\nThe vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-vocabulary.html" + }, + "operationId": "ml-put-trained-model-vocabulary", + "parameters": [ + { + "in": "path", + "name": "model_id", + "description": "The unique identifier of the trained model.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "vocabulary": { + "description": "The model vocabulary, which must not be empty.", + "type": "array", + "items": { + "type": "string" + } + }, + "merges": { + "description": "The optional model merges if required by the tokenizer.", + "x-available-since": "8.2.0", + "type": "array", + "items": { + "type": "string" + } + }, + "scores": { + "description": "The optional vocabulary value scores if required by the tokenizer.", + "x-available-since": "8.9.0", + "type": "array", + "items": { + "type": "number" + } + } + }, + "required": [ + "vocabulary" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "8.0.0" + } + }, + "/_ml/anomaly_detectors/{job_id}/_reset": { + "post": { + "tags": [ + "ml.reset_job" + ], + "summary": "Resets an anomaly detection job", + "description": "All model state and results are deleted. The job is ready to start over as if\nit had just been created.\nIt is not currently possible to reset multiple jobs using wildcards or a\ncomma separated list.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html" + }, + "operationId": "ml-reset-job", + "parameters": [ + { + "in": "path", + "name": "job_id", + "description": "The ID of the job to reset.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "wait_for_completion", + "description": "Should this request wait until the operation has completed before\nreturning.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "delete_user_annotations", + "description": "Specifies whether annotations that have been added by the\nuser should be deleted along with any auto-generated annotations when the job is\nreset.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "7.14.0" + } + }, + "/_ml/data_frame/analytics/{id}/_start": { + "post": { + "tags": [ + "ml.start_data_frame_analytics" + ], + "summary": "Starts a data frame analytics job", + "description": "A data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.\nIf the destination index does not exist, it is created automatically the\nfirst time you start the data frame analytics job. The\n`index.number_of_shards` and `index.number_of_replicas` settings for the\ndestination index are copied from the source index. If there are multiple\nsource indices, the destination index copies the highest setting values. The\nmappings for the destination index are also copied from the source indices.\nIf there are any mapping conflicts, the job fails to start.\nIf the destination index exists, it is used as is. You can therefore set up\nthe destination index in advance with custom settings and mappings.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html" + }, + "operationId": "ml-start-data-frame-analytics", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Identifier for the data frame analytics job. This identifier can contain\nlowercase alphanumeric characters (a-z and 0-9), hyphens, and\nunderscores. It must start and end with alphanumeric characters.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "timeout", + "description": "Controls the amount of time to wait until the data frame analytics job\nstarts.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "acknowledged": { + "type": "boolean" + }, + "node": { + "$ref": "#/components/schemas/_types:NodeId" + } + }, + "required": [ + "acknowledged", + "node" + ] + } + } + } + } + }, + "x-available-since": "7.3.0" + } + }, + "/_ml/datafeeds/{datafeed_id}/_start": { + "post": { + "tags": [ + "ml.start_datafeed" + ], + "summary": "Starts one or more datafeeds", + "description": "A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.\n\nBefore you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.\n\nIf you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.\nIf new data was indexed for that exact millisecond between stopping and starting, it will be ignored.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or\nupdate it had at the time of creation or update and runs the query using those same roles. If you provided secondary\nauthorization headers when you created or updated the datafeed, those credentials are used instead.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html" + }, + "operationId": "ml-start-datafeed", + "parameters": [ + { + "in": "path", + "name": "datafeed_id", + "description": "A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase\nalphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric\ncharacters.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "end", + "description": "The time that the datafeed should end, which can be specified by using one of the following formats:\n\n* ISO 8601 format with milliseconds, for example `2017-01-22T06:00:00.000Z`\n* ISO 8601 format without milliseconds, for example `2017-01-22T06:00:00+00:00`\n* Milliseconds since the epoch, for example `1485061200000`\n\nDate-time arguments using either of the ISO 8601 formats must have a time zone designator, where `Z` is accepted\nas an abbreviation for UTC time. When a URL is expected (for example, in browsers), the `+` used in time zone\ndesignators must be encoded as `%2B`.\nThe end time value is exclusive. If you do not specify an end time, the datafeed\nruns continuously.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "style": "form" + }, + { + "in": "query", + "name": "start", + "description": "The time that the datafeed should begin, which can be specified by using the same formats as the `end` parameter.\nThis value is inclusive.\nIf you do not specify a start time and the datafeed is associated with a new anomaly detection job, the analysis\nstarts from the earliest time for which data is available.\nIf you restart a stopped datafeed and specify a start value that is earlier than the timestamp of the latest\nprocessed record, the datafeed continues from 1 millisecond after the timestamp of the latest processed record.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Specifies the amount of time to wait until a datafeed starts.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "end": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "start": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "timeout": { + "$ref": "#/components/schemas/_types:Duration" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "node": { + "$ref": "#/components/schemas/_types:NodeIds" + }, + "started": { + "description": "For a successful response, this value is always `true`. On failure, an exception is returned instead.", + "type": "boolean" + } + }, + "required": [ + "node", + "started" + ] + } + } + } + } + }, + "x-available-since": "5.5.0" + } + }, + "/_ml/trained_models/{model_id}/deployment/_start": { + "post": { + "tags": [ + "ml.start_trained_model_deployment" + ], + "summary": "Starts a trained model deployment, which allocates the model to every machine learning node", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trained-model-deployment.html" + }, + "operationId": "ml-start-trained-model-deployment", + "parameters": [ + { + "in": "path", + "name": "model_id", + "description": "The unique identifier of the trained model. Currently, only PyTorch models are supported.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "cache_size", + "description": "The inference cache size (in memory outside the JVM heap) per node for the model.\nThe default value is the same size as the `model_size_bytes`. To disable the cache,\n`0b` can be provided.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "style": "form" + }, + { + "in": "query", + "name": "number_of_allocations", + "description": "The number of model allocations on each node where the model is deployed.\nAll allocations on a node share the same copy of the model in memory but use\na separate set of threads to evaluate the model.\nIncreasing this value generally increases the throughput.\nIf this setting is greater than the number of hardware threads\nit will automatically be changed to a value less than the number of hardware threads.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "priority", + "description": "The deployment priority.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ml._types:TrainingPriority" + }, + "style": "form" + }, + { + "in": "query", + "name": "queue_capacity", + "description": "Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds\nthis value, new requests are rejected with a 429 error.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "threads_per_allocation", + "description": "Sets the number of threads used by each model allocation during inference. This generally increases\nthe inference speed. The inference process is a compute-bound process; any number\ngreater than the number of available hardware threads on the machine does not increase the\ninference speed. If this setting is greater than the number of hardware threads\nit will automatically be changed to a value less than the number of hardware threads.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Specifies the amount of time to wait for the model to deploy.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "wait_for", + "description": "Specifies the allocation status to wait for before returning.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ml._types:DeploymentAllocationState" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "assignment": { + "$ref": "#/components/schemas/ml._types:TrainedModelAssignment" + } + }, + "required": [ + "assignment" + ] + } + } + } + } + }, + "x-available-since": "8.0.0" + } + }, + "/_ml/data_frame/analytics/{id}/_stop": { + "post": { + "tags": [ + "ml.stop_data_frame_analytics" + ], + "summary": "Stops one or more data frame analytics jobs", + "description": "A data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html" + }, + "operationId": "ml-stop-data-frame-analytics", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Identifier for the data frame analytics job. This identifier can contain\nlowercase alphanumeric characters (a-z and 0-9), hyphens, and\nunderscores. It must start and end with alphanumeric characters.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "allow_no_match", + "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no data frame analytics\njobs that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value is true, which returns an empty data_frame_analytics\narray when there are no matches and the subset of results when there are\npartial matches. If this parameter is false, the request returns a 404\nstatus code when there are no matches or only partial matches.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "force", + "description": "If true, the data frame analytics job is stopped forcefully.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Controls the amount of time to wait until the data frame analytics job\nstops. Defaults to 20 seconds.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "stopped": { + "type": "boolean" + } + }, + "required": [ + "stopped" + ] + } + } + } + } + }, + "x-available-since": "7.3.0" + } + }, + "/_ml/datafeeds/{datafeed_id}/_stop": { + "post": { + "tags": [ + "ml.stop_datafeed" + ], + "summary": "Stops one or more datafeeds", + "description": "A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html" + }, + "operationId": "ml-stop-datafeed", + "parameters": [ + { + "in": "path", + "name": "datafeed_id", + "description": "Identifier for the datafeed. You can stop multiple datafeeds in a single API request by using a comma-separated\nlist of datafeeds or a wildcard expression. You can close all datafeeds by using `_all` or by specifying `*` as\nthe identifier.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "allow_no_match", + "description": "Specifies what to do when the request:\n\n* Contains wildcard expressions and there are no datafeeds that match.\n* Contains the `_all` string or no identifiers and there are no matches.\n* Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when\nthere are partial matches. If `false`, the API returns a 404 status code when there are no matches or only\npartial matches.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "force", + "description": "If `true`, the datafeed is stopped forcefully.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Specifies the amount of time to wait until a datafeed stops.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "allow_no_match": { + "description": "Refer to the description for the `allow_no_match` query parameter.", + "type": "boolean" + }, + "force": { + "description": "Refer to the description for the `force` query parameter.", + "type": "boolean" + }, + "timeout": { + "$ref": "#/components/schemas/_types:Duration" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "stopped": { + "type": "boolean" + } + }, + "required": [ + "stopped" + ] + } + } + } + } + }, + "x-available-since": "5.4.0" + } + }, + "/_ml/trained_models/{model_id}/deployment/_stop": { + "post": { + "tags": [ + "ml.stop_trained_model_deployment" + ], + "summary": "Stops a trained model deployment", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/stop-trained-model-deployment.html" + }, + "operationId": "ml-stop-trained-model-deployment", + "parameters": [ + { + "in": "path", + "name": "model_id", + "description": "The unique identifier of the trained model.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "allow_no_match", + "description": "Specifies what to do when the request: contains wildcard expressions and there are no deployments that match;\ncontains the `_all` string or no identifiers and there are no matches; or contains wildcard expressions and\nthere are only partial matches. By default, it returns an empty array when there are no matches and the subset of results when there are partial matches.\nIf `false`, the request returns a 404 status code when there are no matches or only partial matches.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "force", + "description": "Forcefully stops the deployment, even if it is used by ingest pipelines. You can't use these pipelines until you\nrestart the model deployment.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "stopped": { + "type": "boolean" + } + }, + "required": [ + "stopped" + ] + } + } + } + } + }, + "x-available-since": "8.0.0" + } + }, + "/_ml/data_frame/analytics/{id}/_update": { + "post": { + "tags": [ + "ml.update_data_frame_analytics" + ], + "summary": "Updates an existing data frame analytics job", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-dfanalytics.html" + }, + "operationId": "ml-update-data-frame-analytics", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Identifier for the data frame analytics job. This identifier can contain\nlowercase alphanumeric characters (a-z and 0-9), hyphens, and\nunderscores. It must start and end with alphanumeric characters.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "description": { + "description": "A description of the job.", + "type": "string" + }, + "model_memory_limit": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html" + }, + "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.", + "type": "string" + }, + "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.", + "type": "number" + }, + "allow_lazy_start": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html" + }, + "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node.", + "type": "boolean" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "authorization": { + "$ref": "#/components/schemas/ml._types:DataframeAnalyticsAuthorization" + }, + "allow_lazy_start": { + "type": "boolean" + }, + "analysis": { + "$ref": "#/components/schemas/ml._types:DataframeAnalysisContainer" + }, + "analyzed_fields": { + "$ref": "#/components/schemas/ml._types:DataframeAnalysisAnalyzedFields" + }, + "create_time": { + "type": "number" + }, + "description": { + "type": "string" + }, + "dest": { + "$ref": "#/components/schemas/ml._types:DataframeAnalyticsDestination" + }, + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "max_num_threads": { + "type": "number" + }, + "model_memory_limit": { + "type": "string" + }, + "source": { + "$ref": "#/components/schemas/ml._types:DataframeAnalyticsSource" + }, + "version": { + "$ref": "#/components/schemas/_types:VersionString" + } + }, + "required": [ + "allow_lazy_start", + "analysis", + "create_time", + "dest", + "id", + "max_num_threads", + "model_memory_limit", + "source", + "version" + ] + } + } + } + } + }, + "x-available-since": "7.3.0" + } + }, + "/_ml/datafeeds/{datafeed_id}/_update": { + "post": { + "tags": [ + "ml.update_datafeed" + ], + "summary": "Updates the properties of a datafeed", + "description": "You must stop and start the datafeed for the changes to be applied.\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at\nthe time of the update and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html" + }, + "operationId": "ml-update-datafeed", + "parameters": [ + { + "in": "path", + "name": "datafeed_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.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "allow_no_indices", + "description": "If `true`, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the\n`_all` string or when no indices are specified.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "expand_wildcards", + "description": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines\nwhether wildcard expressions match hidden data streams. Supports comma-separated values. Valid values are:\n\n* `all`: Match any data stream or index, including hidden ones.\n* `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n* `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or both.\n* `none`: Wildcard patterns are not accepted.\n* `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + { + "in": "query", + "name": "ignore_throttled", + "description": "If `true`, concrete, expanded or aliased indices are ignored when frozen.", + "deprecated": true, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "ignore_unavailable", + "description": "If `true`, unavailable indices (missing or closed) are ignored.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "description": "If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only\nwith low cardinality data.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:AggregationContainer" + } + }, + "chunking_config": { + "$ref": "#/components/schemas/ml._types:ChunkingConfig" + }, + "delayed_data_check_config": { + "$ref": "#/components/schemas/ml._types:DelayedDataCheckConfig" + }, + "frequency": { + "$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.", + "type": "array", + "items": { + "type": "string" + } + }, + "indices_options": { + "$ref": "#/components/schemas/_types:IndicesOptions" + }, + "job_id": { + "$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" + }, + "query_delay": { + "$ref": "#/components/schemas/_types:Duration" + }, + "runtime_mappings": { + "$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.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types:ScriptField" + } + }, + "scroll_size": { + "description": "The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations.\nThe maximum value is the value of `index.max_result_window`.", + "type": "number" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "authorization": { + "$ref": "#/components/schemas/ml._types:DatafeedAuthorization" + }, + "aggregations": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:AggregationContainer" + } + }, + "chunking_config": { + "$ref": "#/components/schemas/ml._types:ChunkingConfig" + }, + "delayed_data_check_config": { + "$ref": "#/components/schemas/ml._types:DelayedDataCheckConfig" + }, + "datafeed_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "frequency": { + "$ref": "#/components/schemas/_types:Duration" + }, + "indices": { + "type": "array", + "items": { + "type": "string" + } + }, + "indices_options": { + "$ref": "#/components/schemas/_types:IndicesOptions" + }, + "job_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "max_empty_searches": { + "type": "number" + }, + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "query_delay": { + "$ref": "#/components/schemas/_types:Duration" + }, + "runtime_mappings": { + "$ref": "#/components/schemas/_types.mapping:RuntimeFields" + }, + "script_fields": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types:ScriptField" + } + }, + "scroll_size": { + "type": "number" + } + }, + "required": [ + "chunking_config", + "datafeed_id", + "indices", + "job_id", + "query", + "query_delay", + "scroll_size" + ] + } + } + } + } + }, + "x-available-since": "6.4.0" + } + }, + "/_ml/filters/{filter_id}/_update": { + "post": { + "tags": [ + "ml.update_filter" + ], + "summary": "Updates the description of a filter, adds items, or removes items from the list", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html" + }, + "operationId": "ml-update-filter", + "parameters": [ + { + "in": "path", + "name": "filter_id", + "description": "A string that uniquely identifies a filter.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "add_items": { + "description": "The items to add to the filter.", + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "description": "A description for the filter.", + "type": "string" + }, + "remove_items": { + "description": "The items to remove from the filter.", + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "filter_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "items": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "description", + "filter_id", + "items" + ] + } + } + } + } + }, + "x-available-since": "6.4.0" + } + }, + "/_ml/anomaly_detectors/{job_id}/_update": { + "post": { + "tags": [ + "ml.update_job" + ], + "summary": "Updates certain properties of an anomaly detection job", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html" + }, + "operationId": "ml-update-job", + "parameters": [ + { + "in": "path", + "name": "job_id", + "description": "Identifier for the job.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "allow_lazy_open": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html" + }, + "description": "Advanced configuration option. Specifies whether this job can open when\nthere is insufficient machine learning node capacity for it to be\nimmediately assigned to a node. If `false` and a machine learning node\nwith capacity to run the job cannot immediately be found, the open\nanomaly detection jobs API returns an error. However, this is also\nsubject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this\noption is set to `true`, the open anomaly detection jobs API does not\nreturn an error and the job waits in the opening state until sufficient\nmachine learning node capacity is available.", + "type": "boolean" + }, + "analysis_limits": { + "$ref": "#/components/schemas/ml._types:AnalysisMemoryLimit" + }, + "background_persist_interval": { + "$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.", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "categorization_filters": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "description": "A description of the job.", + "type": "string" + }, + "model_plot_config": { + "$ref": "#/components/schemas/ml._types:ModelPlotConfig" + }, + "model_prune_window": { + "$ref": "#/components/schemas/_types:Duration" + }, + "daily_model_snapshot_retention_after_days": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/machine-learning/current/ml-ad-run-jobs.html#ml-ad-model-snapshots" + }, + "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`.", + "type": "number" + }, + "model_snapshot_retention_days": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/machine-learning/current/ml-ad-run-jobs.html#ml-ad-model-snapshots" + }, + "description": "Advanced configuration option, which affects the automatic removal of old\nmodel snapshots for this job. It specifies the maximum period of time (in\ndays) that snapshots are retained. This period is relative to the\ntimestamp of the most recent snapshot for this job.", + "type": "number" + }, + "renormalization_window_days": { + "description": "Advanced configuration option. The period over which adjustments to the\nscore are applied, as new data is seen.", + "type": "number" + }, + "results_retention_days": { + "description": "Advanced configuration option. The period of time (in days) that results\nare retained. Age is calculated relative to the timestamp of the latest\nbucket result. If this property has a non-null value, once per day at\n00:30 (server time), results that are the specified number of days older\nthan the latest bucket result are deleted from Elasticsearch. The default\nvalue is null, which means all results are retained.", + "type": "number" + }, + "groups": { + "description": "A list of job groups. A job can belong to no groups or many.", + "type": "array", + "items": { + "type": "string" + } + }, + "detectors": { + "description": "An array of detector update objects.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:Detector" + } + }, + "per_partition_categorization": { + "$ref": "#/components/schemas/ml._types:PerPartitionCategorization" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "allow_lazy_open": { + "type": "boolean" + }, + "analysis_config": { + "$ref": "#/components/schemas/ml._types:AnalysisConfigRead" + }, + "analysis_limits": { + "$ref": "#/components/schemas/ml._types:AnalysisLimits" + }, + "background_persist_interval": { + "$ref": "#/components/schemas/_types:Duration" + }, + "create_time": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "finished_time": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "custom_settings": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "daily_model_snapshot_retention_after_days": { + "type": "number" + }, + "data_description": { + "$ref": "#/components/schemas/ml._types:DataDescription" + }, + "datafeed_config": { + "$ref": "#/components/schemas/ml._types:Datafeed" + }, + "description": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string" + } + }, + "job_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "job_type": { + "type": "string" + }, + "job_version": { + "$ref": "#/components/schemas/_types:VersionString" + }, + "model_plot_config": { + "$ref": "#/components/schemas/ml._types:ModelPlotConfig" + }, + "model_snapshot_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "model_snapshot_retention_days": { + "type": "number" + }, + "renormalization_window_days": { + "type": "number" + }, + "results_index_name": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "results_retention_days": { + "type": "number" + } + }, + "required": [ + "allow_lazy_open", + "analysis_config", + "analysis_limits", + "create_time", + "daily_model_snapshot_retention_after_days", + "data_description", + "job_id", + "job_type", + "job_version", + "model_snapshot_retention_days", + "results_index_name" + ] + } + } + } + } + }, + "x-available-since": "5.5.0" + } + }, + "/_ml/trained_models/{model_id}/deployment/_update": { + "post": { + "tags": [ + "ml.update_trained_model_deployment" + ], + "summary": "Starts a trained model deployment, which allocates the model to every machine learning node", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-trained-model-deployment.html" + }, + "operationId": "ml-update-trained-model-deployment", + "parameters": [ + { + "in": "path", + "name": "model_id", + "description": "The unique identifier of the trained model. Currently, only PyTorch models are supported.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "number_of_allocations", + "description": "The number of model allocations on each node where the model is deployed.\nAll allocations on a node share the same copy of the model in memory but use\na separate set of threads to evaluate the model.\nIncreasing this value generally increases the throughput.\nIf this setting is greater than the number of hardware threads\nit will automatically be changed to a value less than the number of hardware threads.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "number_of_allocations": { + "description": "The number of model allocations on each node where the model is deployed.\nAll allocations on a node share the same copy of the model in memory but use\na separate set of threads to evaluate the model.\nIncreasing this value generally increases the throughput.\nIf this setting is greater than the number of hardware threads\nit will automatically be changed to a value less than the number of hardware threads.", + "type": "number" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "assignment": { + "$ref": "#/components/schemas/ml._types:TrainedModelAssignment" + } + }, + "required": [ + "assignment" + ] + } + } + } + } + }, + "x-beta": true, + "x-available-since": "8.6.0" + } + }, + "/_msearch": { + "get": { + "tags": [ + "msearch" + ], + "summary": "Allows to execute several search operations in one request", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html" + }, + "operationId": "msearch", + "parameters": [ + { + "$ref": "#/components/parameters/msearch#allow_no_indices" + }, + { + "$ref": "#/components/parameters/msearch#ccs_minimize_roundtrips" + }, + { + "$ref": "#/components/parameters/msearch#expand_wildcards" + }, + { + "$ref": "#/components/parameters/msearch#ignore_throttled" + }, + { + "$ref": "#/components/parameters/msearch#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/msearch#max_concurrent_searches" + }, + { + "$ref": "#/components/parameters/msearch#max_concurrent_shard_requests" + }, + { + "$ref": "#/components/parameters/msearch#pre_filter_shard_size" + }, + { + "$ref": "#/components/parameters/msearch#rest_total_hits_as_int" + }, + { + "$ref": "#/components/parameters/msearch#routing" + }, + { + "$ref": "#/components/parameters/msearch#search_type" + }, + { + "$ref": "#/components/parameters/msearch#typed_keys" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/msearch" + }, + "responses": { + "200": { + "$ref": "#/components/responses/msearch#200" + } + }, + "x-available-since": "1.3.0" + }, + "post": { + "tags": [ + "msearch" + ], + "summary": "Allows to execute several search operations in one request", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html" + }, + "operationId": "msearch-1", + "parameters": [ + { + "$ref": "#/components/parameters/msearch#allow_no_indices" + }, + { + "$ref": "#/components/parameters/msearch#ccs_minimize_roundtrips" + }, + { + "$ref": "#/components/parameters/msearch#expand_wildcards" + }, + { + "$ref": "#/components/parameters/msearch#ignore_throttled" + }, + { + "$ref": "#/components/parameters/msearch#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/msearch#max_concurrent_searches" + }, + { + "$ref": "#/components/parameters/msearch#max_concurrent_shard_requests" + }, + { + "$ref": "#/components/parameters/msearch#pre_filter_shard_size" + }, + { + "$ref": "#/components/parameters/msearch#rest_total_hits_as_int" + }, + { + "$ref": "#/components/parameters/msearch#routing" + }, + { + "$ref": "#/components/parameters/msearch#search_type" + }, + { + "$ref": "#/components/parameters/msearch#typed_keys" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/msearch" + }, + "responses": { + "200": { + "$ref": "#/components/responses/msearch#200" + } + }, + "x-available-since": "1.3.0" + } + }, + "/{index}/_msearch": { + "get": { + "tags": [ + "msearch" + ], + "summary": "Allows to execute several search operations in one request", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html" + }, + "operationId": "msearch-2", + "parameters": [ + { + "$ref": "#/components/parameters/msearch#index" + }, + { + "$ref": "#/components/parameters/msearch#allow_no_indices" + }, + { + "$ref": "#/components/parameters/msearch#ccs_minimize_roundtrips" + }, + { + "$ref": "#/components/parameters/msearch#expand_wildcards" + }, + { + "$ref": "#/components/parameters/msearch#ignore_throttled" + }, + { + "$ref": "#/components/parameters/msearch#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/msearch#max_concurrent_searches" + }, + { + "$ref": "#/components/parameters/msearch#max_concurrent_shard_requests" + }, + { + "$ref": "#/components/parameters/msearch#pre_filter_shard_size" + }, + { + "$ref": "#/components/parameters/msearch#rest_total_hits_as_int" + }, + { + "$ref": "#/components/parameters/msearch#routing" + }, + { + "$ref": "#/components/parameters/msearch#search_type" + }, + { + "$ref": "#/components/parameters/msearch#typed_keys" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/msearch" + }, + "responses": { + "200": { + "$ref": "#/components/responses/msearch#200" + } + }, + "x-available-since": "1.3.0" + }, + "post": { + "tags": [ + "msearch" + ], + "summary": "Allows to execute several search operations in one request", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html" + }, + "operationId": "msearch-3", + "parameters": [ + { + "$ref": "#/components/parameters/msearch#index" + }, + { + "$ref": "#/components/parameters/msearch#allow_no_indices" + }, + { + "$ref": "#/components/parameters/msearch#ccs_minimize_roundtrips" + }, + { + "$ref": "#/components/parameters/msearch#expand_wildcards" + }, + { + "$ref": "#/components/parameters/msearch#ignore_throttled" + }, + { + "$ref": "#/components/parameters/msearch#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/msearch#max_concurrent_searches" + }, + { + "$ref": "#/components/parameters/msearch#max_concurrent_shard_requests" + }, + { + "$ref": "#/components/parameters/msearch#pre_filter_shard_size" + }, + { + "$ref": "#/components/parameters/msearch#rest_total_hits_as_int" + }, + { + "$ref": "#/components/parameters/msearch#routing" + }, + { + "$ref": "#/components/parameters/msearch#search_type" + }, + { + "$ref": "#/components/parameters/msearch#typed_keys" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/msearch" + }, + "responses": { + "200": { + "$ref": "#/components/responses/msearch#200" + } + }, + "x-available-since": "1.3.0" + } + }, + "/_msearch/template": { + "get": { + "tags": [ + "msearch_template" + ], + "summary": "Runs multiple templated searches with a single request", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html" + }, + "operationId": "msearch-template", + "parameters": [ + { + "$ref": "#/components/parameters/msearch_template#ccs_minimize_roundtrips" + }, + { + "$ref": "#/components/parameters/msearch_template#max_concurrent_searches" + }, + { + "$ref": "#/components/parameters/msearch_template#search_type" + }, + { + "$ref": "#/components/parameters/msearch_template#rest_total_hits_as_int" + }, + { + "$ref": "#/components/parameters/msearch_template#typed_keys" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/msearch_template" + }, + "responses": { + "200": { + "$ref": "#/components/responses/msearch_template#200" + } + }, + "x-available-since": "5.0.0" + }, + "post": { + "tags": [ + "msearch_template" + ], + "summary": "Runs multiple templated searches with a single request", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html" + }, + "operationId": "msearch-template-1", + "parameters": [ + { + "$ref": "#/components/parameters/msearch_template#ccs_minimize_roundtrips" + }, + { + "$ref": "#/components/parameters/msearch_template#max_concurrent_searches" + }, + { + "$ref": "#/components/parameters/msearch_template#search_type" + }, + { + "$ref": "#/components/parameters/msearch_template#rest_total_hits_as_int" + }, + { + "$ref": "#/components/parameters/msearch_template#typed_keys" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/msearch_template" + }, + "responses": { + "200": { + "$ref": "#/components/responses/msearch_template#200" + } + }, + "x-available-since": "5.0.0" + } + }, + "/{index}/_msearch/template": { + "get": { + "tags": [ + "msearch_template" + ], + "summary": "Runs multiple templated searches with a single request", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html" + }, + "operationId": "msearch-template-2", + "parameters": [ + { + "$ref": "#/components/parameters/msearch_template#index" + }, + { + "$ref": "#/components/parameters/msearch_template#ccs_minimize_roundtrips" + }, + { + "$ref": "#/components/parameters/msearch_template#max_concurrent_searches" + }, + { + "$ref": "#/components/parameters/msearch_template#search_type" + }, + { + "$ref": "#/components/parameters/msearch_template#rest_total_hits_as_int" + }, + { + "$ref": "#/components/parameters/msearch_template#typed_keys" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/msearch_template" + }, + "responses": { + "200": { + "$ref": "#/components/responses/msearch_template#200" + } + }, + "x-available-since": "5.0.0" + }, + "post": { + "tags": [ + "msearch_template" + ], + "summary": "Runs multiple templated searches with a single request", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html" + }, + "operationId": "msearch-template-3", + "parameters": [ + { + "$ref": "#/components/parameters/msearch_template#index" + }, + { + "$ref": "#/components/parameters/msearch_template#ccs_minimize_roundtrips" + }, + { + "$ref": "#/components/parameters/msearch_template#max_concurrent_searches" + }, + { + "$ref": "#/components/parameters/msearch_template#search_type" + }, + { + "$ref": "#/components/parameters/msearch_template#rest_total_hits_as_int" + }, + { + "$ref": "#/components/parameters/msearch_template#typed_keys" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/msearch_template" + }, + "responses": { + "200": { + "$ref": "#/components/responses/msearch_template#200" + } + }, + "x-available-since": "5.0.0" + } + }, + "/_mtermvectors": { + "get": { + "tags": [ + "mtermvectors" + ], + "summary": "Returns multiple termvectors in one request", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html" + }, + "operationId": "mtermvectors", + "parameters": [ + { + "$ref": "#/components/parameters/mtermvectors#ids" + }, + { + "$ref": "#/components/parameters/mtermvectors#fields" + }, + { + "$ref": "#/components/parameters/mtermvectors#field_statistics" + }, + { + "$ref": "#/components/parameters/mtermvectors#offsets" + }, + { + "$ref": "#/components/parameters/mtermvectors#payloads" + }, + { + "$ref": "#/components/parameters/mtermvectors#positions" + }, + { + "$ref": "#/components/parameters/mtermvectors#preference" + }, + { + "$ref": "#/components/parameters/mtermvectors#realtime" + }, + { + "$ref": "#/components/parameters/mtermvectors#routing" + }, + { + "$ref": "#/components/parameters/mtermvectors#term_statistics" + }, + { + "$ref": "#/components/parameters/mtermvectors#version" + }, + { + "$ref": "#/components/parameters/mtermvectors#version_type" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/mtermvectors" + }, + "responses": { + "200": { + "$ref": "#/components/responses/mtermvectors#200" + } + } + }, + "post": { + "tags": [ + "mtermvectors" + ], + "summary": "Returns multiple termvectors in one request", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html" + }, + "operationId": "mtermvectors-1", + "parameters": [ + { + "$ref": "#/components/parameters/mtermvectors#ids" + }, + { + "$ref": "#/components/parameters/mtermvectors#fields" + }, + { + "$ref": "#/components/parameters/mtermvectors#field_statistics" + }, + { + "$ref": "#/components/parameters/mtermvectors#offsets" + }, + { + "$ref": "#/components/parameters/mtermvectors#payloads" + }, + { + "$ref": "#/components/parameters/mtermvectors#positions" + }, + { + "$ref": "#/components/parameters/mtermvectors#preference" + }, + { + "$ref": "#/components/parameters/mtermvectors#realtime" + }, + { + "$ref": "#/components/parameters/mtermvectors#routing" + }, + { + "$ref": "#/components/parameters/mtermvectors#term_statistics" + }, + { + "$ref": "#/components/parameters/mtermvectors#version" + }, + { + "$ref": "#/components/parameters/mtermvectors#version_type" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/mtermvectors" + }, + "responses": { + "200": { + "$ref": "#/components/responses/mtermvectors#200" + } + } + } + }, + "/{index}/_mtermvectors": { + "get": { + "tags": [ + "mtermvectors" + ], + "summary": "Returns multiple termvectors in one request", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html" + }, + "operationId": "mtermvectors-2", + "parameters": [ + { + "$ref": "#/components/parameters/mtermvectors#index" + }, + { + "$ref": "#/components/parameters/mtermvectors#ids" + }, + { + "$ref": "#/components/parameters/mtermvectors#fields" + }, + { + "$ref": "#/components/parameters/mtermvectors#field_statistics" + }, + { + "$ref": "#/components/parameters/mtermvectors#offsets" + }, + { + "$ref": "#/components/parameters/mtermvectors#payloads" + }, + { + "$ref": "#/components/parameters/mtermvectors#positions" + }, + { + "$ref": "#/components/parameters/mtermvectors#preference" + }, + { + "$ref": "#/components/parameters/mtermvectors#realtime" + }, + { + "$ref": "#/components/parameters/mtermvectors#routing" + }, + { + "$ref": "#/components/parameters/mtermvectors#term_statistics" + }, + { + "$ref": "#/components/parameters/mtermvectors#version" + }, + { + "$ref": "#/components/parameters/mtermvectors#version_type" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/mtermvectors" + }, + "responses": { + "200": { + "$ref": "#/components/responses/mtermvectors#200" + } + } + }, + "post": { + "tags": [ + "mtermvectors" + ], + "summary": "Returns multiple termvectors in one request", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html" + }, + "operationId": "mtermvectors-3", + "parameters": [ + { + "$ref": "#/components/parameters/mtermvectors#index" + }, + { + "$ref": "#/components/parameters/mtermvectors#ids" + }, + { + "$ref": "#/components/parameters/mtermvectors#fields" + }, + { + "$ref": "#/components/parameters/mtermvectors#field_statistics" + }, + { + "$ref": "#/components/parameters/mtermvectors#offsets" + }, + { + "$ref": "#/components/parameters/mtermvectors#payloads" + }, + { + "$ref": "#/components/parameters/mtermvectors#positions" + }, + { + "$ref": "#/components/parameters/mtermvectors#preference" + }, + { + "$ref": "#/components/parameters/mtermvectors#realtime" + }, + { + "$ref": "#/components/parameters/mtermvectors#routing" + }, + { + "$ref": "#/components/parameters/mtermvectors#term_statistics" + }, + { + "$ref": "#/components/parameters/mtermvectors#version" + }, + { + "$ref": "#/components/parameters/mtermvectors#version_type" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/mtermvectors" + }, + "responses": { + "200": { + "$ref": "#/components/responses/mtermvectors#200" + } + } + } + }, + "/{index}/_pit": { + "post": { + "tags": [ + "open_point_in_time" + ], + "summary": "A search request by default executes against the most recent visible data of the target indices,\n", + "description": "which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the\nstate of the data as it existed when initiated. In some cases, it’s preferred to perform multiple\nsearch requests using the same point in time. For example, if refreshes happen between\n`search_after` requests, then the results of those requests might not be consistent as changes happening\nbetween searches are only visible to the more recent point in time.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html" + }, + "operationId": "open-point-in-time", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + { + "in": "query", + "name": "keep_alive", + "description": "Extends the time to live of the corresponding point in time.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "ignore_unavailable", + "description": "If `false`, the request returns an error if it targets a missing or closed index.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "preference", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "routing", + "description": "Custom value used to route operations to a specific shard.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Routing" + }, + "style": "form" + }, + { + "in": "query", + "name": "expand_wildcards", + "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/_types:Id" + } + }, + "required": [ + "id" + ] + } + } + } + } + }, + "x-available-since": "7.10.0" + } + }, + "/_scripts/{id}/{context}": { + "put": { + "tags": [ + "put_script" + ], + "summary": "Create or update a script or search template", + "description": "Creates or updates a stored script or search template.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html" + }, + "operationId": "put-script-2", + "parameters": [ + { + "$ref": "#/components/parameters/put_script#id" + }, + { + "$ref": "#/components/parameters/put_script#context" + }, + { + "$ref": "#/components/parameters/put_script#master_timeout" + }, + { + "$ref": "#/components/parameters/put_script#timeout" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/put_script" + }, + "responses": { + "200": { + "$ref": "#/components/responses/put_script#200" + } + } + }, + "post": { + "tags": [ + "put_script" + ], + "summary": "Create or update a script or search template", + "description": "Creates or updates a stored script or search template.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html" + }, + "operationId": "put-script-3", + "parameters": [ + { + "$ref": "#/components/parameters/put_script#id" + }, + { + "$ref": "#/components/parameters/put_script#context" + }, + { + "$ref": "#/components/parameters/put_script#master_timeout" + }, + { + "$ref": "#/components/parameters/put_script#timeout" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/put_script" + }, + "responses": { + "200": { + "$ref": "#/components/responses/put_script#200" + } + } + } + }, + "/_query_rules/{ruleset_id}/_rule/{rule_id}": { + "get": { + "tags": [ + "query_rules.get_rule" + ], + "summary": "Returns the details about a query rule within a query ruleset", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-query-rule.html" + }, + "operationId": "query-rules-get-rule", + "parameters": [ + { + "in": "path", + "name": "ruleset_id", + "description": "The unique identifier of the query ruleset containing the rule to retrieve", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "path", + "name": "rule_id", + "description": "The unique identifier of the query rule within the specified ruleset to retrieve", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/query_rules._types:QueryRule" + } + } + } + } + }, + "x-available-since": "8.15.0" + }, + "put": { + "tags": [ + "query_rules.put_rule" + ], + "summary": "Creates or updates a query rule within a query ruleset", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-query-rule.html" + }, + "operationId": "query-rules-put-rule", + "parameters": [ + { + "in": "path", + "name": "ruleset_id", + "description": "The unique identifier of the query ruleset containing the rule to be created or updated", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "path", + "name": "rule_id", + "description": "The unique identifier of the query rule within the specified ruleset to be created or updated", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/query_rules._types:QueryRuleType" + }, + "criteria": { + "oneOf": [ + { + "$ref": "#/components/schemas/query_rules._types:QueryRuleCriteria" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/query_rules._types:QueryRuleCriteria" + } + } + ] + }, + "actions": { + "$ref": "#/components/schemas/query_rules._types:QueryRuleActions" + }, + "priority": { + "type": "number" + } + }, + "required": [ + "type", + "criteria", + "actions" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } + } + }, + "x-available-since": "8.15.0" + }, + "delete": { + "tags": [ + "query_rules.delete_rule" + ], + "summary": "Deletes a query rule within a query ruleset", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-query-rule.html" + }, + "operationId": "query-rules-delete-rule", + "parameters": [ + { + "in": "path", + "name": "ruleset_id", + "description": "The unique identifier of the query ruleset containing the rule to delete", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "path", + "name": "rule_id", + "description": "The unique identifier of the query rule within the specified ruleset to delete", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "8.15.0" + } + }, + "/_query_rules/{ruleset_id}": { + "get": { + "tags": [ + "query_rules.get_ruleset" + ], + "summary": "Returns the details about a query ruleset", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-query-ruleset.html" + }, + "operationId": "query-rules-get-ruleset", + "parameters": [ + { + "in": "path", + "name": "ruleset_id", + "description": "The unique identifier of the query ruleset", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/query_rules._types:QueryRuleset" + } + } + } + } + }, + "x-available-since": "8.10.0" + }, + "put": { + "tags": [ + "query_rules.put_ruleset" + ], + "summary": "Creates or updates a query ruleset", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-query-ruleset.html" + }, + "operationId": "query-rules-put-ruleset", + "parameters": [ + { + "in": "path", + "name": "ruleset_id", + "description": "The unique identifier of the query ruleset to be created or updated", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "rules": { + "oneOf": [ + { + "$ref": "#/components/schemas/query_rules._types:QueryRule" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/query_rules._types:QueryRule" + } + } + ] + } + }, + "required": [ + "rules" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } + } + }, + "x-available-since": "8.10.0" + }, + "delete": { + "tags": [ + "query_rules.delete_ruleset" + ], + "summary": "Deletes a query ruleset", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-query-ruleset.html" + }, + "operationId": "query-rules-delete-ruleset", + "parameters": [ + { + "in": "path", + "name": "ruleset_id", + "description": "The unique identifier of the query ruleset to delete", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "8.10.0" + } + }, + "/_query_rules": { + "get": { + "tags": [ + "query_rules.list_rulesets" + ], + "summary": "Returns summarized information about existing query rulesets", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-query-rulesets.html" + }, + "operationId": "query-rules-list-rulesets", + "parameters": [ + { + "in": "query", + "name": "from", + "description": "Starting offset (default: 0)", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "size", + "description": "specifies a max number of results to get", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/query_rules.list_rulesets:QueryRulesetListItem" + } + } + }, + "required": [ + "count", + "results" + ] + } + } + } + } + }, + "x-available-since": "8.10.0" + } + }, + "/_rank_eval": { + "get": { + "tags": [ + "rank_eval" + ], + "summary": "Enables you to evaluate the quality of ranked search results over a set of typical search queries", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html" + }, + "operationId": "rank-eval", + "parameters": [ + { + "$ref": "#/components/parameters/rank_eval#allow_no_indices" + }, + { + "$ref": "#/components/parameters/rank_eval#expand_wildcards" + }, + { + "$ref": "#/components/parameters/rank_eval#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/rank_eval#search_type" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/rank_eval" + }, + "responses": { + "200": { + "$ref": "#/components/responses/rank_eval#200" + } + }, + "x-available-since": "6.2.0" + }, + "post": { + "tags": [ + "rank_eval" + ], + "summary": "Enables you to evaluate the quality of ranked search results over a set of typical search queries", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html" + }, + "operationId": "rank-eval-1", + "parameters": [ + { + "$ref": "#/components/parameters/rank_eval#allow_no_indices" + }, + { + "$ref": "#/components/parameters/rank_eval#expand_wildcards" + }, + { + "$ref": "#/components/parameters/rank_eval#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/rank_eval#search_type" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/rank_eval" + }, + "responses": { + "200": { + "$ref": "#/components/responses/rank_eval#200" + } + }, + "x-available-since": "6.2.0" + } + }, + "/{index}/_rank_eval": { + "get": { + "tags": [ + "rank_eval" + ], + "summary": "Enables you to evaluate the quality of ranked search results over a set of typical search queries", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html" + }, + "operationId": "rank-eval-2", + "parameters": [ + { + "$ref": "#/components/parameters/rank_eval#index" + }, + { + "$ref": "#/components/parameters/rank_eval#allow_no_indices" + }, + { + "$ref": "#/components/parameters/rank_eval#expand_wildcards" + }, + { + "$ref": "#/components/parameters/rank_eval#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/rank_eval#search_type" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/rank_eval" + }, + "responses": { + "200": { + "$ref": "#/components/responses/rank_eval#200" + } + }, + "x-available-since": "6.2.0" + }, + "post": { + "tags": [ + "rank_eval" + ], + "summary": "Enables you to evaluate the quality of ranked search results over a set of typical search queries", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html" + }, + "operationId": "rank-eval-3", + "parameters": [ + { + "$ref": "#/components/parameters/rank_eval#index" + }, + { + "$ref": "#/components/parameters/rank_eval#allow_no_indices" + }, + { + "$ref": "#/components/parameters/rank_eval#expand_wildcards" + }, + { + "$ref": "#/components/parameters/rank_eval#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/rank_eval#search_type" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/rank_eval" + }, + "responses": { + "200": { + "$ref": "#/components/responses/rank_eval#200" + } + }, + "x-available-since": "6.2.0" + } + }, + "/_reindex": { + "post": { + "tags": [ + "reindex" + ], + "summary": "Reindex documents", + "description": "Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html" + }, + "operationId": "reindex", + "parameters": [ + { + "in": "query", + "name": "refresh", + "description": "If `true`, the request refreshes affected shards to make this operation visible to search.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "requests_per_second", + "description": "The throttle for this request in sub-requests per second.\nDefaults to no throttle.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "scroll", + "description": "Specifies how long a consistent view of the index should be maintained for scrolled search.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "slices", + "description": "The number of slices this task should be divided into.\nDefaults to 1 slice, meaning the task isn’t sliced into subtasks.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Slices" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "wait_for_active_shards", + "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:WaitForActiveShards" + }, + "style": "form" + }, + { + "in": "query", + "name": "wait_for_completion", + "description": "If `true`, the request blocks until the operation is complete.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "require_alias", + "description": "If `true`, the destination must be an index alias.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "conflicts": { + "$ref": "#/components/schemas/_types:Conflicts" + }, + "dest": { + "$ref": "#/components/schemas/_global.reindex:Destination" + }, + "max_docs": { + "description": "The maximum number of documents to reindex.", + "type": "number" + }, + "script": { + "$ref": "#/components/schemas/_types:Script" + }, + "size": { + "type": "number" + }, + "source": { + "$ref": "#/components/schemas/_global.reindex:Source" + } + }, + "required": [ + "dest", + "source" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "batches": { + "type": "number" + }, + "created": { + "type": "number" + }, + "deleted": { + "type": "number" + }, + "failures": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:BulkIndexByScrollFailure" + } + }, + "noops": { + "type": "number" + }, + "retries": { + "$ref": "#/components/schemas/_types:Retries" + }, + "requests_per_second": { + "type": "number" + }, + "slice_id": { + "type": "number" + }, + "task": { + "$ref": "#/components/schemas/_types:TaskId" + }, + "throttled_millis": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "throttled_until_millis": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "timed_out": { + "type": "boolean" + }, + "took": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + }, + "total": { + "type": "number" + }, + "updated": { + "type": "number" + }, + "version_conflicts": { + "type": "number" + } + } + } + } + } + } + }, + "x-available-since": "2.3.0" + } + }, + "/_render/template": { + "get": { + "tags": [ + "render_search_template" + ], + "summary": "Renders a search template as a search request body", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/render-search-template-api.html" + }, + "operationId": "render-search-template", + "requestBody": { + "$ref": "#/components/requestBodies/render_search_template" + }, + "responses": { + "200": { + "$ref": "#/components/responses/render_search_template#200" + } + } + }, + "post": { + "tags": [ + "render_search_template" + ], + "summary": "Renders a search template as a search request body", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/render-search-template-api.html" + }, + "operationId": "render-search-template-1", + "requestBody": { + "$ref": "#/components/requestBodies/render_search_template" + }, + "responses": { + "200": { + "$ref": "#/components/responses/render_search_template#200" + } + } + } + }, + "/_render/template/{id}": { + "get": { + "tags": [ + "render_search_template" + ], + "summary": "Renders a search template as a search request body", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/render-search-template-api.html" + }, + "operationId": "render-search-template-2", + "parameters": [ + { + "$ref": "#/components/parameters/render_search_template#id" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/render_search_template" + }, + "responses": { + "200": { + "$ref": "#/components/responses/render_search_template#200" + } + } + }, + "post": { + "tags": [ + "render_search_template" + ], + "summary": "Renders a search template as a search request body", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/render-search-template-api.html" + }, + "operationId": "render-search-template-3", + "parameters": [ + { + "$ref": "#/components/parameters/render_search_template#id" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/render_search_template" + }, + "responses": { + "200": { + "$ref": "#/components/responses/render_search_template#200" + } + } + } + }, + "/_scripts/painless/_execute": { + "get": { + "tags": [ + "scripts_painless_execute" + ], + "summary": "Run a script", + "description": "Runs a script and returns a result.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html" + }, + "operationId": "scripts-painless-execute", + "requestBody": { + "$ref": "#/components/requestBodies/scripts_painless_execute" + }, + "responses": { + "200": { + "$ref": "#/components/responses/scripts_painless_execute#200" + } + }, + "x-technical-preview": true, + "x-available-since": "6.3.0" + }, + "post": { + "tags": [ + "scripts_painless_execute" + ], + "summary": "Run a script", + "description": "Runs a script and returns a result.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html" + }, + "operationId": "scripts-painless-execute-1", + "requestBody": { + "$ref": "#/components/requestBodies/scripts_painless_execute" + }, + "responses": { + "200": { + "$ref": "#/components/responses/scripts_painless_execute#200" + } + }, + "x-technical-preview": true, + "x-available-since": "6.3.0" + } + }, + "/_search": { + "get": { + "tags": [ + "search" + ], + "summary": "Returns search hits that match the query defined in the request", + "description": "You can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html" + }, + "operationId": "search", + "parameters": [ + { + "$ref": "#/components/parameters/search#allow_no_indices" + }, + { + "$ref": "#/components/parameters/search#allow_partial_search_results" + }, + { + "$ref": "#/components/parameters/search#analyzer" + }, + { + "$ref": "#/components/parameters/search#analyze_wildcard" + }, + { + "$ref": "#/components/parameters/search#batched_reduce_size" + }, + { + "$ref": "#/components/parameters/search#ccs_minimize_roundtrips" + }, + { + "$ref": "#/components/parameters/search#default_operator" + }, + { + "$ref": "#/components/parameters/search#df" + }, + { + "$ref": "#/components/parameters/search#docvalue_fields" + }, + { + "$ref": "#/components/parameters/search#expand_wildcards" + }, + { + "$ref": "#/components/parameters/search#explain" + }, + { + "$ref": "#/components/parameters/search#ignore_throttled" + }, + { + "$ref": "#/components/parameters/search#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/search#lenient" + }, + { + "$ref": "#/components/parameters/search#max_concurrent_shard_requests" + }, + { + "$ref": "#/components/parameters/search#min_compatible_shard_node" + }, + { + "$ref": "#/components/parameters/search#preference" + }, + { + "$ref": "#/components/parameters/search#pre_filter_shard_size" + }, + { + "$ref": "#/components/parameters/search#request_cache" + }, + { + "$ref": "#/components/parameters/search#routing" + }, + { + "$ref": "#/components/parameters/search#scroll" + }, + { + "$ref": "#/components/parameters/search#search_type" + }, + { + "$ref": "#/components/parameters/search#stats" + }, + { + "$ref": "#/components/parameters/search#stored_fields" + }, + { + "$ref": "#/components/parameters/search#suggest_field" + }, + { + "$ref": "#/components/parameters/search#suggest_mode" + }, + { + "$ref": "#/components/parameters/search#suggest_size" + }, + { + "$ref": "#/components/parameters/search#suggest_text" + }, + { + "$ref": "#/components/parameters/search#terminate_after" + }, + { + "$ref": "#/components/parameters/search#timeout" + }, + { + "$ref": "#/components/parameters/search#track_total_hits" + }, + { + "$ref": "#/components/parameters/search#track_scores" + }, + { + "$ref": "#/components/parameters/search#typed_keys" + }, + { + "$ref": "#/components/parameters/search#rest_total_hits_as_int" + }, + { + "$ref": "#/components/parameters/search#version" + }, + { + "$ref": "#/components/parameters/search#_source" + }, + { + "$ref": "#/components/parameters/search#_source_excludes" + }, + { + "$ref": "#/components/parameters/search#_source_includes" + }, + { + "$ref": "#/components/parameters/search#seq_no_primary_term" + }, + { + "$ref": "#/components/parameters/search#q" + }, + { + "$ref": "#/components/parameters/search#size" + }, + { + "$ref": "#/components/parameters/search#from" + }, + { + "$ref": "#/components/parameters/search#sort" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/search" + }, + "responses": { + "200": { + "$ref": "#/components/responses/search#200" + } + } + }, + "post": { + "tags": [ + "search" + ], + "summary": "Returns search hits that match the query defined in the request", + "description": "You can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html" + }, + "operationId": "search-1", + "parameters": [ + { + "$ref": "#/components/parameters/search#allow_no_indices" + }, + { + "$ref": "#/components/parameters/search#allow_partial_search_results" + }, + { + "$ref": "#/components/parameters/search#analyzer" + }, + { + "$ref": "#/components/parameters/search#analyze_wildcard" + }, + { + "$ref": "#/components/parameters/search#batched_reduce_size" + }, + { + "$ref": "#/components/parameters/search#ccs_minimize_roundtrips" + }, + { + "$ref": "#/components/parameters/search#default_operator" + }, + { + "$ref": "#/components/parameters/search#df" + }, + { + "$ref": "#/components/parameters/search#docvalue_fields" + }, + { + "$ref": "#/components/parameters/search#expand_wildcards" + }, + { + "$ref": "#/components/parameters/search#explain" + }, + { + "$ref": "#/components/parameters/search#ignore_throttled" + }, + { + "$ref": "#/components/parameters/search#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/search#lenient" + }, + { + "$ref": "#/components/parameters/search#max_concurrent_shard_requests" + }, + { + "$ref": "#/components/parameters/search#min_compatible_shard_node" + }, + { + "$ref": "#/components/parameters/search#preference" + }, + { + "$ref": "#/components/parameters/search#pre_filter_shard_size" + }, + { + "$ref": "#/components/parameters/search#request_cache" + }, + { + "$ref": "#/components/parameters/search#routing" + }, + { + "$ref": "#/components/parameters/search#scroll" + }, + { + "$ref": "#/components/parameters/search#search_type" + }, + { + "$ref": "#/components/parameters/search#stats" + }, + { + "$ref": "#/components/parameters/search#stored_fields" + }, + { + "$ref": "#/components/parameters/search#suggest_field" + }, + { + "$ref": "#/components/parameters/search#suggest_mode" + }, + { + "$ref": "#/components/parameters/search#suggest_size" + }, + { + "$ref": "#/components/parameters/search#suggest_text" + }, + { + "$ref": "#/components/parameters/search#terminate_after" + }, + { + "$ref": "#/components/parameters/search#timeout" + }, + { + "$ref": "#/components/parameters/search#track_total_hits" + }, + { + "$ref": "#/components/parameters/search#track_scores" + }, + { + "$ref": "#/components/parameters/search#typed_keys" + }, + { + "$ref": "#/components/parameters/search#rest_total_hits_as_int" + }, + { + "$ref": "#/components/parameters/search#version" + }, + { + "$ref": "#/components/parameters/search#_source" + }, + { + "$ref": "#/components/parameters/search#_source_excludes" + }, + { + "$ref": "#/components/parameters/search#_source_includes" + }, + { + "$ref": "#/components/parameters/search#seq_no_primary_term" + }, + { + "$ref": "#/components/parameters/search#q" + }, + { + "$ref": "#/components/parameters/search#size" + }, + { + "$ref": "#/components/parameters/search#from" + }, + { + "$ref": "#/components/parameters/search#sort" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/search" + }, + "responses": { + "200": { + "$ref": "#/components/responses/search#200" + } + } + } + }, + "/{index}/_search": { + "get": { + "tags": [ + "search" + ], + "summary": "Returns search hits that match the query defined in the request", + "description": "You can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html" + }, + "operationId": "search-2", + "parameters": [ + { + "$ref": "#/components/parameters/search#index" + }, + { + "$ref": "#/components/parameters/search#allow_no_indices" + }, + { + "$ref": "#/components/parameters/search#allow_partial_search_results" + }, + { + "$ref": "#/components/parameters/search#analyzer" + }, + { + "$ref": "#/components/parameters/search#analyze_wildcard" + }, + { + "$ref": "#/components/parameters/search#batched_reduce_size" + }, + { + "$ref": "#/components/parameters/search#ccs_minimize_roundtrips" + }, + { + "$ref": "#/components/parameters/search#default_operator" + }, + { + "$ref": "#/components/parameters/search#df" + }, + { + "$ref": "#/components/parameters/search#docvalue_fields" + }, + { + "$ref": "#/components/parameters/search#expand_wildcards" + }, + { + "$ref": "#/components/parameters/search#explain" + }, + { + "$ref": "#/components/parameters/search#ignore_throttled" + }, + { + "$ref": "#/components/parameters/search#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/search#lenient" + }, + { + "$ref": "#/components/parameters/search#max_concurrent_shard_requests" + }, + { + "$ref": "#/components/parameters/search#min_compatible_shard_node" + }, + { + "$ref": "#/components/parameters/search#preference" + }, + { + "$ref": "#/components/parameters/search#pre_filter_shard_size" + }, + { + "$ref": "#/components/parameters/search#request_cache" + }, + { + "$ref": "#/components/parameters/search#routing" + }, + { + "$ref": "#/components/parameters/search#scroll" + }, + { + "$ref": "#/components/parameters/search#search_type" + }, + { + "$ref": "#/components/parameters/search#stats" + }, + { + "$ref": "#/components/parameters/search#stored_fields" + }, + { + "$ref": "#/components/parameters/search#suggest_field" + }, + { + "$ref": "#/components/parameters/search#suggest_mode" + }, + { + "$ref": "#/components/parameters/search#suggest_size" + }, + { + "$ref": "#/components/parameters/search#suggest_text" + }, + { + "$ref": "#/components/parameters/search#terminate_after" + }, + { + "$ref": "#/components/parameters/search#timeout" + }, + { + "$ref": "#/components/parameters/search#track_total_hits" + }, + { + "$ref": "#/components/parameters/search#track_scores" + }, + { + "$ref": "#/components/parameters/search#typed_keys" + }, + { + "$ref": "#/components/parameters/search#rest_total_hits_as_int" + }, + { + "$ref": "#/components/parameters/search#version" + }, + { + "$ref": "#/components/parameters/search#_source" + }, + { + "$ref": "#/components/parameters/search#_source_excludes" + }, + { + "$ref": "#/components/parameters/search#_source_includes" + }, + { + "$ref": "#/components/parameters/search#seq_no_primary_term" + }, + { + "$ref": "#/components/parameters/search#q" + }, + { + "$ref": "#/components/parameters/search#size" + }, + { + "$ref": "#/components/parameters/search#from" + }, + { + "$ref": "#/components/parameters/search#sort" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/search" + }, + "responses": { + "200": { + "$ref": "#/components/responses/search#200" + } + } + }, + "post": { + "tags": [ + "search" + ], + "summary": "Returns search hits that match the query defined in the request", + "description": "You can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html" + }, + "operationId": "search-3", + "parameters": [ + { + "$ref": "#/components/parameters/search#index" + }, + { + "$ref": "#/components/parameters/search#allow_no_indices" + }, + { + "$ref": "#/components/parameters/search#allow_partial_search_results" + }, + { + "$ref": "#/components/parameters/search#analyzer" + }, + { + "$ref": "#/components/parameters/search#analyze_wildcard" + }, + { + "$ref": "#/components/parameters/search#batched_reduce_size" + }, + { + "$ref": "#/components/parameters/search#ccs_minimize_roundtrips" + }, + { + "$ref": "#/components/parameters/search#default_operator" + }, + { + "$ref": "#/components/parameters/search#df" + }, + { + "$ref": "#/components/parameters/search#docvalue_fields" + }, + { + "$ref": "#/components/parameters/search#expand_wildcards" + }, + { + "$ref": "#/components/parameters/search#explain" + }, + { + "$ref": "#/components/parameters/search#ignore_throttled" + }, + { + "$ref": "#/components/parameters/search#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/search#lenient" + }, + { + "$ref": "#/components/parameters/search#max_concurrent_shard_requests" + }, + { + "$ref": "#/components/parameters/search#min_compatible_shard_node" + }, + { + "$ref": "#/components/parameters/search#preference" + }, + { + "$ref": "#/components/parameters/search#pre_filter_shard_size" + }, + { + "$ref": "#/components/parameters/search#request_cache" + }, + { + "$ref": "#/components/parameters/search#routing" + }, + { + "$ref": "#/components/parameters/search#scroll" + }, + { + "$ref": "#/components/parameters/search#search_type" + }, + { + "$ref": "#/components/parameters/search#stats" + }, + { + "$ref": "#/components/parameters/search#stored_fields" + }, + { + "$ref": "#/components/parameters/search#suggest_field" + }, + { + "$ref": "#/components/parameters/search#suggest_mode" + }, + { + "$ref": "#/components/parameters/search#suggest_size" + }, + { + "$ref": "#/components/parameters/search#suggest_text" + }, + { + "$ref": "#/components/parameters/search#terminate_after" + }, + { + "$ref": "#/components/parameters/search#timeout" + }, + { + "$ref": "#/components/parameters/search#track_total_hits" + }, + { + "$ref": "#/components/parameters/search#track_scores" + }, + { + "$ref": "#/components/parameters/search#typed_keys" + }, + { + "$ref": "#/components/parameters/search#rest_total_hits_as_int" + }, + { + "$ref": "#/components/parameters/search#version" + }, + { + "$ref": "#/components/parameters/search#_source" + }, + { + "$ref": "#/components/parameters/search#_source_excludes" + }, + { + "$ref": "#/components/parameters/search#_source_includes" + }, + { + "$ref": "#/components/parameters/search#seq_no_primary_term" + }, + { + "$ref": "#/components/parameters/search#q" + }, + { + "$ref": "#/components/parameters/search#size" + }, + { + "$ref": "#/components/parameters/search#from" + }, + { + "$ref": "#/components/parameters/search#sort" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/search" + }, + "responses": { + "200": { + "$ref": "#/components/responses/search#200" + } + } + } + }, + "/_application/search_application/{name}": { + "get": { + "tags": [ + "search_application.get" + ], + "summary": "Returns the details about a search application", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-search-application.html" + }, + "operationId": "search-application-get", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "The name of the search application", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/search_application._types:SearchApplication" + } + } + } + } + }, + "x-beta": true, + "x-available-since": "8.8.0" + }, + "put": { + "tags": [ + "search_application.put" + ], + "summary": "Creates or updates a search application", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-search-application.html" + }, + "operationId": "search-application-put", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "The name of the search application to be created or updated.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" + }, + { + "in": "query", + "name": "create", + "description": "If `true`, this request cannot replace or update existing Search Applications.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/search_application._types:SearchApplication" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + } + }, + "required": [ + "result" + ] + } + } + } + } + }, + "x-beta": true, + "x-available-since": "8.8.0" + }, + "delete": { + "tags": [ + "search_application.delete" + ], + "summary": "Deletes a search application", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-search-application.html" + }, + "operationId": "search-application-delete", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "The name of the search application to delete", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-beta": true, + "x-available-since": "8.8.0" + } + }, + "/_application/analytics/{name}": { + "get": { + "tags": [ + "search_application.get_behavioral_analytics" + ], + "summary": "Returns the existing behavioral analytics collections", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-analytics-collection.html" + }, + "operationId": "search-application-get-behavioral-analytics-1", + "parameters": [ + { + "$ref": "#/components/parameters/search_application.get_behavioral_analytics#name" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/search_application.get_behavioral_analytics#200" + } + }, + "x-technical-preview": true, + "x-available-since": "8.8.0" + }, + "put": { + "tags": [ + "search_application.put_behavioral_analytics" + ], + "summary": "Creates a behavioral analytics collection", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-analytics-collection.html" + }, + "operationId": "search-application-put-behavioral-analytics", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "The name of the analytics collection to be created or updated.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/search_application.put_behavioral_analytics:AnalyticsAcknowledgeResponseBase" + } + } + } + } + }, + "x-technical-preview": true, + "x-available-since": "8.8.0" + }, + "delete": { + "tags": [ + "search_application.delete_behavioral_analytics" + ], + "summary": "Delete a behavioral analytics collection", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-analytics-collection.html" + }, + "operationId": "search-application-delete-behavioral-analytics", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "The name of the analytics collection to be deleted", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-technical-preview": true, + "x-available-since": "8.8.0" + } + }, + "/_application/analytics": { + "get": { + "tags": [ + "search_application.get_behavioral_analytics" + ], + "summary": "Returns the existing behavioral analytics collections", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-analytics-collection.html" + }, + "operationId": "search-application-get-behavioral-analytics", + "responses": { + "200": { + "$ref": "#/components/responses/search_application.get_behavioral_analytics#200" + } + }, + "x-technical-preview": true, + "x-available-since": "8.8.0" + } + }, + "/_application/search_application": { + "get": { + "tags": [ + "search_application.list" + ], + "summary": "Returns the existing search applications", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-search-applications.html" + }, + "operationId": "search-application-list", + "parameters": [ + { + "in": "query", + "name": "q", + "description": "Query in the Lucene query string syntax.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "from", + "description": "Starting offset.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "size", + "description": "Specifies a max number of results to get.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/search_application.list:SearchApplicationListItem" + } + } + }, + "required": [ + "count", + "results" + ] + } + } + } + } + }, + "x-beta": true, + "x-available-since": "8.8.0" + } + }, + "/_application/search_application/{name}/_search": { + "get": { + "tags": [ + "search_application.search" + ], + "summary": "Perform a search against a search application", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-search.html" + }, + "operationId": "search-application-search", + "parameters": [ + { + "$ref": "#/components/parameters/search_application.search#name" + }, + { + "$ref": "#/components/parameters/search_application.search#typed_keys" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/search_application.search" + }, + "responses": { + "200": { + "$ref": "#/components/responses/search_application.search#200" + } + }, + "x-beta": true, + "x-available-since": "8.8.0" + }, + "post": { + "tags": [ + "search_application.search" + ], + "summary": "Perform a search against a search application", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-search.html" + }, + "operationId": "search-application-search-1", + "parameters": [ + { + "$ref": "#/components/parameters/search_application.search#name" + }, + { + "$ref": "#/components/parameters/search_application.search#typed_keys" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/search_application.search" + }, + "responses": { + "200": { + "$ref": "#/components/responses/search_application.search#200" + } + }, + "x-beta": true, + "x-available-since": "8.8.0" + } + }, + "/{index}/_mvt/{field}/{zoom}/{x}/{y}": { + "get": { + "tags": [ + "search_mvt" + ], + "summary": "Search a vector tile", + "description": "Searches a vector tile for geospatial values.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html" + }, + "operationId": "search-mvt-1", + "parameters": [ + { + "$ref": "#/components/parameters/search_mvt#index" + }, + { + "$ref": "#/components/parameters/search_mvt#field" + }, + { + "$ref": "#/components/parameters/search_mvt#zoom" + }, + { + "$ref": "#/components/parameters/search_mvt#x" + }, + { + "$ref": "#/components/parameters/search_mvt#y" + }, + { + "$ref": "#/components/parameters/search_mvt#exact_bounds" + }, + { + "$ref": "#/components/parameters/search_mvt#extent" + }, + { + "$ref": "#/components/parameters/search_mvt#grid_agg" + }, + { + "$ref": "#/components/parameters/search_mvt#grid_precision" + }, + { + "$ref": "#/components/parameters/search_mvt#grid_type" + }, + { + "$ref": "#/components/parameters/search_mvt#size" + }, + { + "$ref": "#/components/parameters/search_mvt#with_labels" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/search_mvt" + }, + "responses": { + "200": { + "$ref": "#/components/responses/search_mvt#200" + } + }, + "x-available-since": "7.15.0" + }, + "post": { + "tags": [ + "search_mvt" + ], + "summary": "Search a vector tile", + "description": "Searches a vector tile for geospatial values.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html" + }, + "operationId": "search-mvt", + "parameters": [ + { + "$ref": "#/components/parameters/search_mvt#index" + }, + { + "$ref": "#/components/parameters/search_mvt#field" + }, + { + "$ref": "#/components/parameters/search_mvt#zoom" + }, + { + "$ref": "#/components/parameters/search_mvt#x" + }, + { + "$ref": "#/components/parameters/search_mvt#y" + }, + { + "$ref": "#/components/parameters/search_mvt#exact_bounds" + }, + { + "$ref": "#/components/parameters/search_mvt#extent" + }, + { + "$ref": "#/components/parameters/search_mvt#grid_agg" + }, + { + "$ref": "#/components/parameters/search_mvt#grid_precision" + }, + { + "$ref": "#/components/parameters/search_mvt#grid_type" + }, + { + "$ref": "#/components/parameters/search_mvt#size" + }, + { + "$ref": "#/components/parameters/search_mvt#with_labels" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/search_mvt" + }, + "responses": { + "200": { + "$ref": "#/components/responses/search_mvt#200" + } + }, + "x-available-since": "7.15.0" + } + }, + "/_search/template": { + "get": { + "tags": [ + "search_template" + ], + "summary": "Runs a search with a search template", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + }, + "operationId": "search-template", + "parameters": [ + { + "$ref": "#/components/parameters/search_template#allow_no_indices" + }, + { + "$ref": "#/components/parameters/search_template#ccs_minimize_roundtrips" + }, + { + "$ref": "#/components/parameters/search_template#expand_wildcards" + }, + { + "$ref": "#/components/parameters/search_template#explain" + }, + { + "$ref": "#/components/parameters/search_template#ignore_throttled" + }, + { + "$ref": "#/components/parameters/search_template#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/search_template#preference" + }, + { + "$ref": "#/components/parameters/search_template#profile" + }, + { + "$ref": "#/components/parameters/search_template#routing" + }, + { + "$ref": "#/components/parameters/search_template#scroll" + }, + { + "$ref": "#/components/parameters/search_template#search_type" + }, + { + "$ref": "#/components/parameters/search_template#rest_total_hits_as_int" + }, + { + "$ref": "#/components/parameters/search_template#typed_keys" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/search_template" + }, + "responses": { + "200": { + "$ref": "#/components/responses/search_template#200" + } + }, + "x-available-since": "2.0.0" + }, + "post": { + "tags": [ + "search_template" + ], + "summary": "Runs a search with a search template", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + }, + "operationId": "search-template-1", + "parameters": [ + { + "$ref": "#/components/parameters/search_template#allow_no_indices" + }, + { + "$ref": "#/components/parameters/search_template#ccs_minimize_roundtrips" + }, + { + "$ref": "#/components/parameters/search_template#expand_wildcards" + }, + { + "$ref": "#/components/parameters/search_template#explain" + }, + { + "$ref": "#/components/parameters/search_template#ignore_throttled" + }, + { + "$ref": "#/components/parameters/search_template#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/search_template#preference" + }, + { + "$ref": "#/components/parameters/search_template#profile" + }, + { + "$ref": "#/components/parameters/search_template#routing" + }, + { + "$ref": "#/components/parameters/search_template#scroll" + }, + { + "$ref": "#/components/parameters/search_template#search_type" + }, + { + "$ref": "#/components/parameters/search_template#rest_total_hits_as_int" + }, + { + "$ref": "#/components/parameters/search_template#typed_keys" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/search_template" + }, + "responses": { + "200": { + "$ref": "#/components/responses/search_template#200" + } + }, + "x-available-since": "2.0.0" + } + }, + "/{index}/_search/template": { + "get": { + "tags": [ + "search_template" + ], + "summary": "Runs a search with a search template", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + }, + "operationId": "search-template-2", + "parameters": [ + { + "$ref": "#/components/parameters/search_template#index" + }, + { + "$ref": "#/components/parameters/search_template#allow_no_indices" + }, + { + "$ref": "#/components/parameters/search_template#ccs_minimize_roundtrips" + }, + { + "$ref": "#/components/parameters/search_template#expand_wildcards" + }, + { + "$ref": "#/components/parameters/search_template#explain" + }, + { + "$ref": "#/components/parameters/search_template#ignore_throttled" + }, + { + "$ref": "#/components/parameters/search_template#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/search_template#preference" + }, + { + "$ref": "#/components/parameters/search_template#profile" + }, + { + "$ref": "#/components/parameters/search_template#routing" + }, + { + "$ref": "#/components/parameters/search_template#scroll" + }, + { + "$ref": "#/components/parameters/search_template#search_type" + }, + { + "$ref": "#/components/parameters/search_template#rest_total_hits_as_int" + }, + { + "$ref": "#/components/parameters/search_template#typed_keys" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/search_template" + }, + "responses": { + "200": { + "$ref": "#/components/responses/search_template#200" + } + }, + "x-available-since": "2.0.0" + }, + "post": { + "tags": [ + "search_template" + ], + "summary": "Runs a search with a search template", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + }, + "operationId": "search-template-3", + "parameters": [ + { + "$ref": "#/components/parameters/search_template#index" + }, + { + "$ref": "#/components/parameters/search_template#allow_no_indices" + }, + { + "$ref": "#/components/parameters/search_template#ccs_minimize_roundtrips" + }, + { + "$ref": "#/components/parameters/search_template#expand_wildcards" + }, + { + "$ref": "#/components/parameters/search_template#explain" + }, + { + "$ref": "#/components/parameters/search_template#ignore_throttled" + }, + { + "$ref": "#/components/parameters/search_template#ignore_unavailable" + }, + { + "$ref": "#/components/parameters/search_template#preference" + }, + { + "$ref": "#/components/parameters/search_template#profile" + }, + { + "$ref": "#/components/parameters/search_template#routing" + }, + { + "$ref": "#/components/parameters/search_template#scroll" + }, + { + "$ref": "#/components/parameters/search_template#search_type" + }, + { + "$ref": "#/components/parameters/search_template#rest_total_hits_as_int" + }, + { + "$ref": "#/components/parameters/search_template#typed_keys" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/search_template" + }, + "responses": { + "200": { + "$ref": "#/components/responses/search_template#200" + } + }, + "x-available-since": "2.0.0" + } + }, + "/_security/_authenticate": { + "get": { + "tags": [ + "security.authenticate" + ], + "summary": "Authenticate a user", + "description": "Authenticates a user and returns information about the authenticated user.\nInclude the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication).\nA successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user.\nIf the user cannot be authenticated, this API returns a 401 status code.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html" + }, + "operationId": "security-authenticate", + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "api_key": { + "$ref": "#/components/schemas/security._types:ApiKey" + }, + "authentication_realm": { + "$ref": "#/components/schemas/security._types:RealmInfo" + }, + "email": { + "oneOf": [ + { + "type": "string" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "full_name": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types:Name" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "lookup_realm": { + "$ref": "#/components/schemas/security._types:RealmInfo" + }, + "metadata": { + "$ref": "#/components/schemas/_types:Metadata" + }, + "roles": { + "type": "array", + "items": { + "type": "string" + } + }, + "username": { + "$ref": "#/components/schemas/_types:Username" + }, + "enabled": { + "type": "boolean" + }, + "authentication_type": { + "type": "string" + }, + "token": { + "$ref": "#/components/schemas/security.authenticate:Token" + } + }, + "required": [ + "authentication_realm", + "lookup_realm", + "metadata", + "roles", + "username", + "enabled", + "authentication_type" + ] + } + } + } + } + }, + "x-available-since": "5.5.0" + } + }, + "/_security/api_key": { + "get": { + "tags": [ + "security.get_api_key" + ], + "summary": "Get API key information", + "description": "Retrieves information for one or more API keys.\nNOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.\nIf you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html" + }, + "operationId": "security-get-api-key", + "parameters": [ + { + "in": "query", + "name": "id", + "description": "An API key id.\nThis parameter cannot be used with any of `name`, `realm_name` or `username`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "form" + }, + { + "in": "query", + "name": "name", + "description": "An API key name.\nThis parameter cannot be used with any of `id`, `realm_name` or `username`.\nIt supports prefix search with wildcard.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "form" + }, + { + "in": "query", + "name": "owner", + "description": "A boolean flag that can be used to 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.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "realm_name", + "description": "The name of an authentication realm.\nThis parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "form" + }, + { + "in": "query", + "name": "username", + "description": "The username of a user.\nThis parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Username" + }, + "style": "form" + }, + { + "in": "query", + "name": "with_limited_by", + "description": "Return the snapshot of the owner user's role descriptors\nassociated with the API key. An API key's actual\npermission is the intersection of its assigned role\ndescriptors and the owner user's role descriptors.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "active_only", + "description": "A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, nor expired at query time. You can specify this together with other parameters such as `owner` or `name`. If `active_only` is false, the response will include both active and inactive (expired or invalidated) keys.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "with_profile_uid", + "description": "Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "api_keys": { + "type": "array", + "items": { + "$ref": "#/components/schemas/security._types:ApiKey" + } + } + }, + "required": [ + "api_keys" + ] + } + } + } + } + }, + "x-available-since": "6.7.0" + }, + "put": { + "tags": [ + "security.create_api_key" + ], + "summary": "Create an API key", + "description": "Creates an API key for access without requiring basic authentication.\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html" + }, + "operationId": "security-create-api-key", + "parameters": [ + { + "$ref": "#/components/parameters/security.create_api_key#refresh" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/security.create_api_key" + }, + "responses": { + "200": { + "$ref": "#/components/responses/security.create_api_key#200" + } + }, + "x-available-since": "6.7.0" + }, + "post": { + "tags": [ + "security.create_api_key" + ], + "summary": "Create an API key", + "description": "Creates an API key for access without requiring basic authentication.\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html" + }, + "operationId": "security-create-api-key-1", + "parameters": [ + { + "$ref": "#/components/parameters/security.create_api_key#refresh" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/security.create_api_key" + }, + "responses": { + "200": { + "$ref": "#/components/responses/security.create_api_key#200" + } + }, + "x-available-since": "6.7.0" + }, + "delete": { + "tags": [ + "security.invalidate_api_key" + ], + "summary": "Invalidate API keys", + "description": "Invalidates one or more API keys.\nThe `manage_api_key` privilege allows deleting any API keys.\nThe `manage_own_api_key` only allows deleting API keys that are owned by the user.\nIn addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:\n- Set the parameter `owner=true`.\n- Or, set both `username` and `realm_name` to match the user’s identity.\n- Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the `ids` field.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html" + }, + "operationId": "security-invalidate-api-key", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "$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`.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Id" + } + }, + "name": { + "$ref": "#/components/schemas/_types:Name" + }, + "owner": { + "description": "Can be used to 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.", + "type": "boolean" + }, + "realm_name": { + "description": "The name of an authentication realm.\nThis parameter cannot be used with either `ids` or `name`, or when `owner` flag is set to `true`.", + "type": "string" + }, + "username": { + "$ref": "#/components/schemas/_types:Username" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error_count": { + "type": "number" + }, + "error_details": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:ErrorCause" + } + }, + "invalidated_api_keys": { + "type": "array", + "items": { + "type": "string" + } + }, + "previously_invalidated_api_keys": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "error_count", + "invalidated_api_keys", + "previously_invalidated_api_keys" + ] + } + } + } + } + }, + "x-available-since": "6.7.0" + } + }, + "/_security/user/_has_privileges": { + "get": { + "tags": [ + "security.has_privileges" + ], + "summary": "Check user privileges", + "description": "Determines whether the specified user has a specified list of privileges.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html" + }, + "operationId": "security-has-privileges", + "requestBody": { + "$ref": "#/components/requestBodies/security.has_privileges" + }, + "responses": { + "200": { + "$ref": "#/components/responses/security.has_privileges#200" + } + }, + "x-available-since": "6.4.0" + }, + "post": { + "tags": [ + "security.has_privileges" + ], + "summary": "Check user privileges", + "description": "Determines whether the specified user has a specified list of privileges.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html" + }, + "operationId": "security-has-privileges-1", + "requestBody": { + "$ref": "#/components/requestBodies/security.has_privileges" + }, + "responses": { + "200": { + "$ref": "#/components/responses/security.has_privileges#200" + } + }, + "x-available-since": "6.4.0" + } + }, + "/_security/user/{user}/_has_privileges": { + "get": { + "tags": [ + "security.has_privileges" + ], + "summary": "Check user privileges", + "description": "Determines whether the specified user has a specified list of privileges.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html" + }, + "operationId": "security-has-privileges-2", + "parameters": [ + { + "$ref": "#/components/parameters/security.has_privileges#user" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/security.has_privileges" + }, + "responses": { + "200": { + "$ref": "#/components/responses/security.has_privileges#200" + } + }, + "x-available-since": "6.4.0" + }, + "post": { + "tags": [ + "security.has_privileges" + ], + "summary": "Check user privileges", + "description": "Determines whether the specified user has a specified list of privileges.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html" + }, + "operationId": "security-has-privileges-3", + "parameters": [ + { + "$ref": "#/components/parameters/security.has_privileges#user" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/security.has_privileges" + }, + "responses": { + "200": { + "$ref": "#/components/responses/security.has_privileges#200" + } + }, + "x-available-since": "6.4.0" + } + }, + "/_security/_query/api_key": { + "get": { + "tags": [ + "security.query_api_keys" + ], + "summary": "Query API keys", + "description": "Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html" + }, + "operationId": "security-query-api-keys", + "parameters": [ + { + "$ref": "#/components/parameters/security.query_api_keys#with_limited_by" + }, + { + "$ref": "#/components/parameters/security.query_api_keys#with_profile_uid" + }, + { + "$ref": "#/components/parameters/security.query_api_keys#typed_keys" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/security.query_api_keys" + }, + "responses": { + "200": { + "$ref": "#/components/responses/security.query_api_keys#200" + } + }, + "x-available-since": "7.15.0" + }, + "post": { + "tags": [ + "security.query_api_keys" + ], + "summary": "Query API keys", + "description": "Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html" + }, + "operationId": "security-query-api-keys-1", + "parameters": [ + { + "$ref": "#/components/parameters/security.query_api_keys#with_limited_by" + }, + { + "$ref": "#/components/parameters/security.query_api_keys#with_profile_uid" + }, + { + "$ref": "#/components/parameters/security.query_api_keys#typed_keys" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/security.query_api_keys" + }, + "responses": { + "200": { + "$ref": "#/components/responses/security.query_api_keys#200" + } + }, + "x-available-since": "7.15.0" + } + }, + "/_security/api_key/{id}": { + "put": { + "tags": [ + "security.update_api_key" + ], + "summary": "Update an API key", + "description": "Updates attributes of an existing API key.\nUsers can only update API keys that they created or that were granted to them.\nUse this API to update API keys created by the create API Key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use bulk update API Keys to reduce overhead.\nIt’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key.\nThis API supports updates to an API key’s access scope and metadata.\nThe access scope of an API key is derived from the `role_descriptors` you specify in the request, and a snapshot of the owner user’s permissions at the time of the request.\nThe snapshot of the owner’s permissions is updated automatically on every call.\nIf you don’t specify `role_descriptors` in the request, a call to this API might still change the API key’s access scope.\nThis change can occur if the owner user’s permissions have changed since the API key was created or last modified.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\nIMPORTANT: It’s not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user’s credentials are required.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-api-key.html" + }, + "operationId": "security-update-api-key", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The ID of the API key to update.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "role_descriptors": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html" + }, + "description": "An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/security._types:RoleDescriptor" + } + }, + "metadata": { + "$ref": "#/components/schemas/_types:Metadata" + }, + "expiration": { + "$ref": "#/components/schemas/_types:Duration" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "updated": { + "description": "If `true`, the API key was updated.\nIf `false`, the API key didn’t change because no change was detected.", + "type": "boolean" + } + }, + "required": [ + "updated" + ] + } + } + } + } + }, + "x-available-since": "8.4.0" + } + }, + "/_sql/close": { + "post": { + "tags": [ + "sql.clear_cursor" + ], + "summary": "Clears the SQL cursor", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-sql-cursor-api.html" + }, + "operationId": "sql-clear-cursor", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cursor": { + "description": "Cursor to clear.", + "type": "string" + } + }, + "required": [ + "cursor" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "succeeded": { + "type": "boolean" + } + }, + "required": [ + "succeeded" + ] + } + } + } + } + }, + "x-available-since": "6.3.0" + } + }, + "/_sql/async/delete/{id}": { + "delete": { + "tags": [ + "sql.delete_async" + ], + "summary": "Deletes an async SQL search or a stored synchronous SQL search", + "description": "If the search is still running, the API cancels it.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-async-sql-search-api.html" + }, + "operationId": "sql-delete-async", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Identifier for the search.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "7.15.0" + } + }, + "/_sql/async/{id}": { + "get": { + "tags": [ + "sql.get_async" + ], + "summary": "Returns the current status and available results for an async SQL search or stored synchronous SQL search", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-api.html" + }, + "operationId": "sql-get-async", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Identifier for the search.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "delimiter", + "description": "Separator for CSV results. The API only supports this parameter for CSV responses.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "format", + "description": "Format for the response. You must specify a format using this parameter or the\nAccept HTTP header. If you specify both, the API uses this parameter.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "keep_alive", + "description": "Retention period for the search and its results. Defaults\nto the `keep_alive` period for the original SQL search.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "wait_for_completion_timeout", + "description": "Period to wait for complete results. Defaults to no timeout,\nmeaning the request waits for complete search results.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "is_running": { + "description": "If `true`, the search is still running. If false, the search has finished.\nThis value is only returned for async and saved synchronous searches. For\nCSV, TSV, and TXT responses, this value is returned in the `Async-partial`\nHTTP header.", + "type": "boolean" + }, + "is_partial": { + "description": "If `true`, the response does not contain complete search results. If `is_partial`\nis `true` and `is_running` is `true`, the search is still running. If `is_partial`\nis `true` but `is_running` is `false`, the results are partial due to a failure or\ntimeout. This value is only returned for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header.", + "type": "boolean" + }, + "columns": { + "description": "Column headings for the search results. Each object is a column.", + "type": "array", + "items": { + "$ref": "#/components/schemas/sql:Column" + } + }, + "cursor": { + "description": "Cursor for the next set of paginated results. For CSV, TSV, and\nTXT responses, this value is returned in the `Cursor` HTTP header.", + "type": "string" + }, + "rows": { + "description": "Values for the search results.", + "type": "array", + "items": { + "$ref": "#/components/schemas/sql:Row" + } + } + }, + "required": [ + "id", + "is_running", + "is_partial", + "rows" + ] + } + } + } + } + }, + "x-available-since": "7.15.0" + } + }, + "/_sql/async/status/{id}": { + "get": { + "tags": [ + "sql.get_async_status" + ], + "summary": "Returns the current status of an async SQL search or a stored synchronous SQL search", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-status-api.html" + }, + "operationId": "sql-get-async-status", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Identifier for the search.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "description": "Identifier for the search.", + "type": "string" + }, + "is_running": { + "description": "If `true`, the search is still running. If `false`, the search has finished.", + "type": "boolean" + }, + "is_partial": { + "description": "If `true`, the response does not contain complete search results. If `is_partial`\nis `true` and `is_running` is `true`, the search is still running. If `is_partial`\nis `true` but `is_running` is `false`, the results are partial due to a failure or\ntimeout.", + "type": "boolean" + }, + "start_time_in_millis": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "expiration_time_in_millis": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "completion_status": { + "$ref": "#/components/schemas/_types:uint" + } + }, + "required": [ + "id", + "is_running", + "is_partial", + "start_time_in_millis", + "expiration_time_in_millis" + ] + } + } + } + } + }, + "x-available-since": "7.15.0" + } + }, + "/_sql": { + "get": { + "tags": [ + "sql.query" + ], + "summary": "Executes a SQL request", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-search-api.html" + }, + "operationId": "sql-query-1", + "parameters": [ + { + "$ref": "#/components/parameters/sql.query#format" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/sql.query" + }, + "responses": { + "200": { + "$ref": "#/components/responses/sql.query#200" + } + }, + "x-available-since": "6.3.0" + }, + "post": { + "tags": [ + "sql.query" + ], + "summary": "Executes a SQL request", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-search-api.html" + }, + "operationId": "sql-query", + "parameters": [ + { + "$ref": "#/components/parameters/sql.query#format" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/sql.query" + }, + "responses": { + "200": { + "$ref": "#/components/responses/sql.query#200" + } + }, + "x-available-since": "6.3.0" + } + }, + "/_sql/translate": { + "get": { + "tags": [ + "sql.translate" + ], + "summary": "Translates SQL into Elasticsearch queries", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-translate-api.html" + }, + "operationId": "sql-translate-1", + "requestBody": { + "$ref": "#/components/requestBodies/sql.translate" + }, + "responses": { + "200": { + "$ref": "#/components/responses/sql.translate#200" + } + }, + "x-available-since": "6.3.0" + }, + "post": { + "tags": [ + "sql.translate" + ], + "summary": "Translates SQL into Elasticsearch queries", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-translate-api.html" + }, + "operationId": "sql-translate", + "requestBody": { + "$ref": "#/components/requestBodies/sql.translate" + }, + "responses": { + "200": { + "$ref": "#/components/responses/sql.translate#200" + } + }, + "x-available-since": "6.3.0" + } + }, + "/_synonyms/{id}": { + "get": { + "tags": [ + "synonyms.get_synonym" + ], + "summary": "Retrieves a synonym set", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonyms-set.html" + }, + "operationId": "synonyms-get-synonym", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "\"The id of the synonyms set to be retrieved", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "from", + "description": "Starting offset for query rules to be retrieved", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "size", + "description": "specifies a max number of query rules to retrieve", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "synonyms_set": { + "type": "array", + "items": { + "$ref": "#/components/schemas/synonyms._types:SynonymRuleRead" + } + } + }, + "required": [ + "count", + "synonyms_set" + ] + } + } + } + } + }, + "x-available-since": "8.10.0" + }, + "put": { + "tags": [ + "synonyms.put_synonym" + ], + "summary": "Creates or updates a synonym set", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonyms-set.html" + }, + "operationId": "synonyms-put-synonym", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The id of the synonyms set to be created or updated", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "synonyms_set": { + "description": "The synonym set information to update", + "type": "array", + "items": { + "$ref": "#/components/schemas/synonyms._types:SynonymRule" + } + } + }, + "required": [ + "synonyms_set" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + }, + "reload_analyzers_details": { + "$ref": "#/components/schemas/indices.reload_search_analyzers:ReloadResult" + } + }, + "required": [ + "result", + "reload_analyzers_details" + ] + } + } + } + } + }, + "x-available-since": "8.10.0" + }, + "delete": { + "tags": [ + "synonyms.delete_synonym" + ], + "summary": "Deletes a synonym set", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-synonyms-set.html" + }, + "operationId": "synonyms-delete-synonym", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The id of the synonyms set to be deleted", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "8.10.0" + } + }, + "/_synonyms/{set_id}/{rule_id}": { + "get": { + "tags": [ + "synonyms.get_synonym_rule" + ], + "summary": "Retrieves a synonym rule from a synonym set", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonym-rule.html" + }, + "operationId": "synonyms-get-synonym-rule", + "parameters": [ + { + "in": "path", + "name": "set_id", + "description": "The id of the synonym set to retrieve the synonym rule from", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "path", + "name": "rule_id", + "description": "The id of the synonym rule to retrieve", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/synonyms._types:SynonymRuleRead" + } + } + } + } + }, + "x-available-since": "8.10.0" + }, + "put": { + "tags": [ + "synonyms.put_synonym_rule" + ], + "summary": "Creates or updates a synonym rule in a synonym set", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonym-rule.html" + }, + "operationId": "synonyms-put-synonym-rule", + "parameters": [ + { + "in": "path", + "name": "set_id", + "description": "The id of the synonym set to be updated with the synonym rule", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "path", + "name": "rule_id", + "description": "The id of the synonym rule to be updated or created", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "synonyms": { + "$ref": "#/components/schemas/synonyms._types:SynonymString" + } + }, + "required": [ + "synonyms" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/synonyms._types:SynonymsUpdateResult" + } + } + } + } + }, + "x-available-since": "8.10.0" + }, + "delete": { + "tags": [ + "synonyms.delete_synonym_rule" + ], + "summary": "Deletes a synonym rule in a synonym set", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-synonym-rule.html" + }, + "operationId": "synonyms-delete-synonym-rule", + "parameters": [ + { + "in": "path", + "name": "set_id", + "description": "The id of the synonym set to be updated", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "path", + "name": "rule_id", + "description": "The id of the synonym rule to be deleted", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/synonyms._types:SynonymsUpdateResult" + } + } + } + } + }, + "x-available-since": "8.10.0" + } + }, + "/_synonyms": { + "get": { + "tags": [ + "synonyms.get_synonyms_sets" + ], + "summary": "Retrieves a summary of all defined synonym sets", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-synonyms-sets.html" + }, + "operationId": "synonyms-get-synonyms-sets", + "parameters": [ + { + "in": "query", + "name": "from", + "description": "Starting offset", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "size", + "description": "specifies a max number of results to get", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/synonyms.get_synonyms_sets:SynonymsSetItem" + } + } + }, + "required": [ + "count", + "results" + ] + } + } + } + } + }, + "x-available-since": "8.10.0" + } + }, + "/_tasks/{task_id}": { + "get": { + "tags": [ + "tasks.get" + ], + "summary": "Get task information", + "description": "Returns information about the tasks currently executing in the cluster.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html" + }, + "operationId": "tasks-get", + "parameters": [ + { + "in": "path", + "name": "task_id", + "description": "ID of the task.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "timeout", + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "wait_for_completion", + "description": "If `true`, the request blocks until the task has completed.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "completed": { + "type": "boolean" + }, + "task": { + "$ref": "#/components/schemas/tasks._types:TaskInfo" + }, + "response": { + "type": "object" + }, + "error": { + "$ref": "#/components/schemas/_types:ErrorCause" + } + }, + "required": [ + "completed", + "task" + ] + } + } + } + } + }, + "x-technical-preview": true, + "x-available-since": "5.0.0" + } + }, + "/{index}/_terms_enum": { + "get": { + "tags": [ + "terms_enum" + ], + "summary": "The terms enum API can be used to discover terms in the index that begin with the provided string", + "description": "It is designed for low-latency look-ups used in auto-complete scenarios.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-terms-enum.html" + }, + "operationId": "terms-enum", + "parameters": [ + { + "$ref": "#/components/parameters/terms_enum#index" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/terms_enum" + }, + "responses": { + "200": { + "$ref": "#/components/responses/terms_enum#200" + } + }, + "x-available-since": "7.14.0" + }, + "post": { + "tags": [ + "terms_enum" + ], + "summary": "The terms enum API can be used to discover terms in the index that begin with the provided string", + "description": "It is designed for low-latency look-ups used in auto-complete scenarios.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-terms-enum.html" + }, + "operationId": "terms-enum-1", + "parameters": [ + { + "$ref": "#/components/parameters/terms_enum#index" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/terms_enum" + }, + "responses": { + "200": { + "$ref": "#/components/responses/terms_enum#200" + } + }, + "x-available-since": "7.14.0" + } + }, + "/{index}/_termvectors/{id}": { + "get": { + "tags": [ + "termvectors" + ], + "summary": "Get term vector information", + "description": "Returns information and statistics about terms in the fields of a particular document.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html" + }, + "operationId": "termvectors", + "parameters": [ + { + "$ref": "#/components/parameters/termvectors#index" + }, + { + "$ref": "#/components/parameters/termvectors#id" + }, + { + "$ref": "#/components/parameters/termvectors#fields" + }, + { + "$ref": "#/components/parameters/termvectors#field_statistics" + }, + { + "$ref": "#/components/parameters/termvectors#offsets" + }, + { + "$ref": "#/components/parameters/termvectors#payloads" + }, + { + "$ref": "#/components/parameters/termvectors#positions" + }, + { + "$ref": "#/components/parameters/termvectors#preference" + }, + { + "$ref": "#/components/parameters/termvectors#realtime" + }, + { + "$ref": "#/components/parameters/termvectors#routing" + }, + { + "$ref": "#/components/parameters/termvectors#term_statistics" + }, + { + "$ref": "#/components/parameters/termvectors#version" + }, + { + "$ref": "#/components/parameters/termvectors#version_type" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/termvectors" + }, + "responses": { + "200": { + "$ref": "#/components/responses/termvectors#200" + } + } + }, + "post": { + "tags": [ + "termvectors" + ], + "summary": "Get term vector information", + "description": "Returns information and statistics about terms in the fields of a particular document.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html" + }, + "operationId": "termvectors-1", + "parameters": [ + { + "$ref": "#/components/parameters/termvectors#index" + }, + { + "$ref": "#/components/parameters/termvectors#id" + }, + { + "$ref": "#/components/parameters/termvectors#fields" + }, + { + "$ref": "#/components/parameters/termvectors#field_statistics" + }, + { + "$ref": "#/components/parameters/termvectors#offsets" + }, + { + "$ref": "#/components/parameters/termvectors#payloads" + }, + { + "$ref": "#/components/parameters/termvectors#positions" + }, + { + "$ref": "#/components/parameters/termvectors#preference" + }, + { + "$ref": "#/components/parameters/termvectors#realtime" + }, + { + "$ref": "#/components/parameters/termvectors#routing" + }, + { + "$ref": "#/components/parameters/termvectors#term_statistics" + }, + { + "$ref": "#/components/parameters/termvectors#version" + }, + { + "$ref": "#/components/parameters/termvectors#version_type" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/termvectors" + }, + "responses": { + "200": { + "$ref": "#/components/responses/termvectors#200" + } + } + } + }, + "/{index}/_termvectors": { + "get": { + "tags": [ + "termvectors" + ], + "summary": "Get term vector information", + "description": "Returns information and statistics about terms in the fields of a particular document.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html" + }, + "operationId": "termvectors-2", + "parameters": [ + { + "$ref": "#/components/parameters/termvectors#index" + }, + { + "$ref": "#/components/parameters/termvectors#fields" + }, + { + "$ref": "#/components/parameters/termvectors#field_statistics" + }, + { + "$ref": "#/components/parameters/termvectors#offsets" + }, + { + "$ref": "#/components/parameters/termvectors#payloads" + }, + { + "$ref": "#/components/parameters/termvectors#positions" + }, + { + "$ref": "#/components/parameters/termvectors#preference" + }, + { + "$ref": "#/components/parameters/termvectors#realtime" + }, + { + "$ref": "#/components/parameters/termvectors#routing" + }, + { + "$ref": "#/components/parameters/termvectors#term_statistics" + }, + { + "$ref": "#/components/parameters/termvectors#version" + }, + { + "$ref": "#/components/parameters/termvectors#version_type" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/termvectors" + }, + "responses": { + "200": { + "$ref": "#/components/responses/termvectors#200" + } + } + }, + "post": { + "tags": [ + "termvectors" + ], + "summary": "Get term vector information", + "description": "Returns information and statistics about terms in the fields of a particular document.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html" + }, + "operationId": "termvectors-3", + "parameters": [ + { + "$ref": "#/components/parameters/termvectors#index" + }, + { + "$ref": "#/components/parameters/termvectors#fields" + }, + { + "$ref": "#/components/parameters/termvectors#field_statistics" + }, + { + "$ref": "#/components/parameters/termvectors#offsets" + }, + { + "$ref": "#/components/parameters/termvectors#payloads" + }, + { + "$ref": "#/components/parameters/termvectors#positions" + }, + { + "$ref": "#/components/parameters/termvectors#preference" + }, + { + "$ref": "#/components/parameters/termvectors#realtime" + }, + { + "$ref": "#/components/parameters/termvectors#routing" + }, + { + "$ref": "#/components/parameters/termvectors#term_statistics" + }, + { + "$ref": "#/components/parameters/termvectors#version" + }, + { + "$ref": "#/components/parameters/termvectors#version_type" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/termvectors" + }, + "responses": { + "200": { + "$ref": "#/components/responses/termvectors#200" + } + } + } + }, + "/_transform/{transform_id}": { + "get": { + "tags": [ + "transform.get_transform" + ], + "summary": "Get transforms", + "description": "Retrieves configuration information for transforms.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html" + }, + "operationId": "transform-get-transform", + "parameters": [ + { + "$ref": "#/components/parameters/transform.get_transform#transform_id" + }, + { + "$ref": "#/components/parameters/transform.get_transform#allow_no_match" + }, + { + "$ref": "#/components/parameters/transform.get_transform#from" + }, + { + "$ref": "#/components/parameters/transform.get_transform#size" + }, + { + "$ref": "#/components/parameters/transform.get_transform#exclude_generated" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/transform.get_transform#200" + } + }, + "x-available-since": "7.5.0" + }, + "put": { + "tags": [ + "transform.put_transform" + ], + "summary": "Create a transform", + "description": "Creates a transform.\n\nA transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as\na data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a\nunique row per entity.\n\nYou must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If\nyou choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in\nthe pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values\nin the latest object.\n\nYou must have `create_index`, `index`, and `read` privileges on the destination index and `read` and\n`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the\ntransform remembers which roles the user that created it had at the time of creation and uses those same roles. If\nthose roles do not have the required privileges on the source and destination indices, the transform fails when it\nattempts unauthorized operations.\n\nNOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any\n`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do\nnot give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not\ngive users any privileges on `.data-frame-internal*` indices.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html" + }, + "operationId": "transform-put-transform", + "parameters": [ + { + "in": "path", + "name": "transform_id", + "description": "Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9),\nhyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "defer_validation", + "description": "When the transform is created, a series of validations occur to ensure its success. For example, there is a\ncheck for the existence of the source indices and a check that the destination index is not part of the source\nindex pattern. You can use this parameter to skip the checks, for example when the source index does not exist\nuntil after the transform is created. The validations are always run when you start the transform, however, with\nthe exception of privilege checks.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "dest": { + "$ref": "#/components/schemas/transform._types:Destination" + }, + "description": { + "description": "Free text description of the transform.", + "type": "string" + }, + "frequency": { + "$ref": "#/components/schemas/_types:Duration" + }, + "latest": { + "$ref": "#/components/schemas/transform._types:Latest" + }, + "_meta": { + "$ref": "#/components/schemas/_types:Metadata" + }, + "pivot": { + "$ref": "#/components/schemas/transform._types:Pivot" + }, + "retention_policy": { + "$ref": "#/components/schemas/transform._types:RetentionPolicyContainer" + }, + "settings": { + "$ref": "#/components/schemas/transform._types:Settings" + }, + "source": { + "$ref": "#/components/schemas/transform._types:Source" + }, + "sync": { + "$ref": "#/components/schemas/transform._types:SyncContainer" + } + }, + "required": [ + "dest", + "source" + ] + }, + "examples": { + "createTransformRequestExample1": { + "$ref": "#/components/examples/PutTransformRequestExample1" + }, + "createTransformRequestExample2": { + "$ref": "#/components/examples/PutTransformRequestExample2" + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + }, + "examples": { + "createTransformResponseExample1": { + "$ref": "#/components/examples/PutTransformResponseExample1" + } + } + } + } + } + }, + "x-available-since": "7.2.0" + }, + "delete": { + "tags": [ + "transform.delete_transform" + ], + "summary": "Delete a transform", + "description": "Deletes a transform.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html" + }, + "operationId": "transform-delete-transform", + "parameters": [ + { + "in": "path", + "name": "transform_id", + "description": "Identifier for the transform.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "force", + "description": "If this value is false, the transform must be stopped before it can be deleted. If true, the transform is\ndeleted regardless of its current state.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "delete_dest_index", + "description": "If this value is true, the destination index is deleted together with the transform. If false, the destination\nindex will not be deleted", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "7.5.0" + } + }, + "/_transform": { + "get": { + "tags": [ + "transform.get_transform" + ], + "summary": "Get transforms", + "description": "Retrieves configuration information for transforms.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html" + }, + "operationId": "transform-get-transform-1", + "parameters": [ + { + "$ref": "#/components/parameters/transform.get_transform#allow_no_match" + }, + { + "$ref": "#/components/parameters/transform.get_transform#from" + }, + { + "$ref": "#/components/parameters/transform.get_transform#size" + }, + { + "$ref": "#/components/parameters/transform.get_transform#exclude_generated" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/transform.get_transform#200" + } + }, + "x-available-since": "7.5.0" + } + }, + "/_transform/{transform_id}/_stats": { + "get": { + "tags": [ + "transform.get_transform_stats" + ], + "summary": "Get transform stats", + "description": "Retrieves usage information for transforms.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html" + }, + "operationId": "transform-get-transform-stats", + "parameters": [ + { + "in": "path", + "name": "transform_id", + "description": "Identifier for the transform. It can be a transform identifier or a\nwildcard expression. You can get information for all transforms by using\n`_all`, by specifying `*` as the ``, or by omitting the\n``.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "simple" + }, + { + "in": "query", + "name": "allow_no_match", + "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no transforms that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf this parameter is false, the request returns a 404 status code when\nthere are no matches or only partial matches.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "from", + "description": "Skips the specified number of transforms.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "size", + "description": "Specifies the maximum number of transforms to obtain.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Controls the time to wait for the stats", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "transforms": { + "type": "array", + "items": { + "$ref": "#/components/schemas/transform.get_transform_stats:TransformStats" + } + } + }, + "required": [ + "count", + "transforms" + ] + } + } + } + } + }, + "x-available-since": "7.5.0" + } + }, + "/_transform/{transform_id}/_preview": { + "get": { + "tags": [ + "transform.preview_transform" + ], + "summary": "Preview a transform", + "description": "Generates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html" + }, + "operationId": "transform-preview-transform", + "parameters": [ + { + "$ref": "#/components/parameters/transform.preview_transform#transform_id" + }, + { + "$ref": "#/components/parameters/transform.preview_transform#timeout" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/transform.preview_transform" + }, + "responses": { + "200": { + "$ref": "#/components/responses/transform.preview_transform#200" + } + }, + "x-available-since": "7.2.0" + }, + "post": { + "tags": [ + "transform.preview_transform" + ], + "summary": "Preview a transform", + "description": "Generates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html" + }, + "operationId": "transform-preview-transform-1", + "parameters": [ + { + "$ref": "#/components/parameters/transform.preview_transform#transform_id" + }, + { + "$ref": "#/components/parameters/transform.preview_transform#timeout" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/transform.preview_transform" + }, + "responses": { + "200": { + "$ref": "#/components/responses/transform.preview_transform#200" + } + }, + "x-available-since": "7.2.0" + } + }, + "/_transform/_preview": { + "get": { + "tags": [ + "transform.preview_transform" + ], + "summary": "Preview a transform", + "description": "Generates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html" + }, + "operationId": "transform-preview-transform-2", + "parameters": [ + { + "$ref": "#/components/parameters/transform.preview_transform#timeout" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/transform.preview_transform" + }, + "responses": { + "200": { + "$ref": "#/components/responses/transform.preview_transform#200" + } + }, + "x-available-since": "7.2.0" + }, + "post": { + "tags": [ + "transform.preview_transform" + ], + "summary": "Preview a transform", + "description": "Generates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html" + }, + "operationId": "transform-preview-transform-3", + "parameters": [ + { + "$ref": "#/components/parameters/transform.preview_transform#timeout" + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/transform.preview_transform" + }, + "responses": { + "200": { + "$ref": "#/components/responses/transform.preview_transform#200" + } + }, + "x-available-since": "7.2.0" + } + }, + "/_transform/{transform_id}/_reset": { + "post": { + "tags": [ + "transform.reset_transform" + ], + "summary": "Reset a transform", + "description": "Resets a transform.\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/reset-transform.html" + }, + "operationId": "transform-reset-transform", + "parameters": [ + { + "in": "path", + "name": "transform_id", + "description": "Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9),\nhyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "force", + "description": "If this value is `true`, the transform is reset regardless of its current state. If it's `false`, the transform\nmust be stopped before it can be reset.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "8.1.0" + } + }, + "/_transform/{transform_id}/_schedule_now": { + "post": { + "tags": [ + "transform.schedule_now_transform" + ], + "summary": "Schedule a transform to start now", + "description": "Instantly runs a transform to process data.\n\nIf you _schedule_now a transform, it will process the new data instantly,\nwithout waiting for the configured frequency interval. After _schedule_now API is called,\nthe transform will be processed again at now + frequency unless _schedule_now API\nis called again in the meantime.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/schedule-now-transform.html" + }, + "operationId": "transform-schedule-now-transform", + "parameters": [ + { + "in": "path", + "name": "transform_id", + "description": "Identifier for the transform.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "timeout", + "description": "Controls the time to wait for the scheduling to take place", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "8.7.0" + } + }, + "/_transform/{transform_id}/_start": { + "post": { + "tags": [ + "transform.start_transform" + ], + "summary": "Start a transform", + "description": "Starts a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html" + }, + "operationId": "transform-start-transform", + "parameters": [ + { + "in": "path", + "name": "transform_id", + "description": "Identifier for the transform.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "timeout", + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "from", + "description": "Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "7.5.0" + } + }, + "/_transform/{transform_id}/_stop": { + "post": { + "tags": [ + "transform.stop_transform" + ], + "summary": "Stop transforms", + "description": "Stops one or more transforms.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html" + }, + "operationId": "transform-stop-transform", + "parameters": [ + { + "in": "path", + "name": "transform_id", + "description": "Identifier for the transform. To stop multiple transforms, use a comma-separated list or a wildcard expression.\nTo stop all transforms, use `_all` or `*` as the identifier.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" + }, + { + "in": "query", + "name": "allow_no_match", + "description": "Specifies what to do when the request: contains wildcard expressions and there are no transforms that match;\ncontains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there\nare only partial matches.\n\nIf it is true, the API returns a successful acknowledgement message when there are no matches. When there are\nonly partial matches, the API stops the appropriate transforms.\n\nIf it is false, the request returns a 404 status code when there are no matches or only partial matches.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "force", + "description": "If it is true, the API forcefully stops the transforms.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Period to wait for a response when `wait_for_completion` is `true`. If no response is received before the\ntimeout expires, the request returns a timeout exception. However, the request continues processing and\neventually moves the transform to a STOPPED state.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "wait_for_checkpoint", + "description": "If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false,\nthe transform stops as soon as possible.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "wait_for_completion", + "description": "If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns\nimmediately and the indexer is stopped asynchronously in the background.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + } + }, + "x-available-since": "7.5.0" + } + }, + "/_transform/{transform_id}/_update": { + "post": { + "tags": [ + "transform.update_transform" + ], + "summary": "Update a transform", + "description": "Updates certain properties of a transform.\n\nAll updated properties except `description` do not take effect until after the transform starts the next checkpoint,\nthus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`\nprivileges for the source indices. You must also have `index` and `read` privileges for the destination index. When\nElasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the\ntime of update and runs with those privileges.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html" + }, + "operationId": "transform-update-transform", + "parameters": [ + { + "in": "path", + "name": "transform_id", + "description": "Identifier for the transform.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "defer_validation", + "description": "When true, deferrable validations are not run. This behavior may be\ndesired if the source index does not exist until after the transform is\ncreated.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Period to wait for a response. If no response is received before the\ntimeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "dest": { + "$ref": "#/components/schemas/transform._types:Destination" + }, + "description": { + "description": "Free text description of the transform.", + "type": "string" + }, + "frequency": { + "$ref": "#/components/schemas/_types:Duration" + }, + "_meta": { + "$ref": "#/components/schemas/_types:Metadata" + }, + "source": { + "$ref": "#/components/schemas/transform._types:Source" + }, + "settings": { + "$ref": "#/components/schemas/transform._types:Settings" + }, + "sync": { + "$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.", + "oneOf": [ + { + "$ref": "#/components/schemas/transform._types:RetentionPolicyContainer" + }, + { + "nullable": true, + "type": "string" + } + ] + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "authorization": { + "$ref": "#/components/schemas/ml._types:TransformAuthorization" + }, + "create_time": { + "type": "number" + }, + "description": { + "type": "string" + }, + "dest": { + "$ref": "#/components/schemas/_global.reindex:Destination" + }, + "frequency": { + "$ref": "#/components/schemas/_types:Duration" + }, + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "latest": { + "$ref": "#/components/schemas/transform._types:Latest" + }, + "pivot": { + "$ref": "#/components/schemas/transform._types:Pivot" + }, + "retention_policy": { + "$ref": "#/components/schemas/transform._types:RetentionPolicyContainer" + }, + "settings": { + "$ref": "#/components/schemas/transform._types:Settings" + }, + "source": { + "$ref": "#/components/schemas/_global.reindex:Source" + }, + "sync": { + "$ref": "#/components/schemas/transform._types:SyncContainer" + }, + "version": { + "$ref": "#/components/schemas/_types:VersionString" + }, + "_meta": { + "$ref": "#/components/schemas/_types:Metadata" + } + }, + "required": [ + "create_time", + "description", + "dest", + "id", + "settings", + "source", + "version" + ] + } + } + } + } + }, + "x-available-since": "7.2.0" + } + }, + "/{index}/_update/{id}": { + "post": { + "tags": [ + "update" + ], + "summary": "Update a document", + "description": "Updates a document by running a script or passing a partial document.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html" + }, + "operationId": "update", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "The name of the index", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "style": "simple" + }, + { + "in": "path", + "name": "id", + "description": "Document ID", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + { + "in": "query", + "name": "if_primary_term", + "description": "Only perform the operation if the document has this primary term.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "if_seq_no", + "description": "Only perform the operation if the document has this sequence number.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:SequenceNumber" + }, + "style": "form" + }, + { + "in": "query", + "name": "lang", + "description": "The script language.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "refresh", + "description": "If 'true', Elasticsearch refreshes the affected shards to make this operation\nvisible to search, if 'wait_for' then wait for a refresh to make this operation\nvisible to search, if 'false' do nothing with refreshes.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Refresh" + }, + "style": "form" + }, + { + "in": "query", + "name": "require_alias", + "description": "If true, the destination must be an index alias.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "retry_on_conflict", + "description": "Specify how many times should the operation be retried when a conflict occurs.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "routing", + "description": "Custom value used to route operations to a specific shard.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Routing" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Period to wait for dynamic mapping updates and active shards.\nThis guarantees Elasticsearch waits for at least the timeout before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "wait_for_active_shards", + "description": "The number of shard copies that must be active before proceeding with the operations.\nSet to 'all' or any positive integer up to the total number of shards in the index\n(number_of_replicas+1). Defaults to 1 meaning the primary shard.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:WaitForActiveShards" + }, + "style": "form" + }, + { + "in": "query", + "name": "_source", + "description": "Set to false to disable source retrieval. You can also specify a comma-separated\nlist of the fields you want to retrieve.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_global.search._types:SourceConfigParam" + }, + "style": "form" + }, + { + "in": "query", + "name": "_source_excludes", + "description": "Specify the source fields you want to exclude.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + { + "in": "query", + "name": "_source_includes", + "description": "Specify the source fields you want to retrieve.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "detect_noop": { + "description": "Set to false to disable setting 'result' in the response\nto 'noop' if no change to the document occurred.", + "type": "boolean" + }, + "doc": { + "description": "A partial update to an existing document.", + "type": "object" + }, + "doc_as_upsert": { + "description": "Set to true to use the contents of 'doc' as the value of 'upsert'", + "type": "boolean" + }, + "script": { + "$ref": "#/components/schemas/_types:Script" + }, + "scripted_upsert": { + "description": "Set to true to execute the script whether or not the document exists.", + "type": "boolean" + }, + "_source": { + "$ref": "#/components/schemas/_global.search._types:SourceConfig" + }, + "upsert": { + "description": "If the document does not already exist, the contents of 'upsert' are inserted as a\nnew document. If the document exists, the 'script' is executed.", + "type": "object" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_global.update:UpdateWriteResponseBase" + } + } + } + } + } + } + }, + "/{index}/_update_by_query": { + "post": { + "tags": [ + "update_by_query" + ], + "summary": "Update documents", + "description": "Updates documents that match the specified query.\nIf no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html" + }, + "operationId": "update-by-query", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "Comma-separated list of data streams, indices, and aliases to search.\nSupports wildcards (`*`).\nTo search all data streams or indices, omit this parameter or use `*` or `_all`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + { + "in": "query", + "name": "allow_no_indices", + "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.\nFor example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "analyzer", + "description": "Analyzer to use for the query string.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "analyze_wildcard", + "description": "If `true`, wildcard and prefix queries are analyzed.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "conflicts", + "description": "What to do if update by query hits version conflicts: `abort` or `proceed`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Conflicts" + }, + "style": "form" + }, + { + "in": "query", + "name": "default_operator", + "description": "The default operator for query string query: `AND` or `OR`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types.query_dsl:Operator" + }, + "style": "form" + }, + { + "in": "query", + "name": "df", + "description": "Field to use as default where no field prefix is given in the query string.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "expand_wildcards", + "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + { + "in": "query", + "name": "from", + "description": "Starting offset (default: 0)", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "ignore_unavailable", + "description": "If `false`, the request returns an error if it targets a missing or closed index.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "lenient", + "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "max_docs", + "description": "Maximum number of documents to process.\nDefaults to all documents.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "pipeline", + "description": "ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "preference", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "refresh", + "description": "If `true`, Elasticsearch refreshes affected shards to make the operation visible to search.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "request_cache", + "description": "If `true`, the request cache is used for this request.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "requests_per_second", + "description": "The throttle for this request in sub-requests per second.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "routing", + "description": "Custom value used to route operations to a specific shard.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Routing" + }, + "style": "form" + }, + { + "in": "query", + "name": "scroll", + "description": "Period to retain the search context for scrolling.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "scroll_size", + "description": "Size of the scroll request that powers the operation.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "search_timeout", + "description": "Explicit timeout for each search request.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "search_type", + "description": "The type of the search operation. Available options: `query_then_fetch`, `dfs_query_then_fetch`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:SearchType" + }, + "style": "form" + }, + { + "in": "query", + "name": "slices", + "description": "The number of slices this task should be divided into.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Slices" + }, + "style": "form" + }, + { + "in": "query", + "name": "sort", + "description": "A comma-separated list of : pairs.", + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form" + }, + { + "in": "query", + "name": "stats", + "description": "Specific `tag` of the request for logging and statistical purposes.", + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form" + }, + { + "in": "query", + "name": "terminate_after", + "description": "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.\nUse with caution.\nElasticsearch applies this parameter to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "version", + "description": "If `true`, returns the document version as part of a hit.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "version_type", + "description": "Should the document increment the version number (internal) on hit or not (reindex)", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "in": "query", + "name": "wait_for_active_shards", + "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:WaitForActiveShards" + }, + "style": "form" + }, + { + "in": "query", + "name": "wait_for_completion", + "description": "If `true`, the request blocks until the operation is complete.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "max_docs": { + "description": "The maximum number of documents to update.", + "type": "number" + }, + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "script": { + "$ref": "#/components/schemas/_types:Script" + }, + "slice": { + "$ref": "#/components/schemas/_types:SlicedScroll" + }, + "conflicts": { + "$ref": "#/components/schemas/_types:Conflicts" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "batches": { + "type": "number" + }, + "failures": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:BulkIndexByScrollFailure" + } + }, + "noops": { + "type": "number" + }, + "deleted": { + "type": "number" + }, + "requests_per_second": { + "type": "number" + }, + "retries": { + "$ref": "#/components/schemas/_types:Retries" + }, + "task": { + "$ref": "#/components/schemas/_types:TaskId" + }, + "timed_out": { + "type": "boolean" + }, + "took": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + }, + "total": { + "type": "number" + }, + "updated": { + "type": "number" + }, + "version_conflicts": { + "type": "number" + }, + "throttled": { + "$ref": "#/components/schemas/_types:Duration" + }, + "throttled_millis": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + }, + "throttled_until": { + "$ref": "#/components/schemas/_types:Duration" + }, + "throttled_until_millis": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + } + } + } + } + } + } + }, + "x-available-since": "2.4.0" + } + } + }, + "components": { + "responses": { + "async_search.submit#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/async_search._types:AsyncSearchDocumentResponseBase" + } + } + } + }, + "bulk#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "errors": { + "type": "boolean" + }, + "items": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_global.bulk:ResponseItem" + }, + "minProperties": 1, + "maxProperties": 1 + } + }, + "took": { + "type": "number" + }, + "ingest_took": { + "type": "number" + } + }, + "required": [ + "errors", + "items", + "took" + ] + } + } + } + }, + "cat.aliases#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/cat.aliases:AliasesRecord" + } + } + } + } + }, + "cat.component_templates#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/cat.component_templates:ComponentTemplate" + } + } + } + } + }, + "cat.count#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/cat.count:CountRecord" + } + } + } + } + }, + "cat.indices#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/cat.indices:IndicesRecord" + } + } + } + } + }, + "cat.ml_data_frame_analytics#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/cat.ml_data_frame_analytics:DataFrameAnalyticsRecord" + } + } + } + } + }, + "cat.ml_datafeeds#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/cat.ml_datafeeds:DatafeedsRecord" + } + } + } + } + }, + "cat.ml_jobs#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/cat.ml_jobs:JobsRecord" + } + } + } + } + }, + "cat.ml_trained_models#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/cat.ml_trained_models:TrainedModelsRecord" + } + } + } + } + }, + "cat.transforms#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/cat.transforms:TransformsRecord" + } + } + } + } + }, + "clear_scroll#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "succeeded": { + "type": "boolean" + }, + "num_freed": { + "type": "number" + } + }, + "required": [ + "succeeded", + "num_freed" + ] + } + } + } + }, + "cluster.get_component_template#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "component_templates": { + "type": "array", + "items": { + "$ref": "#/components/schemas/cluster._types:ComponentTemplate" + } + } + }, + "required": [ + "component_templates" + ] + } + } + } + }, + "cluster.put_component_template#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + }, + "connector.put#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + }, + "id": { + "$ref": "#/components/schemas/_types:Id" + } + }, + "required": [ + "result", + "id" + ] + } + } + } + }, + "count#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "_shards": { + "$ref": "#/components/schemas/_types:ShardStatistics" + } + }, + "required": [ + "count", + "_shards" + ] + } + } + } + }, + "create#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:WriteResponseBase" + } + } + } + }, + "enrich.get_policy#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "policies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/enrich._types:Summary" + } + } + }, + "required": [ + "policies" + ] + } + } + } + }, + "eql.search#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/eql._types:EqlSearchResponseBase" + } + } + } + }, + "explain#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "_index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "matched": { + "type": "boolean" + }, + "explanation": { + "$ref": "#/components/schemas/_global.explain:ExplanationDetail" + }, + "get": { + "$ref": "#/components/schemas/_types:InlineGet" + } + }, + "required": [ + "_index", + "_id", + "matched" + ] + } + } + } + }, + "field_caps#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "indices": { + "$ref": "#/components/schemas/_types:Indices" + }, + "fields": { + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_global.field_caps:FieldCapability" + } + } + } + }, + "required": [ + "indices", + "fields" + ] + } + } + } + }, + "graph.explore#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "connections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/graph._types:Connection" + } + }, + "failures": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:ShardFailure" + } + }, + "timed_out": { + "type": "boolean" + }, + "took": { + "type": "number" + }, + "vertices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/graph._types:Vertex" + } + } + }, + "required": [ + "connections", + "failures", + "timed_out", + "took", + "vertices" + ] + } + } + } + }, + "index#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:WriteResponseBase" + } + } + } + }, + "indices.analyze#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "detail": { + "$ref": "#/components/schemas/indices.analyze:AnalyzeDetail" + }, + "tokens": { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.analyze:AnalyzeToken" + } + } + } + } + } + } + }, + "indices.data_streams_stats#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "_shards": { + "$ref": "#/components/schemas/_types:ShardStatistics" + }, + "backing_indices": { + "description": "Total number of backing indices for the selected data streams.", + "type": "number" + }, + "data_stream_count": { + "description": "Total number of selected data streams.", + "type": "number" + }, + "data_streams": { + "description": "Contains statistics for the selected data streams.", + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.data_streams_stats:DataStreamsStatsItem" + } + }, + "total_store_sizes": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "total_store_size_bytes": { + "description": "Total size, in bytes, of all shards for the selected data streams.", + "type": "number" + } + }, + "required": [ + "_shards", + "backing_indices", + "data_stream_count", + "data_streams", + "total_store_size_bytes" + ] + } + } + } + }, + "indices.delete_alias#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + }, + "indices.exists_alias#200": { + "description": "", + "content": { + "application/json": {} + } + }, + "indices.get_alias#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/indices.get_alias:IndexAliases" + } + } + } + } + }, + "indices.get_data_stream#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data_streams": { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices._types:DataStream" + } + } + }, + "required": [ + "data_streams" + ] + } + } + } + }, + "indices.get_index_template#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "index_templates": { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.get_index_template:IndexTemplateItem" + } + } + }, + "required": [ + "index_templates" + ] + } + } + } + }, + "indices.get_mapping#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/indices.get_mapping:IndexMappingRecord" + } + } + } + } + }, + "indices.get_settings#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/indices._types:IndexState" + } + } + } + } + }, + "indices.put_alias#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + }, + "indices.put_index_template#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + }, + "indices.put_mapping#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:IndicesResponseBase" + } + } + } + }, + "indices.put_settings#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + }, + "indices.put_template#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + }, + "indices.refresh#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:ShardsOperationResponseBase" + } + } + } + }, + "indices.rollover#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "acknowledged": { + "type": "boolean" + }, + "conditions": { + "type": "object", + "additionalProperties": { + "type": "boolean" + } + }, + "dry_run": { + "type": "boolean" + }, + "new_index": { + "type": "string" + }, + "old_index": { + "type": "string" + }, + "rolled_over": { + "type": "boolean" + }, + "shards_acknowledged": { + "type": "boolean" + } + }, + "required": [ + "acknowledged", + "conditions", + "dry_run", + "new_index", + "old_index", + "rolled_over", + "shards_acknowledged" + ] + } + } + } + }, + "indices.simulate_template#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "overlapping": { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.simulate_template:Overlapping" + } + }, + "template": { + "$ref": "#/components/schemas/indices.simulate_template:Template" + } + }, + "required": [ + "template" + ] + } + } + } + }, + "indices.validate_query#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "explanations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.validate_query:IndicesValidationExplanation" + } + }, + "_shards": { + "$ref": "#/components/schemas/_types:ShardStatistics" + }, + "valid": { + "type": "boolean" + }, + "error": { + "type": "string" + } + }, + "required": [ + "valid" + ] + } + } + } + }, + "inference.delete#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/inference._types:DeleteInferenceEndpointResult" + } + } + } + }, + "inference.get#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "endpoints": { + "type": "array", + "items": { + "$ref": "#/components/schemas/inference._types:InferenceEndpointInfo" + } + } + }, + "required": [ + "endpoints" + ] + } + } + } + }, + "inference.inference#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/inference._types:InferenceResult" + } + } + } + }, + "inference.put#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/inference._types:InferenceEndpointInfo" + } + } + } + }, + "ingest.get_pipeline#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/ingest._types:Pipeline" + } + } + } + } + }, + "ingest.simulate#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "docs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ingest.simulate:PipelineSimulation" + } + } + }, + "required": [ + "docs" + ] + } + } + } + }, + "logstash.get_pipeline#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/logstash._types:Pipeline" + } + } + } + } + }, + "mget#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "docs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.mget:ResponseItem" + } + } + }, + "required": [ + "docs" + ] + } + } + } + }, + "ml.get_calendars#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "calendars": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ml.get_calendars:Calendar" + } + }, + "count": { + "type": "number" + } + }, + "required": [ + "calendars", + "count" + ] + } + } + } + }, + "ml.get_data_frame_analytics#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "data_frame_analytics": { + "description": "An array of data frame analytics job resources, which are sorted by the id value in ascending order.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:DataframeAnalyticsSummary" + } + } + }, + "required": [ + "count", + "data_frame_analytics" + ] + } + } + } + }, + "ml.get_data_frame_analytics_stats#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "data_frame_analytics": { + "description": "An array of objects that contain usage information for data frame analytics jobs, which are sorted by the id value in ascending order.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:DataframeAnalytics" + } + } + }, + "required": [ + "count", + "data_frame_analytics" + ] + } + } + } + }, + "ml.get_datafeed_stats#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "datafeeds": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:DatafeedStats" + } + } + }, + "required": [ + "count", + "datafeeds" + ] + } + } + } + }, + "ml.get_datafeeds#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "datafeeds": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:Datafeed" + } + } + }, + "required": [ + "count", + "datafeeds" + ] + } + } + } + }, + "ml.get_filters#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "filters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:Filter" + } + } + }, + "required": [ + "count", + "filters" + ] + } + } + } + }, + "ml.get_job_stats#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "jobs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:JobStats" + } + } + }, + "required": [ + "count", + "jobs" + ] + } + } + } + }, + "ml.get_jobs#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "jobs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:Job" + } + } + }, + "required": [ + "count", + "jobs" + ] + } + } + } + }, + "ml.get_overall_buckets#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "overall_buckets": { + "description": "Array of overall bucket objects", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:OverallBucket" + } + } + }, + "required": [ + "count", + "overall_buckets" + ] + } + } + } + }, + "ml.get_trained_models#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "trained_model_configs": { + "description": "An array of trained model resources, which are sorted by the model_id value in ascending order.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:TrainedModelConfig" + } + } + }, + "required": [ + "count", + "trained_model_configs" + ] + } + } + } + }, + "ml.get_trained_models_stats#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "count": { + "description": "The total number of trained model statistics that matched the requested ID patterns. Could be higher than the number of items in the trained_model_stats array as the size of the array is restricted by the supplied size parameter.", + "type": "number" + }, + "trained_model_stats": { + "description": "An array of trained model statistics, which are sorted by the model_id value in ascending order.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:TrainedModelStats" + } + } + }, + "required": [ + "count", + "trained_model_stats" + ] + } + } + } + }, + "ml.infer_trained_model#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "inference_results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:InferenceResponseResult" + } + } + }, + "required": [ + "inference_results" + ] + } + } + } + }, + "ml.preview_data_frame_analytics#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "feature_values": { + "description": "An array of objects that contain feature name and value pairs. The features have been processed and indicate what will be sent to the model for training.", + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "required": [ + "feature_values" + ] + } + } + } + }, + "ml.preview_datafeed#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + } + } + } + }, + "msearch#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_global.msearch:MultiSearchResult" + } + } + } + }, + "msearch_template#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_global.msearch:MultiSearchResult" + } + } + } + }, + "mtermvectors#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "docs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.mtermvectors:TermVectorsResult" + } + } + }, + "required": [ + "docs" + ] + } + } + } + }, + "put_script#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + } + } + } + }, + "rank_eval#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "metric_score": { + "description": "The overall evaluation quality calculated by the defined metric", + "type": "number" + }, + "details": { + "description": "The details section contains one entry for every query in the original requests section, keyed by the search request id", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_global.rank_eval:RankEvalMetricDetail" + } + }, + "failures": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "required": [ + "metric_score", + "details", + "failures" + ] + } + } + } + }, + "render_search_template#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "template_output": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "required": [ + "template_output" + ] + } + } + } + }, + "scripts_painless_execute#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object" + } + }, + "required": [ + "result" + ] + } + } + } + }, + "scroll#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_global.search:ResponseBody" + } + } + } + }, + "search#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_global.search:ResponseBody" + } + } + } + }, + "search_application.get_behavioral_analytics#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/search_application._types:AnalyticsCollection" + } + } + } + } + }, + "search_application.search#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_global.search:ResponseBody" + } + } + } + }, + "search_mvt#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types:MapboxVectorTiles" + } + } + } + }, + "search_template#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "took": { + "type": "number" + }, + "timed_out": { + "type": "boolean" + }, + "_shards": { + "$ref": "#/components/schemas/_types:ShardStatistics" + }, + "hits": { + "$ref": "#/components/schemas/_global.search._types:HitsMetadata" + }, + "aggregations": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:Aggregate" + } + }, + "_clusters": { + "$ref": "#/components/schemas/_types:ClusterStatistics" + }, + "fields": { + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "max_score": { + "type": "number" + }, + "num_reduce_phases": { + "type": "number" + }, + "profile": { + "$ref": "#/components/schemas/_global.search._types:Profile" + }, + "pit_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "_scroll_id": { + "$ref": "#/components/schemas/_types:ScrollId" + }, + "suggest": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.search._types:Suggest" + } + } + }, + "terminated_early": { + "type": "boolean" + } + }, + "required": [ + "took", + "timed_out", + "_shards", + "hits" + ] + } + } + } + }, + "security.create_api_key#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "api_key": { + "description": "Generated API key.", + "type": "string" + }, + "expiration": { + "description": "Expiration in milliseconds for the API key.", + "type": "number" + }, + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "name": { + "$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 (`:`).", + "x-available-since": "7.16.0", + "type": "string" + } + }, + "required": [ + "api_key", + "id", + "name", + "encoded" + ] + } + } + } + }, + "security.has_privileges#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "application": { + "$ref": "#/components/schemas/security.has_privileges:ApplicationsPrivileges" + }, + "cluster": { + "type": "object", + "additionalProperties": { + "type": "boolean" + } + }, + "has_all_requested": { + "type": "boolean" + }, + "index": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/security.has_privileges:Privileges" + } + }, + "username": { + "$ref": "#/components/schemas/_types:Username" + } + }, + "required": [ + "application", + "cluster", + "has_all_requested", + "index", + "username" + ] + } + } + } + }, + "security.query_api_keys#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "description": "The total number of API keys found.", + "type": "number" + }, + "count": { + "description": "The number of API keys returned in the response.", + "type": "number" + }, + "api_keys": { + "description": "A list of API key information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/security._types:ApiKey" + } + }, + "aggregations": { + "description": "The aggregations result, if requested.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/security.query_api_keys:ApiKeyAggregate" + } + } + }, + "required": [ + "total", + "count", + "api_keys" + ] + } + } + } + }, + "sql.query#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "is_running": { + "description": "If `true`, the search is still running. If false, the search has finished.\nThis value is only returned for async and saved synchronous searches. For\nCSV, TSV, and TXT responses, this value is returned in the `Async-partial`\nHTTP header.", + "type": "boolean" + }, + "is_partial": { + "description": "If `true`, the response does not contain complete search results. If `is_partial`\nis `true` and `is_running` is `true`, the search is still running. If `is_partial`\nis `true` but `is_running` is `false`, the results are partial due to a failure or\ntimeout. This value is only returned for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header.", + "type": "boolean" + }, + "columns": { + "description": "Column headings for the search results. Each object is a column.", + "type": "array", + "items": { + "$ref": "#/components/schemas/sql:Column" + } + }, + "cursor": { + "description": "Cursor for the next set of paginated results. For CSV, TSV, and\nTXT responses, this value is returned in the `Cursor` HTTP header.", + "type": "string" + }, + "rows": { + "description": "Values for the search results.", + "type": "array", + "items": { + "$ref": "#/components/schemas/sql:Row" + } + } + }, + "required": [ + "rows" + ] + } + } + } + }, + "sql.translate#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:AggregationContainer" + } + }, + "size": { + "type": "number" + }, + "_source": { + "$ref": "#/components/schemas/_global.search._types:SourceConfig" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:FieldAndFormat" + } + }, + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "sort": { + "$ref": "#/components/schemas/_types:Sort" + } + } + } + } + } + }, + "terms_enum#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "_shards": { + "$ref": "#/components/schemas/_types:ShardStatistics" + }, + "terms": { + "type": "array", + "items": { + "type": "string" + } + }, + "complete": { + "type": "boolean" + } + }, + "required": [ + "_shards", + "terms", + "complete" + ] + } + } + } + }, + "termvectors#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "found": { + "type": "boolean" + }, + "_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "_index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "term_vectors": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_global.termvectors:TermVector" + } + }, + "took": { + "type": "number" + }, + "_version": { + "$ref": "#/components/schemas/_types:VersionNumber" + } + }, + "required": [ + "found", + "_index", + "took", + "_version" + ] + } + } + } + }, + "transform.get_transform#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "transforms": { + "type": "array", + "items": { + "$ref": "#/components/schemas/transform.get_transform:TransformSummary" + } + } + }, + "required": [ + "count", + "transforms" + ] + } + } + } + }, + "transform.preview_transform#200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "generated_dest_index": { + "$ref": "#/components/schemas/indices._types:IndexState" + }, + "preview": { + "type": "array", + "items": { + "type": "object" + } + } + }, + "required": [ + "generated_dest_index", + "preview" + ] + } + } + } + } + }, + "parameters": { + "async_search.submit#index": { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + "async_search.submit#wait_for_completion_timeout": { + "in": "query", + "name": "wait_for_completion_timeout", + "description": "Blocks and waits until the search is completed up to a certain timeout.\nWhen the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "async_search.submit#keep_on_completion": { + "in": "query", + "name": "keep_on_completion", + "description": "If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "async_search.submit#keep_alive": { + "in": "query", + "name": "keep_alive", + "description": "Specifies how long the async search needs to be available.\nOngoing async searches and any saved search results are deleted after this period.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "async_search.submit#allow_no_indices": { + "in": "query", + "name": "allow_no_indices", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "async_search.submit#allow_partial_search_results": { + "in": "query", + "name": "allow_partial_search_results", + "description": "Indicate if an error should be returned if there is a partial search failure or timeout", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "async_search.submit#analyzer": { + "in": "query", + "name": "analyzer", + "description": "The analyzer to use for the query string", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "async_search.submit#analyze_wildcard": { + "in": "query", + "name": "analyze_wildcard", + "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "async_search.submit#batched_reduce_size": { + "in": "query", + "name": "batched_reduce_size", + "description": "Affects how often partial results become available, which happens whenever shard results are reduced.\nA partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default).", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "async_search.submit#ccs_minimize_roundtrips": { + "in": "query", + "name": "ccs_minimize_roundtrips", + "description": "The default value is the only supported value.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "async_search.submit#default_operator": { + "in": "query", + "name": "default_operator", + "description": "The default operator for query string query (AND or OR)", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types.query_dsl:Operator" + }, + "style": "form" + }, + "async_search.submit#df": { + "in": "query", + "name": "df", + "description": "The field to use as default where no field prefix is given in the query string", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "async_search.submit#docvalue_fields": { + "in": "query", + "name": "docvalue_fields", + "description": "A comma-separated list of fields to return as the docvalue representation of a field for each hit", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + "async_search.submit#expand_wildcards": { + "in": "query", + "name": "expand_wildcards", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + "async_search.submit#explain": { + "in": "query", + "name": "explain", + "description": "Specify whether to return detailed information about score computation as part of a hit", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "async_search.submit#ignore_throttled": { + "in": "query", + "name": "ignore_throttled", + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "async_search.submit#ignore_unavailable": { + "in": "query", + "name": "ignore_unavailable", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "async_search.submit#lenient": { + "in": "query", + "name": "lenient", + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "async_search.submit#max_concurrent_shard_requests": { + "in": "query", + "name": "max_concurrent_shard_requests", + "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "async_search.submit#min_compatible_shard_node": { + "in": "query", + "name": "min_compatible_shard_node", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:VersionString" + }, + "style": "form" + }, + "async_search.submit#preference": { + "in": "query", + "name": "preference", + "description": "Specify the node or shard the operation should be performed on (default: random)", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "async_search.submit#pre_filter_shard_size": { + "in": "query", + "name": "pre_filter_shard_size", + "description": "The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "async_search.submit#request_cache": { + "in": "query", + "name": "request_cache", + "description": "Specify if request cache should be used for this request or not, defaults to true", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "async_search.submit#routing": { + "in": "query", + "name": "routing", + "description": "A comma-separated list of specific routing values", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Routing" + }, + "style": "form" + }, + "async_search.submit#scroll": { + "in": "query", + "name": "scroll", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "async_search.submit#search_type": { + "in": "query", + "name": "search_type", + "description": "Search operation type", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:SearchType" + }, + "style": "form" + }, + "async_search.submit#stats": { + "in": "query", + "name": "stats", + "description": "Specific 'tag' of the request for logging and statistical purposes", + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form" + }, + "async_search.submit#stored_fields": { + "in": "query", + "name": "stored_fields", + "description": "A comma-separated list of stored fields to return as part of a hit", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + "async_search.submit#suggest_field": { + "in": "query", + "name": "suggest_field", + "description": "Specifies which field to use for suggestions.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Field" + }, + "style": "form" + }, + "async_search.submit#suggest_mode": { + "in": "query", + "name": "suggest_mode", + "description": "Specify suggest mode", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:SuggestMode" + }, + "style": "form" + }, + "async_search.submit#suggest_size": { + "in": "query", + "name": "suggest_size", + "description": "How many suggestions to return in response", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "async_search.submit#suggest_text": { + "in": "query", + "name": "suggest_text", + "description": "The source text for which the suggestions should be returned.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "async_search.submit#terminate_after": { + "in": "query", + "name": "terminate_after", + "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "async_search.submit#timeout": { + "in": "query", + "name": "timeout", + "description": "Explicit operation timeout", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "async_search.submit#track_total_hits": { + "in": "query", + "name": "track_total_hits", + "description": "Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_global.search._types:TrackHits" + }, + "style": "form" + }, + "async_search.submit#track_scores": { + "in": "query", + "name": "track_scores", + "description": "Whether to calculate and return scores even if they are not used for sorting", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "async_search.submit#typed_keys": { + "in": "query", + "name": "typed_keys", + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "async_search.submit#rest_total_hits_as_int": { + "in": "query", + "name": "rest_total_hits_as_int", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "async_search.submit#version": { + "in": "query", + "name": "version", + "description": "Specify whether to return document version as part of a hit", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "async_search.submit#_source": { + "in": "query", + "name": "_source", + "description": "True or false to return the _source field or not, or a list of fields to return", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_global.search._types:SourceConfigParam" + }, + "style": "form" + }, + "async_search.submit#_source_excludes": { + "in": "query", + "name": "_source_excludes", + "description": "A list of fields to exclude from the returned _source field", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + "async_search.submit#_source_includes": { + "in": "query", + "name": "_source_includes", + "description": "A list of fields to extract and return from the _source field", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + "async_search.submit#seq_no_primary_term": { + "in": "query", + "name": "seq_no_primary_term", + "description": "Specify whether to return sequence number and primary term of the last modification of each hit", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "async_search.submit#q": { + "in": "query", + "name": "q", + "description": "Query in the Lucene query string syntax", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "async_search.submit#size": { + "in": "query", + "name": "size", + "description": "Number of hits to return (default: 10)", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "async_search.submit#from": { + "in": "query", + "name": "from", + "description": "Starting offset (default: 0)", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "async_search.submit#sort": { + "in": "query", + "name": "sort", + "description": "A comma-separated list of : pairs", + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "style": "form" + }, + "bulk#index": { + "in": "path", + "name": "index", + "description": "Name of the data stream, index, or index alias to perform bulk actions on.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "style": "simple" + }, + "bulk#pipeline": { + "in": "query", + "name": "pipeline", + "description": "ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "bulk#refresh": { + "in": "query", + "name": "refresh", + "description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.\nValid values: `true`, `false`, `wait_for`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Refresh" + }, + "style": "form" + }, + "bulk#routing": { + "in": "query", + "name": "routing", + "description": "Custom value used to route operations to a specific shard.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Routing" + }, + "style": "form" + }, + "bulk#_source": { + "in": "query", + "name": "_source", + "description": "`true` or `false` to return the `_source` field or not, or a list of fields to return.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_global.search._types:SourceConfigParam" + }, + "style": "form" + }, + "bulk#_source_excludes": { + "in": "query", + "name": "_source_excludes", + "description": "A comma-separated list of source fields to exclude from the response.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + "bulk#_source_includes": { + "in": "query", + "name": "_source_includes", + "description": "A comma-separated list of source fields to include in the response.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + "bulk#timeout": { + "in": "query", + "name": "timeout", + "description": "Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "bulk#wait_for_active_shards": { + "in": "query", + "name": "wait_for_active_shards", + "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:WaitForActiveShards" + }, + "style": "form" + }, + "bulk#require_alias": { + "in": "query", + "name": "require_alias", + "description": "If `true`, the request’s actions must target an index alias.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "cat.aliases#name": { + "in": "path", + "name": "name", + "description": "A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "simple" + }, + "cat.aliases#expand_wildcards": { + "in": "query", + "name": "expand_wildcards", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + "cat.component_templates#name": { + "in": "path", + "name": "name", + "description": "The name of the component template. Accepts wildcard expressions. If omitted, all component templates are returned.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple" + }, + "cat.count#index": { + "in": "path", + "name": "index", + "description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + "cat.indices#index": { + "in": "path", + "name": "index", + "description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + "cat.indices#bytes": { + "in": "query", + "name": "bytes", + "description": "The unit used to display byte values.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Bytes" + }, + "style": "form" + }, + "cat.indices#expand_wildcards": { + "in": "query", + "name": "expand_wildcards", + "description": "The type of index that wildcard patterns can match.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + "cat.indices#health": { + "in": "query", + "name": "health", + "description": "The health status used to limit returned indices. By default, the response includes indices of any health status.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:HealthStatus" + }, + "style": "form" + }, + "cat.indices#include_unloaded_segments": { + "in": "query", + "name": "include_unloaded_segments", + "description": "If true, the response includes information from segments that are not loaded into memory.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "cat.indices#pri": { + "in": "query", + "name": "pri", + "description": "If true, the response only includes information from primary shards.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "cat.indices#time": { + "in": "query", + "name": "time", + "description": "The unit used to display time values.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:TimeUnit" + }, + "style": "form" + }, + "cat.ml_data_frame_analytics#id": { + "in": "path", + "name": "id", + "description": "The ID of the data frame analytics to fetch", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "cat.ml_data_frame_analytics#allow_no_match": { + "in": "query", + "name": "allow_no_match", + "description": "Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified)", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "cat.ml_data_frame_analytics#bytes": { + "in": "query", + "name": "bytes", + "description": "The unit in which to display byte values", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Bytes" + }, + "style": "form" + }, + "cat.ml_data_frame_analytics#h": { + "in": "query", + "name": "h", + "description": "Comma-separated list of column names to display.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/cat._types:CatDfaColumns" + }, + "style": "form" + }, + "cat.ml_data_frame_analytics#s": { + "in": "query", + "name": "s", + "description": "Comma-separated list of column names or column aliases used to sort the\nresponse.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/cat._types:CatDfaColumns" + }, + "style": "form" + }, + "cat.ml_data_frame_analytics#time": { + "in": "query", + "name": "time", + "description": "Unit used to display time values.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "cat.ml_datafeeds#datafeed_id": { + "in": "path", + "name": "datafeed_id", + "description": "A numerical character string that uniquely identifies the datafeed.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "cat.ml_datafeeds#allow_no_match": { + "in": "query", + "name": "allow_no_match", + "description": "Specifies what to do when the request:\n\n* Contains wildcard expressions and there are no datafeeds that match.\n* Contains the `_all` string or no identifiers and there are no matches.\n* Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when\nthere are partial matches. If `false`, the API returns a 404 status code when there are no matches or only\npartial matches.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "cat.ml_datafeeds#h": { + "in": "query", + "name": "h", + "description": "Comma-separated list of column names to display.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/cat._types:CatDatafeedColumns" + }, + "style": "form" + }, + "cat.ml_datafeeds#s": { + "in": "query", + "name": "s", + "description": "Comma-separated list of column names or column aliases used to sort the response.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/cat._types:CatDatafeedColumns" + }, + "style": "form" + }, + "cat.ml_datafeeds#time": { + "in": "query", + "name": "time", + "description": "The unit used to display time values.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:TimeUnit" + }, + "style": "form" + }, + "cat.ml_jobs#job_id": { + "in": "path", + "name": "job_id", + "description": "Identifier for the anomaly detection job.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "cat.ml_jobs#allow_no_match": { + "in": "query", + "name": "allow_no_match", + "description": "Specifies what to do when the request:\n\n* Contains wildcard expressions and there are no jobs that match.\n* Contains the `_all` string or no identifiers and there are no matches.\n* Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the API returns an empty jobs array when there are no matches and the subset of results when there\nare partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial\nmatches.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "cat.ml_jobs#bytes": { + "in": "query", + "name": "bytes", + "description": "The unit used to display byte values.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Bytes" + }, + "style": "form" + }, + "cat.ml_jobs#h": { + "in": "query", + "name": "h", + "description": "Comma-separated list of column names to display.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/cat._types:CatAnonalyDetectorColumns" + }, + "style": "form" + }, + "cat.ml_jobs#s": { + "in": "query", + "name": "s", + "description": "Comma-separated list of column names or column aliases used to sort the response.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/cat._types:CatAnonalyDetectorColumns" + }, + "style": "form" + }, + "cat.ml_jobs#time": { + "in": "query", + "name": "time", + "description": "The unit used to display time values.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:TimeUnit" + }, + "style": "form" + }, + "cat.ml_trained_models#model_id": { + "in": "path", + "name": "model_id", + "description": "A unique identifier for the trained model.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "cat.ml_trained_models#allow_no_match": { + "in": "query", + "name": "allow_no_match", + "description": "Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches.\nIf `true`, the API returns an empty array when there are no matches and the subset of results when there are partial matches.\nIf `false`, the API returns a 404 status code when there are no matches or only partial matches.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "cat.ml_trained_models#bytes": { + "in": "query", + "name": "bytes", + "description": "The unit used to display byte values.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Bytes" + }, + "style": "form" + }, + "cat.ml_trained_models#h": { + "in": "query", + "name": "h", + "description": "A comma-separated list of column names to display.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/cat._types:CatTrainedModelsColumns" + }, + "style": "form" + }, + "cat.ml_trained_models#s": { + "in": "query", + "name": "s", + "description": "A comma-separated list of column names or aliases used to sort the response.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/cat._types:CatTrainedModelsColumns" + }, + "style": "form" + }, + "cat.ml_trained_models#from": { + "in": "query", + "name": "from", + "description": "Skips the specified number of transforms.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "cat.ml_trained_models#size": { + "in": "query", + "name": "size", + "description": "The maximum number of transforms to display.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "cat.transforms#transform_id": { + "in": "path", + "name": "transform_id", + "description": "A transform identifier or a wildcard expression.\nIf you do not specify one of these options, the API returns information for all transforms.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "cat.transforms#allow_no_match": { + "in": "query", + "name": "allow_no_match", + "description": "Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches.\nIf `true`, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches.\nIf `false`, the request returns a 404 status code when there are no matches or only partial matches.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "cat.transforms#from": { + "in": "query", + "name": "from", + "description": "Skips the specified number of transforms.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "cat.transforms#h": { + "in": "query", + "name": "h", + "description": "Comma-separated list of column names to display.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/cat._types:CatTransformColumns" + }, + "style": "form" + }, + "cat.transforms#s": { + "in": "query", + "name": "s", + "description": "Comma-separated list of column names or column aliases used to sort the response.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/cat._types:CatTransformColumns" + }, + "style": "form" + }, + "cat.transforms#time": { + "in": "query", + "name": "time", + "description": "The unit used to display time values.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:TimeUnit" + }, + "style": "form" + }, + "cat.transforms#size": { + "in": "query", + "name": "size", + "description": "The maximum number of transforms to obtain.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "clear_scroll#scroll_id": { + "in": "path", + "name": "scroll_id", + "description": "Comma-separated list of scroll IDs to clear.\nTo clear all scroll IDs, use `_all`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ScrollIds" + }, + "style": "simple" + }, + "cluster.get_component_template#name": { + "in": "path", + "name": "name", + "description": "Comma-separated list of component template names used to limit the request.\nWildcard (`*`) expressions are supported.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" + }, + "cluster.get_component_template#flat_settings": { + "in": "query", + "name": "flat_settings", + "description": "If `true`, returns settings in flat format.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "cluster.get_component_template#include_defaults": { + "in": "query", + "name": "include_defaults", + "description": "Return all default configurations for the component template (default: false)", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "cluster.get_component_template#local": { + "in": "query", + "name": "local", + "description": "If `true`, the request retrieves information from the local node only.\nIf `false`, information is retrieved from the master node.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "cluster.get_component_template#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "cluster.put_component_template#name": { + "in": "path", + "name": "name", + "description": "Name of the component template to create.\nElasticsearch includes the following built-in component templates: `logs-mappings`; 'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`.\nElastic Agent uses these templates to configure backing indices for its data streams.\nIf you use Elastic Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version.\nIf you don’t use Elastic Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" + }, + "cluster.put_component_template#create": { + "in": "query", + "name": "create", + "description": "If `true`, this request cannot replace or update existing component templates.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "cluster.put_component_template#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "connector.put#connector_id": { + "in": "path", + "name": "connector_id", + "description": "The unique identifier of the connector to be created or updated. ID is auto-generated if not provided.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "count#index": { + "in": "path", + "name": "index", + "description": "Comma-separated list of data streams, indices, and aliases to search.\nSupports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + "count#allow_no_indices": { + "in": "query", + "name": "allow_no_indices", + "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "count#analyzer": { + "in": "query", + "name": "analyzer", + "description": "Analyzer to use for the query string.\nThis parameter can only be used when the `q` query string parameter is specified.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "count#analyze_wildcard": { + "in": "query", + "name": "analyze_wildcard", + "description": "If `true`, wildcard and prefix queries are analyzed.\nThis parameter can only be used when the `q` query string parameter is specified.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "count#default_operator": { + "in": "query", + "name": "default_operator", + "description": "The default operator for query string query: `AND` or `OR`.\nThis parameter can only be used when the `q` query string parameter is specified.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types.query_dsl:Operator" + }, + "style": "form" + }, + "count#df": { + "in": "query", + "name": "df", + "description": "Field to use as default where no field prefix is given in the query string.\nThis parameter can only be used when the `q` query string parameter is specified.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "count#expand_wildcards": { + "in": "query", + "name": "expand_wildcards", + "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + "count#ignore_throttled": { + "in": "query", + "name": "ignore_throttled", + "description": "If `true`, concrete, expanded or aliased indices are ignored when frozen.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "count#ignore_unavailable": { + "in": "query", + "name": "ignore_unavailable", + "description": "If `false`, the request returns an error if it targets a missing or closed index.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "count#lenient": { + "in": "query", + "name": "lenient", + "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "count#min_score": { + "in": "query", + "name": "min_score", + "description": "Sets the minimum `_score` value that documents must have to be included in the result.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "count#preference": { + "in": "query", + "name": "preference", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "count#routing": { + "in": "query", + "name": "routing", + "description": "Custom value used to route operations to a specific shard.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Routing" + }, + "style": "form" + }, + "count#terminate_after": { + "in": "query", + "name": "terminate_after", + "description": "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.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "count#q": { + "in": "query", + "name": "q", + "description": "Query in the Lucene query string syntax.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "create#id": { + "in": "path", + "name": "id", + "description": "Unique identifier for the document.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "create#index": { + "in": "path", + "name": "index", + "description": "Name of the data stream or index to target.\nIf the target doesn’t exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream.\nIf the target doesn’t exist and doesn’t match a data stream template, this request creates the index.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "style": "simple" + }, + "create#pipeline": { + "in": "query", + "name": "pipeline", + "description": "ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "create#refresh": { + "in": "query", + "name": "refresh", + "description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.\nValid values: `true`, `false`, `wait_for`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Refresh" + }, + "style": "form" + }, + "create#routing": { + "in": "query", + "name": "routing", + "description": "Custom value used to route operations to a specific shard.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Routing" + }, + "style": "form" + }, + "create#timeout": { + "in": "query", + "name": "timeout", + "description": "Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "create#version": { + "in": "query", + "name": "version", + "description": "Explicit version number for concurrency control.\nThe specified version must match the current version of the document for the request to succeed.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "style": "form" + }, + "create#version_type": { + "in": "query", + "name": "version_type", + "description": "Specific version type: `external`, `external_gte`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:VersionType" + }, + "style": "form" + }, + "create#wait_for_active_shards": { + "in": "query", + "name": "wait_for_active_shards", + "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:WaitForActiveShards" + }, + "style": "form" + }, + "enrich.get_policy#name": { + "in": "path", + "name": "name", + "description": "Comma-separated list of enrich policy names used to limit the request.\nTo return information for all enrich policies, omit this parameter.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "simple" + }, + "eql.search#index": { + "in": "path", + "name": "index", + "description": "The name of the index to scope the operation", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + "eql.search#allow_no_indices": { + "in": "query", + "name": "allow_no_indices", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "eql.search#expand_wildcards": { + "in": "query", + "name": "expand_wildcards", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + "eql.search#ignore_unavailable": { + "in": "query", + "name": "ignore_unavailable", + "description": "If true, missing or closed indices are not included in the response.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "eql.search#keep_alive": { + "in": "query", + "name": "keep_alive", + "description": "Period for which the search and its results are stored on the cluster.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "eql.search#keep_on_completion": { + "in": "query", + "name": "keep_on_completion", + "description": "If true, the search and its results are stored on the cluster.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "eql.search#wait_for_completion_timeout": { + "in": "query", + "name": "wait_for_completion_timeout", + "description": "Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "explain#id": { + "in": "path", + "name": "id", + "description": "Defines the document ID.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "explain#index": { + "in": "path", + "name": "index", + "description": "Index names used to limit the request.\nOnly a single index name can be provided to this parameter.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "style": "simple" + }, + "explain#analyzer": { + "in": "query", + "name": "analyzer", + "description": "Analyzer to use for the query string.\nThis parameter can only be used when the `q` query string parameter is specified.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "explain#analyze_wildcard": { + "in": "query", + "name": "analyze_wildcard", + "description": "If `true`, wildcard and prefix queries are analyzed.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "explain#default_operator": { + "in": "query", + "name": "default_operator", + "description": "The default operator for query string query: `AND` or `OR`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types.query_dsl:Operator" + }, + "style": "form" + }, + "explain#df": { + "in": "query", + "name": "df", + "description": "Field to use as default where no field prefix is given in the query string.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "explain#lenient": { + "in": "query", + "name": "lenient", + "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "explain#preference": { + "in": "query", + "name": "preference", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "explain#routing": { + "in": "query", + "name": "routing", + "description": "Custom value used to route operations to a specific shard.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Routing" + }, + "style": "form" + }, + "explain#_source": { + "in": "query", + "name": "_source", + "description": "True or false to return the `_source` field or not, or a list of fields to return.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_global.search._types:SourceConfigParam" + }, + "style": "form" + }, + "explain#_source_excludes": { + "in": "query", + "name": "_source_excludes", + "description": "A comma-separated list of source fields to exclude from the response.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + "explain#_source_includes": { + "in": "query", + "name": "_source_includes", + "description": "A comma-separated list of source fields to include in the response.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + "explain#stored_fields": { + "in": "query", + "name": "stored_fields", + "description": "A comma-separated list of stored fields to return in the response.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + "explain#q": { + "in": "query", + "name": "q", + "description": "Query in the Lucene query string syntax.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "field_caps#index": { + "in": "path", + "name": "index", + "description": "Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + "field_caps#allow_no_indices": { + "in": "query", + "name": "allow_no_indices", + "description": "If false, the request returns an error if any wildcard expression, index alias,\nor `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request\ntargeting `foo*,bar*` returns an error if an index starts with foo but no index starts with bar.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "field_caps#expand_wildcards": { + "in": "query", + "name": "expand_wildcards", + "description": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + "field_caps#fields": { + "in": "query", + "name": "fields", + "description": "Comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + "field_caps#ignore_unavailable": { + "in": "query", + "name": "ignore_unavailable", + "description": "If `true`, missing or closed indices are not included in the response.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "field_caps#include_unmapped": { + "in": "query", + "name": "include_unmapped", + "description": "If true, unmapped fields are included in the response.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "field_caps#filters": { + "in": "query", + "name": "filters", + "description": "An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parent", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "field_caps#types": { + "in": "query", + "name": "types", + "description": "Only return results for fields that have one of the types in the list", + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form" + }, + "field_caps#include_empty_fields": { + "in": "query", + "name": "include_empty_fields", + "description": "If false, empty fields are not included in the response.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "graph.explore#index": { + "in": "path", + "name": "index", + "description": "Name of the index.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + "graph.explore#routing": { + "in": "query", + "name": "routing", + "description": "Custom value used to route operations to a specific shard.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Routing" + }, + "style": "form" + }, + "graph.explore#timeout": { + "in": "query", + "name": "timeout", + "description": "Specifies the period of time to wait for a response from each shard.\nIf no response is received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "index#id": { + "in": "path", + "name": "id", + "description": "Unique identifier for the document.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "index#index": { + "in": "path", + "name": "index", + "description": "Name of the data stream or index to target.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "style": "simple" + }, + "index#if_primary_term": { + "in": "query", + "name": "if_primary_term", + "description": "Only perform the operation if the document has this primary term.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "index#if_seq_no": { + "in": "query", + "name": "if_seq_no", + "description": "Only perform the operation if the document has this sequence number.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:SequenceNumber" + }, + "style": "form" + }, + "index#op_type": { + "in": "query", + "name": "op_type", + "description": "Set to create to only index the document if it does not already exist (put if absent).\nIf a document with the specified `_id` already exists, the indexing operation will fail.\nSame as using the `/_create` endpoint.\nValid values: `index`, `create`.\nIf document id is specified, it defaults to `index`.\nOtherwise, it defaults to `create`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:OpType" + }, + "style": "form" + }, + "index#pipeline": { + "in": "query", + "name": "pipeline", + "description": "ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "index#refresh": { + "in": "query", + "name": "refresh", + "description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.\nValid values: `true`, `false`, `wait_for`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Refresh" + }, + "style": "form" + }, + "index#routing": { + "in": "query", + "name": "routing", + "description": "Custom value used to route operations to a specific shard.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Routing" + }, + "style": "form" + }, + "index#timeout": { + "in": "query", + "name": "timeout", + "description": "Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "index#version": { + "in": "query", + "name": "version", + "description": "Explicit version number for concurrency control.\nThe specified version must match the current version of the document for the request to succeed.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "style": "form" + }, + "index#version_type": { + "in": "query", + "name": "version_type", + "description": "Specific version type: `external`, `external_gte`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:VersionType" + }, + "style": "form" + }, + "index#wait_for_active_shards": { + "in": "query", + "name": "wait_for_active_shards", + "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:WaitForActiveShards" + }, + "style": "form" + }, + "index#require_alias": { + "in": "query", + "name": "require_alias", + "description": "If `true`, the destination must be an index alias.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.analyze#index": { + "in": "path", + "name": "index", + "description": "Index used to derive the analyzer.\nIf specified, the `analyzer` or field parameter overrides this value.\nIf no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "style": "simple" + }, + "indices.data_streams_stats#name": { + "in": "path", + "name": "name", + "description": "Comma-separated list of data streams used to limit the request.\nWildcard expressions (`*`) are supported.\nTo target all data streams in a cluster, omit this parameter or use `*`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "style": "simple" + }, + "indices.data_streams_stats#expand_wildcards": { + "in": "query", + "name": "expand_wildcards", + "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + "indices.delete_alias#index": { + "in": "path", + "name": "index", + "description": "Comma-separated list of data streams or indices used to limit the request.\nSupports wildcards (`*`).", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + "indices.delete_alias#name": { + "in": "path", + "name": "name", + "description": "Comma-separated list of aliases to remove.\nSupports wildcards (`*`). To remove all aliases, use `*` or `_all`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "simple" + }, + "indices.delete_alias#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "indices.delete_alias#timeout": { + "in": "query", + "name": "timeout", + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "indices.exists_alias#name": { + "in": "path", + "name": "name", + "description": "Comma-separated list of aliases to check. Supports wildcards (`*`).", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "simple" + }, + "indices.exists_alias#index": { + "in": "path", + "name": "index", + "description": "Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + "indices.exists_alias#allow_no_indices": { + "in": "query", + "name": "allow_no_indices", + "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.exists_alias#expand_wildcards": { + "in": "query", + "name": "expand_wildcards", + "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + "indices.exists_alias#ignore_unavailable": { + "in": "query", + "name": "ignore_unavailable", + "description": "If `false`, requests that include a missing data stream or index in the target indices or data streams return an error.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.exists_alias#local": { + "in": "query", + "name": "local", + "description": "If `true`, the request retrieves information from the local node only.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.get_alias#name": { + "in": "path", + "name": "name", + "description": "Comma-separated list of aliases to retrieve.\nSupports wildcards (`*`).\nTo retrieve all aliases, omit this parameter or use `*` or `_all`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "simple" + }, + "indices.get_alias#index": { + "in": "path", + "name": "index", + "description": "Comma-separated list of data streams or indices used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + "indices.get_alias#allow_no_indices": { + "in": "query", + "name": "allow_no_indices", + "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.get_alias#expand_wildcards": { + "in": "query", + "name": "expand_wildcards", + "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + "indices.get_alias#ignore_unavailable": { + "in": "query", + "name": "ignore_unavailable", + "description": "If `false`, the request returns an error if it targets a missing or closed index.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.get_alias#local": { + "in": "query", + "name": "local", + "description": "If `true`, the request retrieves information from the local node only.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.get_data_stream#name": { + "in": "path", + "name": "name", + "description": "Comma-separated list of data stream names used to limit the request.\nWildcard (`*`) expressions are supported. If omitted, all data streams are returned.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DataStreamNames" + }, + "style": "simple" + }, + "indices.get_data_stream#expand_wildcards": { + "in": "query", + "name": "expand_wildcards", + "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + "indices.get_data_stream#include_defaults": { + "in": "query", + "name": "include_defaults", + "description": "If true, returns all relevant default configurations for the index template.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.get_index_template#name": { + "in": "path", + "name": "name", + "description": "Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" + }, + "indices.get_index_template#local": { + "in": "query", + "name": "local", + "description": "If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.get_index_template#flat_settings": { + "in": "query", + "name": "flat_settings", + "description": "If true, returns settings in flat format.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.get_index_template#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "indices.get_index_template#include_defaults": { + "in": "query", + "name": "include_defaults", + "description": "If true, returns all relevant default configurations for the index template.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.get_mapping#index": { + "in": "path", + "name": "index", + "description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + "indices.get_mapping#allow_no_indices": { + "in": "query", + "name": "allow_no_indices", + "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.get_mapping#expand_wildcards": { + "in": "query", + "name": "expand_wildcards", + "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + "indices.get_mapping#ignore_unavailable": { + "in": "query", + "name": "ignore_unavailable", + "description": "If `false`, the request returns an error if it targets a missing or closed index.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.get_mapping#local": { + "in": "query", + "name": "local", + "description": "If `true`, the request retrieves information from the local node only.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.get_mapping#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "indices.get_settings#index": { + "in": "path", + "name": "index", + "description": "Comma-separated list of data streams, indices, and aliases used to limit\nthe request. Supports wildcards (`*`). To target all data streams and\nindices, omit this parameter or use `*` or `_all`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + "indices.get_settings#name": { + "in": "path", + "name": "name", + "description": "Comma-separated list or wildcard expression of settings to retrieve.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "simple" + }, + "indices.get_settings#allow_no_indices": { + "in": "query", + "name": "allow_no_indices", + "description": "If `false`, the request returns an error if any wildcard expression, index\nalias, or `_all` value targets only missing or closed indices. This\nbehavior applies even if the request targets other open indices. For\nexample, a request targeting `foo*,bar*` returns an error if an index\nstarts with foo but no index starts with `bar`.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.get_settings#expand_wildcards": { + "in": "query", + "name": "expand_wildcards", + "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + "indices.get_settings#flat_settings": { + "in": "query", + "name": "flat_settings", + "description": "If `true`, returns settings in flat format.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.get_settings#ignore_unavailable": { + "in": "query", + "name": "ignore_unavailable", + "description": "If `false`, the request returns an error if it targets a missing or closed index.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.get_settings#include_defaults": { + "in": "query", + "name": "include_defaults", + "description": "If `true`, return all default settings in the response.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.get_settings#local": { + "in": "query", + "name": "local", + "description": "If `true`, the request retrieves information from the local node only. If\n`false`, information is retrieved from the master node.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.get_settings#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "indices.put_alias#index": { + "in": "path", + "name": "index", + "description": "Comma-separated list of data streams or indices to add.\nSupports wildcards (`*`).\nWildcard patterns that match both data streams and indices return an error.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + "indices.put_alias#name": { + "in": "path", + "name": "name", + "description": "Alias to update.\nIf the alias doesn’t exist, the request creates it.\nIndex alias names support date math.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" + }, + "indices.put_alias#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "indices.put_alias#timeout": { + "in": "query", + "name": "timeout", + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "indices.put_index_template#name": { + "in": "path", + "name": "name", + "description": "Index or template name", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" + }, + "indices.put_index_template#create": { + "in": "query", + "name": "create", + "description": "If `true`, this request cannot replace or update existing index templates.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.put_index_template#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "indices.put_index_template#cause": { + "in": "query", + "name": "cause", + "description": "User defined reason for creating/updating the index template", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "indices.put_mapping#index": { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + "indices.put_mapping#allow_no_indices": { + "in": "query", + "name": "allow_no_indices", + "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.put_mapping#expand_wildcards": { + "in": "query", + "name": "expand_wildcards", + "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + "indices.put_mapping#ignore_unavailable": { + "in": "query", + "name": "ignore_unavailable", + "description": "If `false`, the request returns an error if it targets a missing or closed index.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.put_mapping#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "indices.put_mapping#timeout": { + "in": "query", + "name": "timeout", + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "indices.put_mapping#write_index_only": { + "in": "query", + "name": "write_index_only", + "description": "If `true`, the mappings are applied only to the current write index for the target.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.put_settings#index": { + "in": "path", + "name": "index", + "description": "Comma-separated list of data streams, indices, and aliases used to limit\nthe request. Supports wildcards (`*`). To target all data streams and\nindices, omit this parameter or use `*` or `_all`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + "indices.put_settings#allow_no_indices": { + "in": "query", + "name": "allow_no_indices", + "description": "If `false`, the request returns an error if any wildcard expression, index\nalias, or `_all` value targets only missing or closed indices. This\nbehavior applies even if the request targets other open indices. For\nexample, a request targeting `foo*,bar*` returns an error if an index\nstarts with `foo` but no index starts with `bar`.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.put_settings#expand_wildcards": { + "in": "query", + "name": "expand_wildcards", + "description": "Type of index that wildcard patterns can match. If the request can target\ndata streams, this argument determines whether wildcard expressions match\nhidden data streams. Supports comma-separated values, such as\n`open,hidden`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + "indices.put_settings#flat_settings": { + "in": "query", + "name": "flat_settings", + "description": "If `true`, returns settings in flat format.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.put_settings#ignore_unavailable": { + "in": "query", + "name": "ignore_unavailable", + "description": "If `true`, returns settings in flat format.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.put_settings#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "indices.put_settings#preserve_existing": { + "in": "query", + "name": "preserve_existing", + "description": "If `true`, existing index settings remain unchanged.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.put_settings#timeout": { + "in": "query", + "name": "timeout", + "description": "Period to wait for a response. If no response is received before the\n timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "indices.put_template#name": { + "in": "path", + "name": "name", + "description": "The name of the template", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" + }, + "indices.put_template#create": { + "in": "query", + "name": "create", + "description": "If true, this request cannot replace or update existing index templates.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.put_template#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "indices.put_template#order": { + "in": "query", + "name": "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.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "indices.put_template#cause": { + "in": "query", + "name": "cause", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "indices.refresh#index": { + "in": "path", + "name": "index", + "description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + "indices.refresh#allow_no_indices": { + "in": "query", + "name": "allow_no_indices", + "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.refresh#expand_wildcards": { + "in": "query", + "name": "expand_wildcards", + "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + "indices.refresh#ignore_unavailable": { + "in": "query", + "name": "ignore_unavailable", + "description": "If `false`, the request returns an error if it targets a missing or closed index.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.rollover#alias": { + "in": "path", + "name": "alias", + "description": "Name of the data stream or index alias to roll over.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:IndexAlias" + }, + "style": "simple" + }, + "indices.rollover#new_index": { + "in": "path", + "name": "new_index", + "description": "Name of the index to create.\nSupports date math.\nData streams do not support this parameter.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "style": "simple" + }, + "indices.rollover#dry_run": { + "in": "query", + "name": "dry_run", + "description": "If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.rollover#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "indices.rollover#timeout": { + "in": "query", + "name": "timeout", + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "indices.rollover#wait_for_active_shards": { + "in": "query", + "name": "wait_for_active_shards", + "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:WaitForActiveShards" + }, + "style": "form" + }, + "indices.simulate_template#name": { + "in": "path", + "name": "name", + "description": "Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit\nthis parameter and specify the template configuration in the request body.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" + }, + "indices.simulate_template#create": { + "in": "query", + "name": "create", + "description": "If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.simulate_template#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "indices.simulate_template#include_defaults": { + "in": "query", + "name": "include_defaults", + "description": "If true, returns all relevant default configurations for the index template.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.validate_query#index": { + "in": "path", + "name": "index", + "description": "Comma-separated list of data streams, indices, and aliases to search.\nSupports wildcards (`*`).\nTo search all data streams or indices, omit this parameter or use `*` or `_all`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + "indices.validate_query#allow_no_indices": { + "in": "query", + "name": "allow_no_indices", + "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.validate_query#all_shards": { + "in": "query", + "name": "all_shards", + "description": "If `true`, the validation is executed on all shards instead of one random shard per index.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.validate_query#analyzer": { + "in": "query", + "name": "analyzer", + "description": "Analyzer to use for the query string.\nThis parameter can only be used when the `q` query string parameter is specified.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "indices.validate_query#analyze_wildcard": { + "in": "query", + "name": "analyze_wildcard", + "description": "If `true`, wildcard and prefix queries are analyzed.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.validate_query#default_operator": { + "in": "query", + "name": "default_operator", + "description": "The default operator for query string query: `AND` or `OR`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types.query_dsl:Operator" + }, + "style": "form" + }, + "indices.validate_query#df": { + "in": "query", + "name": "df", + "description": "Field to use as default where no field prefix is given in the query string.\nThis parameter can only be used when the `q` query string parameter is specified.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "indices.validate_query#expand_wildcards": { + "in": "query", + "name": "expand_wildcards", + "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + "indices.validate_query#explain": { + "in": "query", + "name": "explain", + "description": "If `true`, the response returns detailed information if an error has occurred.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.validate_query#ignore_unavailable": { + "in": "query", + "name": "ignore_unavailable", + "description": "If `false`, the request returns an error if it targets a missing or closed index.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.validate_query#lenient": { + "in": "query", + "name": "lenient", + "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.validate_query#rewrite": { + "in": "query", + "name": "rewrite", + "description": "If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "indices.validate_query#q": { + "in": "query", + "name": "q", + "description": "Query in the Lucene query string syntax.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "inference.delete#task_type": { + "in": "path", + "name": "task_type", + "description": "The task type", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/inference._types:TaskType" + }, + "style": "simple" + }, + "inference.delete#inference_id": { + "in": "path", + "name": "inference_id", + "description": "The inference Id", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "inference.delete#dry_run": { + "in": "query", + "name": "dry_run", + "description": "When true, the endpoint is not deleted, and a list of ingest processors which reference this endpoint is returned", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "inference.delete#force": { + "in": "query", + "name": "force", + "description": "When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "inference.get#task_type": { + "in": "path", + "name": "task_type", + "description": "The task type", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/inference._types:TaskType" + }, + "style": "simple" + }, + "inference.get#inference_id": { + "in": "path", + "name": "inference_id", + "description": "The inference Id", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "inference.inference#task_type": { + "in": "path", + "name": "task_type", + "description": "The task type", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/inference._types:TaskType" + }, + "style": "simple" + }, + "inference.inference#inference_id": { + "in": "path", + "name": "inference_id", + "description": "The inference Id", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "inference.inference#timeout": { + "in": "query", + "name": "timeout", + "description": "Specifies the amount of time to wait for the inference request to complete.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "inference.put#task_type": { + "in": "path", + "name": "task_type", + "description": "The task type", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/inference._types:TaskType" + }, + "style": "simple" + }, + "inference.put#inference_id": { + "in": "path", + "name": "inference_id", + "description": "The inference Id", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "ingest.get_pipeline#id": { + "in": "path", + "name": "id", + "description": "Comma-separated list of pipeline IDs to retrieve.\nWildcard (`*`) expressions are supported.\nTo get all ingest pipelines, omit this parameter or use `*`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "ingest.get_pipeline#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "ingest.get_pipeline#summary": { + "in": "query", + "name": "summary", + "description": "Return pipelines without their definitions (default: false)", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "ingest.simulate#id": { + "in": "path", + "name": "id", + "description": "Pipeline to test.\nIf you don’t specify a `pipeline` in the request body, this parameter is required.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "ingest.simulate#verbose": { + "in": "query", + "name": "verbose", + "description": "If `true`, the response includes output data for each processor in the executed pipeline.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "logstash.get_pipeline#id": { + "in": "path", + "name": "id", + "description": "Comma-separated list of pipeline identifiers.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Ids" + }, + "style": "simple" + }, + "mget#index": { + "in": "path", + "name": "index", + "description": "Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "style": "simple" + }, + "mget#preference": { + "in": "query", + "name": "preference", + "description": "Specifies the node or shard the operation should be performed on. Random by default.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "mget#realtime": { + "in": "query", + "name": "realtime", + "description": "If `true`, the request is real-time as opposed to near-real-time.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "mget#refresh": { + "in": "query", + "name": "refresh", + "description": "If `true`, the request refreshes relevant shards before retrieving documents.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "mget#routing": { + "in": "query", + "name": "routing", + "description": "Custom value used to route operations to a specific shard.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Routing" + }, + "style": "form" + }, + "mget#_source": { + "in": "query", + "name": "_source", + "description": "True or false to return the `_source` field or not, or a list of fields to return.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_global.search._types:SourceConfigParam" + }, + "style": "form" + }, + "mget#_source_excludes": { + "in": "query", + "name": "_source_excludes", + "description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + "mget#_source_includes": { + "in": "query", + "name": "_source_includes", + "description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + "mget#stored_fields": { + "in": "query", + "name": "stored_fields", + "description": "If `true`, retrieves the document fields stored in the index rather than the document `_source`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + "ml.get_calendars#calendar_id": { + "in": "path", + "name": "calendar_id", + "description": "A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using `_all` or `*` or by omitting the calendar identifier.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "ml.get_calendars#from": { + "in": "query", + "name": "from", + "description": "Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "ml.get_calendars#size": { + "in": "query", + "name": "size", + "description": "Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "ml.get_data_frame_analytics#id": { + "in": "path", + "name": "id", + "description": "Identifier for the data frame analytics job. If you do not specify this\noption, the API returns information for the first hundred data frame\nanalytics jobs.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "ml.get_data_frame_analytics#allow_no_match": { + "in": "query", + "name": "allow_no_match", + "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no data frame analytics\njobs that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value returns an empty data_frame_analytics array when there\nare no matches and the subset of results when there are partial matches.\nIf this parameter is `false`, the request returns a 404 status code when\nthere are no matches or only partial matches.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "ml.get_data_frame_analytics#from": { + "in": "query", + "name": "from", + "description": "Skips the specified number of data frame analytics jobs.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "ml.get_data_frame_analytics#size": { + "in": "query", + "name": "size", + "description": "Specifies the maximum number of data frame analytics jobs to obtain.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "ml.get_data_frame_analytics#exclude_generated": { + "in": "query", + "name": "exclude_generated", + "description": "Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "ml.get_data_frame_analytics_stats#id": { + "in": "path", + "name": "id", + "description": "Identifier for the data frame analytics job. If you do not specify this\noption, the API returns information for the first hundred data frame\nanalytics jobs.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "ml.get_data_frame_analytics_stats#allow_no_match": { + "in": "query", + "name": "allow_no_match", + "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no data frame analytics\njobs that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value returns an empty data_frame_analytics array when there\nare no matches and the subset of results when there are partial matches.\nIf this parameter is `false`, the request returns a 404 status code when\nthere are no matches or only partial matches.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "ml.get_data_frame_analytics_stats#from": { + "in": "query", + "name": "from", + "description": "Skips the specified number of data frame analytics jobs.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "ml.get_data_frame_analytics_stats#size": { + "in": "query", + "name": "size", + "description": "Specifies the maximum number of data frame analytics jobs to obtain.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "ml.get_data_frame_analytics_stats#verbose": { + "in": "query", + "name": "verbose", + "description": "Defines whether the stats response should be verbose.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "ml.get_datafeed_stats#datafeed_id": { + "in": "path", + "name": "datafeed_id", + "description": "Identifier for the datafeed. It can be a datafeed identifier or a\nwildcard expression. If you do not specify one of these options, the API\nreturns information about all datafeeds.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Ids" + }, + "style": "simple" + }, + "ml.get_datafeed_stats#allow_no_match": { + "in": "query", + "name": "allow_no_match", + "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no datafeeds that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value is `true`, which returns an empty `datafeeds` array\nwhen there are no matches and the subset of results when there are\npartial matches. If this parameter is `false`, the request returns a\n`404` status code when there are no matches or only partial matches.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "ml.get_datafeeds#datafeed_id": { + "in": "path", + "name": "datafeed_id", + "description": "Identifier for the datafeed. It can be a datafeed identifier or a\nwildcard expression. If you do not specify one of these options, the API\nreturns information about all datafeeds.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Ids" + }, + "style": "simple" + }, + "ml.get_datafeeds#allow_no_match": { + "in": "query", + "name": "allow_no_match", + "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no datafeeds that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value is `true`, which returns an empty `datafeeds` array\nwhen there are no matches and the subset of results when there are\npartial matches. If this parameter is `false`, the request returns a\n`404` status code when there are no matches or only partial matches.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "ml.get_datafeeds#exclude_generated": { + "in": "query", + "name": "exclude_generated", + "description": "Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "ml.get_filters#filter_id": { + "in": "path", + "name": "filter_id", + "description": "A string that uniquely identifies a filter.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Ids" + }, + "style": "simple" + }, + "ml.get_filters#from": { + "in": "query", + "name": "from", + "description": "Skips the specified number of filters.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "ml.get_filters#size": { + "in": "query", + "name": "size", + "description": "Specifies the maximum number of filters to obtain.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "ml.get_job_stats#job_id": { + "in": "path", + "name": "job_id", + "description": "Identifier for the anomaly detection job. It can be a job identifier, a\ngroup name, a comma-separated list of jobs, or a wildcard expression. If\nyou do not specify one of these options, the API returns information for\nall anomaly detection jobs.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "ml.get_job_stats#allow_no_match": { + "in": "query", + "name": "allow_no_match", + "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no jobs that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the API returns an empty `jobs` array when\nthere are no matches and the subset of results when there are partial\nmatches. If `false`, the API returns a `404` status\ncode when there are no matches or only partial matches.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "ml.get_jobs#job_id": { + "in": "path", + "name": "job_id", + "description": "Identifier for the anomaly detection job. It can be a job identifier, a\ngroup name, or a wildcard expression. If you do not specify one of these\noptions, the API returns information for all anomaly detection jobs.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Ids" + }, + "style": "simple" + }, + "ml.get_jobs#allow_no_match": { + "in": "query", + "name": "allow_no_match", + "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no jobs that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value is `true`, which returns an empty `jobs` array when\nthere are no matches and the subset of results when there are partial\nmatches. If this parameter is `false`, the request returns a `404` status\ncode when there are no matches or only partial matches.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "ml.get_jobs#exclude_generated": { + "in": "query", + "name": "exclude_generated", + "description": "Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "ml.get_overall_buckets#job_id": { + "in": "path", + "name": "job_id", + "description": "Identifier for the anomaly detection job. It can be a job identifier, a\ngroup name, a comma-separated list of jobs or groups, or a wildcard\nexpression.\n\nYou can summarize the bucket results for all anomaly detection jobs by\nusing `_all` or by specifying `*` as the ``.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "ml.get_overall_buckets#allow_no_match": { + "in": "query", + "name": "allow_no_match", + "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no jobs that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the request returns an empty `jobs` array when there are no\nmatches and the subset of results when there are partial matches. If this\nparameter is `false`, the request returns a `404` status code when there\nare no matches or only partial matches.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "ml.get_overall_buckets#bucket_span": { + "in": "query", + "name": "bucket_span", + "description": "The span of the overall buckets. Must be greater or equal to the largest\nbucket span of the specified anomaly detection jobs, which is the default\nvalue.\n\nBy default, an overall bucket has a span equal to the largest bucket span\nof the specified anomaly detection jobs. To override that behavior, use\nthe optional `bucket_span` parameter.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "ml.get_overall_buckets#end": { + "in": "query", + "name": "end", + "description": "Returns overall buckets with timestamps earlier than this time.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "style": "form" + }, + "ml.get_overall_buckets#exclude_interim": { + "in": "query", + "name": "exclude_interim", + "description": "If `true`, the output excludes interim results.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "ml.get_overall_buckets#overall_score": { + "in": "query", + "name": "overall_score", + "description": "Returns overall buckets with overall scores greater than or equal to this\nvalue.", + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "style": "form" + }, + "ml.get_overall_buckets#start": { + "in": "query", + "name": "start", + "description": "Returns overall buckets with timestamps after this time.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "style": "form" + }, + "ml.get_overall_buckets#top_n": { + "in": "query", + "name": "top_n", + "description": "The number of top anomaly detection job bucket scores to be used in the\n`overall_score` calculation.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "ml.get_trained_models#model_id": { + "in": "path", + "name": "model_id", + "description": "The unique identifier of the trained model or a model alias.\n\nYou can get information for multiple trained models in a single API\nrequest by using a comma-separated list of model IDs or a wildcard\nexpression.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Ids" + }, + "style": "simple" + }, + "ml.get_trained_models#allow_no_match": { + "in": "query", + "name": "allow_no_match", + "description": "Specifies what to do when the request:\n\n- Contains wildcard expressions and there are no models that match.\n- Contains the _all string or no identifiers and there are no matches.\n- Contains wildcard expressions and there are only partial matches.\n\nIf true, it returns an empty array when there are no matches and the\nsubset of results when there are partial matches.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "ml.get_trained_models#decompress_definition": { + "in": "query", + "name": "decompress_definition", + "description": "Specifies whether the included model definition should be returned as a\nJSON map (true) or in a custom compressed format (false).", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "ml.get_trained_models#exclude_generated": { + "in": "query", + "name": "exclude_generated", + "description": "Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "ml.get_trained_models#from": { + "in": "query", + "name": "from", + "description": "Skips the specified number of models.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "ml.get_trained_models#include": { + "in": "query", + "name": "include", + "description": "A comma delimited string of optional fields to include in the response\nbody.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ml._types:Include" + }, + "style": "form" + }, + "ml.get_trained_models#size": { + "in": "query", + "name": "size", + "description": "Specifies the maximum number of models to obtain.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "ml.get_trained_models#tags": { + "in": "query", + "name": "tags", + "description": "A comma delimited string of tags. A trained model can have many tags, or\nnone. When supplied, only trained models that contain all the supplied\ntags are returned.", + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "style": "form" + }, + "ml.get_trained_models_stats#model_id": { + "in": "path", + "name": "model_id", + "description": "The unique identifier of the trained model or a model alias. It can be a\ncomma-separated list or a wildcard expression.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Ids" + }, + "style": "simple" + }, + "ml.get_trained_models_stats#allow_no_match": { + "in": "query", + "name": "allow_no_match", + "description": "Specifies what to do when the request:\n\n- Contains wildcard expressions and there are no models that match.\n- Contains the _all string or no identifiers and there are no matches.\n- Contains wildcard expressions and there are only partial matches.\n\nIf true, it returns an empty array when there are no matches and the\nsubset of results when there are partial matches.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "ml.get_trained_models_stats#from": { + "in": "query", + "name": "from", + "description": "Skips the specified number of models.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "ml.get_trained_models_stats#size": { + "in": "query", + "name": "size", + "description": "Specifies the maximum number of models to obtain.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "ml.infer_trained_model#model_id": { + "in": "path", + "name": "model_id", + "description": "The unique identifier of the trained model.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "ml.infer_trained_model#timeout": { + "in": "query", + "name": "timeout", + "description": "Controls the amount of time to wait for inference results.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "ml.preview_data_frame_analytics#id": { + "in": "path", + "name": "id", + "description": "Identifier for the data frame analytics job.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "ml.preview_datafeed#datafeed_id": { + "in": "path", + "name": "datafeed_id", + "description": "A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase\nalphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric\ncharacters. NOTE: If you use this path parameter, you cannot provide datafeed or anomaly detection job\nconfiguration details in the request body.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "ml.preview_datafeed#start": { + "in": "query", + "name": "start", + "description": "The start time from where the datafeed preview should begin", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "style": "form" + }, + "ml.preview_datafeed#end": { + "in": "query", + "name": "end", + "description": "The end time when the datafeed preview should stop", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "style": "form" + }, + "msearch#index": { + "in": "path", + "name": "index", + "description": "Comma-separated list of data streams, indices, and index aliases to search.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + "msearch#allow_no_indices": { + "in": "query", + "name": "allow_no_indices", + "description": "If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "msearch#ccs_minimize_roundtrips": { + "in": "query", + "name": "ccs_minimize_roundtrips", + "description": "If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "msearch#expand_wildcards": { + "in": "query", + "name": "expand_wildcards", + "description": "Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + "msearch#ignore_throttled": { + "in": "query", + "name": "ignore_throttled", + "description": "If true, concrete, expanded or aliased indices are ignored when frozen.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "msearch#ignore_unavailable": { + "in": "query", + "name": "ignore_unavailable", + "description": "If true, missing or closed indices are not included in the response.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "msearch#max_concurrent_searches": { + "in": "query", + "name": "max_concurrent_searches", + "description": "Maximum number of concurrent searches the multi search API can execute.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "msearch#max_concurrent_shard_requests": { + "in": "query", + "name": "max_concurrent_shard_requests", + "description": "Maximum number of concurrent shard requests that each sub-search request executes per node.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "msearch#pre_filter_shard_size": { + "in": "query", + "name": "pre_filter_shard_size", + "description": "Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "msearch#rest_total_hits_as_int": { + "in": "query", + "name": "rest_total_hits_as_int", + "description": "If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "msearch#routing": { + "in": "query", + "name": "routing", + "description": "Custom routing value used to route search operations to a specific shard.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Routing" + }, + "style": "form" + }, + "msearch#search_type": { + "in": "query", + "name": "search_type", + "description": "Indicates whether global term and document frequencies should be used when scoring returned documents.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:SearchType" + }, + "style": "form" + }, + "msearch#typed_keys": { + "in": "query", + "name": "typed_keys", + "description": "Specifies whether aggregation and suggester names should be prefixed by their respective types in the response.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "msearch_template#index": { + "in": "path", + "name": "index", + "description": "Comma-separated list of data streams, indices, and aliases to search.\nSupports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + "msearch_template#ccs_minimize_roundtrips": { + "in": "query", + "name": "ccs_minimize_roundtrips", + "description": "If `true`, network round-trips are minimized for cross-cluster search requests.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "msearch_template#max_concurrent_searches": { + "in": "query", + "name": "max_concurrent_searches", + "description": "Maximum number of concurrent searches the API can run.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "msearch_template#search_type": { + "in": "query", + "name": "search_type", + "description": "The type of the search operation.\nAvailable options: `query_then_fetch`, `dfs_query_then_fetch`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:SearchType" + }, + "style": "form" + }, + "msearch_template#rest_total_hits_as_int": { + "in": "query", + "name": "rest_total_hits_as_int", + "description": "If `true`, the response returns `hits.total` as an integer.\nIf `false`, it returns `hits.total` as an object.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "msearch_template#typed_keys": { + "in": "query", + "name": "typed_keys", + "description": "If `true`, the response prefixes aggregation and suggester names with their respective types.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "mtermvectors#index": { + "in": "path", + "name": "index", + "description": "Name of the index that contains the documents.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "style": "simple" + }, + "mtermvectors#ids": { + "in": "query", + "name": "ids", + "description": "A comma-separated list of documents ids. You must define ids as parameter or set \"ids\" or \"docs\" in the request body", + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Id" + } + }, + "style": "form" + }, + "mtermvectors#fields": { + "in": "query", + "name": "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + "mtermvectors#field_statistics": { + "in": "query", + "name": "field_statistics", + "description": "If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "mtermvectors#offsets": { + "in": "query", + "name": "offsets", + "description": "If `true`, the response includes term offsets.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "mtermvectors#payloads": { + "in": "query", + "name": "payloads", + "description": "If `true`, the response includes term payloads.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "mtermvectors#positions": { + "in": "query", + "name": "positions", + "description": "If `true`, the response includes term positions.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "mtermvectors#preference": { + "in": "query", + "name": "preference", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "mtermvectors#realtime": { + "in": "query", + "name": "realtime", + "description": "If true, the request is real-time as opposed to near-real-time.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "mtermvectors#routing": { + "in": "query", + "name": "routing", + "description": "Custom value used to route operations to a specific shard.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Routing" + }, + "style": "form" + }, + "mtermvectors#term_statistics": { + "in": "query", + "name": "term_statistics", + "description": "If true, the response includes term frequency and document frequency.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "mtermvectors#version": { + "in": "query", + "name": "version", + "description": "If `true`, returns the document version as part of a hit.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "style": "form" + }, + "mtermvectors#version_type": { + "in": "query", + "name": "version_type", + "description": "Specific version type.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:VersionType" + }, + "style": "form" + }, + "put_script#id": { + "in": "path", + "name": "id", + "description": "Identifier for the stored script or search template.\nMust be unique within the cluster.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "put_script#context": { + "in": "path", + "name": "context", + "description": "Context in which the script or search template should run.\nTo prevent errors, the API immediately compiles the script or template in this context.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" + }, + "put_script#master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "put_script#timeout": { + "in": "query", + "name": "timeout", + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "rank_eval#index": { + "in": "path", + "name": "index", + "description": "Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard (`*`) expressions are supported.\nTo target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + "rank_eval#allow_no_indices": { + "in": "query", + "name": "allow_no_indices", + "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "rank_eval#expand_wildcards": { + "in": "query", + "name": "expand_wildcards", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + "rank_eval#ignore_unavailable": { + "in": "query", + "name": "ignore_unavailable", + "description": "If `true`, missing or closed indices are not included in the response.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "rank_eval#search_type": { + "in": "query", + "name": "search_type", + "description": "Search operation type", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "render_search_template#id": { + "in": "path", + "name": "id", + "description": "ID of the search template to render.\nIf no `source` is specified, this or the `id` request body parameter is required.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "scroll#scroll_id": { + "in": "path", + "name": "scroll_id", + "description": "The scroll ID", + "required": true, + "deprecated": true, + "schema": { + "$ref": "#/components/schemas/_types:ScrollId" + }, + "style": "simple" + }, + "scroll#scroll": { + "in": "query", + "name": "scroll", + "description": "Period to retain the search context for scrolling.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "scroll#scroll_id_": { + "in": "query", + "name": "scroll_id", + "description": "The scroll ID for scrolled search", + "deprecated": true, + "schema": { + "$ref": "#/components/schemas/_types:ScrollId" + }, + "style": "form" + }, + "scroll#rest_total_hits_as_int": { + "in": "query", + "name": "rest_total_hits_as_int", + "description": "If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "search#index": { + "in": "path", + "name": "index", + "description": "Comma-separated list of data streams, indices, and aliases to search.\nSupports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + "search#allow_no_indices": { + "in": "query", + "name": "allow_no_indices", + "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.\nFor example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "search#allow_partial_search_results": { + "in": "query", + "name": "allow_partial_search_results", + "description": "If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "search#analyzer": { + "in": "query", + "name": "analyzer", + "description": "Analyzer to use for the query string.\nThis parameter can only be used when the q query string parameter is specified.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "search#analyze_wildcard": { + "in": "query", + "name": "analyze_wildcard", + "description": "If true, wildcard and prefix queries are analyzed.\nThis parameter can only be used when the q query string parameter is specified.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "search#batched_reduce_size": { + "in": "query", + "name": "batched_reduce_size", + "description": "The number of shard results that should be reduced at once on the coordinating node.\nThis value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "search#ccs_minimize_roundtrips": { + "in": "query", + "name": "ccs_minimize_roundtrips", + "description": "If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "search#default_operator": { + "in": "query", + "name": "default_operator", + "description": "The default operator for query string query: AND or OR.\nThis parameter can only be used when the `q` query string parameter is specified.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types.query_dsl:Operator" + }, + "style": "form" + }, + "search#df": { + "in": "query", + "name": "df", + "description": "Field to use as default where no field prefix is given in the query string.\nThis parameter can only be used when the q query string parameter is specified.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "search#docvalue_fields": { + "in": "query", + "name": "docvalue_fields", + "description": "A comma-separated list of fields to return as the docvalue representation for each hit.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + "search#expand_wildcards": { + "in": "query", + "name": "expand_wildcards", + "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + "search#explain": { + "in": "query", + "name": "explain", + "description": "If `true`, returns detailed information about score computation as part of a hit.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "search#ignore_throttled": { + "in": "query", + "name": "ignore_throttled", + "description": "If `true`, concrete, expanded or aliased indices will be ignored when frozen.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "search#ignore_unavailable": { + "in": "query", + "name": "ignore_unavailable", + "description": "If `false`, the request returns an error if it targets a missing or closed index.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "search#lenient": { + "in": "query", + "name": "lenient", + "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.\nThis parameter can only be used when the `q` query string parameter is specified.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "search#max_concurrent_shard_requests": { + "in": "query", + "name": "max_concurrent_shard_requests", + "description": "Defines the number of concurrent shard requests per node this search executes concurrently.\nThis value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "search#min_compatible_shard_node": { + "in": "query", + "name": "min_compatible_shard_node", + "description": "The minimum version of the node that can handle the request\nAny handling node with a lower version will fail the request.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:VersionString" + }, + "style": "form" + }, + "search#preference": { + "in": "query", + "name": "preference", + "description": "Nodes and shards used for the search.\nBy default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are:\n`_only_local` to run the search only on shards on the local node;\n`_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method;\n`_only_nodes:,` to run the search on only the specified nodes IDs, where, if suitable shards exist on more than one selected node, use shards on those nodes using the default method, or if none of the specified nodes are available, select shards from any available node using the default method;\n`_prefer_nodes:,` to if possible, run the search on the specified nodes IDs, or if not, select shards using the default method;\n`_shards:,` to run the search only on the specified shards;\n`` (any string that does not start with `_`) to route searches with the same `` to the same shards in the same order.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "search#pre_filter_shard_size": { + "in": "query", + "name": "pre_filter_shard_size", + "description": "Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold.\nThis filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint).\nWhen unspecified, the pre-filter phase is executed if any of these conditions is met:\nthe request targets more than 128 shards;\nthe request targets one or more read-only index;\nthe primary sort of the query targets an indexed field.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "search#request_cache": { + "in": "query", + "name": "request_cache", + "description": "If `true`, the caching of search results is enabled for requests where `size` is `0`.\nDefaults to index level settings.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "search#routing": { + "in": "query", + "name": "routing", + "description": "Custom value used to route operations to a specific shard.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Routing" + }, + "style": "form" + }, + "search#scroll": { + "in": "query", + "name": "scroll", + "description": "Period to retain the search context for scrolling. See Scroll search results.\nBy default, this value cannot exceed `1d` (24 hours).\nYou can change this limit using the `search.max_keep_alive` cluster-level setting.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "search#search_type": { + "in": "query", + "name": "search_type", + "description": "How distributed term frequencies are calculated for relevance scoring.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:SearchType" + }, + "style": "form" + }, + "search#stats": { + "in": "query", + "name": "stats", + "description": "Specific `tag` of the request for logging and statistical purposes.", + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form" + }, + "search#stored_fields": { + "in": "query", + "name": "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` parameter defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + "search#suggest_field": { + "in": "query", + "name": "suggest_field", + "description": "Specifies which field to use for suggestions.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Field" + }, + "style": "form" + }, + "search#suggest_mode": { + "in": "query", + "name": "suggest_mode", + "description": "Specifies the suggest mode.\nThis parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:SuggestMode" + }, + "style": "form" + }, + "search#suggest_size": { + "in": "query", + "name": "suggest_size", + "description": "Number of suggestions to return.\nThis parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "search#suggest_text": { + "in": "query", + "name": "suggest_text", + "description": "The source text for which the suggestions should be returned.\nThis parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "search#terminate_after": { + "in": "query", + "name": "terminate_after", + "description": "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.\nUse with caution.\nElasticsearch applies this parameter to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.\nIf set to `0` (default), the query does not terminate early.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "search#timeout": { + "in": "query", + "name": "timeout", + "description": "Specifies the period of time to wait for a response from each shard.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "search#track_total_hits": { + "in": "query", + "name": "track_total_hits", + "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_global.search._types:TrackHits" + }, + "style": "form" + }, + "search#track_scores": { + "in": "query", + "name": "track_scores", + "description": "If `true`, calculate and return document scores, even if the scores are not used for sorting.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "search#typed_keys": { + "in": "query", + "name": "typed_keys", + "description": "If `true`, aggregation and suggester names are be prefixed by their respective types in the response.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "search#rest_total_hits_as_int": { + "in": "query", + "name": "rest_total_hits_as_int", + "description": "Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "search#version": { + "in": "query", + "name": "version", + "description": "If `true`, returns document version as part of a hit.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "search#_source": { + "in": "query", + "name": "_source", + "description": "Indicates which source fields are returned for matching documents.\nThese fields are returned in the `hits._source` property of the search response.\nValid values are:\n`true` to return the entire document source;\n`false` to not return the document source;\n`` to return the source fields that are specified as a comma-separated list (supports wildcard (`*`) patterns).", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_global.search._types:SourceConfigParam" + }, + "style": "form" + }, + "search#_source_excludes": { + "in": "query", + "name": "_source_excludes", + "description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + "search#_source_includes": { + "in": "query", + "name": "_source_includes", + "description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned.\nYou can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + "search#seq_no_primary_term": { + "in": "query", + "name": "seq_no_primary_term", + "description": "If `true`, returns sequence number and primary term of the last modification of each hit.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "search#q": { + "in": "query", + "name": "q", + "description": "Query in the Lucene query string syntax using query parameter search.\nQuery parameter searches do not support the full Elasticsearch Query DSL but are handy for testing.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "search#size": { + "in": "query", + "name": "size", + "description": "Defines the number of hits to return.\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.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "search#from": { + "in": "query", + "name": "from", + "description": "Starting document offset.\nNeeds to be non-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.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "search#sort": { + "in": "query", + "name": "sort", + "description": "A comma-separated list of : pairs.", + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "style": "form" + }, + "search_application.get_behavioral_analytics#name": { + "in": "path", + "name": "name", + "description": "A list of analytics collections to limit the returned information", + "required": true, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Name" + } + }, + "style": "simple" + }, + "search_application.search#name": { + "in": "path", + "name": "name", + "description": "The name of the search application to be searched.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" + }, + "search_application.search#typed_keys": { + "in": "query", + "name": "typed_keys", + "description": "Determines whether aggregation names are prefixed by their respective types in the response.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "search_mvt#index": { + "in": "path", + "name": "index", + "description": "Comma-separated list of data streams, indices, or aliases to search", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + "search_mvt#field": { + "in": "path", + "name": "field", + "description": "Field containing geospatial data to return", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Field" + }, + "style": "simple" + }, + "search_mvt#zoom": { + "in": "path", + "name": "zoom", + "description": "Zoom level for the vector tile to search", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_global.search_mvt._types:ZoomLevel" + }, + "style": "simple" + }, + "search_mvt#x": { + "in": "path", + "name": "x", + "description": "X coordinate for the vector tile to search", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_global.search_mvt._types:Coordinate" + }, + "style": "simple" + }, + "search_mvt#y": { + "in": "path", + "name": "y", + "description": "Y coordinate for the vector tile to search", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_global.search_mvt._types:Coordinate" + }, + "style": "simple" + }, + "search_mvt#exact_bounds": { + "in": "query", + "name": "exact_bounds", + "description": "If false, the meta layer’s feature is the bounding box of the tile.\nIf true, the meta layer’s feature is a bounding box resulting from a\ngeo_bounds aggregation. The aggregation runs on values that intersect\nthe // tile with wrap_longitude set to false. The resulting\nbounding box may be larger than the vector tile.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "search_mvt#extent": { + "in": "query", + "name": "extent", + "description": "Size, in pixels, of a side of the tile. Vector tiles are square with equal sides.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "search_mvt#grid_agg": { + "in": "query", + "name": "grid_agg", + "description": "Aggregation used to create a grid for `field`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_global.search_mvt._types:GridAggregationType" + }, + "style": "form" + }, + "search_mvt#grid_precision": { + "in": "query", + "name": "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.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "search_mvt#grid_type": { + "in": "query", + "name": "grid_type", + "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_global.search_mvt._types:GridType" + }, + "style": "form" + }, + "search_mvt#size": { + "in": "query", + "name": "size", + "description": "Maximum number of features to return in the hits layer. Accepts 0-10000.\nIf 0, results don’t include the hits layer.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "search_mvt#with_labels": { + "in": "query", + "name": "with_labels", + "description": "If `true`, the hits and aggs layers will contain additional point features representing\nsuggested label positions for the original features.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "search_template#index": { + "in": "path", + "name": "index", + "description": "Comma-separated list of data streams, indices,\nand aliases to search. Supports wildcards (*).", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Indices" + }, + "style": "simple" + }, + "search_template#allow_no_indices": { + "in": "query", + "name": "allow_no_indices", + "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.\nFor example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "search_template#ccs_minimize_roundtrips": { + "in": "query", + "name": "ccs_minimize_roundtrips", + "description": "If `true`, network round-trips are minimized for cross-cluster search requests.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "search_template#expand_wildcards": { + "in": "query", + "name": "expand_wildcards", + "description": "Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "style": "form" + }, + "search_template#explain": { + "in": "query", + "name": "explain", + "description": "If `true`, the response includes additional details about score computation as part of a hit.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "search_template#ignore_throttled": { + "in": "query", + "name": "ignore_throttled", + "description": "If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "search_template#ignore_unavailable": { + "in": "query", + "name": "ignore_unavailable", + "description": "If `false`, the request returns an error if it targets a missing or closed index.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "search_template#preference": { + "in": "query", + "name": "preference", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "search_template#profile": { + "in": "query", + "name": "profile", + "description": "If `true`, the query execution is profiled.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "search_template#routing": { + "in": "query", + "name": "routing", + "description": "Custom value used to route operations to a specific shard.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Routing" + }, + "style": "form" + }, + "search_template#scroll": { + "in": "query", + "name": "scroll", + "description": "Specifies how long a consistent view of the index\nshould be maintained for scrolled search.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + }, + "search_template#search_type": { + "in": "query", + "name": "search_type", + "description": "The type of the search operation.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:SearchType" + }, + "style": "form" + }, + "search_template#rest_total_hits_as_int": { + "in": "query", + "name": "rest_total_hits_as_int", + "description": "If true, hits.total are rendered as an integer in the response.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "search_template#typed_keys": { + "in": "query", + "name": "typed_keys", + "description": "If `true`, the response prefixes aggregation and suggester names with their respective types.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "security.create_api_key#refresh": { + "in": "query", + "name": "refresh", + "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Refresh" + }, + "style": "form" + }, + "security.has_privileges#user": { + "in": "path", + "name": "user", + "description": "Username", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Name" + }, + "style": "simple" + }, + "security.query_api_keys#with_limited_by": { + "in": "query", + "name": "with_limited_by", + "description": "Return the snapshot of the owner user's role descriptors associated with the API key.\nAn API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "security.query_api_keys#with_profile_uid": { + "in": "query", + "name": "with_profile_uid", + "description": "Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "security.query_api_keys#typed_keys": { + "in": "query", + "name": "typed_keys", + "description": "Determines whether aggregation names are prefixed by their respective types in the response.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "sql.query#format": { + "in": "query", + "name": "format", + "description": "Format for the response.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "terms_enum#index": { + "in": "path", + "name": "index", + "description": "Comma-separated list of data streams, indices, and index aliases to search. Wildcard (*) expressions are supported.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "style": "simple" + }, + "termvectors#index": { + "in": "path", + "name": "index", + "description": "Name of the index that contains the document.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "style": "simple" + }, + "termvectors#id": { + "in": "path", + "name": "id", + "description": "Unique identifier of the document.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "termvectors#fields": { + "in": "query", + "name": "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.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Fields" + }, + "style": "form" + }, + "termvectors#field_statistics": { + "in": "query", + "name": "field_statistics", + "description": "If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "termvectors#offsets": { + "in": "query", + "name": "offsets", + "description": "If `true`, the response includes term offsets.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "termvectors#payloads": { + "in": "query", + "name": "payloads", + "description": "If `true`, the response includes term payloads.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "termvectors#positions": { + "in": "query", + "name": "positions", + "description": "If `true`, the response includes term positions.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "termvectors#preference": { + "in": "query", + "name": "preference", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + "termvectors#realtime": { + "in": "query", + "name": "realtime", + "description": "If true, the request is real-time as opposed to near-real-time.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "termvectors#routing": { + "in": "query", + "name": "routing", + "description": "Custom value used to route operations to a specific shard.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Routing" + }, + "style": "form" + }, + "termvectors#term_statistics": { + "in": "query", + "name": "term_statistics", + "description": "If `true`, the response includes term frequency and document frequency.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "termvectors#version": { + "in": "query", + "name": "version", + "description": "If `true`, returns the document version as part of a hit.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "style": "form" + }, + "termvectors#version_type": { + "in": "query", + "name": "version_type", + "description": "Specific version type.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:VersionType" + }, + "style": "form" + }, + "transform.get_transform#transform_id": { + "in": "path", + "name": "transform_id", + "description": "Identifier for the transform. It can be a transform identifier or a\nwildcard expression. You can get information for all transforms by using\n`_all`, by specifying `*` as the ``, or by omitting the\n``.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Names" + }, + "style": "simple" + }, + "transform.get_transform#allow_no_match": { + "in": "query", + "name": "allow_no_match", + "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no transforms that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf this parameter is false, the request returns a 404 status code when\nthere are no matches or only partial matches.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "transform.get_transform#from": { + "in": "query", + "name": "from", + "description": "Skips the specified number of transforms.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "transform.get_transform#size": { + "in": "query", + "name": "size", + "description": "Specifies the maximum number of transforms to obtain.", + "deprecated": false, + "schema": { + "type": "number" + }, + "style": "form" + }, + "transform.get_transform#exclude_generated": { + "in": "query", + "name": "exclude_generated", + "description": "Excludes fields that were automatically added when creating the\ntransform. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + "transform.preview_transform#transform_id": { + "in": "path", + "name": "transform_id", + "description": "Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform\nconfiguration details in the request body.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + }, + "transform.preview_transform#timeout": { + "in": "query", + "name": "timeout", + "description": "Period to wait for a response. If no response is received before the\ntimeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Duration" + }, + "style": "form" + } + }, + "requestBodies": { + "async_search.submit": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:AggregationContainer" + } + }, + "collapse": { + "$ref": "#/components/schemas/_global.search._types:FieldCollapse" + }, + "explain": { + "description": "If true, returns detailed information about score computation as part of a hit.", + "type": "boolean" + }, + "ext": { + "description": "Configuration of search extensions defined by Elasticsearch plugins.", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "from": { + "description": "Starting document offset. By default, you cannot page through more than 10,000\nhits using the from and size parameters. To page through more hits, use the\nsearch_after parameter.", + "type": "number" + }, + "highlight": { + "$ref": "#/components/schemas/_global.search._types:Highlight" + }, + "track_total_hits": { + "$ref": "#/components/schemas/_global.search._types:TrackHits" + }, + "indices_boost": { + "description": "Boosts the _score of documents from specified indices.", + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "number" + } + } + }, + "docvalue_fields": { + "description": "Array of wildcard (*) patterns. The request returns doc values for field\nnames matching these patterns in the hits.fields property of the response.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:FieldAndFormat" + } + }, + "knn": { + "description": "Defines the approximate kNN search to run.", + "x-available-since": "8.4.0", + "oneOf": [ + { + "$ref": "#/components/schemas/_types:KnnSearch" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:KnnSearch" + } + } + ] + }, + "min_score": { + "description": "Minimum _score for matching documents. Documents with a lower _score are\nnot included in the search results.", + "type": "number" + }, + "post_filter": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "profile": { + "type": "boolean" + }, + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "rescore": { + "oneOf": [ + { + "$ref": "#/components/schemas/_global.search._types:Rescore" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.search._types:Rescore" + } + } + ] + }, + "script_fields": { + "description": "Retrieve a script evaluation (based on different fields) for each hit.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types:ScriptField" + } + }, + "search_after": { + "$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.", + "type": "number" + }, + "slice": { + "$ref": "#/components/schemas/_types:SlicedScroll" + }, + "sort": { + "$ref": "#/components/schemas/_types:Sort" + }, + "_source": { + "$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.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:FieldAndFormat" + } + }, + "suggest": { + "$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.", + "type": "number" + }, + "timeout": { + "description": "Specifies the period of time to wait for a response from each shard. If no response\nis received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.", + "type": "string" + }, + "track_scores": { + "description": "If true, calculate and return document scores, even if the scores are not used for sorting.", + "type": "boolean" + }, + "version": { + "description": "If true, returns document version as part of a hit.", + "type": "boolean" + }, + "seq_no_primary_term": { + "description": "If true, returns sequence number and primary term of the last modification\nof each hit. See Optimistic concurrency control.", + "type": "boolean" + }, + "stored_fields": { + "$ref": "#/components/schemas/_types:Fields" + }, + "pit": { + "$ref": "#/components/schemas/_global.search._types:PointInTimeReference" + }, + "runtime_mappings": { + "$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.", + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "bulk": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/_global.bulk:OperationContainer" + }, + { + "$ref": "#/components/schemas/_global.bulk:UpdateAction" + }, + { + "type": "object" + } + ] + } + } + } + }, + "required": true + }, + "clear_scroll": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "scroll_id": { + "$ref": "#/components/schemas/_types:ScrollIds" + } + } + } + } + } + }, + "cluster.put_component_template": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "template": { + "$ref": "#/components/schemas/indices._types:IndexState" + }, + "version": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "_meta": { + "$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.", + "type": "boolean" + } + }, + "required": [ + "template" + ] + } + } + }, + "required": true + }, + "connector.put": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "index_name": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "is_native": { + "type": "boolean" + }, + "language": { + "type": "string" + }, + "name": { + "type": "string" + }, + "service_type": { + "type": "string" + } + } + } + } + } + }, + "count": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + } + } + } + } + } + }, + "create": { + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + }, + "required": true + }, + "eql.search": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "query": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html" + }, + "description": "EQL query you wish to run.", + "type": "string" + }, + "case_sensitive": { + "type": "boolean" + }, + "event_category_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "tiebreaker_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "timestamp_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "fetch_size": { + "$ref": "#/components/schemas/_types:uint" + }, + "filter": { + "description": "Query, written in Query DSL, used to filter the events on which the EQL query runs.", + "oneOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + } + } + ] + }, + "keep_alive": { + "$ref": "#/components/schemas/_types:Duration" + }, + "keep_on_completion": { + "type": "boolean" + }, + "wait_for_completion_timeout": { + "$ref": "#/components/schemas/_types:Duration" + }, + "size": { + "$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.", + "oneOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:FieldAndFormat" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:FieldAndFormat" + } + } + ] + }, + "result_position": { + "$ref": "#/components/schemas/eql.search:ResultPosition" + }, + "runtime_mappings": { + "$ref": "#/components/schemas/_types.mapping:RuntimeFields" + } + }, + "required": [ + "query" + ] + } + } + }, + "required": true + }, + "explain": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + } + } + } + } + } + }, + "field_caps": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "fields": { + "$ref": "#/components/schemas/_types:Fields" + }, + "index_filter": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "runtime_mappings": { + "$ref": "#/components/schemas/_types.mapping:RuntimeFields" + } + } + } + } + } + }, + "graph.explore": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "connections": { + "$ref": "#/components/schemas/graph._types:Hop" + }, + "controls": { + "$ref": "#/components/schemas/graph._types:ExploreControls" + }, + "query": { + "$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.", + "type": "array", + "items": { + "$ref": "#/components/schemas/graph._types:VertexDefinition" + } + } + } + } + } + } + }, + "index": { + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + }, + "required": true + }, + "indices.analyze": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "analyzer": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-analyzers.html" + }, + "description": "The name of the analyzer that should be applied to the provided `text`.\nThis could be a built-in analyzer, or an analyzer that’s been configured in the index.", + "type": "string" + }, + "attributes": { + "description": "Array of token attributes used to filter the output of the `explain` parameter.", + "type": "array", + "items": { + "type": "string" + } + }, + "char_filter": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-charfilters.html" + }, + "description": "Array of character filters used to preprocess characters before the tokenizer.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.analysis:CharFilter" + } + }, + "explain": { + "description": "If `true`, the response includes token attributes and additional details.", + "type": "boolean" + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "filter": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenfilters.html" + }, + "description": "Array of token filters used to apply after the tokenizer.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.analysis:TokenFilter" + } + }, + "normalizer": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-normalizers.html" + }, + "description": "Normalizer to use to convert text into a single token.", + "type": "string" + }, + "text": { + "$ref": "#/components/schemas/indices.analyze:TextToAnalyze" + }, + "tokenizer": { + "$ref": "#/components/schemas/_types.analysis:Tokenizer" + } + } + } + } + } + }, + "indices.put_alias": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "filter": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "index_routing": { + "$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" + }, + "search_routing": { + "$ref": "#/components/schemas/_types:Routing" + } + } + } + } + } + }, + "indices.put_index_template": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "index_patterns": { + "$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.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Name" + } + }, + "template": { + "$ref": "#/components/schemas/indices.put_index_template:IndexTemplateMapping" + }, + "data_stream": { + "$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" + }, + "_meta": { + "$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.", + "type": "boolean" + }, + "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", + "type": "array", + "items": { + "type": "string" + } + }, + "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.", + "type": "boolean" + } + } + } + } + }, + "required": true + }, + "indices.put_mapping": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "date_detection": { + "description": "Controls whether dynamic date detection is enabled.", + "type": "boolean" + }, + "dynamic": { + "$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.", + "type": "array", + "items": { + "type": "string" + } + }, + "dynamic_templates": { + "description": "Specify dynamic templates for the mapping.", + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.mapping:DynamicTemplate" + } + }, + { + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.mapping:DynamicTemplate" + } + } + } + ] + }, + "_field_names": { + "$ref": "#/components/schemas/_types.mapping:FieldNamesField" + }, + "_meta": { + "$ref": "#/components/schemas/_types:Metadata" + }, + "numeric_detection": { + "description": "Automatically map strings into numeric data types for all fields.", + "type": "boolean" + }, + "properties": { + "description": "Mapping for a field. For new fields, this mapping can include:\n\n- Field name\n- Field data type\n- Mapping parameters", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.mapping:Property" + } + }, + "_routing": { + "$ref": "#/components/schemas/_types.mapping:RoutingField" + }, + "_source": { + "$ref": "#/components/schemas/_types.mapping:SourceField" + }, + "runtime": { + "$ref": "#/components/schemas/_types.mapping:RuntimeFields" + } + } + } + } + }, + "required": true + }, + "indices.put_settings": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/indices._types:IndexSettings" + } + } + }, + "required": true + }, + "indices.put_template": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aliases": { + "description": "Aliases for the index.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/indices._types:Alias" + } + }, + "index_patterns": { + "description": "Array of wildcard expressions used to match the names\nof indices during creation.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "mappings": { + "$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" + }, + "version": { + "$ref": "#/components/schemas/_types:VersionNumber" + } + } + } + } + }, + "required": true + }, + "indices.rollover": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aliases": { + "description": "Aliases for the target index.\nData streams do not support this parameter.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/indices._types:Alias" + } + }, + "conditions": { + "$ref": "#/components/schemas/indices.rollover:RolloverConditions" + }, + "mappings": { + "$ref": "#/components/schemas/_types.mapping:TypeMapping" + }, + "settings": { + "description": "Configuration options for the index.\nData streams do not support this parameter.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + } + } + } + }, + "indices.simulate_template": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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.", + "type": "boolean" + }, + "index_patterns": { + "$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.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Name" + } + }, + "template": { + "$ref": "#/components/schemas/indices.put_index_template:IndexTemplateMapping" + }, + "data_stream": { + "$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" + }, + "_meta": { + "$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", + "type": "array", + "items": { + "type": "string" + } + }, + "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.", + "type": "boolean" + } + } + } + } + } + }, + "indices.validate_query": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + } + } + } + } + } + }, + "inference.inference": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "query": { + "description": "Query input, required for rerank task.\nNot required for other tasks.", + "type": "string" + }, + "input": { + "description": "Inference input.\nEither a string or an array of strings.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "task_settings": { + "$ref": "#/components/schemas/inference._types:TaskSettings" + } + }, + "required": [ + "input" + ] + } + } + } + }, + "inference.put": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/inference._types:InferenceEndpoint" + } + } + }, + "required": true + }, + "ingest.simulate": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "docs": { + "description": "Sample documents to test in the pipeline.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ingest.simulate:Document" + } + }, + "pipeline": { + "$ref": "#/components/schemas/ingest._types:Pipeline" + } + } + } + } + }, + "required": true + }, + "mget": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "docs": { + "description": "The documents you want to retrieve. Required if no index is specified in the request URI.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.mget:Operation" + } + }, + "ids": { + "$ref": "#/components/schemas/_types:Ids" + } + } + } + } + }, + "required": true + }, + "ml.get_calendars": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "page": { + "$ref": "#/components/schemas/ml._types:Page" + } + } + } + } + } + }, + "ml.get_overall_buckets": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "allow_no_match": { + "description": "Refer to the description for the `allow_no_match` query parameter.", + "type": "boolean" + }, + "bucket_span": { + "$ref": "#/components/schemas/_types:Duration" + }, + "end": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "exclude_interim": { + "description": "Refer to the description for the `exclude_interim` query parameter.", + "type": "boolean" + }, + "overall_score": { + "description": "Refer to the description for the `overall_score` query parameter.", + "oneOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "start": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "top_n": { + "description": "Refer to the description for the `top_n` query parameter.", + "type": "number" + } + } + } + } + } + }, + "ml.infer_trained_model": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "docs": { + "description": "An array of objects to pass to the model for inference. The objects should contain a fields matching your\nconfigured trained model input. Typically, for NLP models, the field name is `text_field`.\nCurrently, for NLP models, only a single value is allowed.", + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "inference_config": { + "$ref": "#/components/schemas/ml._types:InferenceConfigUpdateContainer" + } + }, + "required": [ + "docs" + ] + } + } + }, + "required": true + }, + "ml.preview_data_frame_analytics": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "config": { + "$ref": "#/components/schemas/ml.preview_data_frame_analytics:DataframePreviewConfig" + } + } + } + } + } + }, + "ml.preview_datafeed": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "datafeed_config": { + "$ref": "#/components/schemas/ml._types:DatafeedConfig" + }, + "job_config": { + "$ref": "#/components/schemas/ml._types:JobConfig" + } + } + } + } + } + }, + "msearch": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.msearch:RequestItem" + } + } + } + }, + "required": true + }, + "msearch_template": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.msearch_template:RequestItem" + } + } + } + }, + "required": true + }, + "mtermvectors": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "docs": { + "description": "Array of existing or artificial documents.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.mtermvectors:Operation" + } + }, + "ids": { + "description": "Simplified syntax to specify documents by their ID if they're in the same index.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Id" + } + } + } + } + } + } + }, + "put_script": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "script": { + "$ref": "#/components/schemas/_types:StoredScript" + } + }, + "required": [ + "script" + ] + } + } + }, + "required": true + }, + "rank_eval": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "requests": { + "description": "A set of typical search requests, together with their provided ratings.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.rank_eval:RankEvalRequestItem" + } + }, + "metric": { + "$ref": "#/components/schemas/_global.rank_eval:RankEvalMetric" + } + }, + "required": [ + "requests" + ] + } + } + }, + "required": true + }, + "render_search_template": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "file": { + "type": "string" + }, + "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.", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "source": { + "description": "An inline search template.\nSupports 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.", + "type": "string" + } + } + } + } + } + }, + "scripts_painless_execute": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "context": { + "description": "The context that the script should run in.", + "type": "string" + }, + "context_setup": { + "$ref": "#/components/schemas/_global.scripts_painless_execute:PainlessContextSetup" + }, + "script": { + "$ref": "#/components/schemas/_types:Script" + } + } + } + } + } + }, + "scroll": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "scroll": { + "$ref": "#/components/schemas/_types:Duration" + }, + "scroll_id": { + "$ref": "#/components/schemas/_types:ScrollId" + } + }, + "required": [ + "scroll_id" + ] + } + } + } + }, + "search": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "description": "Defines the aggregations that are run as part of the search request.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:AggregationContainer" + } + }, + "collapse": { + "$ref": "#/components/schemas/_global.search._types:FieldCollapse" + }, + "explain": { + "description": "If true, returns detailed information about score computation as part of a hit.", + "type": "boolean" + }, + "ext": { + "description": "Configuration of search extensions defined by Elasticsearch plugins.", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "from": { + "description": "Starting document offset.\nNeeds to be non-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.", + "type": "number" + }, + "highlight": { + "$ref": "#/components/schemas/_global.search._types:Highlight" + }, + "track_total_hits": { + "$ref": "#/components/schemas/_global.search._types:TrackHits" + }, + "indices_boost": { + "description": "Boosts the _score of documents from specified indices.", + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "number" + } + } + }, + "docvalue_fields": { + "description": "Array of wildcard (`*`) patterns.\nThe request returns doc values for field names matching these patterns in the `hits.fields` property of the response.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:FieldAndFormat" + } + }, + "knn": { + "description": "Defines the approximate kNN search to run.", + "x-available-since": "8.4.0", + "oneOf": [ + { + "$ref": "#/components/schemas/_types:KnnSearch" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:KnnSearch" + } + } + ] + }, + "rank": { + "$ref": "#/components/schemas/_types:RankContainer" + }, + "min_score": { + "description": "Minimum `_score` for matching documents.\nDocuments with a lower `_score` are not included in the search results.", + "type": "number" + }, + "post_filter": { + "$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.", + "type": "boolean" + }, + "query": { + "$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.", + "oneOf": [ + { + "$ref": "#/components/schemas/_global.search._types:Rescore" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.search._types:Rescore" + } + } + ] + }, + "retriever": { + "$ref": "#/components/schemas/_types:RetrieverContainer" + }, + "script_fields": { + "description": "Retrieve a script evaluation (based on different fields) for each hit.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types:ScriptField" + } + }, + "search_after": { + "$ref": "#/components/schemas/_types:SortResults" + }, + "size": { + "description": "The number of hits to return.\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.", + "type": "number" + }, + "slice": { + "$ref": "#/components/schemas/_types:SlicedScroll" + }, + "sort": { + "$ref": "#/components/schemas/_types:Sort" + }, + "_source": { + "$ref": "#/components/schemas/_global.search._types:SourceConfig" + }, + "fields": { + "description": "Array of wildcard (`*`) patterns.\nThe request returns values for field names matching these patterns in the `hits.fields` property of the response.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:FieldAndFormat" + } + }, + "suggest": { + "$ref": "#/components/schemas/_global.search._types:Suggester" + }, + "terminate_after": { + "description": "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.\nUse with caution.\nElasticsearch applies this parameter to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.\nIf set to `0` (default), the query does not terminate early.", + "type": "number" + }, + "timeout": { + "description": "Specifies the period of time to wait for a response from each shard.\nIf no response is received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.", + "type": "string" + }, + "track_scores": { + "description": "If true, calculate and return document scores, even if the scores are not used for sorting.", + "type": "boolean" + }, + "version": { + "description": "If true, returns document version as part of a hit.", + "type": "boolean" + }, + "seq_no_primary_term": { + "description": "If `true`, returns sequence number and primary term of the last modification of each hit.", + "type": "boolean" + }, + "stored_fields": { + "$ref": "#/components/schemas/_types:Fields" + }, + "pit": { + "$ref": "#/components/schemas/_global.search._types:PointInTimeReference" + }, + "runtime_mappings": { + "$ref": "#/components/schemas/_types.mapping:RuntimeFields" + }, + "stats": { + "description": "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.", + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "search_application.search": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "params": { + "description": "Query parameters specific to this request, which will override any defaults specified in the template.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + } + } + } + }, + "search_mvt": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggs": { + "description": "Sub-aggregations for the geotile_grid.\n\nSupports the following aggregation types:\n- avg\n- cardinality\n- max\n- min\n- sum", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:AggregationContainer" + } + }, + "buffer": { + "description": "Size, in pixels, of a clipping buffer outside the tile. This allows renderers\nto avoid outline artifacts from geometries that extend past the extent of the tile.", + "type": "number" + }, + "exact_bounds": { + "description": "If false, the meta layer’s feature is the bounding box of the tile.\nIf true, the meta layer’s feature is a bounding box resulting from a\ngeo_bounds aggregation. The aggregation runs on values that intersect\nthe // tile with wrap_longitude set to false. The resulting\nbounding box may be larger than the vector tile.", + "type": "boolean" + }, + "extent": { + "description": "Size, in pixels, of a side of the tile. Vector tiles are square with equal sides.", + "type": "number" + }, + "fields": { + "$ref": "#/components/schemas/_types:Fields" + }, + "grid_agg": { + "$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.", + "type": "number" + }, + "grid_type": { + "$ref": "#/components/schemas/_global.search_mvt._types:GridType" + }, + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "runtime_mappings": { + "$ref": "#/components/schemas/_types.mapping:RuntimeFields" + }, + "size": { + "description": "Maximum number of features to return in the hits layer. Accepts 0-10000.\nIf 0, results don’t include the hits layer.", + "type": "number" + }, + "sort": { + "$ref": "#/components/schemas/_types:Sort" + }, + "track_total_hits": { + "$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.", + "type": "boolean" + } + } + } + } + } + }, + "search_template": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "explain": { + "description": "If `true`, returns detailed information about score calculation as part of each hit.", + "type": "boolean" + }, + "id": { + "$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.", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "profile": { + "description": "If `true`, the query execution is profiled.", + "type": "boolean" + }, + "source": { + "description": "An inline search template. Supports the same parameters as the search API's\nrequest body. Also supports Mustache variables. If no id is specified, this\nparameter is required.", + "type": "string" + } + } + } + } + }, + "required": true + }, + "security.create_api_key": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "expiration": { + "$ref": "#/components/schemas/_types:Duration" + }, + "name": { + "$ref": "#/components/schemas/_types:Name" + }, + "role_descriptors": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html" + }, + "description": "An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/security._types:RoleDescriptor" + } + }, + "metadata": { + "$ref": "#/components/schemas/_types:Metadata" + } + } + } + } + }, + "required": true + }, + "security.has_privileges": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "application": { + "type": "array", + "items": { + "$ref": "#/components/schemas/security.has_privileges:ApplicationPrivilegesCheck" + } + }, + "cluster": { + "description": "A list of the cluster privileges that you want to check.", + "type": "array", + "items": { + "$ref": "#/components/schemas/security._types:ClusterPrivilege" + } + }, + "index": { + "type": "array", + "items": { + "$ref": "#/components/schemas/security.has_privileges:IndexPrivilegesCheck" + } + } + } + } + } + }, + "required": true + }, + "security.query_api_keys": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "description": "Any aggregations to run over the corpus of returned API keys.\nAggregations and queries work together. Aggregations are computed only on the API keys that match the query.\nThis supports only a subset of aggregation types, namely: `terms`, `range`, `date_range`, `missing`,\n`cardinality`, `value_count`, `composite`, `filter`, and `filters`.\nAdditionally, aggregations only run over the same subset of fields that query works with.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/security.query_api_keys:ApiKeyAggregationContainer" + } + }, + "query": { + "$ref": "#/components/schemas/security.query_api_keys:ApiKeyQueryContainer" + }, + "from": { + "description": "Starting document offset.\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.", + "type": "number" + }, + "sort": { + "$ref": "#/components/schemas/_types:Sort" + }, + "size": { + "description": "The number of hits to return.\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.", + "type": "number" + }, + "search_after": { + "$ref": "#/components/schemas/_types:SortResults" + } + } + } + } + } + }, + "sql.query": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "catalog": { + "description": "Default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only.", + "type": "string" + }, + "columnar": { + "description": "If true, the results in a columnar fashion: one row represents all the values of a certain column from the current page of results.", + "type": "boolean" + }, + "cursor": { + "description": "Cursor used to retrieve a set of paginated results.\nIf you specify a cursor, the API only uses the `columnar` and `time_zone` request body parameters.\nIt ignores other request body parameters.", + "type": "string" + }, + "fetch_size": { + "description": "The maximum number of rows (or entries) to return in one response", + "type": "number" + }, + "filter": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "query": { + "description": "SQL query to run.", + "type": "string" + }, + "request_timeout": { + "$ref": "#/components/schemas/_types:Duration" + }, + "page_timeout": { + "$ref": "#/components/schemas/_types:Duration" + }, + "time_zone": { + "$ref": "#/components/schemas/_types:TimeZone" + }, + "field_multi_value_leniency": { + "description": "Throw an exception when encountering multiple values for a field (default) or be lenient and return the first value from the list (without any guarantees of what that will be - typically the first in natural ascending order).", + "type": "boolean" + }, + "runtime_mappings": { + "$ref": "#/components/schemas/_types.mapping:RuntimeFields" + }, + "wait_for_completion_timeout": { + "$ref": "#/components/schemas/_types:Duration" + }, + "params": { + "description": "Values for parameters in the query.", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "keep_alive": { + "$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. If false, Elasticsearch only stores async searches that don’t finish before the wait_for_completion_timeout.", + "type": "boolean" + }, + "index_using_frozen": { + "description": "If true, the search can run on frozen indices. Defaults to false.", + "type": "boolean" + } + } + } + } + }, + "required": true + }, + "sql.translate": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "fetch_size": { + "description": "The maximum number of rows (or entries) to return in one response.", + "type": "number" + }, + "filter": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "query": { + "description": "SQL query to run.", + "type": "string" + }, + "time_zone": { + "$ref": "#/components/schemas/_types:TimeZone" + } + }, + "required": [ + "query" + ] + } + } + }, + "required": true + }, + "terms_enum": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "size": { + "description": "How many matching terms to return.", + "type": "number" + }, + "timeout": { + "$ref": "#/components/schemas/_types:Duration" + }, + "case_insensitive": { + "description": "When true the provided search string is matched against index terms without case sensitivity.", + "type": "boolean" + }, + "index_filter": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "string": { + "description": "The string after which terms in the index should be returned. Allows for a form of pagination if the last result from one request is passed as the search_after parameter for a subsequent request.", + "type": "string" + }, + "search_after": { + "type": "string" + } + }, + "required": [ + "field" + ] + } + } + } + }, + "termvectors": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "doc": { + "description": "An artificial document (a document not present in the index) for which you want to retrieve term vectors.", + "type": "object" + }, + "filter": { + "$ref": "#/components/schemas/_global.termvectors:Filter" + }, + "per_field_analyzer": { + "description": "Overrides the default per-field analyzer.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + } + } + }, + "transform.preview_transform": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "dest": { + "$ref": "#/components/schemas/transform._types:Destination" + }, + "description": { + "description": "Free text description of the transform.", + "type": "string" + }, + "frequency": { + "$ref": "#/components/schemas/_types:Duration" + }, + "pivot": { + "$ref": "#/components/schemas/transform._types:Pivot" + }, + "source": { + "$ref": "#/components/schemas/transform._types:Source" + }, + "settings": { + "$ref": "#/components/schemas/transform._types:Settings" + }, + "sync": { + "$ref": "#/components/schemas/transform._types:SyncContainer" + }, + "retention_policy": { + "$ref": "#/components/schemas/transform._types:RetentionPolicyContainer" + }, + "latest": { + "$ref": "#/components/schemas/transform._types:Latest" + } + } + } + } + } + } + }, + "schemas": { + "_types:Id": { + "type": "string" + }, + "_types:AcknowledgedResponseBase": { + "type": "object", + "properties": { + "acknowledged": { + "description": "For a successful response, this value is always true. On failure, an exception is returned instead.", + "type": "boolean" + } + }, + "required": [ + "acknowledged" + ] + }, + "_types:Duration": { + "externalDocs": { + "url": "https://github.com/elastic/elasticsearch/blob/current/libs/core/src/main/java/org/elasticsearch/core/TimeValue.java" + }, + "description": "A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and\n`d` (days). Also accepts \"0\" without a unit and \"-1\" to indicate an unspecified value.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "-1" + ] + }, + { + "type": "string", + "enum": [ + "0" + ] + } + ] + }, + "async_search._types:AsyncSearchDocumentResponseBase": { + "allOf": [ + { + "$ref": "#/components/schemas/async_search._types:AsyncSearchResponseBase" + }, + { + "type": "object", + "properties": { + "response": { + "$ref": "#/components/schemas/async_search._types:AsyncSearch" + } + }, + "required": [ + "response" + ] + } + ] + }, + "async_search._types:AsyncSearch": { + "type": "object", + "properties": { + "aggregations": { + "description": "Partial aggregations results, coming from the shards that have already completed the execution of the query.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:Aggregate" + } + }, + "_clusters": { + "$ref": "#/components/schemas/_types:ClusterStatistics" + }, + "fields": { + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "hits": { + "$ref": "#/components/schemas/_global.search._types:HitsMetadata" + }, + "max_score": { + "type": "number" + }, + "num_reduce_phases": { + "description": "Indicates how many reductions of the results have been performed.\nIf this number increases compared to the last retrieved results for a get asynch search request, you can expect additional results included in the search response.", + "type": "number" + }, + "profile": { + "$ref": "#/components/schemas/_global.search._types:Profile" + }, + "pit_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "_scroll_id": { + "$ref": "#/components/schemas/_types:ScrollId" + }, + "_shards": { + "$ref": "#/components/schemas/_types:ShardStatistics" + }, + "suggest": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.search._types:Suggest" + } + } + }, + "terminated_early": { + "type": "boolean" + }, + "timed_out": { + "type": "boolean" + }, + "took": { + "type": "number" + } + }, + "required": [ + "hits", + "_shards", + "timed_out", + "took" + ] + }, + "_types.aggregations:Aggregate": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:CardinalityAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:HdrPercentilesAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:HdrPercentileRanksAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:TDigestPercentilesAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:TDigestPercentileRanksAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:PercentilesBucketAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:MedianAbsoluteDeviationAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:MinAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:MaxAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:SumAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:AvgAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:WeightedAvgAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:ValueCountAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:SimpleValueAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:DerivativeAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:BucketMetricValueAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:StatsAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:StatsBucketAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:ExtendedStatsAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:ExtendedStatsBucketAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:GeoBoundsAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:GeoCentroidAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:HistogramAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:DateHistogramAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:AutoDateHistogramAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:VariableWidthHistogramAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:StringTermsAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:LongTermsAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:DoubleTermsAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:UnmappedTermsAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:LongRareTermsAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:StringRareTermsAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:UnmappedRareTermsAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:MultiTermsAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:MissingAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:NestedAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:ReverseNestedAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:GlobalAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:FilterAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:ChildrenAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:ParentAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:SamplerAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:UnmappedSamplerAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:GeoHashGridAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:GeoTileGridAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:GeoHexGridAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:RangeAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:DateRangeAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:GeoDistanceAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:IpRangeAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:IpPrefixAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:FiltersAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:AdjacencyMatrixAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:SignificantLongTermsAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:SignificantStringTermsAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:UnmappedSignificantTermsAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:CompositeAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:FrequentItemSetsAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:ScriptedMetricAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:TopHitsAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:InferenceAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:StringStatsAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:BoxPlotAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:TopMetricsAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:TTestAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:RateAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:CumulativeCardinalityAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:MatrixStatsAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:GeoLineAggregate" + } + ] + }, + "_types.aggregations:CardinalityAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "value": { + "type": "number" + } + }, + "required": [ + "value" + ] + } + ] + }, + "_types.aggregations:AggregateBase": { + "type": "object", + "properties": { + "meta": { + "$ref": "#/components/schemas/_types:Metadata" + } + } + }, + "_types:Metadata": { + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "_types.aggregations:HdrPercentilesAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:PercentilesAggregateBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:PercentilesAggregateBase": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "values": { + "$ref": "#/components/schemas/_types.aggregations:Percentiles" + } + }, + "required": [ + "values" + ] + } + ] + }, + "_types.aggregations:Percentiles": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:KeyedPercentiles" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:ArrayPercentilesItem" + } + } + ] + }, + "_types.aggregations:KeyedPercentiles": { + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + } + }, + "_types.aggregations:ArrayPercentilesItem": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "value_as_string": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + }, + "_types.aggregations:HdrPercentileRanksAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:PercentilesAggregateBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:TDigestPercentilesAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:PercentilesAggregateBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:TDigestPercentileRanksAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:PercentilesAggregateBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:PercentilesBucketAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:PercentilesAggregateBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:MedianAbsoluteDeviationAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:SingleMetricAggregateBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:SingleMetricAggregateBase": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "value": { + "description": "The metric value. A missing value generally means that there was no data to aggregate,\nunless specified otherwise.", + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "value_as_string": { + "type": "string" + } + }, + "required": [ + "value" + ] + } + ] + }, + "_types.aggregations:MinAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:SingleMetricAggregateBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:MaxAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:SingleMetricAggregateBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:SumAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:SingleMetricAggregateBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:AvgAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:SingleMetricAggregateBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:WeightedAvgAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:SingleMetricAggregateBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:ValueCountAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:SingleMetricAggregateBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:SimpleValueAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:SingleMetricAggregateBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:DerivativeAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:SingleMetricAggregateBase" + }, + { + "type": "object", + "properties": { + "normalized_value": { + "type": "number" + }, + "normalized_value_as_string": { + "type": "string" + } + } + } + ] + }, + "_types.aggregations:BucketMetricValueAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:SingleMetricAggregateBase" + }, + { + "type": "object", + "properties": { + "keys": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "keys" + ] + } + ] + }, + "_types.aggregations:StatsAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "min": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "max": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "avg": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "sum": { + "type": "number" + }, + "min_as_string": { + "type": "string" + }, + "max_as_string": { + "type": "string" + }, + "avg_as_string": { + "type": "string" + }, + "sum_as_string": { + "type": "string" + } + }, + "required": [ + "count", + "min", + "max", + "avg", + "sum" + ] + } + ] + }, + "_types.aggregations:StatsBucketAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:StatsAggregate" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:ExtendedStatsAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:StatsAggregate" + }, + { + "type": "object", + "properties": { + "sum_of_squares": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "variance": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "variance_population": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "variance_sampling": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "std_deviation": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "std_deviation_population": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "std_deviation_sampling": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "std_deviation_bounds": { + "$ref": "#/components/schemas/_types.aggregations:StandardDeviationBounds" + }, + "sum_of_squares_as_string": { + "type": "string" + }, + "variance_as_string": { + "type": "string" + }, + "variance_population_as_string": { + "type": "string" + }, + "variance_sampling_as_string": { + "type": "string" + }, + "std_deviation_as_string": { + "type": "string" + }, + "std_deviation_bounds_as_string": { + "$ref": "#/components/schemas/_types.aggregations:StandardDeviationBoundsAsString" + } + }, + "required": [ + "sum_of_squares", + "variance", + "variance_population", + "variance_sampling", + "std_deviation", + "std_deviation_population", + "std_deviation_sampling" + ] + } + ] + }, + "_types.aggregations:StandardDeviationBounds": { + "type": "object", + "properties": { + "upper": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "lower": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "upper_population": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "lower_population": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "upper_sampling": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "lower_sampling": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + } + }, + "required": [ + "upper", + "lower", + "upper_population", + "lower_population", + "upper_sampling", + "lower_sampling" + ] + }, + "_types.aggregations:StandardDeviationBoundsAsString": { + "type": "object", + "properties": { + "upper": { + "type": "string" + }, + "lower": { + "type": "string" + }, + "upper_population": { + "type": "string" + }, + "lower_population": { + "type": "string" + }, + "upper_sampling": { + "type": "string" + }, + "lower_sampling": { + "type": "string" + } + }, + "required": [ + "upper", + "lower", + "upper_population", + "lower_population", + "upper_sampling", + "lower_sampling" + ] + }, + "_types.aggregations:ExtendedStatsBucketAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:ExtendedStatsAggregate" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:GeoBoundsAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "bounds": { + "$ref": "#/components/schemas/_types:GeoBounds" + } + } + } + ] + }, + "_types:GeoBounds": { + "description": "A geo bounding box. It can be represented in various ways:\n- as 4 top/bottom/left/right coordinates\n- as 2 top_left / bottom_right points\n- as 2 top_right / bottom_left points\n- as a WKT bounding box", + "oneOf": [ + { + "$ref": "#/components/schemas/_types:CoordsGeoBounds" + }, + { + "$ref": "#/components/schemas/_types:TopLeftBottomRightGeoBounds" + }, + { + "$ref": "#/components/schemas/_types:TopRightBottomLeftGeoBounds" + }, + { + "$ref": "#/components/schemas/_types:WktGeoBounds" + } + ] + }, + "_types:CoordsGeoBounds": { + "type": "object", + "properties": { + "top": { + "type": "number" + }, + "bottom": { + "type": "number" + }, + "left": { + "type": "number" + }, + "right": { + "type": "number" + } + }, + "required": [ + "top", + "bottom", + "left", + "right" + ] + }, + "_types:TopLeftBottomRightGeoBounds": { + "type": "object", + "properties": { + "top_left": { + "$ref": "#/components/schemas/_types:GeoLocation" + }, + "bottom_right": { + "$ref": "#/components/schemas/_types:GeoLocation" + } + }, + "required": [ + "top_left", + "bottom_right" + ] + }, + "_types:GeoLocation": { + "description": "A latitude/longitude as a 2 dimensional point. It can be represented in various ways:\n- as a `{lat, long}` object\n- as a geo hash value\n- as a `[lon, lat]` array\n- as a string in `\", \"` or WKT point formats", + "oneOf": [ + { + "$ref": "#/components/schemas/_types:LatLonGeoLocation" + }, + { + "$ref": "#/components/schemas/_types:GeoHashLocation" + }, + { + "type": "array", + "items": { + "type": "number" + } + }, + { + "type": "string" + } + ] + }, + "_types:LatLonGeoLocation": { + "type": "object", + "properties": { + "lat": { + "description": "Latitude", + "type": "number" + }, + "lon": { + "description": "Longitude", + "type": "number" + } + }, + "required": [ + "lat", + "lon" + ] + }, + "_types:GeoHashLocation": { + "type": "object", + "properties": { + "geohash": { + "$ref": "#/components/schemas/_types:GeoHash" + } + }, + "required": [ + "geohash" + ] + }, + "_types:GeoHash": { + "type": "string" + }, + "_types:TopRightBottomLeftGeoBounds": { + "type": "object", + "properties": { + "top_right": { + "$ref": "#/components/schemas/_types:GeoLocation" + }, + "bottom_left": { + "$ref": "#/components/schemas/_types:GeoLocation" + } + }, + "required": [ + "top_right", + "bottom_left" + ] + }, + "_types:WktGeoBounds": { + "type": "object", + "properties": { + "wkt": { + "type": "string" + } + }, + "required": [ + "wkt" + ] + }, + "_types.aggregations:GeoCentroidAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "location": { + "$ref": "#/components/schemas/_types:GeoLocation" + } + }, + "required": [ + "count" + ] + } + ] + }, + "_types.aggregations:HistogramAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketAggregateBaseHistogramBucket" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:MultiBucketAggregateBaseHistogramBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "buckets": { + "$ref": "#/components/schemas/_types.aggregations:BucketsHistogramBucket" + } + }, + "required": [ + "buckets" + ] + } + ] + }, + "_types.aggregations:BucketsHistogramBucket": { + "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.", + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:HistogramBucket" + } + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:HistogramBucket" + } + } + ] + }, + "_types.aggregations:HistogramBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketBase" + }, + { + "type": "object", + "properties": { + "key_as_string": { + "type": "string" + }, + "key": { + "type": "number" + } + }, + "required": [ + "key" + ] + } + ] + }, + "_types.aggregations:MultiBucketBase": { + "type": "object", + "properties": { + "doc_count": { + "type": "number" + } + }, + "required": [ + "doc_count" + ] + }, + "_types.aggregations:DateHistogramAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketAggregateBaseDateHistogramBucket" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:MultiBucketAggregateBaseDateHistogramBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "buckets": { + "$ref": "#/components/schemas/_types.aggregations:BucketsDateHistogramBucket" + } + }, + "required": [ + "buckets" + ] + } + ] + }, + "_types.aggregations:BucketsDateHistogramBucket": { + "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.", + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:DateHistogramBucket" + } + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:DateHistogramBucket" + } + } + ] + }, + "_types.aggregations:DateHistogramBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketBase" + }, + { + "type": "object", + "properties": { + "key_as_string": { + "type": "string" + }, + "key": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + } + }, + "required": [ + "key" + ] + } + ] + }, + "_types:EpochTimeUnitMillis": { + "allOf": [ + { + "$ref": "#/components/schemas/_types:UnitMillis" + } + ] + }, + "_types:UnitMillis": { + "description": "Time unit for milliseconds", + "type": "number" + }, + "_types.aggregations:AutoDateHistogramAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketAggregateBaseDateHistogramBucket" + }, + { + "type": "object", + "properties": { + "interval": { + "$ref": "#/components/schemas/_types:DurationLarge" + } + }, + "required": [ + "interval" + ] + } + ] + }, + "_types:DurationLarge": { + "description": "A date histogram interval. Similar to `Duration` with additional units: `w` (week), `M` (month), `q` (quarter) and\n`y` (year)", + "type": "string" + }, + "_types.aggregations:VariableWidthHistogramAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketAggregateBaseVariableWidthHistogramBucket" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:MultiBucketAggregateBaseVariableWidthHistogramBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "buckets": { + "$ref": "#/components/schemas/_types.aggregations:BucketsVariableWidthHistogramBucket" + } + }, + "required": [ + "buckets" + ] + } + ] + }, + "_types.aggregations:BucketsVariableWidthHistogramBucket": { + "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.", + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:VariableWidthHistogramBucket" + } + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:VariableWidthHistogramBucket" + } + } + ] + }, + "_types.aggregations:VariableWidthHistogramBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketBase" + }, + { + "type": "object", + "properties": { + "min": { + "type": "number" + }, + "key": { + "type": "number" + }, + "max": { + "type": "number" + }, + "min_as_string": { + "type": "string" + }, + "key_as_string": { + "type": "string" + }, + "max_as_string": { + "type": "string" + } + }, + "required": [ + "min", + "key", + "max" + ] + } + ] + }, + "_types.aggregations:StringTermsAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:TermsAggregateBaseStringTermsBucket" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:TermsAggregateBaseStringTermsBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketAggregateBaseStringTermsBucket" + }, + { + "type": "object", + "properties": { + "doc_count_error_upper_bound": { + "type": "number" + }, + "sum_other_doc_count": { + "type": "number" + } + } + } + ] + }, + "_types.aggregations:MultiBucketAggregateBaseStringTermsBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "buckets": { + "$ref": "#/components/schemas/_types.aggregations:BucketsStringTermsBucket" + } + }, + "required": [ + "buckets" + ] + } + ] + }, + "_types.aggregations:BucketsStringTermsBucket": { + "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.", + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:StringTermsBucket" + } + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:StringTermsBucket" + } + } + ] + }, + "_types.aggregations:StringTermsBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:TermsBucketBase" + }, + { + "type": "object", + "properties": { + "key": { + "$ref": "#/components/schemas/_types:FieldValue" + } + }, + "required": [ + "key" + ] + } + ] + }, + "_types:FieldValue": { + "description": "A field value.", + "oneOf": [ + { + "type": "number" + }, + { + "type": "number" + }, + { + "type": "string" + }, + { + "type": "boolean" + }, + { + "nullable": true, + "type": "string" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:TermsBucketBase": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketBase" + }, + { + "type": "object", + "properties": { + "doc_count_error_upper_bound": { + "type": "number" + } + } + } + ] + }, + "_types.aggregations:LongTermsAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:TermsAggregateBaseLongTermsBucket" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:TermsAggregateBaseLongTermsBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketAggregateBaseLongTermsBucket" + }, + { + "type": "object", + "properties": { + "doc_count_error_upper_bound": { + "type": "number" + }, + "sum_other_doc_count": { + "type": "number" + } + } + } + ] + }, + "_types.aggregations:MultiBucketAggregateBaseLongTermsBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "buckets": { + "$ref": "#/components/schemas/_types.aggregations:BucketsLongTermsBucket" + } + }, + "required": [ + "buckets" + ] + } + ] + }, + "_types.aggregations:BucketsLongTermsBucket": { + "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.", + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:LongTermsBucket" + } + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:LongTermsBucket" + } + } + ] + }, + "_types.aggregations:LongTermsBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:TermsBucketBase" + }, + { + "type": "object", + "properties": { + "key": { + "type": "number" + }, + "key_as_string": { + "type": "string" + } + }, + "required": [ + "key" + ] + } + ] + }, + "_types.aggregations:DoubleTermsAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:TermsAggregateBaseDoubleTermsBucket" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:TermsAggregateBaseDoubleTermsBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketAggregateBaseDoubleTermsBucket" + }, + { + "type": "object", + "properties": { + "doc_count_error_upper_bound": { + "type": "number" + }, + "sum_other_doc_count": { + "type": "number" + } + } + } + ] + }, + "_types.aggregations:MultiBucketAggregateBaseDoubleTermsBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "buckets": { + "$ref": "#/components/schemas/_types.aggregations:BucketsDoubleTermsBucket" + } + }, + "required": [ + "buckets" + ] + } + ] + }, + "_types.aggregations:BucketsDoubleTermsBucket": { + "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.", + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:DoubleTermsBucket" + } + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:DoubleTermsBucket" + } + } + ] + }, + "_types.aggregations:DoubleTermsBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:TermsBucketBase" + }, + { + "type": "object", + "properties": { + "key": { + "type": "number" + }, + "key_as_string": { + "type": "string" + } + }, + "required": [ + "key" + ] + } + ] + }, + "_types.aggregations:UnmappedTermsAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:TermsAggregateBaseVoid" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:TermsAggregateBaseVoid": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketAggregateBaseVoid" + }, + { + "type": "object", + "properties": { + "doc_count_error_upper_bound": { + "type": "number" + }, + "sum_other_doc_count": { + "type": "number" + } + } + } + ] + }, + "_types.aggregations:MultiBucketAggregateBaseVoid": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "buckets": { + "$ref": "#/components/schemas/_types.aggregations:BucketsVoid" + } + }, + "required": [ + "buckets" + ] + } + ] + }, + "_types.aggregations:BucketsVoid": { + "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.", + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_spec_utils:Void" + } + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_spec_utils:Void" + } + } + ] + }, + "_spec_utils:Void": { + "description": "The absence of any type. This is commonly used in APIs that don't return a body.\n\nAlthough \"void\" is generally used for the unit type that has only one value, this is to be interpreted as\nthe bottom type that has no value at all. Most languages have a unit type, but few have a bottom type.\n\nSee https://en.m.wikipedia.org/wiki/Unit_type and https://en.m.wikipedia.org/wiki/Bottom_type", + "type": "object" + }, + "_types.aggregations:LongRareTermsAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketAggregateBaseLongRareTermsBucket" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:MultiBucketAggregateBaseLongRareTermsBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "buckets": { + "$ref": "#/components/schemas/_types.aggregations:BucketsLongRareTermsBucket" + } + }, + "required": [ + "buckets" + ] + } + ] + }, + "_types.aggregations:BucketsLongRareTermsBucket": { + "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.", + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:LongRareTermsBucket" + } + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:LongRareTermsBucket" + } + } + ] + }, + "_types.aggregations:LongRareTermsBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketBase" + }, + { + "type": "object", + "properties": { + "key": { + "type": "number" + }, + "key_as_string": { + "type": "string" + } + }, + "required": [ + "key" + ] + } + ] + }, + "_types.aggregations:StringRareTermsAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketAggregateBaseStringRareTermsBucket" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:MultiBucketAggregateBaseStringRareTermsBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "buckets": { + "$ref": "#/components/schemas/_types.aggregations:BucketsStringRareTermsBucket" + } + }, + "required": [ + "buckets" + ] + } + ] + }, + "_types.aggregations:BucketsStringRareTermsBucket": { + "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.", + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:StringRareTermsBucket" + } + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:StringRareTermsBucket" + } + } + ] + }, + "_types.aggregations:StringRareTermsBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketBase" + }, + { + "type": "object", + "properties": { + "key": { + "type": "string" + } + }, + "required": [ + "key" + ] + } + ] + }, + "_types.aggregations:UnmappedRareTermsAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketAggregateBaseVoid" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:MultiTermsAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:TermsAggregateBaseMultiTermsBucket" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:TermsAggregateBaseMultiTermsBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketAggregateBaseMultiTermsBucket" + }, + { + "type": "object", + "properties": { + "doc_count_error_upper_bound": { + "type": "number" + }, + "sum_other_doc_count": { + "type": "number" + } + } + } + ] + }, + "_types.aggregations:MultiBucketAggregateBaseMultiTermsBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "buckets": { + "$ref": "#/components/schemas/_types.aggregations:BucketsMultiTermsBucket" + } + }, + "required": [ + "buckets" + ] + } + ] + }, + "_types.aggregations:BucketsMultiTermsBucket": { + "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.", + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:MultiTermsBucket" + } + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:MultiTermsBucket" + } + } + ] + }, + "_types.aggregations:MultiTermsBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketBase" + }, + { + "type": "object", + "properties": { + "key": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:FieldValue" + } + }, + "key_as_string": { + "type": "string" + }, + "doc_count_error_upper_bound": { + "type": "number" + } + }, + "required": [ + "key" + ] + } + ] + }, + "_types.aggregations:MissingAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:SingleBucketAggregateBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:SingleBucketAggregateBase": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "doc_count": { + "type": "number" + } + }, + "required": [ + "doc_count" + ] + } + ] + }, + "_types.aggregations:NestedAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:SingleBucketAggregateBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:ReverseNestedAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:SingleBucketAggregateBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:GlobalAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:SingleBucketAggregateBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:FilterAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:SingleBucketAggregateBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:ChildrenAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:SingleBucketAggregateBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:ParentAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:SingleBucketAggregateBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:SamplerAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:SingleBucketAggregateBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:UnmappedSamplerAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:SingleBucketAggregateBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:GeoHashGridAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketAggregateBaseGeoHashGridBucket" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:MultiBucketAggregateBaseGeoHashGridBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "buckets": { + "$ref": "#/components/schemas/_types.aggregations:BucketsGeoHashGridBucket" + } + }, + "required": [ + "buckets" + ] + } + ] + }, + "_types.aggregations:BucketsGeoHashGridBucket": { + "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.", + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:GeoHashGridBucket" + } + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:GeoHashGridBucket" + } + } + ] + }, + "_types.aggregations:GeoHashGridBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketBase" + }, + { + "type": "object", + "properties": { + "key": { + "$ref": "#/components/schemas/_types:GeoHash" + } + }, + "required": [ + "key" + ] + } + ] + }, + "_types.aggregations:GeoTileGridAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketAggregateBaseGeoTileGridBucket" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:MultiBucketAggregateBaseGeoTileGridBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "buckets": { + "$ref": "#/components/schemas/_types.aggregations:BucketsGeoTileGridBucket" + } + }, + "required": [ + "buckets" + ] + } + ] + }, + "_types.aggregations:BucketsGeoTileGridBucket": { + "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.", + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:GeoTileGridBucket" + } + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:GeoTileGridBucket" + } + } + ] + }, + "_types.aggregations:GeoTileGridBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketBase" + }, + { + "type": "object", + "properties": { + "key": { + "$ref": "#/components/schemas/_types:GeoTile" + } + }, + "required": [ + "key" + ] + } + ] + }, + "_types:GeoTile": { + "description": "A map tile reference, represented as `{zoom}/{x}/{y}`", + "type": "string" + }, + "_types.aggregations:GeoHexGridAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketAggregateBaseGeoHexGridBucket" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:MultiBucketAggregateBaseGeoHexGridBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "buckets": { + "$ref": "#/components/schemas/_types.aggregations:BucketsGeoHexGridBucket" + } + }, + "required": [ + "buckets" + ] + } + ] + }, + "_types.aggregations:BucketsGeoHexGridBucket": { + "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.", + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:GeoHexGridBucket" + } + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:GeoHexGridBucket" + } + } + ] + }, + "_types.aggregations:GeoHexGridBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketBase" + }, + { + "type": "object", + "properties": { + "key": { + "$ref": "#/components/schemas/_types:GeoHexCell" + } + }, + "required": [ + "key" + ] + } + ] + }, + "_types:GeoHexCell": { + "description": "A map hex cell (H3) reference", + "type": "string" + }, + "_types.aggregations:RangeAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketAggregateBaseRangeBucket" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:MultiBucketAggregateBaseRangeBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "buckets": { + "$ref": "#/components/schemas/_types.aggregations:BucketsRangeBucket" + } + }, + "required": [ + "buckets" + ] + } + ] + }, + "_types.aggregations:BucketsRangeBucket": { + "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.", + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:RangeBucket" + } + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:RangeBucket" + } + } + ] + }, + "_types.aggregations:RangeBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketBase" + }, + { + "type": "object", + "properties": { + "from": { + "type": "number" + }, + "to": { + "type": "number" + }, + "from_as_string": { + "type": "string" + }, + "to_as_string": { + "type": "string" + }, + "key": { + "description": "The bucket key. Present if the aggregation is _not_ keyed", + "type": "string" + } + } + } + ] + }, + "_types.aggregations:DateRangeAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:RangeAggregate" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:GeoDistanceAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:RangeAggregate" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:IpRangeAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketAggregateBaseIpRangeBucket" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:MultiBucketAggregateBaseIpRangeBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "buckets": { + "$ref": "#/components/schemas/_types.aggregations:BucketsIpRangeBucket" + } + }, + "required": [ + "buckets" + ] + } + ] + }, + "_types.aggregations:BucketsIpRangeBucket": { + "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.", + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:IpRangeBucket" + } + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:IpRangeBucket" + } + } + ] + }, + "_types.aggregations:IpRangeBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketBase" + }, + { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "from": { + "type": "string" + }, + "to": { + "type": "string" + } + } + } + ] + }, + "_types.aggregations:IpPrefixAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketAggregateBaseIpPrefixBucket" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:MultiBucketAggregateBaseIpPrefixBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "buckets": { + "$ref": "#/components/schemas/_types.aggregations:BucketsIpPrefixBucket" + } + }, + "required": [ + "buckets" + ] + } + ] + }, + "_types.aggregations:BucketsIpPrefixBucket": { + "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.", + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:IpPrefixBucket" + } + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:IpPrefixBucket" + } + } + ] + }, + "_types.aggregations:IpPrefixBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketBase" + }, + { + "type": "object", + "properties": { + "is_ipv6": { + "type": "boolean" + }, + "key": { + "type": "string" + }, + "prefix_length": { + "type": "number" + }, + "netmask": { + "type": "string" + } + }, + "required": [ + "is_ipv6", + "key", + "prefix_length" + ] + } + ] + }, + "_types.aggregations:FiltersAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketAggregateBaseFiltersBucket" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:MultiBucketAggregateBaseFiltersBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "buckets": { + "$ref": "#/components/schemas/_types.aggregations:BucketsFiltersBucket" + } + }, + "required": [ + "buckets" + ] + } + ] + }, + "_types.aggregations:BucketsFiltersBucket": { + "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.", + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:FiltersBucket" + } + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:FiltersBucket" + } + } + ] + }, + "_types.aggregations:FiltersBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:AdjacencyMatrixAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketAggregateBaseAdjacencyMatrixBucket" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:MultiBucketAggregateBaseAdjacencyMatrixBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "buckets": { + "$ref": "#/components/schemas/_types.aggregations:BucketsAdjacencyMatrixBucket" + } + }, + "required": [ + "buckets" + ] + } + ] + }, + "_types.aggregations:BucketsAdjacencyMatrixBucket": { + "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.", + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:AdjacencyMatrixBucket" + } + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:AdjacencyMatrixBucket" + } + } + ] + }, + "_types.aggregations:AdjacencyMatrixBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketBase" + }, + { + "type": "object", + "properties": { + "key": { + "type": "string" + } + }, + "required": [ + "key" + ] + } + ] + }, + "_types.aggregations:SignificantLongTermsAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:SignificantTermsAggregateBaseSignificantLongTermsBucket" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:SignificantTermsAggregateBaseSignificantLongTermsBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketAggregateBaseSignificantLongTermsBucket" + }, + { + "type": "object", + "properties": { + "bg_count": { + "type": "number" + }, + "doc_count": { + "type": "number" + } + } + } + ] + }, + "_types.aggregations:MultiBucketAggregateBaseSignificantLongTermsBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "buckets": { + "$ref": "#/components/schemas/_types.aggregations:BucketsSignificantLongTermsBucket" + } + }, + "required": [ + "buckets" + ] + } + ] + }, + "_types.aggregations:BucketsSignificantLongTermsBucket": { + "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.", + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:SignificantLongTermsBucket" + } + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:SignificantLongTermsBucket" + } + } + ] + }, + "_types.aggregations:SignificantLongTermsBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:SignificantTermsBucketBase" + }, + { + "type": "object", + "properties": { + "key": { + "type": "number" + }, + "key_as_string": { + "type": "string" + } + }, + "required": [ + "key" + ] + } + ] + }, + "_types.aggregations:SignificantTermsBucketBase": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketBase" + }, + { + "type": "object", + "properties": { + "score": { + "type": "number" + }, + "bg_count": { + "type": "number" + } + }, + "required": [ + "score", + "bg_count" + ] + } + ] + }, + "_types.aggregations:SignificantStringTermsAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:SignificantTermsAggregateBaseSignificantStringTermsBucket" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:SignificantTermsAggregateBaseSignificantStringTermsBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketAggregateBaseSignificantStringTermsBucket" + }, + { + "type": "object", + "properties": { + "bg_count": { + "type": "number" + }, + "doc_count": { + "type": "number" + } + } + } + ] + }, + "_types.aggregations:MultiBucketAggregateBaseSignificantStringTermsBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "buckets": { + "$ref": "#/components/schemas/_types.aggregations:BucketsSignificantStringTermsBucket" + } + }, + "required": [ + "buckets" + ] + } + ] + }, + "_types.aggregations:BucketsSignificantStringTermsBucket": { + "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.", + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:SignificantStringTermsBucket" + } + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:SignificantStringTermsBucket" + } + } + ] + }, + "_types.aggregations:SignificantStringTermsBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:SignificantTermsBucketBase" + }, + { + "type": "object", + "properties": { + "key": { + "type": "string" + } + }, + "required": [ + "key" + ] + } + ] + }, + "_types.aggregations:UnmappedSignificantTermsAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:SignificantTermsAggregateBaseVoid" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:SignificantTermsAggregateBaseVoid": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketAggregateBaseVoid" + }, + { + "type": "object", + "properties": { + "bg_count": { + "type": "number" + }, + "doc_count": { + "type": "number" + } + } + } + ] + }, + "_types.aggregations:CompositeAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketAggregateBaseCompositeBucket" + }, + { + "type": "object", + "properties": { + "after_key": { + "$ref": "#/components/schemas/_types.aggregations:CompositeAggregateKey" + } + } + } + ] + }, + "_types.aggregations:CompositeAggregateKey": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types:FieldValue" + } + }, + "_types.aggregations:MultiBucketAggregateBaseCompositeBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "buckets": { + "$ref": "#/components/schemas/_types.aggregations:BucketsCompositeBucket" + } + }, + "required": [ + "buckets" + ] + } + ] + }, + "_types.aggregations:BucketsCompositeBucket": { + "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.", + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:CompositeBucket" + } + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:CompositeBucket" + } + } + ] + }, + "_types.aggregations:CompositeBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketBase" + }, + { + "type": "object", + "properties": { + "key": { + "$ref": "#/components/schemas/_types.aggregations:CompositeAggregateKey" + } + }, + "required": [ + "key" + ] + } + ] + }, + "_types.aggregations:FrequentItemSetsAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketAggregateBaseFrequentItemSetsBucket" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:MultiBucketAggregateBaseFrequentItemSetsBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "buckets": { + "$ref": "#/components/schemas/_types.aggregations:BucketsFrequentItemSetsBucket" + } + }, + "required": [ + "buckets" + ] + } + ] + }, + "_types.aggregations:BucketsFrequentItemSetsBucket": { + "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.", + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:FrequentItemSetsBucket" + } + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:FrequentItemSetsBucket" + } + } + ] + }, + "_types.aggregations:FrequentItemSetsBucket": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MultiBucketBase" + }, + { + "type": "object", + "properties": { + "key": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "support": { + "type": "number" + } + }, + "required": [ + "key", + "support" + ] + } + ] + }, + "_types.aggregations:ScriptedMetricAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "value": { + "type": "object" + } + }, + "required": [ + "value" + ] + } + ] + }, + "_types.aggregations:TopHitsAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "hits": { + "$ref": "#/components/schemas/_global.search._types:HitsMetadata" + } + }, + "required": [ + "hits" + ] + } + ] + }, + "_global.search._types:HitsMetadata": { + "type": "object", + "properties": { + "total": { + "description": "Total hit count information, present only if `track_total_hits` wasn't `false` in the search request.", + "oneOf": [ + { + "$ref": "#/components/schemas/_global.search._types:TotalHits" + }, + { + "type": "number" + } + ] + }, + "hits": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.search._types:Hit" + } + }, + "max_score": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + } + }, + "required": [ + "hits" + ] + }, + "_global.search._types:TotalHits": { + "type": "object", + "properties": { + "relation": { + "$ref": "#/components/schemas/_global.search._types:TotalHitsRelation" + }, + "value": { + "type": "number" + } + }, + "required": [ + "relation", + "value" + ] + }, + "_global.search._types:TotalHitsRelation": { + "type": "string", + "enum": [ + "eq", + "gte" + ] + }, + "_global.search._types:Hit": { + "type": "object", + "properties": { + "_index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "_score": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "_explanation": { + "$ref": "#/components/schemas/_global.explain:Explanation" + }, + "fields": { + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "highlight": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "inner_hits": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_global.search._types:InnerHitsResult" + } + }, + "matched_queries": { + "type": "array", + "items": { + "type": "string" + } + }, + "_nested": { + "$ref": "#/components/schemas/_global.search._types:NestedIdentity" + }, + "_ignored": { + "type": "array", + "items": { + "type": "string" + } + }, + "ignored_field_values": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "_shard": { + "type": "string" + }, + "_node": { + "type": "string" + }, + "_routing": { + "type": "string" + }, + "_source": { + "type": "object" + }, + "_rank": { + "type": "number" + }, + "_seq_no": { + "$ref": "#/components/schemas/_types:SequenceNumber" + }, + "_primary_term": { + "type": "number" + }, + "_version": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "sort": { + "$ref": "#/components/schemas/_types:SortResults" + } + }, + "required": [ + "_index" + ] + }, + "_types:IndexName": { + "type": "string" + }, + "_global.explain:Explanation": { + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.explain:ExplanationDetail" + } + }, + "value": { + "type": "number" + } + }, + "required": [ + "description", + "details", + "value" + ] + }, + "_global.explain:ExplanationDetail": { + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.explain:ExplanationDetail" + } + }, + "value": { + "type": "number" + } + }, + "required": [ + "description", + "value" + ] + }, + "_global.search._types:InnerHitsResult": { + "type": "object", + "properties": { + "hits": { + "$ref": "#/components/schemas/_global.search._types:HitsMetadata" + } + }, + "required": [ + "hits" + ] + }, + "_global.search._types:NestedIdentity": { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "offset": { + "type": "number" + }, + "_nested": { + "$ref": "#/components/schemas/_global.search._types:NestedIdentity" + } + }, + "required": [ + "field", + "offset" + ] + }, + "_types:Field": { + "description": "Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.", + "type": "string" + }, + "_types:SequenceNumber": { + "type": "number" + }, + "_types:VersionNumber": { + "type": "number" + }, + "_types:SortResults": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:FieldValue" + } + }, + "_types.aggregations:InferenceAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "value": { + "$ref": "#/components/schemas/_types:FieldValue" + }, + "feature_importance": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:InferenceFeatureImportance" + } + }, + "top_classes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:InferenceTopClassEntry" + } + }, + "warning": { + "type": "string" + } + } + } + ] + }, + "_types.aggregations:InferenceFeatureImportance": { + "type": "object", + "properties": { + "feature_name": { + "type": "string" + }, + "importance": { + "type": "number" + }, + "classes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:InferenceClassImportance" + } + } + }, + "required": [ + "feature_name" + ] + }, + "_types.aggregations:InferenceClassImportance": { + "type": "object", + "properties": { + "class_name": { + "type": "string" + }, + "importance": { + "type": "number" + } + }, + "required": [ + "class_name", + "importance" + ] + }, + "_types.aggregations:InferenceTopClassEntry": { + "type": "object", + "properties": { + "class_name": { + "$ref": "#/components/schemas/_types:FieldValue" + }, + "class_probability": { + "type": "number" + }, + "class_score": { + "type": "number" + } + }, + "required": [ + "class_name", + "class_probability", + "class_score" + ] + }, + "_types.aggregations:StringStatsAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "min_length": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "max_length": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "avg_length": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "entropy": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "distribution": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "number" + } + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "min_length_as_string": { + "type": "string" + }, + "max_length_as_string": { + "type": "string" + }, + "avg_length_as_string": { + "type": "string" + } + }, + "required": [ + "count", + "min_length", + "max_length", + "avg_length", + "entropy" + ] + } + ] + }, + "_types.aggregations:BoxPlotAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "min": { + "type": "number" + }, + "max": { + "type": "number" + }, + "q1": { + "type": "number" + }, + "q2": { + "type": "number" + }, + "q3": { + "type": "number" + }, + "lower": { + "type": "number" + }, + "upper": { + "type": "number" + }, + "min_as_string": { + "type": "string" + }, + "max_as_string": { + "type": "string" + }, + "q1_as_string": { + "type": "string" + }, + "q2_as_string": { + "type": "string" + }, + "q3_as_string": { + "type": "string" + }, + "lower_as_string": { + "type": "string" + }, + "upper_as_string": { + "type": "string" + } + }, + "required": [ + "min", + "max", + "q1", + "q2", + "q3", + "lower", + "upper" + ] + } + ] + }, + "_types.aggregations:TopMetricsAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "top": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:TopMetrics" + } + } + }, + "required": [ + "top" + ] + } + ] + }, + "_types.aggregations:TopMetrics": { + "type": "object", + "properties": { + "sort": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types:FieldValue" + }, + { + "nullable": true, + "type": "string" + } + ] + } + }, + "metrics": { + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types:FieldValue" + }, + { + "nullable": true, + "type": "string" + } + ] + } + } + }, + "required": [ + "sort", + "metrics" + ] + }, + "_types.aggregations:TTestAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "value": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "value_as_string": { + "type": "string" + } + }, + "required": [ + "value" + ] + } + ] + }, + "_types.aggregations:RateAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "value": { + "type": "number" + }, + "value_as_string": { + "type": "string" + } + }, + "required": [ + "value" + ] + } + ] + }, + "_types.aggregations:CumulativeCardinalityAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "value": { + "type": "number" + }, + "value_as_string": { + "type": "string" + } + }, + "required": [ + "value" + ] + } + ] + }, + "_types.aggregations:MatrixStatsAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "doc_count": { + "type": "number" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:MatrixStatsFields" + } + } + }, + "required": [ + "doc_count" + ] + } + ] + }, + "_types.aggregations:MatrixStatsFields": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/_types:Field" + }, + "count": { + "type": "number" + }, + "mean": { + "type": "number" + }, + "variance": { + "type": "number" + }, + "skewness": { + "type": "number" + }, + "kurtosis": { + "type": "number" + }, + "covariance": { + "type": "object", + "additionalProperties": { + "type": "number" + } + }, + "correlation": { + "type": "object", + "additionalProperties": { + "type": "number" + } + } + }, + "required": [ + "name", + "count", + "mean", + "variance", + "skewness", + "kurtosis", + "covariance", + "correlation" + ] + }, + "_types.aggregations:GeoLineAggregate": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:AggregateBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "geometry": { + "$ref": "#/components/schemas/_types:GeoLine" + }, + "properties": { + "type": "object" + } + }, + "required": [ + "type", + "geometry", + "properties" + ] + } + ] + }, + "_types:GeoLine": { + "type": "object", + "properties": { + "type": { + "description": "Always `\"LineString\"`", + "type": "string" + }, + "coordinates": { + "description": "Array of `[lon, lat]` coordinates", + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number" + } + } + } + }, + "required": [ + "type", + "coordinates" + ] + }, + "_types:ClusterStatistics": { + "type": "object", + "properties": { + "skipped": { + "type": "number" + }, + "successful": { + "type": "number" + }, + "total": { + "type": "number" + }, + "running": { + "type": "number" + }, + "partial": { + "type": "number" + }, + "failed": { + "type": "number" + }, + "details": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types:ClusterDetails" + } + } + }, + "required": [ + "skipped", + "successful", + "total", + "running", + "partial", + "failed" + ] + }, + "_types:ClusterDetails": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/_types:ClusterSearchStatus" + }, + "indices": { + "type": "string" + }, + "took": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + }, + "timed_out": { + "type": "boolean" + }, + "_shards": { + "$ref": "#/components/schemas/_types:ShardStatistics" + }, + "failures": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:ShardFailure" + } + } + }, + "required": [ + "status", + "indices", + "timed_out" + ] + }, + "_types:ClusterSearchStatus": { + "type": "string", + "enum": [ + "running", + "successful", + "partial", + "skipped", + "failed" + ] + }, + "_types:DurationValueUnitMillis": { + "allOf": [ + { + "$ref": "#/components/schemas/_types:UnitMillis" + } + ] + }, + "_types:ShardStatistics": { + "type": "object", + "properties": { + "failed": { + "$ref": "#/components/schemas/_types:uint" + }, + "successful": { + "$ref": "#/components/schemas/_types:uint" + }, + "total": { + "$ref": "#/components/schemas/_types:uint" + }, + "failures": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:ShardFailure" + } + }, + "skipped": { + "$ref": "#/components/schemas/_types:uint" + } + }, + "required": [ + "failed", + "successful", + "total" + ] + }, + "_types:uint": { + "type": "number" + }, + "_types:ShardFailure": { + "type": "object", + "properties": { + "index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "node": { + "type": "string" + }, + "reason": { + "$ref": "#/components/schemas/_types:ErrorCause" + }, + "shard": { + "type": "number" + }, + "status": { + "type": "string" + } + }, + "required": [ + "reason", + "shard" + ] + }, + "_types:ErrorCause": { + "type": "object", + "properties": { + "type": { + "description": "The type of error", + "type": "string" + }, + "reason": { + "description": "A human-readable explanation of the error, in english", + "type": "string" + }, + "stack_trace": { + "description": "The server stack trace. Present only if the `error_trace=true` parameter was sent with the request.", + "type": "string" + }, + "caused_by": { + "$ref": "#/components/schemas/_types:ErrorCause" + }, + "root_cause": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:ErrorCause" + } + }, + "suppressed": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:ErrorCause" + } + } + }, + "required": [ + "type" + ] + }, + "_global.search._types:Profile": { + "type": "object", + "properties": { + "shards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.search._types:ShardProfile" + } + } + }, + "required": [ + "shards" + ] + }, + "_global.search._types:ShardProfile": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.search._types:AggregationProfile" + } + }, + "id": { + "type": "string" + }, + "searches": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.search._types:SearchProfile" + } + }, + "fetch": { + "$ref": "#/components/schemas/_global.search._types:FetchProfile" + } + }, + "required": [ + "aggregations", + "id", + "searches" + ] + }, + "_global.search._types:AggregationProfile": { + "type": "object", + "properties": { + "breakdown": { + "$ref": "#/components/schemas/_global.search._types:AggregationBreakdown" + }, + "description": { + "type": "string" + }, + "time_in_nanos": { + "$ref": "#/components/schemas/_types:DurationValueUnitNanos" + }, + "type": { + "type": "string" + }, + "debug": { + "$ref": "#/components/schemas/_global.search._types:AggregationProfileDebug" + }, + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.search._types:AggregationProfile" + } + } + }, + "required": [ + "breakdown", + "description", + "time_in_nanos", + "type" + ] + }, + "_global.search._types:AggregationBreakdown": { + "type": "object", + "properties": { + "build_aggregation": { + "type": "number" + }, + "build_aggregation_count": { + "type": "number" + }, + "build_leaf_collector": { + "type": "number" + }, + "build_leaf_collector_count": { + "type": "number" + }, + "collect": { + "type": "number" + }, + "collect_count": { + "type": "number" + }, + "initialize": { + "type": "number" + }, + "initialize_count": { + "type": "number" + }, + "post_collection": { + "type": "number" + }, + "post_collection_count": { + "type": "number" + }, + "reduce": { + "type": "number" + }, + "reduce_count": { + "type": "number" + } + }, + "required": [ + "build_aggregation", + "build_aggregation_count", + "build_leaf_collector", + "build_leaf_collector_count", + "collect", + "collect_count", + "initialize", + "initialize_count", + "reduce", + "reduce_count" + ] + }, + "_types:DurationValueUnitNanos": { + "allOf": [ + { + "$ref": "#/components/schemas/_types:UnitNanos" + } + ] + }, + "_types:UnitNanos": { + "description": "Time unit for nanoseconds", + "type": "number" + }, + "_global.search._types:AggregationProfileDebug": { + "type": "object", + "properties": { + "segments_with_multi_valued_ords": { + "type": "number" + }, + "collection_strategy": { + "type": "string" + }, + "segments_with_single_valued_ords": { + "type": "number" + }, + "total_buckets": { + "type": "number" + }, + "built_buckets": { + "type": "number" + }, + "result_strategy": { + "type": "string" + }, + "has_filter": { + "type": "boolean" + }, + "delegate": { + "type": "string" + }, + "delegate_debug": { + "$ref": "#/components/schemas/_global.search._types:AggregationProfileDebug" + }, + "chars_fetched": { + "type": "number" + }, + "extract_count": { + "type": "number" + }, + "extract_ns": { + "type": "number" + }, + "values_fetched": { + "type": "number" + }, + "collect_analyzed_ns": { + "type": "number" + }, + "collect_analyzed_count": { + "type": "number" + }, + "surviving_buckets": { + "type": "number" + }, + "ordinals_collectors_used": { + "type": "number" + }, + "ordinals_collectors_overhead_too_high": { + "type": "number" + }, + "string_hashing_collectors_used": { + "type": "number" + }, + "numeric_collectors_used": { + "type": "number" + }, + "empty_collectors_used": { + "type": "number" + }, + "deferred_aggregators": { + "type": "array", + "items": { + "type": "string" + } + }, + "segments_with_doc_count_field": { + "type": "number" + }, + "segments_with_deleted_docs": { + "type": "number" + }, + "filters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.search._types:AggregationProfileDelegateDebugFilter" + } + }, + "segments_counted": { + "type": "number" + }, + "segments_collected": { + "type": "number" + }, + "map_reducer": { + "type": "string" + } + } + }, + "_global.search._types:AggregationProfileDelegateDebugFilter": { + "type": "object", + "properties": { + "results_from_metadata": { + "type": "number" + }, + "query": { + "type": "string" + }, + "specialized_for": { + "type": "string" + }, + "segments_counted_in_constant_time": { + "type": "number" + } + } + }, + "_global.search._types:SearchProfile": { + "type": "object", + "properties": { + "collector": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.search._types:Collector" + } + }, + "query": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.search._types:QueryProfile" + } + }, + "rewrite_time": { + "type": "number" + } + }, + "required": [ + "collector", + "query", + "rewrite_time" + ] + }, + "_global.search._types:Collector": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "reason": { + "type": "string" + }, + "time_in_nanos": { + "$ref": "#/components/schemas/_types:DurationValueUnitNanos" + }, + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.search._types:Collector" + } + } + }, + "required": [ + "name", + "reason", + "time_in_nanos" + ] + }, + "_global.search._types:QueryProfile": { + "type": "object", + "properties": { + "breakdown": { + "$ref": "#/components/schemas/_global.search._types:QueryBreakdown" + }, + "description": { + "type": "string" + }, + "time_in_nanos": { + "$ref": "#/components/schemas/_types:DurationValueUnitNanos" + }, + "type": { + "type": "string" + }, + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.search._types:QueryProfile" + } + } + }, + "required": [ + "breakdown", + "description", + "time_in_nanos", + "type" + ] + }, + "_global.search._types:QueryBreakdown": { + "type": "object", + "properties": { + "advance": { + "type": "number" + }, + "advance_count": { + "type": "number" + }, + "build_scorer": { + "type": "number" + }, + "build_scorer_count": { + "type": "number" + }, + "create_weight": { + "type": "number" + }, + "create_weight_count": { + "type": "number" + }, + "match": { + "type": "number" + }, + "match_count": { + "type": "number" + }, + "shallow_advance": { + "type": "number" + }, + "shallow_advance_count": { + "type": "number" + }, + "next_doc": { + "type": "number" + }, + "next_doc_count": { + "type": "number" + }, + "score": { + "type": "number" + }, + "score_count": { + "type": "number" + }, + "compute_max_score": { + "type": "number" + }, + "compute_max_score_count": { + "type": "number" + }, + "set_min_competitive_score": { + "type": "number" + }, + "set_min_competitive_score_count": { + "type": "number" + } + }, + "required": [ + "advance", + "advance_count", + "build_scorer", + "build_scorer_count", + "create_weight", + "create_weight_count", + "match", + "match_count", + "shallow_advance", + "shallow_advance_count", + "next_doc", + "next_doc_count", + "score", + "score_count", + "compute_max_score", + "compute_max_score_count", + "set_min_competitive_score", + "set_min_competitive_score_count" + ] + }, + "_global.search._types:FetchProfile": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "description": { + "type": "string" + }, + "time_in_nanos": { + "$ref": "#/components/schemas/_types:DurationValueUnitNanos" + }, + "breakdown": { + "$ref": "#/components/schemas/_global.search._types:FetchProfileBreakdown" + }, + "debug": { + "$ref": "#/components/schemas/_global.search._types:FetchProfileDebug" + }, + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.search._types:FetchProfile" + } + } + }, + "required": [ + "type", + "description", + "time_in_nanos", + "breakdown" + ] + }, + "_global.search._types:FetchProfileBreakdown": { + "type": "object", + "properties": { + "load_source": { + "type": "number" + }, + "load_source_count": { + "type": "number" + }, + "load_stored_fields": { + "type": "number" + }, + "load_stored_fields_count": { + "type": "number" + }, + "next_reader": { + "type": "number" + }, + "next_reader_count": { + "type": "number" + }, + "process_count": { + "type": "number" + }, + "process": { + "type": "number" + } + } + }, + "_global.search._types:FetchProfileDebug": { + "type": "object", + "properties": { + "stored_fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "fast_path": { + "type": "number" + } + } + }, + "_types:ScrollId": { + "type": "string" + }, + "_global.search._types:Suggest": { + "oneOf": [ + { + "$ref": "#/components/schemas/_global.search._types:CompletionSuggest" + }, + { + "$ref": "#/components/schemas/_global.search._types:PhraseSuggest" + }, + { + "$ref": "#/components/schemas/_global.search._types:TermSuggest" + } + ] + }, + "_global.search._types:CompletionSuggest": { + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types:SuggestBase" + }, + { + "type": "object", + "properties": { + "options": { + "oneOf": [ + { + "$ref": "#/components/schemas/_global.search._types:CompletionSuggestOption" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.search._types:CompletionSuggestOption" + } + } + ] + } + }, + "required": [ + "options" + ] + } + ] + }, + "_global.search._types:CompletionSuggestOption": { + "type": "object", + "properties": { + "collate_match": { + "type": "boolean" + }, + "contexts": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.search._types:Context" + } + } + }, + "fields": { + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "_id": { + "type": "string" + }, + "_index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "_routing": { + "$ref": "#/components/schemas/_types:Routing" + }, + "_score": { + "type": "number" + }, + "_source": { + "type": "object" + }, + "text": { + "type": "string" + }, + "score": { + "type": "number" + } + }, + "required": [ + "text" + ] + }, + "_global.search._types:Context": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html#_document_input_parameters" + }, + "description": "Text or location that we want similar documents for or a lookup to a document's field for the text.", + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/_types:GeoLocation" + } + ] + }, + "_types:Routing": { + "type": "string" + }, + "_global.search._types:SuggestBase": { + "type": "object", + "properties": { + "length": { + "type": "number" + }, + "offset": { + "type": "number" + }, + "text": { + "type": "string" + } + }, + "required": [ + "length", + "offset", + "text" + ] + }, + "_global.search._types:PhraseSuggest": { + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types:SuggestBase" + }, + { + "type": "object", + "properties": { + "options": { + "oneOf": [ + { + "$ref": "#/components/schemas/_global.search._types:PhraseSuggestOption" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.search._types:PhraseSuggestOption" + } + } + ] + } + }, + "required": [ + "options" + ] + } + ] + }, + "_global.search._types:PhraseSuggestOption": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "score": { + "type": "number" + }, + "highlighted": { + "type": "string" + }, + "collate_match": { + "type": "boolean" + } + }, + "required": [ + "text", + "score" + ] + }, + "_global.search._types:TermSuggest": { + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types:SuggestBase" + }, + { + "type": "object", + "properties": { + "options": { + "oneOf": [ + { + "$ref": "#/components/schemas/_global.search._types:TermSuggestOption" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.search._types:TermSuggestOption" + } + } + ] + } + }, + "required": [ + "options" + ] + } + ] + }, + "_global.search._types:TermSuggestOption": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "score": { + "type": "number" + }, + "freq": { + "type": "number" + }, + "highlighted": { + "type": "string" + }, + "collate_match": { + "type": "boolean" + } + }, + "required": [ + "text", + "score", + "freq" + ] + }, + "async_search._types:AsyncSearchResponseBase": { + "type": "object", + "properties": { + "id": { + "$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`.", + "type": "boolean" + }, + "is_running": { + "description": "Indicates whether the search is still running or has completed.\nNOTE: If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though `is_running` is `false`.", + "type": "boolean" + }, + "expiration_time": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "expiration_time_in_millis": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "start_time": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "start_time_in_millis": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "completion_time": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "completion_time_in_millis": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + } + }, + "required": [ + "is_partial", + "is_running", + "expiration_time_in_millis", + "start_time_in_millis" + ] + }, + "_types:DateTime": { + "description": "A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a\nnumber of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string\nrepresentation.", + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + } + ] + }, + "async_search.status:StatusResponseBase": { + "allOf": [ + { + "$ref": "#/components/schemas/async_search._types:AsyncSearchResponseBase" + }, + { + "type": "object", + "properties": { + "_shards": { + "$ref": "#/components/schemas/_types:ShardStatistics" + }, + "_clusters": { + "$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.\n503 indicates that the async search was completed with an error.", + "type": "number" + } + }, + "required": [ + "_shards" + ] + } + ] + }, + "_types:Indices": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types:IndexName" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:IndexName" + } + } + ] + }, + "_types.query_dsl:Operator": { + "type": "string", + "enum": [ + "and", + "AND", + "or", + "OR" + ] + }, + "_types:Fields": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types:Field" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Field" + } + } + ] + }, + "_types:ExpandWildcards": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types:ExpandWildcard" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:ExpandWildcard" + } + } + ] + }, + "_types:ExpandWildcard": { + "type": "string", + "enum": [ + "all", + "open", + "closed", + "hidden", + "none" + ] + }, + "_types:VersionString": { + "type": "string" + }, + "_types:SearchType": { + "type": "string", + "enum": [ + "query_then_fetch", + "dfs_query_then_fetch" + ] + }, + "_types:SuggestMode": { + "type": "string", + "enum": [ + "missing", + "popular", + "always" + ] + }, + "_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.", + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "number" + } + ] + }, + "_global.search._types:SourceConfigParam": { + "description": "Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.\nUsed as a query parameter along with the `_source_includes` and `_source_excludes` parameters.", + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "#/components/schemas/_types:Fields" + } + ] + }, + "_types.aggregations:AggregationContainer": { + "allOf": [ + { + "type": "object", + "properties": { + "aggregations": { + "description": "Sub-aggregations for this aggregation.\nOnly applies to bucket aggregations.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:AggregationContainer" + } + }, + "meta": { + "$ref": "#/components/schemas/_types:Metadata" + } + } + }, + { + "type": "object", + "properties": { + "adjacency_matrix": { + "$ref": "#/components/schemas/_types.aggregations:AdjacencyMatrixAggregation" + }, + "auto_date_histogram": { + "$ref": "#/components/schemas/_types.aggregations:AutoDateHistogramAggregation" + }, + "avg": { + "$ref": "#/components/schemas/_types.aggregations:AverageAggregation" + }, + "avg_bucket": { + "$ref": "#/components/schemas/_types.aggregations:AverageBucketAggregation" + }, + "boxplot": { + "$ref": "#/components/schemas/_types.aggregations:BoxplotAggregation" + }, + "bucket_script": { + "$ref": "#/components/schemas/_types.aggregations:BucketScriptAggregation" + }, + "bucket_selector": { + "$ref": "#/components/schemas/_types.aggregations:BucketSelectorAggregation" + }, + "bucket_sort": { + "$ref": "#/components/schemas/_types.aggregations:BucketSortAggregation" + }, + "bucket_count_ks_test": { + "$ref": "#/components/schemas/_types.aggregations:BucketKsAggregation" + }, + "bucket_correlation": { + "$ref": "#/components/schemas/_types.aggregations:BucketCorrelationAggregation" + }, + "cardinality": { + "$ref": "#/components/schemas/_types.aggregations:CardinalityAggregation" + }, + "categorize_text": { + "$ref": "#/components/schemas/_types.aggregations:CategorizeTextAggregation" + }, + "children": { + "$ref": "#/components/schemas/_types.aggregations:ChildrenAggregation" + }, + "composite": { + "$ref": "#/components/schemas/_types.aggregations:CompositeAggregation" + }, + "cumulative_cardinality": { + "$ref": "#/components/schemas/_types.aggregations:CumulativeCardinalityAggregation" + }, + "cumulative_sum": { + "$ref": "#/components/schemas/_types.aggregations:CumulativeSumAggregation" + }, + "date_histogram": { + "$ref": "#/components/schemas/_types.aggregations:DateHistogramAggregation" + }, + "date_range": { + "$ref": "#/components/schemas/_types.aggregations:DateRangeAggregation" + }, + "derivative": { + "$ref": "#/components/schemas/_types.aggregations:DerivativeAggregation" + }, + "diversified_sampler": { + "$ref": "#/components/schemas/_types.aggregations:DiversifiedSamplerAggregation" + }, + "extended_stats": { + "$ref": "#/components/schemas/_types.aggregations:ExtendedStatsAggregation" + }, + "extended_stats_bucket": { + "$ref": "#/components/schemas/_types.aggregations:ExtendedStatsBucketAggregation" + }, + "frequent_item_sets": { + "$ref": "#/components/schemas/_types.aggregations:FrequentItemSetsAggregation" + }, + "filter": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "filters": { + "$ref": "#/components/schemas/_types.aggregations:FiltersAggregation" + }, + "geo_bounds": { + "$ref": "#/components/schemas/_types.aggregations:GeoBoundsAggregation" + }, + "geo_centroid": { + "$ref": "#/components/schemas/_types.aggregations:GeoCentroidAggregation" + }, + "geo_distance": { + "$ref": "#/components/schemas/_types.aggregations:GeoDistanceAggregation" + }, + "geohash_grid": { + "$ref": "#/components/schemas/_types.aggregations:GeoHashGridAggregation" + }, + "geo_line": { + "$ref": "#/components/schemas/_types.aggregations:GeoLineAggregation" + }, + "geotile_grid": { + "$ref": "#/components/schemas/_types.aggregations:GeoTileGridAggregation" + }, + "geohex_grid": { + "$ref": "#/components/schemas/_types.aggregations:GeohexGridAggregation" + }, + "global": { + "$ref": "#/components/schemas/_types.aggregations:GlobalAggregation" + }, + "histogram": { + "$ref": "#/components/schemas/_types.aggregations:HistogramAggregation" + }, + "ip_range": { + "$ref": "#/components/schemas/_types.aggregations:IpRangeAggregation" + }, + "ip_prefix": { + "$ref": "#/components/schemas/_types.aggregations:IpPrefixAggregation" + }, + "inference": { + "$ref": "#/components/schemas/_types.aggregations:InferenceAggregation" + }, + "line": { + "$ref": "#/components/schemas/_types.aggregations:GeoLineAggregation" + }, + "matrix_stats": { + "$ref": "#/components/schemas/_types.aggregations:MatrixStatsAggregation" + }, + "max": { + "$ref": "#/components/schemas/_types.aggregations:MaxAggregation" + }, + "max_bucket": { + "$ref": "#/components/schemas/_types.aggregations:MaxBucketAggregation" + }, + "median_absolute_deviation": { + "$ref": "#/components/schemas/_types.aggregations:MedianAbsoluteDeviationAggregation" + }, + "min": { + "$ref": "#/components/schemas/_types.aggregations:MinAggregation" + }, + "min_bucket": { + "$ref": "#/components/schemas/_types.aggregations:MinBucketAggregation" + }, + "missing": { + "$ref": "#/components/schemas/_types.aggregations:MissingAggregation" + }, + "moving_avg": { + "$ref": "#/components/schemas/_types.aggregations:MovingAverageAggregation" + }, + "moving_percentiles": { + "$ref": "#/components/schemas/_types.aggregations:MovingPercentilesAggregation" + }, + "moving_fn": { + "$ref": "#/components/schemas/_types.aggregations:MovingFunctionAggregation" + }, + "multi_terms": { + "$ref": "#/components/schemas/_types.aggregations:MultiTermsAggregation" + }, + "nested": { + "$ref": "#/components/schemas/_types.aggregations:NestedAggregation" + }, + "normalize": { + "$ref": "#/components/schemas/_types.aggregations:NormalizeAggregation" + }, + "parent": { + "$ref": "#/components/schemas/_types.aggregations:ParentAggregation" + }, + "percentile_ranks": { + "$ref": "#/components/schemas/_types.aggregations:PercentileRanksAggregation" + }, + "percentiles": { + "$ref": "#/components/schemas/_types.aggregations:PercentilesAggregation" + }, + "percentiles_bucket": { + "$ref": "#/components/schemas/_types.aggregations:PercentilesBucketAggregation" + }, + "range": { + "$ref": "#/components/schemas/_types.aggregations:RangeAggregation" + }, + "rare_terms": { + "$ref": "#/components/schemas/_types.aggregations:RareTermsAggregation" + }, + "rate": { + "$ref": "#/components/schemas/_types.aggregations:RateAggregation" + }, + "reverse_nested": { + "$ref": "#/components/schemas/_types.aggregations:ReverseNestedAggregation" + }, + "sampler": { + "$ref": "#/components/schemas/_types.aggregations:SamplerAggregation" + }, + "scripted_metric": { + "$ref": "#/components/schemas/_types.aggregations:ScriptedMetricAggregation" + }, + "serial_diff": { + "$ref": "#/components/schemas/_types.aggregations:SerialDifferencingAggregation" + }, + "significant_terms": { + "$ref": "#/components/schemas/_types.aggregations:SignificantTermsAggregation" + }, + "significant_text": { + "$ref": "#/components/schemas/_types.aggregations:SignificantTextAggregation" + }, + "stats": { + "$ref": "#/components/schemas/_types.aggregations:StatsAggregation" + }, + "stats_bucket": { + "$ref": "#/components/schemas/_types.aggregations:StatsBucketAggregation" + }, + "string_stats": { + "$ref": "#/components/schemas/_types.aggregations:StringStatsAggregation" + }, + "sum": { + "$ref": "#/components/schemas/_types.aggregations:SumAggregation" + }, + "sum_bucket": { + "$ref": "#/components/schemas/_types.aggregations:SumBucketAggregation" + }, + "terms": { + "$ref": "#/components/schemas/_types.aggregations:TermsAggregation" + }, + "top_hits": { + "$ref": "#/components/schemas/_types.aggregations:TopHitsAggregation" + }, + "t_test": { + "$ref": "#/components/schemas/_types.aggregations:TTestAggregation" + }, + "top_metrics": { + "$ref": "#/components/schemas/_types.aggregations:TopMetricsAggregation" + }, + "value_count": { + "$ref": "#/components/schemas/_types.aggregations:ValueCountAggregation" + }, + "weighted_avg": { + "$ref": "#/components/schemas/_types.aggregations:WeightedAverageAggregation" + }, + "variable_width_histogram": { + "$ref": "#/components/schemas/_types.aggregations:VariableWidthHistogramAggregation" + } + }, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "_types.aggregations:AdjacencyMatrixAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "filters": { + "description": "Filters used to create buckets.\nAt least one filter is required.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + } + }, + "separator": { + "description": "Separator used to concatenate filter names. Defaults to &.", + "type": "string" + } + } + } + ] + }, + "_types.query_dsl:QueryContainer": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html" + }, + "type": "object", + "properties": { + "bool": { + "$ref": "#/components/schemas/_types.query_dsl:BoolQuery" + }, + "boosting": { + "$ref": "#/components/schemas/_types.query_dsl:BoostingQuery" + }, + "common": { + "deprecated": true, + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.query_dsl:CommonTermsQuery" + }, + "minProperties": 1, + "maxProperties": 1 + }, + "combined_fields": { + "$ref": "#/components/schemas/_types.query_dsl:CombinedFieldsQuery" + }, + "constant_score": { + "$ref": "#/components/schemas/_types.query_dsl:ConstantScoreQuery" + }, + "dis_max": { + "$ref": "#/components/schemas/_types.query_dsl:DisMaxQuery" + }, + "distance_feature": { + "$ref": "#/components/schemas/_types.query_dsl:DistanceFeatureQuery" + }, + "exists": { + "$ref": "#/components/schemas/_types.query_dsl:ExistsQuery" + }, + "function_score": { + "$ref": "#/components/schemas/_types.query_dsl:FunctionScoreQuery" + }, + "fuzzy": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-fuzzy-query.html" + }, + "description": "Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.query_dsl:FuzzyQuery" + }, + "minProperties": 1, + "maxProperties": 1 + }, + "geo_bounding_box": { + "$ref": "#/components/schemas/_types.query_dsl:GeoBoundingBoxQuery" + }, + "geo_distance": { + "$ref": "#/components/schemas/_types.query_dsl:GeoDistanceQuery" + }, + "geo_polygon": { + "$ref": "#/components/schemas/_types.query_dsl:GeoPolygonQuery" + }, + "geo_shape": { + "$ref": "#/components/schemas/_types.query_dsl:GeoShapeQuery" + }, + "has_child": { + "$ref": "#/components/schemas/_types.query_dsl:HasChildQuery" + }, + "has_parent": { + "$ref": "#/components/schemas/_types.query_dsl:HasParentQuery" + }, + "ids": { + "$ref": "#/components/schemas/_types.query_dsl:IdsQuery" + }, + "intervals": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-intervals-query.html" + }, + "description": "Returns documents based on the order and proximity of matching terms.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.query_dsl:IntervalsQuery" + }, + "minProperties": 1, + "maxProperties": 1 + }, + "knn": { + "$ref": "#/components/schemas/_types:KnnQuery" + }, + "match": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html" + }, + "description": "Returns documents that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.query_dsl:MatchQuery" + }, + "minProperties": 1, + "maxProperties": 1 + }, + "match_all": { + "$ref": "#/components/schemas/_types.query_dsl:MatchAllQuery" + }, + "match_bool_prefix": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-bool-prefix-query.html" + }, + "description": "Analyzes its input and constructs a `bool` query from the terms.\nEach term except the last is used in a `term` query.\nThe last term is used in a prefix query.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.query_dsl:MatchBoolPrefixQuery" + }, + "minProperties": 1, + "maxProperties": 1 + }, + "match_none": { + "$ref": "#/components/schemas/_types.query_dsl:MatchNoneQuery" + }, + "match_phrase": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase.html" + }, + "description": "Analyzes the text and creates a phrase query out of the analyzed text.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.query_dsl:MatchPhraseQuery" + }, + "minProperties": 1, + "maxProperties": 1 + }, + "match_phrase_prefix": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase-prefix.html" + }, + "description": "Returns documents that contain the words of a provided text, in the same order as provided.\nThe last term of the provided text is treated as a prefix, matching any words that begin with that term.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.query_dsl:MatchPhrasePrefixQuery" + }, + "minProperties": 1, + "maxProperties": 1 + }, + "more_like_this": { + "$ref": "#/components/schemas/_types.query_dsl:MoreLikeThisQuery" + }, + "multi_match": { + "$ref": "#/components/schemas/_types.query_dsl:MultiMatchQuery" + }, + "nested": { + "$ref": "#/components/schemas/_types.query_dsl:NestedQuery" + }, + "parent_id": { + "$ref": "#/components/schemas/_types.query_dsl:ParentIdQuery" + }, + "percolate": { + "$ref": "#/components/schemas/_types.query_dsl:PercolateQuery" + }, + "pinned": { + "$ref": "#/components/schemas/_types.query_dsl:PinnedQuery" + }, + "prefix": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-prefix-query.html" + }, + "description": "Returns documents that contain a specific prefix in a provided field.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.query_dsl:PrefixQuery" + }, + "minProperties": 1, + "maxProperties": 1 + }, + "query_string": { + "$ref": "#/components/schemas/_types.query_dsl:QueryStringQuery" + }, + "range": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html" + }, + "description": "Returns documents that contain terms within a provided range.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.query_dsl:RangeQuery" + }, + "minProperties": 1, + "maxProperties": 1 + }, + "rank_feature": { + "$ref": "#/components/schemas/_types.query_dsl:RankFeatureQuery" + }, + "regexp": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-regexp-query.html" + }, + "description": "Returns documents that contain terms matching a regular expression.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.query_dsl:RegexpQuery" + }, + "minProperties": 1, + "maxProperties": 1 + }, + "rule": { + "$ref": "#/components/schemas/_types.query_dsl:RuleQuery" + }, + "script": { + "$ref": "#/components/schemas/_types.query_dsl:ScriptQuery" + }, + "script_score": { + "$ref": "#/components/schemas/_types.query_dsl:ScriptScoreQuery" + }, + "semantic": { + "$ref": "#/components/schemas/_types.query_dsl:SemanticQuery" + }, + "shape": { + "$ref": "#/components/schemas/_types.query_dsl:ShapeQuery" + }, + "simple_query_string": { + "$ref": "#/components/schemas/_types.query_dsl:SimpleQueryStringQuery" + }, + "span_containing": { + "$ref": "#/components/schemas/_types.query_dsl:SpanContainingQuery" + }, + "span_field_masking": { + "$ref": "#/components/schemas/_types.query_dsl:SpanFieldMaskingQuery" + }, + "span_first": { + "$ref": "#/components/schemas/_types.query_dsl:SpanFirstQuery" + }, + "span_multi": { + "$ref": "#/components/schemas/_types.query_dsl:SpanMultiTermQuery" + }, + "span_near": { + "$ref": "#/components/schemas/_types.query_dsl:SpanNearQuery" + }, + "span_not": { + "$ref": "#/components/schemas/_types.query_dsl:SpanNotQuery" + }, + "span_or": { + "$ref": "#/components/schemas/_types.query_dsl:SpanOrQuery" + }, + "span_term": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-term-query.html" + }, + "description": "Matches spans containing a term.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.query_dsl:SpanTermQuery" + }, + "minProperties": 1, + "maxProperties": 1 + }, + "span_within": { + "$ref": "#/components/schemas/_types.query_dsl:SpanWithinQuery" + }, + "sparse_vector": { + "$ref": "#/components/schemas/_types.query_dsl:SparseVectorQuery" + }, + "term": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html" + }, + "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.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.query_dsl:TermQuery" + }, + "minProperties": 1, + "maxProperties": 1 + }, + "terms": { + "$ref": "#/components/schemas/_types.query_dsl:TermsQuery" + }, + "terms_set": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-set-query.html" + }, + "description": "Returns documents that contain a minimum number of exact terms in a provided field.\nTo return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.query_dsl:TermsSetQuery" + }, + "minProperties": 1, + "maxProperties": 1 + }, + "text_expansion": { + "deprecated": true, + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-text-expansion-query.html" + }, + "description": "Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.", + "x-available-since": "8.8.0", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.query_dsl:TextExpansionQuery" + }, + "minProperties": 1, + "maxProperties": 1 + }, + "weighted_tokens": { + "deprecated": true, + "description": "Supports returning text_expansion query results by sending in precomputed tokens with the query.", + "x-available-since": "8.13.0", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.query_dsl:WeightedTokensQuery" + }, + "minProperties": 1, + "maxProperties": 1 + }, + "wildcard": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html" + }, + "description": "Returns documents that contain terms matching a wildcard pattern.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.query_dsl:WildcardQuery" + }, + "minProperties": 1, + "maxProperties": 1 + }, + "wrapper": { + "$ref": "#/components/schemas/_types.query_dsl:WrapperQuery" + }, + "type": { + "$ref": "#/components/schemas/_types.query_dsl:TypeQuery" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "_types.query_dsl:BoolQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "filter": { + "description": "The clause (query) must appear in matching documents.\nHowever, unlike `must`, the score of the query will be ignored.", + "oneOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + } + } + ] + }, + "minimum_should_match": { + "$ref": "#/components/schemas/_types:MinimumShouldMatch" + }, + "must": { + "description": "The clause (query) must appear in matching documents and will contribute to the score.", + "oneOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + } + } + ] + }, + "must_not": { + "description": "The clause (query) must not appear in the matching documents.\nBecause scoring is ignored, a score of `0` is returned for all documents.", + "oneOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + } + } + ] + }, + "should": { + "description": "The clause (query) should appear in the matching document.", + "oneOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + } + } + ] + } + } + } + ] + }, + "_types:MinimumShouldMatch": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html" + }, + "description": "The minimum number of terms that should match as integer, percentage or range", + "oneOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "_types.query_dsl:QueryBase": { + "type": "object", + "properties": { + "boost": { + "description": "Floating point number used to decrease or increase the relevance scores of the query.\nBoost values are relative to the default value of 1.0.\nA boost value between 0 and 1.0 decreases the relevance score.\nA value greater than 1.0 increases the relevance score.", + "type": "number" + }, + "_name": { + "type": "string" + } + } + }, + "_types.query_dsl:BoostingQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "negative_boost": { + "description": "Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the `negative` query.", + "type": "number" + }, + "negative": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "positive": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + } + }, + "required": [ + "negative_boost", + "negative", + "positive" + ] + } + ] + }, + "_types.query_dsl:CommonTermsQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "analyzer": { + "type": "string" + }, + "cutoff_frequency": { + "type": "number" + }, + "high_freq_operator": { + "$ref": "#/components/schemas/_types.query_dsl:Operator" + }, + "low_freq_operator": { + "$ref": "#/components/schemas/_types.query_dsl:Operator" + }, + "minimum_should_match": { + "$ref": "#/components/schemas/_types:MinimumShouldMatch" + }, + "query": { + "type": "string" + } + }, + "required": [ + "query" + ] + } + ] + }, + "_types.query_dsl:CombinedFieldsQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "fields": { + "description": "List of fields to search. Field wildcard patterns are allowed. Only `text` fields are supported, and they must all have the same search `analyzer`.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "query": { + "description": "Text to search for in the provided `fields`.\nThe `combined_fields` query analyzes the provided text before performing a search.", + "type": "string" + }, + "auto_generate_synonyms_phrase_query": { + "description": "If true, match phrase queries are automatically created for multi-term synonyms.", + "type": "boolean" + }, + "operator": { + "$ref": "#/components/schemas/_types.query_dsl:CombinedFieldsOperator" + }, + "minimum_should_match": { + "$ref": "#/components/schemas/_types:MinimumShouldMatch" + }, + "zero_terms_query": { + "$ref": "#/components/schemas/_types.query_dsl:CombinedFieldsZeroTerms" + } + }, + "required": [ + "fields", + "query" + ] + } + ] + }, + "_types.query_dsl:CombinedFieldsOperator": { + "type": "string", + "enum": [ + "or", + "and" + ] + }, + "_types.query_dsl:CombinedFieldsZeroTerms": { + "type": "string", + "enum": [ + "none", + "all" + ] + }, + "_types.query_dsl:ConstantScoreQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "filter": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + } + }, + "required": [ + "filter" + ] + } + ] + }, + "_types.query_dsl:DisMaxQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "queries": { + "description": "One or more query clauses.\nReturned documents must match one or more of these queries.\nIf a document matches multiple queries, Elasticsearch uses the highest relevance score.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + } + }, + "tie_breaker": { + "description": "Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses.", + "type": "number" + } + }, + "required": [ + "queries" + ] + } + ] + }, + "_types.query_dsl:DistanceFeatureQuery": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:UntypedDistanceFeatureQuery" + }, + { + "$ref": "#/components/schemas/_types.query_dsl:GeoDistanceFeatureQuery" + }, + { + "$ref": "#/components/schemas/_types.query_dsl:DateDistanceFeatureQuery" + } + ] + }, + "_types.query_dsl:UntypedDistanceFeatureQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:DistanceFeatureQueryBase" + }, + { + "type": "object" + } + ] + }, + "_types.query_dsl:DistanceFeatureQueryBase": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "origin": { + "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.", + "type": "object" + }, + "pivot": { + "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`.", + "type": "object" + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "origin", + "pivot", + "field" + ] + } + ] + }, + "_types.query_dsl:GeoDistanceFeatureQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:DistanceFeatureQueryBaseGeoLocationDistance" + }, + { + "type": "object" + } + ] + }, + "_types.query_dsl:DistanceFeatureQueryBaseGeoLocationDistance": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "origin": { + "$ref": "#/components/schemas/_types:GeoLocation" + }, + "pivot": { + "$ref": "#/components/schemas/_types:Distance" + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "origin", + "pivot", + "field" + ] + } + ] + }, + "_types:Distance": { + "type": "string" + }, + "_types.query_dsl:DateDistanceFeatureQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:DistanceFeatureQueryBaseDateMathDuration" + }, + { + "type": "object" + } + ] + }, + "_types.query_dsl:DistanceFeatureQueryBaseDateMathDuration": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "origin": { + "$ref": "#/components/schemas/_types:DateMath" + }, + "pivot": { + "$ref": "#/components/schemas/_types:Duration" + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "origin", + "pivot", + "field" + ] + } + ] + }, + "_types:DateMath": { + "type": "string" + }, + "_types.query_dsl:ExistsQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "field" + ] + } + ] + }, + "_types.query_dsl:FunctionScoreQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "boost_mode": { + "$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.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:FunctionScoreContainer" + } + }, + "max_boost": { + "description": "Restricts the new score to not exceed the provided limit.", + "type": "number" + }, + "min_score": { + "description": "Excludes documents that do not meet the provided score threshold.", + "type": "number" + }, + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "score_mode": { + "$ref": "#/components/schemas/_types.query_dsl:FunctionScoreMode" + } + } + } + ] + }, + "_types.query_dsl:FunctionBoostMode": { + "type": "string", + "enum": [ + "multiply", + "replace", + "sum", + "avg", + "max", + "min" + ] + }, + "_types.query_dsl:FunctionScoreContainer": { + "allOf": [ + { + "type": "object", + "properties": { + "filter": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "weight": { + "type": "number" + } + } + }, + { + "type": "object", + "properties": { + "exp": { + "$ref": "#/components/schemas/_types.query_dsl:DecayFunction" + }, + "gauss": { + "$ref": "#/components/schemas/_types.query_dsl:DecayFunction" + }, + "linear": { + "$ref": "#/components/schemas/_types.query_dsl:DecayFunction" + }, + "field_value_factor": { + "$ref": "#/components/schemas/_types.query_dsl:FieldValueFactorScoreFunction" + }, + "random_score": { + "$ref": "#/components/schemas/_types.query_dsl:RandomScoreFunction" + }, + "script_score": { + "$ref": "#/components/schemas/_types.query_dsl:ScriptScoreFunction" + } + }, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "_types.query_dsl:DecayFunction": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:UntypedDecayFunction" + }, + { + "$ref": "#/components/schemas/_types.query_dsl:DateDecayFunction" + }, + { + "$ref": "#/components/schemas/_types.query_dsl:NumericDecayFunction" + }, + { + "$ref": "#/components/schemas/_types.query_dsl:GeoDecayFunction" + } + ] + }, + "_types.query_dsl:UntypedDecayFunction": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:DecayFunctionBase" + }, + { + "type": "object" + } + ] + }, + "_types.query_dsl:DecayFunctionBase": { + "type": "object", + "properties": { + "multi_value_mode": { + "$ref": "#/components/schemas/_types.query_dsl:MultiValueMode" + } + } + }, + "_types.query_dsl:MultiValueMode": { + "type": "string", + "enum": [ + "min", + "max", + "avg", + "sum" + ] + }, + "_types.query_dsl:DateDecayFunction": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:DecayFunctionBaseDateMathDuration" + }, + { + "type": "object" + } + ] + }, + "_types.query_dsl:DecayFunctionBaseDateMathDuration": { + "type": "object", + "properties": { + "multi_value_mode": { + "$ref": "#/components/schemas/_types.query_dsl:MultiValueMode" + } + } + }, + "_types.query_dsl:NumericDecayFunction": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:DecayFunctionBasedoubledouble" + }, + { + "type": "object" + } + ] + }, + "_types.query_dsl:DecayFunctionBasedoubledouble": { + "type": "object", + "properties": { + "multi_value_mode": { + "$ref": "#/components/schemas/_types.query_dsl:MultiValueMode" + } + } + }, + "_types.query_dsl:GeoDecayFunction": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:DecayFunctionBaseGeoLocationDistance" + }, + { + "type": "object" + } + ] + }, + "_types.query_dsl:DecayFunctionBaseGeoLocationDistance": { + "type": "object", + "properties": { + "multi_value_mode": { + "$ref": "#/components/schemas/_types.query_dsl:MultiValueMode" + } + } + }, + "_types.query_dsl:FieldValueFactorScoreFunction": { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "factor": { + "description": "Optional factor to multiply the field value with.", + "type": "number" + }, + "missing": { + "description": "Value used if the document doesn’t have that field.\nThe modifier and factor are still applied to it as though it were read from the document.", + "type": "number" + }, + "modifier": { + "$ref": "#/components/schemas/_types.query_dsl:FieldValueFactorModifier" + } + }, + "required": [ + "field" + ] + }, + "_types.query_dsl:FieldValueFactorModifier": { + "type": "string", + "enum": [ + "none", + "log", + "log1p", + "log2p", + "ln", + "ln1p", + "ln2p", + "square", + "sqrt", + "reciprocal" + ] + }, + "_types.query_dsl:RandomScoreFunction": { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "seed": { + "oneOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + } + } + }, + "_types.query_dsl:ScriptScoreFunction": { + "type": "object", + "properties": { + "script": { + "$ref": "#/components/schemas/_types:Script" + } + }, + "required": [ + "script" + ] + }, + "_types:Script": { + "type": "object", + "properties": { + "source": { + "description": "The script source.", + "type": "string" + }, + "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" + } + } + } + }, + "_types:ScriptLanguage": { + "anyOf": [ + { + "type": "string", + "enum": [ + "painless", + "expression", + "mustache", + "java" + ] + }, + { + "type": "string" + } + ] + }, + "_types.query_dsl:FunctionScoreMode": { + "type": "string", + "enum": [ + "multiply", + "sum", + "avg", + "first", + "max", + "min" + ] + }, + "_types.query_dsl:FuzzyQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "max_expansions": { + "description": "Maximum number of variations created.", + "type": "number" + }, + "prefix_length": { + "description": "Number of beginning characters left unchanged when creating expansions.", + "type": "number" + }, + "rewrite": { + "$ref": "#/components/schemas/_types:MultiTermQueryRewrite" + }, + "transpositions": { + "description": "Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`).", + "type": "boolean" + }, + "fuzziness": { + "$ref": "#/components/schemas/_types:Fuzziness" + }, + "value": { + "description": "Term you wish to find in the provided field.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "value" + ] + } + ] + }, + "_types:MultiTermQueryRewrite": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html" + }, + "type": "string" + }, + "_types:Fuzziness": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness" + }, + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + } + ] + }, + "_types.query_dsl:GeoBoundingBoxQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/_types.query_dsl:GeoExecution" + }, + "validation_method": { + "$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.", + "type": "boolean" + } + } + } + ] + }, + "_types.query_dsl:GeoExecution": { + "type": "string", + "enum": [ + "memory", + "indexed" + ] + }, + "_types.query_dsl:GeoValidationMethod": { + "type": "string", + "enum": [ + "coerce", + "ignore_malformed", + "strict" + ] + }, + "_types.query_dsl:GeoDistanceQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "distance": { + "$ref": "#/components/schemas/_types:Distance" + }, + "distance_type": { + "$ref": "#/components/schemas/_types:GeoDistanceType" + }, + "validation_method": { + "$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.", + "type": "boolean" + } + }, + "required": [ + "distance" + ] + } + ] + }, + "_types:GeoDistanceType": { + "type": "string", + "enum": [ + "arc", + "plane" + ] + }, + "_types.query_dsl:GeoPolygonQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "validation_method": { + "$ref": "#/components/schemas/_types.query_dsl:GeoValidationMethod" + }, + "ignore_unmapped": { + "type": "boolean" + } + } + } + ] + }, + "_types.query_dsl:GeoShapeQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "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.", + "type": "boolean" + } + } + } + ] + }, + "_types.query_dsl:HasChildQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "ignore_unmapped": { + "description": "Indicates whether to ignore an unmapped `type` and not return any documents instead of an error.", + "type": "boolean" + }, + "inner_hits": { + "$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.", + "type": "number" + }, + "min_children": { + "description": "Minimum number of child documents that match the query required to match the query for a returned parent document.\nIf the parent document does not meet this limit, it is excluded from the search results.", + "type": "number" + }, + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "score_mode": { + "$ref": "#/components/schemas/_types.query_dsl:ChildScoreMode" + }, + "type": { + "$ref": "#/components/schemas/_types:RelationName" + } + }, + "required": [ + "query", + "type" + ] + } + ] + }, + "_global.search._types:InnerHits": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/_types:Name" + }, + "size": { + "description": "The maximum number of hits to return per `inner_hits`.", + "type": "number" + }, + "from": { + "description": "Inner hit starting document offset.", + "type": "number" + }, + "collapse": { + "$ref": "#/components/schemas/_global.search._types:FieldCollapse" + }, + "docvalue_fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:FieldAndFormat" + } + }, + "explain": { + "type": "boolean" + }, + "highlight": { + "$ref": "#/components/schemas/_global.search._types:Highlight" + }, + "ignore_unmapped": { + "type": "boolean" + }, + "script_fields": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types:ScriptField" + } + }, + "seq_no_primary_term": { + "type": "boolean" + }, + "fields": { + "$ref": "#/components/schemas/_types:Fields" + }, + "sort": { + "$ref": "#/components/schemas/_types:Sort" + }, + "_source": { + "$ref": "#/components/schemas/_global.search._types:SourceConfig" + }, + "stored_fields": { + "$ref": "#/components/schemas/_types:Fields" + }, + "track_scores": { + "type": "boolean" + }, + "version": { + "type": "boolean" + } + } + }, + "_types:Name": { + "type": "string" + }, + "_global.search._types:FieldCollapse": { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "inner_hits": { + "description": "The number of inner hits and their sort order", + "oneOf": [ + { + "$ref": "#/components/schemas/_global.search._types:InnerHits" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.search._types:InnerHits" + } + } + ] + }, + "max_concurrent_group_searches": { + "description": "The number of concurrent requests allowed to retrieve the inner_hits per group", + "type": "number" + }, + "collapse": { + "$ref": "#/components/schemas/_global.search._types:FieldCollapse" + } + }, + "required": [ + "field" + ] + }, + "_types.query_dsl:FieldAndFormat": { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "format": { + "description": "Format in which the values are returned.", + "type": "string" + }, + "include_unmapped": { + "type": "boolean" + } + }, + "required": [ + "field" + ] + }, + "_global.search._types:Highlight": { + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types:HighlightBase" + }, + { + "type": "object", + "properties": { + "encoder": { + "$ref": "#/components/schemas/_global.search._types:HighlighterEncoder" + }, + "fields": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_global.search._types:HighlightField" + } + } + }, + "required": [ + "fields" + ] + } + ] + }, + "_global.search._types:HighlighterEncoder": { + "type": "string", + "enum": [ + "default", + "html" + ] + }, + "_global.search._types:HighlightField": { + "allOf": [ + { + "$ref": "#/components/schemas/_global.search._types:HighlightBase" + }, + { + "type": "object", + "properties": { + "fragment_offset": { + "type": "number" + }, + "matched_fields": { + "$ref": "#/components/schemas/_types:Fields" + }, + "analyzer": { + "$ref": "#/components/schemas/_types.analysis:Analyzer" + } + } + } + ] + }, + "_types.analysis:Analyzer": { + "discriminator": { + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/_types.analysis:CustomAnalyzer" + }, + { + "$ref": "#/components/schemas/_types.analysis:FingerprintAnalyzer" + }, + { + "$ref": "#/components/schemas/_types.analysis:KeywordAnalyzer" + }, + { + "$ref": "#/components/schemas/_types.analysis:LanguageAnalyzer" + }, + { + "$ref": "#/components/schemas/_types.analysis:NoriAnalyzer" + }, + { + "$ref": "#/components/schemas/_types.analysis:PatternAnalyzer" + }, + { + "$ref": "#/components/schemas/_types.analysis:SimpleAnalyzer" + }, + { + "$ref": "#/components/schemas/_types.analysis:StandardAnalyzer" + }, + { + "$ref": "#/components/schemas/_types.analysis:StopAnalyzer" + }, + { + "$ref": "#/components/schemas/_types.analysis:WhitespaceAnalyzer" + }, + { + "$ref": "#/components/schemas/_types.analysis:IcuAnalyzer" + }, + { + "$ref": "#/components/schemas/_types.analysis:KuromojiAnalyzer" + }, + { + "$ref": "#/components/schemas/_types.analysis:SnowballAnalyzer" + }, + { + "$ref": "#/components/schemas/_types.analysis:DutchAnalyzer" + } + ] + }, + "_types.analysis:CustomAnalyzer": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "custom" + ] + }, + "char_filter": { + "type": "array", + "items": { + "type": "string" + } + }, + "filter": { + "type": "array", + "items": { + "type": "string" + } + }, + "position_increment_gap": { + "type": "number" + }, + "position_offset_gap": { + "type": "number" + }, + "tokenizer": { + "type": "string" + } + }, + "required": [ + "type", + "tokenizer" + ] + }, + "_types.analysis:FingerprintAnalyzer": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "fingerprint" + ] + }, + "version": { + "$ref": "#/components/schemas/_types:VersionString" + }, + "max_output_size": { + "type": "number" + }, + "preserve_original": { + "type": "boolean" + }, + "separator": { + "type": "string" + }, + "stopwords": { + "$ref": "#/components/schemas/_types.analysis:StopWords" + }, + "stopwords_path": { + "type": "string" + } + }, + "required": [ + "type", + "max_output_size", + "preserve_original", + "separator" + ] + }, + "_types.analysis:StopWords": { + "description": "Language value, such as _arabic_ or _thai_. Defaults to _english_.\nEach language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words.\nAlso accepts an array of stop words.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "_types.analysis:KeywordAnalyzer": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "keyword" + ] + }, + "version": { + "$ref": "#/components/schemas/_types:VersionString" + } + }, + "required": [ + "type" + ] + }, + "_types.analysis:LanguageAnalyzer": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "language" + ] + }, + "version": { + "$ref": "#/components/schemas/_types:VersionString" + }, + "language": { + "$ref": "#/components/schemas/_types.analysis:Language" + }, + "stem_exclusion": { + "type": "array", + "items": { + "type": "string" + } + }, + "stopwords": { + "$ref": "#/components/schemas/_types.analysis:StopWords" + }, + "stopwords_path": { + "type": "string" + } + }, + "required": [ + "type", + "language", + "stem_exclusion" + ] + }, + "_types.analysis:Language": { + "type": "string", + "enum": [ + "Arabic", + "Armenian", + "Basque", + "Brazilian", + "Bulgarian", + "Catalan", + "Chinese", + "Cjk", + "Czech", + "Danish", + "Dutch", + "English", + "Estonian", + "Finnish", + "French", + "Galician", + "German", + "Greek", + "Hindi", + "Hungarian", + "Indonesian", + "Irish", + "Italian", + "Latvian", + "Norwegian", + "Persian", + "Portuguese", + "Romanian", + "Russian", + "Sorani", + "Spanish", + "Swedish", + "Turkish", + "Thai" + ] + }, + "_types.analysis:NoriAnalyzer": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "nori" + ] + }, + "version": { + "$ref": "#/components/schemas/_types:VersionString" + }, + "decompound_mode": { + "$ref": "#/components/schemas/_types.analysis:NoriDecompoundMode" + }, + "stoptags": { + "type": "array", + "items": { + "type": "string" + } + }, + "user_dictionary": { + "type": "string" + } + }, + "required": [ + "type" + ] + }, + "_types.analysis:NoriDecompoundMode": { + "type": "string", + "enum": [ + "discard", + "none", + "mixed" + ] + }, + "_types.analysis:PatternAnalyzer": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "pattern" + ] + }, + "version": { + "$ref": "#/components/schemas/_types:VersionString" + }, + "flags": { + "type": "string" + }, + "lowercase": { + "type": "boolean" + }, + "pattern": { + "type": "string" + }, + "stopwords": { + "$ref": "#/components/schemas/_types.analysis:StopWords" + } + }, + "required": [ + "type", + "pattern" + ] + }, + "_types.analysis:SimpleAnalyzer": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "simple" + ] + }, + "version": { + "$ref": "#/components/schemas/_types:VersionString" + } + }, + "required": [ + "type" + ] + }, + "_types.analysis:StandardAnalyzer": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "standard" + ] + }, + "max_token_length": { + "type": "number" + }, + "stopwords": { + "$ref": "#/components/schemas/_types.analysis:StopWords" + } + }, + "required": [ + "type" + ] + }, + "_types.analysis:StopAnalyzer": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "stop" + ] + }, + "version": { + "$ref": "#/components/schemas/_types:VersionString" + }, + "stopwords": { + "$ref": "#/components/schemas/_types.analysis:StopWords" + }, + "stopwords_path": { + "type": "string" + } + }, + "required": [ + "type" + ] + }, + "_types.analysis:WhitespaceAnalyzer": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "whitespace" + ] + }, + "version": { + "$ref": "#/components/schemas/_types:VersionString" + } + }, + "required": [ + "type" + ] + }, + "_types.analysis:IcuAnalyzer": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "icu_analyzer" + ] + }, + "method": { + "$ref": "#/components/schemas/_types.analysis:IcuNormalizationType" + }, + "mode": { + "$ref": "#/components/schemas/_types.analysis:IcuNormalizationMode" + } + }, + "required": [ + "type", + "method", + "mode" + ] + }, + "_types.analysis:IcuNormalizationType": { + "type": "string", + "enum": [ + "nfc", + "nfkc", + "nfkc_cf" + ] + }, + "_types.analysis:IcuNormalizationMode": { + "type": "string", + "enum": [ + "decompose", + "compose" + ] + }, + "_types.analysis:KuromojiAnalyzer": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "kuromoji" + ] + }, + "mode": { + "$ref": "#/components/schemas/_types.analysis:KuromojiTokenizationMode" + }, + "user_dictionary": { + "type": "string" + } + }, + "required": [ + "type", + "mode" + ] + }, + "_types.analysis:KuromojiTokenizationMode": { + "type": "string", + "enum": [ + "normal", + "search", + "extended" + ] + }, + "_types.analysis:SnowballAnalyzer": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "snowball" + ] + }, + "version": { + "$ref": "#/components/schemas/_types:VersionString" + }, + "language": { + "$ref": "#/components/schemas/_types.analysis:SnowballLanguage" + }, + "stopwords": { + "$ref": "#/components/schemas/_types.analysis:StopWords" + } + }, + "required": [ + "type", + "language" + ] + }, + "_types.analysis:SnowballLanguage": { + "type": "string", + "enum": [ + "Armenian", + "Basque", + "Catalan", + "Danish", + "Dutch", + "English", + "Finnish", + "French", + "German", + "German2", + "Hungarian", + "Italian", + "Kp", + "Lovins", + "Norwegian", + "Porter", + "Portuguese", + "Romanian", + "Russian", + "Spanish", + "Swedish", + "Turkish" + ] + }, + "_types.analysis:DutchAnalyzer": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "dutch" + ] + }, + "stopwords": { + "$ref": "#/components/schemas/_types.analysis:StopWords" + } + }, + "required": [ + "type" + ] + }, + "_global.search._types:HighlightBase": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/_global.search._types:HighlighterType" + }, + "boundary_chars": { + "description": "A string that contains each boundary character.", + "type": "string" + }, + "boundary_max_scan": { + "description": "How far to scan for boundary characters.", + "type": "number" + }, + "boundary_scanner": { + "$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\"`.", + "type": "string" + }, + "force_source": { + "deprecated": true, + "type": "boolean" + }, + "fragmenter": { + "$ref": "#/components/schemas/_global.search._types:HighlighterFragmenter" + }, + "fragment_size": { + "description": "The size of the highlighted fragment in characters.", + "type": "number" + }, + "highlight_filter": { + "type": "boolean" + }, + "highlight_query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "max_fragment_length": { + "type": "number" + }, + "max_analyzed_offset": { + "description": "If set to a non-negative value, highlighting stops at this defined maximum limit.\nThe rest of the text is not processed, thus not highlighted and no error is returned\nThe `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting.", + "type": "number" + }, + "no_match_size": { + "description": "The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight.", + "type": "number" + }, + "number_of_fragments": { + "description": "The maximum number of fragments to return.\nIf the number of fragments is set to `0`, no fragments are returned.\nInstead, the entire field contents are highlighted and returned.\nThis can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required.\nIf `number_of_fragments` is `0`, `fragment_size` is ignored.", + "type": "number" + }, + "options": { + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "order": { + "$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.", + "type": "number" + }, + "post_tags": { + "description": "Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text.\nBy default, highlighted text is wrapped in `` and `` tags.", + "type": "array", + "items": { + "type": "string" + } + }, + "pre_tags": { + "description": "Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text.\nBy default, highlighted text is wrapped in `` and `` tags.", + "type": "array", + "items": { + "type": "string" + } + }, + "require_field_match": { + "description": "By default, only fields that contains a query match are highlighted.\nSet to `false` to highlight all fields.", + "type": "boolean" + }, + "tags_schema": { + "$ref": "#/components/schemas/_global.search._types:HighlighterTagsSchema" + } + } + }, + "_global.search._types:HighlighterType": { + "anyOf": [ + { + "type": "string", + "enum": [ + "plain", + "fvh", + "unified" + ] + }, + { + "type": "string" + } + ] + }, + "_global.search._types:BoundaryScanner": { + "type": "string", + "enum": [ + "chars", + "sentence", + "word" + ] + }, + "_global.search._types:HighlighterFragmenter": { + "type": "string", + "enum": [ + "simple", + "span" + ] + }, + "_global.search._types:HighlighterOrder": { + "type": "string", + "enum": [ + "score" + ] + }, + "_global.search._types:HighlighterTagsSchema": { + "type": "string", + "enum": [ + "styled" + ] + }, + "_types:ScriptField": { + "type": "object", + "properties": { + "script": { + "$ref": "#/components/schemas/_types:Script" + }, + "ignore_failure": { + "type": "boolean" + } + }, + "required": [ + "script" + ] + }, + "_types:Sort": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types:SortCombinations" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:SortCombinations" + } + } + ] + }, + "_types:SortCombinations": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types:Field" + }, + { + "$ref": "#/components/schemas/_types:SortOptions" + } + ] + }, + "_types:SortOptions": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html" + }, + "type": "object", + "properties": { + "_score": { + "$ref": "#/components/schemas/_types:ScoreSort" + }, + "_doc": { + "$ref": "#/components/schemas/_types:ScoreSort" + }, + "_geo_distance": { + "$ref": "#/components/schemas/_types:GeoDistanceSort" + }, + "_script": { + "$ref": "#/components/schemas/_types:ScriptSort" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "_types:ScoreSort": { + "type": "object", + "properties": { + "order": { + "$ref": "#/components/schemas/_types:SortOrder" + } + } + }, + "_types:SortOrder": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + }, + "_types:GeoDistanceSort": { + "type": "object", + "properties": { + "mode": { + "$ref": "#/components/schemas/_types:SortMode" + }, + "distance_type": { + "$ref": "#/components/schemas/_types:GeoDistanceType" + }, + "ignore_unmapped": { + "type": "boolean" + }, + "order": { + "$ref": "#/components/schemas/_types:SortOrder" + }, + "unit": { + "$ref": "#/components/schemas/_types:DistanceUnit" + }, + "nested": { + "$ref": "#/components/schemas/_types:NestedSortValue" + } + } + }, + "_types:SortMode": { + "type": "string", + "enum": [ + "min", + "max", + "sum", + "avg", + "median" + ] + }, + "_types:DistanceUnit": { + "type": "string", + "enum": [ + "in", + "ft", + "yd", + "mi", + "nmi", + "km", + "m", + "cm", + "mm" + ] + }, + "_types:NestedSortValue": { + "type": "object", + "properties": { + "filter": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "max_children": { + "type": "number" + }, + "nested": { + "$ref": "#/components/schemas/_types:NestedSortValue" + }, + "path": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "path" + ] + }, + "_types:ScriptSort": { + "type": "object", + "properties": { + "order": { + "$ref": "#/components/schemas/_types:SortOrder" + }, + "script": { + "$ref": "#/components/schemas/_types:Script" + }, + "type": { + "$ref": "#/components/schemas/_types:ScriptSortType" + }, + "mode": { + "$ref": "#/components/schemas/_types:SortMode" + }, + "nested": { + "$ref": "#/components/schemas/_types:NestedSortValue" + } + }, + "required": [ + "script" + ] + }, + "_types:ScriptSortType": { + "type": "string", + "enum": [ + "string", + "number", + "version" + ] + }, + "_global.search._types:SourceConfig": { + "description": "Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.", + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "#/components/schemas/_global.search._types:SourceFilter" + } + ] + }, + "_global.search._types:SourceFilter": { + "type": "object", + "properties": { + "excludes": { + "$ref": "#/components/schemas/_types:Fields" + }, + "includes": { + "$ref": "#/components/schemas/_types:Fields" + } + } + }, + "_types.query_dsl:ChildScoreMode": { + "type": "string", + "enum": [ + "none", + "avg", + "sum", + "max", + "min" + ] + }, + "_types:RelationName": { + "type": "string" + }, + "_types.query_dsl:HasParentQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "ignore_unmapped": { + "description": "Indicates whether to ignore an unmapped `parent_type` and not return any documents instead of an error.\nYou can use this parameter to query multiple indices that may not contain the `parent_type`.", + "type": "boolean" + }, + "inner_hits": { + "$ref": "#/components/schemas/_global.search._types:InnerHits" + }, + "parent_type": { + "$ref": "#/components/schemas/_types:RelationName" + }, + "query": { + "$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.", + "type": "boolean" + } + }, + "required": [ + "parent_type", + "query" + ] + } + ] + }, + "_types.query_dsl:IdsQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "values": { + "$ref": "#/components/schemas/_types:Ids" + } + } + } + ] + }, + "_types:Ids": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types:Id" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Id" + } + } + ] + }, + "_types.query_dsl:IntervalsQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "all_of": { + "$ref": "#/components/schemas/_types.query_dsl:IntervalsAllOf" + }, + "any_of": { + "$ref": "#/components/schemas/_types.query_dsl:IntervalsAnyOf" + }, + "fuzzy": { + "$ref": "#/components/schemas/_types.query_dsl:IntervalsFuzzy" + }, + "match": { + "$ref": "#/components/schemas/_types.query_dsl:IntervalsMatch" + }, + "prefix": { + "$ref": "#/components/schemas/_types.query_dsl:IntervalsPrefix" + }, + "wildcard": { + "$ref": "#/components/schemas/_types.query_dsl:IntervalsWildcard" + } + }, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "_types.query_dsl:IntervalsAllOf": { + "type": "object", + "properties": { + "intervals": { + "description": "An array of rules to combine. All rules must produce a match in a document for the overall source to match.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:IntervalsContainer" + } + }, + "max_gaps": { + "description": "Maximum number of positions between the matching terms.\nIntervals produced by the rules further apart than this are not considered matches.", + "type": "number" + }, + "ordered": { + "description": "If `true`, intervals produced by the rules should appear in the order in which they are specified.", + "type": "boolean" + }, + "filter": { + "$ref": "#/components/schemas/_types.query_dsl:IntervalsFilter" + } + }, + "required": [ + "intervals" + ] + }, + "_types.query_dsl:IntervalsContainer": { + "type": "object", + "properties": { + "all_of": { + "$ref": "#/components/schemas/_types.query_dsl:IntervalsAllOf" + }, + "any_of": { + "$ref": "#/components/schemas/_types.query_dsl:IntervalsAnyOf" + }, + "fuzzy": { + "$ref": "#/components/schemas/_types.query_dsl:IntervalsFuzzy" + }, + "match": { + "$ref": "#/components/schemas/_types.query_dsl:IntervalsMatch" + }, + "prefix": { + "$ref": "#/components/schemas/_types.query_dsl:IntervalsPrefix" + }, + "wildcard": { + "$ref": "#/components/schemas/_types.query_dsl:IntervalsWildcard" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "_types.query_dsl:IntervalsAnyOf": { + "type": "object", + "properties": { + "intervals": { + "description": "An array of rules to match.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:IntervalsContainer" + } + }, + "filter": { + "$ref": "#/components/schemas/_types.query_dsl:IntervalsFilter" + } + }, + "required": [ + "intervals" + ] + }, + "_types.query_dsl:IntervalsFilter": { + "type": "object", + "properties": { + "after": { + "$ref": "#/components/schemas/_types.query_dsl:IntervalsContainer" + }, + "before": { + "$ref": "#/components/schemas/_types.query_dsl:IntervalsContainer" + }, + "contained_by": { + "$ref": "#/components/schemas/_types.query_dsl:IntervalsContainer" + }, + "containing": { + "$ref": "#/components/schemas/_types.query_dsl:IntervalsContainer" + }, + "not_contained_by": { + "$ref": "#/components/schemas/_types.query_dsl:IntervalsContainer" + }, + "not_containing": { + "$ref": "#/components/schemas/_types.query_dsl:IntervalsContainer" + }, + "not_overlapping": { + "$ref": "#/components/schemas/_types.query_dsl:IntervalsContainer" + }, + "overlapping": { + "$ref": "#/components/schemas/_types.query_dsl:IntervalsContainer" + }, + "script": { + "$ref": "#/components/schemas/_types:Script" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "_types.query_dsl:IntervalsFuzzy": { + "type": "object", + "properties": { + "analyzer": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html" + }, + "description": "Analyzer used to normalize the term.", + "type": "string" + }, + "fuzziness": { + "$ref": "#/components/schemas/_types:Fuzziness" + }, + "prefix_length": { + "description": "Number of beginning characters left unchanged when creating expansions.", + "type": "number" + }, + "term": { + "description": "The term to match.", + "type": "string" + }, + "transpositions": { + "description": "Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`).", + "type": "boolean" + }, + "use_field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "term" + ] + }, + "_types.query_dsl:IntervalsMatch": { + "type": "object", + "properties": { + "analyzer": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html" + }, + "description": "Analyzer used to analyze terms in the query.", + "type": "string" + }, + "max_gaps": { + "description": "Maximum number of positions between the matching terms.\nTerms further apart than this are not considered matches.", + "type": "number" + }, + "ordered": { + "description": "If `true`, matching terms must appear in their specified order.", + "type": "boolean" + }, + "query": { + "description": "Text you wish to find in the provided field.", + "type": "string" + }, + "use_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "filter": { + "$ref": "#/components/schemas/_types.query_dsl:IntervalsFilter" + } + }, + "required": [ + "query" + ] + }, + "_types.query_dsl:IntervalsPrefix": { + "type": "object", + "properties": { + "analyzer": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html" + }, + "description": "Analyzer used to analyze the `prefix`.", + "type": "string" + }, + "prefix": { + "description": "Beginning characters of terms you wish to find in the top-level field.", + "type": "string" + }, + "use_field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "prefix" + ] + }, + "_types.query_dsl:IntervalsWildcard": { + "type": "object", + "properties": { + "analyzer": { + "description": "Analyzer used to analyze the `pattern`.\nDefaults to the top-level field's analyzer.", + "type": "string" + }, + "pattern": { + "description": "Wildcard pattern used to find matching terms.", + "type": "string" + }, + "use_field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "pattern" + ] + }, + "_types:KnnQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "query_vector": { + "$ref": "#/components/schemas/_types:QueryVector" + }, + "query_vector_builder": { + "$ref": "#/components/schemas/_types:QueryVectorBuilder" + }, + "num_candidates": { + "description": "The number of nearest neighbor candidates to consider per shard", + "type": "number" + }, + "filter": { + "description": "Filters for the kNN search query", + "oneOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + } + } + ] + }, + "similarity": { + "description": "The minimum similarity for a vector to be considered a match", + "type": "number" + } + }, + "required": [ + "field" + ] + } + ] + }, + "_types:QueryVector": { + "type": "array", + "items": { + "type": "number" + } + }, + "_types:QueryVectorBuilder": { + "type": "object", + "properties": { + "text_embedding": { + "$ref": "#/components/schemas/_types:TextEmbedding" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "_types:TextEmbedding": { + "type": "object", + "properties": { + "model_id": { + "type": "string" + }, + "model_text": { + "type": "string" + } + }, + "required": [ + "model_id", + "model_text" + ] + }, + "_types.query_dsl:MatchQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "analyzer": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html" + }, + "description": "Analyzer used to convert the text in the query value into tokens.", + "type": "string" + }, + "auto_generate_synonyms_phrase_query": { + "description": "If `true`, match phrase queries are automatically created for multi-term synonyms.", + "type": "boolean" + }, + "cutoff_frequency": { + "deprecated": true, + "type": "number" + }, + "fuzziness": { + "$ref": "#/components/schemas/_types:Fuzziness" + }, + "fuzzy_rewrite": { + "$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`).", + "type": "boolean" + }, + "lenient": { + "description": "If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored.", + "type": "boolean" + }, + "max_expansions": { + "description": "Maximum number of terms to which the query will expand.", + "type": "number" + }, + "minimum_should_match": { + "$ref": "#/components/schemas/_types:MinimumShouldMatch" + }, + "operator": { + "$ref": "#/components/schemas/_types.query_dsl:Operator" + }, + "prefix_length": { + "description": "Number of beginning characters left unchanged for fuzzy matching.", + "type": "number" + }, + "query": { + "description": "Text, number, boolean value or date you wish to find in the provided field.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + }, + "zero_terms_query": { + "$ref": "#/components/schemas/_types.query_dsl:ZeroTermsQuery" + } + }, + "required": [ + "query" + ] + } + ] + }, + "_types.query_dsl:ZeroTermsQuery": { + "type": "string", + "enum": [ + "all", + "none" + ] + }, + "_types.query_dsl:MatchAllQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object" + } + ] + }, + "_types.query_dsl:MatchBoolPrefixQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "analyzer": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html" + }, + "description": "Analyzer used to convert the text in the query value into tokens.", + "type": "string" + }, + "fuzziness": { + "$ref": "#/components/schemas/_types:Fuzziness" + }, + "fuzzy_rewrite": { + "$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.", + "type": "boolean" + }, + "max_expansions": { + "description": "Maximum number of terms to which the query will expand.\nCan be applied to the term subqueries constructed for all terms but the final term.", + "type": "number" + }, + "minimum_should_match": { + "$ref": "#/components/schemas/_types:MinimumShouldMatch" + }, + "operator": { + "$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.", + "type": "number" + }, + "query": { + "description": "Terms you wish to find in the provided field.\nThe last term is used in a prefix query.", + "type": "string" + } + }, + "required": [ + "query" + ] + } + ] + }, + "_types.query_dsl:MatchNoneQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object" + } + ] + }, + "_types.query_dsl:MatchPhraseQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "analyzer": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html" + }, + "description": "Analyzer used to convert the text in the query value into tokens.", + "type": "string" + }, + "query": { + "description": "Query terms that are analyzed and turned into a phrase query.", + "type": "string" + }, + "slop": { + "description": "Maximum number of positions allowed between matching tokens.", + "type": "number" + }, + "zero_terms_query": { + "$ref": "#/components/schemas/_types.query_dsl:ZeroTermsQuery" + } + }, + "required": [ + "query" + ] + } + ] + }, + "_types.query_dsl:MatchPhrasePrefixQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "analyzer": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html" + }, + "description": "Analyzer used to convert text in the query value into tokens.", + "type": "string" + }, + "max_expansions": { + "description": "Maximum number of terms to which the last provided term of the query value will expand.", + "type": "number" + }, + "query": { + "description": "Text you wish to find in the provided field.", + "type": "string" + }, + "slop": { + "description": "Maximum number of positions allowed between matching tokens.", + "type": "number" + }, + "zero_terms_query": { + "$ref": "#/components/schemas/_types.query_dsl:ZeroTermsQuery" + } + }, + "required": [ + "query" + ] + } + ] + }, + "_types.query_dsl:MoreLikeThisQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "analyzer": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html" + }, + "description": "The analyzer that is used to analyze the free form text.\nDefaults to the analyzer associated with the first field in fields.", + "type": "string" + }, + "boost_terms": { + "description": "Each term in the formed query could be further boosted by their tf-idf score.\nThis sets the boost factor to use when using this feature.\nDefaults to deactivated (0).", + "type": "number" + }, + "fail_on_unsupported_field": { + "description": "Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (`text` or `keyword`).", + "type": "boolean" + }, + "fields": { + "description": "A list of fields to fetch and analyze the text from.\nDefaults to the `index.query.default_field` index setting, which has a default value of `*`.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "include": { + "description": "Specifies whether the input documents should also be included in the search results returned.", + "type": "boolean" + }, + "like": { + "description": "Specifies free form text and/or a single or multiple documents for which you want to find similar documents.", + "oneOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:Like" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:Like" + } + } + ] + }, + "max_doc_freq": { + "description": "The maximum document frequency above which the terms are ignored from the input document.", + "type": "number" + }, + "max_query_terms": { + "description": "The maximum number of query terms that can be selected.", + "type": "number" + }, + "max_word_length": { + "description": "The maximum word length above which the terms are ignored.\nDefaults to unbounded (`0`).", + "type": "number" + }, + "min_doc_freq": { + "description": "The minimum document frequency below which the terms are ignored from the input document.", + "type": "number" + }, + "minimum_should_match": { + "$ref": "#/components/schemas/_types:MinimumShouldMatch" + }, + "min_term_freq": { + "description": "The minimum term frequency below which the terms are ignored from the input document.", + "type": "number" + }, + "min_word_length": { + "description": "The minimum word length below which the terms are ignored.", + "type": "number" + }, + "routing": { + "$ref": "#/components/schemas/_types:Routing" + }, + "stop_words": { + "$ref": "#/components/schemas/_types.analysis:StopWords" + }, + "unlike": { + "description": "Used in combination with `like` to exclude documents that match a set of terms.", + "oneOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:Like" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:Like" + } + } + ] + }, + "version": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "version_type": { + "$ref": "#/components/schemas/_types:VersionType" + } + }, + "required": [ + "like" + ] + } + ] + }, + "_types.query_dsl:Like": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html#_document_input_parameters" + }, + "description": "Text that we want similar documents for or a lookup to a document's field for the text.", + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/_types.query_dsl:LikeDocument" + } + ] + }, + "_types.query_dsl:LikeDocument": { + "type": "object", + "properties": { + "doc": { + "description": "A document not present in the index.", + "type": "object" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "_index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "per_field_analyzer": { + "description": "Overrides the default analyzer.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "routing": { + "$ref": "#/components/schemas/_types:Routing" + }, + "version": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "version_type": { + "$ref": "#/components/schemas/_types:VersionType" + } + } + }, + "_types:VersionType": { + "type": "string", + "enum": [ + "internal", + "external", + "external_gte", + "force" + ] + }, + "_types.query_dsl:MultiMatchQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "analyzer": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html" + }, + "description": "Analyzer used to convert the text in the query value into tokens.", + "type": "string" + }, + "auto_generate_synonyms_phrase_query": { + "description": "If `true`, match phrase queries are automatically created for multi-term synonyms.", + "type": "boolean" + }, + "cutoff_frequency": { + "deprecated": true, + "type": "number" + }, + "fields": { + "$ref": "#/components/schemas/_types:Fields" + }, + "fuzziness": { + "$ref": "#/components/schemas/_types:Fuzziness" + }, + "fuzzy_rewrite": { + "$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.", + "type": "boolean" + }, + "lenient": { + "description": "If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored.", + "type": "boolean" + }, + "max_expansions": { + "description": "Maximum number of terms to which the query will expand.", + "type": "number" + }, + "minimum_should_match": { + "$ref": "#/components/schemas/_types:MinimumShouldMatch" + }, + "operator": { + "$ref": "#/components/schemas/_types.query_dsl:Operator" + }, + "prefix_length": { + "description": "Number of beginning characters left unchanged for fuzzy matching.", + "type": "number" + }, + "query": { + "description": "Text, number, boolean value or date you wish to find in the provided field.", + "type": "string" + }, + "slop": { + "description": "Maximum number of positions allowed between matching tokens.", + "type": "number" + }, + "tie_breaker": { + "description": "Determines how scores for each per-term blended query and scores across groups are combined.", + "type": "number" + }, + "type": { + "$ref": "#/components/schemas/_types.query_dsl:TextQueryType" + }, + "zero_terms_query": { + "$ref": "#/components/schemas/_types.query_dsl:ZeroTermsQuery" + } + }, + "required": [ + "query" + ] + } + ] + }, + "_types.query_dsl:TextQueryType": { + "type": "string", + "enum": [ + "best_fields", + "most_fields", + "cross_fields", + "phrase", + "phrase_prefix", + "bool_prefix" + ] + }, + "_types.query_dsl:NestedQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "ignore_unmapped": { + "description": "Indicates whether to ignore an unmapped path and not return any documents instead of an error.", + "type": "boolean" + }, + "inner_hits": { + "$ref": "#/components/schemas/_global.search._types:InnerHits" + }, + "path": { + "$ref": "#/components/schemas/_types:Field" + }, + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "score_mode": { + "$ref": "#/components/schemas/_types.query_dsl:ChildScoreMode" + } + }, + "required": [ + "path", + "query" + ] + } + ] + }, + "_types.query_dsl:ParentIdQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "ignore_unmapped": { + "description": "Indicates whether to ignore an unmapped `type` and not return any documents instead of an error.", + "type": "boolean" + }, + "type": { + "$ref": "#/components/schemas/_types:RelationName" + } + } + } + ] + }, + "_types.query_dsl:PercolateQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "document": { + "description": "The source of the document being percolated.", + "type": "object" + }, + "documents": { + "description": "An array of sources of the documents being percolated.", + "type": "array", + "items": { + "type": "object" + } + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "name": { + "description": "The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified.", + "type": "string" + }, + "preference": { + "description": "Preference used to fetch document to percolate.", + "type": "string" + }, + "routing": { + "$ref": "#/components/schemas/_types:Routing" + }, + "version": { + "$ref": "#/components/schemas/_types:VersionNumber" + } + }, + "required": [ + "field" + ] + } + ] + }, + "_types.query_dsl:PinnedQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "organic": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + } + }, + "required": [ + "organic" + ] + }, + { + "type": "object", + "properties": { + "ids": { + "description": "Document IDs listed in the order they are to appear in results.\nRequired if `docs` is not specified.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Id" + } + }, + "docs": { + "description": "Documents listed in the order they are to appear in results.\nRequired if `ids` is not specified.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:PinnedDoc" + } + } + }, + "minProperties": 1, + "maxProperties": 1 + } + ] + } + ] + }, + "_types.query_dsl:PinnedDoc": { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "_index": { + "$ref": "#/components/schemas/_types:IndexName" + } + }, + "required": [ + "_id", + "_index" + ] + }, + "_types.query_dsl:PrefixQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "rewrite": { + "$ref": "#/components/schemas/_types:MultiTermQueryRewrite" + }, + "value": { + "description": "Beginning characters of terms you wish to find in the provided field.", + "type": "string" + }, + "case_insensitive": { + "description": "Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.\nDefault is `false` which means the case sensitivity of matching depends on the underlying field’s mapping.", + "x-available-since": "7.10.0", + "type": "boolean" + } + }, + "required": [ + "value" + ] + } + ] + }, + "_types.query_dsl:QueryStringQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "allow_leading_wildcard": { + "description": "If `true`, the wildcard characters `*` and `?` are allowed as the first character of the query string.", + "type": "boolean" + }, + "analyzer": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html" + }, + "description": "Analyzer used to convert text in the query string into tokens.", + "type": "string" + }, + "analyze_wildcard": { + "description": "If `true`, the query attempts to analyze wildcard terms in the query string.", + "type": "boolean" + }, + "auto_generate_synonyms_phrase_query": { + "description": "If `true`, match phrase queries are automatically created for multi-term synonyms.", + "type": "boolean" + }, + "default_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "default_operator": { + "$ref": "#/components/schemas/_types.query_dsl:Operator" + }, + "enable_position_increments": { + "description": "If `true`, enable position increments in queries constructed from a `query_string` search.", + "type": "boolean" + }, + "escape": { + "type": "boolean" + }, + "fields": { + "description": "Array of fields to search. Supports wildcards (`*`).", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "fuzziness": { + "$ref": "#/components/schemas/_types:Fuzziness" + }, + "fuzzy_max_expansions": { + "description": "Maximum number of terms to which the query expands for fuzzy matching.", + "type": "number" + }, + "fuzzy_prefix_length": { + "description": "Number of beginning characters left unchanged for fuzzy matching.", + "type": "number" + }, + "fuzzy_rewrite": { + "$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`).", + "type": "boolean" + }, + "lenient": { + "description": "If `true`, format-based errors, such as providing a text value for a numeric field, are ignored.", + "type": "boolean" + }, + "max_determinized_states": { + "description": "Maximum number of automaton states required for the query.", + "type": "number" + }, + "minimum_should_match": { + "$ref": "#/components/schemas/_types:MinimumShouldMatch" + }, + "phrase_slop": { + "description": "Maximum number of positions allowed between matching tokens for phrases.", + "type": "number" + }, + "query": { + "description": "Query string you wish to parse and use for search.", + "type": "string" + }, + "quote_analyzer": { + "description": "Analyzer used to convert quoted text in the query string into tokens.\nFor quoted text, this parameter overrides the analyzer specified in the `analyzer` parameter.", + "type": "string" + }, + "quote_field_suffix": { + "description": "Suffix appended to quoted text in the query string.\nYou can use this suffix to use a different analysis method for exact matches.", + "type": "string" + }, + "rewrite": { + "$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" + }, + "type": { + "$ref": "#/components/schemas/_types.query_dsl:TextQueryType" + } + }, + "required": [ + "query" + ] + } + ] + }, + "_types:TimeZone": { + "type": "string" + }, + "_types.query_dsl:RangeQuery": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:UntypedRangeQuery" + }, + { + "$ref": "#/components/schemas/_types.query_dsl:DateRangeQuery" + }, + { + "$ref": "#/components/schemas/_types.query_dsl:NumberRangeQuery" + }, + { + "$ref": "#/components/schemas/_types.query_dsl:TermRangeQuery" + } + ] + }, + "_types.query_dsl:UntypedRangeQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:RangeQueryBase" + }, + { + "type": "object", + "properties": { + "format": { + "$ref": "#/components/schemas/_types:DateFormat" + }, + "time_zone": { + "$ref": "#/components/schemas/_types:TimeZone" + } + } + } + ] + }, + "_types:DateFormat": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html" + }, + "type": "string" + }, + "_types.query_dsl:RangeQueryBase": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "relation": { + "$ref": "#/components/schemas/_types.query_dsl:RangeRelation" + }, + "gt": { + "description": "Greater than.", + "type": "object" + }, + "gte": { + "description": "Greater than or equal to.", + "type": "object" + }, + "lt": { + "description": "Less than.", + "type": "object" + }, + "lte": { + "description": "Less than or equal to.", + "type": "object" + }, + "from": { + "oneOf": [ + { + "type": "object" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "to": { + "oneOf": [ + { + "type": "object" + }, + { + "nullable": true, + "type": "string" + } + ] + } + } + } + ] + }, + "_types.query_dsl:RangeRelation": { + "type": "string", + "enum": [ + "within", + "contains", + "intersects" + ] + }, + "_types.query_dsl:DateRangeQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:RangeQueryBaseDateMath" + }, + { + "type": "object", + "properties": { + "format": { + "$ref": "#/components/schemas/_types:DateFormat" + }, + "time_zone": { + "$ref": "#/components/schemas/_types:TimeZone" + } + } + } + ] + }, + "_types.query_dsl:RangeQueryBaseDateMath": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "relation": { + "$ref": "#/components/schemas/_types.query_dsl:RangeRelation" + }, + "gt": { + "$ref": "#/components/schemas/_types:DateMath" + }, + "gte": { + "$ref": "#/components/schemas/_types:DateMath" + }, + "lt": { + "$ref": "#/components/schemas/_types:DateMath" + }, + "lte": { + "$ref": "#/components/schemas/_types:DateMath" + }, + "from": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types:DateMath" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "to": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types:DateMath" + }, + { + "nullable": true, + "type": "string" + } + ] + } + } + } + ] + }, + "_types.query_dsl:NumberRangeQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:RangeQueryBasedouble" + }, + { + "type": "object" + } + ] + }, + "_types.query_dsl:RangeQueryBasedouble": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "relation": { + "$ref": "#/components/schemas/_types.query_dsl:RangeRelation" + }, + "gt": { + "description": "Greater than.", + "type": "number" + }, + "gte": { + "description": "Greater than or equal to.", + "type": "number" + }, + "lt": { + "description": "Less than.", + "type": "number" + }, + "lte": { + "description": "Less than or equal to.", + "type": "number" + }, + "from": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "to": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + } + } + } + ] + }, + "_types.query_dsl:TermRangeQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:RangeQueryBasestring" + }, + { + "type": "object" + } + ] + }, + "_types.query_dsl:RangeQueryBasestring": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "relation": { + "$ref": "#/components/schemas/_types.query_dsl:RangeRelation" + }, + "gt": { + "description": "Greater than.", + "type": "string" + }, + "gte": { + "description": "Greater than or equal to.", + "type": "string" + }, + "lt": { + "description": "Less than.", + "type": "string" + }, + "lte": { + "description": "Less than or equal to.", + "type": "string" + }, + "from": { + "oneOf": [ + { + "type": "string" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "to": { + "oneOf": [ + { + "type": "string" + }, + { + "nullable": true, + "type": "string" + } + ] + } + } + } + ] + }, + "_types.query_dsl:RankFeatureQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "saturation": { + "$ref": "#/components/schemas/_types.query_dsl:RankFeatureFunctionSaturation" + }, + "log": { + "$ref": "#/components/schemas/_types.query_dsl:RankFeatureFunctionLogarithm" + }, + "linear": { + "$ref": "#/components/schemas/_types.query_dsl:RankFeatureFunctionLinear" + }, + "sigmoid": { + "$ref": "#/components/schemas/_types.query_dsl:RankFeatureFunctionSigmoid" + } + }, + "required": [ + "field" + ] + } + ] + }, + "_types.query_dsl:RankFeatureFunctionSaturation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:RankFeatureFunction" + }, + { + "type": "object", + "properties": { + "pivot": { + "description": "Configurable pivot value so that the result will be less than 0.5.", + "type": "number" + } + } + } + ] + }, + "_types.query_dsl:RankFeatureFunction": { + "type": "object" + }, + "_types.query_dsl:RankFeatureFunctionLogarithm": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:RankFeatureFunction" + }, + { + "type": "object", + "properties": { + "scaling_factor": { + "description": "Configurable scaling factor.", + "type": "number" + } + }, + "required": [ + "scaling_factor" + ] + } + ] + }, + "_types.query_dsl:RankFeatureFunctionLinear": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:RankFeatureFunction" + }, + { + "type": "object" + } + ] + }, + "_types.query_dsl:RankFeatureFunctionSigmoid": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:RankFeatureFunction" + }, + { + "type": "object", + "properties": { + "pivot": { + "description": "Configurable pivot value so that the result will be less than 0.5.", + "type": "number" + }, + "exponent": { + "description": "Configurable Exponent.", + "type": "number" + } + }, + "required": [ + "pivot", + "exponent" + ] + } + ] + }, + "_types.query_dsl:RegexpQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "case_insensitive": { + "description": "Allows case insensitive matching of the regular expression value with the indexed field values when set to `true`.\nWhen `false`, case sensitivity of matching depends on the underlying field’s mapping.", + "x-available-since": "7.10.0", + "type": "boolean" + }, + "flags": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/regexp-syntax.html" + }, + "description": "Enables optional operators for the regular expression.", + "type": "string" + }, + "max_determinized_states": { + "description": "Maximum number of automaton states required for the query.", + "type": "number" + }, + "rewrite": { + "$ref": "#/components/schemas/_types:MultiTermQueryRewrite" + }, + "value": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/regexp-syntax.html" + }, + "description": "Regular expression for terms you wish to find in the provided field.", + "type": "string" + } + }, + "required": [ + "value" + ] + } + ] + }, + "_types.query_dsl:RuleQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "organic": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "ruleset_ids": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Id" + } + }, + "match_criteria": { + "type": "object" + } + }, + "required": [ + "organic", + "ruleset_ids", + "match_criteria" + ] + } + ] + }, + "_types.query_dsl:ScriptQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "script": { + "$ref": "#/components/schemas/_types:Script" + } + }, + "required": [ + "script" + ] + } + ] + }, + "_types.query_dsl:ScriptScoreQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "min_score": { + "description": "Documents with a score lower than this floating point number are excluded from the search results.", + "type": "number" + }, + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "script": { + "$ref": "#/components/schemas/_types:Script" + } + }, + "required": [ + "query", + "script" + ] + } + ] + }, + "_types.query_dsl:SemanticQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "field": { + "description": "The field to query, which must be a semantic_text field type", + "type": "string" + }, + "query": { + "description": "The query text", + "type": "string" + } + }, + "required": [ + "field", + "query" + ] + } + ] + }, + "_types.query_dsl:ShapeQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "ignore_unmapped": { + "description": "When set to `true` the query ignores an unmapped field and will not match any documents.", + "type": "boolean" + } + } + } + ] + }, + "_types.query_dsl:SimpleQueryStringQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "analyzer": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html" + }, + "description": "Analyzer used to convert text in the query string into tokens.", + "type": "string" + }, + "analyze_wildcard": { + "description": "If `true`, the query attempts to analyze wildcard terms in the query string.", + "type": "boolean" + }, + "auto_generate_synonyms_phrase_query": { + "description": "If `true`, the parser creates a match_phrase query for each multi-position token.", + "type": "boolean" + }, + "default_operator": { + "$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 `*`.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "flags": { + "$ref": "#/components/schemas/_types.query_dsl:SimpleQueryStringFlags" + }, + "fuzzy_max_expansions": { + "description": "Maximum number of terms to which the query expands for fuzzy matching.", + "type": "number" + }, + "fuzzy_prefix_length": { + "description": "Number of beginning characters left unchanged for fuzzy matching.", + "type": "number" + }, + "fuzzy_transpositions": { + "description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).", + "type": "boolean" + }, + "lenient": { + "description": "If `true`, format-based errors, such as providing a text value for a numeric field, are ignored.", + "type": "boolean" + }, + "minimum_should_match": { + "$ref": "#/components/schemas/_types:MinimumShouldMatch" + }, + "query": { + "description": "Query string in the simple query string syntax you wish to parse and use for search.", + "type": "string" + }, + "quote_field_suffix": { + "description": "Suffix appended to quoted text in the query string.", + "type": "string" + } + }, + "required": [ + "query" + ] + } + ] + }, + "_types.query_dsl:SimpleQueryStringFlags": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html#supported-flags" + }, + "description": "Query flags can be either a single flag or a combination of flags, e.g. `OR|AND|PREFIX`", + "allOf": [ + { + "$ref": "#/components/schemas/_spec_utils:PipeSeparatedFlagsSimpleQueryStringFlag" + } + ] + }, + "_spec_utils:PipeSeparatedFlagsSimpleQueryStringFlag": { + "description": "A set of flags that can be represented as a single enum value or a set of values that are encoded\nas a pipe-separated string\n\nDepending on the target language, code generators can use this hint to generate language specific\nflags enum constructs and the corresponding (de-)serialization code.", + "oneOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:SimpleQueryStringFlag" + }, + { + "type": "string" + } + ] + }, + "_types.query_dsl:SimpleQueryStringFlag": { + "type": "string", + "enum": [ + "NONE", + "AND", + "NOT", + "OR", + "PREFIX", + "PHRASE", + "PRECEDENCE", + "ESCAPE", + "WHITESPACE", + "FUZZY", + "NEAR", + "SLOP", + "ALL" + ] + }, + "_types.query_dsl:SpanContainingQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "big": { + "$ref": "#/components/schemas/_types.query_dsl:SpanQuery" + }, + "little": { + "$ref": "#/components/schemas/_types.query_dsl:SpanQuery" + } + }, + "required": [ + "big", + "little" + ] + } + ] + }, + "_types.query_dsl:SpanQuery": { + "type": "object", + "properties": { + "span_containing": { + "$ref": "#/components/schemas/_types.query_dsl:SpanContainingQuery" + }, + "span_field_masking": { + "$ref": "#/components/schemas/_types.query_dsl:SpanFieldMaskingQuery" + }, + "span_first": { + "$ref": "#/components/schemas/_types.query_dsl:SpanFirstQuery" + }, + "span_gap": { + "$ref": "#/components/schemas/_types.query_dsl:SpanGapQuery" + }, + "span_multi": { + "$ref": "#/components/schemas/_types.query_dsl:SpanMultiTermQuery" + }, + "span_near": { + "$ref": "#/components/schemas/_types.query_dsl:SpanNearQuery" + }, + "span_not": { + "$ref": "#/components/schemas/_types.query_dsl:SpanNotQuery" + }, + "span_or": { + "$ref": "#/components/schemas/_types.query_dsl:SpanOrQuery" + }, + "span_term": { + "description": "The equivalent of the `term` query but for use with other span queries.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.query_dsl:SpanTermQuery" + }, + "minProperties": 1, + "maxProperties": 1 + }, + "span_within": { + "$ref": "#/components/schemas/_types.query_dsl:SpanWithinQuery" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "_types.query_dsl:SpanFieldMaskingQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "query": { + "$ref": "#/components/schemas/_types.query_dsl:SpanQuery" + } + }, + "required": [ + "field", + "query" + ] + } + ] + }, + "_types.query_dsl:SpanFirstQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "end": { + "description": "Controls the maximum end position permitted in a match.", + "type": "number" + }, + "match": { + "$ref": "#/components/schemas/_types.query_dsl:SpanQuery" + } + }, + "required": [ + "end", + "match" + ] + } + ] + }, + "_types.query_dsl:SpanGapQuery": { + "description": "Can only be used as a clause in a span_near query.", + "type": "object", + "additionalProperties": { + "type": "number" + }, + "minProperties": 1, + "maxProperties": 1 + }, + "_types.query_dsl:SpanMultiTermQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "match": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + } + }, + "required": [ + "match" + ] + } + ] + }, + "_types.query_dsl:SpanNearQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "clauses": { + "description": "Array of one or more other span type queries.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:SpanQuery" + } + }, + "in_order": { + "description": "Controls whether matches are required to be in-order.", + "type": "boolean" + }, + "slop": { + "description": "Controls the maximum number of intervening unmatched positions permitted.", + "type": "number" + } + }, + "required": [ + "clauses" + ] + } + ] + }, + "_types.query_dsl:SpanNotQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "dist": { + "description": "The number of tokens from within the include span that can’t have overlap with the exclude span.\nEquivalent to setting both `pre` and `post`.", + "type": "number" + }, + "exclude": { + "$ref": "#/components/schemas/_types.query_dsl:SpanQuery" + }, + "include": { + "$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.", + "type": "number" + }, + "pre": { + "description": "The number of tokens before the include span that can’t have overlap with the exclude span.", + "type": "number" + } + }, + "required": [ + "exclude", + "include" + ] + } + ] + }, + "_types.query_dsl:SpanOrQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "clauses": { + "description": "Array of one or more other span type queries.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:SpanQuery" + } + } + }, + "required": [ + "clauses" + ] + } + ] + }, + "_types.query_dsl:SpanTermQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "value": { + "type": "string" + } + }, + "required": [ + "value" + ] + } + ] + }, + "_types.query_dsl:SpanWithinQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "big": { + "$ref": "#/components/schemas/_types.query_dsl:SpanQuery" + }, + "little": { + "$ref": "#/components/schemas/_types.query_dsl:SpanQuery" + } + }, + "required": [ + "big", + "little" + ] + } + ] + }, + "_types.query_dsl:SparseVectorQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "allOf": [ + { + "type": "object", + "properties": { + "field": { + "$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.", + "type": "string" + }, + "prune": { + "description": "Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance.\nIf prune is true but the pruning_config is not specified, pruning will occur but default values will be used.\nDefault: false", + "x-technical-preview": true, + "x-available-since": "8.15.0", + "type": "boolean" + }, + "pruning_config": { + "$ref": "#/components/schemas/_types.query_dsl:TokenPruningConfig" + } + }, + "required": [ + "field" + ] + }, + { + "type": "object", + "properties": { + "query_vector": { + "description": "Dictionary of precomputed sparse vectors and their associated weights.\nOnly one of inference_id or query_vector may be supplied in a request.", + "type": "object", + "additionalProperties": { + "type": "number" + } + }, + "inference_id": { + "$ref": "#/components/schemas/_types:Id" + } + }, + "minProperties": 1, + "maxProperties": 1 + } + ] + } + ] + }, + "_types.query_dsl:TokenPruningConfig": { + "type": "object", + "properties": { + "tokens_freq_ratio_threshold": { + "description": "Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned.", + "type": "number" + }, + "tokens_weight_threshold": { + "description": "Tokens whose weight is less than this threshold are considered nonsignificant and pruned.", + "type": "number" + }, + "only_score_pruned_tokens": { + "description": "Whether to only score pruned tokens, vs only scoring kept tokens.", + "type": "boolean" + } + } + }, + "_types.query_dsl:TermQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "value": { + "$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.", + "x-available-since": "7.10.0", + "type": "boolean" + } + }, + "required": [ + "value" + ] + } + ] + }, + "_types.query_dsl:TermsQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object" + } + ] + }, + "_types.query_dsl:TermsSetQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "minimum_should_match_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "minimum_should_match_script": { + "$ref": "#/components/schemas/_types:Script" + }, + "terms": { + "description": "Array of terms you wish to find in the provided field.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "terms" + ] + } + ] + }, + "_types.query_dsl:TextExpansionQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "model_id": { + "description": "The text expansion NLP model to use", + "type": "string" + }, + "model_text": { + "description": "The query text", + "type": "string" + }, + "pruning_config": { + "$ref": "#/components/schemas/_types.query_dsl:TokenPruningConfig" + } + }, + "required": [ + "model_id", + "model_text" + ] + } + ] + }, + "_types.query_dsl:WeightedTokensQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "tokens": { + "description": "The tokens representing this query", + "type": "object", + "additionalProperties": { + "type": "number" + } + }, + "pruning_config": { + "$ref": "#/components/schemas/_types.query_dsl:TokenPruningConfig" + } + }, + "required": [ + "tokens" + ] + } + ] + }, + "_types.query_dsl:WildcardQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "case_insensitive": { + "description": "Allows case insensitive matching of the pattern with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field’s mapping.", + "x-available-since": "7.10.0", + "type": "boolean" + }, + "rewrite": { + "$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.", + "type": "string" + }, + "wildcard": { + "description": "Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set.", + "type": "string" + } + } + } + ] + }, + "_types.query_dsl:WrapperQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "query": { + "description": "A base64 encoded query.\nThe binary data format can be any of JSON, YAML, CBOR or SMILE encodings", + "type": "string" + } + }, + "required": [ + "query" + ] + } + ] + }, + "_types.query_dsl:TypeQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryBase" + }, + { + "type": "object", + "properties": { + "value": { + "type": "string" + } + }, + "required": [ + "value" + ] + } + ] + }, + "_types.aggregations:BucketAggregationBase": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:Aggregation" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:Aggregation": { + "type": "object" + }, + "_types.aggregations:AutoDateHistogramAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "buckets": { + "description": "The target number of buckets.", + "type": "number" + }, + "field": { + "$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" + }, + "missing": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "offset": { + "description": "Time zone specified as a ISO 8601 UTC offset.", + "type": "string" + }, + "params": { + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "script": { + "$ref": "#/components/schemas/_types:Script" + }, + "time_zone": { + "$ref": "#/components/schemas/_types:TimeZone" + } + } + } + ] + }, + "_types.aggregations:MinimumInterval": { + "type": "string", + "enum": [ + "second", + "minute", + "hour", + "day", + "month", + "year" + ] + }, + "_types.aggregations:AverageAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:FormatMetricAggregationBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:FormatMetricAggregationBase": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MetricAggregationBase" + }, + { + "type": "object", + "properties": { + "format": { + "type": "string" + } + } + } + ] + }, + "_types.aggregations:MetricAggregationBase": { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "missing": { + "$ref": "#/components/schemas/_types.aggregations:Missing" + }, + "script": { + "$ref": "#/components/schemas/_types:Script" + } + } + }, + "_types.aggregations:Missing": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + }, + "_types.aggregations:AverageBucketAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:PipelineAggregationBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:PipelineAggregationBase": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketPathAggregation" + }, + { + "type": "object", + "properties": { + "format": { + "description": "`DecimalFormat` pattern for the output value.\nIf specified, the formatted value is returned in the aggregation’s `value_as_string` property.", + "type": "string" + }, + "gap_policy": { + "$ref": "#/components/schemas/_types.aggregations:GapPolicy" + } + } + } + ] + }, + "_types.aggregations:GapPolicy": { + "type": "string", + "enum": [ + "skip", + "insert_zeros", + "keep_values" + ] + }, + "_types.aggregations:BucketPathAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:Aggregation" + }, + { + "type": "object", + "properties": { + "buckets_path": { + "$ref": "#/components/schemas/_types.aggregations:BucketsPath" + } + } + } + ] + }, + "_types.aggregations:BucketsPath": { + "description": "Buckets path can be expressed in different ways, and an aggregation may accept some or all of these\nforms depending on its type. Please refer to each aggregation's documentation to know what buckets\npath forms they accept.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + ] + }, + "_types.aggregations:BoxplotAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MetricAggregationBase" + }, + { + "type": "object", + "properties": { + "compression": { + "description": "Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error.", + "type": "number" + } + } + } + ] + }, + "_types.aggregations:BucketScriptAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:PipelineAggregationBase" + }, + { + "type": "object", + "properties": { + "script": { + "$ref": "#/components/schemas/_types:Script" + } + } + } + ] + }, + "_types.aggregations:BucketSelectorAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:PipelineAggregationBase" + }, + { + "type": "object", + "properties": { + "script": { + "$ref": "#/components/schemas/_types:Script" + } + } + } + ] + }, + "_types.aggregations:BucketSortAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:Aggregation" + }, + { + "type": "object", + "properties": { + "from": { + "description": "Buckets in positions prior to `from` will be truncated.", + "type": "number" + }, + "gap_policy": { + "$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" + } + } + } + ] + }, + "_types.aggregations:BucketKsAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketPathAggregation" + }, + { + "type": "object", + "properties": { + "alternative": { + "description": "A list of string values indicating which K-S test alternative to calculate. The valid values\nare: \"greater\", \"less\", \"two_sided\". This parameter is key for determining the K-S statistic used\nwhen calculating the K-S test. Default value is all possible alternative hypotheses.", + "type": "array", + "items": { + "type": "string" + } + }, + "fractions": { + "description": "A list of doubles indicating the distribution of the samples with which to compare to the `buckets_path` results.\nIn typical usage this is the overall proportion of documents in each bucket, which is compared with the actual\ndocument proportions in each bucket from the sibling aggregation counts. The default is to assume that overall\ndocuments are uniformly distributed on these buckets, which they would be if one used equal percentiles of a\nmetric to define the bucket end points.", + "type": "array", + "items": { + "type": "number" + } + }, + "sampling_method": { + "description": "Indicates the sampling methodology when calculating the K-S test. Note, this is sampling of the returned values.\nThis determines the cumulative distribution function (CDF) points used comparing the two samples. Default is\n`upper_tail`, which emphasizes the upper end of the CDF points. Valid options are: `upper_tail`, `uniform`,\nand `lower_tail`.", + "type": "string" + } + } + } + ] + }, + "_types.aggregations:BucketCorrelationAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketPathAggregation" + }, + { + "type": "object", + "properties": { + "function": { + "$ref": "#/components/schemas/_types.aggregations:BucketCorrelationFunction" + } + }, + "required": [ + "function" + ] + } + ] + }, + "_types.aggregations:BucketCorrelationFunction": { + "type": "object", + "properties": { + "count_correlation": { + "$ref": "#/components/schemas/_types.aggregations:BucketCorrelationFunctionCountCorrelation" + } + }, + "required": [ + "count_correlation" + ] + }, + "_types.aggregations:BucketCorrelationFunctionCountCorrelation": { + "type": "object", + "properties": { + "indicator": { + "$ref": "#/components/schemas/_types.aggregations:BucketCorrelationFunctionCountCorrelationIndicator" + } + }, + "required": [ + "indicator" + ] + }, + "_types.aggregations:BucketCorrelationFunctionCountCorrelationIndicator": { + "type": "object", + "properties": { + "doc_count": { + "description": "The total number of documents that initially created the expectations. It’s required to be greater\nthan or equal to the sum of all values in the buckets_path as this is the originating superset of data\nto which the term values are correlated.", + "type": "number" + }, + "expectations": { + "description": "An array of numbers with which to correlate the configured `bucket_path` values.\nThe length of this value must always equal the number of buckets returned by the `bucket_path`.", + "type": "array", + "items": { + "type": "number" + } + }, + "fractions": { + "description": "An array of fractions to use when averaging and calculating variance. This should be used if\nthe pre-calculated data and the buckets_path have known gaps. The length of fractions, if provided,\nmust equal expectations.", + "type": "array", + "items": { + "type": "number" + } + } + }, + "required": [ + "doc_count", + "expectations" + ] + }, + "_types.aggregations:CardinalityAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MetricAggregationBase" + }, + { + "type": "object", + "properties": { + "precision_threshold": { + "description": "A unique count below which counts are expected to be close to accurate.\nThis allows to trade memory for accuracy.", + "type": "number" + }, + "rehash": { + "type": "boolean" + }, + "execution_hint": { + "$ref": "#/components/schemas/_types.aggregations:CardinalityExecutionMode" + } + } + } + ] + }, + "_types.aggregations:CardinalityExecutionMode": { + "type": "string", + "enum": [ + "global_ordinals", + "segment_ordinals", + "direct", + "save_memory_heuristic", + "save_time_heuristic" + ] + }, + "_types.aggregations:CategorizeTextAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:Aggregation" + }, + { + "type": "object", + "properties": { + "field": { + "$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.", + "type": "number" + }, + "max_matched_tokens": { + "description": "The maximum number of token positions to match on before attempting to merge categories. Larger\nvalues will use more memory and create narrower categories. Max allowed value is 100.", + "type": "number" + }, + "similarity_threshold": { + "description": "The minimum percentage of tokens that must match for text to be added to the category bucket. Must\nbe between 1 and 100. The larger the value the narrower the categories. Larger values will increase memory\nusage and create narrower categories.", + "type": "number" + }, + "categorization_filters": { + "description": "This property expects an array of regular expressions. The expressions are used to filter out matching\nsequences from the categorization field values. You can use this functionality to fine tune the categorization\nby excluding sequences from consideration when categories are defined. For example, you can exclude SQL\nstatements that appear in your log files. This property cannot be used at the same time as categorization_analyzer.\nIf you only want to define simple regular expression filters that are applied prior to tokenization, setting\nthis property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering,\nuse the categorization_analyzer property instead and include the filters as pattern_replace character filters.", + "type": "array", + "items": { + "type": "string" + } + }, + "categorization_analyzer": { + "$ref": "#/components/schemas/_types.aggregations:CategorizeTextAnalyzer" + }, + "shard_size": { + "description": "The number of categorization buckets to return from each shard before merging all the results.", + "type": "number" + }, + "size": { + "description": "The number of buckets to return.", + "type": "number" + }, + "min_doc_count": { + "description": "The minimum number of documents in a bucket to be returned to the results.", + "type": "number" + }, + "shard_min_doc_count": { + "description": "The minimum number of documents in a bucket to be returned from the shard before merging.", + "type": "number" + } + }, + "required": [ + "field" + ] + } + ] + }, + "_types.aggregations:CategorizeTextAnalyzer": { + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/_types.aggregations:CustomCategorizeTextAnalyzer" + } + ] + }, + "_types.aggregations:CustomCategorizeTextAnalyzer": { + "type": "object", + "properties": { + "char_filter": { + "type": "array", + "items": { + "type": "string" + } + }, + "tokenizer": { + "type": "string" + }, + "filter": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "_types.aggregations:ChildrenAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/_types:RelationName" + } + } + } + ] + }, + "_types.aggregations:CompositeAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "after": { + "$ref": "#/components/schemas/_types.aggregations:CompositeAggregateKey" + }, + "size": { + "description": "The number of composite buckets that should be returned.", + "type": "number" + }, + "sources": { + "description": "The value sources used to build composite buckets.\nKeys are returned in the order of the `sources` definition.", + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:CompositeAggregationSource" + } + } + } + } + } + ] + }, + "_types.aggregations:CompositeAggregationSource": { + "type": "object", + "properties": { + "terms": { + "$ref": "#/components/schemas/_types.aggregations:CompositeTermsAggregation" + }, + "histogram": { + "$ref": "#/components/schemas/_types.aggregations:CompositeHistogramAggregation" + }, + "date_histogram": { + "$ref": "#/components/schemas/_types.aggregations:CompositeDateHistogramAggregation" + }, + "geotile_grid": { + "$ref": "#/components/schemas/_types.aggregations:CompositeGeoTileGridAggregation" + } + } + }, + "_types.aggregations:CompositeTermsAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:CompositeAggregationBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:CompositeAggregationBase": { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "missing_bucket": { + "type": "boolean" + }, + "missing_order": { + "$ref": "#/components/schemas/_types.aggregations:MissingOrder" + }, + "script": { + "$ref": "#/components/schemas/_types:Script" + }, + "value_type": { + "$ref": "#/components/schemas/_types.aggregations:ValueType" + }, + "order": { + "$ref": "#/components/schemas/_types:SortOrder" + } + } + }, + "_types.aggregations:MissingOrder": { + "type": "string", + "enum": [ + "first", + "last", + "default" + ] + }, + "_types.aggregations:ValueType": { + "type": "string", + "enum": [ + "string", + "long", + "double", + "number", + "date", + "date_nanos", + "ip", + "numeric", + "geo_point", + "boolean" + ] + }, + "_types.aggregations:CompositeHistogramAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:CompositeAggregationBase" + }, + { + "type": "object", + "properties": { + "interval": { + "type": "number" + } + }, + "required": [ + "interval" + ] + } + ] + }, + "_types.aggregations:CompositeDateHistogramAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:CompositeAggregationBase" + }, + { + "type": "object", + "properties": { + "format": { + "type": "string" + }, + "calendar_interval": { + "$ref": "#/components/schemas/_types:DurationLarge" + }, + "fixed_interval": { + "$ref": "#/components/schemas/_types:DurationLarge" + }, + "offset": { + "$ref": "#/components/schemas/_types:Duration" + }, + "time_zone": { + "$ref": "#/components/schemas/_types:TimeZone" + } + } + } + ] + }, + "_types.aggregations:CompositeGeoTileGridAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:CompositeAggregationBase" + }, + { + "type": "object", + "properties": { + "precision": { + "type": "number" + }, + "bounds": { + "$ref": "#/components/schemas/_types:GeoBounds" + } + } + } + ] + }, + "_types.aggregations:CumulativeCardinalityAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:PipelineAggregationBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:CumulativeSumAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:PipelineAggregationBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:DateHistogramAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "calendar_interval": { + "$ref": "#/components/schemas/_types.aggregations:CalendarInterval" + }, + "extended_bounds": { + "$ref": "#/components/schemas/_types.aggregations:ExtendedBoundsFieldDateMath" + }, + "hard_bounds": { + "$ref": "#/components/schemas/_types.aggregations:ExtendedBoundsFieldDateMath" + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "fixed_interval": { + "$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" + }, + "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" + }, + "offset": { + "$ref": "#/components/schemas/_types:Duration" + }, + "order": { + "$ref": "#/components/schemas/_types.aggregations:AggregateOrder" + }, + "params": { + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "script": { + "$ref": "#/components/schemas/_types:Script" + }, + "time_zone": { + "$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.", + "type": "boolean" + } + } + } + ] + }, + "_types.aggregations:CalendarInterval": { + "type": "string", + "enum": [ + "second", + "1s", + "minute", + "1m", + "hour", + "1h", + "day", + "1d", + "week", + "1w", + "month", + "1M", + "quarter", + "1q", + "year", + "1y" + ] + }, + "_types.aggregations:ExtendedBoundsFieldDateMath": { + "type": "object", + "properties": { + "max": { + "$ref": "#/components/schemas/_types.aggregations:FieldDateMath" + }, + "min": { + "$ref": "#/components/schemas/_types.aggregations:FieldDateMath" + } + } + }, + "_types.aggregations:FieldDateMath": { + "description": "A date range limit, represented either as a DateMath expression or a number expressed\naccording to the target field's precision.", + "oneOf": [ + { + "$ref": "#/components/schemas/_types:DateMath" + }, + { + "type": "number" + } + ] + }, + "_types.aggregations:AggregateOrder": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types:SortOrder" + }, + "minProperties": 1, + "maxProperties": 1 + }, + { + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types:SortOrder" + }, + "minProperties": 1, + "maxProperties": 1 + } + } + ] + }, + "_types.aggregations:DateRangeAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "field": { + "$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" + }, + "ranges": { + "description": "Array of date ranges.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:DateRangeExpression" + } + }, + "time_zone": { + "$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.", + "type": "boolean" + } + } + } + ] + }, + "_types.aggregations:DateRangeExpression": { + "type": "object", + "properties": { + "from": { + "$ref": "#/components/schemas/_types.aggregations:FieldDateMath" + }, + "key": { + "description": "Custom key to return the range with.", + "type": "string" + }, + "to": { + "$ref": "#/components/schemas/_types.aggregations:FieldDateMath" + } + } + }, + "_types.aggregations:DerivativeAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:PipelineAggregationBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:DiversifiedSamplerAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "execution_hint": { + "$ref": "#/components/schemas/_types.aggregations:SamplerAggregationExecutionHint" + }, + "max_docs_per_value": { + "description": "Limits how many documents are permitted per choice of de-duplicating value.", + "type": "number" + }, + "script": { + "$ref": "#/components/schemas/_types:Script" + }, + "shard_size": { + "description": "Limits how many top-scoring documents are collected in the sample processed on each shard.", + "type": "number" + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + } + } + } + ] + }, + "_types.aggregations:SamplerAggregationExecutionHint": { + "type": "string", + "enum": [ + "map", + "global_ordinals", + "bytes_hash" + ] + }, + "_types.aggregations:ExtendedStatsAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:FormatMetricAggregationBase" + }, + { + "type": "object", + "properties": { + "sigma": { + "description": "The number of standard deviations above/below the mean to display.", + "type": "number" + } + } + } + ] + }, + "_types.aggregations:ExtendedStatsBucketAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:PipelineAggregationBase" + }, + { + "type": "object", + "properties": { + "sigma": { + "description": "The number of standard deviations above/below the mean to display.", + "type": "number" + } + } + } + ] + }, + "_types.aggregations:FrequentItemSetsAggregation": { + "type": "object", + "properties": { + "fields": { + "description": "Fields to analyze.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:FrequentItemSetsField" + } + }, + "minimum_set_size": { + "description": "The minimum size of one item set.", + "type": "number" + }, + "minimum_support": { + "description": "The minimum support of one item set.", + "type": "number" + }, + "size": { + "description": "The number of top item sets to return.", + "type": "number" + }, + "filter": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + } + }, + "required": [ + "fields" + ] + }, + "_types.aggregations:FrequentItemSetsField": { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "exclude": { + "$ref": "#/components/schemas/_types.aggregations:TermsExclude" + }, + "include": { + "$ref": "#/components/schemas/_types.aggregations:TermsInclude" + } + }, + "required": [ + "field" + ] + }, + "_types.aggregations:TermsExclude": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "_types.aggregations:TermsInclude": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "#/components/schemas/_types.aggregations:TermsPartition" + } + ] + }, + "_types.aggregations:TermsPartition": { + "type": "object", + "properties": { + "num_partitions": { + "description": "The number of partitions.", + "type": "number" + }, + "partition": { + "description": "The partition number for this request.", + "type": "number" + } + }, + "required": [ + "num_partitions", + "partition" + ] + }, + "_types.aggregations:FiltersAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "filters": { + "$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.", + "type": "boolean" + }, + "other_bucket_key": { + "description": "The key with which the other bucket is returned.", + "type": "string" + }, + "keyed": { + "description": "By default, the named filters aggregation returns the buckets as an object.\nSet to `false` to return the buckets as an array of objects.", + "type": "boolean" + } + } + } + ] + }, + "_types.aggregations:BucketsQueryContainer": { + "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.", + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + } + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + } + } + ] + }, + "_types.aggregations:GeoBoundsAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MetricAggregationBase" + }, + { + "type": "object", + "properties": { + "wrap_longitude": { + "description": "Specifies whether the bounding box should be allowed to overlap the international date line.", + "type": "boolean" + } + } + } + ] + }, + "_types.aggregations:GeoCentroidAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MetricAggregationBase" + }, + { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "location": { + "$ref": "#/components/schemas/_types:GeoLocation" + } + } + } + ] + }, + "_types.aggregations:GeoDistanceAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "distance_type": { + "$ref": "#/components/schemas/_types:GeoDistanceType" + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "origin": { + "$ref": "#/components/schemas/_types:GeoLocation" + }, + "ranges": { + "description": "An array of ranges used to bucket documents.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:AggregationRange" + } + }, + "unit": { + "$ref": "#/components/schemas/_types:DistanceUnit" + } + } + } + ] + }, + "_types.aggregations:AggregationRange": { + "type": "object", + "properties": { + "from": { + "description": "Start of the range (inclusive).", + "type": "number" + }, + "key": { + "description": "Custom key to return the range with.", + "type": "string" + }, + "to": { + "description": "End of the range (exclusive).", + "type": "number" + } + } + }, + "_types.aggregations:GeoHashGridAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "bounds": { + "$ref": "#/components/schemas/_types:GeoBounds" + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "precision": { + "$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.", + "type": "number" + }, + "size": { + "description": "The maximum number of geohash buckets to return.", + "type": "number" + } + } + } + ] + }, + "_types:GeoHashPrecision": { + "description": "A precision that can be expressed as a geohash length between 1 and 12, or a distance measure like \"1km\", \"10m\".", + "oneOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "_types.aggregations:GeoLineAggregation": { + "type": "object", + "properties": { + "point": { + "$ref": "#/components/schemas/_types.aggregations:GeoLinePoint" + }, + "sort": { + "$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" + }, + "size": { + "description": "The maximum length of the line represented in the aggregation.\nValid sizes are between 1 and 10000.", + "type": "number" + } + }, + "required": [ + "point", + "sort" + ] + }, + "_types.aggregations:GeoLinePoint": { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "field" + ] + }, + "_types.aggregations:GeoLineSort": { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "field" + ] + }, + "_types.aggregations:GeoTileGridAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "precision": { + "$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.", + "type": "number" + }, + "size": { + "description": "The maximum number of buckets to return.", + "type": "number" + }, + "bounds": { + "$ref": "#/components/schemas/_types:GeoBounds" + } + } + } + ] + }, + "_types:GeoTilePrecision": { + "type": "number" + }, + "_types.aggregations:GeohexGridAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "field": { + "$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.", + "type": "number" + }, + "bounds": { + "$ref": "#/components/schemas/_types:GeoBounds" + }, + "size": { + "description": "Maximum number of buckets to return.", + "type": "number" + }, + "shard_size": { + "description": "Number of buckets returned from each shard.", + "type": "number" + } + }, + "required": [ + "field" + ] + } + ] + }, + "_types.aggregations:GlobalAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:HistogramAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "extended_bounds": { + "$ref": "#/components/schemas/_types.aggregations:ExtendedBoundsdouble" + }, + "hard_bounds": { + "$ref": "#/components/schemas/_types.aggregations:ExtendedBoundsdouble" + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "interval": { + "description": "The interval for the buckets.\nMust be a positive decimal.", + "type": "number" + }, + "min_doc_count": { + "description": "Only returns buckets that have `min_doc_count` number of documents.\nBy default, the response will fill gaps in the histogram with empty buckets.", + "type": "number" + }, + "missing": { + "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", + "type": "number" + }, + "offset": { + "description": "By default, the bucket keys start with 0 and then continue in even spaced steps of `interval`.\nThe bucket boundaries can be shifted by using the `offset` option.", + "type": "number" + }, + "order": { + "$ref": "#/components/schemas/_types.aggregations:AggregateOrder" + }, + "script": { + "$ref": "#/components/schemas/_types:Script" + }, + "format": { + "type": "string" + }, + "keyed": { + "description": "If `true`, returns buckets as a hash instead of an array, keyed by the bucket keys.", + "type": "boolean" + } + } + } + ] + }, + "_types.aggregations:ExtendedBoundsdouble": { + "type": "object", + "properties": { + "max": { + "description": "Maximum value for the bound.", + "type": "number" + }, + "min": { + "description": "Minimum value for the bound.", + "type": "number" + } + } + }, + "_types.aggregations:IpRangeAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "ranges": { + "description": "Array of IP ranges.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:IpRangeAggregationRange" + } + } + } + } + ] + }, + "_types.aggregations:IpRangeAggregationRange": { + "type": "object", + "properties": { + "from": { + "description": "Start of the range.", + "oneOf": [ + { + "type": "string" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "mask": { + "description": "IP range defined as a CIDR mask.", + "type": "string" + }, + "to": { + "description": "End of the range.", + "oneOf": [ + { + "type": "string" + }, + { + "nullable": true, + "type": "string" + } + ] + } + } + }, + "_types.aggregations:IpPrefixAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "field": { + "$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].", + "type": "number" + }, + "is_ipv6": { + "description": "Defines whether the prefix applies to IPv6 addresses.", + "type": "boolean" + }, + "append_prefix_length": { + "description": "Defines whether the prefix length is appended to IP address keys in the response.", + "type": "boolean" + }, + "keyed": { + "description": "Defines whether buckets are returned as a hash rather than an array in the response.", + "type": "boolean" + }, + "min_doc_count": { + "description": "Minimum number of documents in a bucket for it to be included in the response.", + "type": "number" + } + }, + "required": [ + "field", + "prefix_length" + ] + } + ] + }, + "_types.aggregations:InferenceAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:PipelineAggregationBase" + }, + { + "type": "object", + "properties": { + "model_id": { + "$ref": "#/components/schemas/_types:Name" + }, + "inference_config": { + "$ref": "#/components/schemas/_types.aggregations:InferenceConfigContainer" + } + }, + "required": [ + "model_id" + ] + } + ] + }, + "_types.aggregations:InferenceConfigContainer": { + "type": "object", + "properties": { + "regression": { + "$ref": "#/components/schemas/ml._types:RegressionInferenceOptions" + }, + "classification": { + "$ref": "#/components/schemas/ml._types:ClassificationInferenceOptions" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "ml._types:RegressionInferenceOptions": { + "type": "object", + "properties": { + "results_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "num_top_feature_importance_values": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/machine-learning/current/ml-feature-importance.html" + }, + "description": "Specifies the maximum number of feature importance values per document.", + "type": "number" + } + } + }, + "ml._types:ClassificationInferenceOptions": { + "type": "object", + "properties": { + "num_top_classes": { + "description": "Specifies the number of top class predictions to return. Defaults to 0.", + "type": "number" + }, + "num_top_feature_importance_values": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/machine-learning/current/ml-feature-importance.html" + }, + "description": "Specifies the maximum number of feature importance values per document.", + "type": "number" + }, + "prediction_field_type": { + "description": "Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false.", + "type": "string" + }, + "results_field": { + "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", + "type": "string" + }, + "top_classes_results_field": { + "description": "Specifies the field to which the top classes are written. Defaults to top_classes.", + "type": "string" + } + } + }, + "_types.aggregations:MatrixStatsAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MatrixAggregation" + }, + { + "type": "object", + "properties": { + "mode": { + "$ref": "#/components/schemas/_types:SortMode" + } + } + } + ] + }, + "_types.aggregations:MatrixAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:Aggregation" + }, + { + "type": "object", + "properties": { + "fields": { + "$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.", + "type": "object", + "additionalProperties": { + "type": "number" + } + } + } + } + ] + }, + "_types.aggregations:MaxAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:FormatMetricAggregationBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:MaxBucketAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:PipelineAggregationBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:MedianAbsoluteDeviationAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:FormatMetricAggregationBase" + }, + { + "type": "object", + "properties": { + "compression": { + "description": "Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error.", + "type": "number" + } + } + } + ] + }, + "_types.aggregations:MinAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:FormatMetricAggregationBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:MinBucketAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:PipelineAggregationBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:MissingAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "missing": { + "$ref": "#/components/schemas/_types.aggregations:Missing" + } + } + } + ] + }, + "_types.aggregations:MovingAverageAggregation": { + "discriminator": { + "propertyName": "model" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:LinearMovingAverageAggregation" + }, + { + "$ref": "#/components/schemas/_types.aggregations:SimpleMovingAverageAggregation" + }, + { + "$ref": "#/components/schemas/_types.aggregations:EwmaMovingAverageAggregation" + }, + { + "$ref": "#/components/schemas/_types.aggregations:HoltMovingAverageAggregation" + }, + { + "$ref": "#/components/schemas/_types.aggregations:HoltWintersMovingAverageAggregation" + } + ] + }, + "_types.aggregations:LinearMovingAverageAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MovingAverageAggregationBase" + }, + { + "type": "object", + "properties": { + "model": { + "type": "string", + "enum": [ + "linear" + ] + }, + "settings": { + "$ref": "#/components/schemas/_types:EmptyObject" + } + }, + "required": [ + "model", + "settings" + ] + } + ] + }, + "_types:EmptyObject": { + "type": "object" + }, + "_types.aggregations:MovingAverageAggregationBase": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:PipelineAggregationBase" + }, + { + "type": "object", + "properties": { + "minimize": { + "type": "boolean" + }, + "predict": { + "type": "number" + }, + "window": { + "type": "number" + } + } + } + ] + }, + "_types.aggregations:SimpleMovingAverageAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MovingAverageAggregationBase" + }, + { + "type": "object", + "properties": { + "model": { + "type": "string", + "enum": [ + "simple" + ] + }, + "settings": { + "$ref": "#/components/schemas/_types:EmptyObject" + } + }, + "required": [ + "model", + "settings" + ] + } + ] + }, + "_types.aggregations:EwmaMovingAverageAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MovingAverageAggregationBase" + }, + { + "type": "object", + "properties": { + "model": { + "type": "string", + "enum": [ + "ewma" + ] + }, + "settings": { + "$ref": "#/components/schemas/_types.aggregations:EwmaModelSettings" + } + }, + "required": [ + "model", + "settings" + ] + } + ] + }, + "_types.aggregations:EwmaModelSettings": { + "type": "object", + "properties": { + "alpha": { + "type": "number" + } + } + }, + "_types.aggregations:HoltMovingAverageAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MovingAverageAggregationBase" + }, + { + "type": "object", + "properties": { + "model": { + "type": "string", + "enum": [ + "holt" + ] + }, + "settings": { + "$ref": "#/components/schemas/_types.aggregations:HoltLinearModelSettings" + } + }, + "required": [ + "model", + "settings" + ] + } + ] + }, + "_types.aggregations:HoltLinearModelSettings": { + "type": "object", + "properties": { + "alpha": { + "type": "number" + }, + "beta": { + "type": "number" + } + } + }, + "_types.aggregations:HoltWintersMovingAverageAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MovingAverageAggregationBase" + }, + { + "type": "object", + "properties": { + "model": { + "type": "string", + "enum": [ + "holt_winters" + ] + }, + "settings": { + "$ref": "#/components/schemas/_types.aggregations:HoltWintersModelSettings" + } + }, + "required": [ + "model", + "settings" + ] + } + ] + }, + "_types.aggregations:HoltWintersModelSettings": { + "type": "object", + "properties": { + "alpha": { + "type": "number" + }, + "beta": { + "type": "number" + }, + "gamma": { + "type": "number" + }, + "pad": { + "type": "boolean" + }, + "period": { + "type": "number" + }, + "type": { + "$ref": "#/components/schemas/_types.aggregations:HoltWintersType" + } + } + }, + "_types.aggregations:HoltWintersType": { + "type": "string", + "enum": [ + "add", + "mult" + ] + }, + "_types.aggregations:MovingPercentilesAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:PipelineAggregationBase" + }, + { + "type": "object", + "properties": { + "window": { + "description": "The size of window to \"slide\" across the histogram.", + "type": "number" + }, + "shift": { + "description": "By default, the window consists of the last n values excluding the current bucket.\nIncreasing `shift` by 1, moves the starting window position by 1 to the right.", + "type": "number" + }, + "keyed": { + "type": "boolean" + } + } + } + ] + }, + "_types.aggregations:MovingFunctionAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:PipelineAggregationBase" + }, + { + "type": "object", + "properties": { + "script": { + "description": "The script that should be executed on each window of data.", + "type": "string" + }, + "shift": { + "description": "By default, the window consists of the last n values excluding the current bucket.\nIncreasing `shift` by 1, moves the starting window position by 1 to the right.", + "type": "number" + }, + "window": { + "description": "The size of window to \"slide\" across the histogram.", + "type": "number" + } + } + } + ] + }, + "_types.aggregations:MultiTermsAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "collect_mode": { + "$ref": "#/components/schemas/_types.aggregations:TermsAggregationCollectMode" + }, + "order": { + "$ref": "#/components/schemas/_types.aggregations:AggregateOrder" + }, + "min_doc_count": { + "description": "The minimum number of documents in a bucket for it to be returned.", + "type": "number" + }, + "shard_min_doc_count": { + "description": "The minimum number of documents in a bucket on each shard for it to be returned.", + "type": "number" + }, + "shard_size": { + "description": "The number of candidate terms produced by each shard.\nBy default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter.", + "type": "number" + }, + "show_term_doc_count_error": { + "description": "Calculates the doc count error on per term basis.", + "type": "boolean" + }, + "size": { + "description": "The number of term buckets should be returned out of the overall terms list.", + "type": "number" + }, + "terms": { + "description": "The field from which to generate sets of terms.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:MultiTermLookup" + } + } + }, + "required": [ + "terms" + ] + } + ] + }, + "_types.aggregations:TermsAggregationCollectMode": { + "type": "string", + "enum": [ + "depth_first", + "breadth_first" + ] + }, + "_types.aggregations:MultiTermLookup": { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "missing": { + "$ref": "#/components/schemas/_types.aggregations:Missing" + } + }, + "required": [ + "field" + ] + }, + "_types.aggregations:NestedAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "path": { + "$ref": "#/components/schemas/_types:Field" + } + } + } + ] + }, + "_types.aggregations:NormalizeAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:PipelineAggregationBase" + }, + { + "type": "object", + "properties": { + "method": { + "$ref": "#/components/schemas/_types.aggregations:NormalizeMethod" + } + } + } + ] + }, + "_types.aggregations:NormalizeMethod": { + "type": "string", + "enum": [ + "rescale_0_1", + "rescale_0_100", + "percent_of_sum", + "mean", + "z-score", + "softmax" + ] + }, + "_types.aggregations:ParentAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/_types:RelationName" + } + } + } + ] + }, + "_types.aggregations:PercentileRanksAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:FormatMetricAggregationBase" + }, + { + "type": "object", + "properties": { + "keyed": { + "description": "By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array.\nSet to `false` to disable this behavior.", + "type": "boolean" + }, + "values": { + "description": "An array of values for which to calculate the percentile ranks.", + "oneOf": [ + { + "type": "array", + "items": { + "type": "number" + } + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "hdr": { + "$ref": "#/components/schemas/_types.aggregations:HdrMethod" + }, + "tdigest": { + "$ref": "#/components/schemas/_types.aggregations:TDigest" + } + } + } + ] + }, + "_types.aggregations:HdrMethod": { + "type": "object", + "properties": { + "number_of_significant_value_digits": { + "description": "Specifies the resolution of values for the histogram in number of significant digits.", + "type": "number" + } + } + }, + "_types.aggregations:TDigest": { + "type": "object", + "properties": { + "compression": { + "description": "Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error.", + "type": "number" + } + } + }, + "_types.aggregations:PercentilesAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:FormatMetricAggregationBase" + }, + { + "type": "object", + "properties": { + "keyed": { + "description": "By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array.\nSet to `false` to disable this behavior.", + "type": "boolean" + }, + "percents": { + "description": "The percentiles to calculate.", + "type": "array", + "items": { + "type": "number" + } + }, + "hdr": { + "$ref": "#/components/schemas/_types.aggregations:HdrMethod" + }, + "tdigest": { + "$ref": "#/components/schemas/_types.aggregations:TDigest" + } + } + } + ] + }, + "_types.aggregations:PercentilesBucketAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:PipelineAggregationBase" + }, + { + "type": "object", + "properties": { + "percents": { + "description": "The list of percentiles to calculate.", + "type": "array", + "items": { + "type": "number" + } + } + } + } + ] + }, + "_types.aggregations:RangeAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "field": { + "$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.", + "type": "number" + }, + "ranges": { + "description": "An array of ranges used to bucket documents.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:AggregationRange" + } + }, + "script": { + "$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.", + "type": "boolean" + }, + "format": { + "type": "string" + } + } + } + ] + }, + "_types.aggregations:RareTermsAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "exclude": { + "$ref": "#/components/schemas/_types.aggregations:TermsExclude" + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "include": { + "$ref": "#/components/schemas/_types.aggregations:TermsInclude" + }, + "max_doc_count": { + "description": "The maximum number of documents a term should appear in.", + "type": "number" + }, + "missing": { + "$ref": "#/components/schemas/_types.aggregations:Missing" + }, + "precision": { + "description": "The precision of the internal CuckooFilters.\nSmaller precision leads to better approximation, but higher memory usage.", + "type": "number" + }, + "value_type": { + "type": "string" + } + } + } + ] + }, + "_types.aggregations:RateAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:FormatMetricAggregationBase" + }, + { + "type": "object", + "properties": { + "unit": { + "$ref": "#/components/schemas/_types.aggregations:CalendarInterval" + }, + "mode": { + "$ref": "#/components/schemas/_types.aggregations:RateMode" + } + } + } + ] + }, + "_types.aggregations:RateMode": { + "type": "string", + "enum": [ + "sum", + "value_count" + ] + }, + "_types.aggregations:ReverseNestedAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "path": { + "$ref": "#/components/schemas/_types:Field" + } + } + } + ] + }, + "_types.aggregations:SamplerAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "shard_size": { + "description": "Limits how many top-scoring documents are collected in the sample processed on each shard.", + "type": "number" + } + } + } + ] + }, + "_types.aggregations:ScriptedMetricAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MetricAggregationBase" + }, + { + "type": "object", + "properties": { + "combine_script": { + "$ref": "#/components/schemas/_types:Script" + }, + "init_script": { + "$ref": "#/components/schemas/_types:Script" + }, + "map_script": { + "$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.", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "reduce_script": { + "$ref": "#/components/schemas/_types:Script" + } + } + } + ] + }, + "_types.aggregations:SerialDifferencingAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:PipelineAggregationBase" + }, + { + "type": "object", + "properties": { + "lag": { + "description": "The historical bucket to subtract from the current value.\nMust be a positive, non-zero integer.", + "type": "number" + } + } + } + ] + }, + "_types.aggregations:SignificantTermsAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "background_filter": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "chi_square": { + "$ref": "#/components/schemas/_types.aggregations:ChiSquareHeuristic" + }, + "exclude": { + "$ref": "#/components/schemas/_types.aggregations:TermsExclude" + }, + "execution_hint": { + "$ref": "#/components/schemas/_types.aggregations:TermsAggregationExecutionHint" + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "gnd": { + "$ref": "#/components/schemas/_types.aggregations:GoogleNormalizedDistanceHeuristic" + }, + "include": { + "$ref": "#/components/schemas/_types.aggregations:TermsInclude" + }, + "jlh": { + "$ref": "#/components/schemas/_types:EmptyObject" + }, + "min_doc_count": { + "description": "Only return terms that are found in more than `min_doc_count` hits.", + "type": "number" + }, + "mutual_information": { + "$ref": "#/components/schemas/_types.aggregations:MutualInformationHeuristic" + }, + "percentage": { + "$ref": "#/components/schemas/_types.aggregations:PercentageScoreHeuristic" + }, + "script_heuristic": { + "$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`.", + "type": "number" + }, + "shard_size": { + "description": "Can be used to control the volumes of candidate terms produced by each shard.\nBy default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter.", + "type": "number" + }, + "size": { + "description": "The number of buckets returned out of the overall terms list.", + "type": "number" + } + } + } + ] + }, + "_types.aggregations:ChiSquareHeuristic": { + "type": "object", + "properties": { + "background_is_superset": { + "description": "Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to.", + "type": "boolean" + }, + "include_negatives": { + "description": "Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset.", + "type": "boolean" + } + }, + "required": [ + "background_is_superset", + "include_negatives" + ] + }, + "_types.aggregations:TermsAggregationExecutionHint": { + "type": "string", + "enum": [ + "map", + "global_ordinals", + "global_ordinals_hash", + "global_ordinals_low_cardinality" + ] + }, + "_types.aggregations:GoogleNormalizedDistanceHeuristic": { + "type": "object", + "properties": { + "background_is_superset": { + "description": "Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to.", + "type": "boolean" + } + } + }, + "_types.aggregations:MutualInformationHeuristic": { + "type": "object", + "properties": { + "background_is_superset": { + "description": "Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to.", + "type": "boolean" + }, + "include_negatives": { + "description": "Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset.", + "type": "boolean" + } + } + }, + "_types.aggregations:PercentageScoreHeuristic": { + "type": "object" + }, + "_types.aggregations:ScriptedHeuristic": { + "type": "object", + "properties": { + "script": { + "$ref": "#/components/schemas/_types:Script" + } + }, + "required": [ + "script" + ] + }, + "_types.aggregations:SignificantTextAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "background_filter": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "chi_square": { + "$ref": "#/components/schemas/_types.aggregations:ChiSquareHeuristic" + }, + "exclude": { + "$ref": "#/components/schemas/_types.aggregations:TermsExclude" + }, + "execution_hint": { + "$ref": "#/components/schemas/_types.aggregations:TermsAggregationExecutionHint" + }, + "field": { + "$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" + }, + "include": { + "$ref": "#/components/schemas/_types.aggregations:TermsInclude" + }, + "jlh": { + "$ref": "#/components/schemas/_types:EmptyObject" + }, + "min_doc_count": { + "description": "Only return values that are found in more than `min_doc_count` hits.", + "type": "number" + }, + "mutual_information": { + "$ref": "#/components/schemas/_types.aggregations:MutualInformationHeuristic" + }, + "percentage": { + "$ref": "#/components/schemas/_types.aggregations:PercentageScoreHeuristic" + }, + "script_heuristic": { + "$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`.", + "type": "number" + }, + "shard_size": { + "description": "The number of candidate terms produced by each shard.\nBy default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter.", + "type": "number" + }, + "size": { + "description": "The number of buckets returned out of the overall terms list.", + "type": "number" + }, + "source_fields": { + "$ref": "#/components/schemas/_types:Fields" + } + } + } + ] + }, + "_types.aggregations:StatsAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:FormatMetricAggregationBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:StatsBucketAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:PipelineAggregationBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:StringStatsAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MetricAggregationBase" + }, + { + "type": "object", + "properties": { + "show_distribution": { + "description": "Shows the probability distribution for all characters.", + "type": "boolean" + } + } + } + ] + }, + "_types.aggregations:SumAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:FormatMetricAggregationBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:SumBucketAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:PipelineAggregationBase" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:TermsAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "collect_mode": { + "$ref": "#/components/schemas/_types.aggregations:TermsAggregationCollectMode" + }, + "exclude": { + "$ref": "#/components/schemas/_types.aggregations:TermsExclude" + }, + "execution_hint": { + "$ref": "#/components/schemas/_types.aggregations:TermsAggregationExecutionHint" + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "include": { + "$ref": "#/components/schemas/_types.aggregations:TermsInclude" + }, + "min_doc_count": { + "description": "Only return values that are found in more than `min_doc_count` hits.", + "type": "number" + }, + "missing": { + "$ref": "#/components/schemas/_types.aggregations:Missing" + }, + "missing_order": { + "$ref": "#/components/schemas/_types.aggregations:MissingOrder" + }, + "missing_bucket": { + "type": "boolean" + }, + "value_type": { + "description": "Coerced unmapped fields into the specified type.", + "type": "string" + }, + "order": { + "$ref": "#/components/schemas/_types.aggregations:AggregateOrder" + }, + "script": { + "$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`.", + "type": "number" + }, + "shard_size": { + "description": "The number of candidate terms produced by each shard.\nBy default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter.", + "type": "number" + }, + "show_term_doc_count_error": { + "description": "Set to `true` to return the `doc_count_error_upper_bound`, which is an upper bound to the error on the `doc_count` returned by each shard.", + "type": "boolean" + }, + "size": { + "description": "The number of buckets returned out of the overall terms list.", + "type": "number" + }, + "format": { + "type": "string" + } + } + } + ] + }, + "_types.aggregations:TopHitsAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MetricAggregationBase" + }, + { + "type": "object", + "properties": { + "docvalue_fields": { + "description": "Fields for which to return doc values.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:FieldAndFormat" + } + }, + "explain": { + "description": "If `true`, returns detailed information about score computation as part of a hit.", + "type": "boolean" + }, + "fields": { + "description": "Array of wildcard (*) patterns. The request returns values for field names\nmatching these patterns in the hits.fields property of the response.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:FieldAndFormat" + } + }, + "from": { + "description": "Starting document offset.", + "type": "number" + }, + "highlight": { + "$ref": "#/components/schemas/_global.search._types:Highlight" + }, + "script_fields": { + "description": "Returns the result of one or more script evaluations for each hit.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types:ScriptField" + } + }, + "size": { + "description": "The maximum number of top matching hits to return per bucket.", + "type": "number" + }, + "sort": { + "$ref": "#/components/schemas/_types:Sort" + }, + "_source": { + "$ref": "#/components/schemas/_global.search._types:SourceConfig" + }, + "stored_fields": { + "$ref": "#/components/schemas/_types:Fields" + }, + "track_scores": { + "description": "If `true`, calculates and returns document scores, even if the scores are not used for sorting.", + "type": "boolean" + }, + "version": { + "description": "If `true`, returns document version as part of a hit.", + "type": "boolean" + }, + "seq_no_primary_term": { + "description": "If `true`, returns sequence number and primary term of the last modification of each hit.", + "type": "boolean" + } + } + } + ] + }, + "_types.aggregations:TTestAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:Aggregation" + }, + { + "type": "object", + "properties": { + "a": { + "$ref": "#/components/schemas/_types.aggregations:TestPopulation" + }, + "b": { + "$ref": "#/components/schemas/_types.aggregations:TestPopulation" + }, + "type": { + "$ref": "#/components/schemas/_types.aggregations:TTestType" + } + } + } + ] + }, + "_types.aggregations:TestPopulation": { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "script": { + "$ref": "#/components/schemas/_types:Script" + }, + "filter": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + } + }, + "required": [ + "field" + ] + }, + "_types.aggregations:TTestType": { + "type": "string", + "enum": [ + "paired", + "homoscedastic", + "heteroscedastic" + ] + }, + "_types.aggregations:TopMetricsAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MetricAggregationBase" + }, + { + "type": "object", + "properties": { + "metrics": { + "description": "The fields of the top document to return.", + "oneOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:TopMetricsValue" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.aggregations:TopMetricsValue" + } + } + ] + }, + "size": { + "description": "The number of top documents from which to return metrics.", + "type": "number" + }, + "sort": { + "$ref": "#/components/schemas/_types:Sort" + } + } + } + ] + }, + "_types.aggregations:TopMetricsValue": { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "field" + ] + }, + "_types.aggregations:ValueCountAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:FormattableMetricAggregation" + }, + { + "type": "object" + } + ] + }, + "_types.aggregations:FormattableMetricAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:MetricAggregationBase" + }, + { + "type": "object", + "properties": { + "format": { + "type": "string" + } + } + } + ] + }, + "_types.aggregations:WeightedAverageAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:Aggregation" + }, + { + "type": "object", + "properties": { + "format": { + "description": "A numeric response formatter.", + "type": "string" + }, + "value": { + "$ref": "#/components/schemas/_types.aggregations:WeightedAverageValue" + }, + "value_type": { + "$ref": "#/components/schemas/_types.aggregations:ValueType" + }, + "weight": { + "$ref": "#/components/schemas/_types.aggregations:WeightedAverageValue" + } + } + } + ] + }, + "_types.aggregations:WeightedAverageValue": { + "type": "object", + "properties": { + "field": { + "$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" + } + } + }, + "_types.aggregations:VariableWidthHistogramAggregation": { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "buckets": { + "description": "The target number of buckets.", + "type": "number" + }, + "shard_size": { + "description": "The number of buckets that the coordinating node will request from each shard.\nDefaults to `buckets * 50`.", + "type": "number" + }, + "initial_buffer": { + "description": "Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run.\nDefaults to `min(10 * shard_size, 50000)`.", + "type": "number" + }, + "script": { + "$ref": "#/components/schemas/_types:Script" + } + } + }, + "_types:KnnSearch": { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "query_vector": { + "$ref": "#/components/schemas/_types:QueryVector" + }, + "query_vector_builder": { + "$ref": "#/components/schemas/_types:QueryVectorBuilder" + }, + "k": { + "description": "The final number of nearest neighbors to return as top hits", + "type": "number" + }, + "num_candidates": { + "description": "The number of nearest neighbor candidates to consider per shard", + "type": "number" + }, + "boost": { + "description": "Boost value to apply to kNN scores", + "type": "number" + }, + "filter": { + "description": "Filters for the kNN search query", + "oneOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + } + } + ] + }, + "similarity": { + "description": "The minimum similarity for a vector to be considered a match", + "type": "number" + }, + "inner_hits": { + "$ref": "#/components/schemas/_global.search._types:InnerHits" + } + }, + "required": [ + "field" + ] + }, + "_global.search._types:Rescore": { + "allOf": [ + { + "type": "object", + "properties": { + "window_size": { + "type": "number" + } + } + }, + { + "type": "object", + "properties": { + "query": { + "$ref": "#/components/schemas/_global.search._types:RescoreQuery" + }, + "learning_to_rank": { + "$ref": "#/components/schemas/_global.search._types:LearningToRank" + } + }, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "_global.search._types:RescoreQuery": { + "type": "object", + "properties": { + "rescore_query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "query_weight": { + "description": "Relative importance of the original query versus the rescore query.", + "type": "number" + }, + "rescore_query_weight": { + "description": "Relative importance of the rescore query versus the original query.", + "type": "number" + }, + "score_mode": { + "$ref": "#/components/schemas/_global.search._types:ScoreMode" + } + }, + "required": [ + "rescore_query" + ] + }, + "_global.search._types:ScoreMode": { + "type": "string", + "enum": [ + "avg", + "max", + "min", + "multiply", + "total" + ] + }, + "_global.search._types:LearningToRank": { + "type": "object", + "properties": { + "model_id": { + "description": "The unique identifier of the trained model uploaded to Elasticsearch", + "type": "string" + }, + "params": { + "description": "Named parameters to be passed to the query templates used for feature", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "required": [ + "model_id" + ] + }, + "_types:SlicedScroll": { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "max": { + "type": "number" + } + }, + "required": [ + "id", + "max" + ] + }, + "_global.search._types:Suggester": { + "type": "object", + "properties": { + "text": { + "description": "Global suggest text, to avoid repetition when the same text is used in several suggesters", + "type": "string" + } + } + }, + "_global.search._types:PointInTimeReference": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "keep_alive": { + "$ref": "#/components/schemas/_types:Duration" + } + }, + "required": [ + "id" + ] + }, + "_types.mapping:RuntimeFields": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.mapping:RuntimeField" + } + }, + "_types.mapping:RuntimeField": { + "type": "object", + "properties": { + "fetch_fields": { + "description": "For type `lookup`", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.mapping:RuntimeFieldFetchFields" + } + }, + "format": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html" + }, + "description": "A custom format for `date` type runtime fields.", + "type": "string" + }, + "input_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "target_index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "script": { + "$ref": "#/components/schemas/_types:Script" + }, + "type": { + "$ref": "#/components/schemas/_types.mapping:RuntimeFieldType" + } + }, + "required": [ + "type" + ] + }, + "_types.mapping:RuntimeFieldFetchFields": { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "format": { + "type": "string" + } + }, + "required": [ + "field" + ] + }, + "_types.mapping:RuntimeFieldType": { + "type": "string", + "enum": [ + "boolean", + "composite", + "date", + "double", + "geo_point", + "ip", + "keyword", + "long", + "lookup" + ] + }, + "_types:Refresh": { + "type": "string", + "enum": [ + "true", + "false", + "wait_for" + ] + }, + "_types:WaitForActiveShards": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "#/components/schemas/_types:WaitForActiveShardOptions" + } + ] + }, + "_types:WaitForActiveShardOptions": { + "type": "string", + "enum": [ + "all", + "index-setting" + ] + }, + "_global.bulk:OperationContainer": { + "type": "object", + "properties": { + "index": { + "$ref": "#/components/schemas/_global.bulk:IndexOperation" + }, + "create": { + "$ref": "#/components/schemas/_global.bulk:CreateOperation" + }, + "update": { + "$ref": "#/components/schemas/_global.bulk:UpdateOperation" + }, + "delete": { + "$ref": "#/components/schemas/_global.bulk:DeleteOperation" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "_global.bulk:IndexOperation": { + "allOf": [ + { + "$ref": "#/components/schemas/_global.bulk:WriteOperation" + }, + { + "type": "object" + } + ] + }, + "_global.bulk:WriteOperation": { + "allOf": [ + { + "$ref": "#/components/schemas/_global.bulk:OperationBase" + }, + { + "type": "object", + "properties": { + "dynamic_templates": { + "description": "A map from the full name of fields to the name of dynamic templates.\nDefaults to an empty map.\nIf a name matches a dynamic template, then that template will be applied regardless of other match predicates defined in the template.\nIf a field is already defined in the mapping, then this parameter won’t be used.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "pipeline": { + "description": "ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.", + "type": "string" + }, + "require_alias": { + "description": "If `true`, the request’s actions must target an index alias.", + "type": "boolean" + } + } + } + ] + }, + "_global.bulk:OperationBase": { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "_index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "routing": { + "$ref": "#/components/schemas/_types:Routing" + }, + "if_primary_term": { + "type": "number" + }, + "if_seq_no": { + "$ref": "#/components/schemas/_types:SequenceNumber" + }, + "version": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "version_type": { + "$ref": "#/components/schemas/_types:VersionType" + } + } + }, + "_global.bulk:CreateOperation": { + "allOf": [ + { + "$ref": "#/components/schemas/_global.bulk:WriteOperation" + }, + { + "type": "object" + } + ] + }, + "_global.bulk:UpdateOperation": { + "allOf": [ + { + "$ref": "#/components/schemas/_global.bulk:OperationBase" + }, + { + "type": "object", + "properties": { + "require_alias": { + "description": "If `true`, the request’s actions must target an index alias.", + "type": "boolean" + }, + "retry_on_conflict": { + "type": "number" + } + } + } + ] + }, + "_global.bulk:DeleteOperation": { + "allOf": [ + { + "$ref": "#/components/schemas/_global.bulk:OperationBase" + }, + { + "type": "object" + } + ] + }, + "_global.bulk:UpdateAction": { + "type": "object", + "properties": { + "detect_noop": { + "description": "Set to false to disable setting 'result' in the response\nto 'noop' if no change to the document occurred.", + "type": "boolean" + }, + "doc": { + "description": "A partial update to an existing document.", + "type": "object" + }, + "doc_as_upsert": { + "description": "Set to true to use the contents of 'doc' as the value of 'upsert'", + "type": "boolean" + }, + "script": { + "$ref": "#/components/schemas/_types:Script" + }, + "scripted_upsert": { + "description": "Set to true to execute the script whether or not the document exists.", + "type": "boolean" + }, + "_source": { + "$ref": "#/components/schemas/_global.search._types:SourceConfig" + }, + "upsert": { + "description": "If the document does not already exist, the contents of 'upsert' are inserted as a\nnew document. If the document exists, the 'script' is executed.", + "type": "object" + } + } + }, + "_global.bulk:ResponseItem": { + "type": "object", + "properties": { + "_id": { + "description": "The document ID associated with the operation.", + "oneOf": [ + { + "type": "string" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "_index": { + "description": "Name of the index associated with the operation.\nIf the operation targeted a data stream, this is the backing index into which the document was written.", + "type": "string" + }, + "status": { + "description": "HTTP status code returned for the operation.", + "type": "number" + }, + "error": { + "$ref": "#/components/schemas/_types:ErrorCause" + }, + "_primary_term": { + "description": "The primary term assigned to the document for the operation.", + "type": "number" + }, + "result": { + "description": "Result of the operation.\nSuccessful values are `created`, `deleted`, and `updated`.", + "type": "string" + }, + "_seq_no": { + "$ref": "#/components/schemas/_types:SequenceNumber" + }, + "_shards": { + "$ref": "#/components/schemas/_types:ShardStatistics" + }, + "_version": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "forced_refresh": { + "type": "boolean" + }, + "get": { + "$ref": "#/components/schemas/_types:InlineGetDictUserDefined" + } + }, + "required": [ + "_index", + "status" + ] + }, + "_types:InlineGetDictUserDefined": { + "type": "object", + "properties": { + "fields": { + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "found": { + "type": "boolean" + }, + "_seq_no": { + "$ref": "#/components/schemas/_types:SequenceNumber" + }, + "_primary_term": { + "type": "number" + }, + "_routing": { + "$ref": "#/components/schemas/_types:Routing" + }, + "_source": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "required": [ + "found" + ] + }, + "_types:Names": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types:Name" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Name" + } + } + ] + }, + "cat.aliases:AliasesRecord": { + "type": "object", + "properties": { + "alias": { + "description": "alias name", + "type": "string" + }, + "index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "filter": { + "description": "filter", + "type": "string" + }, + "routing.index": { + "description": "index routing", + "type": "string" + }, + "routing.search": { + "description": "search routing", + "type": "string" + }, + "is_write_index": { + "description": "write index", + "type": "string" + } + } + }, + "cat.component_templates:ComponentTemplate": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + }, + "alias_count": { + "type": "string" + }, + "mapping_count": { + "type": "string" + }, + "settings_count": { + "type": "string" + }, + "metadata_count": { + "type": "string" + }, + "included_in": { + "type": "string" + } + }, + "required": [ + "name", + "version", + "alias_count", + "mapping_count", + "settings_count", + "metadata_count", + "included_in" + ] + }, + "cat.count:CountRecord": { + "type": "object", + "properties": { + "epoch": { + "$ref": "#/components/schemas/_spec_utils:StringifiedEpochTimeUnitSeconds" + }, + "timestamp": { + "$ref": "#/components/schemas/_types:TimeOfDay" + }, + "count": { + "description": "the document count", + "type": "string" + } + } + }, + "_spec_utils:StringifiedEpochTimeUnitSeconds": { + "description": "Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior\nis used to capture this behavior while keeping the semantics of the field type.\n\nDepending on the target language, code generators can keep the union or remove it and leniently parse\nstrings to the target type.", + "oneOf": [ + { + "$ref": "#/components/schemas/_types:EpochTimeUnitSeconds" + }, + { + "type": "string" + } + ] + }, + "_types:EpochTimeUnitSeconds": { + "allOf": [ + { + "$ref": "#/components/schemas/_types:UnitSeconds" + } + ] + }, + "_types:UnitSeconds": { + "description": "Time unit for seconds", + "type": "number" + }, + "_types:TimeOfDay": { + "description": "Time of day, expressed as HH:MM:SS", + "type": "string" + }, + "cat.help:HelpRecord": { + "type": "object", + "properties": { + "endpoint": { + "type": "string" + } + }, + "required": [ + "endpoint" + ] + }, + "_types:Bytes": { + "type": "string", + "enum": [ + "b", + "kb", + "mb", + "gb", + "tb", + "pb" + ] + }, + "_types:HealthStatus": { + "type": "string", + "enum": [ + "green", + "GREEN", + "yellow", + "YELLOW", + "red", + "RED" + ] + }, + "_types:TimeUnit": { + "type": "string", + "enum": [ + "nanos", + "micros", + "ms", + "s", + "m", + "h", + "d" + ] + }, + "cat.indices:IndicesRecord": { + "type": "object", + "properties": { + "health": { + "description": "current health status", + "type": "string" + }, + "status": { + "description": "open/close status", + "type": "string" + }, + "index": { + "description": "index name", + "type": "string" + }, + "uuid": { + "description": "index uuid", + "type": "string" + }, + "pri": { + "description": "number of primary shards", + "type": "string" + }, + "rep": { + "description": "number of replica shards", + "type": "string" + }, + "docs.count": { + "description": "available docs", + "oneOf": [ + { + "type": "string" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "docs.deleted": { + "description": "deleted docs", + "oneOf": [ + { + "type": "string" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "creation.date": { + "description": "index creation date (millisecond value)", + "type": "string" + }, + "creation.date.string": { + "description": "index creation date (as string)", + "type": "string" + }, + "store.size": { + "description": "store size of primaries & replicas", + "oneOf": [ + { + "type": "string" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "pri.store.size": { + "description": "store size of primaries", + "oneOf": [ + { + "type": "string" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "completion.size": { + "description": "size of completion", + "type": "string" + }, + "pri.completion.size": { + "description": "size of completion", + "type": "string" + }, + "fielddata.memory_size": { + "description": "used fielddata cache", + "type": "string" + }, + "pri.fielddata.memory_size": { + "description": "used fielddata cache", + "type": "string" + }, + "fielddata.evictions": { + "description": "fielddata evictions", + "type": "string" + }, + "pri.fielddata.evictions": { + "description": "fielddata evictions", + "type": "string" + }, + "query_cache.memory_size": { + "description": "used query cache", + "type": "string" + }, + "pri.query_cache.memory_size": { + "description": "used query cache", + "type": "string" + }, + "query_cache.evictions": { + "description": "query cache evictions", + "type": "string" + }, + "pri.query_cache.evictions": { + "description": "query cache evictions", + "type": "string" + }, + "request_cache.memory_size": { + "description": "used request cache", + "type": "string" + }, + "pri.request_cache.memory_size": { + "description": "used request cache", + "type": "string" + }, + "request_cache.evictions": { + "description": "request cache evictions", + "type": "string" + }, + "pri.request_cache.evictions": { + "description": "request cache evictions", + "type": "string" + }, + "request_cache.hit_count": { + "description": "request cache hit count", + "type": "string" + }, + "pri.request_cache.hit_count": { + "description": "request cache hit count", + "type": "string" + }, + "request_cache.miss_count": { + "description": "request cache miss count", + "type": "string" + }, + "pri.request_cache.miss_count": { + "description": "request cache miss count", + "type": "string" + }, + "flush.total": { + "description": "number of flushes", + "type": "string" + }, + "pri.flush.total": { + "description": "number of flushes", + "type": "string" + }, + "flush.total_time": { + "description": "time spent in flush", + "type": "string" + }, + "pri.flush.total_time": { + "description": "time spent in flush", + "type": "string" + }, + "get.current": { + "description": "number of current get ops", + "type": "string" + }, + "pri.get.current": { + "description": "number of current get ops", + "type": "string" + }, + "get.time": { + "description": "time spent in get", + "type": "string" + }, + "pri.get.time": { + "description": "time spent in get", + "type": "string" + }, + "get.total": { + "description": "number of get ops", + "type": "string" + }, + "pri.get.total": { + "description": "number of get ops", + "type": "string" + }, + "get.exists_time": { + "description": "time spent in successful gets", + "type": "string" + }, + "pri.get.exists_time": { + "description": "time spent in successful gets", + "type": "string" + }, + "get.exists_total": { + "description": "number of successful gets", + "type": "string" + }, + "pri.get.exists_total": { + "description": "number of successful gets", + "type": "string" + }, + "get.missing_time": { + "description": "time spent in failed gets", + "type": "string" + }, + "pri.get.missing_time": { + "description": "time spent in failed gets", + "type": "string" + }, + "get.missing_total": { + "description": "number of failed gets", + "type": "string" + }, + "pri.get.missing_total": { + "description": "number of failed gets", + "type": "string" + }, + "indexing.delete_current": { + "description": "number of current deletions", + "type": "string" + }, + "pri.indexing.delete_current": { + "description": "number of current deletions", + "type": "string" + }, + "indexing.delete_time": { + "description": "time spent in deletions", + "type": "string" + }, + "pri.indexing.delete_time": { + "description": "time spent in deletions", + "type": "string" + }, + "indexing.delete_total": { + "description": "number of delete ops", + "type": "string" + }, + "pri.indexing.delete_total": { + "description": "number of delete ops", + "type": "string" + }, + "indexing.index_current": { + "description": "number of current indexing ops", + "type": "string" + }, + "pri.indexing.index_current": { + "description": "number of current indexing ops", + "type": "string" + }, + "indexing.index_time": { + "description": "time spent in indexing", + "type": "string" + }, + "pri.indexing.index_time": { + "description": "time spent in indexing", + "type": "string" + }, + "indexing.index_total": { + "description": "number of indexing ops", + "type": "string" + }, + "pri.indexing.index_total": { + "description": "number of indexing ops", + "type": "string" + }, + "indexing.index_failed": { + "description": "number of failed indexing ops", + "type": "string" + }, + "pri.indexing.index_failed": { + "description": "number of failed indexing ops", + "type": "string" + }, + "merges.current": { + "description": "number of current merges", + "type": "string" + }, + "pri.merges.current": { + "description": "number of current merges", + "type": "string" + }, + "merges.current_docs": { + "description": "number of current merging docs", + "type": "string" + }, + "pri.merges.current_docs": { + "description": "number of current merging docs", + "type": "string" + }, + "merges.current_size": { + "description": "size of current merges", + "type": "string" + }, + "pri.merges.current_size": { + "description": "size of current merges", + "type": "string" + }, + "merges.total": { + "description": "number of completed merge ops", + "type": "string" + }, + "pri.merges.total": { + "description": "number of completed merge ops", + "type": "string" + }, + "merges.total_docs": { + "description": "docs merged", + "type": "string" + }, + "pri.merges.total_docs": { + "description": "docs merged", + "type": "string" + }, + "merges.total_size": { + "description": "size merged", + "type": "string" + }, + "pri.merges.total_size": { + "description": "size merged", + "type": "string" + }, + "merges.total_time": { + "description": "time spent in merges", + "type": "string" + }, + "pri.merges.total_time": { + "description": "time spent in merges", + "type": "string" + }, + "refresh.total": { + "description": "total refreshes", + "type": "string" + }, + "pri.refresh.total": { + "description": "total refreshes", + "type": "string" + }, + "refresh.time": { + "description": "time spent in refreshes", + "type": "string" + }, + "pri.refresh.time": { + "description": "time spent in refreshes", + "type": "string" + }, + "refresh.external_total": { + "description": "total external refreshes", + "type": "string" + }, + "pri.refresh.external_total": { + "description": "total external refreshes", + "type": "string" + }, + "refresh.external_time": { + "description": "time spent in external refreshes", + "type": "string" + }, + "pri.refresh.external_time": { + "description": "time spent in external refreshes", + "type": "string" + }, + "refresh.listeners": { + "description": "number of pending refresh listeners", + "type": "string" + }, + "pri.refresh.listeners": { + "description": "number of pending refresh listeners", + "type": "string" + }, + "search.fetch_current": { + "description": "current fetch phase ops", + "type": "string" + }, + "pri.search.fetch_current": { + "description": "current fetch phase ops", + "type": "string" + }, + "search.fetch_time": { + "description": "time spent in fetch phase", + "type": "string" + }, + "pri.search.fetch_time": { + "description": "time spent in fetch phase", + "type": "string" + }, + "search.fetch_total": { + "description": "total fetch ops", + "type": "string" + }, + "pri.search.fetch_total": { + "description": "total fetch ops", + "type": "string" + }, + "search.open_contexts": { + "description": "open search contexts", + "type": "string" + }, + "pri.search.open_contexts": { + "description": "open search contexts", + "type": "string" + }, + "search.query_current": { + "description": "current query phase ops", + "type": "string" + }, + "pri.search.query_current": { + "description": "current query phase ops", + "type": "string" + }, + "search.query_time": { + "description": "time spent in query phase", + "type": "string" + }, + "pri.search.query_time": { + "description": "time spent in query phase", + "type": "string" + }, + "search.query_total": { + "description": "total query phase ops", + "type": "string" + }, + "pri.search.query_total": { + "description": "total query phase ops", + "type": "string" + }, + "search.scroll_current": { + "description": "open scroll contexts", + "type": "string" + }, + "pri.search.scroll_current": { + "description": "open scroll contexts", + "type": "string" + }, + "search.scroll_time": { + "description": "time scroll contexts held open", + "type": "string" + }, + "pri.search.scroll_time": { + "description": "time scroll contexts held open", + "type": "string" + }, + "search.scroll_total": { + "description": "completed scroll contexts", + "type": "string" + }, + "pri.search.scroll_total": { + "description": "completed scroll contexts", + "type": "string" + }, + "segments.count": { + "description": "number of segments", + "type": "string" + }, + "pri.segments.count": { + "description": "number of segments", + "type": "string" + }, + "segments.memory": { + "description": "memory used by segments", + "type": "string" + }, + "pri.segments.memory": { + "description": "memory used by segments", + "type": "string" + }, + "segments.index_writer_memory": { + "description": "memory used by index writer", + "type": "string" + }, + "pri.segments.index_writer_memory": { + "description": "memory used by index writer", + "type": "string" + }, + "segments.version_map_memory": { + "description": "memory used by version map", + "type": "string" + }, + "pri.segments.version_map_memory": { + "description": "memory used by version map", + "type": "string" + }, + "segments.fixed_bitset_memory": { + "description": "memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields", + "type": "string" + }, + "pri.segments.fixed_bitset_memory": { + "description": "memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields", + "type": "string" + }, + "warmer.current": { + "description": "current warmer ops", + "type": "string" + }, + "pri.warmer.current": { + "description": "current warmer ops", + "type": "string" + }, + "warmer.total": { + "description": "total warmer ops", + "type": "string" + }, + "pri.warmer.total": { + "description": "total warmer ops", + "type": "string" + }, + "warmer.total_time": { + "description": "time spent in warmers", + "type": "string" + }, + "pri.warmer.total_time": { + "description": "time spent in warmers", + "type": "string" + }, + "suggest.current": { + "description": "number of current suggest ops", + "type": "string" + }, + "pri.suggest.current": { + "description": "number of current suggest ops", + "type": "string" + }, + "suggest.time": { + "description": "time spend in suggest", + "type": "string" + }, + "pri.suggest.time": { + "description": "time spend in suggest", + "type": "string" + }, + "suggest.total": { + "description": "number of suggest ops", + "type": "string" + }, + "pri.suggest.total": { + "description": "number of suggest ops", + "type": "string" + }, + "memory.total": { + "description": "total used memory", + "type": "string" + }, + "pri.memory.total": { + "description": "total user memory", + "type": "string" + }, + "search.throttled": { + "description": "indicates if the index is search throttled", + "type": "string" + }, + "bulk.total_operations": { + "description": "number of bulk shard ops", + "type": "string" + }, + "pri.bulk.total_operations": { + "description": "number of bulk shard ops", + "type": "string" + }, + "bulk.total_time": { + "description": "time spend in shard bulk", + "type": "string" + }, + "pri.bulk.total_time": { + "description": "time spend in shard bulk", + "type": "string" + }, + "bulk.total_size_in_bytes": { + "description": "total size in bytes of shard bulk", + "type": "string" + }, + "pri.bulk.total_size_in_bytes": { + "description": "total size in bytes of shard bulk", + "type": "string" + }, + "bulk.avg_time": { + "description": "average time spend in shard bulk", + "type": "string" + }, + "pri.bulk.avg_time": { + "description": "average time spend in shard bulk", + "type": "string" + }, + "bulk.avg_size_in_bytes": { + "description": "average size in bytes of shard bulk", + "type": "string" + }, + "pri.bulk.avg_size_in_bytes": { + "description": "average size in bytes of shard bulk", + "type": "string" + } + } + }, + "cat._types:CatDfaColumns": { + "oneOf": [ + { + "$ref": "#/components/schemas/cat._types:CatDfaColumn" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/cat._types:CatDfaColumn" + } + } + ] + }, + "cat._types:CatDfaColumn": { + "type": "string", + "enum": [ + "assignment_explanation", + "ae", + "create_time", + "ct", + "createTime", + "description", + "d", + "dest_index", + "di", + "destIndex", + "failure_reason", + "fr", + "failureReason", + "id", + "model_memory_limit", + "mml", + "modelMemoryLimit", + "node.address", + "na", + "nodeAddress", + "node.ephemeral_id", + "ne", + "nodeEphemeralId", + "node.id", + "ni", + "nodeId", + "node.name", + "nn", + "nodeName", + "progress", + "p", + "source_index", + "si", + "sourceIndex", + "state", + "s", + "type", + "t", + "version", + "v" + ] + }, + "cat.ml_data_frame_analytics:DataFrameAnalyticsRecord": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "type": { + "description": "The type of analysis that the job performs.", + "type": "string" + }, + "create_time": { + "description": "The time when the job was created.", + "type": "string" + }, + "version": { + "$ref": "#/components/schemas/_types:VersionString" + }, + "source_index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "dest_index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "description": { + "description": "A description of the job.", + "type": "string" + }, + "model_memory_limit": { + "description": "The approximate maximum amount of memory resources that are permitted for the job.", + "type": "string" + }, + "state": { + "description": "The current status of the job.", + "type": "string" + }, + "failure_reason": { + "description": "Messages about the reason why the job failed.", + "type": "string" + }, + "progress": { + "description": "The progress report for the job by phase.", + "type": "string" + }, + "assignment_explanation": { + "description": "Messages related to the selection of a node.", + "type": "string" + }, + "node.id": { + "$ref": "#/components/schemas/_types:Id" + }, + "node.name": { + "$ref": "#/components/schemas/_types:Name" + }, + "node.ephemeral_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "node.address": { + "description": "The network address of the assigned node.", + "type": "string" + } + } + }, + "cat._types:CatDatafeedColumns": { + "oneOf": [ + { + "$ref": "#/components/schemas/cat._types:CatDatafeedColumn" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/cat._types:CatDatafeedColumn" + } + } + ] + }, + "cat._types:CatDatafeedColumn": { + "type": "string", + "enum": [ + "ae", + "assignment_explanation", + "bc", + "buckets.count", + "bucketsCount", + "id", + "na", + "node.address", + "nodeAddress", + "ne", + "node.ephemeral_id", + "nodeEphemeralId", + "ni", + "node.id", + "nodeId", + "nn", + "node.name", + "nodeName", + "sba", + "search.bucket_avg", + "searchBucketAvg", + "sc", + "search.count", + "searchCount", + "seah", + "search.exp_avg_hour", + "searchExpAvgHour", + "st", + "search.time", + "searchTime", + "s", + "state" + ] + }, + "cat.ml_datafeeds:DatafeedsRecord": { + "type": "object", + "properties": { + "id": { + "description": "The datafeed identifier.", + "type": "string" + }, + "state": { + "$ref": "#/components/schemas/ml._types:DatafeedState" + }, + "assignment_explanation": { + "description": "For started datafeeds only, contains messages relating to the selection of a node.", + "type": "string" + }, + "buckets.count": { + "description": "The number of buckets processed.", + "type": "string" + }, + "search.count": { + "description": "The number of searches run by the datafeed.", + "type": "string" + }, + "search.time": { + "description": "The total time the datafeed spent searching, in milliseconds.", + "type": "string" + }, + "search.bucket_avg": { + "description": "The average search time per bucket, in milliseconds.", + "type": "string" + }, + "search.exp_avg_hour": { + "description": "The exponential average search time per hour, in milliseconds.", + "type": "string" + }, + "node.id": { + "description": "The unique identifier of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", + "type": "string" + }, + "node.name": { + "description": "The name of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", + "type": "string" + }, + "node.ephemeral_id": { + "description": "The ephemeral identifier of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", + "type": "string" + }, + "node.address": { + "description": "The network address of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", + "type": "string" + } + } + }, + "ml._types:DatafeedState": { + "type": "string", + "enum": [ + "started", + "stopped", + "starting", + "stopping" + ] + }, + "cat._types:CatAnonalyDetectorColumns": { + "oneOf": [ + { + "$ref": "#/components/schemas/cat._types:CatAnomalyDetectorColumn" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/cat._types:CatAnomalyDetectorColumn" + } + } + ] + }, + "cat._types:CatAnomalyDetectorColumn": { + "type": "string", + "enum": [ + "assignment_explanation", + "ae", + "buckets.count", + "bc", + "bucketsCount", + "buckets.time.exp_avg", + "btea", + "bucketsTimeExpAvg", + "buckets.time.exp_avg_hour", + "bteah", + "bucketsTimeExpAvgHour", + "buckets.time.max", + "btmax", + "bucketsTimeMax", + "buckets.time.min", + "btmin", + "bucketsTimeMin", + "buckets.time.total", + "btt", + "bucketsTimeTotal", + "data.buckets", + "db", + "dataBuckets", + "data.earliest_record", + "der", + "dataEarliestRecord", + "data.empty_buckets", + "deb", + "dataEmptyBuckets", + "data.input_bytes", + "dib", + "dataInputBytes", + "data.input_fields", + "dif", + "dataInputFields", + "data.input_records", + "dir", + "dataInputRecords", + "data.invalid_dates", + "did", + "dataInvalidDates", + "data.last", + "dl", + "dataLast", + "data.last_empty_bucket", + "dleb", + "dataLastEmptyBucket", + "data.last_sparse_bucket", + "dlsb", + "dataLastSparseBucket", + "data.latest_record", + "dlr", + "dataLatestRecord", + "data.missing_fields", + "dmf", + "dataMissingFields", + "data.out_of_order_timestamps", + "doot", + "dataOutOfOrderTimestamps", + "data.processed_fields", + "dpf", + "dataProcessedFields", + "data.processed_records", + "dpr", + "dataProcessedRecords", + "data.sparse_buckets", + "dsb", + "dataSparseBuckets", + "forecasts.memory.avg", + "fmavg", + "forecastsMemoryAvg", + "forecasts.memory.max", + "fmmax", + "forecastsMemoryMax", + "forecasts.memory.min", + "fmmin", + "forecastsMemoryMin", + "forecasts.memory.total", + "fmt", + "forecastsMemoryTotal", + "forecasts.records.avg", + "fravg", + "forecastsRecordsAvg", + "forecasts.records.max", + "frmax", + "forecastsRecordsMax", + "forecasts.records.min", + "frmin", + "forecastsRecordsMin", + "forecasts.records.total", + "frt", + "forecastsRecordsTotal", + "forecasts.time.avg", + "ftavg", + "forecastsTimeAvg", + "forecasts.time.max", + "ftmax", + "forecastsTimeMax", + "forecasts.time.min", + "ftmin", + "forecastsTimeMin", + "forecasts.time.total", + "ftt", + "forecastsTimeTotal", + "forecasts.total", + "ft", + "forecastsTotal", + "id", + "model.bucket_allocation_failures", + "mbaf", + "modelBucketAllocationFailures", + "model.by_fields", + "mbf", + "modelByFields", + "model.bytes", + "mb", + "modelBytes", + "model.bytes_exceeded", + "mbe", + "modelBytesExceeded", + "model.categorization_status", + "mcs", + "modelCategorizationStatus", + "model.categorized_doc_count", + "mcdc", + "modelCategorizedDocCount", + "model.dead_category_count", + "mdcc", + "modelDeadCategoryCount", + "model.failed_category_count", + "mdcc", + "modelFailedCategoryCount", + "model.frequent_category_count", + "mfcc", + "modelFrequentCategoryCount", + "model.log_time", + "mlt", + "modelLogTime", + "model.memory_limit", + "mml", + "modelMemoryLimit", + "model.memory_status", + "mms", + "modelMemoryStatus", + "model.over_fields", + "mof", + "modelOverFields", + "model.partition_fields", + "mpf", + "modelPartitionFields", + "model.rare_category_count", + "mrcc", + "modelRareCategoryCount", + "model.timestamp", + "mt", + "modelTimestamp", + "model.total_category_count", + "mtcc", + "modelTotalCategoryCount", + "node.address", + "na", + "nodeAddress", + "node.ephemeral_id", + "ne", + "nodeEphemeralId", + "node.id", + "ni", + "nodeId", + "node.name", + "nn", + "nodeName", + "opened_time", + "ot", + "state", + "s" + ] + }, + "cat.ml_jobs:JobsRecord": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "state": { + "$ref": "#/components/schemas/ml._types:JobState" + }, + "opened_time": { + "description": "For open jobs only, the amount of time the job has been opened.", + "type": "string" + }, + "assignment_explanation": { + "description": "For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job.", + "type": "string" + }, + "data.processed_records": { + "description": "The number of input documents that have been processed by the anomaly detection job.\nThis value includes documents with missing fields, since they are nonetheless analyzed.\nIf you use datafeeds and have aggregations in your search query, the `processed_record_count` is the number of aggregation results processed, not the number of Elasticsearch documents.", + "type": "string" + }, + "data.processed_fields": { + "description": "The total number of fields in all the documents that have been processed by the anomaly detection job.\nOnly fields that are specified in the detector configuration object contribute to this count.\nThe timestamp is not included in this count.", + "type": "string" + }, + "data.input_bytes": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "data.input_records": { + "description": "The number of input documents posted to the anomaly detection job.", + "type": "string" + }, + "data.input_fields": { + "description": "The total number of fields in input documents posted to the anomaly detection job.\nThis count includes fields that are not used in the analysis.\nHowever, be aware that if you are using a datafeed, it extracts only the required fields from the documents it retrieves before posting them to the job.", + "type": "string" + }, + "data.invalid_dates": { + "description": "The number of input documents with either a missing date field or a date that could not be parsed.", + "type": "string" + }, + "data.missing_fields": { + "description": "The number of input documents that are missing a field that the anomaly detection job is configured to analyze.\nInput documents with missing fields are still processed because it is possible that not all fields are missing.\nIf you are using datafeeds or posting data to the job in JSON format, a high `missing_field_count` is often not an indication of data issues.\nIt is not necessarily a cause for concern.", + "type": "string" + }, + "data.out_of_order_timestamps": { + "description": "The number of input documents that have a timestamp chronologically preceding the start of the current anomaly detection bucket offset by the latency window.\nThis information is applicable only when you provide data to the anomaly detection job by using the post data API.\nThese out of order documents are discarded, since jobs require time series data to be in ascending chronological order.", + "type": "string" + }, + "data.empty_buckets": { + "description": "The number of buckets which did not contain any data.\nIf your data contains many empty buckets, consider increasing your `bucket_span` or using functions that are tolerant to gaps in data such as mean, `non_null_sum` or `non_zero_count`.", + "type": "string" + }, + "data.sparse_buckets": { + "description": "The number of buckets that contained few data points compared to the expected number of data points.\nIf your data contains many sparse buckets, consider using a longer `bucket_span`.", + "type": "string" + }, + "data.buckets": { + "description": "The total number of buckets processed.", + "type": "string" + }, + "data.earliest_record": { + "description": "The timestamp of the earliest chronologically input document.", + "type": "string" + }, + "data.latest_record": { + "description": "The timestamp of the latest chronologically input document.", + "type": "string" + }, + "data.last": { + "description": "The timestamp at which data was last analyzed, according to server time.", + "type": "string" + }, + "data.last_empty_bucket": { + "description": "The timestamp of the last bucket that did not contain any data.", + "type": "string" + }, + "data.last_sparse_bucket": { + "description": "The timestamp of the last bucket that was considered sparse.", + "type": "string" + }, + "model.bytes": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "model.memory_status": { + "$ref": "#/components/schemas/ml._types:MemoryStatus" + }, + "model.bytes_exceeded": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "model.memory_limit": { + "description": "The upper limit for model memory usage, checked on increasing values.", + "type": "string" + }, + "model.by_fields": { + "description": "The number of `by` field values that were analyzed by the models.\nThis value is cumulative for all detectors in the job.", + "type": "string" + }, + "model.over_fields": { + "description": "The number of `over` field values that were analyzed by the models.\nThis value is cumulative for all detectors in the job.", + "type": "string" + }, + "model.partition_fields": { + "description": "The number of `partition` field values that were analyzed by the models.\nThis value is cumulative for all detectors in the job.", + "type": "string" + }, + "model.bucket_allocation_failures": { + "description": "The number of buckets for which new entities in incoming data were not processed due to insufficient model memory.\nThis situation is also signified by a `hard_limit: memory_status` property value.", + "type": "string" + }, + "model.categorization_status": { + "$ref": "#/components/schemas/ml._types:CategorizationStatus" + }, + "model.categorized_doc_count": { + "description": "The number of documents that have had a field categorized.", + "type": "string" + }, + "model.total_category_count": { + "description": "The number of categories created by categorization.", + "type": "string" + }, + "model.frequent_category_count": { + "description": "The number of categories that match more than 1% of categorized documents.", + "type": "string" + }, + "model.rare_category_count": { + "description": "The number of categories that match just one categorized document.", + "type": "string" + }, + "model.dead_category_count": { + "description": "The number of categories created by categorization that will never be assigned again because another category’s definition makes it a superset of the dead category.\nDead categories are a side effect of the way categorization has no prior training.", + "type": "string" + }, + "model.failed_category_count": { + "description": "The number of times that categorization wanted to create a new category but couldn’t because the job had hit its `model_memory_limit`.\nThis count does not track which specific categories failed to be created.\nTherefore you cannot use this value to determine the number of unique categories that were missed.", + "type": "string" + }, + "model.log_time": { + "description": "The timestamp when the model stats were gathered, according to server time.", + "type": "string" + }, + "model.timestamp": { + "description": "The timestamp of the last record when the model stats were gathered.", + "type": "string" + }, + "forecasts.total": { + "description": "The number of individual forecasts currently available for the job.\nA value of one or more indicates that forecasts exist.", + "type": "string" + }, + "forecasts.memory.min": { + "description": "The minimum memory usage in bytes for forecasts related to the anomaly detection job.", + "type": "string" + }, + "forecasts.memory.max": { + "description": "The maximum memory usage in bytes for forecasts related to the anomaly detection job.", + "type": "string" + }, + "forecasts.memory.avg": { + "description": "The average memory usage in bytes for forecasts related to the anomaly detection job.", + "type": "string" + }, + "forecasts.memory.total": { + "description": "The total memory usage in bytes for forecasts related to the anomaly detection job.", + "type": "string" + }, + "forecasts.records.min": { + "description": "The minimum number of `model_forecast` documents written for forecasts related to the anomaly detection job.", + "type": "string" + }, + "forecasts.records.max": { + "description": "The maximum number of `model_forecast` documents written for forecasts related to the anomaly detection job.", + "type": "string" + }, + "forecasts.records.avg": { + "description": "The average number of `model_forecast` documents written for forecasts related to the anomaly detection job.", + "type": "string" + }, + "forecasts.records.total": { + "description": "The total number of `model_forecast` documents written for forecasts related to the anomaly detection job.", + "type": "string" + }, + "forecasts.time.min": { + "description": "The minimum runtime in milliseconds for forecasts related to the anomaly detection job.", + "type": "string" + }, + "forecasts.time.max": { + "description": "The maximum runtime in milliseconds for forecasts related to the anomaly detection job.", + "type": "string" + }, + "forecasts.time.avg": { + "description": "The average runtime in milliseconds for forecasts related to the anomaly detection job.", + "type": "string" + }, + "forecasts.time.total": { + "description": "The total runtime in milliseconds for forecasts related to the anomaly detection job.", + "type": "string" + }, + "node.id": { + "$ref": "#/components/schemas/_types:NodeId" + }, + "node.name": { + "description": "The name of the assigned node.", + "type": "string" + }, + "node.ephemeral_id": { + "$ref": "#/components/schemas/_types:NodeId" + }, + "node.address": { + "description": "The network address of the assigned node.", + "type": "string" + }, + "buckets.count": { + "description": "The number of bucket results produced by the job.", + "type": "string" + }, + "buckets.time.total": { + "description": "The sum of all bucket processing times, in milliseconds.", + "type": "string" + }, + "buckets.time.min": { + "description": "The minimum of all bucket processing times, in milliseconds.", + "type": "string" + }, + "buckets.time.max": { + "description": "The maximum of all bucket processing times, in milliseconds.", + "type": "string" + }, + "buckets.time.exp_avg": { + "description": "The exponential moving average of all bucket processing times, in milliseconds.", + "type": "string" + }, + "buckets.time.exp_avg_hour": { + "description": "The exponential moving average of bucket processing times calculated in a one hour time window, in milliseconds.", + "type": "string" + } + } + }, + "ml._types:JobState": { + "type": "string", + "enum": [ + "closing", + "closed", + "opened", + "failed", + "opening" + ] + }, + "_types:ByteSize": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#byte-units" + }, + "oneOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "ml._types:MemoryStatus": { + "type": "string", + "enum": [ + "ok", + "soft_limit", + "hard_limit" + ] + }, + "ml._types:CategorizationStatus": { + "type": "string", + "enum": [ + "ok", + "warn" + ] + }, + "_types:NodeId": { + "type": "string" + }, + "cat._types:CatTrainedModelsColumns": { + "oneOf": [ + { + "$ref": "#/components/schemas/cat._types:CatTrainedModelsColumn" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/cat._types:CatTrainedModelsColumn" + } + } + ] + }, + "cat._types:CatTrainedModelsColumn": { + "type": "string", + "enum": [ + "create_time", + "ct", + "created_by", + "c", + "createdBy", + "data_frame_analytics_id", + "df", + "dataFrameAnalytics", + "dfid", + "description", + "d", + "heap_size", + "hs", + "modelHeapSize", + "id", + "ingest.count", + "ic", + "ingestCount", + "ingest.current", + "icurr", + "ingestCurrent", + "ingest.failed", + "if", + "ingestFailed", + "ingest.pipelines", + "ip", + "ingestPipelines", + "ingest.time", + "it", + "ingestTime", + "license", + "l", + "operations", + "o", + "modelOperations", + "version", + "v" + ] + }, + "cat.ml_trained_models:TrainedModelsRecord": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "created_by": { + "description": "Information about the creator of the model.", + "type": "string" + }, + "heap_size": { + "$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.", + "type": "string" + }, + "license": { + "description": "The license level of the model.", + "type": "string" + }, + "create_time": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "version": { + "$ref": "#/components/schemas/_types:VersionString" + }, + "description": { + "description": "A description of the model.", + "type": "string" + }, + "ingest.pipelines": { + "description": "The number of pipelines that are referencing the model.", + "type": "string" + }, + "ingest.count": { + "description": "The total number of documents that are processed by the model.", + "type": "string" + }, + "ingest.time": { + "description": "The total time spent processing documents with thie model.", + "type": "string" + }, + "ingest.current": { + "description": "The total number of documents that are currently being handled by the model.", + "type": "string" + }, + "ingest.failed": { + "description": "The total number of failed ingest attempts with the model.", + "type": "string" + }, + "data_frame.id": { + "description": "The identifier for the data frame analytics job that created the model.\nOnly displayed if the job is still available.", + "type": "string" + }, + "data_frame.create_time": { + "description": "The time the data frame analytics job was created.", + "type": "string" + }, + "data_frame.source_index": { + "description": "The source index used to train in the data frame analysis.", + "type": "string" + }, + "data_frame.analysis": { + "description": "The analysis used by the data frame to build the model.", + "type": "string" + }, + "type": { + "x-available-since": "8.0.0", + "type": "string" + } + } + }, + "cat._types:CatTransformColumns": { + "oneOf": [ + { + "$ref": "#/components/schemas/cat._types:CatTransformColumn" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/cat._types:CatTransformColumn" + } + } + ] + }, + "cat._types:CatTransformColumn": { + "type": "string", + "enum": [ + "changes_last_detection_time", + "cldt", + "checkpoint", + "cp", + "checkpoint_duration_time_exp_avg", + "cdtea", + "checkpointTimeExpAvg", + "checkpoint_progress", + "c", + "checkpointProgress", + "create_time", + "ct", + "createTime", + "delete_time", + "dtime", + "description", + "d", + "dest_index", + "di", + "destIndex", + "documents_deleted", + "docd", + "documents_indexed", + "doci", + "docs_per_second", + "dps", + "documents_processed", + "docp", + "frequency", + "f", + "id", + "index_failure", + "if", + "index_time", + "itime", + "index_total", + "it", + "indexed_documents_exp_avg", + "idea", + "last_search_time", + "lst", + "lastSearchTime", + "max_page_search_size", + "mpsz", + "pages_processed", + "pp", + "pipeline", + "p", + "processed_documents_exp_avg", + "pdea", + "processing_time", + "pt", + "reason", + "r", + "search_failure", + "sf", + "search_time", + "stime", + "search_total", + "st", + "source_index", + "si", + "sourceIndex", + "state", + "s", + "transform_type", + "tt", + "trigger_count", + "tc", + "version", + "v" + ] + }, + "cat.transforms:TransformsRecord": { + "type": "object", + "properties": { + "id": { + "$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.", + "type": "string" + }, + "checkpoint": { + "description": "The sequence number for the checkpoint.", + "type": "string" + }, + "documents_processed": { + "description": "The number of documents that have been processed from the source index of the transform.", + "type": "string" + }, + "checkpoint_progress": { + "description": "The progress of the next checkpoint that is currently in progress.", + "oneOf": [ + { + "type": "string" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "last_search_time": { + "description": "The timestamp of the last search in the source indices.\nThis field is shown only if the transform is running.", + "oneOf": [ + { + "type": "string" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "changes_last_detection_time": { + "description": "The timestamp when changes were last detected in the source indices.", + "oneOf": [ + { + "type": "string" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "create_time": { + "description": "The time the transform was created.", + "type": "string" + }, + "version": { + "$ref": "#/components/schemas/_types:VersionString" + }, + "source_index": { + "description": "The source indices for the transform.", + "type": "string" + }, + "dest_index": { + "description": "The destination index for the transform.", + "type": "string" + }, + "pipeline": { + "description": "The unique identifier for the ingest pipeline.", + "type": "string" + }, + "description": { + "description": "The description of the transform.", + "type": "string" + }, + "transform_type": { + "description": "The type of transform: `batch` or `continuous`.", + "type": "string" + }, + "frequency": { + "description": "The interval between checks for changes in the source indices when the transform is running continuously.", + "type": "string" + }, + "max_page_search_size": { + "description": "The initial page size that is used for the composite aggregation for each checkpoint.", + "type": "string" + }, + "docs_per_second": { + "description": "The number of input documents per second.", + "type": "string" + }, + "reason": { + "description": "If a transform has a `failed` state, these details describe the reason for failure.", + "type": "string" + }, + "search_total": { + "description": "The total number of search operations on the source index for the transform.", + "type": "string" + }, + "search_failure": { + "description": "The total number of search failures.", + "type": "string" + }, + "search_time": { + "description": "The total amount of search time, in milliseconds.", + "type": "string" + }, + "index_total": { + "description": "The total number of index operations done by the transform.", + "type": "string" + }, + "index_failure": { + "description": "The total number of indexing failures.", + "type": "string" + }, + "index_time": { + "description": "The total time spent indexing documents, in milliseconds.", + "type": "string" + }, + "documents_indexed": { + "description": "The number of documents that have been indexed into the destination index for the transform.", + "type": "string" + }, + "delete_time": { + "description": "The total time spent deleting documents, in milliseconds.", + "type": "string" + }, + "documents_deleted": { + "description": "The number of documents deleted from the destination index due to the retention policy for the transform.", + "type": "string" + }, + "trigger_count": { + "description": "The number of times the transform has been triggered by the scheduler.\nFor example, the scheduler triggers the transform indexer to check for updates or ingest new data at an interval specified in the `frequency` property.", + "type": "string" + }, + "pages_processed": { + "description": "The number of search or bulk index operations processed.\nDocuments are processed in batches instead of individually.", + "type": "string" + }, + "processing_time": { + "description": "The total time spent processing results, in milliseconds.", + "type": "string" + }, + "checkpoint_duration_time_exp_avg": { + "description": "The exponential moving average of the duration of the checkpoint, in milliseconds.", + "type": "string" + }, + "indexed_documents_exp_avg": { + "description": "The exponential moving average of the number of new documents that have been indexed.", + "type": "string" + }, + "processed_documents_exp_avg": { + "description": "The exponential moving average of the number of documents that have been processed.", + "type": "string" + } + } + }, + "_types:ScrollIds": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types:ScrollId" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:ScrollId" + } + } + ] + }, + "cluster._types:ComponentTemplate": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/_types:Name" + }, + "component_template": { + "$ref": "#/components/schemas/cluster._types:ComponentTemplateNode" + } + }, + "required": [ + "name", + "component_template" + ] + }, + "cluster._types:ComponentTemplateNode": { + "type": "object", + "properties": { + "template": { + "$ref": "#/components/schemas/cluster._types:ComponentTemplateSummary" + }, + "version": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "_meta": { + "$ref": "#/components/schemas/_types:Metadata" + } + }, + "required": [ + "template" + ] + }, + "cluster._types:ComponentTemplateSummary": { + "type": "object", + "properties": { + "_meta": { + "$ref": "#/components/schemas/_types:Metadata" + }, + "version": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "settings": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/indices._types:IndexSettings" + } + }, + "mappings": { + "$ref": "#/components/schemas/_types.mapping:TypeMapping" + }, + "aliases": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/indices._types:AliasDefinition" + } + }, + "lifecycle": { + "$ref": "#/components/schemas/indices._types:DataStreamLifecycleWithRollover" + } + } + }, + "indices._types:IndexSettings": { + "type": "object", + "properties": { + "index": { + "$ref": "#/components/schemas/indices._types:IndexSettings" + }, + "mode": { + "type": "string" + }, + "routing_path": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "soft_deletes": { + "$ref": "#/components/schemas/indices._types:SoftDeletes" + }, + "sort": { + "$ref": "#/components/schemas/indices._types:IndexSegmentSort" + }, + "number_of_shards": { + "oneOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "number_of_replicas": { + "oneOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "number_of_routing_shards": { + "type": "number" + }, + "check_on_startup": { + "$ref": "#/components/schemas/indices._types:IndexCheckOnStartup" + }, + "codec": { + "type": "string" + }, + "routing_partition_size": { + "$ref": "#/components/schemas/_spec_utils:Stringifiedinteger" + }, + "load_fixed_bitset_filters_eagerly": { + "type": "boolean" + }, + "hidden": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "string" + } + ] + }, + "auto_expand_replicas": { + "type": "string" + }, + "merge": { + "$ref": "#/components/schemas/indices._types:Merge" + }, + "search": { + "$ref": "#/components/schemas/indices._types:SettingsSearch" + }, + "refresh_interval": { + "$ref": "#/components/schemas/_types:Duration" + }, + "max_result_window": { + "type": "number" + }, + "max_inner_result_window": { + "type": "number" + }, + "max_rescore_window": { + "type": "number" + }, + "max_docvalue_fields_search": { + "type": "number" + }, + "max_script_fields": { + "type": "number" + }, + "max_ngram_diff": { + "type": "number" + }, + "max_shingle_diff": { + "type": "number" + }, + "blocks": { + "$ref": "#/components/schemas/indices._types:IndexSettingBlocks" + }, + "max_refresh_listeners": { + "type": "number" + }, + "analyze": { + "$ref": "#/components/schemas/indices._types:SettingsAnalyze" + }, + "highlight": { + "$ref": "#/components/schemas/indices._types:SettingsHighlight" + }, + "max_terms_count": { + "type": "number" + }, + "max_regex_length": { + "type": "number" + }, + "routing": { + "$ref": "#/components/schemas/indices._types:IndexRouting" + }, + "gc_deletes": { + "$ref": "#/components/schemas/_types:Duration" + }, + "default_pipeline": { + "$ref": "#/components/schemas/_types:PipelineName" + }, + "final_pipeline": { + "$ref": "#/components/schemas/_types:PipelineName" + }, + "lifecycle": { + "$ref": "#/components/schemas/indices._types:IndexSettingsLifecycle" + }, + "provided_name": { + "$ref": "#/components/schemas/_types:Name" + }, + "creation_date": { + "$ref": "#/components/schemas/_spec_utils:StringifiedEpochTimeUnitMillis" + }, + "creation_date_string": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "uuid": { + "$ref": "#/components/schemas/_types:Uuid" + }, + "version": { + "$ref": "#/components/schemas/indices._types:IndexVersioning" + }, + "verified_before_close": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "string" + } + ] + }, + "format": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + } + ] + }, + "max_slices_per_scroll": { + "type": "number" + }, + "translog": { + "$ref": "#/components/schemas/indices._types:Translog" + }, + "query_string": { + "$ref": "#/components/schemas/indices._types:SettingsQueryString" + }, + "priority": { + "oneOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "top_metrics_max_size": { + "type": "number" + }, + "analysis": { + "$ref": "#/components/schemas/indices._types:IndexSettingsAnalysis" + }, + "settings": { + "$ref": "#/components/schemas/indices._types:IndexSettings" + }, + "time_series": { + "$ref": "#/components/schemas/indices._types:IndexSettingsTimeSeries" + }, + "queries": { + "$ref": "#/components/schemas/indices._types:Queries" + }, + "similarity": { + "description": "Configure custom similarity settings to customize how search results are scored.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/indices._types:SettingsSimilarity" + } + }, + "mapping": { + "$ref": "#/components/schemas/indices._types:MappingLimitSettings" + }, + "indexing.slowlog": { + "$ref": "#/components/schemas/indices._types:IndexingSlowlogSettings" + }, + "indexing_pressure": { + "$ref": "#/components/schemas/indices._types:IndexingPressure" + }, + "store": { + "$ref": "#/components/schemas/indices._types:Storage" + } + } + }, + "indices._types:SoftDeletes": { + "type": "object", + "properties": { + "enabled": { + "description": "Indicates whether soft deletes are enabled on the index.", + "type": "boolean" + }, + "retention_lease": { + "$ref": "#/components/schemas/indices._types:RetentionLease" + } + } + }, + "indices._types:RetentionLease": { + "type": "object", + "properties": { + "period": { + "$ref": "#/components/schemas/_types:Duration" + } + }, + "required": [ + "period" + ] + }, + "indices._types:IndexSegmentSort": { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Fields" + }, + "order": { + "oneOf": [ + { + "$ref": "#/components/schemas/indices._types:SegmentSortOrder" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices._types:SegmentSortOrder" + } + } + ] + }, + "mode": { + "oneOf": [ + { + "$ref": "#/components/schemas/indices._types:SegmentSortMode" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices._types:SegmentSortMode" + } + } + ] + }, + "missing": { + "oneOf": [ + { + "$ref": "#/components/schemas/indices._types:SegmentSortMissing" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices._types:SegmentSortMissing" + } + } + ] + } + } + }, + "indices._types:SegmentSortOrder": { + "type": "string", + "enum": [ + "asc", + "ASC", + "desc", + "DESC" + ] + }, + "indices._types:SegmentSortMode": { + "type": "string", + "enum": [ + "min", + "MIN", + "max", + "MAX" + ] + }, + "indices._types:SegmentSortMissing": { + "type": "string", + "enum": [ + "_last", + "_first" + ] + }, + "indices._types:IndexCheckOnStartup": { + "type": "string", + "enum": [ + "true", + "false", + "checksum" + ] + }, + "_spec_utils:Stringifiedinteger": { + "description": "Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior\nis used to capture this behavior while keeping the semantics of the field type.\n\nDepending on the target language, code generators can keep the union or remove it and leniently parse\nstrings to the target type.", + "oneOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "indices._types:Merge": { + "type": "object", + "properties": { + "scheduler": { + "$ref": "#/components/schemas/indices._types:MergeScheduler" + } + } + }, + "indices._types:MergeScheduler": { + "type": "object", + "properties": { + "max_thread_count": { + "$ref": "#/components/schemas/_spec_utils:Stringifiedinteger" + }, + "max_merge_count": { + "$ref": "#/components/schemas/_spec_utils:Stringifiedinteger" + } + } + }, + "indices._types:SettingsSearch": { + "type": "object", + "properties": { + "idle": { + "$ref": "#/components/schemas/indices._types:SearchIdle" + }, + "slowlog": { + "$ref": "#/components/schemas/indices._types:SlowlogSettings" + } + } + }, + "indices._types:SearchIdle": { + "type": "object", + "properties": { + "after": { + "$ref": "#/components/schemas/_types:Duration" + } + } + }, + "indices._types:SlowlogSettings": { + "type": "object", + "properties": { + "level": { + "type": "string" + }, + "source": { + "type": "number" + }, + "reformat": { + "type": "boolean" + }, + "threshold": { + "$ref": "#/components/schemas/indices._types:SlowlogTresholds" + } + } + }, + "indices._types:SlowlogTresholds": { + "type": "object", + "properties": { + "query": { + "$ref": "#/components/schemas/indices._types:SlowlogTresholdLevels" + }, + "fetch": { + "$ref": "#/components/schemas/indices._types:SlowlogTresholdLevels" + } + } + }, + "indices._types:SlowlogTresholdLevels": { + "type": "object", + "properties": { + "warn": { + "$ref": "#/components/schemas/_types:Duration" + }, + "info": { + "$ref": "#/components/schemas/_types:Duration" + }, + "debug": { + "$ref": "#/components/schemas/_types:Duration" + }, + "trace": { + "$ref": "#/components/schemas/_types:Duration" + } + } + }, + "indices._types:IndexSettingBlocks": { + "type": "object", + "properties": { + "read_only": { + "$ref": "#/components/schemas/_spec_utils:Stringifiedboolean" + }, + "read_only_allow_delete": { + "$ref": "#/components/schemas/_spec_utils:Stringifiedboolean" + }, + "read": { + "$ref": "#/components/schemas/_spec_utils:Stringifiedboolean" + }, + "write": { + "$ref": "#/components/schemas/_spec_utils:Stringifiedboolean" + }, + "metadata": { + "$ref": "#/components/schemas/_spec_utils:Stringifiedboolean" + } + } + }, + "_spec_utils:Stringifiedboolean": { + "description": "Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior\nis used to capture this behavior while keeping the semantics of the field type.\n\nDepending on the target language, code generators can keep the union or remove it and leniently parse\nstrings to the target type.", + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "string" + } + ] + }, + "indices._types:SettingsAnalyze": { + "type": "object", + "properties": { + "max_token_count": { + "$ref": "#/components/schemas/_spec_utils:Stringifiedinteger" + } + } + }, + "indices._types:SettingsHighlight": { + "type": "object", + "properties": { + "max_analyzed_offset": { + "type": "number" + } + } + }, + "indices._types:IndexRouting": { + "type": "object", + "properties": { + "allocation": { + "$ref": "#/components/schemas/indices._types:IndexRoutingAllocation" + }, + "rebalance": { + "$ref": "#/components/schemas/indices._types:IndexRoutingRebalance" + } + } + }, + "indices._types:IndexRoutingAllocation": { + "type": "object", + "properties": { + "enable": { + "$ref": "#/components/schemas/indices._types:IndexRoutingAllocationOptions" + }, + "include": { + "$ref": "#/components/schemas/indices._types:IndexRoutingAllocationInclude" + }, + "initial_recovery": { + "$ref": "#/components/schemas/indices._types:IndexRoutingAllocationInitialRecovery" + }, + "disk": { + "$ref": "#/components/schemas/indices._types:IndexRoutingAllocationDisk" + } + } + }, + "indices._types:IndexRoutingAllocationOptions": { + "type": "string", + "enum": [ + "all", + "primaries", + "new_primaries", + "none" + ] + }, + "indices._types:IndexRoutingAllocationInclude": { + "type": "object", + "properties": { + "_tier_preference": { + "type": "string" + }, + "_id": { + "$ref": "#/components/schemas/_types:Id" + } + } + }, + "indices._types:IndexRoutingAllocationInitialRecovery": { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/_types:Id" + } + } + }, + "indices._types:IndexRoutingAllocationDisk": { + "type": "object", + "properties": { + "threshold_enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "string" + } + ] + } + } + }, + "indices._types:IndexRoutingRebalance": { + "type": "object", + "properties": { + "enable": { + "$ref": "#/components/schemas/indices._types:IndexRoutingRebalanceOptions" + } + }, + "required": [ + "enable" + ] + }, + "indices._types:IndexRoutingRebalanceOptions": { + "type": "string", + "enum": [ + "all", + "primaries", + "replicas", + "none" + ] + }, + "_types:PipelineName": { + "type": "string" + }, + "indices._types:IndexSettingsLifecycle": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/_types:Name" + }, + "indexing_complete": { + "$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.", + "type": "number" + }, + "parse_origination_date": { + "description": "Set to true to parse the origination date from the index name. This origination date is used to calculate the index age\nfor its phase transitions. The index name must match the pattern ^.*-{date_format}-\\\\d+, where the date_format is\nyyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format,\nfor example logs-2016.10.31-000002). If the index name doesn’t match the pattern, index creation fails.", + "type": "boolean" + }, + "step": { + "$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.", + "type": "string" + } + } + }, + "indices._types:IndexSettingsLifecycleStep": { + "type": "object", + "properties": { + "wait_time_threshold": { + "$ref": "#/components/schemas/_types:Duration" + } + } + }, + "_spec_utils:StringifiedEpochTimeUnitMillis": { + "description": "Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior\nis used to capture this behavior while keeping the semantics of the field type.\n\nDepending on the target language, code generators can keep the union or remove it and leniently parse\nstrings to the target type.", + "oneOf": [ + { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + { + "type": "string" + } + ] + }, + "_types:Uuid": { + "type": "string" + }, + "indices._types:IndexVersioning": { + "type": "object", + "properties": { + "created": { + "$ref": "#/components/schemas/_types:VersionString" + }, + "created_string": { + "type": "string" + } + } + }, + "indices._types:Translog": { + "type": "object", + "properties": { + "sync_interval": { + "$ref": "#/components/schemas/_types:Duration" + }, + "durability": { + "$ref": "#/components/schemas/indices._types:TranslogDurability" + }, + "flush_threshold_size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "retention": { + "$ref": "#/components/schemas/indices._types:TranslogRetention" + } + } + }, + "indices._types:TranslogDurability": { + "type": "string", + "enum": [ + "request", + "REQUEST", + "async", + "ASYNC" + ] + }, + "indices._types:TranslogRetention": { + "type": "object", + "properties": { + "size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "age": { + "$ref": "#/components/schemas/_types:Duration" + } + } + }, + "indices._types:SettingsQueryString": { + "type": "object", + "properties": { + "lenient": { + "$ref": "#/components/schemas/_spec_utils:Stringifiedboolean" + } + }, + "required": [ + "lenient" + ] + }, + "indices._types:IndexSettingsAnalysis": { + "type": "object", + "properties": { + "analyzer": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.analysis:Analyzer" + } + }, + "char_filter": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.analysis:CharFilter" + } + }, + "filter": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.analysis:TokenFilter" + } + }, + "normalizer": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.analysis:Normalizer" + } + }, + "tokenizer": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.analysis:Tokenizer" + } + } + } + }, + "_types.analysis:CharFilter": { + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/_types.analysis:CharFilterDefinition" + } + ] + }, + "_types.analysis:CharFilterDefinition": { + "discriminator": { + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/_types.analysis:HtmlStripCharFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:MappingCharFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:PatternReplaceCharFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:IcuNormalizationCharFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:KuromojiIterationMarkCharFilter" + } + ] + }, + "_types.analysis:HtmlStripCharFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:CharFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "html_strip" + ] + }, + "escaped_tags": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:CharFilterBase": { + "type": "object", + "properties": { + "version": { + "$ref": "#/components/schemas/_types:VersionString" + } + } + }, + "_types.analysis:MappingCharFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:CharFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "mapping" + ] + }, + "mappings": { + "type": "array", + "items": { + "type": "string" + } + }, + "mappings_path": { + "type": "string" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:PatternReplaceCharFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:CharFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "pattern_replace" + ] + }, + "flags": { + "type": "string" + }, + "pattern": { + "type": "string" + }, + "replacement": { + "type": "string" + } + }, + "required": [ + "type", + "pattern" + ] + } + ] + }, + "_types.analysis:IcuNormalizationCharFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:CharFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "icu_normalizer" + ] + }, + "mode": { + "$ref": "#/components/schemas/_types.analysis:IcuNormalizationMode" + }, + "name": { + "$ref": "#/components/schemas/_types.analysis:IcuNormalizationType" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:KuromojiIterationMarkCharFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:CharFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "kuromoji_iteration_mark" + ] + }, + "normalize_kana": { + "type": "boolean" + }, + "normalize_kanji": { + "type": "boolean" + } + }, + "required": [ + "type", + "normalize_kana", + "normalize_kanji" + ] + } + ] + }, + "_types.analysis:TokenFilter": { + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterDefinition" + } + ] + }, + "_types.analysis:TokenFilterDefinition": { + "discriminator": { + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/_types.analysis:AsciiFoldingTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:CommonGramsTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:ConditionTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:DelimitedPayloadTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:EdgeNGramTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:ElisionTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:FingerprintTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:HunspellTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:HyphenationDecompounderTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:KeepTypesTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:KeepWordsTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:KeywordMarkerTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:KStemTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:LengthTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:LimitTokenCountTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:LowercaseTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:MultiplexerTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:NGramTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:NoriPartOfSpeechTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:PatternCaptureTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:PatternReplaceTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:PorterStemTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:PredicateTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:RemoveDuplicatesTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:ReverseTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:ShingleTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:SnowballTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:StemmerOverrideTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:StemmerTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:StopTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:SynonymGraphTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:SynonymTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:TrimTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:TruncateTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:UniqueTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:UppercaseTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:WordDelimiterGraphTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:WordDelimiterTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:KuromojiStemmerTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:KuromojiReadingFormTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:KuromojiPartOfSpeechTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:IcuCollationTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:IcuFoldingTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:IcuNormalizationTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:IcuTransformTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:PhoneticTokenFilter" + }, + { + "$ref": "#/components/schemas/_types.analysis:DictionaryDecompounderTokenFilter" + } + ] + }, + "_types.analysis:AsciiFoldingTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "asciifolding" + ] + }, + "preserve_original": { + "$ref": "#/components/schemas/_spec_utils:Stringifiedboolean" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:TokenFilterBase": { + "type": "object", + "properties": { + "version": { + "$ref": "#/components/schemas/_types:VersionString" + } + } + }, + "_types.analysis:CommonGramsTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "common_grams" + ] + }, + "common_words": { + "type": "array", + "items": { + "type": "string" + } + }, + "common_words_path": { + "type": "string" + }, + "ignore_case": { + "type": "boolean" + }, + "query_mode": { + "type": "boolean" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:ConditionTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "condition" + ] + }, + "filter": { + "type": "array", + "items": { + "type": "string" + } + }, + "script": { + "$ref": "#/components/schemas/_types:Script" + } + }, + "required": [ + "type", + "filter", + "script" + ] + } + ] + }, + "_types.analysis:DelimitedPayloadTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "delimited_payload" + ] + }, + "delimiter": { + "type": "string" + }, + "encoding": { + "$ref": "#/components/schemas/_types.analysis:DelimitedPayloadEncoding" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:DelimitedPayloadEncoding": { + "type": "string", + "enum": [ + "int", + "float", + "identity" + ] + }, + "_types.analysis:EdgeNGramTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "edge_ngram" + ] + }, + "max_gram": { + "type": "number" + }, + "min_gram": { + "type": "number" + }, + "side": { + "$ref": "#/components/schemas/_types.analysis:EdgeNGramSide" + }, + "preserve_original": { + "$ref": "#/components/schemas/_spec_utils:Stringifiedboolean" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:EdgeNGramSide": { + "type": "string", + "enum": [ + "front", + "back" + ] + }, + "_types.analysis:ElisionTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "elision" + ] + }, + "articles": { + "type": "array", + "items": { + "type": "string" + } + }, + "articles_path": { + "type": "string" + }, + "articles_case": { + "$ref": "#/components/schemas/_spec_utils:Stringifiedboolean" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:FingerprintTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "fingerprint" + ] + }, + "max_output_size": { + "type": "number" + }, + "separator": { + "type": "string" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:HunspellTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "hunspell" + ] + }, + "dedup": { + "type": "boolean" + }, + "dictionary": { + "type": "string" + }, + "locale": { + "type": "string" + }, + "longest_only": { + "type": "boolean" + } + }, + "required": [ + "type", + "locale" + ] + } + ] + }, + "_types.analysis:HyphenationDecompounderTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:CompoundWordTokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "hyphenation_decompounder" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:CompoundWordTokenFilterBase": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "hyphenation_patterns_path": { + "type": "string" + }, + "max_subword_size": { + "type": "number" + }, + "min_subword_size": { + "type": "number" + }, + "min_word_size": { + "type": "number" + }, + "only_longest_match": { + "type": "boolean" + }, + "word_list": { + "type": "array", + "items": { + "type": "string" + } + }, + "word_list_path": { + "type": "string" + } + } + } + ] + }, + "_types.analysis:KeepTypesTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "keep_types" + ] + }, + "mode": { + "$ref": "#/components/schemas/_types.analysis:KeepTypesMode" + }, + "types": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:KeepTypesMode": { + "type": "string", + "enum": [ + "include", + "exclude" + ] + }, + "_types.analysis:KeepWordsTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "keep" + ] + }, + "keep_words": { + "type": "array", + "items": { + "type": "string" + } + }, + "keep_words_case": { + "type": "boolean" + }, + "keep_words_path": { + "type": "string" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:KeywordMarkerTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "keyword_marker" + ] + }, + "ignore_case": { + "type": "boolean" + }, + "keywords": { + "type": "array", + "items": { + "type": "string" + } + }, + "keywords_path": { + "type": "string" + }, + "keywords_pattern": { + "type": "string" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:KStemTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "kstem" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:LengthTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "length" + ] + }, + "max": { + "type": "number" + }, + "min": { + "type": "number" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:LimitTokenCountTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "limit" + ] + }, + "consume_all_tokens": { + "type": "boolean" + }, + "max_token_count": { + "$ref": "#/components/schemas/_spec_utils:Stringifiedinteger" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:LowercaseTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "lowercase" + ] + }, + "language": { + "type": "string" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:MultiplexerTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "multiplexer" + ] + }, + "filters": { + "type": "array", + "items": { + "type": "string" + } + }, + "preserve_original": { + "$ref": "#/components/schemas/_spec_utils:Stringifiedboolean" + } + }, + "required": [ + "type", + "filters" + ] + } + ] + }, + "_types.analysis:NGramTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "ngram" + ] + }, + "max_gram": { + "type": "number" + }, + "min_gram": { + "type": "number" + }, + "preserve_original": { + "$ref": "#/components/schemas/_spec_utils:Stringifiedboolean" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:NoriPartOfSpeechTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "nori_part_of_speech" + ] + }, + "stoptags": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:PatternCaptureTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "pattern_capture" + ] + }, + "patterns": { + "type": "array", + "items": { + "type": "string" + } + }, + "preserve_original": { + "$ref": "#/components/schemas/_spec_utils:Stringifiedboolean" + } + }, + "required": [ + "type", + "patterns" + ] + } + ] + }, + "_types.analysis:PatternReplaceTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "pattern_replace" + ] + }, + "all": { + "type": "boolean" + }, + "flags": { + "type": "string" + }, + "pattern": { + "type": "string" + }, + "replacement": { + "type": "string" + } + }, + "required": [ + "type", + "pattern" + ] + } + ] + }, + "_types.analysis:PorterStemTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "porter_stem" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:PredicateTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "predicate_token_filter" + ] + }, + "script": { + "$ref": "#/components/schemas/_types:Script" + } + }, + "required": [ + "type", + "script" + ] + } + ] + }, + "_types.analysis:RemoveDuplicatesTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "remove_duplicates" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:ReverseTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "reverse" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:ShingleTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "shingle" + ] + }, + "filler_token": { + "type": "string" + }, + "max_shingle_size": { + "oneOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "min_shingle_size": { + "oneOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "output_unigrams": { + "type": "boolean" + }, + "output_unigrams_if_no_shingles": { + "type": "boolean" + }, + "token_separator": { + "type": "string" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:SnowballTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "snowball" + ] + }, + "language": { + "$ref": "#/components/schemas/_types.analysis:SnowballLanguage" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:StemmerOverrideTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "stemmer_override" + ] + }, + "rules": { + "type": "array", + "items": { + "type": "string" + } + }, + "rules_path": { + "type": "string" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:StemmerTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "stemmer" + ] + }, + "language": { + "type": "string" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:StopTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "stop" + ] + }, + "ignore_case": { + "type": "boolean" + }, + "remove_trailing": { + "type": "boolean" + }, + "stopwords": { + "$ref": "#/components/schemas/_types.analysis:StopWords" + }, + "stopwords_path": { + "type": "string" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:SynonymGraphTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "synonym_graph" + ] + }, + "expand": { + "type": "boolean" + }, + "format": { + "$ref": "#/components/schemas/_types.analysis:SynonymFormat" + }, + "lenient": { + "type": "boolean" + }, + "synonyms": { + "type": "array", + "items": { + "type": "string" + } + }, + "synonyms_path": { + "type": "string" + }, + "synonyms_set": { + "type": "string" + }, + "tokenizer": { + "type": "string" + }, + "updateable": { + "type": "boolean" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:SynonymFormat": { + "type": "string", + "enum": [ + "solr", + "wordnet" + ] + }, + "_types.analysis:SynonymTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "synonym" + ] + }, + "expand": { + "type": "boolean" + }, + "format": { + "$ref": "#/components/schemas/_types.analysis:SynonymFormat" + }, + "lenient": { + "type": "boolean" + }, + "synonyms": { + "type": "array", + "items": { + "type": "string" + } + }, + "synonyms_path": { + "type": "string" + }, + "synonyms_set": { + "type": "string" + }, + "tokenizer": { + "type": "string" + }, + "updateable": { + "type": "boolean" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:TrimTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "trim" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:TruncateTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "truncate" + ] + }, + "length": { + "type": "number" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:UniqueTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "unique" + ] + }, + "only_on_same_position": { + "type": "boolean" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:UppercaseTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "uppercase" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:WordDelimiterGraphTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "word_delimiter_graph" + ] + }, + "adjust_offsets": { + "type": "boolean" + }, + "catenate_all": { + "type": "boolean" + }, + "catenate_numbers": { + "type": "boolean" + }, + "catenate_words": { + "type": "boolean" + }, + "generate_number_parts": { + "type": "boolean" + }, + "generate_word_parts": { + "type": "boolean" + }, + "ignore_keywords": { + "type": "boolean" + }, + "preserve_original": { + "$ref": "#/components/schemas/_spec_utils:Stringifiedboolean" + }, + "protected_words": { + "type": "array", + "items": { + "type": "string" + } + }, + "protected_words_path": { + "type": "string" + }, + "split_on_case_change": { + "type": "boolean" + }, + "split_on_numerics": { + "type": "boolean" + }, + "stem_english_possessive": { + "type": "boolean" + }, + "type_table": { + "type": "array", + "items": { + "type": "string" + } + }, + "type_table_path": { + "type": "string" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:WordDelimiterTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "word_delimiter" + ] + }, + "catenate_all": { + "type": "boolean" + }, + "catenate_numbers": { + "type": "boolean" + }, + "catenate_words": { + "type": "boolean" + }, + "generate_number_parts": { + "type": "boolean" + }, + "generate_word_parts": { + "type": "boolean" + }, + "preserve_original": { + "$ref": "#/components/schemas/_spec_utils:Stringifiedboolean" + }, + "protected_words": { + "type": "array", + "items": { + "type": "string" + } + }, + "protected_words_path": { + "type": "string" + }, + "split_on_case_change": { + "type": "boolean" + }, + "split_on_numerics": { + "type": "boolean" + }, + "stem_english_possessive": { + "type": "boolean" + }, + "type_table": { + "type": "array", + "items": { + "type": "string" + } + }, + "type_table_path": { + "type": "string" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:KuromojiStemmerTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "kuromoji_stemmer" + ] + }, + "minimum_length": { + "type": "number" + } + }, + "required": [ + "type", + "minimum_length" + ] + } + ] + }, + "_types.analysis:KuromojiReadingFormTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "kuromoji_readingform" + ] + }, + "use_romaji": { + "type": "boolean" + } + }, + "required": [ + "type", + "use_romaji" + ] + } + ] + }, + "_types.analysis:KuromojiPartOfSpeechTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "kuromoji_part_of_speech" + ] + }, + "stoptags": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "type", + "stoptags" + ] + } + ] + }, + "_types.analysis:IcuCollationTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "icu_collation" + ] + }, + "alternate": { + "$ref": "#/components/schemas/_types.analysis:IcuCollationAlternate" + }, + "case_first": { + "$ref": "#/components/schemas/_types.analysis:IcuCollationCaseFirst" + }, + "case_level": { + "type": "boolean" + }, + "country": { + "type": "string" + }, + "decomposition": { + "$ref": "#/components/schemas/_types.analysis:IcuCollationDecomposition" + }, + "hiragana_quaternary_mode": { + "type": "boolean" + }, + "language": { + "type": "string" + }, + "numeric": { + "type": "boolean" + }, + "rules": { + "type": "string" + }, + "strength": { + "$ref": "#/components/schemas/_types.analysis:IcuCollationStrength" + }, + "variable_top": { + "type": "string" + }, + "variant": { + "type": "string" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:IcuCollationAlternate": { + "type": "string", + "enum": [ + "shifted", + "non-ignorable" + ] + }, + "_types.analysis:IcuCollationCaseFirst": { + "type": "string", + "enum": [ + "lower", + "upper" + ] + }, + "_types.analysis:IcuCollationDecomposition": { + "type": "string", + "enum": [ + "no", + "identical" + ] + }, + "_types.analysis:IcuCollationStrength": { + "type": "string", + "enum": [ + "primary", + "secondary", + "tertiary", + "quaternary", + "identical" + ] + }, + "_types.analysis:IcuFoldingTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "icu_folding" + ] + }, + "unicode_set_filter": { + "type": "string" + } + }, + "required": [ + "type", + "unicode_set_filter" + ] + } + ] + }, + "_types.analysis:IcuNormalizationTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "icu_normalizer" + ] + }, + "name": { + "$ref": "#/components/schemas/_types.analysis:IcuNormalizationType" + } + }, + "required": [ + "type", + "name" + ] + } + ] + }, + "_types.analysis:IcuTransformTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "icu_transform" + ] + }, + "dir": { + "$ref": "#/components/schemas/_types.analysis:IcuTransformDirection" + }, + "id": { + "type": "string" + } + }, + "required": [ + "type", + "id" + ] + } + ] + }, + "_types.analysis:IcuTransformDirection": { + "type": "string", + "enum": [ + "forward", + "reverse" + ] + }, + "_types.analysis:PhoneticTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "phonetic" + ] + }, + "encoder": { + "$ref": "#/components/schemas/_types.analysis:PhoneticEncoder" + }, + "languageset": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types.analysis:PhoneticLanguage" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.analysis:PhoneticLanguage" + } + } + ] + }, + "max_code_len": { + "type": "number" + }, + "name_type": { + "$ref": "#/components/schemas/_types.analysis:PhoneticNameType" + }, + "replace": { + "type": "boolean" + }, + "rule_type": { + "$ref": "#/components/schemas/_types.analysis:PhoneticRuleType" + } + }, + "required": [ + "type", + "encoder", + "languageset", + "name_type", + "rule_type" + ] + } + ] + }, + "_types.analysis:PhoneticEncoder": { + "type": "string", + "enum": [ + "metaphone", + "double_metaphone", + "soundex", + "refined_soundex", + "caverphone1", + "caverphone2", + "cologne", + "nysiis", + "koelnerphonetik", + "haasephonetik", + "beider_morse", + "daitch_mokotoff" + ] + }, + "_types.analysis:PhoneticLanguage": { + "type": "string", + "enum": [ + "any", + "common", + "cyrillic", + "english", + "french", + "german", + "hebrew", + "hungarian", + "polish", + "romanian", + "russian", + "spanish" + ] + }, + "_types.analysis:PhoneticNameType": { + "type": "string", + "enum": [ + "generic", + "ashkenazi", + "sephardic" + ] + }, + "_types.analysis:PhoneticRuleType": { + "type": "string", + "enum": [ + "approx", + "exact" + ] + }, + "_types.analysis:DictionaryDecompounderTokenFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:CompoundWordTokenFilterBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "dictionary_decompounder" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:Normalizer": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-normalizers.html" + }, + "discriminator": { + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/_types.analysis:LowercaseNormalizer" + }, + { + "$ref": "#/components/schemas/_types.analysis:CustomNormalizer" + } + ] + }, + "_types.analysis:LowercaseNormalizer": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "lowercase" + ] + } + }, + "required": [ + "type" + ] + }, + "_types.analysis:CustomNormalizer": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "custom" + ] + }, + "char_filter": { + "type": "array", + "items": { + "type": "string" + } + }, + "filter": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "type" + ] + }, + "_types.analysis:Tokenizer": { + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/_types.analysis:TokenizerDefinition" + } + ] + }, + "_types.analysis:TokenizerDefinition": { + "discriminator": { + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/_types.analysis:CharGroupTokenizer" + }, + { + "$ref": "#/components/schemas/_types.analysis:EdgeNGramTokenizer" + }, + { + "$ref": "#/components/schemas/_types.analysis:KeywordTokenizer" + }, + { + "$ref": "#/components/schemas/_types.analysis:LetterTokenizer" + }, + { + "$ref": "#/components/schemas/_types.analysis:LowercaseTokenizer" + }, + { + "$ref": "#/components/schemas/_types.analysis:NGramTokenizer" + }, + { + "$ref": "#/components/schemas/_types.analysis:NoriTokenizer" + }, + { + "$ref": "#/components/schemas/_types.analysis:PathHierarchyTokenizer" + }, + { + "$ref": "#/components/schemas/_types.analysis:StandardTokenizer" + }, + { + "$ref": "#/components/schemas/_types.analysis:UaxEmailUrlTokenizer" + }, + { + "$ref": "#/components/schemas/_types.analysis:WhitespaceTokenizer" + }, + { + "$ref": "#/components/schemas/_types.analysis:KuromojiTokenizer" + }, + { + "$ref": "#/components/schemas/_types.analysis:PatternTokenizer" + }, + { + "$ref": "#/components/schemas/_types.analysis:IcuTokenizer" + } + ] + }, + "_types.analysis:CharGroupTokenizer": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenizerBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "char_group" + ] + }, + "tokenize_on_chars": { + "type": "array", + "items": { + "type": "string" + } + }, + "max_token_length": { + "type": "number" + } + }, + "required": [ + "type", + "tokenize_on_chars" + ] + } + ] + }, + "_types.analysis:TokenizerBase": { + "type": "object", + "properties": { + "version": { + "$ref": "#/components/schemas/_types:VersionString" + } + } + }, + "_types.analysis:EdgeNGramTokenizer": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenizerBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "edge_ngram" + ] + }, + "custom_token_chars": { + "type": "string" + }, + "max_gram": { + "type": "number" + }, + "min_gram": { + "type": "number" + }, + "token_chars": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.analysis:TokenChar" + } + } + }, + "required": [ + "type", + "max_gram", + "min_gram", + "token_chars" + ] + } + ] + }, + "_types.analysis:TokenChar": { + "type": "string", + "enum": [ + "letter", + "digit", + "whitespace", + "punctuation", + "symbol", + "custom" + ] + }, + "_types.analysis:KeywordTokenizer": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenizerBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "keyword" + ] + }, + "buffer_size": { + "type": "number" + } + }, + "required": [ + "type", + "buffer_size" + ] + } + ] + }, + "_types.analysis:LetterTokenizer": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenizerBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "letter" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:LowercaseTokenizer": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenizerBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "lowercase" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:NGramTokenizer": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenizerBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "ngram" + ] + }, + "custom_token_chars": { + "type": "string" + }, + "max_gram": { + "type": "number" + }, + "min_gram": { + "type": "number" + }, + "token_chars": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.analysis:TokenChar" + } + } + }, + "required": [ + "type", + "max_gram", + "min_gram", + "token_chars" + ] + } + ] + }, + "_types.analysis:NoriTokenizer": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenizerBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "nori_tokenizer" + ] + }, + "decompound_mode": { + "$ref": "#/components/schemas/_types.analysis:NoriDecompoundMode" + }, + "discard_punctuation": { + "type": "boolean" + }, + "user_dictionary": { + "type": "string" + }, + "user_dictionary_rules": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:PathHierarchyTokenizer": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenizerBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "path_hierarchy" + ] + }, + "buffer_size": { + "$ref": "#/components/schemas/_spec_utils:Stringifiedinteger" + }, + "delimiter": { + "type": "string" + }, + "replacement": { + "type": "string" + }, + "reverse": { + "$ref": "#/components/schemas/_spec_utils:Stringifiedboolean" + }, + "skip": { + "$ref": "#/components/schemas/_spec_utils:Stringifiedinteger" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:StandardTokenizer": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenizerBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "standard" + ] + }, + "max_token_length": { + "type": "number" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:UaxEmailUrlTokenizer": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenizerBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "uax_url_email" + ] + }, + "max_token_length": { + "type": "number" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:WhitespaceTokenizer": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenizerBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "whitespace" + ] + }, + "max_token_length": { + "type": "number" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:KuromojiTokenizer": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenizerBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "kuromoji_tokenizer" + ] + }, + "discard_punctuation": { + "type": "boolean" + }, + "mode": { + "$ref": "#/components/schemas/_types.analysis:KuromojiTokenizationMode" + }, + "nbest_cost": { + "type": "number" + }, + "nbest_examples": { + "type": "string" + }, + "user_dictionary": { + "type": "string" + }, + "user_dictionary_rules": { + "type": "array", + "items": { + "type": "string" + } + }, + "discard_compound_token": { + "type": "boolean" + } + }, + "required": [ + "type", + "mode" + ] + } + ] + }, + "_types.analysis:PatternTokenizer": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenizerBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "pattern" + ] + }, + "flags": { + "type": "string" + }, + "group": { + "type": "number" + }, + "pattern": { + "type": "string" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.analysis:IcuTokenizer": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.analysis:TokenizerBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "icu_tokenizer" + ] + }, + "rule_files": { + "type": "string" + } + }, + "required": [ + "type", + "rule_files" + ] + } + ] + }, + "indices._types:IndexSettingsTimeSeries": { + "type": "object", + "properties": { + "end_time": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "start_time": { + "$ref": "#/components/schemas/_types:DateTime" + } + } + }, + "indices._types:Queries": { + "type": "object", + "properties": { + "cache": { + "$ref": "#/components/schemas/indices._types:CacheQueries" + } + } + }, + "indices._types:CacheQueries": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "required": [ + "enabled" + ] + }, + "indices._types:SettingsSimilarity": { + "discriminator": { + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/indices._types:SettingsSimilarityBm25" + }, + { + "$ref": "#/components/schemas/indices._types:SettingsSimilarityBoolean" + }, + { + "$ref": "#/components/schemas/indices._types:SettingsSimilarityDfi" + }, + { + "$ref": "#/components/schemas/indices._types:SettingsSimilarityDfr" + }, + { + "$ref": "#/components/schemas/indices._types:SettingsSimilarityIb" + }, + { + "$ref": "#/components/schemas/indices._types:SettingsSimilarityLmd" + }, + { + "$ref": "#/components/schemas/indices._types:SettingsSimilarityLmj" + }, + { + "$ref": "#/components/schemas/indices._types:SettingsSimilarityScripted" + } + ] + }, + "indices._types:SettingsSimilarityBm25": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "BM25" + ] + }, + "b": { + "type": "number" + }, + "discount_overlaps": { + "type": "boolean" + }, + "k1": { + "type": "number" + } + }, + "required": [ + "type" + ] + }, + "indices._types:SettingsSimilarityBoolean": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "boolean" + ] + } + }, + "required": [ + "type" + ] + }, + "indices._types:SettingsSimilarityDfi": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "DFI" + ] + }, + "independence_measure": { + "$ref": "#/components/schemas/_types:DFIIndependenceMeasure" + } + }, + "required": [ + "type", + "independence_measure" + ] + }, + "_types:DFIIndependenceMeasure": { + "type": "string", + "enum": [ + "standardized", + "saturated", + "chisquared" + ] + }, + "indices._types:SettingsSimilarityDfr": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "DFR" + ] + }, + "after_effect": { + "$ref": "#/components/schemas/_types:DFRAfterEffect" + }, + "basic_model": { + "$ref": "#/components/schemas/_types:DFRBasicModel" + }, + "normalization": { + "$ref": "#/components/schemas/_types:Normalization" + } + }, + "required": [ + "type", + "after_effect", + "basic_model", + "normalization" + ] + }, + "_types:DFRAfterEffect": { + "type": "string", + "enum": [ + "no", + "b", + "l" + ] + }, + "_types:DFRBasicModel": { + "type": "string", + "enum": [ + "be", + "d", + "g", + "if", + "in", + "ine", + "p" + ] + }, + "_types:Normalization": { + "type": "string", + "enum": [ + "no", + "h1", + "h2", + "h3", + "z" + ] + }, + "indices._types:SettingsSimilarityIb": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "IB" + ] + }, + "distribution": { + "$ref": "#/components/schemas/_types:IBDistribution" + }, + "lambda": { + "$ref": "#/components/schemas/_types:IBLambda" + }, + "normalization": { + "$ref": "#/components/schemas/_types:Normalization" + } + }, + "required": [ + "type", + "distribution", + "lambda", + "normalization" + ] + }, + "_types:IBDistribution": { + "type": "string", + "enum": [ + "ll", + "spl" + ] + }, + "_types:IBLambda": { + "type": "string", + "enum": [ + "df", + "ttf" + ] + }, + "indices._types:SettingsSimilarityLmd": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "LMDirichlet" + ] + }, + "mu": { + "type": "number" + } + }, + "required": [ + "type" + ] + }, + "indices._types:SettingsSimilarityLmj": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "LMJelinekMercer" + ] + }, + "lambda": { + "type": "number" + } + }, + "required": [ + "type" + ] + }, + "indices._types:SettingsSimilarityScripted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "scripted" + ] + }, + "script": { + "$ref": "#/components/schemas/_types:Script" + }, + "weight_script": { + "$ref": "#/components/schemas/_types:Script" + } + }, + "required": [ + "type", + "script" + ] + }, + "indices._types:MappingLimitSettings": { + "type": "object", + "properties": { + "coerce": { + "type": "boolean" + }, + "total_fields": { + "$ref": "#/components/schemas/indices._types:MappingLimitSettingsTotalFields" + }, + "depth": { + "$ref": "#/components/schemas/indices._types:MappingLimitSettingsDepth" + }, + "nested_fields": { + "$ref": "#/components/schemas/indices._types:MappingLimitSettingsNestedFields" + }, + "nested_objects": { + "$ref": "#/components/schemas/indices._types:MappingLimitSettingsNestedObjects" + }, + "field_name_length": { + "$ref": "#/components/schemas/indices._types:MappingLimitSettingsFieldNameLength" + }, + "dimension_fields": { + "$ref": "#/components/schemas/indices._types:MappingLimitSettingsDimensionFields" + }, + "ignore_malformed": { + "type": "boolean" + } + } + }, + "indices._types:MappingLimitSettingsTotalFields": { + "type": "object", + "properties": { + "limit": { + "description": "The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit.\nThe limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance\ndegradations and memory issues, especially in clusters with a high load or few resources.", + "type": "number" + }, + "ignore_dynamic_beyond_limit": { + "description": "This setting determines what happens when a dynamically mapped field would exceed the total fields limit. When set\nto false (the default), the index request of the document that tries to add a dynamic field to the mapping will fail\nwith the message Limit of total fields [X] has been exceeded. When set to true, the index request will not fail.\nInstead, fields that would exceed the limit are not added to the mapping, similar to dynamic: false.\nThe fields that were not added to the mapping will be added to the _ignored field.", + "type": "boolean" + } + } + }, + "indices._types:MappingLimitSettingsDepth": { + "type": "object", + "properties": { + "limit": { + "description": "The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined\nat the root object level, then the depth is 1. If there is one object mapping, then the depth is 2, etc.", + "type": "number" + } + } + }, + "indices._types:MappingLimitSettingsNestedFields": { + "type": "object", + "properties": { + "limit": { + "description": "The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when\narrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this\nsetting limits the number of unique nested types per index.", + "type": "number" + } + } + }, + "indices._types:MappingLimitSettingsNestedObjects": { + "type": "object", + "properties": { + "limit": { + "description": "The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps\nto prevent out of memory errors when a document contains too many nested objects.", + "type": "number" + } + } + }, + "indices._types:MappingLimitSettingsFieldNameLength": { + "type": "object", + "properties": { + "limit": { + "description": "Setting for the maximum length of a field name. This setting isn’t really something that addresses mappings explosion but\nmight still be useful if you want to limit the field length. It usually shouldn’t be necessary to set this setting. The\ndefault is okay unless a user starts to add a huge number of fields with really long names. Default is `Long.MAX_VALUE` (no limit).", + "type": "number" + } + } + }, + "indices._types:MappingLimitSettingsDimensionFields": { + "type": "object", + "properties": { + "limit": { + "description": "[preview] This functionality is in technical preview and may be changed or removed in a future release.\nElastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.", + "type": "number" + } + } + }, + "indices._types:IndexingSlowlogSettings": { + "type": "object", + "properties": { + "level": { + "type": "string" + }, + "source": { + "type": "number" + }, + "reformat": { + "type": "boolean" + }, + "threshold": { + "$ref": "#/components/schemas/indices._types:IndexingSlowlogTresholds" + } + } + }, + "indices._types:IndexingSlowlogTresholds": { + "type": "object", + "properties": { + "index": { + "$ref": "#/components/schemas/indices._types:SlowlogTresholdLevels" + } + } + }, + "indices._types:IndexingPressure": { + "type": "object", + "properties": { + "memory": { + "$ref": "#/components/schemas/indices._types:IndexingPressureMemory" + } + }, + "required": [ + "memory" + ] + }, + "indices._types:IndexingPressureMemory": { + "type": "object", + "properties": { + "limit": { + "description": "Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded,\nthe node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit,\nthe node will reject new replica operations. Defaults to 10% of the heap.", + "type": "number" + } + } + }, + "indices._types:Storage": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/indices._types:StorageType" + }, + "allow_mmap": { + "description": "You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap.\nThis is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This\nsetting is useful, for example, if you are in an environment where you can not control the ability to create a lot\nof memory maps so you need disable the ability to use memory-mapping.", + "type": "boolean" + } + }, + "required": [ + "type" + ] + }, + "indices._types:StorageType": { + "anyOf": [ + { + "type": "string", + "enum": [ + "fs", + "niofs", + "mmapfs", + "hybridfs" + ] + }, + { + "type": "string" + } + ] + }, + "_types.mapping:TypeMapping": { + "type": "object", + "properties": { + "all_field": { + "$ref": "#/components/schemas/_types.mapping:AllField" + }, + "date_detection": { + "type": "boolean" + }, + "dynamic": { + "$ref": "#/components/schemas/_types.mapping:DynamicMapping" + }, + "dynamic_date_formats": { + "type": "array", + "items": { + "type": "string" + } + }, + "dynamic_templates": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.mapping:DynamicTemplate" + } + } + }, + "_field_names": { + "$ref": "#/components/schemas/_types.mapping:FieldNamesField" + }, + "index_field": { + "$ref": "#/components/schemas/_types.mapping:IndexField" + }, + "_meta": { + "$ref": "#/components/schemas/_types:Metadata" + }, + "numeric_detection": { + "type": "boolean" + }, + "properties": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.mapping:Property" + } + }, + "_routing": { + "$ref": "#/components/schemas/_types.mapping:RoutingField" + }, + "_size": { + "$ref": "#/components/schemas/_types.mapping:SizeField" + }, + "_source": { + "$ref": "#/components/schemas/_types.mapping:SourceField" + }, + "runtime": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.mapping:RuntimeField" + } + }, + "enabled": { + "type": "boolean" + }, + "subobjects": { + "type": "boolean" + }, + "_data_stream_timestamp": { + "$ref": "#/components/schemas/_types.mapping:DataStreamTimestamp" + } + } + }, + "_types.mapping:AllField": { + "type": "object", + "properties": { + "analyzer": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "omit_norms": { + "type": "boolean" + }, + "search_analyzer": { + "type": "string" + }, + "similarity": { + "type": "string" + }, + "store": { + "type": "boolean" + }, + "store_term_vector_offsets": { + "type": "boolean" + }, + "store_term_vector_payloads": { + "type": "boolean" + }, + "store_term_vector_positions": { + "type": "boolean" + }, + "store_term_vectors": { + "type": "boolean" + } + }, + "required": [ + "analyzer", + "enabled", + "omit_norms", + "search_analyzer", + "similarity", + "store", + "store_term_vector_offsets", + "store_term_vector_payloads", + "store_term_vector_positions", + "store_term_vectors" + ] + }, + "_types.mapping:DynamicMapping": { + "type": "string", + "enum": [ + "strict", + "runtime", + "true", + "false" + ] + }, + "_types.mapping:DynamicTemplate": { + "allOf": [ + { + "type": "object", + "properties": { + "match": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "path_match": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "unmatch": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "path_unmatch": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "match_mapping_type": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "unmatch_mapping_type": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "match_pattern": { + "$ref": "#/components/schemas/_types.mapping:MatchType" + } + } + }, + { + "type": "object", + "properties": { + "mapping": { + "$ref": "#/components/schemas/_types.mapping:Property" + }, + "runtime": { + "$ref": "#/components/schemas/_types.mapping:Property" + } + }, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "_types.mapping:Property": { + "discriminator": { + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/_types.mapping:BinaryProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:BooleanProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:DynamicProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:JoinProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:KeywordProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:MatchOnlyTextProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:PercolatorProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:RankFeatureProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:RankFeaturesProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:SearchAsYouTypeProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:TextProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:VersionProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:WildcardProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:DateNanosProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:DateProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:AggregateMetricDoubleProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:DenseVectorProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:FlattenedProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:NestedProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:ObjectProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:SemanticTextProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:SparseVectorProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:CompletionProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:ConstantKeywordProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:FieldAliasProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:HistogramProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:IpProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:Murmur3HashProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:TokenCountProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:GeoPointProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:GeoShapeProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:PointProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:ShapeProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:ByteNumberProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:DoubleNumberProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:FloatNumberProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:HalfFloatNumberProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:IntegerNumberProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:LongNumberProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:ScaledFloatNumberProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:ShortNumberProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:UnsignedLongNumberProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:DateRangeProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:DoubleRangeProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:FloatRangeProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:IntegerRangeProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:IpRangeProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:LongRangeProperty" + }, + { + "$ref": "#/components/schemas/_types.mapping:IcuCollationProperty" + } + ] + }, + "_types.mapping:BinaryProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:DocValuesPropertyBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "binary" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:DocValuesPropertyBase": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:CorePropertyBase" + }, + { + "type": "object", + "properties": { + "doc_values": { + "type": "boolean" + } + } + } + ] + }, + "_types.mapping:CorePropertyBase": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:PropertyBase" + }, + { + "type": "object", + "properties": { + "copy_to": { + "$ref": "#/components/schemas/_types:Fields" + }, + "similarity": { + "type": "string" + }, + "store": { + "type": "boolean" + } + } + } + ] + }, + "_types.mapping:PropertyBase": { + "type": "object", + "properties": { + "meta": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html" + }, + "description": "Metadata about the field.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.mapping:Property" + } + }, + "ignore_above": { + "type": "number" + }, + "dynamic": { + "$ref": "#/components/schemas/_types.mapping:DynamicMapping" + }, + "fields": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.mapping:Property" + } + } + } + }, + "_types.mapping:BooleanProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:DocValuesPropertyBase" + }, + { + "type": "object", + "properties": { + "boost": { + "type": "number" + }, + "fielddata": { + "$ref": "#/components/schemas/indices._types:NumericFielddata" + }, + "index": { + "type": "boolean" + }, + "null_value": { + "type": "boolean" + }, + "type": { + "type": "string", + "enum": [ + "boolean" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "indices._types:NumericFielddata": { + "type": "object", + "properties": { + "format": { + "$ref": "#/components/schemas/indices._types:NumericFielddataFormat" + } + }, + "required": [ + "format" + ] + }, + "indices._types:NumericFielddataFormat": { + "type": "string", + "enum": [ + "array", + "disabled" + ] + }, + "_types.mapping:DynamicProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:DocValuesPropertyBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "{dynamic_type}" + ] + }, + "enabled": { + "type": "boolean" + }, + "null_value": { + "$ref": "#/components/schemas/_types:FieldValue" + }, + "boost": { + "type": "number" + }, + "coerce": { + "type": "boolean" + }, + "script": { + "$ref": "#/components/schemas/_types:Script" + }, + "on_script_error": { + "$ref": "#/components/schemas/_types.mapping:OnScriptError" + }, + "ignore_malformed": { + "type": "boolean" + }, + "time_series_metric": { + "$ref": "#/components/schemas/_types.mapping:TimeSeriesMetricType" + }, + "analyzer": { + "type": "string" + }, + "eager_global_ordinals": { + "type": "boolean" + }, + "index": { + "type": "boolean" + }, + "index_options": { + "$ref": "#/components/schemas/_types.mapping:IndexOptions" + }, + "index_phrases": { + "type": "boolean" + }, + "index_prefixes": { + "$ref": "#/components/schemas/_types.mapping:TextIndexPrefixes" + }, + "norms": { + "type": "boolean" + }, + "position_increment_gap": { + "type": "number" + }, + "search_analyzer": { + "type": "string" + }, + "search_quote_analyzer": { + "type": "string" + }, + "term_vector": { + "$ref": "#/components/schemas/_types.mapping:TermVectorOption" + }, + "format": { + "type": "string" + }, + "precision_step": { + "type": "number" + }, + "locale": { + "type": "string" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:OnScriptError": { + "type": "string", + "enum": [ + "fail", + "continue" + ] + }, + "_types.mapping:TimeSeriesMetricType": { + "type": "string", + "enum": [ + "gauge", + "counter", + "summary", + "histogram", + "position" + ] + }, + "_types.mapping:IndexOptions": { + "type": "string", + "enum": [ + "docs", + "freqs", + "positions", + "offsets" + ] + }, + "_types.mapping:TextIndexPrefixes": { + "type": "object", + "properties": { + "max_chars": { + "type": "number" + }, + "min_chars": { + "type": "number" + } + }, + "required": [ + "max_chars", + "min_chars" + ] + }, + "_types.mapping:TermVectorOption": { + "type": "string", + "enum": [ + "no", + "yes", + "with_offsets", + "with_positions", + "with_positions_offsets", + "with_positions_offsets_payloads", + "with_positions_payloads" + ] + }, + "_types.mapping:JoinProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:PropertyBase" + }, + { + "type": "object", + "properties": { + "relations": { + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types:RelationName" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:RelationName" + } + } + ] + } + }, + "eager_global_ordinals": { + "type": "boolean" + }, + "type": { + "type": "string", + "enum": [ + "join" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:KeywordProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:DocValuesPropertyBase" + }, + { + "type": "object", + "properties": { + "boost": { + "type": "number" + }, + "eager_global_ordinals": { + "type": "boolean" + }, + "index": { + "type": "boolean" + }, + "index_options": { + "$ref": "#/components/schemas/_types.mapping:IndexOptions" + }, + "script": { + "$ref": "#/components/schemas/_types:Script" + }, + "on_script_error": { + "$ref": "#/components/schemas/_types.mapping:OnScriptError" + }, + "normalizer": { + "type": "string" + }, + "norms": { + "type": "boolean" + }, + "null_value": { + "type": "string" + }, + "split_queries_on_whitespace": { + "type": "boolean" + }, + "time_series_dimension": { + "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.", + "x-technical-preview": true, + "type": "boolean" + }, + "type": { + "type": "string", + "enum": [ + "keyword" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:MatchOnlyTextProperty": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "match_only_text" + ] + }, + "fields": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/multi-fields.html" + }, + "description": "Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one\nfield for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.mapping:Property" + } + }, + "meta": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html" + }, + "description": "Metadata about the field.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "copy_to": { + "$ref": "#/components/schemas/_types:Fields" + } + }, + "required": [ + "type" + ] + }, + "_types.mapping:PercolatorProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:PropertyBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "percolator" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:RankFeatureProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:PropertyBase" + }, + { + "type": "object", + "properties": { + "positive_score_impact": { + "type": "boolean" + }, + "type": { + "type": "string", + "enum": [ + "rank_feature" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:RankFeaturesProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:PropertyBase" + }, + { + "type": "object", + "properties": { + "positive_score_impact": { + "type": "boolean" + }, + "type": { + "type": "string", + "enum": [ + "rank_features" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:SearchAsYouTypeProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:CorePropertyBase" + }, + { + "type": "object", + "properties": { + "analyzer": { + "type": "string" + }, + "index": { + "type": "boolean" + }, + "index_options": { + "$ref": "#/components/schemas/_types.mapping:IndexOptions" + }, + "max_shingle_size": { + "type": "number" + }, + "norms": { + "type": "boolean" + }, + "search_analyzer": { + "type": "string" + }, + "search_quote_analyzer": { + "type": "string" + }, + "term_vector": { + "$ref": "#/components/schemas/_types.mapping:TermVectorOption" + }, + "type": { + "type": "string", + "enum": [ + "search_as_you_type" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:TextProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:CorePropertyBase" + }, + { + "type": "object", + "properties": { + "analyzer": { + "type": "string" + }, + "boost": { + "type": "number" + }, + "eager_global_ordinals": { + "type": "boolean" + }, + "fielddata": { + "type": "boolean" + }, + "fielddata_frequency_filter": { + "$ref": "#/components/schemas/indices._types:FielddataFrequencyFilter" + }, + "index": { + "type": "boolean" + }, + "index_options": { + "$ref": "#/components/schemas/_types.mapping:IndexOptions" + }, + "index_phrases": { + "type": "boolean" + }, + "index_prefixes": { + "$ref": "#/components/schemas/_types.mapping:TextIndexPrefixes" + }, + "norms": { + "type": "boolean" + }, + "position_increment_gap": { + "type": "number" + }, + "search_analyzer": { + "type": "string" + }, + "search_quote_analyzer": { + "type": "string" + }, + "term_vector": { + "$ref": "#/components/schemas/_types.mapping:TermVectorOption" + }, + "type": { + "type": "string", + "enum": [ + "text" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "indices._types:FielddataFrequencyFilter": { + "type": "object", + "properties": { + "max": { + "type": "number" + }, + "min": { + "type": "number" + }, + "min_segment_size": { + "type": "number" + } + }, + "required": [ + "max", + "min", + "min_segment_size" + ] + }, + "_types.mapping:VersionProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:DocValuesPropertyBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "version" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:WildcardProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:DocValuesPropertyBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "wildcard" + ] + }, + "null_value": { + "x-available-since": "7.15.0", + "type": "string" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:DateNanosProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:DocValuesPropertyBase" + }, + { + "type": "object", + "properties": { + "boost": { + "type": "number" + }, + "format": { + "type": "string" + }, + "ignore_malformed": { + "type": "boolean" + }, + "index": { + "type": "boolean" + }, + "null_value": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "precision_step": { + "type": "number" + }, + "type": { + "type": "string", + "enum": [ + "date_nanos" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:DateProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:DocValuesPropertyBase" + }, + { + "type": "object", + "properties": { + "boost": { + "type": "number" + }, + "fielddata": { + "$ref": "#/components/schemas/indices._types:NumericFielddata" + }, + "format": { + "type": "string" + }, + "ignore_malformed": { + "type": "boolean" + }, + "index": { + "type": "boolean" + }, + "null_value": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "precision_step": { + "type": "number" + }, + "locale": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "date" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:AggregateMetricDoubleProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:PropertyBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "aggregate_metric_double" + ] + }, + "default_metric": { + "type": "string" + }, + "metrics": { + "type": "array", + "items": { + "type": "string" + } + }, + "time_series_metric": { + "$ref": "#/components/schemas/_types.mapping:TimeSeriesMetricType" + } + }, + "required": [ + "type", + "default_metric", + "metrics" + ] + } + ] + }, + "_types.mapping:DenseVectorProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:PropertyBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "dense_vector" + ] + }, + "element_type": { + "type": "string" + }, + "dims": { + "type": "number" + }, + "similarity": { + "type": "string" + }, + "index": { + "type": "boolean" + }, + "index_options": { + "$ref": "#/components/schemas/_types.mapping:DenseVectorIndexOptions" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:DenseVectorIndexOptions": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "m": { + "type": "number" + }, + "ef_construction": { + "type": "number" + }, + "confidence_interval": { + "type": "number" + } + }, + "required": [ + "type" + ] + }, + "_types.mapping:FlattenedProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:PropertyBase" + }, + { + "type": "object", + "properties": { + "boost": { + "type": "number" + }, + "depth_limit": { + "type": "number" + }, + "doc_values": { + "type": "boolean" + }, + "eager_global_ordinals": { + "type": "boolean" + }, + "index": { + "type": "boolean" + }, + "index_options": { + "$ref": "#/components/schemas/_types.mapping:IndexOptions" + }, + "null_value": { + "type": "string" + }, + "similarity": { + "type": "string" + }, + "split_queries_on_whitespace": { + "type": "boolean" + }, + "type": { + "type": "string", + "enum": [ + "flattened" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:NestedProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:CorePropertyBase" + }, + { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "include_in_parent": { + "type": "boolean" + }, + "include_in_root": { + "type": "boolean" + }, + "type": { + "type": "string", + "enum": [ + "nested" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:ObjectProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:CorePropertyBase" + }, + { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "subobjects": { + "type": "boolean" + }, + "type": { + "type": "string", + "enum": [ + "object" + ] + } + } + } + ] + }, + "_types.mapping:SemanticTextProperty": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "semantic_text" + ] + }, + "meta": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "inference_id": { + "$ref": "#/components/schemas/_types:Id" + } + }, + "required": [ + "type", + "inference_id" + ] + }, + "_types.mapping:SparseVectorProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:PropertyBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "sparse_vector" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:CompletionProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:DocValuesPropertyBase" + }, + { + "type": "object", + "properties": { + "analyzer": { + "type": "string" + }, + "contexts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.mapping:SuggestContext" + } + }, + "max_input_length": { + "type": "number" + }, + "preserve_position_increments": { + "type": "boolean" + }, + "preserve_separators": { + "type": "boolean" + }, + "search_analyzer": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "completion" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:SuggestContext": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/_types:Name" + }, + "path": { + "$ref": "#/components/schemas/_types:Field" + }, + "type": { + "type": "string" + }, + "precision": { + "oneOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + } + }, + "required": [ + "name", + "type" + ] + }, + "_types.mapping:ConstantKeywordProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:PropertyBase" + }, + { + "type": "object", + "properties": { + "value": { + "type": "object" + }, + "type": { + "type": "string", + "enum": [ + "constant_keyword" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:FieldAliasProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:PropertyBase" + }, + { + "type": "object", + "properties": { + "path": { + "$ref": "#/components/schemas/_types:Field" + }, + "type": { + "type": "string", + "enum": [ + "alias" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:HistogramProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:PropertyBase" + }, + { + "type": "object", + "properties": { + "ignore_malformed": { + "type": "boolean" + }, + "type": { + "type": "string", + "enum": [ + "histogram" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:IpProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:DocValuesPropertyBase" + }, + { + "type": "object", + "properties": { + "boost": { + "type": "number" + }, + "index": { + "type": "boolean" + }, + "ignore_malformed": { + "type": "boolean" + }, + "null_value": { + "type": "string" + }, + "on_script_error": { + "$ref": "#/components/schemas/_types.mapping:OnScriptError" + }, + "script": { + "$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.", + "x-technical-preview": true, + "type": "boolean" + }, + "type": { + "type": "string", + "enum": [ + "ip" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:Murmur3HashProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:DocValuesPropertyBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "murmur3" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:TokenCountProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:DocValuesPropertyBase" + }, + { + "type": "object", + "properties": { + "analyzer": { + "type": "string" + }, + "boost": { + "type": "number" + }, + "index": { + "type": "boolean" + }, + "null_value": { + "type": "number" + }, + "enable_position_increments": { + "type": "boolean" + }, + "type": { + "type": "string", + "enum": [ + "token_count" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:GeoPointProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:DocValuesPropertyBase" + }, + { + "type": "object", + "properties": { + "ignore_malformed": { + "type": "boolean" + }, + "ignore_z_value": { + "type": "boolean" + }, + "null_value": { + "$ref": "#/components/schemas/_types:GeoLocation" + }, + "index": { + "type": "boolean" + }, + "on_script_error": { + "$ref": "#/components/schemas/_types.mapping:OnScriptError" + }, + "script": { + "$ref": "#/components/schemas/_types:Script" + }, + "type": { + "type": "string", + "enum": [ + "geo_point" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:GeoShapeProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:DocValuesPropertyBase" + }, + { + "type": "object", + "properties": { + "coerce": { + "type": "boolean" + }, + "ignore_malformed": { + "type": "boolean" + }, + "ignore_z_value": { + "type": "boolean" + }, + "orientation": { + "$ref": "#/components/schemas/_types.mapping:GeoOrientation" + }, + "strategy": { + "$ref": "#/components/schemas/_types.mapping:GeoStrategy" + }, + "type": { + "type": "string", + "enum": [ + "geo_shape" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:GeoOrientation": { + "type": "string", + "enum": [ + "right", + "RIGHT", + "counterclockwise", + "ccw", + "left", + "LEFT", + "clockwise", + "cw" + ] + }, + "_types.mapping:GeoStrategy": { + "type": "string", + "enum": [ + "recursive", + "term" + ] + }, + "_types.mapping:PointProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:DocValuesPropertyBase" + }, + { + "type": "object", + "properties": { + "ignore_malformed": { + "type": "boolean" + }, + "ignore_z_value": { + "type": "boolean" + }, + "null_value": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "point" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:ShapeProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:DocValuesPropertyBase" + }, + { + "type": "object", + "properties": { + "coerce": { + "type": "boolean" + }, + "ignore_malformed": { + "type": "boolean" + }, + "ignore_z_value": { + "type": "boolean" + }, + "orientation": { + "$ref": "#/components/schemas/_types.mapping:GeoOrientation" + }, + "type": { + "type": "string", + "enum": [ + "shape" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:ByteNumberProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:NumberPropertyBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "byte" + ] + }, + "null_value": { + "$ref": "#/components/schemas/_types:byte" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types:byte": { + "type": "number" + }, + "_types.mapping:NumberPropertyBase": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:DocValuesPropertyBase" + }, + { + "type": "object", + "properties": { + "boost": { + "type": "number" + }, + "coerce": { + "type": "boolean" + }, + "ignore_malformed": { + "type": "boolean" + }, + "index": { + "type": "boolean" + }, + "on_script_error": { + "$ref": "#/components/schemas/_types.mapping:OnScriptError" + }, + "script": { + "$ref": "#/components/schemas/_types:Script" + }, + "time_series_metric": { + "$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.", + "x-technical-preview": true, + "type": "boolean" + } + } + } + ] + }, + "_types.mapping:DoubleNumberProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:NumberPropertyBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "double" + ] + }, + "null_value": { + "type": "number" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:FloatNumberProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:NumberPropertyBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "float" + ] + }, + "null_value": { + "type": "number" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:HalfFloatNumberProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:NumberPropertyBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "half_float" + ] + }, + "null_value": { + "type": "number" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:IntegerNumberProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:NumberPropertyBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "integer" + ] + }, + "null_value": { + "type": "number" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:LongNumberProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:NumberPropertyBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "long" + ] + }, + "null_value": { + "type": "number" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:ScaledFloatNumberProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:NumberPropertyBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "scaled_float" + ] + }, + "null_value": { + "type": "number" + }, + "scaling_factor": { + "type": "number" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:ShortNumberProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:NumberPropertyBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "short" + ] + }, + "null_value": { + "$ref": "#/components/schemas/_types:short" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types:short": { + "type": "number" + }, + "_types.mapping:UnsignedLongNumberProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:NumberPropertyBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "unsigned_long" + ] + }, + "null_value": { + "$ref": "#/components/schemas/_types:ulong" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types:ulong": { + "type": "number" + }, + "_types.mapping:DateRangeProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:RangePropertyBase" + }, + { + "type": "object", + "properties": { + "format": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "date_range" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:RangePropertyBase": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:DocValuesPropertyBase" + }, + { + "type": "object", + "properties": { + "boost": { + "type": "number" + }, + "coerce": { + "type": "boolean" + }, + "index": { + "type": "boolean" + } + } + } + ] + }, + "_types.mapping:DoubleRangeProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:RangePropertyBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "double_range" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:FloatRangeProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:RangePropertyBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "float_range" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:IntegerRangeProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:RangePropertyBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "integer_range" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:IpRangeProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:RangePropertyBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "ip_range" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:LongRangeProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:RangePropertyBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "long_range" + ] + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:IcuCollationProperty": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.mapping:DocValuesPropertyBase" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "icu_collation_keyword" + ] + }, + "norms": { + "type": "boolean" + }, + "index_options": { + "$ref": "#/components/schemas/_types.mapping:IndexOptions" + }, + "index": { + "description": "Should the field be searchable?", + "type": "boolean" + }, + "null_value": { + "description": "Accepts a string value which is substituted for any explicit null values. Defaults to null, which means the field is treated as missing.", + "type": "string" + }, + "rules": { + "type": "string" + }, + "language": { + "type": "string" + }, + "country": { + "type": "string" + }, + "variant": { + "type": "string" + }, + "strength": { + "$ref": "#/components/schemas/_types.analysis:IcuCollationStrength" + }, + "decomposition": { + "$ref": "#/components/schemas/_types.analysis:IcuCollationDecomposition" + }, + "alternate": { + "$ref": "#/components/schemas/_types.analysis:IcuCollationAlternate" + }, + "case_level": { + "type": "boolean" + }, + "case_first": { + "$ref": "#/components/schemas/_types.analysis:IcuCollationCaseFirst" + }, + "numeric": { + "type": "boolean" + }, + "variable_top": { + "type": "string" + }, + "hiragana_quaternary_mode": { + "type": "boolean" + } + }, + "required": [ + "type" + ] + } + ] + }, + "_types.mapping:MatchType": { + "type": "string", + "enum": [ + "simple", + "regex" + ] + }, + "_types.mapping:FieldNamesField": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "required": [ + "enabled" + ] + }, + "_types.mapping:IndexField": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "required": [ + "enabled" + ] + }, + "_types.mapping:RoutingField": { + "type": "object", + "properties": { + "required": { + "type": "boolean" + } + }, + "required": [ + "required" + ] + }, + "_types.mapping:SizeField": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "required": [ + "enabled" + ] + }, + "_types.mapping:SourceField": { + "type": "object", + "properties": { + "compress": { + "type": "boolean" + }, + "compress_threshold": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "excludes": { + "type": "array", + "items": { + "type": "string" + } + }, + "includes": { + "type": "array", + "items": { + "type": "string" + } + }, + "mode": { + "$ref": "#/components/schemas/_types.mapping:SourceFieldMode" + } + } + }, + "_types.mapping:SourceFieldMode": { + "type": "string", + "enum": [ + "disabled", + "stored", + "synthetic" + ] + }, + "_types.mapping:DataStreamTimestamp": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "required": [ + "enabled" + ] + }, + "indices._types:AliasDefinition": { + "type": "object", + "properties": { + "filter": { + "$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.", + "type": "string" + }, + "is_write_index": { + "description": "If `true`, the index is the write index for the alias.", + "type": "boolean" + }, + "routing": { + "description": "Value used to route indexing and search operations to a specific shard.", + "type": "string" + }, + "search_routing": { + "description": "Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.", + "type": "string" + }, + "is_hidden": { + "description": "If `true`, the alias is hidden.\nAll indices for the alias must have the same `is_hidden` value.", + "x-available-since": "7.16.0", + "type": "boolean" + } + } + }, + "indices._types:DataStreamLifecycleWithRollover": { + "type": "object", + "properties": { + "data_retention": { + "$ref": "#/components/schemas/_types:Duration" + }, + "downsampling": { + "$ref": "#/components/schemas/indices._types:DataStreamLifecycleDownsampling" + }, + "rollover": { + "$ref": "#/components/schemas/indices._types:DataStreamLifecycleRolloverConditions" + } + } + }, + "indices._types:DataStreamLifecycleDownsampling": { + "type": "object", + "properties": { + "rounds": { + "description": "The list of downsampling rounds to execute as part of this downsampling configuration", + "type": "array", + "items": { + "$ref": "#/components/schemas/indices._types:DownsamplingRound" + } + } + }, + "required": [ + "rounds" + ] + }, + "indices._types:DownsamplingRound": { + "type": "object", + "properties": { + "after": { + "$ref": "#/components/schemas/_types:Duration" + }, + "config": { + "$ref": "#/components/schemas/indices._types:DownsampleConfig" + } + }, + "required": [ + "after", + "config" + ] + }, + "indices._types:DownsampleConfig": { + "type": "object", + "properties": { + "fixed_interval": { + "$ref": "#/components/schemas/_types:DurationLarge" + } + }, + "required": [ + "fixed_interval" + ] + }, + "indices._types:DataStreamLifecycleRolloverConditions": { + "type": "object", + "properties": { + "min_age": { + "$ref": "#/components/schemas/_types:Duration" + }, + "max_age": { + "type": "string" + }, + "min_docs": { + "type": "number" + }, + "max_docs": { + "type": "number" + }, + "min_size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "max_size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "min_primary_shard_size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "max_primary_shard_size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "min_primary_shard_docs": { + "type": "number" + }, + "max_primary_shard_docs": { + "type": "number" + } + } + }, + "_types:ClusterInfoTargets": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types:ClusterInfoTarget" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:ClusterInfoTarget" + } + } + ] + }, + "_types:ClusterInfoTarget": { + "type": "string", + "enum": [ + "_all", + "http", + "ingest", + "thread_pool", + "script" + ] + }, + "nodes._types:Http": { + "type": "object", + "properties": { + "current_open": { + "description": "Current number of open HTTP connections for the node.", + "type": "number" + }, + "total_opened": { + "description": "Total number of HTTP connections opened for the node.", + "type": "number" + }, + "clients": { + "description": "Information on current and recently-closed HTTP client connections.\nClients that have been closed longer than the `http.client_stats.closed_channels.max_age` setting will not be represented here.", + "type": "array", + "items": { + "$ref": "#/components/schemas/nodes._types:Client" + } + } + } + }, + "nodes._types:Client": { + "type": "object", + "properties": { + "id": { + "description": "Unique ID for the HTTP client.", + "type": "number" + }, + "agent": { + "description": "Reported agent for the HTTP client.\nIf unavailable, this property is not included in the response.", + "type": "string" + }, + "local_address": { + "description": "Local address for the HTTP connection.", + "type": "string" + }, + "remote_address": { + "description": "Remote address for the HTTP connection.", + "type": "string" + }, + "last_uri": { + "description": "The URI of the client’s most recent request.", + "type": "string" + }, + "opened_time_millis": { + "description": "Time at which the client opened the connection.", + "type": "number" + }, + "closed_time_millis": { + "description": "Time at which the client closed the connection if the connection is closed.", + "type": "number" + }, + "last_request_time_millis": { + "description": "Time of the most recent request from this client.", + "type": "number" + }, + "request_count": { + "description": "Number of requests from this client.", + "type": "number" + }, + "request_size_bytes": { + "description": "Cumulative size in bytes of all requests from this client.", + "type": "number" + }, + "x_opaque_id": { + "description": "Value from the client’s `x-opaque-id` HTTP header.\nIf unavailable, this property is not included in the response.", + "type": "string" + } + } + }, + "nodes._types:Ingest": { + "type": "object", + "properties": { + "pipelines": { + "description": "Contains statistics about ingest pipelines for the node.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/nodes._types:IngestTotal" + } + }, + "total": { + "$ref": "#/components/schemas/nodes._types:IngestTotal" + } + } + }, + "nodes._types:IngestTotal": { + "type": "object", + "properties": { + "count": { + "description": "Total number of documents ingested during the lifetime of this node.", + "type": "number" + }, + "current": { + "description": "Total number of documents currently being ingested.", + "type": "number" + }, + "failed": { + "description": "Total number of failed ingest operations during the lifetime of this node.", + "type": "number" + }, + "processors": { + "description": "Total number of ingest processors.", + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/nodes._types:KeyedProcessor" + } + } + }, + "time_in_millis": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + } + } + }, + "nodes._types:KeyedProcessor": { + "type": "object", + "properties": { + "stats": { + "$ref": "#/components/schemas/nodes._types:Processor" + }, + "type": { + "type": "string" + } + } + }, + "nodes._types:Processor": { + "type": "object", + "properties": { + "count": { + "description": "Number of documents transformed by the processor.", + "type": "number" + }, + "current": { + "description": "Number of documents currently being transformed by the processor.", + "type": "number" + }, + "failed": { + "description": "Number of failed operations for the processor.", + "type": "number" + }, + "time_in_millis": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + } + } + }, + "nodes._types:ThreadCount": { + "type": "object", + "properties": { + "active": { + "description": "Number of active threads in the thread pool.", + "type": "number" + }, + "completed": { + "description": "Number of tasks completed by the thread pool executor.", + "type": "number" + }, + "largest": { + "description": "Highest number of active threads in the thread pool.", + "type": "number" + }, + "queue": { + "description": "Number of tasks in queue for the thread pool.", + "type": "number" + }, + "rejected": { + "description": "Number of tasks rejected by the thread pool executor.", + "type": "number" + }, + "threads": { + "description": "Number of threads in the thread pool.", + "type": "number" + } + } + }, + "nodes._types:Scripting": { + "type": "object", + "properties": { + "cache_evictions": { + "description": "Total number of times the script cache has evicted old data.", + "type": "number" + }, + "compilations": { + "description": "Total number of inline script compilations performed by the node.", + "type": "number" + }, + "compilations_history": { + "description": "Contains this recent history of script compilations.", + "type": "object", + "additionalProperties": { + "type": "number" + } + }, + "compilation_limit_triggered": { + "description": "Total number of times the script compilation circuit breaker has limited inline script compilations.", + "type": "number" + }, + "contexts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/nodes._types:Context" + } + } + } + }, + "nodes._types:Context": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "compilations": { + "type": "number" + }, + "cache_evictions": { + "type": "number" + }, + "compilation_limit_triggered": { + "type": "number" + } + } + }, + "indices._types:IndexState": { + "type": "object", + "properties": { + "aliases": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/indices._types:Alias" + } + }, + "mappings": { + "$ref": "#/components/schemas/_types.mapping:TypeMapping" + }, + "settings": { + "$ref": "#/components/schemas/indices._types:IndexSettings" + }, + "defaults": { + "$ref": "#/components/schemas/indices._types:IndexSettings" + }, + "data_stream": { + "$ref": "#/components/schemas/_types:DataStreamName" + }, + "lifecycle": { + "$ref": "#/components/schemas/indices._types:DataStreamLifecycle" + } + } + }, + "indices._types:Alias": { + "type": "object", + "properties": { + "filter": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "index_routing": { + "$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.", + "type": "boolean" + }, + "is_write_index": { + "description": "If `true`, the index is the write index for the alias.", + "type": "boolean" + }, + "routing": { + "$ref": "#/components/schemas/_types:Routing" + }, + "search_routing": { + "$ref": "#/components/schemas/_types:Routing" + } + } + }, + "_types:DataStreamName": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-data-stream.html#indices-create-data-stream-api-path-params" + }, + "type": "string" + }, + "indices._types:DataStreamLifecycle": { + "type": "object", + "properties": { + "data_retention": { + "$ref": "#/components/schemas/_types:Duration" + }, + "downsampling": { + "$ref": "#/components/schemas/indices._types:DataStreamLifecycleDownsampling" + } + } + }, + "_types:Result": { + "type": "string", + "enum": [ + "created", + "updated", + "deleted", + "not_found", + "noop" + ] + }, + "connector._types:Connector": { + "type": "object", + "properties": { + "api_key_id": { + "type": "string" + }, + "api_key_secret_id": { + "type": "string" + }, + "configuration": { + "$ref": "#/components/schemas/connector._types:ConnectorConfiguration" + }, + "custom_scheduling": { + "$ref": "#/components/schemas/connector._types:ConnectorCustomScheduling" + }, + "description": { + "type": "string" + }, + "error": { + "oneOf": [ + { + "type": "string" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "features": { + "$ref": "#/components/schemas/connector._types:ConnectorFeatures" + }, + "filtering": { + "type": "array", + "items": { + "$ref": "#/components/schemas/connector._types:FilteringConfig" + } + }, + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "index_name": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types:IndexName" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "is_native": { + "type": "boolean" + }, + "language": { + "type": "string" + }, + "last_access_control_sync_error": { + "type": "string" + }, + "last_access_control_sync_scheduled_at": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "last_access_control_sync_status": { + "$ref": "#/components/schemas/connector._types:SyncStatus" + }, + "last_deleted_document_count": { + "type": "number" + }, + "last_incremental_sync_scheduled_at": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "last_indexed_document_count": { + "type": "number" + }, + "last_seen": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "last_sync_error": { + "type": "string" + }, + "last_sync_scheduled_at": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "last_sync_status": { + "$ref": "#/components/schemas/connector._types:SyncStatus" + }, + "last_synced": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "name": { + "type": "string" + }, + "pipeline": { + "$ref": "#/components/schemas/connector._types:IngestPipelineParams" + }, + "scheduling": { + "$ref": "#/components/schemas/connector._types:SchedulingConfiguration" + }, + "service_type": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/connector._types:ConnectorStatus" + }, + "sync_cursor": { + "type": "object" + }, + "sync_now": { + "type": "boolean" + } + }, + "required": [ + "configuration", + "custom_scheduling", + "filtering", + "is_native", + "scheduling", + "status", + "sync_now" + ] + }, + "connector._types:ConnectorConfiguration": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/connector._types:ConnectorConfigProperties" + } + }, + "connector._types:ConnectorConfigProperties": { + "type": "object", + "properties": { + "category": { + "type": "string" + }, + "default_value": { + "$ref": "#/components/schemas/_types:ScalarValue" + }, + "depends_on": { + "type": "array", + "items": { + "$ref": "#/components/schemas/connector._types:Dependency" + } + }, + "display": { + "$ref": "#/components/schemas/connector._types:DisplayType" + }, + "label": { + "type": "string" + }, + "options": { + "type": "array", + "items": { + "$ref": "#/components/schemas/connector._types:SelectOption" + } + }, + "order": { + "type": "number" + }, + "placeholder": { + "type": "string" + }, + "required": { + "type": "boolean" + }, + "sensitive": { + "type": "boolean" + }, + "tooltip": { + "oneOf": [ + { + "type": "string" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "type": { + "$ref": "#/components/schemas/connector._types:ConnectorFieldType" + }, + "ui_restrictions": { + "type": "array", + "items": { + "type": "string" + } + }, + "validations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/connector._types:Validation" + } + }, + "value": { + "type": "object" + } + }, + "required": [ + "default_value", + "depends_on", + "display", + "label", + "options", + "required", + "sensitive", + "value" + ] + }, + "_types:ScalarValue": { + "description": "A scalar value.", + "oneOf": [ + { + "type": "number" + }, + { + "type": "number" + }, + { + "type": "string" + }, + { + "type": "boolean" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "connector._types:Dependency": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "value": { + "$ref": "#/components/schemas/_types:ScalarValue" + } + }, + "required": [ + "field", + "value" + ] + }, + "connector._types:DisplayType": { + "type": "string", + "enum": [ + "textbox", + "textarea", + "numeric", + "toggle", + "dropdown" + ] + }, + "connector._types:SelectOption": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "value": { + "$ref": "#/components/schemas/_types:ScalarValue" + } + }, + "required": [ + "label", + "value" + ] + }, + "connector._types:ConnectorFieldType": { + "type": "string", + "enum": [ + "str", + "int", + "list", + "bool" + ] + }, + "connector._types:Validation": { + "discriminator": { + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/connector._types:LessThanValidation" + }, + { + "$ref": "#/components/schemas/connector._types:GreaterThanValidation" + }, + { + "$ref": "#/components/schemas/connector._types:ListTypeValidation" + }, + { + "$ref": "#/components/schemas/connector._types:IncludedInValidation" + }, + { + "$ref": "#/components/schemas/connector._types:RegexValidation" + } + ] + }, + "connector._types:LessThanValidation": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "less_than" + ] + }, + "constraint": { + "type": "number" + } + }, + "required": [ + "type", + "constraint" + ] + }, + "connector._types:GreaterThanValidation": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "greater_than" + ] + }, + "constraint": { + "type": "number" + } + }, + "required": [ + "type", + "constraint" + ] + }, + "connector._types:ListTypeValidation": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "list_type" + ] + }, + "constraint": { + "type": "string" + } + }, + "required": [ + "type", + "constraint" + ] + }, + "connector._types:IncludedInValidation": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "included_in" + ] + }, + "constraint": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:ScalarValue" + } + } + }, + "required": [ + "type", + "constraint" + ] + }, + "connector._types:RegexValidation": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "regex" + ] + }, + "constraint": { + "type": "string" + } + }, + "required": [ + "type", + "constraint" + ] + }, + "connector._types:ConnectorCustomScheduling": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/connector._types:CustomScheduling" + } + }, + "connector._types:CustomScheduling": { + "type": "object", + "properties": { + "configuration_overrides": { + "$ref": "#/components/schemas/connector._types:CustomSchedulingConfigurationOverrides" + }, + "enabled": { + "type": "boolean" + }, + "interval": { + "type": "string" + }, + "last_synced": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "name": { + "type": "string" + } + }, + "required": [ + "configuration_overrides", + "enabled", + "interval", + "name" + ] + }, + "connector._types:CustomSchedulingConfigurationOverrides": { + "type": "object", + "properties": { + "max_crawl_depth": { + "type": "number" + }, + "sitemap_discovery_disabled": { + "type": "boolean" + }, + "domain_allowlist": { + "type": "array", + "items": { + "type": "string" + } + }, + "sitemap_urls": { + "type": "array", + "items": { + "type": "string" + } + }, + "seed_urls": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "connector._types:ConnectorFeatures": { + "type": "object", + "properties": { + "document_level_security": { + "$ref": "#/components/schemas/connector._types:FeatureEnabled" + }, + "incremental_sync": { + "$ref": "#/components/schemas/connector._types:FeatureEnabled" + }, + "native_connector_api_keys": { + "$ref": "#/components/schemas/connector._types:FeatureEnabled" + }, + "sync_rules": { + "$ref": "#/components/schemas/connector._types:SyncRulesFeature" + } + } + }, + "connector._types:FeatureEnabled": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "required": [ + "enabled" + ] + }, + "connector._types:SyncRulesFeature": { + "type": "object", + "properties": { + "advanced": { + "$ref": "#/components/schemas/connector._types:FeatureEnabled" + }, + "basic": { + "$ref": "#/components/schemas/connector._types:FeatureEnabled" + } + } + }, + "connector._types:FilteringConfig": { + "type": "object", + "properties": { + "active": { + "$ref": "#/components/schemas/connector._types:FilteringRules" + }, + "domain": { + "type": "string" + }, + "draft": { + "$ref": "#/components/schemas/connector._types:FilteringRules" + } + }, + "required": [ + "active", + "draft" + ] + }, + "connector._types:FilteringRules": { + "type": "object", + "properties": { + "advanced_snippet": { + "$ref": "#/components/schemas/connector._types:FilteringAdvancedSnippet" + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/connector._types:FilteringRule" + } + }, + "validation": { + "$ref": "#/components/schemas/connector._types:FilteringRulesValidation" + } + }, + "required": [ + "advanced_snippet", + "rules", + "validation" + ] + }, + "connector._types:FilteringAdvancedSnippet": { + "type": "object", + "properties": { + "created_at": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "updated_at": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "value": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "required": [ + "value" + ] + }, + "connector._types:FilteringRule": { + "type": "object", + "properties": { + "created_at": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "order": { + "type": "number" + }, + "policy": { + "$ref": "#/components/schemas/connector._types:FilteringPolicy" + }, + "rule": { + "$ref": "#/components/schemas/connector._types:FilteringRuleRule" + }, + "updated_at": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "value": { + "type": "string" + } + }, + "required": [ + "field", + "id", + "order", + "policy", + "rule", + "value" + ] + }, + "connector._types:FilteringPolicy": { + "type": "string", + "enum": [ + "exclude", + "include" + ] + }, + "connector._types:FilteringRuleRule": { + "type": "string", + "enum": [ + "contains", + "ends_with", + "equals", + "regex", + "starts_with", + ">", + "<" + ] + }, + "connector._types:FilteringRulesValidation": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/connector._types:FilteringValidation" + } + }, + "state": { + "$ref": "#/components/schemas/connector._types:FilteringValidationState" + } + }, + "required": [ + "errors", + "state" + ] + }, + "connector._types:FilteringValidation": { + "type": "object", + "properties": { + "ids": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Id" + } + }, + "messages": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "ids", + "messages" + ] + }, + "connector._types:FilteringValidationState": { + "type": "string", + "enum": [ + "edited", + "invalid", + "valid" + ] + }, + "connector._types:SyncStatus": { + "type": "string", + "enum": [ + "canceling", + "canceled", + "completed", + "error", + "in_progress", + "pending", + "suspended" + ] + }, + "connector._types:IngestPipelineParams": { + "type": "object", + "properties": { + "extract_binary_content": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "reduce_whitespace": { + "type": "boolean" + }, + "run_ml_inference": { + "type": "boolean" + } + }, + "required": [ + "extract_binary_content", + "name", + "reduce_whitespace", + "run_ml_inference" + ] + }, + "connector._types:SchedulingConfiguration": { + "type": "object", + "properties": { + "access_control": { + "$ref": "#/components/schemas/connector._types:ConnectorScheduling" + }, + "full": { + "$ref": "#/components/schemas/connector._types:ConnectorScheduling" + }, + "incremental": { + "$ref": "#/components/schemas/connector._types:ConnectorScheduling" + } + } + }, + "connector._types:ConnectorScheduling": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "interval": { + "description": "The interval is expressed using the crontab syntax", + "type": "string" + } + }, + "required": [ + "enabled", + "interval" + ] + }, + "connector._types:ConnectorStatus": { + "type": "string", + "enum": [ + "created", + "needs_configuration", + "configured", + "connected", + "error" + ] + }, + "connector._types:ConnectorSyncJob": { + "type": "object", + "properties": { + "cancelation_requested_at": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "canceled_at": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "completed_at": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "connector": { + "$ref": "#/components/schemas/connector._types:SyncJobConnectorReference" + }, + "created_at": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "deleted_document_count": { + "type": "number" + }, + "error": { + "type": "string" + }, + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "indexed_document_count": { + "type": "number" + }, + "indexed_document_volume": { + "type": "number" + }, + "job_type": { + "$ref": "#/components/schemas/connector._types:SyncJobType" + }, + "last_seen": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "metadata": { + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "started_at": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "status": { + "$ref": "#/components/schemas/connector._types:SyncStatus" + }, + "total_document_count": { + "type": "number" + }, + "trigger_method": { + "$ref": "#/components/schemas/connector._types:SyncJobTriggerMethod" + }, + "worker_hostname": { + "type": "string" + } + }, + "required": [ + "connector", + "created_at", + "deleted_document_count", + "id", + "indexed_document_count", + "indexed_document_volume", + "job_type", + "metadata", + "status", + "total_document_count", + "trigger_method" + ] + }, + "connector._types:SyncJobConnectorReference": { + "type": "object", + "properties": { + "configuration": { + "$ref": "#/components/schemas/connector._types:ConnectorConfiguration" + }, + "filtering": { + "$ref": "#/components/schemas/connector._types:FilteringRules" + }, + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "index_name": { + "type": "string" + }, + "language": { + "type": "string" + }, + "pipeline": { + "$ref": "#/components/schemas/connector._types:IngestPipelineParams" + }, + "service_type": { + "type": "string" + }, + "sync_cursor": { + "type": "object" + } + }, + "required": [ + "configuration", + "filtering", + "id", + "index_name", + "service_type" + ] + }, + "connector._types:SyncJobType": { + "type": "string", + "enum": [ + "full", + "incremental", + "access_control" + ] + }, + "connector._types:SyncJobTriggerMethod": { + "type": "string", + "enum": [ + "on_demand", + "scheduled" + ] + }, + "_spec_utils:NullValue": { + "nullable": true, + "description": "A `null` value that is to be interpreted as an actual value, unless other uses of `null` that are equivalent\nto a missing value. It is used for exemple in settings, where using the `NullValue` for a setting will reset\nit to its default value.", + "type": "string" + }, + "_types:WriteResponseBase": { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "_index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "_primary_term": { + "type": "number" + }, + "result": { + "$ref": "#/components/schemas/_types:Result" + }, + "_seq_no": { + "$ref": "#/components/schemas/_types:SequenceNumber" + }, + "_shards": { + "$ref": "#/components/schemas/_types:ShardStatistics" + }, + "_version": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "forced_refresh": { + "type": "boolean" + } + }, + "required": [ + "_id", + "_index", + "result", + "_shards", + "_version" + ] + }, + "_types:Conflicts": { + "type": "string", + "enum": [ + "abort", + "proceed" + ] + }, + "_types:Slices": { + "description": "Slices configuration used to parallelize a process.", + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "#/components/schemas/_types:SlicesCalculation" + } + ] + }, + "_types:SlicesCalculation": { + "type": "string", + "enum": [ + "auto" + ] + }, + "_types:BulkIndexByScrollFailure": { + "type": "object", + "properties": { + "cause": { + "$ref": "#/components/schemas/_types:ErrorCause" + }, + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "status": { + "type": "number" + }, + "type": { + "type": "string" + } + }, + "required": [ + "cause", + "id", + "index", + "status", + "type" + ] + }, + "_types:Retries": { + "type": "object", + "properties": { + "bulk": { + "type": "number" + }, + "search": { + "type": "number" + } + }, + "required": [ + "bulk", + "search" + ] + }, + "_types:TaskId": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + } + ] + }, + "enrich.execute_policy:ExecuteEnrichPolicyStatus": { + "type": "object", + "properties": { + "phase": { + "$ref": "#/components/schemas/enrich.execute_policy:EnrichPolicyPhase" + } + }, + "required": [ + "phase" + ] + }, + "enrich.execute_policy:EnrichPolicyPhase": { + "type": "string", + "enum": [ + "SCHEDULED", + "RUNNING", + "COMPLETE", + "FAILED" + ] + }, + "enrich._types:Summary": { + "type": "object", + "properties": { + "config": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/enrich._types:Policy" + }, + "minProperties": 1, + "maxProperties": 1 + } + }, + "required": [ + "config" + ] + }, + "enrich._types:Policy": { + "type": "object", + "properties": { + "enrich_fields": { + "$ref": "#/components/schemas/_types:Fields" + }, + "indices": { + "$ref": "#/components/schemas/_types:Indices" + }, + "match_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "name": { + "$ref": "#/components/schemas/_types:Name" + }, + "elasticsearch_version": { + "type": "string" + } + }, + "required": [ + "enrich_fields", + "indices", + "match_field" + ] + }, + "enrich.stats:CoordinatorStats": { + "type": "object", + "properties": { + "executed_searches_total": { + "type": "number" + }, + "node_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "queue_size": { + "type": "number" + }, + "remote_requests_current": { + "type": "number" + }, + "remote_requests_total": { + "type": "number" + } + }, + "required": [ + "executed_searches_total", + "node_id", + "queue_size", + "remote_requests_current", + "remote_requests_total" + ] + }, + "enrich.stats:ExecutingPolicy": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/_types:Name" + }, + "task": { + "$ref": "#/components/schemas/tasks._types:TaskInfo" + } + }, + "required": [ + "name", + "task" + ] + }, + "tasks._types:TaskInfo": { + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "cancelled": { + "type": "boolean" + }, + "cancellable": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "headers": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "id": { + "type": "number" + }, + "node": { + "$ref": "#/components/schemas/_types:NodeId" + }, + "running_time": { + "$ref": "#/components/schemas/_types:Duration" + }, + "running_time_in_nanos": { + "$ref": "#/components/schemas/_types:DurationValueUnitNanos" + }, + "start_time_in_millis": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "status": { + "description": "Task status information can vary wildly from task to task.", + "type": "object" + }, + "type": { + "type": "string" + }, + "parent_task_id": { + "$ref": "#/components/schemas/_types:TaskId" + } + }, + "required": [ + "action", + "cancellable", + "headers", + "id", + "node", + "running_time_in_nanos", + "start_time_in_millis", + "type" + ] + }, + "enrich.stats:CacheStats": { + "type": "object", + "properties": { + "node_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "count": { + "type": "number" + }, + "hits": { + "type": "number" + }, + "misses": { + "type": "number" + }, + "evictions": { + "type": "number" + } + }, + "required": [ + "node_id", + "count", + "hits", + "misses", + "evictions" + ] + }, + "eql._types:EqlSearchResponseBase": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "is_partial": { + "description": "If true, the response does not contain complete search results.", + "type": "boolean" + }, + "is_running": { + "description": "If true, the search request is still executing.", + "type": "boolean" + }, + "took": { + "$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" + } + }, + "required": [ + "hits" + ] + }, + "eql._types:EqlHits": { + "type": "object", + "properties": { + "total": { + "$ref": "#/components/schemas/_global.search._types:TotalHits" + }, + "events": { + "description": "Contains events matching the query. Each object represents a matching event.", + "type": "array", + "items": { + "$ref": "#/components/schemas/eql._types:HitsEvent" + } + }, + "sequences": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-sequences" + }, + "description": "Contains event sequences matching the query. Each object represents a matching sequence. This parameter is only returned for EQL queries containing a sequence.", + "type": "array", + "items": { + "$ref": "#/components/schemas/eql._types:HitsSequence" + } + } + } + }, + "eql._types:HitsEvent": { + "type": "object", + "properties": { + "_index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "_source": { + "description": "Original JSON body passed for the event at index time.", + "type": "object" + }, + "missing": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-missing-events" + }, + "description": "Set to `true` for events in a timespan-constrained sequence that do not meet a given condition.", + "type": "boolean" + }, + "fields": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "object" + } + } + } + }, + "required": [ + "_index", + "_id", + "_source" + ] + }, + "eql._types:HitsSequence": { + "type": "object", + "properties": { + "events": { + "description": "Contains events matching the query. Each object represents a matching event.", + "type": "array", + "items": { + "$ref": "#/components/schemas/eql._types:HitsEvent" + } + }, + "join_keys": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-sequences" + }, + "description": "Shared field values used to constrain matches in the sequence. These are defined using the by keyword in the EQL query syntax.", + "type": "array", + "items": { + "type": "object" + } + } + }, + "required": [ + "events" + ] + }, + "eql.search:ResultPosition": { + "type": "string", + "enum": [ + "tail", + "head" + ] + }, + "esql._types:TableValuesContainer": { + "type": "object", + "properties": { + "integer": { + "type": "array", + "items": { + "$ref": "#/components/schemas/esql._types:TableValuesIntegerValue" + } + }, + "keyword": { + "type": "array", + "items": { + "$ref": "#/components/schemas/esql._types:TableValuesKeywordValue" + } + }, + "long": { + "type": "array", + "items": { + "$ref": "#/components/schemas/esql._types:TableValuesLongValue" + } + }, + "double": { + "type": "array", + "items": { + "$ref": "#/components/schemas/esql._types:TableValuesLongDouble" + } + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "esql._types:TableValuesIntegerValue": { + "oneOf": [ + { + "type": "number" + }, + { + "type": "array", + "items": { + "type": "number" + } + } + ] + }, + "esql._types:TableValuesKeywordValue": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "esql._types:TableValuesLongValue": { + "oneOf": [ + { + "type": "number" + }, + { + "type": "array", + "items": { + "type": "number" + } + } + ] + }, + "esql._types:TableValuesLongDouble": { + "oneOf": [ + { + "type": "number" + }, + { + "type": "array", + "items": { + "type": "number" + } + } + ] + }, + "_types:EsqlColumns": { + "type": "object" + }, + "_types:InlineGet": { + "type": "object", + "properties": { + "fields": { + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "found": { + "type": "boolean" + }, + "_seq_no": { + "$ref": "#/components/schemas/_types:SequenceNumber" + }, + "_primary_term": { + "type": "number" + }, + "_routing": { + "$ref": "#/components/schemas/_types:Routing" + }, + "_source": { + "type": "object" + } + }, + "required": [ + "found" + ] + }, + "_global.field_caps:FieldCapability": { + "type": "object", + "properties": { + "aggregatable": { + "description": "Whether this field can be aggregated on all indices.", + "type": "boolean" + }, + "indices": { + "$ref": "#/components/schemas/_types:Indices" + }, + "meta": { + "$ref": "#/components/schemas/_types:Metadata" + }, + "non_aggregatable_indices": { + "$ref": "#/components/schemas/_types:Indices" + }, + "non_searchable_indices": { + "$ref": "#/components/schemas/_types:Indices" + }, + "searchable": { + "description": "Whether this field is indexed for search on all indices.", + "type": "boolean" + }, + "type": { + "type": "string" + }, + "metadata_field": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-fields.html" + }, + "description": "Whether this field is registered as a metadata field.", + "type": "boolean" + }, + "time_series_dimension": { + "description": "Whether this field is used as a time series dimension.", + "x-technical-preview": true, + "x-available-since": "8.0.0", + "type": "boolean" + }, + "time_series_metric": { + "$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.", + "x-technical-preview": true, + "x-available-since": "8.0.0", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:IndexName" + } + }, + "metric_conflicts_indices": { + "description": "The list of indices where this field is present if these indices\ndon’t have the same `time_series_metric` value for this field.", + "x-technical-preview": true, + "x-available-since": "8.0.0", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:IndexName" + } + } + }, + "required": [ + "aggregatable", + "searchable", + "type" + ] + }, + "_global.get:GetResult": { + "type": "object", + "properties": { + "_index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "fields": { + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "found": { + "type": "boolean" + }, + "_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "_primary_term": { + "type": "number" + }, + "_routing": { + "type": "string" + }, + "_seq_no": { + "$ref": "#/components/schemas/_types:SequenceNumber" + }, + "_source": { + "type": "object" + }, + "_version": { + "$ref": "#/components/schemas/_types:VersionNumber" + } + }, + "required": [ + "_index", + "found", + "_id" + ] + }, + "_types:StoredScript": { + "type": "object", + "properties": { + "lang": { + "$ref": "#/components/schemas/_types:ScriptLanguage" + }, + "options": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "source": { + "description": "The script source.", + "type": "string" + } + }, + "required": [ + "lang", + "source" + ] + }, + "graph._types:Hop": { + "type": "object", + "properties": { + "connections": { + "$ref": "#/components/schemas/graph._types:Hop" + }, + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "vertices": { + "description": "Contains the fields you are interested in.", + "type": "array", + "items": { + "$ref": "#/components/schemas/graph._types:VertexDefinition" + } + } + }, + "required": [ + "query", + "vertices" + ] + }, + "graph._types:VertexDefinition": { + "type": "object", + "properties": { + "exclude": { + "description": "Prevents the specified terms from being included in the results.", + "type": "array", + "items": { + "type": "string" + } + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "include": { + "description": "Identifies the terms of interest that form the starting points from which you want to spider out.", + "type": "array", + "items": { + "$ref": "#/components/schemas/graph._types:VertexInclude" + } + }, + "min_doc_count": { + "description": "Specifies how many documents must contain a pair of terms before it is considered to be a useful connection.\nThis setting acts as a certainty threshold.", + "type": "number" + }, + "shard_min_doc_count": { + "description": "Controls how many documents on a particular shard have to contain a pair of terms before the connection is returned for global consideration.", + "type": "number" + }, + "size": { + "description": "Specifies the maximum number of vertex terms returned for each field.", + "type": "number" + } + }, + "required": [ + "field" + ] + }, + "graph._types:VertexInclude": { + "type": "object", + "properties": { + "boost": { + "type": "number" + }, + "term": { + "type": "string" + } + }, + "required": [ + "boost", + "term" + ] + }, + "graph._types:ExploreControls": { + "type": "object", + "properties": { + "sample_diversity": { + "$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.", + "type": "number" + }, + "timeout": { + "$ref": "#/components/schemas/_types:Duration" + }, + "use_significance": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significantterms-aggregation.html" + }, + "description": "Filters associated terms so only those that are significantly associated with your query are included.", + "type": "boolean" + } + }, + "required": [ + "use_significance" + ] + }, + "graph._types:SampleDiversity": { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "max_docs_per_value": { + "type": "number" + } + }, + "required": [ + "field", + "max_docs_per_value" + ] + }, + "graph._types:Connection": { + "type": "object", + "properties": { + "doc_count": { + "type": "number" + }, + "source": { + "type": "number" + }, + "target": { + "type": "number" + }, + "weight": { + "type": "number" + } + }, + "required": [ + "doc_count", + "source", + "target", + "weight" + ] + }, + "graph._types:Vertex": { + "type": "object", + "properties": { + "depth": { + "type": "number" + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "term": { + "type": "string" + }, + "weight": { + "type": "number" + } + }, + "required": [ + "depth", + "field", + "term", + "weight" + ] + }, + "_types:OpType": { + "type": "string", + "enum": [ + "index", + "create" + ] + }, + "indices.add_block:IndicesBlockOptions": { + "type": "string", + "enum": [ + "metadata", + "read", + "read_only", + "write" + ] + }, + "indices.add_block:IndicesBlockStatus": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "blocked": { + "type": "boolean" + } + }, + "required": [ + "name", + "blocked" + ] + }, + "indices.analyze:TextToAnalyze": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "indices.analyze:AnalyzeDetail": { + "type": "object", + "properties": { + "analyzer": { + "$ref": "#/components/schemas/indices.analyze:AnalyzerDetail" + }, + "charfilters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.analyze:CharFilterDetail" + } + }, + "custom_analyzer": { + "type": "boolean" + }, + "tokenfilters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.analyze:TokenDetail" + } + }, + "tokenizer": { + "$ref": "#/components/schemas/indices.analyze:TokenDetail" + } + }, + "required": [ + "custom_analyzer" + ] + }, + "indices.analyze:AnalyzerDetail": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "tokens": { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.analyze:ExplainAnalyzeToken" + } + } + }, + "required": [ + "name", + "tokens" + ] + }, + "indices.analyze:ExplainAnalyzeToken": { + "type": "object", + "properties": { + "bytes": { + "type": "string" + }, + "end_offset": { + "type": "number" + }, + "keyword": { + "type": "boolean" + }, + "position": { + "type": "number" + }, + "positionLength": { + "type": "number" + }, + "start_offset": { + "type": "number" + }, + "termFrequency": { + "type": "number" + }, + "token": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "required": [ + "bytes", + "end_offset", + "position", + "positionLength", + "start_offset", + "termFrequency", + "token", + "type" + ] + }, + "indices.analyze:CharFilterDetail": { + "type": "object", + "properties": { + "filtered_text": { + "type": "array", + "items": { + "type": "string" + } + }, + "name": { + "type": "string" + } + }, + "required": [ + "filtered_text", + "name" + ] + }, + "indices.analyze:TokenDetail": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "tokens": { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.analyze:ExplainAnalyzeToken" + } + } + }, + "required": [ + "name", + "tokens" + ] + }, + "indices.analyze:AnalyzeToken": { + "type": "object", + "properties": { + "end_offset": { + "type": "number" + }, + "position": { + "type": "number" + }, + "positionLength": { + "type": "number" + }, + "start_offset": { + "type": "number" + }, + "token": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "required": [ + "end_offset", + "position", + "start_offset", + "token", + "type" + ] + }, + "indices.data_streams_stats:DataStreamsStatsItem": { + "type": "object", + "properties": { + "backing_indices": { + "description": "Current number of backing indices for the data stream.", + "type": "number" + }, + "data_stream": { + "$ref": "#/components/schemas/_types:Name" + }, + "maximum_timestamp": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "store_size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "store_size_bytes": { + "description": "Total size, in bytes, of all shards for the data stream’s backing indices.", + "type": "number" + } + }, + "required": [ + "backing_indices", + "data_stream", + "maximum_timestamp", + "store_size_bytes" + ] + }, + "_types:IndicesResponseBase": { + "allOf": [ + { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + }, + { + "type": "object", + "properties": { + "_shards": { + "$ref": "#/components/schemas/_types:ShardStatistics" + } + } + } + ] + }, + "_types:DataStreamNames": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types:DataStreamName" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:DataStreamName" + } + } + ] + }, + "indices.explain_data_lifecycle:DataStreamLifecycleExplain": { + "type": "object", + "properties": { + "index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "managed_by_lifecycle": { + "type": "boolean" + }, + "index_creation_date_millis": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "time_since_index_creation": { + "$ref": "#/components/schemas/_types:Duration" + }, + "rollover_date_millis": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "time_since_rollover": { + "$ref": "#/components/schemas/_types:Duration" + }, + "lifecycle": { + "$ref": "#/components/schemas/indices._types:DataStreamLifecycleWithRollover" + }, + "generation_time": { + "$ref": "#/components/schemas/_types:Duration" + }, + "error": { + "type": "string" + } + }, + "required": [ + "index", + "managed_by_lifecycle" + ] + }, + "indices.get:Features": { + "oneOf": [ + { + "$ref": "#/components/schemas/indices.get:Feature" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.get:Feature" + } + } + ] + }, + "indices.get:Feature": { + "type": "string", + "enum": [ + "aliases", + "mappings", + "settings" + ] + }, + "indices.get_alias:IndexAliases": { + "type": "object", + "properties": { + "aliases": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/indices._types:AliasDefinition" + } + } + }, + "required": [ + "aliases" + ] + }, + "indices.get_data_lifecycle:DataStreamWithLifecycle": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/_types:DataStreamName" + }, + "lifecycle": { + "$ref": "#/components/schemas/indices._types:DataStreamLifecycle" + } + }, + "required": [ + "name" + ] + }, + "indices._types:DataStream": { + "type": "object", + "properties": { + "_meta": { + "$ref": "#/components/schemas/_types:Metadata" + }, + "allow_custom_routing": { + "description": "If `true`, the data stream allows custom routing on write request.", + "type": "boolean" + }, + "generation": { + "description": "Current generation for the data stream. This number acts as a cumulative count of the stream’s rollovers, starting at 1.", + "type": "number" + }, + "hidden": { + "description": "If `true`, the data stream is hidden.", + "type": "boolean" + }, + "ilm_policy": { + "$ref": "#/components/schemas/_types:Name" + }, + "next_generation_managed_by": { + "$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.", + "type": "boolean" + }, + "indices": { + "description": "Array of objects containing information about the data stream’s backing indices.\nThe last item in this array contains information about the stream’s current write index.", + "type": "array", + "items": { + "$ref": "#/components/schemas/indices._types:DataStreamIndex" + } + }, + "lifecycle": { + "$ref": "#/components/schemas/indices._types:DataStreamLifecycleWithRollover" + }, + "name": { + "$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.", + "type": "boolean" + }, + "status": { + "$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.", + "x-available-since": "7.10.0", + "type": "boolean" + }, + "template": { + "$ref": "#/components/schemas/_types:Name" + }, + "timestamp_field": { + "$ref": "#/components/schemas/indices._types:DataStreamTimestampField" + } + }, + "required": [ + "generation", + "hidden", + "next_generation_managed_by", + "prefer_ilm", + "indices", + "name", + "status", + "template", + "timestamp_field" + ] + }, + "indices._types:ManagedBy": { + "type": "string", + "enum": [ + "Index Lifecycle Management", + "Data stream lifecycle", + "Unmanaged" + ] + }, + "indices._types:DataStreamIndex": { + "type": "object", + "properties": { + "index_name": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "index_uuid": { + "$ref": "#/components/schemas/_types:Uuid" + }, + "ilm_policy": { + "$ref": "#/components/schemas/_types:Name" + }, + "managed_by": { + "$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" + } + }, + "required": [ + "index_name", + "index_uuid", + "managed_by", + "prefer_ilm" + ] + }, + "indices._types:DataStreamTimestampField": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "name" + ] + }, + "indices.get_index_template:IndexTemplateItem": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/_types:Name" + }, + "index_template": { + "$ref": "#/components/schemas/indices._types:IndexTemplate" + } + }, + "required": [ + "name", + "index_template" + ] + }, + "indices._types:IndexTemplate": { + "type": "object", + "properties": { + "index_patterns": { + "$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.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Name" + } + }, + "template": { + "$ref": "#/components/schemas/indices._types:IndexTemplateSummary" + }, + "version": { + "$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" + }, + "allow_auto_create": { + "type": "boolean" + }, + "data_stream": { + "$ref": "#/components/schemas/indices._types:IndexTemplateDataStreamConfiguration" + } + }, + "required": [ + "index_patterns", + "composed_of" + ] + }, + "indices._types:IndexTemplateSummary": { + "type": "object", + "properties": { + "aliases": { + "description": "Aliases to add.\nIf the index template includes a `data_stream` object, these are data stream aliases.\nOtherwise, these are index aliases.\nData stream aliases ignore the `index_routing`, `routing`, and `search_routing` options.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/indices._types:Alias" + } + }, + "mappings": { + "$ref": "#/components/schemas/_types.mapping:TypeMapping" + }, + "settings": { + "$ref": "#/components/schemas/indices._types:IndexSettings" + }, + "lifecycle": { + "$ref": "#/components/schemas/indices._types:DataStreamLifecycleWithRollover" + } + } + }, + "indices._types:IndexTemplateDataStreamConfiguration": { + "type": "object", + "properties": { + "hidden": { + "description": "If true, the data stream is hidden.", + "type": "boolean" + }, + "allow_custom_routing": { + "description": "If true, the data stream supports custom routing.", + "type": "boolean" + } + } + }, + "indices.get_mapping:IndexMappingRecord": { + "type": "object", + "properties": { + "item": { + "$ref": "#/components/schemas/_types.mapping:TypeMapping" + }, + "mappings": { + "$ref": "#/components/schemas/_types.mapping:TypeMapping" + } + }, + "required": [ + "mappings" + ] + }, + "indices.modify_data_stream:Action": { + "type": "object", + "properties": { + "add_backing_index": { + "$ref": "#/components/schemas/indices.modify_data_stream:IndexAndDataStreamAction" + }, + "remove_backing_index": { + "$ref": "#/components/schemas/indices.modify_data_stream:IndexAndDataStreamAction" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "indices.modify_data_stream:IndexAndDataStreamAction": { + "type": "object", + "properties": { + "data_stream": { + "$ref": "#/components/schemas/_types:DataStreamName" + }, + "index": { + "$ref": "#/components/schemas/_types:IndexName" + } + }, + "required": [ + "data_stream", + "index" + ] + }, + "indices.put_index_template:IndexTemplateMapping": { + "type": "object", + "properties": { + "aliases": { + "description": "Aliases to add.\nIf the index template includes a `data_stream` object, these are data stream aliases.\nOtherwise, these are index aliases.\nData stream aliases ignore the `index_routing`, `routing`, and `search_routing` options.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/indices._types:Alias" + } + }, + "mappings": { + "$ref": "#/components/schemas/_types.mapping:TypeMapping" + }, + "settings": { + "$ref": "#/components/schemas/indices._types:IndexSettings" + }, + "lifecycle": { + "$ref": "#/components/schemas/indices._types:DataStreamLifecycle" + } + } + }, + "indices._types:DataStreamVisibility": { + "type": "object", + "properties": { + "hidden": { + "type": "boolean" + } + } + }, + "_types:ShardsOperationResponseBase": { + "type": "object", + "properties": { + "_shards": { + "$ref": "#/components/schemas/_types:ShardStatistics" + } + }, + "required": [ + "_shards" + ] + }, + "indices.resolve_index:ResolveIndexItem": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/_types:Name" + }, + "aliases": { + "type": "array", + "items": { + "type": "string" + } + }, + "attributes": { + "type": "array", + "items": { + "type": "string" + } + }, + "data_stream": { + "$ref": "#/components/schemas/_types:DataStreamName" + } + }, + "required": [ + "name", + "attributes" + ] + }, + "indices.resolve_index:ResolveIndexAliasItem": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/_types:Name" + }, + "indices": { + "$ref": "#/components/schemas/_types:Indices" + } + }, + "required": [ + "name", + "indices" + ] + }, + "indices.resolve_index:ResolveIndexDataStreamsItem": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/_types:DataStreamName" + }, + "timestamp_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "backing_indices": { + "$ref": "#/components/schemas/_types:Indices" + } + }, + "required": [ + "name", + "timestamp_field", + "backing_indices" + ] + }, + "_types:IndexAlias": { + "type": "string" + }, + "indices.rollover:RolloverConditions": { + "type": "object", + "properties": { + "min_age": { + "$ref": "#/components/schemas/_types:Duration" + }, + "max_age": { + "$ref": "#/components/schemas/_types:Duration" + }, + "max_age_millis": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + }, + "min_docs": { + "type": "number" + }, + "max_docs": { + "type": "number" + }, + "max_size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "max_size_bytes": { + "type": "number" + }, + "min_size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "min_size_bytes": { + "type": "number" + }, + "max_primary_shard_size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "max_primary_shard_size_bytes": { + "type": "number" + }, + "min_primary_shard_size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "min_primary_shard_size_bytes": { + "type": "number" + }, + "max_primary_shard_docs": { + "type": "number" + }, + "min_primary_shard_docs": { + "type": "number" + } + } + }, + "indices.simulate_template:Overlapping": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/_types:Name" + }, + "index_patterns": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "name", + "index_patterns" + ] + }, + "indices.simulate_template:Template": { + "type": "object", + "properties": { + "aliases": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/indices._types:Alias" + } + }, + "mappings": { + "$ref": "#/components/schemas/_types.mapping:TypeMapping" + }, + "settings": { + "$ref": "#/components/schemas/indices._types:IndexSettings" + } + }, + "required": [ + "aliases", + "mappings", + "settings" + ] + }, + "indices.update_aliases:Action": { + "type": "object", + "properties": { + "add": { + "$ref": "#/components/schemas/indices.update_aliases:AddAction" + }, + "remove": { + "$ref": "#/components/schemas/indices.update_aliases:RemoveAction" + }, + "remove_index": { + "$ref": "#/components/schemas/indices.update_aliases:RemoveIndexAction" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "indices.update_aliases:AddAction": { + "type": "object", + "properties": { + "alias": { + "$ref": "#/components/schemas/_types:IndexAlias" + }, + "aliases": { + "description": "Aliases for the action.\nIndex alias names support date math.", + "oneOf": [ + { + "$ref": "#/components/schemas/_types:IndexAlias" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:IndexAlias" + } + } + ] + }, + "filter": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "indices": { + "$ref": "#/components/schemas/_types:Indices" + }, + "index_routing": { + "$ref": "#/components/schemas/_types:Routing" + }, + "is_hidden": { + "description": "If `true`, the alias is hidden.", + "type": "boolean" + }, + "is_write_index": { + "description": "If `true`, sets the write index or data stream for the alias.", + "type": "boolean" + }, + "routing": { + "$ref": "#/components/schemas/_types:Routing" + }, + "search_routing": { + "$ref": "#/components/schemas/_types:Routing" + }, + "must_exist": { + "description": "If `true`, the alias must exist to perform the action.", + "type": "boolean" + } + } + }, + "indices.update_aliases:RemoveAction": { + "type": "object", + "properties": { + "alias": { + "$ref": "#/components/schemas/_types:IndexAlias" + }, + "aliases": { + "description": "Aliases for the action.\nIndex alias names support date math.", + "oneOf": [ + { + "$ref": "#/components/schemas/_types:IndexAlias" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:IndexAlias" + } + } + ] + }, + "index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "indices": { + "$ref": "#/components/schemas/_types:Indices" + }, + "must_exist": { + "description": "If `true`, the alias must exist to perform the action.", + "type": "boolean" + } + } + }, + "indices.update_aliases:RemoveIndexAction": { + "type": "object", + "properties": { + "index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "indices": { + "$ref": "#/components/schemas/_types:Indices" + }, + "must_exist": { + "description": "If `true`, the alias must exist to perform the action.", + "type": "boolean" + } + } + }, + "indices.validate_query:IndicesValidationExplanation": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "explanation": { + "type": "string" + }, + "index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "valid": { + "type": "boolean" + } + }, + "required": [ + "index", + "valid" + ] + }, + "inference._types:TaskType": { + "type": "string", + "enum": [ + "sparse_embedding", + "text_embedding", + "rerank", + "completion" + ] + }, + "inference._types:DeleteInferenceEndpointResult": { + "allOf": [ + { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + }, + { + "type": "object", + "properties": { + "pipelines": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "pipelines" + ] + } + ] + }, + "inference._types:InferenceEndpointInfo": { + "allOf": [ + { + "$ref": "#/components/schemas/inference._types:InferenceEndpoint" + }, + { + "type": "object", + "properties": { + "inference_id": { + "description": "The inference Id", + "type": "string" + }, + "task_type": { + "$ref": "#/components/schemas/inference._types:TaskType" + } + }, + "required": [ + "inference_id", + "task_type" + ] + } + ] + }, + "inference._types:InferenceEndpoint": { + "type": "object", + "properties": { + "service": { + "description": "The service type", + "type": "string" + }, + "service_settings": { + "$ref": "#/components/schemas/inference._types:ServiceSettings" + }, + "task_settings": { + "$ref": "#/components/schemas/inference._types:TaskSettings" + } + }, + "required": [ + "service", + "service_settings", + "task_settings" + ] + }, + "inference._types:ServiceSettings": { + "type": "object" + }, + "inference._types:TaskSettings": { + "type": "object" + }, + "inference._types:InferenceResult": { + "description": "InferenceResult is an aggregation of mutually exclusive variants", + "type": "object", + "properties": { + "text_embedding_bytes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/inference._types:TextEmbeddingByteResult" + } + }, + "text_embedding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/inference._types:TextEmbeddingResult" + } + }, + "sparse_embedding": { + "type": "array", + "items": { + "$ref": "#/components/schemas/inference._types:SparseEmbeddingResult" + } + }, + "completion": { + "type": "array", + "items": { + "$ref": "#/components/schemas/inference._types:CompletionResult" + } + }, + "rerank": { + "type": "array", + "items": { + "$ref": "#/components/schemas/inference._types:RankedDocument" + } + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "inference._types:TextEmbeddingByteResult": { + "type": "object", + "properties": { + "embedding": { + "$ref": "#/components/schemas/inference._types:DenseByteVector" + } + }, + "required": [ + "embedding" + ] + }, + "inference._types:DenseByteVector": { + "description": "Text Embedding results containing bytes are represented as Dense\nVectors of bytes.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:byte" + } + }, + "inference._types:TextEmbeddingResult": { + "type": "object", + "properties": { + "embedding": { + "$ref": "#/components/schemas/inference._types:DenseVector" + } + }, + "required": [ + "embedding" + ] + }, + "inference._types:DenseVector": { + "description": "Text Embedding results are represented as Dense Vectors\nof floats.", + "type": "array", + "items": { + "type": "number" + } + }, + "inference._types:SparseEmbeddingResult": { + "type": "object", + "properties": { + "embedding": { + "$ref": "#/components/schemas/inference._types:SparseVector" + } + }, + "required": [ + "embedding" + ] + }, + "inference._types:SparseVector": { + "description": "Sparse Embedding tokens are represented as a dictionary\nof string to double.", + "type": "object", + "additionalProperties": { + "type": "number" + } + }, + "inference._types:CompletionResult": { + "type": "object", + "properties": { + "result": { + "type": "string" + } + }, + "required": [ + "result" + ] + }, + "inference._types:RankedDocument": { + "type": "object", + "properties": { + "index": { + "type": "number" + }, + "score": { + "type": "number" + }, + "text": { + "type": "string" + } + }, + "required": [ + "index", + "score" + ] + }, + "_types:ElasticsearchVersionInfo": { + "type": "object", + "properties": { + "build_date": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "build_flavor": { + "type": "string" + }, + "build_hash": { + "type": "string" + }, + "build_snapshot": { + "type": "boolean" + }, + "build_type": { + "type": "string" + }, + "lucene_version": { + "$ref": "#/components/schemas/_types:VersionString" + }, + "minimum_index_compatibility_version": { + "$ref": "#/components/schemas/_types:VersionString" + }, + "minimum_wire_compatibility_version": { + "$ref": "#/components/schemas/_types:VersionString" + }, + "number": { + "type": "string" + } + }, + "required": [ + "build_date", + "build_flavor", + "build_hash", + "build_snapshot", + "build_type", + "lucene_version", + "minimum_index_compatibility_version", + "minimum_wire_compatibility_version", + "number" + ] + }, + "ingest._types:Pipeline": { + "type": "object", + "properties": { + "description": { + "description": "Description of the ingest pipeline.", + "type": "string" + }, + "on_failure": { + "description": "Processors to run immediately after a processor failure.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ingest._types:ProcessorContainer" + } + }, + "processors": { + "description": "Processors used to perform transformations on documents before indexing.\nProcessors run sequentially in the order specified.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ingest._types:ProcessorContainer" + } + }, + "version": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "_meta": { + "$ref": "#/components/schemas/_types:Metadata" + } + } + }, + "ingest._types:ProcessorContainer": { + "type": "object", + "properties": { + "append": { + "$ref": "#/components/schemas/ingest._types:AppendProcessor" + }, + "attachment": { + "$ref": "#/components/schemas/ingest._types:AttachmentProcessor" + }, + "bytes": { + "$ref": "#/components/schemas/ingest._types:BytesProcessor" + }, + "circle": { + "$ref": "#/components/schemas/ingest._types:CircleProcessor" + }, + "convert": { + "$ref": "#/components/schemas/ingest._types:ConvertProcessor" + }, + "csv": { + "$ref": "#/components/schemas/ingest._types:CsvProcessor" + }, + "date": { + "$ref": "#/components/schemas/ingest._types:DateProcessor" + }, + "date_index_name": { + "$ref": "#/components/schemas/ingest._types:DateIndexNameProcessor" + }, + "dissect": { + "$ref": "#/components/schemas/ingest._types:DissectProcessor" + }, + "dot_expander": { + "$ref": "#/components/schemas/ingest._types:DotExpanderProcessor" + }, + "drop": { + "$ref": "#/components/schemas/ingest._types:DropProcessor" + }, + "enrich": { + "$ref": "#/components/schemas/ingest._types:EnrichProcessor" + }, + "fail": { + "$ref": "#/components/schemas/ingest._types:FailProcessor" + }, + "foreach": { + "$ref": "#/components/schemas/ingest._types:ForeachProcessor" + }, + "geoip": { + "$ref": "#/components/schemas/ingest._types:GeoIpProcessor" + }, + "grok": { + "$ref": "#/components/schemas/ingest._types:GrokProcessor" + }, + "gsub": { + "$ref": "#/components/schemas/ingest._types:GsubProcessor" + }, + "inference": { + "$ref": "#/components/schemas/ingest._types:InferenceProcessor" + }, + "join": { + "$ref": "#/components/schemas/ingest._types:JoinProcessor" + }, + "json": { + "$ref": "#/components/schemas/ingest._types:JsonProcessor" + }, + "kv": { + "$ref": "#/components/schemas/ingest._types:KeyValueProcessor" + }, + "lowercase": { + "$ref": "#/components/schemas/ingest._types:LowercaseProcessor" + }, + "pipeline": { + "$ref": "#/components/schemas/ingest._types:PipelineProcessor" + }, + "remove": { + "$ref": "#/components/schemas/ingest._types:RemoveProcessor" + }, + "rename": { + "$ref": "#/components/schemas/ingest._types:RenameProcessor" + }, + "reroute": { + "$ref": "#/components/schemas/ingest._types:RerouteProcessor" + }, + "script": { + "$ref": "#/components/schemas/ingest._types:ScriptProcessor" + }, + "set": { + "$ref": "#/components/schemas/ingest._types:SetProcessor" + }, + "set_security_user": { + "$ref": "#/components/schemas/ingest._types:SetSecurityUserProcessor" + }, + "sort": { + "$ref": "#/components/schemas/ingest._types:SortProcessor" + }, + "split": { + "$ref": "#/components/schemas/ingest._types:SplitProcessor" + }, + "trim": { + "$ref": "#/components/schemas/ingest._types:TrimProcessor" + }, + "uppercase": { + "$ref": "#/components/schemas/ingest._types:UppercaseProcessor" + }, + "urldecode": { + "$ref": "#/components/schemas/ingest._types:UrlDecodeProcessor" + }, + "user_agent": { + "$ref": "#/components/schemas/ingest._types:UserAgentProcessor" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "ingest._types:AppendProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "value": { + "description": "The value to be appended. Supports template snippets.", + "type": "array", + "items": { + "type": "object" + } + }, + "allow_duplicates": { + "description": "If `false`, the processor does not append values already present in the field.", + "type": "boolean" + } + }, + "required": [ + "field", + "value" + ] + } + ] + }, + "ingest._types:ProcessorBase": { + "type": "object", + "properties": { + "description": { + "description": "Description of the processor.\nUseful for describing the purpose of the processor or its configuration.", + "type": "string" + }, + "if": { + "description": "Conditionally execute the processor.", + "type": "string" + }, + "ignore_failure": { + "description": "Ignore failures for the processor.", + "type": "boolean" + }, + "on_failure": { + "description": "Handle failures for the processor.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ingest._types:ProcessorContainer" + } + }, + "tag": { + "description": "Identifier for the processor.\nUseful for debugging and metrics.", + "type": "string" + } + } + }, + "ingest._types:AttachmentProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "ignore_missing": { + "description": "If `true` and field does not exist, the processor quietly exits without modifying the document.", + "type": "boolean" + }, + "indexed_chars": { + "description": "The number of chars being used for extraction to prevent huge fields.\nUse `-1` for no limit.", + "type": "number" + }, + "indexed_chars_field": { + "$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`.", + "type": "array", + "items": { + "type": "string" + } + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "remove_binary": { + "description": "If true, the binary field will be removed from the document", + "type": "boolean" + }, + "resource_name": { + "description": "Field containing the name of the resource to decode.\nIf specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection.", + "type": "string" + } + }, + "required": [ + "field" + ] + } + ] + }, + "ingest._types:BytesProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$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.", + "type": "boolean" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "field" + ] + } + ] + }, + "ingest._types:CircleProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "error_distance": { + "description": "The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for `geo_shape`, unit-less for `shape`).", + "type": "number" + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "ignore_missing": { + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", + "type": "boolean" + }, + "shape_type": { + "$ref": "#/components/schemas/ingest._types:ShapeType" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "error_distance", + "field", + "shape_type" + ] + } + ] + }, + "ingest._types:ShapeType": { + "type": "string", + "enum": [ + "geo_shape", + "shape" + ] + }, + "ingest._types:ConvertProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$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.", + "type": "boolean" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "type": { + "$ref": "#/components/schemas/ingest._types:ConvertType" + } + }, + "required": [ + "field", + "type" + ] + } + ] + }, + "ingest._types:ConvertType": { + "type": "string", + "enum": [ + "integer", + "long", + "float", + "double", + "string", + "boolean", + "auto" + ] + }, + "ingest._types:CsvProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "empty_value": { + "description": "Value used to fill empty fields.\nEmpty fields are skipped if this is not provided.\nAn empty field is one with no value (2 consecutive separators) or empty quotes (`\"\"`).", + "type": "object" + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "ignore_missing": { + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", + "type": "boolean" + }, + "quote": { + "description": "Quote used in CSV, has to be single character string.", + "type": "string" + }, + "separator": { + "description": "Separator used in CSV, has to be single character string.", + "type": "string" + }, + "target_fields": { + "$ref": "#/components/schemas/_types:Fields" + }, + "trim": { + "description": "Trim whitespaces in unquoted fields.", + "type": "boolean" + } + }, + "required": [ + "field", + "target_fields" + ] + } + ] + }, + "ingest._types:DateProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$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.", + "type": "array", + "items": { + "type": "string" + } + }, + "locale": { + "description": "The locale to use when parsing the date, relevant when parsing month names or week days.\nSupports template snippets.", + "type": "string" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "timezone": { + "description": "The timezone to use when parsing the date.\nSupports template snippets.", + "type": "string" + } + }, + "required": [ + "field", + "formats" + ] + } + ] + }, + "ingest._types:DateIndexNameProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "date_formats": { + "description": "An array of the expected date formats for parsing dates / timestamps in the document being preprocessed.\nCan be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N.", + "type": "array", + "items": { + "type": "string" + } + }, + "date_rounding": { + "description": "How to round the date when formatting the date into the index name. Valid values are:\n`y` (year), `M` (month), `w` (week), `d` (day), `h` (hour), `m` (minute) and `s` (second).\nSupports template snippets.", + "type": "string" + }, + "field": { + "$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.", + "type": "string" + }, + "index_name_prefix": { + "description": "A prefix of the index name to be prepended before the printed date.\nSupports template snippets.", + "type": "string" + }, + "locale": { + "description": "The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days.", + "type": "string" + }, + "timezone": { + "description": "The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names.", + "type": "string" + } + }, + "required": [ + "date_formats", + "date_rounding", + "field" + ] + } + ] + }, + "ingest._types:DissectProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "append_separator": { + "description": "The character(s) that separate the appended fields.", + "type": "string" + }, + "field": { + "$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.", + "type": "boolean" + }, + "pattern": { + "description": "The pattern to apply to the field.", + "type": "string" + } + }, + "required": [ + "field", + "pattern" + ] + } + ] + }, + "ingest._types:DotExpanderProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "path": { + "description": "The field that contains the field to expand.\nOnly required if the field to expand is part another object field, because the `field` option can only understand leaf fields.", + "type": "string" + } + }, + "required": [ + "field" + ] + } + ] + }, + "ingest._types:DropProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object" + } + ] + }, + "ingest._types:EnrichProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "ignore_missing": { + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", + "type": "boolean" + }, + "max_matches": { + "description": "The maximum number of matched documents to include under the configured target field.\nThe `target_field` will be turned into a json array if `max_matches` is higher than 1, otherwise `target_field` will become a json object.\nIn order to avoid documents getting too large, the maximum allowed value is 128.", + "type": "number" + }, + "override": { + "description": "If processor will update fields with pre-existing non-null-valued field.\nWhen set to `false`, such fields will not be touched.", + "type": "boolean" + }, + "policy_name": { + "description": "The name of the enrich policy to use.", + "type": "string" + }, + "shape_relation": { + "$ref": "#/components/schemas/_types:GeoShapeRelation" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "field", + "policy_name", + "target_field" + ] + } + ] + }, + "_types:GeoShapeRelation": { + "type": "string", + "enum": [ + "intersects", + "disjoint", + "within", + "contains" + ] + }, + "ingest._types:FailProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "message": { + "description": "The error message thrown by the processor.\nSupports template snippets.", + "type": "string" + } + }, + "required": [ + "message" + ] + } + ] + }, + "ingest._types:ForeachProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$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.", + "type": "boolean" + }, + "processor": { + "$ref": "#/components/schemas/ingest._types:ProcessorContainer" + } + }, + "required": [ + "field", + "processor" + ] + } + ] + }, + "ingest._types:GeoIpProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "database_file": { + "description": "The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory.", + "type": "string" + }, + "field": { + "$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.", + "type": "boolean" + }, + "ignore_missing": { + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", + "type": "boolean" + }, + "properties": { + "description": "Controls what properties are added to the `target_field` based on the geoip lookup.", + "type": "array", + "items": { + "type": "string" + } + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "field" + ] + } + ] + }, + "ingest._types:GrokProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$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.", + "type": "boolean" + }, + "pattern_definitions": { + "description": "A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor.\nPatterns matching existing names will override the pre-existing definition.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "patterns": { + "description": "An ordered list of grok expression to match and extract named captures with.\nReturns on the first expression in the list that matches.", + "type": "array", + "items": { + "type": "string" + } + }, + "trace_match": { + "description": "When `true`, `_ingest._grok_match_index` will be inserted into your matched document’s metadata with the index into the pattern found in `patterns` that matched.", + "type": "boolean" + } + }, + "required": [ + "field", + "patterns" + ] + } + ] + }, + "ingest._types:GsubProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$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.", + "type": "boolean" + }, + "pattern": { + "description": "The pattern to be replaced.", + "type": "string" + }, + "replacement": { + "description": "The string to replace the matching patterns with.", + "type": "string" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "field", + "pattern", + "replacement" + ] + } + ] + }, + "ingest._types:InferenceProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "model_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "target_field": { + "$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.", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "inference_config": { + "$ref": "#/components/schemas/ingest._types:InferenceConfig" + } + }, + "required": [ + "model_id" + ] + } + ] + }, + "ingest._types:InferenceConfig": { + "type": "object", + "properties": { + "regression": { + "$ref": "#/components/schemas/ingest._types:InferenceConfigRegression" + }, + "classification": { + "$ref": "#/components/schemas/ingest._types:InferenceConfigClassification" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "ingest._types:InferenceConfigRegression": { + "type": "object", + "properties": { + "results_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "num_top_feature_importance_values": { + "description": "Specifies the maximum number of feature importance values per document.", + "type": "number" + } + } + }, + "ingest._types:InferenceConfigClassification": { + "type": "object", + "properties": { + "num_top_classes": { + "description": "Specifies the number of top class predictions to return.", + "type": "number" + }, + "num_top_feature_importance_values": { + "description": "Specifies the maximum number of feature importance values per document.", + "type": "number" + }, + "results_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "top_classes_results_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "prediction_field_type": { + "description": "Specifies the type of the predicted field to write.\nValid values are: `string`, `number`, `boolean`.", + "type": "string" + } + } + }, + "ingest._types:JoinProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "separator": { + "description": "The separator character.", + "type": "string" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "field", + "separator" + ] + } + ] + }, + "ingest._types:JsonProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "add_to_root": { + "description": "Flag that forces the parsed JSON to be added at the top level of the document.\n`target_field` must not be set when this option is chosen.", + "type": "boolean" + }, + "add_to_root_conflict_strategy": { + "$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.", + "type": "boolean" + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "field" + ] + } + ] + }, + "ingest._types:JsonProcessorConflictStrategy": { + "type": "string", + "enum": [ + "replace", + "merge" + ] + }, + "ingest._types:KeyValueProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "exclude_keys": { + "description": "List of keys to exclude from document.", + "type": "array", + "items": { + "type": "string" + } + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "field_split": { + "description": "Regex pattern to use for splitting key-value pairs.", + "type": "string" + }, + "ignore_missing": { + "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", + "type": "boolean" + }, + "include_keys": { + "description": "List of keys to filter and insert into document.\nDefaults to including all keys.", + "type": "array", + "items": { + "type": "string" + } + }, + "prefix": { + "description": "Prefix to be added to extracted keys.", + "type": "string" + }, + "strip_brackets": { + "description": "If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `\"` from extracted values.", + "type": "boolean" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "trim_key": { + "description": "String of characters to trim from extracted keys.", + "type": "string" + }, + "trim_value": { + "description": "String of characters to trim from extracted values.", + "type": "string" + }, + "value_split": { + "description": "Regex pattern to use for splitting the key from the value within a key-value pair.", + "type": "string" + } + }, + "required": [ + "field", + "field_split", + "value_split" + ] + } + ] + }, + "ingest._types:LowercaseProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$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.", + "type": "boolean" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "field" + ] + } + ] + }, + "ingest._types:PipelineProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/_types:Name" + }, + "ignore_missing_pipeline": { + "description": "Whether to ignore missing pipelines instead of failing.", + "type": "boolean" + } + }, + "required": [ + "name" + ] + } + ] + }, + "ingest._types:RemoveProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Fields" + }, + "keep": { + "$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.", + "type": "boolean" + } + }, + "required": [ + "field" + ] + } + ] + }, + "ingest._types:RenameProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "ignore_missing": { + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", + "type": "boolean" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "field", + "target_field" + ] + } + ] + }, + "ingest._types:RerouteProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "destination": { + "description": "A static value for the target. Can’t be set when the dataset or namespace option is set.", + "type": "string" + }, + "dataset": { + "description": "Field references or a static value for the dataset part of the data stream name.\nIn addition to the criteria for index names, cannot contain - and must be no longer than 100 characters.\nExample values are nginx.access and nginx.error.\n\nSupports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces).\nWhen resolving field references, the processor replaces invalid characters with _. Uses the part\nof the index name as a fallback if all field references resolve to a null, missing, or non-string value.\n\ndefault {{data_stream.dataset}}", + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "namespace": { + "description": "Field references or a static value for the namespace part of the data stream name. See the criteria for\nindex names for allowed characters. Must be no longer than 100 characters.\n\nSupports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces).\nWhen resolving field references, the processor replaces invalid characters with _. Uses the part\nof the index name as a fallback if all field references resolve to a null, missing, or non-string value.\n\ndefault {{data_stream.namespace}}", + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + } + } + } + ] + }, + "ingest._types:ScriptProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "lang": { + "description": "Script language.", + "type": "string" + }, + "params": { + "description": "Object containing parameters for the script.", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "source": { + "description": "Inline script.\nIf no `id` is specified, this parameter is required.", + "type": "string" + } + } + } + ] + }, + "ingest._types:SetProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "copy_from": { + "$ref": "#/components/schemas/_types:Field" + }, + "field": { + "$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.", + "type": "boolean" + }, + "media_type": { + "description": "The media type for encoding `value`.\nApplies only when value is a template snippet.\nMust be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`.", + "type": "string" + }, + "override": { + "description": "If `true` processor will update fields with pre-existing non-null-valued field.\nWhen set to `false`, such fields will not be touched.", + "type": "boolean" + }, + "value": { + "description": "The value to be set for the field.\nSupports template snippets.\nMay specify only one of `value` or `copy_from`.", + "type": "object" + } + }, + "required": [ + "field" + ] + } + ] + }, + "ingest._types:SetSecurityUserProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "properties": { + "description": "Controls what user related properties are added to the field.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "field" + ] + } + ] + }, + "ingest._types:SortProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "order": { + "$ref": "#/components/schemas/_types:SortOrder" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "field" + ] + } + ] + }, + "ingest._types:SplitProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "ignore_missing": { + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", + "type": "boolean" + }, + "preserve_trailing": { + "description": "Preserves empty trailing fields, if any.", + "type": "boolean" + }, + "separator": { + "description": "A regex which matches the separator, for example, `,` or `\\s+`.", + "type": "string" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "field", + "separator" + ] + } + ] + }, + "ingest._types:TrimProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "ignore_missing": { + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", + "type": "boolean" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "field" + ] + } + ] + }, + "ingest._types:UppercaseProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$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.", + "type": "boolean" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "field" + ] + } + ] + }, + "ingest._types:UrlDecodeProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$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.", + "type": "boolean" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "field" + ] + } + ] + }, + "ingest._types:UserAgentProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "ignore_missing": { + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", + "type": "boolean" + }, + "options": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ingest._types:UserAgentProperty" + } + }, + "regex_file": { + "description": "The name of the file in the `config/ingest-user-agent` directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the `regexes.yaml` from uap-core it ships with.", + "type": "string" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "field" + ] + } + ] + }, + "ingest._types:UserAgentProperty": { + "type": "string", + "enum": [ + "NAME", + "MAJOR", + "MINOR", + "PATCH", + "OS", + "OS_NAME", + "OS_MAJOR", + "OS_MINOR", + "DEVICE", + "BUILD" + ] + }, + "ingest.simulate:Document": { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "_index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "_source": { + "description": "JSON body for the document.", + "type": "object" + } + }, + "required": [ + "_source" + ] + }, + "ingest.simulate:PipelineSimulation": { + "type": "object", + "properties": { + "doc": { + "$ref": "#/components/schemas/ingest.simulate:DocumentSimulation" + }, + "processor_results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ingest.simulate:PipelineSimulation" + } + }, + "tag": { + "type": "string" + }, + "processor_type": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/watcher._types:ActionStatusOptions" + } + } + }, + "ingest.simulate:DocumentSimulation": { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "_index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "_ingest": { + "$ref": "#/components/schemas/ingest.simulate:Ingest" + }, + "_routing": { + "description": "Value used to send the document to a specific primary shard.", + "type": "string" + }, + "_source": { + "description": "JSON body for the document.", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "_version": { + "$ref": "#/components/schemas/_spec_utils:StringifiedVersionNumber" + }, + "_version_type": { + "$ref": "#/components/schemas/_types:VersionType" + } + }, + "required": [ + "_id", + "_index", + "_ingest", + "_source" + ] + }, + "ingest.simulate:Ingest": { + "type": "object", + "properties": { + "timestamp": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "pipeline": { + "$ref": "#/components/schemas/_types:Name" + } + }, + "required": [ + "timestamp" + ] + }, + "_spec_utils:StringifiedVersionNumber": { + "description": "Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior\nis used to capture this behavior while keeping the semantics of the field type.\n\nDepending on the target language, code generators can keep the union or remove it and leniently parse\nstrings to the target type.", + "oneOf": [ + { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + { + "type": "string" + } + ] + }, + "watcher._types:ActionStatusOptions": { + "type": "string", + "enum": [ + "success", + "failure", + "simulated", + "throttled" + ] + }, + "license.get:LicenseInformation": { + "type": "object", + "properties": { + "expiry_date": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "expiry_date_in_millis": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "issue_date": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "issue_date_in_millis": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "issued_to": { + "type": "string" + }, + "issuer": { + "type": "string" + }, + "max_nodes": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "max_resource_units": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "status": { + "$ref": "#/components/schemas/license._types:LicenseStatus" + }, + "type": { + "$ref": "#/components/schemas/license._types:LicenseType" + }, + "uid": { + "$ref": "#/components/schemas/_types:Uuid" + }, + "start_date_in_millis": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + } + }, + "required": [ + "issue_date", + "issue_date_in_millis", + "issued_to", + "issuer", + "max_nodes", + "status", + "type", + "uid", + "start_date_in_millis" + ] + }, + "license._types:LicenseStatus": { + "type": "string", + "enum": [ + "active", + "valid", + "invalid", + "expired" + ] + }, + "license._types:LicenseType": { + "type": "string", + "enum": [ + "missing", + "trial", + "basic", + "standard", + "dev", + "silver", + "gold", + "platinum", + "enterprise" + ] + }, + "logstash._types:Pipeline": { + "type": "object", + "properties": { + "description": { + "description": "Description of the pipeline.\nThis description is not used by Elasticsearch or Logstash.", + "type": "string" + }, + "last_modified": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "pipeline_metadata": { + "$ref": "#/components/schemas/logstash._types:PipelineMetadata" + }, + "username": { + "description": "User who last updated the pipeline.", + "type": "string" + }, + "pipeline": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/logstash/current/configuration-file-structure.html" + }, + "description": "Configuration for the pipeline.", + "type": "string" + }, + "pipeline_settings": { + "$ref": "#/components/schemas/logstash._types:PipelineSettings" + } + }, + "required": [ + "description", + "last_modified", + "pipeline_metadata", + "username", + "pipeline", + "pipeline_settings" + ] + }, + "logstash._types:PipelineMetadata": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "required": [ + "type", + "version" + ] + }, + "logstash._types:PipelineSettings": { + "type": "object", + "properties": { + "pipeline.workers": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/logstash/current/logstash-settings-file.html" + }, + "description": "The number of workers that will, in parallel, execute the filter and output stages of the pipeline.", + "type": "number" + }, + "pipeline.batch.size": { + "description": "The maximum number of events an individual worker thread will collect from inputs before attempting to execute its filters and outputs.", + "type": "number" + }, + "pipeline.batch.delay": { + "description": "When creating pipeline event batches, how long in milliseconds to wait for each event before dispatching an undersized batch to pipeline workers.", + "type": "number" + }, + "queue.type": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/logstash/current/logstash-settings-file.html" + }, + "description": "The internal queuing model to use for event buffering.", + "type": "string" + }, + "queue.max_bytes.number": { + "description": "The total capacity of the queue (`queue.type: persisted`) in number of bytes.", + "type": "number" + }, + "queue.max_bytes.units": { + "description": "The total capacity of the queue (`queue.type: persisted`) in terms of units of bytes.", + "type": "string" + }, + "queue.checkpoint.writes": { + "description": "The maximum number of written events before forcing a checkpoint when persistent queues are enabled (`queue.type: persisted`).", + "type": "number" + } + }, + "required": [ + "pipeline.workers", + "pipeline.batch.size", + "pipeline.batch.delay", + "queue.type", + "queue.max_bytes.number", + "queue.max_bytes.units", + "queue.checkpoint.writes" + ] + }, + "_global.mget:Operation": { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "_index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "routing": { + "$ref": "#/components/schemas/_types:Routing" + }, + "_source": { + "$ref": "#/components/schemas/_global.search._types:SourceConfig" + }, + "stored_fields": { + "$ref": "#/components/schemas/_types:Fields" + }, + "version": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "version_type": { + "$ref": "#/components/schemas/_types:VersionType" + } + }, + "required": [ + "_id" + ] + }, + "_global.mget:ResponseItem": { + "oneOf": [ + { + "$ref": "#/components/schemas/_global.get:GetResult" + }, + { + "$ref": "#/components/schemas/_global.mget:MultiGetError" + } + ] + }, + "_global.mget:MultiGetError": { + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/_types:ErrorCause" + }, + "_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "_index": { + "$ref": "#/components/schemas/_types:IndexName" + } + }, + "required": [ + "error", + "_id", + "_index" + ] + }, + "ml._types:AnalysisConfig": { + "type": "object", + "properties": { + "bucket_span": { + "$ref": "#/components/schemas/_types:Duration" + }, + "categorization_analyzer": { + "$ref": "#/components/schemas/ml._types:CategorizationAnalyzer" + }, + "categorization_field_name": { + "$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.", + "type": "array", + "items": { + "type": "string" + } + }, + "detectors": { + "description": "Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job. If the detectors array does not contain at least one detector, no analysis can occur and an error is returned.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:Detector" + } + }, + "influencers": { + "description": "A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "latency": { + "$ref": "#/components/schemas/_types:Duration" + }, + "model_prune_window": { + "$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" + }, + "summary_count_field_name": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "detectors" + ] + }, + "ml._types:CategorizationAnalyzer": { + "oneOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/ml._types:CategorizationAnalyzerDefinition" + } + ] + }, + "ml._types:CategorizationAnalyzerDefinition": { + "type": "object", + "properties": { + "char_filter": { + "description": "One or more character filters. In addition to the built-in character filters, other plugins can provide more character filters. If this property is not specified, no character filters are applied prior to categorization. If you are customizing some other aspect of the analyzer and you need to achieve the equivalent of `categorization_filters` (which are not permitted when some other aspect of the analyzer is customized), add them here as pattern replace character filters.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.analysis:CharFilter" + } + }, + "filter": { + "description": "One or more token filters. In addition to the built-in token filters, other plugins can provide more token filters. If this property is not specified, no token filters are applied prior to categorization.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.analysis:TokenFilter" + } + }, + "tokenizer": { + "$ref": "#/components/schemas/_types.analysis:Tokenizer" + } + } + }, + "ml._types:Detector": { + "type": "object", + "properties": { + "by_field_name": { + "$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.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:DetectionRule" + } + }, + "detector_description": { + "description": "A description of the detector.", + "type": "string" + }, + "detector_index": { + "description": "A unique identifier for the detector. This identifier is based on the order of the detectors in the `analysis_config`, starting at zero. If you specify a value for this property, it is ignored.", + "type": "number" + }, + "exclude_frequent": { + "$ref": "#/components/schemas/ml._types:ExcludeFrequent" + }, + "field_name": { + "$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" + }, + "partition_field_name": { + "$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.", + "type": "boolean" + } + } + }, + "ml._types:DetectionRule": { + "type": "object", + "properties": { + "actions": { + "description": "The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:RuleAction" + } + }, + "conditions": { + "description": "An array of numeric conditions when the rule applies. A rule must either have a non-empty scope or at least one condition. Multiple conditions are combined together with a logical AND.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:RuleCondition" + } + }, + "scope": { + "description": "A scope of series where the rule applies. A rule must either have a non-empty scope or at least one condition. By default, the scope includes all series. Scoping is allowed for any of the fields that are also specified in `by_field_name`, `over_field_name`, or `partition_field_name`.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/ml._types:FilterRef" + } + } + } + }, + "ml._types:RuleAction": { + "type": "string", + "enum": [ + "skip_result", + "skip_model_update" + ] + }, + "ml._types:RuleCondition": { + "type": "object", + "properties": { + "applies_to": { + "$ref": "#/components/schemas/ml._types:AppliesTo" + }, + "operator": { + "$ref": "#/components/schemas/ml._types:ConditionOperator" + }, + "value": { + "description": "The value that is compared against the `applies_to` field using the operator.", + "type": "number" + } + }, + "required": [ + "applies_to", + "operator", + "value" + ] + }, + "ml._types:AppliesTo": { + "type": "string", + "enum": [ + "actual", + "typical", + "diff_from_typical", + "time" + ] + }, + "ml._types:ConditionOperator": { + "type": "string", + "enum": [ + "gt", + "gte", + "lt", + "lte" + ] + }, + "ml._types:FilterRef": { + "type": "object", + "properties": { + "filter_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "filter_type": { + "$ref": "#/components/schemas/ml._types:FilterType" + } + }, + "required": [ + "filter_id" + ] + }, + "ml._types:FilterType": { + "type": "string", + "enum": [ + "include", + "exclude" + ] + }, + "ml._types:ExcludeFrequent": { + "type": "string", + "enum": [ + "all", + "none", + "by", + "over" + ] + }, + "ml._types:PerPartitionCategorization": { + "type": "object", + "properties": { + "enabled": { + "description": "To enable this setting, you must also set the `partition_field_name` property to the same value in every detector that uses the keyword `mlcategory`. Otherwise, job creation fails.", + "type": "boolean" + }, + "stop_on_warn": { + "description": "This setting can be set to true only if per-partition categorization is enabled. If true, both categorization and subsequent anomaly detection stops for partitions where the categorization status changes to warn. This setting makes it viable to have a job where it is expected that categorization works well for some partitions but not others; you do not pay the cost of bad categorization forever in the partitions where it works badly.", + "type": "boolean" + } + } + }, + "ml._types:DataframeEvaluationContainer": { + "type": "object", + "properties": { + "classification": { + "$ref": "#/components/schemas/ml._types:DataframeEvaluationClassification" + }, + "outlier_detection": { + "$ref": "#/components/schemas/ml._types:DataframeEvaluationOutlierDetection" + }, + "regression": { + "$ref": "#/components/schemas/ml._types:DataframeEvaluationRegression" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "ml._types:DataframeEvaluationClassification": { + "type": "object", + "properties": { + "actual_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "predicted_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "top_classes_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "metrics": { + "$ref": "#/components/schemas/ml._types:DataframeEvaluationClassificationMetrics" + } + }, + "required": [ + "actual_field" + ] + }, + "ml._types:DataframeEvaluationClassificationMetrics": { + "allOf": [ + { + "$ref": "#/components/schemas/ml._types:DataframeEvaluationMetrics" + }, + { + "type": "object", + "properties": { + "accuracy": { + "description": "Accuracy of predictions (per-class and overall).", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "multiclass_confusion_matrix": { + "description": "Multiclass confusion matrix.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + } + ] + }, + "ml._types:DataframeEvaluationMetrics": { + "type": "object", + "properties": { + "auc_roc": { + "$ref": "#/components/schemas/ml._types:DataframeEvaluationClassificationMetricsAucRoc" + }, + "precision": { + "description": "Precision of predictions (per-class and average).", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "recall": { + "description": "Recall of predictions (per-class and average).", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "ml._types:DataframeEvaluationClassificationMetricsAucRoc": { + "type": "object", + "properties": { + "class_name": { + "$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.", + "type": "boolean" + } + } + }, + "ml._types:DataframeEvaluationOutlierDetection": { + "type": "object", + "properties": { + "actual_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "predicted_probability_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "metrics": { + "$ref": "#/components/schemas/ml._types:DataframeEvaluationOutlierDetectionMetrics" + } + }, + "required": [ + "actual_field", + "predicted_probability_field" + ] + }, + "ml._types:DataframeEvaluationOutlierDetectionMetrics": { + "allOf": [ + { + "$ref": "#/components/schemas/ml._types:DataframeEvaluationMetrics" + }, + { + "type": "object", + "properties": { + "confusion_matrix": { + "description": "Accuracy of predictions (per-class and overall).", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + } + ] + }, + "ml._types:DataframeEvaluationRegression": { + "type": "object", + "properties": { + "actual_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "predicted_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "metrics": { + "$ref": "#/components/schemas/ml._types:DataframeEvaluationRegressionMetrics" + } + }, + "required": [ + "actual_field", + "predicted_field" + ] + }, + "ml._types:DataframeEvaluationRegressionMetrics": { + "type": "object", + "properties": { + "mse": { + "externalDocs": { + "url": "https://en.wikipedia.org/wiki/Mean_squared_error" + }, + "description": "Average squared difference between the predicted values and the actual (ground truth) value. For more information, read this wiki article.", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "msle": { + "$ref": "#/components/schemas/ml._types:DataframeEvaluationRegressionMetricsMsle" + }, + "huber": { + "$ref": "#/components/schemas/ml._types:DataframeEvaluationRegressionMetricsHuber" + }, + "r_squared": { + "externalDocs": { + "url": "https://en.wikipedia.org/wiki/Coefficient_of_determination" + }, + "description": "Proportion of the variance in the dependent variable that is predictable from the independent variables.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "ml._types:DataframeEvaluationRegressionMetricsMsle": { + "type": "object", + "properties": { + "offset": { + "description": "Defines the transition point at which you switch from minimizing quadratic error to minimizing quadratic log error. Defaults to 1.", + "type": "number" + } + } + }, + "ml._types:DataframeEvaluationRegressionMetricsHuber": { + "type": "object", + "properties": { + "delta": { + "description": "Approximates 1/2 (prediction - actual)2 for values much less than delta and approximates a straight line with slope delta for values much larger than delta. Defaults to 1. Delta needs to be greater than 0.", + "type": "number" + } + } + }, + "ml.evaluate_data_frame:DataframeClassificationSummary": { + "type": "object", + "properties": { + "auc_roc": { + "$ref": "#/components/schemas/ml.evaluate_data_frame:DataframeEvaluationSummaryAucRoc" + }, + "accuracy": { + "$ref": "#/components/schemas/ml.evaluate_data_frame:DataframeClassificationSummaryAccuracy" + }, + "multiclass_confusion_matrix": { + "$ref": "#/components/schemas/ml.evaluate_data_frame:DataframeClassificationSummaryMulticlassConfusionMatrix" + }, + "precision": { + "$ref": "#/components/schemas/ml.evaluate_data_frame:DataframeClassificationSummaryPrecision" + }, + "recall": { + "$ref": "#/components/schemas/ml.evaluate_data_frame:DataframeClassificationSummaryRecall" + } + } + }, + "ml.evaluate_data_frame:DataframeEvaluationSummaryAucRoc": { + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame:DataframeEvaluationValue" + }, + { + "type": "object", + "properties": { + "curve": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ml.evaluate_data_frame:DataframeEvaluationSummaryAucRocCurveItem" + } + } + } + } + ] + }, + "ml.evaluate_data_frame:DataframeEvaluationSummaryAucRocCurveItem": { + "type": "object", + "properties": { + "tpr": { + "type": "number" + }, + "fpr": { + "type": "number" + }, + "threshold": { + "type": "number" + } + }, + "required": [ + "tpr", + "fpr", + "threshold" + ] + }, + "ml.evaluate_data_frame:DataframeEvaluationValue": { + "type": "object", + "properties": { + "value": { + "type": "number" + } + }, + "required": [ + "value" + ] + }, + "ml.evaluate_data_frame:DataframeClassificationSummaryAccuracy": { + "type": "object", + "properties": { + "classes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ml.evaluate_data_frame:DataframeEvaluationClass" + } + }, + "overall_accuracy": { + "type": "number" + } + }, + "required": [ + "classes", + "overall_accuracy" + ] + }, + "ml.evaluate_data_frame:DataframeEvaluationClass": { + "allOf": [ + { + "$ref": "#/components/schemas/ml.evaluate_data_frame:DataframeEvaluationValue" + }, + { + "type": "object", + "properties": { + "class_name": { + "$ref": "#/components/schemas/_types:Name" + } + }, + "required": [ + "class_name" + ] + } + ] + }, + "ml.evaluate_data_frame:DataframeClassificationSummaryMulticlassConfusionMatrix": { + "type": "object", + "properties": { + "confusion_matrix": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ml.evaluate_data_frame:ConfusionMatrixItem" + } + }, + "other_actual_class_count": { + "type": "number" + } + }, + "required": [ + "confusion_matrix", + "other_actual_class_count" + ] + }, + "ml.evaluate_data_frame:ConfusionMatrixItem": { + "type": "object", + "properties": { + "actual_class": { + "$ref": "#/components/schemas/_types:Name" + }, + "actual_class_doc_count": { + "type": "number" + }, + "predicted_classes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ml.evaluate_data_frame:ConfusionMatrixPrediction" + } + }, + "other_predicted_class_doc_count": { + "type": "number" + } + }, + "required": [ + "actual_class", + "actual_class_doc_count", + "predicted_classes", + "other_predicted_class_doc_count" + ] + }, + "ml.evaluate_data_frame:ConfusionMatrixPrediction": { + "type": "object", + "properties": { + "predicted_class": { + "$ref": "#/components/schemas/_types:Name" + }, + "count": { + "type": "number" + } + }, + "required": [ + "predicted_class", + "count" + ] + }, + "ml.evaluate_data_frame:DataframeClassificationSummaryPrecision": { + "type": "object", + "properties": { + "classes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ml.evaluate_data_frame:DataframeEvaluationClass" + } + }, + "avg_precision": { + "type": "number" + } + }, + "required": [ + "classes", + "avg_precision" + ] + }, + "ml.evaluate_data_frame:DataframeClassificationSummaryRecall": { + "type": "object", + "properties": { + "classes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ml.evaluate_data_frame:DataframeEvaluationClass" + } + }, + "avg_recall": { + "type": "number" + } + }, + "required": [ + "classes", + "avg_recall" + ] + }, + "ml.evaluate_data_frame:DataframeOutlierDetectionSummary": { + "type": "object", + "properties": { + "auc_roc": { + "$ref": "#/components/schemas/ml.evaluate_data_frame:DataframeEvaluationSummaryAucRoc" + }, + "precision": { + "description": "Set the different thresholds of the outlier score at where the metric is calculated.", + "type": "object", + "additionalProperties": { + "type": "number" + } + }, + "recall": { + "description": "Set the different thresholds of the outlier score at where the metric is calculated.", + "type": "object", + "additionalProperties": { + "type": "number" + } + }, + "confusion_matrix": { + "description": "Set the different thresholds of the outlier score at where the metrics (`tp` - true positive, `fp` - false positive, `tn` - true negative, `fn` - false negative) are calculated.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/ml.evaluate_data_frame:ConfusionMatrixThreshold" + } + } + } + }, + "ml.evaluate_data_frame:ConfusionMatrixThreshold": { + "type": "object", + "properties": { + "tp": { + "description": "True Positive", + "type": "number" + }, + "fp": { + "description": "False Positive", + "type": "number" + }, + "tn": { + "description": "True Negative", + "type": "number" + }, + "fn": { + "description": "False Negative", + "type": "number" + } + }, + "required": [ + "tp", + "fp", + "tn", + "fn" + ] + }, + "ml.evaluate_data_frame:DataframeRegressionSummary": { + "type": "object", + "properties": { + "huber": { + "$ref": "#/components/schemas/ml.evaluate_data_frame:DataframeEvaluationValue" + }, + "mse": { + "$ref": "#/components/schemas/ml.evaluate_data_frame:DataframeEvaluationValue" + }, + "msle": { + "$ref": "#/components/schemas/ml.evaluate_data_frame:DataframeEvaluationValue" + }, + "r_squared": { + "$ref": "#/components/schemas/ml.evaluate_data_frame:DataframeEvaluationValue" + } + } + }, + "ml._types:CalendarEvent": { + "type": "object", + "properties": { + "calendar_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "event_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "description": { + "description": "A description of the scheduled event.", + "type": "string" + }, + "end_time": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "start_time": { + "$ref": "#/components/schemas/_types:DateTime" + } + }, + "required": [ + "description", + "end_time", + "start_time" + ] + }, + "ml._types:Page": { + "type": "object", + "properties": { + "from": { + "description": "Skips the specified number of items.", + "type": "number" + }, + "size": { + "description": "Specifies the maximum number of items to obtain.", + "type": "number" + } + } + }, + "ml.get_calendars:Calendar": { + "type": "object", + "properties": { + "calendar_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "description": { + "description": "A description of the calendar.", + "type": "string" + }, + "job_ids": { + "description": "An array of anomaly detection job identifiers.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Id" + } + } + }, + "required": [ + "calendar_id", + "job_ids" + ] + }, + "ml._types:DataframeAnalyticsSummary": { + "type": "object", + "properties": { + "allow_lazy_start": { + "type": "boolean" + }, + "analysis": { + "$ref": "#/components/schemas/ml._types:DataframeAnalysisContainer" + }, + "analyzed_fields": { + "$ref": "#/components/schemas/ml._types:DataframeAnalysisAnalyzedFields" + }, + "authorization": { + "$ref": "#/components/schemas/ml._types:DataframeAnalyticsAuthorization" + }, + "create_time": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "description": { + "type": "string" + }, + "dest": { + "$ref": "#/components/schemas/ml._types:DataframeAnalyticsDestination" + }, + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "max_num_threads": { + "type": "number" + }, + "model_memory_limit": { + "type": "string" + }, + "source": { + "$ref": "#/components/schemas/ml._types:DataframeAnalyticsSource" + }, + "version": { + "$ref": "#/components/schemas/_types:VersionString" + } + }, + "required": [ + "analysis", + "dest", + "id", + "source" + ] + }, + "ml._types:DataframeAnalysisContainer": { + "type": "object", + "properties": { + "classification": { + "$ref": "#/components/schemas/ml._types:DataframeAnalysisClassification" + }, + "outlier_detection": { + "$ref": "#/components/schemas/ml._types:DataframeAnalysisOutlierDetection" + }, + "regression": { + "$ref": "#/components/schemas/ml._types:DataframeAnalysisRegression" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "ml._types:DataframeAnalysisClassification": { + "allOf": [ + { + "$ref": "#/components/schemas/ml._types:DataframeAnalysis" + }, + { + "type": "object", + "properties": { + "class_assignment_objective": { + "type": "string" + }, + "num_top_classes": { + "description": "Defines the number of categories for which the predicted probabilities are reported. It must be non-negative or -1. If it is -1 or greater than the total number of categories, probabilities are reported for all categories; if you have a large number of categories, there could be a significant effect on the size of your destination index. NOTE: To use the AUC ROC evaluation method, `num_top_classes` must be set to -1 or a value greater than or equal to the total number of categories.", + "type": "number" + } + } + } + ] + }, + "ml._types:DataframeAnalysis": { + "type": "object", + "properties": { + "alpha": { + "description": "Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero.", + "type": "number" + }, + "dependent_variable": { + "description": "Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable.\nFor classification analysis, the data type of the field must be numeric (`integer`, `short`, `long`, `byte`), categorical (`ip` or `keyword`), or `boolean`. There must be no more than 30 different values in this field.\nFor regression analysis, the data type of the field must be numeric.", + "type": "string" + }, + "downsample_factor": { + "description": "Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1.", + "type": "number" + }, + "early_stopping_enabled": { + "description": "Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable.", + "type": "boolean" + }, + "eta": { + "description": "Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1.", + "type": "number" + }, + "eta_growth_rate_per_tree": { + "description": "Advanced configuration option. Specifies the rate at which `eta` increases for each new tree that is added to the forest. For example, a rate of 1.05 increases `eta` by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2.", + "type": "number" + }, + "feature_bag_fraction": { + "description": "Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization.", + "type": "number" + }, + "feature_processors": { + "description": "Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple `feature_processors` entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:DataframeAnalysisFeatureProcessor" + } + }, + "gamma": { + "description": "Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value.", + "type": "number" + }, + "lambda": { + "description": "Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value.", + "type": "number" + }, + "max_optimization_rounds_per_hyperparameter": { + "description": "Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization.", + "type": "number" + }, + "max_trees": { + "description": "Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization.", + "type": "number" + }, + "num_top_feature_importance_values": { + "description": "Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs.", + "type": "number" + }, + "prediction_field_name": { + "$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).", + "type": "number" + }, + "soft_tree_depth_limit": { + "description": "Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.", + "type": "number" + }, + "soft_tree_depth_tolerance": { + "description": "Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01.", + "type": "number" + }, + "training_percent": { + "$ref": "#/components/schemas/_types:Percentage" + } + }, + "required": [ + "dependent_variable" + ] + }, + "ml._types:DataframeAnalysisFeatureProcessor": { + "type": "object", + "properties": { + "frequency_encoding": { + "$ref": "#/components/schemas/ml._types:DataframeAnalysisFeatureProcessorFrequencyEncoding" + }, + "multi_encoding": { + "$ref": "#/components/schemas/ml._types:DataframeAnalysisFeatureProcessorMultiEncoding" + }, + "n_gram_encoding": { + "$ref": "#/components/schemas/ml._types:DataframeAnalysisFeatureProcessorNGramEncoding" + }, + "one_hot_encoding": { + "$ref": "#/components/schemas/ml._types:DataframeAnalysisFeatureProcessorOneHotEncoding" + }, + "target_mean_encoding": { + "$ref": "#/components/schemas/ml._types:DataframeAnalysisFeatureProcessorTargetMeanEncoding" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "ml._types:DataframeAnalysisFeatureProcessorFrequencyEncoding": { + "type": "object", + "properties": { + "feature_name": { + "$ref": "#/components/schemas/_types:Name" + }, + "field": { + "$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.", + "type": "object", + "additionalProperties": { + "type": "number" + } + } + }, + "required": [ + "feature_name", + "field", + "frequency_map" + ] + }, + "ml._types:DataframeAnalysisFeatureProcessorMultiEncoding": { + "type": "object", + "properties": { + "processors": { + "description": "The ordered array of custom processors to execute. Must be more than 1.", + "type": "array", + "items": { + "type": "number" + } + } + }, + "required": [ + "processors" + ] + }, + "ml._types:DataframeAnalysisFeatureProcessorNGramEncoding": { + "type": "object", + "properties": { + "feature_prefix": { + "description": "The feature name prefix. Defaults to ngram__.", + "type": "string" + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "length": { + "description": "Specifies the length of the n-gram substring. Defaults to 50. Must be greater than 0.", + "type": "number" + }, + "n_grams": { + "description": "Specifies which n-grams to gather. It’s an array of integer values where the minimum value is 1, and a maximum value is 5.", + "type": "array", + "items": { + "type": "number" + } + }, + "start": { + "description": "Specifies the zero-indexed start of the n-gram substring. Negative values are allowed for encoding n-grams of string suffixes. Defaults to 0.", + "type": "number" + }, + "custom": { + "type": "boolean" + } + }, + "required": [ + "field", + "n_grams" + ] + }, + "ml._types:DataframeAnalysisFeatureProcessorOneHotEncoding": { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "hot_map": { + "description": "The one hot map mapping the field value with the column name.", + "type": "string" + } + }, + "required": [ + "field", + "hot_map" + ] + }, + "ml._types:DataframeAnalysisFeatureProcessorTargetMeanEncoding": { + "type": "object", + "properties": { + "default_value": { + "description": "The default value if field value is not found in the target_map.", + "type": "number" + }, + "feature_name": { + "$ref": "#/components/schemas/_types:Name" + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "target_map": { + "description": "The field value to target mean transition map.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "required": [ + "default_value", + "feature_name", + "field", + "target_map" + ] + }, + "_types:Percentage": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + } + ] + }, + "ml._types:DataframeAnalysisOutlierDetection": { + "type": "object", + "properties": { + "compute_feature_influence": { + "description": "Specifies whether the feature influence calculation is enabled.", + "type": "boolean" + }, + "feature_influence_threshold": { + "description": "The minimum outlier score that a document needs to have in order to calculate its feature influence score. Value range: 0-1.", + "type": "number" + }, + "method": { + "description": "The method that outlier detection uses. Available methods are `lof`, `ldof`, `distance_kth_nn`, `distance_knn`, and `ensemble`. The default value is ensemble, which means that outlier detection uses an ensemble of different methods and normalises and combines their individual outlier scores to obtain the overall outlier score.", + "type": "string" + }, + "n_neighbors": { + "description": "Defines the value for how many nearest neighbors each method of outlier detection uses to calculate its outlier score. When the value is not set, different values are used for different ensemble members. This default behavior helps improve the diversity in the ensemble; only override it if you are confident that the value you choose is appropriate for the data set.", + "type": "number" + }, + "outlier_fraction": { + "description": "The proportion of the data set that is assumed to be outlying prior to outlier detection. For example, 0.05 means it is assumed that 5% of values are real outliers and 95% are inliers.", + "type": "number" + }, + "standardization_enabled": { + "description": "If true, the following operation is performed on the columns before computing outlier scores: `(x_i - mean(x_i)) / sd(x_i)`.", + "type": "boolean" + } + } + }, + "ml._types:DataframeAnalysisRegression": { + "allOf": [ + { + "$ref": "#/components/schemas/ml._types:DataframeAnalysis" + }, + { + "type": "object", + "properties": { + "loss_function": { + "description": "The loss function used during regression. Available options are `mse` (mean squared error), `msle` (mean squared logarithmic error), `huber` (Pseudo-Huber loss).", + "type": "string" + }, + "loss_function_parameter": { + "description": "A positive number that is used as a parameter to the `loss_function`.", + "type": "number" + } + } + } + ] + }, + "ml._types:DataframeAnalysisAnalyzedFields": { + "type": "object", + "properties": { + "includes": { + "description": "An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically.", + "type": "array", + "items": { + "type": "string" + } + }, + "excludes": { + "description": "An array of strings that defines the fields that will be included in the analysis.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "includes", + "excludes" + ] + }, + "ml._types:DataframeAnalyticsAuthorization": { + "type": "object", + "properties": { + "api_key": { + "$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.", + "type": "array", + "items": { + "type": "string" + } + }, + "service_account": { + "description": "If a service account was used for the most recent update to the job, the account name is listed in the response.", + "type": "string" + } + } + }, + "ml._types:ApiKeyAuthorization": { + "type": "object", + "properties": { + "id": { + "description": "The identifier for the API key.", + "type": "string" + }, + "name": { + "description": "The name of the API key.", + "type": "string" + } + }, + "required": [ + "id", + "name" + ] + }, + "ml._types:DataframeAnalyticsDestination": { + "type": "object", + "properties": { + "index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "results_field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "index" + ] + }, + "ml._types:DataframeAnalyticsSource": { + "type": "object", + "properties": { + "index": { + "$ref": "#/components/schemas/_types:Indices" + }, + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "runtime_mappings": { + "$ref": "#/components/schemas/_types.mapping:RuntimeFields" + }, + "_source": { + "$ref": "#/components/schemas/ml._types:DataframeAnalysisAnalyzedFields" + } + }, + "required": [ + "index" + ] + }, + "ml._types:DataframeAnalytics": { + "type": "object", + "properties": { + "analysis_stats": { + "$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" + }, + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "memory_usage": { + "$ref": "#/components/schemas/ml._types:DataframeAnalyticsStatsMemoryUsage" + }, + "progress": { + "description": "The progress report of the data frame analytics job by phase.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:DataframeAnalyticsStatsProgress" + } + }, + "state": { + "$ref": "#/components/schemas/ml._types:DataframeState" + } + }, + "required": [ + "data_counts", + "id", + "memory_usage", + "progress", + "state" + ] + }, + "ml._types:DataframeAnalyticsStatsContainer": { + "type": "object", + "properties": { + "classification_stats": { + "$ref": "#/components/schemas/ml._types:DataframeAnalyticsStatsHyperparameters" + }, + "outlier_detection_stats": { + "$ref": "#/components/schemas/ml._types:DataframeAnalyticsStatsOutlierDetection" + }, + "regression_stats": { + "$ref": "#/components/schemas/ml._types:DataframeAnalyticsStatsHyperparameters" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "ml._types:DataframeAnalyticsStatsHyperparameters": { + "type": "object", + "properties": { + "hyperparameters": { + "$ref": "#/components/schemas/ml._types:Hyperparameters" + }, + "iteration": { + "description": "The number of iterations on the analysis.", + "type": "number" + }, + "timestamp": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "timing_stats": { + "$ref": "#/components/schemas/ml._types:TimingStats" + }, + "validation_loss": { + "$ref": "#/components/schemas/ml._types:ValidationLoss" + } + }, + "required": [ + "hyperparameters", + "iteration", + "timestamp", + "timing_stats", + "validation_loss" + ] + }, + "ml._types:Hyperparameters": { + "type": "object", + "properties": { + "alpha": { + "description": "Advanced configuration option.\nMachine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly.\nThis parameter affects loss calculations by acting as a multiplier of the tree depth.\nHigher alpha values result in shallower trees and faster training times.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be greater than or equal to zero.", + "type": "number" + }, + "lambda": { + "description": "Advanced configuration option.\nRegularization parameter to prevent overfitting on the training data set.\nMultiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest.\nA high lambda value causes training to favor small leaf weights.\nThis behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable.\nA small lambda value results in large individual trees and slower training.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be a nonnegative value.", + "type": "number" + }, + "gamma": { + "description": "Advanced configuration option.\nRegularization parameter to prevent overfitting on the training data set.\nMultiplies a linear penalty associated with the size of individual trees in the forest.\nA high gamma value causes training to prefer small trees.\nA small gamma value results in larger individual trees and slower training.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be a nonnegative value.", + "type": "number" + }, + "eta": { + "description": "Advanced configuration option.\nThe shrinkage applied to the weights.\nSmaller values result in larger forests which have a better generalization error.\nHowever, larger forests cause slower training.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be a value between `0.001` and `1`.", + "type": "number" + }, + "eta_growth_rate_per_tree": { + "description": "Advanced configuration option.\nSpecifies the rate at which `eta` increases for each new tree that is added to the forest.\nFor example, a rate of 1.05 increases `eta` by 5% for each extra tree.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be between `0.5` and `2`.", + "type": "number" + }, + "feature_bag_fraction": { + "description": "Advanced configuration option.\nDefines the fraction of features that will be used when selecting a random bag for each candidate split.\nBy default, this value is calculated during hyperparameter optimization.", + "type": "number" + }, + "downsample_factor": { + "description": "Advanced configuration option.\nControls the fraction of data that is used to compute the derivatives of the loss function for tree training.\nA small value results in the use of a small fraction of the data.\nIf this value is set to be less than 1, accuracy typically improves.\nHowever, too small a value may result in poor convergence for the ensemble and so require more trees.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be greater than zero and less than or equal to 1.", + "type": "number" + }, + "max_attempts_to_add_tree": { + "description": "If the algorithm fails to determine a non-trivial tree (more than a single leaf), this parameter determines how many of such consecutive failures are tolerated.\nOnce the number of attempts exceeds the threshold, the forest training stops.", + "type": "number" + }, + "max_optimization_rounds_per_hyperparameter": { + "description": "Advanced configuration option.\nA multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure.\nThe maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter.\nBy default, this value is calculated during hyperparameter optimization.", + "type": "number" + }, + "max_trees": { + "description": "Advanced configuration option.\nDefines the maximum number of decision trees in the forest.\nThe maximum value is 2000.\nBy default, this value is calculated during hyperparameter optimization.", + "type": "number" + }, + "num_folds": { + "description": "The maximum number of folds for the cross-validation procedure.", + "type": "number" + }, + "num_splits_per_feature": { + "description": "Determines the maximum number of splits for every feature that can occur in a decision tree when the tree is trained.", + "type": "number" + }, + "soft_tree_depth_limit": { + "description": "Advanced configuration option.\nMachine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly.\nThis soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be greater than or equal to 0.", + "type": "number" + }, + "soft_tree_depth_tolerance": { + "description": "Advanced configuration option.\nThis option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be greater than or equal to 0.01.", + "type": "number" + } + } + }, + "ml._types:TimingStats": { + "type": "object", + "properties": { + "elapsed_time": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + }, + "iteration_time": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + } + }, + "required": [ + "elapsed_time" + ] + }, + "ml._types:ValidationLoss": { + "type": "object", + "properties": { + "fold_values": { + "description": "Validation loss values for every added decision tree during the forest growing procedure.", + "type": "array", + "items": { + "type": "string" + } + }, + "loss_type": { + "description": "The type of the loss metric. For example, binomial_logistic.", + "type": "string" + } + }, + "required": [ + "fold_values", + "loss_type" + ] + }, + "ml._types:DataframeAnalyticsStatsOutlierDetection": { + "type": "object", + "properties": { + "parameters": { + "$ref": "#/components/schemas/ml._types:OutlierDetectionParameters" + }, + "timestamp": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "timing_stats": { + "$ref": "#/components/schemas/ml._types:TimingStats" + } + }, + "required": [ + "parameters", + "timestamp", + "timing_stats" + ] + }, + "ml._types:OutlierDetectionParameters": { + "type": "object", + "properties": { + "compute_feature_influence": { + "description": "Specifies whether the feature influence calculation is enabled.", + "type": "boolean" + }, + "feature_influence_threshold": { + "description": "The minimum outlier score that a document needs to have in order to calculate its feature influence score.\nValue range: 0-1", + "type": "number" + }, + "method": { + "description": "The method that outlier detection uses.\nAvailable methods are `lof`, `ldof`, `distance_kth_nn`, `distance_knn`, and `ensemble`.\nThe default value is ensemble, which means that outlier detection uses an ensemble of different methods and normalises and combines their individual outlier scores to obtain the overall outlier score.", + "type": "string" + }, + "n_neighbors": { + "description": "Defines the value for how many nearest neighbors each method of outlier detection uses to calculate its outlier score.\nWhen the value is not set, different values are used for different ensemble members.\nThis default behavior helps improve the diversity in the ensemble; only override it if you are confident that the value you choose is appropriate for the data set.", + "type": "number" + }, + "outlier_fraction": { + "description": "The proportion of the data set that is assumed to be outlying prior to outlier detection.\nFor example, 0.05 means it is assumed that 5% of values are real outliers and 95% are inliers.", + "type": "number" + }, + "standardization_enabled": { + "description": "If `true`, the following operation is performed on the columns before computing outlier scores: (x_i - mean(x_i)) / sd(x_i).", + "type": "boolean" + } + } + }, + "ml._types:DataframeAnalyticsStatsDataCounts": { + "type": "object", + "properties": { + "skipped_docs_count": { + "description": "The number of documents that are skipped during the analysis because they contained values that are not supported by the analysis. For example, outlier detection does not support missing fields so it skips documents with missing fields. Likewise, all types of analysis skip documents that contain arrays with more than one element.", + "type": "number" + }, + "test_docs_count": { + "description": "The number of documents that are not used for training the model and can be used for testing.", + "type": "number" + }, + "training_docs_count": { + "description": "The number of documents that are used for training the model.", + "type": "number" + } + }, + "required": [ + "skipped_docs_count", + "test_docs_count", + "training_docs_count" + ] + }, + "ml._types:DataframeAnalyticsStatsMemoryUsage": { + "type": "object", + "properties": { + "memory_reestimate_bytes": { + "description": "This value is present when the status is hard_limit and it is a new estimate of how much memory the job needs.", + "type": "number" + }, + "peak_usage_bytes": { + "description": "The number of bytes used at the highest peak of memory usage.", + "type": "number" + }, + "status": { + "description": "The memory usage status.", + "type": "string" + }, + "timestamp": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + } + }, + "required": [ + "peak_usage_bytes", + "status" + ] + }, + "ml._types:DataframeAnalyticsStatsProgress": { + "type": "object", + "properties": { + "phase": { + "description": "Defines the phase of the data frame analytics job.", + "type": "string" + }, + "progress_percent": { + "description": "The progress that the data frame analytics job has made expressed in percentage.", + "type": "number" + } + }, + "required": [ + "phase", + "progress_percent" + ] + }, + "ml._types:DataframeState": { + "type": "string", + "enum": [ + "started", + "stopped", + "starting", + "stopping", + "failed" + ] + }, + "ml._types:DatafeedStats": { + "type": "object", + "properties": { + "assignment_explanation": { + "description": "For started datafeeds only, contains messages relating to the selection of a node.", + "type": "string" + }, + "datafeed_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "state": { + "$ref": "#/components/schemas/ml._types:DatafeedState" + }, + "timing_stats": { + "$ref": "#/components/schemas/ml._types:DatafeedTimingStats" + }, + "running_state": { + "$ref": "#/components/schemas/ml._types:DatafeedRunningState" + } + }, + "required": [ + "datafeed_id", + "state", + "timing_stats" + ] + }, + "ml._types:DatafeedTimingStats": { + "type": "object", + "properties": { + "bucket_count": { + "description": "The number of buckets processed.", + "type": "number" + }, + "exponential_average_search_time_per_hour_ms": { + "$ref": "#/components/schemas/_types:DurationValueUnitFloatMillis" + }, + "job_id": { + "$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" + }, + "average_search_time_per_bucket_ms": { + "$ref": "#/components/schemas/_types:DurationValueUnitFloatMillis" + } + }, + "required": [ + "bucket_count", + "exponential_average_search_time_per_hour_ms", + "job_id", + "search_count", + "total_search_time_ms" + ] + }, + "_types:DurationValueUnitFloatMillis": { + "allOf": [ + { + "$ref": "#/components/schemas/_types:UnitFloatMillis" + } + ] + }, + "_types:UnitFloatMillis": { + "description": "Time unit for fractional milliseconds", + "type": "number" + }, + "ml._types:DatafeedRunningState": { + "type": "object", + "properties": { + "real_time_configured": { + "description": "Indicates if the datafeed is \"real-time\"; meaning that the datafeed has no configured `end` time.", + "type": "boolean" + }, + "real_time_running": { + "description": "Indicates whether the datafeed has finished running on the available past data.\nFor datafeeds without a configured `end` time, this means that the datafeed is now running on \"real-time\" data.", + "type": "boolean" + }, + "search_interval": { + "$ref": "#/components/schemas/ml._types:RunningStateSearchInterval" + } + }, + "required": [ + "real_time_configured", + "real_time_running" + ] + }, + "ml._types:RunningStateSearchInterval": { + "type": "object", + "properties": { + "end": { + "$ref": "#/components/schemas/_types:Duration" + }, + "end_ms": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + }, + "start": { + "$ref": "#/components/schemas/_types:Duration" + }, + "start_ms": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + } + }, + "required": [ + "end_ms", + "start_ms" + ] + }, + "ml._types:Datafeed": { + "type": "object", + "properties": { + "aggregations": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:AggregationContainer" + } + }, + "authorization": { + "$ref": "#/components/schemas/ml._types:DatafeedAuthorization" + }, + "chunking_config": { + "$ref": "#/components/schemas/ml._types:ChunkingConfig" + }, + "datafeed_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "frequency": { + "$ref": "#/components/schemas/_types:Duration" + }, + "indices": { + "type": "array", + "items": { + "type": "string" + } + }, + "indexes": { + "type": "array", + "items": { + "type": "string" + } + }, + "job_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "max_empty_searches": { + "type": "number" + }, + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "query_delay": { + "$ref": "#/components/schemas/_types:Duration" + }, + "script_fields": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types:ScriptField" + } + }, + "scroll_size": { + "type": "number" + }, + "delayed_data_check_config": { + "$ref": "#/components/schemas/ml._types:DelayedDataCheckConfig" + }, + "runtime_mappings": { + "$ref": "#/components/schemas/_types.mapping:RuntimeFields" + }, + "indices_options": { + "$ref": "#/components/schemas/_types:IndicesOptions" + } + }, + "required": [ + "datafeed_id", + "indices", + "job_id", + "query", + "delayed_data_check_config" + ] + }, + "ml._types:DatafeedAuthorization": { + "type": "object", + "properties": { + "api_key": { + "$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.", + "type": "array", + "items": { + "type": "string" + } + }, + "service_account": { + "description": "If a service account was used for the most recent update to the datafeed, the account name is listed in the response.", + "type": "string" + } + } + }, + "ml._types:ChunkingConfig": { + "type": "object", + "properties": { + "mode": { + "$ref": "#/components/schemas/ml._types:ChunkingMode" + }, + "time_span": { + "$ref": "#/components/schemas/_types:Duration" + } + }, + "required": [ + "mode" + ] + }, + "ml._types:ChunkingMode": { + "type": "string", + "enum": [ + "auto", + "manual", + "off" + ] + }, + "ml._types:DelayedDataCheckConfig": { + "type": "object", + "properties": { + "check_window": { + "$ref": "#/components/schemas/_types:Duration" + }, + "enabled": { + "description": "Specifies whether the datafeed periodically checks for delayed data.", + "type": "boolean" + } + }, + "required": [ + "enabled" + ] + }, + "_types:IndicesOptions": { + "type": "object", + "properties": { + "allow_no_indices": { + "description": "If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only\nmissing or closed indices. This behavior applies even if the request targets other open indices. For example,\na request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.", + "type": "boolean" + }, + "expand_wildcards": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "ignore_unavailable": { + "description": "If true, missing or closed indices are not included in the response.", + "type": "boolean" + }, + "ignore_throttled": { + "description": "If true, concrete, expanded or aliased indices are ignored when frozen.", + "type": "boolean" + } + } + }, + "ml._types:Filter": { + "type": "object", + "properties": { + "description": { + "description": "A description of the filter.", + "type": "string" + }, + "filter_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "items": { + "description": "An array of strings which is the filter item list.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "filter_id", + "items" + ] + }, + "ml._types:JobStats": { + "type": "object", + "properties": { + "assignment_explanation": { + "description": "For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job.", + "type": "string" + }, + "data_counts": { + "$ref": "#/components/schemas/ml._types:DataCounts" + }, + "forecasts_stats": { + "$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" + }, + "open_time": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "state": { + "$ref": "#/components/schemas/ml._types:JobState" + }, + "timing_stats": { + "$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`.", + "type": "boolean" + } + }, + "required": [ + "data_counts", + "forecasts_stats", + "job_id", + "model_size_stats", + "state", + "timing_stats" + ] + }, + "ml._types:DataCounts": { + "type": "object", + "properties": { + "bucket_count": { + "type": "number" + }, + "earliest_record_timestamp": { + "type": "number" + }, + "empty_bucket_count": { + "type": "number" + }, + "input_bytes": { + "type": "number" + }, + "input_field_count": { + "type": "number" + }, + "input_record_count": { + "type": "number" + }, + "invalid_date_count": { + "type": "number" + }, + "job_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "last_data_time": { + "type": "number" + }, + "latest_empty_bucket_timestamp": { + "type": "number" + }, + "latest_record_timestamp": { + "type": "number" + }, + "latest_sparse_bucket_timestamp": { + "type": "number" + }, + "latest_bucket_timestamp": { + "type": "number" + }, + "log_time": { + "type": "number" + }, + "missing_field_count": { + "type": "number" + }, + "out_of_order_timestamp_count": { + "type": "number" + }, + "processed_field_count": { + "type": "number" + }, + "processed_record_count": { + "type": "number" + }, + "sparse_bucket_count": { + "type": "number" + } + }, + "required": [ + "bucket_count", + "empty_bucket_count", + "input_bytes", + "input_field_count", + "input_record_count", + "invalid_date_count", + "job_id", + "missing_field_count", + "out_of_order_timestamp_count", + "processed_field_count", + "processed_record_count", + "sparse_bucket_count" + ] + }, + "ml._types:JobForecastStatistics": { + "type": "object", + "properties": { + "memory_bytes": { + "$ref": "#/components/schemas/ml._types:JobStatistics" + }, + "processing_time_ms": { + "$ref": "#/components/schemas/ml._types:JobStatistics" + }, + "records": { + "$ref": "#/components/schemas/ml._types:JobStatistics" + }, + "status": { + "type": "object", + "additionalProperties": { + "type": "number" + } + }, + "total": { + "type": "number" + }, + "forecasted_jobs": { + "type": "number" + } + }, + "required": [ + "total", + "forecasted_jobs" + ] + }, + "ml._types:JobStatistics": { + "type": "object", + "properties": { + "avg": { + "type": "number" + }, + "max": { + "type": "number" + }, + "min": { + "type": "number" + }, + "total": { + "type": "number" + } + }, + "required": [ + "avg", + "max", + "min", + "total" + ] + }, + "ml._types:ModelSizeStats": { + "type": "object", + "properties": { + "bucket_allocation_failures_count": { + "type": "number" + }, + "job_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "log_time": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "memory_status": { + "$ref": "#/components/schemas/ml._types:MemoryStatus" + }, + "model_bytes": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "model_bytes_exceeded": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "model_bytes_memory_limit": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "peak_model_bytes": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "assignment_memory_basis": { + "type": "string" + }, + "result_type": { + "type": "string" + }, + "total_by_field_count": { + "type": "number" + }, + "total_over_field_count": { + "type": "number" + }, + "total_partition_field_count": { + "type": "number" + }, + "categorization_status": { + "$ref": "#/components/schemas/ml._types:CategorizationStatus" + }, + "categorized_doc_count": { + "type": "number" + }, + "dead_category_count": { + "type": "number" + }, + "failed_category_count": { + "type": "number" + }, + "frequent_category_count": { + "type": "number" + }, + "rare_category_count": { + "type": "number" + }, + "total_category_count": { + "type": "number" + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "bucket_allocation_failures_count", + "job_id", + "log_time", + "memory_status", + "model_bytes", + "result_type", + "total_by_field_count", + "total_over_field_count", + "total_partition_field_count", + "categorization_status", + "categorized_doc_count", + "dead_category_count", + "failed_category_count", + "frequent_category_count", + "rare_category_count", + "total_category_count" + ] + }, + "ml._types:JobTimingStats": { + "type": "object", + "properties": { + "average_bucket_processing_time_ms": { + "$ref": "#/components/schemas/_types:DurationValueUnitFloatMillis" + }, + "bucket_count": { + "type": "number" + }, + "exponential_average_bucket_processing_time_ms": { + "$ref": "#/components/schemas/_types:DurationValueUnitFloatMillis" + }, + "exponential_average_bucket_processing_time_per_hour_ms": { + "$ref": "#/components/schemas/_types:DurationValueUnitFloatMillis" + }, + "job_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "total_bucket_processing_time_ms": { + "$ref": "#/components/schemas/_types:DurationValueUnitFloatMillis" + }, + "maximum_bucket_processing_time_ms": { + "$ref": "#/components/schemas/_types:DurationValueUnitFloatMillis" + }, + "minimum_bucket_processing_time_ms": { + "$ref": "#/components/schemas/_types:DurationValueUnitFloatMillis" + } + }, + "required": [ + "bucket_count", + "exponential_average_bucket_processing_time_per_hour_ms", + "job_id", + "total_bucket_processing_time_ms" + ] + }, + "ml._types:Job": { + "type": "object", + "properties": { + "allow_lazy_open": { + "description": "Advanced configuration option.\nSpecifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node.", + "type": "boolean" + }, + "analysis_config": { + "$ref": "#/components/schemas/ml._types:AnalysisConfig" + }, + "analysis_limits": { + "$ref": "#/components/schemas/ml._types:AnalysisLimits" + }, + "background_persist_interval": { + "$ref": "#/components/schemas/_types:Duration" + }, + "blocked": { + "$ref": "#/components/schemas/ml._types:JobBlocked" + }, + "create_time": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "custom_settings": { + "$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`.", + "type": "number" + }, + "data_description": { + "$ref": "#/components/schemas/ml._types:DataDescription" + }, + "datafeed_config": { + "$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`.", + "type": "boolean" + }, + "description": { + "description": "A description of the job.", + "type": "string" + }, + "finished_time": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "groups": { + "description": "A list of job groups.\nA job can belong to no groups or many.", + "type": "array", + "items": { + "type": "string" + } + }, + "job_id": { + "$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" + }, + "model_plot_config": { + "$ref": "#/components/schemas/ml._types:ModelPlotConfig" + }, + "model_snapshot_id": { + "$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.", + "type": "number" + }, + "renormalization_window_days": { + "description": "Advanced configuration option.\nThe period over which adjustments to the score are applied, as new data is seen.\nThe default value is the longer of 30 days or 100 `bucket_spans`.", + "type": "number" + }, + "results_index_name": { + "$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.", + "type": "number" + } + }, + "required": [ + "allow_lazy_open", + "analysis_config", + "data_description", + "job_id", + "model_snapshot_retention_days", + "results_index_name" + ] + }, + "ml._types:AnalysisLimits": { + "type": "object", + "properties": { + "categorization_examples_limit": { + "description": "The maximum number of examples stored per category in memory and in the results data store. If you increase this value, more examples are available, however it requires that you have more storage available. If you set this value to 0, no examples are stored. NOTE: The `categorization_examples_limit` applies only to analysis that uses categorization.", + "type": "number" + }, + "model_memory_limit": { + "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.", + "type": "string" + } + } + }, + "ml._types:JobBlocked": { + "type": "object", + "properties": { + "reason": { + "$ref": "#/components/schemas/ml._types:JobBlockedReason" + }, + "task_id": { + "$ref": "#/components/schemas/_types:TaskId" + } + }, + "required": [ + "reason" + ] + }, + "ml._types:JobBlockedReason": { + "type": "string", + "enum": [ + "delete", + "reset", + "revert" + ] + }, + "ml._types:CustomSettings": { + "description": "Custom metadata about the job", + "type": "object" + }, + "ml._types:DataDescription": { + "type": "object", + "properties": { + "format": { + "description": "Only JSON format is supported at this time.", + "type": "string" + }, + "time_field": { + "$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.", + "type": "string" + }, + "field_delimiter": { + "type": "string" + } + } + }, + "ml._types:ModelPlotConfig": { + "type": "object", + "properties": { + "annotations_enabled": { + "description": "If true, enables calculation and storage of the model change annotations for each entity that is being analyzed.", + "x-available-since": "7.9.0", + "type": "boolean" + }, + "enabled": { + "description": "If true, enables calculation and storage of the model bounds for each entity that is being analyzed.", + "type": "boolean" + }, + "terms": { + "$ref": "#/components/schemas/_types:Field" + } + } + }, + "ml._types:OverallBucket": { + "type": "object", + "properties": { + "bucket_span": { + "$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.", + "type": "boolean" + }, + "jobs": { + "description": "An array of objects that contain the max_anomaly_score per job_id.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:OverallBucketJob" + } + }, + "overall_score": { + "description": "The top_n average of the maximum bucket anomaly_score per job.", + "type": "number" + }, + "result_type": { + "description": "Internal. This is always set to overall_bucket.", + "type": "string" + }, + "timestamp": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "timestamp_string": { + "$ref": "#/components/schemas/_types:DateTime" + } + }, + "required": [ + "bucket_span", + "is_interim", + "jobs", + "overall_score", + "result_type", + "timestamp", + "timestamp_string" + ] + }, + "_types:DurationValueUnitSeconds": { + "allOf": [ + { + "$ref": "#/components/schemas/_types:UnitSeconds" + } + ] + }, + "ml._types:OverallBucketJob": { + "type": "object", + "properties": { + "job_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "max_anomaly_score": { + "type": "number" + } + }, + "required": [ + "job_id", + "max_anomaly_score" + ] + }, + "ml._types:Include": { + "type": "string", + "enum": [ + "definition", + "feature_importance_baseline", + "hyperparameters", + "total_feature_importance", + "definition_status" + ] + }, + "ml._types:TrainedModelConfig": { + "type": "object", + "properties": { + "model_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "model_type": { + "$ref": "#/components/schemas/ml._types:TrainedModelType" + }, + "tags": { + "description": "A comma delimited string of tags. A trained model can have many tags, or none.", + "type": "array", + "items": { + "type": "string" + } + }, + "version": { + "$ref": "#/components/schemas/_types:VersionString" + }, + "compressed_definition": { + "type": "string" + }, + "created_by": { + "description": "Information on the creator of the trained model.", + "type": "string" + }, + "create_time": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "default_field_map": { + "description": "Any field map described in the inference configuration takes precedence.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "description": { + "description": "The free-text description of the trained model.", + "type": "string" + }, + "estimated_heap_memory_usage_bytes": { + "description": "The estimated heap usage in bytes to keep the trained model in memory.", + "type": "number" + }, + "estimated_operations": { + "description": "The estimated number of operations to use the trained model.", + "type": "number" + }, + "fully_defined": { + "description": "True if the full model definition is present.", + "type": "boolean" + }, + "inference_config": { + "$ref": "#/components/schemas/ml._types:InferenceConfigCreateContainer" + }, + "input": { + "$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" + }, + "model_size_bytes": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "location": { + "$ref": "#/components/schemas/ml._types:TrainedModelLocation" + }, + "prefix_strings": { + "$ref": "#/components/schemas/ml._types:TrainedModelPrefixStrings" + } + }, + "required": [ + "model_id", + "tags", + "input" + ] + }, + "ml._types:TrainedModelType": { + "type": "string", + "enum": [ + "tree_ensemble", + "lang_ident", + "pytorch" + ] + }, + "ml._types:InferenceConfigCreateContainer": { + "description": "Inference configuration provided when storing the model config", + "type": "object", + "properties": { + "regression": { + "$ref": "#/components/schemas/ml._types:RegressionInferenceOptions" + }, + "classification": { + "$ref": "#/components/schemas/ml._types:ClassificationInferenceOptions" + }, + "text_classification": { + "$ref": "#/components/schemas/ml._types:TextClassificationInferenceOptions" + }, + "zero_shot_classification": { + "$ref": "#/components/schemas/ml._types:ZeroShotClassificationInferenceOptions" + }, + "fill_mask": { + "$ref": "#/components/schemas/ml._types:FillMaskInferenceOptions" + }, + "ner": { + "$ref": "#/components/schemas/ml._types:NerInferenceOptions" + }, + "pass_through": { + "$ref": "#/components/schemas/ml._types:PassThroughInferenceOptions" + }, + "text_embedding": { + "$ref": "#/components/schemas/ml._types:TextEmbeddingInferenceOptions" + }, + "text_expansion": { + "$ref": "#/components/schemas/ml._types:TextExpansionInferenceOptions" + }, + "question_answering": { + "$ref": "#/components/schemas/ml._types:QuestionAnsweringInferenceOptions" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "ml._types:TextClassificationInferenceOptions": { + "type": "object", + "properties": { + "num_top_classes": { + "description": "Specifies the number of top class predictions to return. Defaults to 0.", + "type": "number" + }, + "tokenization": { + "$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" + }, + "classification_labels": { + "description": "Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ml._types:TokenizationConfigContainer": { + "description": "Tokenization options stored in inference configuration", + "type": "object", + "properties": { + "bert": { + "$ref": "#/components/schemas/ml._types:NlpBertTokenizationConfig" + }, + "mpnet": { + "$ref": "#/components/schemas/ml._types:NlpBertTokenizationConfig" + }, + "roberta": { + "$ref": "#/components/schemas/ml._types:NlpRobertaTokenizationConfig" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "ml._types:NlpBertTokenizationConfig": { + "type": "object", + "properties": { + "do_lower_case": { + "description": "Should the tokenizer lower case the text", + "type": "boolean" + }, + "with_special_tokens": { + "description": "Is tokenization completed with special tokens", + "type": "boolean" + }, + "max_sequence_length": { + "description": "Maximum input sequence length for the model", + "type": "number" + }, + "truncate": { + "$ref": "#/components/schemas/ml._types:TokenizationTruncate" + }, + "span": { + "description": "Tokenization spanning options. Special value of -1 indicates no spanning takes place", + "type": "number" + } + } + }, + "ml._types:TokenizationTruncate": { + "type": "string", + "enum": [ + "first", + "second", + "none" + ] + }, + "ml._types:NlpRobertaTokenizationConfig": { + "type": "object", + "properties": { + "add_prefix_space": { + "description": "Should the tokenizer prefix input with a space character", + "type": "boolean" + }, + "with_special_tokens": { + "description": "Is tokenization completed with special tokens", + "type": "boolean" + }, + "max_sequence_length": { + "description": "Maximum input sequence length for the model", + "type": "number" + }, + "truncate": { + "$ref": "#/components/schemas/ml._types:TokenizationTruncate" + }, + "span": { + "description": "Tokenization spanning options. Special value of -1 indicates no spanning takes place", + "type": "number" + } + } + }, + "ml._types:ZeroShotClassificationInferenceOptions": { + "type": "object", + "properties": { + "tokenization": { + "$ref": "#/components/schemas/ml._types:TokenizationConfigContainer" + }, + "hypothesis_template": { + "description": "Hypothesis template used when tokenizing labels for prediction", + "type": "string" + }, + "classification_labels": { + "description": "The zero shot classification labels indicating entailment, neutral, and contradiction\nMust contain exactly and only entailment, neutral, and contradiction", + "type": "array", + "items": { + "type": "string" + } + }, + "results_field": { + "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", + "type": "string" + }, + "multi_label": { + "description": "Indicates if more than one true label exists.", + "type": "boolean" + }, + "labels": { + "description": "The labels to predict.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "classification_labels" + ] + }, + "ml._types:FillMaskInferenceOptions": { + "type": "object", + "properties": { + "mask_token": { + "description": "The string/token which will be removed from incoming documents and replaced with the inference prediction(s).\nIn a response, this field contains the mask token for the specified model/tokenizer. Each model and tokenizer\nhas a predefined mask token which cannot be changed. Thus, it is recommended not to set this value in requests.\nHowever, if this field is present in a request, its value must match the predefined value for that model/tokenizer,\notherwise the request will fail.", + "type": "string" + }, + "num_top_classes": { + "description": "Specifies the number of top class predictions to return. Defaults to 0.", + "type": "number" + }, + "tokenization": { + "$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" + } + } + }, + "ml._types:NerInferenceOptions": { + "type": "object", + "properties": { + "tokenization": { + "$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" + }, + "classification_labels": { + "description": "The token classification labels. Must be IOB formatted tags", + "type": "array", + "items": { + "type": "string" + } + }, + "vocabulary": { + "$ref": "#/components/schemas/ml._types:Vocabulary" + } + } + }, + "ml._types:Vocabulary": { + "type": "object", + "properties": { + "index": { + "$ref": "#/components/schemas/_types:IndexName" + } + }, + "required": [ + "index" + ] + }, + "ml._types:PassThroughInferenceOptions": { + "type": "object", + "properties": { + "tokenization": { + "$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" + } + } + }, + "ml._types:TextEmbeddingInferenceOptions": { + "type": "object", + "properties": { + "embedding_size": { + "description": "The number of dimensions in the embedding output", + "type": "number" + }, + "tokenization": { + "$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" + } + } + }, + "ml._types:TextExpansionInferenceOptions": { + "type": "object", + "properties": { + "tokenization": { + "$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" + } + } + }, + "ml._types:QuestionAnsweringInferenceOptions": { + "type": "object", + "properties": { + "num_top_classes": { + "description": "Specifies the number of top class predictions to return. Defaults to 0.", + "type": "number" + }, + "tokenization": { + "$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" + }, + "max_answer_length": { + "description": "The maximum answer length to consider", + "type": "number" + } + } + }, + "ml._types:TrainedModelConfigInput": { + "type": "object", + "properties": { + "field_names": { + "description": "An array of input field names for the model.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Field" + } + } + }, + "required": [ + "field_names" + ] + }, + "ml._types:TrainedModelConfigMetadata": { + "type": "object", + "properties": { + "model_aliases": { + "type": "array", + "items": { + "type": "string" + } + }, + "feature_importance_baseline": { + "description": "An object that contains the baseline for feature importance values. For regression analysis, it is a single value. For classification analysis, there is a value for each class.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "hyperparameters": { + "description": "List of the available hyperparameters optimized during the fine_parameter_tuning phase as well as specified by the user.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:Hyperparameter" + } + }, + "total_feature_importance": { + "description": "An array of the total feature importance for each feature used from the training data set. This array of objects is returned if data frame analytics trained the model and the request includes total_feature_importance in the include request parameter.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:TotalFeatureImportance" + } + } + } + }, + "ml._types:Hyperparameter": { + "type": "object", + "properties": { + "absolute_importance": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/machine-learning/current/dfa-regression-lossfunction.html" + }, + "description": "A positive number showing how much the parameter influences the variation of the loss function. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization.", + "type": "number" + }, + "name": { + "$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.", + "type": "number" + }, + "supplied": { + "description": "Indicates if the hyperparameter is specified by the user (true) or optimized (false).", + "type": "boolean" + }, + "value": { + "description": "The value of the hyperparameter, either optimized or specified by the user.", + "type": "number" + } + }, + "required": [ + "name", + "supplied", + "value" + ] + }, + "ml._types:TotalFeatureImportance": { + "type": "object", + "properties": { + "feature_name": { + "$ref": "#/components/schemas/_types:Name" + }, + "importance": { + "description": "A collection of feature importance statistics related to the training data set for this particular feature.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:TotalFeatureImportanceStatistics" + } + }, + "classes": { + "description": "If the trained model is a classification model, feature importance statistics are gathered per target class value.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:TotalFeatureImportanceClass" + } + } + }, + "required": [ + "feature_name", + "importance", + "classes" + ] + }, + "ml._types:TotalFeatureImportanceStatistics": { + "type": "object", + "properties": { + "mean_magnitude": { + "description": "The average magnitude of this feature across all the training data. This value is the average of the absolute values of the importance for this feature.", + "type": "number" + }, + "max": { + "description": "The maximum importance value across all the training data for this feature.", + "type": "number" + }, + "min": { + "description": "The minimum importance value across all the training data for this feature.", + "type": "number" + } + }, + "required": [ + "mean_magnitude", + "max", + "min" + ] + }, + "ml._types:TotalFeatureImportanceClass": { + "type": "object", + "properties": { + "class_name": { + "$ref": "#/components/schemas/_types:Name" + }, + "importance": { + "description": "A collection of feature importance statistics related to the training data set for this particular feature.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:TotalFeatureImportanceStatistics" + } + } + }, + "required": [ + "class_name", + "importance" + ] + }, + "ml._types:TrainedModelLocation": { + "type": "object", + "properties": { + "index": { + "$ref": "#/components/schemas/ml._types:TrainedModelLocationIndex" + } + }, + "required": [ + "index" + ] + }, + "ml._types:TrainedModelLocationIndex": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/_types:IndexName" + } + }, + "required": [ + "name" + ] + }, + "ml._types:TrainedModelPrefixStrings": { + "type": "object", + "properties": { + "ingest": { + "description": "String prepended to input at ingest", + "type": "string" + }, + "search": { + "description": "String prepended to input at search", + "type": "string" + } + } + }, + "ml._types:TrainedModelStats": { + "type": "object", + "properties": { + "deployment_stats": { + "$ref": "#/components/schemas/ml._types:TrainedModelDeploymentStats" + }, + "inference_stats": { + "$ref": "#/components/schemas/ml._types:TrainedModelInferenceStats" + }, + "ingest": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html" + }, + "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.", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "model_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "model_size_stats": { + "$ref": "#/components/schemas/ml._types:TrainedModelSizeStats" + }, + "pipeline_count": { + "description": "The number of ingest pipelines that currently refer to the model.", + "type": "number" + } + }, + "required": [ + "model_id", + "model_size_stats", + "pipeline_count" + ] + }, + "ml._types:TrainedModelDeploymentStats": { + "type": "object", + "properties": { + "allocation_status": { + "$ref": "#/components/schemas/ml._types:TrainedModelDeploymentAllocationStatus" + }, + "cache_size": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "deployment_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "error_count": { + "description": "The sum of `error_count` for all nodes in the deployment.", + "type": "number" + }, + "inference_count": { + "description": "The sum of `inference_count` for all nodes in the deployment.", + "type": "number" + }, + "model_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "nodes": { + "$ref": "#/components/schemas/ml._types:TrainedModelDeploymentNodesStats" + }, + "number_of_allocations": { + "description": "The number of allocations requested.", + "type": "number" + }, + "queue_capacity": { + "description": "The number of inference requests that can be queued before new requests are rejected.", + "type": "number" + }, + "rejected_execution_count": { + "description": "The sum of `rejected_execution_count` for all nodes in the deployment.\nIndividual nodes reject an inference request if the inference queue is full.\nThe queue size is controlled by the `queue_capacity` setting in the start\ntrained model deployment API.", + "type": "number" + }, + "reason": { + "description": "The reason for the current deployment state. Usually only populated when\nthe model is not deployed to a node.", + "type": "string" + }, + "start_time": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "state": { + "$ref": "#/components/schemas/ml._types:DeploymentState" + }, + "threads_per_allocation": { + "description": "The number of threads used be each allocation during inference.", + "type": "number" + }, + "timeout_count": { + "description": "The sum of `timeout_count` for all nodes in the deployment.", + "type": "number" + } + }, + "required": [ + "allocation_status", + "deployment_id", + "error_count", + "inference_count", + "model_id", + "nodes", + "number_of_allocations", + "queue_capacity", + "rejected_execution_count", + "reason", + "start_time", + "state", + "threads_per_allocation", + "timeout_count" + ] + }, + "ml._types:TrainedModelDeploymentAllocationStatus": { + "type": "object", + "properties": { + "allocation_count": { + "description": "The current number of nodes where the model is allocated.", + "type": "number" + }, + "state": { + "$ref": "#/components/schemas/ml._types:DeploymentAllocationState" + }, + "target_allocation_count": { + "description": "The desired number of nodes for model allocation.", + "type": "number" + } + }, + "required": [ + "allocation_count", + "state", + "target_allocation_count" + ] + }, + "ml._types:DeploymentAllocationState": { + "type": "string", + "enum": [ + "started", + "starting", + "fully_allocated" + ] + }, + "ml._types:TrainedModelDeploymentNodesStats": { + "type": "object", + "properties": { + "average_inference_time_ms": { + "$ref": "#/components/schemas/_types:DurationValueUnitFloatMillis" + }, + "error_count": { + "description": "The number of errors when evaluating the trained model.", + "type": "number" + }, + "inference_count": { + "description": "The total number of inference calls made against this node for this model.", + "type": "number" + }, + "last_access": { + "description": "The epoch time stamp of the last inference call for the model on this node.", + "type": "number" + }, + "number_of_allocations": { + "description": "The number of allocations assigned to this node.", + "type": "number" + }, + "number_of_pending_requests": { + "description": "The number of inference requests queued to be processed.", + "type": "number" + }, + "rejection_execution_count": { + "description": "The number of inference requests that were not processed because the queue was full.", + "type": "number" + }, + "routing_state": { + "$ref": "#/components/schemas/ml._types:TrainedModelAssignmentRoutingTable" + }, + "start_time": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "threads_per_allocation": { + "description": "The number of threads used by each allocation during inference.", + "type": "number" + }, + "timeout_count": { + "description": "The number of inference requests that timed out before being processed.", + "type": "number" + } + }, + "required": [ + "average_inference_time_ms", + "error_count", + "inference_count", + "last_access", + "number_of_allocations", + "number_of_pending_requests", + "rejection_execution_count", + "routing_state", + "start_time", + "threads_per_allocation", + "timeout_count" + ] + }, + "ml._types:TrainedModelAssignmentRoutingTable": { + "type": "object", + "properties": { + "reason": { + "description": "The reason for the current state. It is usually populated only when the\n`routing_state` is `failed`.", + "type": "string" + }, + "routing_state": { + "$ref": "#/components/schemas/ml._types:RoutingState" + }, + "current_allocations": { + "description": "Current number of allocations.", + "type": "number" + }, + "target_allocations": { + "description": "Target number of allocations.", + "type": "number" + } + }, + "required": [ + "reason", + "routing_state", + "current_allocations", + "target_allocations" + ] + }, + "ml._types:RoutingState": { + "type": "string", + "enum": [ + "failed", + "started", + "starting", + "stopped", + "stopping" + ] + }, + "ml._types:DeploymentState": { + "type": "string", + "enum": [ + "started", + "starting", + "stopping" + ] + }, + "ml._types:TrainedModelInferenceStats": { + "type": "object", + "properties": { + "cache_miss_count": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html" + }, + "description": "The number of times the model was loaded for inference and was not retrieved from the cache.\nIf this number is close to the `inference_count`, the cache is not being appropriately used.\nThis can be solved by increasing the cache size or its time-to-live (TTL).\nRefer to general machine learning settings for the appropriate settings.", + "type": "number" + }, + "failure_count": { + "description": "The number of failures when using the model for inference.", + "type": "number" + }, + "inference_count": { + "description": "The total number of times the model has been called for inference.\nThis is across all inference contexts, including all pipelines.", + "type": "number" + }, + "missing_all_fields_count": { + "description": "The number of inference calls where all the training features for the model were missing.", + "type": "number" + }, + "timestamp": { + "$ref": "#/components/schemas/_types:DateTime" + } + }, + "required": [ + "cache_miss_count", + "failure_count", + "inference_count", + "missing_all_fields_count", + "timestamp" + ] + }, + "ml._types:TrainedModelSizeStats": { + "type": "object", + "properties": { + "model_size_bytes": { + "$ref": "#/components/schemas/_types:ByteSize" + }, + "required_native_memory_bytes": { + "$ref": "#/components/schemas/_types:ByteSize" + } + }, + "required": [ + "model_size_bytes", + "required_native_memory_bytes" + ] + }, + "ml._types:InferenceConfigUpdateContainer": { + "type": "object", + "properties": { + "regression": { + "$ref": "#/components/schemas/ml._types:RegressionInferenceOptions" + }, + "classification": { + "$ref": "#/components/schemas/ml._types:ClassificationInferenceOptions" + }, + "text_classification": { + "$ref": "#/components/schemas/ml._types:TextClassificationInferenceUpdateOptions" + }, + "zero_shot_classification": { + "$ref": "#/components/schemas/ml._types:ZeroShotClassificationInferenceUpdateOptions" + }, + "fill_mask": { + "$ref": "#/components/schemas/ml._types:FillMaskInferenceUpdateOptions" + }, + "ner": { + "$ref": "#/components/schemas/ml._types:NerInferenceUpdateOptions" + }, + "pass_through": { + "$ref": "#/components/schemas/ml._types:PassThroughInferenceUpdateOptions" + }, + "text_embedding": { + "$ref": "#/components/schemas/ml._types:TextEmbeddingInferenceUpdateOptions" + }, + "text_expansion": { + "$ref": "#/components/schemas/ml._types:TextExpansionInferenceUpdateOptions" + }, + "question_answering": { + "$ref": "#/components/schemas/ml._types:QuestionAnsweringInferenceUpdateOptions" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "ml._types:TextClassificationInferenceUpdateOptions": { + "type": "object", + "properties": { + "num_top_classes": { + "description": "Specifies the number of top class predictions to return. Defaults to 0.", + "type": "number" + }, + "tokenization": { + "$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.", + "type": "string" + }, + "classification_labels": { + "description": "Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ml._types:NlpTokenizationUpdateOptions": { + "type": "object", + "properties": { + "truncate": { + "$ref": "#/components/schemas/ml._types:TokenizationTruncate" + }, + "span": { + "description": "Span options to apply", + "type": "number" + } + } + }, + "ml._types:ZeroShotClassificationInferenceUpdateOptions": { + "type": "object", + "properties": { + "tokenization": { + "$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.", + "type": "string" + }, + "multi_label": { + "description": "Update the configured multi label option. Indicates if more than one true label exists. Defaults to the configured value.", + "type": "boolean" + }, + "labels": { + "description": "The labels to predict.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "labels" + ] + }, + "ml._types:FillMaskInferenceUpdateOptions": { + "type": "object", + "properties": { + "num_top_classes": { + "description": "Specifies the number of top class predictions to return. Defaults to 0.", + "type": "number" + }, + "tokenization": { + "$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.", + "type": "string" + } + } + }, + "ml._types:NerInferenceUpdateOptions": { + "type": "object", + "properties": { + "tokenization": { + "$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.", + "type": "string" + } + } + }, + "ml._types:PassThroughInferenceUpdateOptions": { + "type": "object", + "properties": { + "tokenization": { + "$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.", + "type": "string" + } + } + }, + "ml._types:TextEmbeddingInferenceUpdateOptions": { + "type": "object", + "properties": { + "tokenization": { + "$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.", + "type": "string" + } + } + }, + "ml._types:TextExpansionInferenceUpdateOptions": { + "type": "object", + "properties": { + "tokenization": { + "$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.", + "type": "string" + } + } + }, + "ml._types:QuestionAnsweringInferenceUpdateOptions": { + "type": "object", + "properties": { + "question": { + "description": "The question to answer given the inference context", + "type": "string" + }, + "num_top_classes": { + "description": "Specifies the number of top class predictions to return. Defaults to 0.", + "type": "number" + }, + "tokenization": { + "$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.", + "type": "string" + }, + "max_answer_length": { + "description": "The maximum answer length to consider for extraction", + "type": "number" + } + }, + "required": [ + "question" + ] + }, + "ml._types:InferenceResponseResult": { + "type": "object", + "properties": { + "entities": { + "description": "If the model is trained for named entity recognition (NER) tasks, the response contains the recognized entities.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:TrainedModelEntities" + } + }, + "is_truncated": { + "description": "Indicates whether the input text was truncated to meet the model's maximum sequence length limit. This property\nis present only when it is true.", + "type": "boolean" + }, + "predicted_value": { + "description": "If the model is trained for a text classification or zero shot classification task, the response is the\npredicted class.\nFor named entity recognition (NER) tasks, it contains the annotated text output.\nFor fill mask tasks, it contains the top prediction for replacing the mask token.\nFor text embedding tasks, it contains the raw numerical text embedding values.\nFor regression models, its a numerical value\nFor classification models, it may be an integer, double, boolean or string depending on prediction type", + "oneOf": [ + { + "$ref": "#/components/schemas/ml._types:PredictedValue" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:PredictedValue" + } + } + ] + }, + "predicted_value_sequence": { + "description": "For fill mask tasks, the response contains the input text sequence with the mask token replaced by the predicted\nvalue.\nAdditionally", + "type": "string" + }, + "prediction_probability": { + "description": "Specifies a probability for the predicted value.", + "type": "number" + }, + "prediction_score": { + "description": "Specifies a confidence score for the predicted value.", + "type": "number" + }, + "top_classes": { + "description": "For fill mask, text classification, and zero shot classification tasks, the response contains a list of top\nclass entries.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:TopClassEntry" + } + }, + "warning": { + "description": "If the request failed, the response contains the reason for the failure.", + "type": "string" + }, + "feature_importance": { + "description": "The feature importance for the inference results. Relevant only for classification or regression models", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:TrainedModelInferenceFeatureImportance" + } + } + } + }, + "ml._types:TrainedModelEntities": { + "type": "object", + "properties": { + "class_name": { + "type": "string" + }, + "class_probability": { + "type": "number" + }, + "entity": { + "type": "string" + }, + "start_pos": { + "type": "number" + }, + "end_pos": { + "type": "number" + } + }, + "required": [ + "class_name", + "class_probability", + "entity", + "start_pos", + "end_pos" + ] + }, + "ml._types:PredictedValue": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "number" + } + ] + }, + "ml._types:TopClassEntry": { + "type": "object", + "properties": { + "class_name": { + "type": "string" + }, + "class_probability": { + "type": "number" + }, + "class_score": { + "type": "number" + } + }, + "required": [ + "class_name", + "class_probability", + "class_score" + ] + }, + "ml._types:TrainedModelInferenceFeatureImportance": { + "type": "object", + "properties": { + "feature_name": { + "type": "string" + }, + "importance": { + "type": "number" + }, + "classes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:TrainedModelInferenceClassImportance" + } + } + }, + "required": [ + "feature_name" + ] + }, + "ml._types:TrainedModelInferenceClassImportance": { + "type": "object", + "properties": { + "class_name": { + "type": "string" + }, + "importance": { + "type": "number" + } + }, + "required": [ + "class_name", + "importance" + ] + }, + "ml.preview_data_frame_analytics:DataframePreviewConfig": { + "type": "object", + "properties": { + "source": { + "$ref": "#/components/schemas/ml._types:DataframeAnalyticsSource" + }, + "analysis": { + "$ref": "#/components/schemas/ml._types:DataframeAnalysisContainer" + }, + "model_memory_limit": { + "type": "string" + }, + "max_num_threads": { + "type": "number" + }, + "analyzed_fields": { + "$ref": "#/components/schemas/ml._types:DataframeAnalysisAnalyzedFields" + } + }, + "required": [ + "source", + "analysis" + ] + }, + "ml._types:DatafeedConfig": { + "type": "object", + "properties": { + "aggregations": { + "description": "If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:AggregationContainer" + } + }, + "chunking_config": { + "$ref": "#/components/schemas/ml._types:ChunkingConfig" + }, + "datafeed_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "delayed_data_check_config": { + "$ref": "#/components/schemas/ml._types:DelayedDataCheckConfig" + }, + "frequency": { + "$ref": "#/components/schemas/_types:Duration" + }, + "indices": { + "$ref": "#/components/schemas/_types:Indices" + }, + "indices_options": { + "$ref": "#/components/schemas/_types:IndicesOptions" + }, + "job_id": { + "$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" + }, + "query_delay": { + "$ref": "#/components/schemas/_types:Duration" + }, + "runtime_mappings": { + "$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.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types:ScriptField" + } + }, + "scroll_size": { + "description": "The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value of `index.max_result_window`, which is 10,000 by default.", + "type": "number" + } + } + }, + "ml._types:JobConfig": { + "type": "object", + "properties": { + "allow_lazy_open": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html" + }, + "description": "Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node.", + "type": "boolean" + }, + "analysis_config": { + "$ref": "#/components/schemas/ml._types:AnalysisConfig" + }, + "analysis_limits": { + "$ref": "#/components/schemas/ml._types:AnalysisLimits" + }, + "background_persist_interval": { + "$ref": "#/components/schemas/_types:Duration" + }, + "custom_settings": { + "$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.", + "type": "number" + }, + "data_description": { + "$ref": "#/components/schemas/ml._types:DataDescription" + }, + "datafeed_config": { + "$ref": "#/components/schemas/ml._types:DatafeedConfig" + }, + "description": { + "description": "A description of the job.", + "type": "string" + }, + "groups": { + "description": "A list of job groups. A job can belong to no groups or many.", + "type": "array", + "items": { + "type": "string" + } + }, + "job_id": { + "$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" + }, + "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.", + "type": "number" + }, + "renormalization_window_days": { + "description": "Advanced configuration option.\nThe period over which adjustments to the score are applied, as new data is seen.\nThe default value is the longer of 30 days or 100 `bucket_spans`.", + "type": "number" + }, + "results_index_name": { + "$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.", + "type": "number" + } + }, + "required": [ + "analysis_config", + "data_description" + ] + }, + "_types:HttpHeaders": { + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + } + }, + "ml._types:AnalysisConfigRead": { + "type": "object", + "properties": { + "bucket_span": { + "$ref": "#/components/schemas/_types:Duration" + }, + "categorization_analyzer": { + "$ref": "#/components/schemas/ml._types:CategorizationAnalyzer" + }, + "categorization_field_name": { + "$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.", + "type": "array", + "items": { + "type": "string" + } + }, + "detectors": { + "description": "An array of detector configuration objects.\nDetector configuration objects specify which data fields a job analyzes.\nThey also specify which analytical functions are used.\nYou can specify multiple detectors for a job.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:DetectorRead" + } + }, + "influencers": { + "description": "A comma separated list of influencer field names.\nTypically these can be the by, over, or partition fields that are used in the detector configuration.\nYou might also want to use a field name that is not specifically named in a detector, but is available as part of the input data.\nWhen you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "model_prune_window": { + "$ref": "#/components/schemas/_types:Duration" + }, + "latency": { + "$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" + }, + "summary_count_field_name": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "bucket_span", + "detectors", + "influencers" + ] + }, + "ml._types:DetectorRead": { + "type": "object", + "properties": { + "by_field_name": { + "$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.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml._types:DetectionRule" + } + }, + "detector_description": { + "description": "A description of the detector.", + "type": "string" + }, + "detector_index": { + "description": "A unique identifier for the detector.\nThis identifier is based on the order of the detectors in the `analysis_config`, starting at zero.", + "type": "number" + }, + "exclude_frequent": { + "$ref": "#/components/schemas/ml._types:ExcludeFrequent" + }, + "field_name": { + "$ref": "#/components/schemas/_types:Field" + }, + "function": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/machine-learning/current/ml-functions.html" + }, + "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" + }, + "partition_field_name": { + "$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.", + "type": "boolean" + } + }, + "required": [ + "function" + ] + }, + "ml.put_trained_model:Definition": { + "type": "object", + "properties": { + "preprocessors": { + "description": "Collection of preprocessors", + "type": "array", + "items": { + "$ref": "#/components/schemas/ml.put_trained_model:Preprocessor" + } + }, + "trained_model": { + "$ref": "#/components/schemas/ml.put_trained_model:TrainedModel" + } + }, + "required": [ + "trained_model" + ] + }, + "ml.put_trained_model:Preprocessor": { + "type": "object", + "properties": { + "frequency_encoding": { + "$ref": "#/components/schemas/ml.put_trained_model:FrequencyEncodingPreprocessor" + }, + "one_hot_encoding": { + "$ref": "#/components/schemas/ml.put_trained_model:OneHotEncodingPreprocessor" + }, + "target_mean_encoding": { + "$ref": "#/components/schemas/ml.put_trained_model:TargetMeanEncodingPreprocessor" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "ml.put_trained_model:FrequencyEncodingPreprocessor": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "feature_name": { + "type": "string" + }, + "frequency_map": { + "type": "object", + "additionalProperties": { + "type": "number" + } + } + }, + "required": [ + "field", + "feature_name", + "frequency_map" + ] + }, + "ml.put_trained_model:OneHotEncodingPreprocessor": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "hot_map": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "field", + "hot_map" + ] + }, + "ml.put_trained_model:TargetMeanEncodingPreprocessor": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "feature_name": { + "type": "string" + }, + "target_map": { + "type": "object", + "additionalProperties": { + "type": "number" + } + }, + "default_value": { + "type": "number" + } + }, + "required": [ + "field", + "feature_name", + "target_map", + "default_value" + ] + }, + "ml.put_trained_model:TrainedModel": { + "type": "object", + "properties": { + "tree": { + "$ref": "#/components/schemas/ml.put_trained_model:TrainedModelTree" + }, + "tree_node": { + "$ref": "#/components/schemas/ml.put_trained_model:TrainedModelTreeNode" + }, + "ensemble": { + "$ref": "#/components/schemas/ml.put_trained_model:Ensemble" + } + } + }, + "ml.put_trained_model:TrainedModelTree": { + "type": "object", + "properties": { + "classification_labels": { + "type": "array", + "items": { + "type": "string" + } + }, + "feature_names": { + "type": "array", + "items": { + "type": "string" + } + }, + "target_type": { + "type": "string" + }, + "tree_structure": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ml.put_trained_model:TrainedModelTreeNode" + } + } + }, + "required": [ + "feature_names", + "tree_structure" + ] + }, + "ml.put_trained_model:TrainedModelTreeNode": { + "type": "object", + "properties": { + "decision_type": { + "type": "string" + }, + "default_left": { + "type": "boolean" + }, + "leaf_value": { + "type": "number" + }, + "left_child": { + "type": "number" + }, + "node_index": { + "type": "number" + }, + "right_child": { + "type": "number" + }, + "split_feature": { + "type": "number" + }, + "split_gain": { + "type": "number" + }, + "threshold": { + "type": "number" + } + }, + "required": [ + "node_index" + ] + }, + "ml.put_trained_model:Ensemble": { + "type": "object", + "properties": { + "aggregate_output": { + "$ref": "#/components/schemas/ml.put_trained_model:AggregateOutput" + }, + "classification_labels": { + "type": "array", + "items": { + "type": "string" + } + }, + "feature_names": { + "type": "array", + "items": { + "type": "string" + } + }, + "target_type": { + "type": "string" + }, + "trained_models": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ml.put_trained_model:TrainedModel" + } + } + }, + "required": [ + "trained_models" + ] + }, + "ml.put_trained_model:AggregateOutput": { + "type": "object", + "properties": { + "logistic_regression": { + "$ref": "#/components/schemas/ml.put_trained_model:Weights" + }, + "weighted_sum": { + "$ref": "#/components/schemas/ml.put_trained_model:Weights" + }, + "weighted_mode": { + "$ref": "#/components/schemas/ml.put_trained_model:Weights" + }, + "exponent": { + "$ref": "#/components/schemas/ml.put_trained_model:Weights" + } + } + }, + "ml.put_trained_model:Weights": { + "type": "object", + "properties": { + "weights": { + "type": "number" + } + }, + "required": [ + "weights" + ] + }, + "ml.put_trained_model:Input": { + "type": "object", + "properties": { + "field_names": { + "$ref": "#/components/schemas/_types:Names" + } + }, + "required": [ + "field_names" + ] + }, + "_types:NodeIds": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types:NodeId" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:NodeId" + } + } + ] + }, + "ml._types:TrainingPriority": { + "type": "string", + "enum": [ + "normal", + "low" + ] + }, + "ml._types:TrainedModelAssignment": { + "type": "object", + "properties": { + "assignment_state": { + "$ref": "#/components/schemas/ml._types:DeploymentAssignmentState" + }, + "max_assigned_allocations": { + "type": "number" + }, + "routing_table": { + "description": "The allocation state for each node.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/ml._types:TrainedModelAssignmentRoutingTable" + } + }, + "start_time": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "task_parameters": { + "$ref": "#/components/schemas/ml._types:TrainedModelAssignmentTaskParameters" + } + }, + "required": [ + "assignment_state", + "routing_table", + "start_time", + "task_parameters" + ] + }, + "ml._types:DeploymentAssignmentState": { + "type": "string", + "enum": [ + "starting", + "started", + "stopping", + "failed" + ] + }, + "ml._types:TrainedModelAssignmentTaskParameters": { + "type": "object", + "properties": { + "model_bytes": { + "description": "The size of the trained model in bytes.", + "type": "number" + }, + "model_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "deployment_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "cache_size": { + "$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" + }, + "queue_capacity": { + "description": "Number of inference requests are allowed in the queue at a time.", + "type": "number" + }, + "threads_per_allocation": { + "description": "Number of threads per allocation.", + "type": "number" + } + }, + "required": [ + "model_bytes", + "model_id", + "deployment_id", + "cache_size", + "number_of_allocations", + "priority", + "queue_capacity", + "threads_per_allocation" + ] + }, + "ml._types:AnalysisMemoryLimit": { + "type": "object", + "properties": { + "model_memory_limit": { + "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.", + "type": "string" + } + }, + "required": [ + "model_memory_limit" + ] + }, + "_global.msearch:RequestItem": { + "oneOf": [ + { + "$ref": "#/components/schemas/_global.msearch:MultisearchHeader" + }, + { + "$ref": "#/components/schemas/_global.msearch:MultisearchBody" + } + ] + }, + "_global.msearch:MultisearchHeader": { + "type": "object", + "properties": { + "allow_no_indices": { + "type": "boolean" + }, + "expand_wildcards": { + "$ref": "#/components/schemas/_types:ExpandWildcards" + }, + "ignore_unavailable": { + "type": "boolean" + }, + "index": { + "$ref": "#/components/schemas/_types:Indices" + }, + "preference": { + "type": "string" + }, + "request_cache": { + "type": "boolean" + }, + "routing": { + "$ref": "#/components/schemas/_types:Routing" + }, + "search_type": { + "$ref": "#/components/schemas/_types:SearchType" + }, + "ccs_minimize_roundtrips": { + "type": "boolean" + }, + "allow_partial_search_results": { + "type": "boolean" + }, + "ignore_throttled": { + "type": "boolean" + } + } + }, + "_global.msearch:MultisearchBody": { + "type": "object", + "properties": { + "aggregations": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:AggregationContainer" + } + }, + "collapse": { + "$ref": "#/components/schemas/_global.search._types:FieldCollapse" + }, + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "explain": { + "description": "If true, returns detailed information about score computation as part of a hit.", + "type": "boolean" + }, + "ext": { + "description": "Configuration of search extensions defined by Elasticsearch plugins.", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "stored_fields": { + "$ref": "#/components/schemas/_types:Fields" + }, + "docvalue_fields": { + "description": "Array of wildcard (*) patterns. The request returns doc values for field\nnames matching these patterns in the hits.fields property of the response.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:FieldAndFormat" + } + }, + "knn": { + "description": "Defines the approximate kNN search to run.", + "x-available-since": "8.4.0", + "oneOf": [ + { + "$ref": "#/components/schemas/_types:KnnSearch" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:KnnSearch" + } + } + ] + }, + "from": { + "description": "Starting document offset. By default, you cannot page through more than 10,000\nhits using the from and size parameters. To page through more hits, use the\nsearch_after parameter.", + "type": "number" + }, + "highlight": { + "$ref": "#/components/schemas/_global.search._types:Highlight" + }, + "indices_boost": { + "description": "Boosts the _score of documents from specified indices.", + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "number" + } + } + }, + "min_score": { + "description": "Minimum _score for matching documents. Documents with a lower _score are\nnot included in the search results.", + "type": "number" + }, + "post_filter": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "profile": { + "type": "boolean" + }, + "rescore": { + "oneOf": [ + { + "$ref": "#/components/schemas/_global.search._types:Rescore" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.search._types:Rescore" + } + } + ] + }, + "script_fields": { + "description": "Retrieve a script evaluation (based on different fields) for each hit.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types:ScriptField" + } + }, + "search_after": { + "$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.", + "type": "number" + }, + "sort": { + "$ref": "#/components/schemas/_types:Sort" + }, + "_source": { + "$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.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:FieldAndFormat" + } + }, + "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.", + "type": "number" + }, + "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.", + "type": "array", + "items": { + "type": "string" + } + }, + "timeout": { + "description": "Specifies the period of time to wait for a response from each shard. If no response\nis received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.", + "type": "string" + }, + "track_scores": { + "description": "If true, calculate and return document scores, even if the scores are not used for sorting.", + "type": "boolean" + }, + "track_total_hits": { + "$ref": "#/components/schemas/_global.search._types:TrackHits" + }, + "version": { + "description": "If true, returns document version as part of a hit.", + "type": "boolean" + }, + "runtime_mappings": { + "$ref": "#/components/schemas/_types.mapping:RuntimeFields" + }, + "seq_no_primary_term": { + "description": "If true, returns sequence number and primary term of the last modification\nof each hit. See Optimistic concurrency control.", + "type": "boolean" + }, + "pit": { + "$ref": "#/components/schemas/_global.search._types:PointInTimeReference" + }, + "suggest": { + "$ref": "#/components/schemas/_global.search._types:Suggester" + } + } + }, + "_global.msearch:MultiSearchResult": { + "type": "object", + "properties": { + "took": { + "type": "number" + }, + "responses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.msearch:ResponseItem" + } + } + }, + "required": [ + "took", + "responses" + ] + }, + "_global.msearch:ResponseItem": { + "oneOf": [ + { + "$ref": "#/components/schemas/_global.msearch:MultiSearchItem" + }, + { + "$ref": "#/components/schemas/_types:ErrorResponseBase" + } + ] + }, + "_global.msearch:MultiSearchItem": { + "allOf": [ + { + "$ref": "#/components/schemas/_global.search:ResponseBody" + }, + { + "type": "object", + "properties": { + "status": { + "type": "number" + } + } + } + ] + }, + "_global.search:ResponseBody": { + "type": "object", + "properties": { + "took": { + "type": "number" + }, + "timed_out": { + "type": "boolean" + }, + "_shards": { + "$ref": "#/components/schemas/_types:ShardStatistics" + }, + "hits": { + "$ref": "#/components/schemas/_global.search._types:HitsMetadata" + }, + "aggregations": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:Aggregate" + } + }, + "_clusters": { + "$ref": "#/components/schemas/_types:ClusterStatistics" + }, + "fields": { + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "max_score": { + "type": "number" + }, + "num_reduce_phases": { + "type": "number" + }, + "profile": { + "$ref": "#/components/schemas/_global.search._types:Profile" + }, + "pit_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "_scroll_id": { + "$ref": "#/components/schemas/_types:ScrollId" + }, + "suggest": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.search._types:Suggest" + } + } + }, + "terminated_early": { + "type": "boolean" + } + }, + "required": [ + "took", + "timed_out", + "_shards", + "hits" + ] + }, + "_types:ErrorResponseBase": { + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/_types:ErrorCause" + }, + "status": { + "type": "number" + } + }, + "required": [ + "error", + "status" + ] + }, + "_global.msearch_template:RequestItem": { + "oneOf": [ + { + "$ref": "#/components/schemas/_global.msearch:MultisearchHeader" + }, + { + "$ref": "#/components/schemas/_global.msearch_template:TemplateConfig" + } + ] + }, + "_global.msearch_template:TemplateConfig": { + "type": "object", + "properties": { + "explain": { + "description": "If `true`, returns detailed information about score calculation as part of each hit.", + "type": "boolean" + }, + "id": { + "$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.", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "profile": { + "description": "If `true`, the query execution is profiled.", + "type": "boolean" + }, + "source": { + "description": "An inline search template. Supports the same parameters as the search API's\nrequest body. Also supports Mustache variables. If no id is specified, this\nparameter is required.", + "type": "string" + } + } + }, + "_global.mtermvectors:Operation": { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "_index": { + "$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" + }, + "field_statistics": { + "description": "If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies.", + "type": "boolean" + }, + "filter": { + "$ref": "#/components/schemas/_global.termvectors:Filter" + }, + "offsets": { + "description": "If `true`, the response includes term offsets.", + "type": "boolean" + }, + "payloads": { + "description": "If `true`, the response includes term payloads.", + "type": "boolean" + }, + "positions": { + "description": "If `true`, the response includes term positions.", + "type": "boolean" + }, + "routing": { + "$ref": "#/components/schemas/_types:Routing" + }, + "term_statistics": { + "description": "If true, the response includes term frequency and document frequency.", + "type": "boolean" + }, + "version": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "version_type": { + "$ref": "#/components/schemas/_types:VersionType" + } + } + }, + "_global.termvectors:Filter": { + "type": "object", + "properties": { + "max_doc_freq": { + "description": "Ignore words which occur in more than this many docs.\nDefaults to unbounded.", + "type": "number" + }, + "max_num_terms": { + "description": "Maximum number of terms that must be returned per field.", + "type": "number" + }, + "max_term_freq": { + "description": "Ignore words with more than this frequency in the source doc.\nDefaults to unbounded.", + "type": "number" + }, + "max_word_length": { + "description": "The maximum word length above which words will be ignored.\nDefaults to unbounded.", + "type": "number" + }, + "min_doc_freq": { + "description": "Ignore terms which do not occur in at least this many docs.", + "type": "number" + }, + "min_term_freq": { + "description": "Ignore words with less than this frequency in the source doc.", + "type": "number" + }, + "min_word_length": { + "description": "The minimum word length below which words will be ignored.", + "type": "number" + } + } + }, + "_global.mtermvectors:TermVectorsResult": { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "_index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "_version": { + "$ref": "#/components/schemas/_types:VersionNumber" + }, + "took": { + "type": "number" + }, + "found": { + "type": "boolean" + }, + "term_vectors": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_global.termvectors:TermVector" + } + }, + "error": { + "$ref": "#/components/schemas/_types:ErrorCause" + } + }, + "required": [ + "_index" + ] + }, + "_global.termvectors:TermVector": { + "type": "object", + "properties": { + "field_statistics": { + "$ref": "#/components/schemas/_global.termvectors:FieldStatistics" + }, + "terms": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_global.termvectors:Term" + } + } + }, + "required": [ + "terms" + ] + }, + "_global.termvectors:FieldStatistics": { + "type": "object", + "properties": { + "doc_count": { + "type": "number" + }, + "sum_doc_freq": { + "type": "number" + }, + "sum_ttf": { + "type": "number" + } + }, + "required": [ + "doc_count", + "sum_doc_freq", + "sum_ttf" + ] + }, + "_global.termvectors:Term": { + "type": "object", + "properties": { + "doc_freq": { + "type": "number" + }, + "score": { + "type": "number" + }, + "term_freq": { + "type": "number" + }, + "tokens": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.termvectors:Token" + } + }, + "ttf": { + "type": "number" + } + }, + "required": [ + "term_freq" + ] + }, + "_global.termvectors:Token": { + "type": "object", + "properties": { + "end_offset": { + "type": "number" + }, + "payload": { + "type": "string" + }, + "position": { + "type": "number" + }, + "start_offset": { + "type": "number" + } + }, + "required": [ + "position" + ] + }, + "query_rules._types:QueryRule": { + "type": "object", + "properties": { + "rule_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "type": { + "$ref": "#/components/schemas/query_rules._types:QueryRuleType" + }, + "criteria": { + "oneOf": [ + { + "$ref": "#/components/schemas/query_rules._types:QueryRuleCriteria" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/query_rules._types:QueryRuleCriteria" + } + } + ] + }, + "actions": { + "$ref": "#/components/schemas/query_rules._types:QueryRuleActions" + }, + "priority": { + "type": "number" + } + }, + "required": [ + "rule_id", + "type", + "criteria", + "actions" + ] + }, + "query_rules._types:QueryRuleType": { + "type": "string", + "enum": [ + "pinned" + ] + }, + "query_rules._types:QueryRuleCriteria": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/query_rules._types:QueryRuleCriteriaType" + }, + "metadata": { + "type": "string" + }, + "values": { + "type": "array", + "items": { + "type": "object" + } + } + }, + "required": [ + "type" + ] + }, + "query_rules._types:QueryRuleCriteriaType": { + "type": "string", + "enum": [ + "global", + "exact", + "exact_fuzzy", + "fuzzy", + "prefix", + "suffix", + "contains", + "lt", + "lte", + "gt", + "gte", + "always" + ] + }, + "query_rules._types:QueryRuleActions": { + "type": "object", + "properties": { + "ids": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Id" + } + }, + "docs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:PinnedDoc" + } + } + } + }, + "query_rules._types:QueryRuleset": { + "type": "object", + "properties": { + "ruleset_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "rules": { + "description": "Rules associated with the query ruleset", + "type": "array", + "items": { + "$ref": "#/components/schemas/query_rules._types:QueryRule" + } + } + }, + "required": [ + "ruleset_id", + "rules" + ] + }, + "query_rules.list_rulesets:QueryRulesetListItem": { + "type": "object", + "properties": { + "ruleset_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "rule_total_count": { + "description": "The number of rules associated with this ruleset", + "type": "number" + }, + "rule_criteria_types_counts": { + "description": "A map of criteria type to the number of rules of that type", + "type": "object", + "additionalProperties": { + "type": "number" + } + } + }, + "required": [ + "ruleset_id", + "rule_total_count", + "rule_criteria_types_counts" + ] + }, + "_global.rank_eval:RankEvalRequestItem": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "request": { + "$ref": "#/components/schemas/_global.rank_eval:RankEvalQuery" + }, + "ratings": { + "description": "List of document ratings", + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.rank_eval:DocumentRating" + } + }, + "template_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "params": { + "description": "The search template parameters.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "required": [ + "id", + "ratings" + ] + }, + "_global.rank_eval:RankEvalQuery": { + "type": "object", + "properties": { + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "size": { + "type": "number" + } + }, + "required": [ + "query" + ] + }, + "_global.rank_eval:DocumentRating": { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "_index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "rating": { + "description": "The document’s relevance with regard to this search request.", + "type": "number" + } + }, + "required": [ + "_id", + "_index", + "rating" + ] + }, + "_global.rank_eval:RankEvalMetric": { + "type": "object", + "properties": { + "precision": { + "$ref": "#/components/schemas/_global.rank_eval:RankEvalMetricPrecision" + }, + "recall": { + "$ref": "#/components/schemas/_global.rank_eval:RankEvalMetricRecall" + }, + "mean_reciprocal_rank": { + "$ref": "#/components/schemas/_global.rank_eval:RankEvalMetricMeanReciprocalRank" + }, + "dcg": { + "$ref": "#/components/schemas/_global.rank_eval:RankEvalMetricDiscountedCumulativeGain" + }, + "expected_reciprocal_rank": { + "$ref": "#/components/schemas/_global.rank_eval:RankEvalMetricExpectedReciprocalRank" + } + } + }, + "_global.rank_eval:RankEvalMetricPrecision": { + "allOf": [ + { + "$ref": "#/components/schemas/_global.rank_eval:RankEvalMetricRatingTreshold" + }, + { + "type": "object", + "properties": { + "ignore_unlabeled": { + "description": "Controls how unlabeled documents in the search results are counted. If set to true, unlabeled documents are ignored and neither count as relevant or irrelevant. Set to false (the default), they are treated as irrelevant.", + "type": "boolean" + } + } + } + ] + }, + "_global.rank_eval:RankEvalMetricRatingTreshold": { + "allOf": [ + { + "$ref": "#/components/schemas/_global.rank_eval:RankEvalMetricBase" + }, + { + "type": "object", + "properties": { + "relevant_rating_threshold": { + "description": "Sets the rating threshold above which documents are considered to be \"relevant\".", + "type": "number" + } + } + } + ] + }, + "_global.rank_eval:RankEvalMetricBase": { + "type": "object", + "properties": { + "k": { + "description": "Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query.", + "type": "number" + } + } + }, + "_global.rank_eval:RankEvalMetricRecall": { + "allOf": [ + { + "$ref": "#/components/schemas/_global.rank_eval:RankEvalMetricRatingTreshold" + }, + { + "type": "object" + } + ] + }, + "_global.rank_eval:RankEvalMetricMeanReciprocalRank": { + "allOf": [ + { + "$ref": "#/components/schemas/_global.rank_eval:RankEvalMetricRatingTreshold" + }, + { + "type": "object" + } + ] + }, + "_global.rank_eval:RankEvalMetricDiscountedCumulativeGain": { + "allOf": [ + { + "$ref": "#/components/schemas/_global.rank_eval:RankEvalMetricBase" + }, + { + "type": "object", + "properties": { + "normalize": { + "externalDocs": { + "url": "https://en.wikipedia.org/wiki/Discounted_cumulative_gain#Normalized_DCG" + }, + "description": "If set to true, this metric will calculate the Normalized DCG.", + "type": "boolean" + } + } + } + ] + }, + "_global.rank_eval:RankEvalMetricExpectedReciprocalRank": { + "allOf": [ + { + "$ref": "#/components/schemas/_global.rank_eval:RankEvalMetricBase" + }, + { + "type": "object", + "properties": { + "maximum_relevance": { + "description": "The highest relevance grade used in the user-supplied relevance judgments.", + "type": "number" + } + }, + "required": [ + "maximum_relevance" + ] + } + ] + }, + "_global.rank_eval:RankEvalMetricDetail": { + "type": "object", + "properties": { + "metric_score": { + "description": "The metric_score in the details section shows the contribution of this query to the global quality metric score", + "type": "number" + }, + "unrated_docs": { + "description": "The unrated_docs section contains an _index and _id entry for each document in the search result for this query that didn’t have a ratings value. This can be used to ask the user to supply ratings for these documents", + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.rank_eval:UnratedDocument" + } + }, + "hits": { + "description": "The hits section shows a grouping of the search results with their supplied ratings", + "type": "array", + "items": { + "$ref": "#/components/schemas/_global.rank_eval:RankEvalHitItem" + } + }, + "metric_details": { + "description": "The metric_details give additional information about the calculated quality metric (e.g. how many of the retrieved documents were relevant). The content varies for each metric but allows for better interpretation of the results", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "required": [ + "metric_score", + "unrated_docs", + "hits", + "metric_details" + ] + }, + "_global.rank_eval:UnratedDocument": { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "_index": { + "$ref": "#/components/schemas/_types:IndexName" + } + }, + "required": [ + "_id", + "_index" + ] + }, + "_global.rank_eval:RankEvalHitItem": { + "type": "object", + "properties": { + "hit": { + "$ref": "#/components/schemas/_global.rank_eval:RankEvalHit" + }, + "rating": { + "oneOf": [ + { + "type": "number" + }, + { + "nullable": true, + "type": "string" + } + ] + } + }, + "required": [ + "hit" + ] + }, + "_global.rank_eval:RankEvalHit": { + "type": "object", + "properties": { + "_id": { + "$ref": "#/components/schemas/_types:Id" + }, + "_index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "_score": { + "type": "number" + } + }, + "required": [ + "_id", + "_index", + "_score" + ] + }, + "_global.reindex:Destination": { + "type": "object", + "properties": { + "index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "op_type": { + "$ref": "#/components/schemas/_types:OpType" + }, + "pipeline": { + "description": "The name of the pipeline to use.", + "type": "string" + }, + "routing": { + "$ref": "#/components/schemas/_types:Routing" + }, + "version_type": { + "$ref": "#/components/schemas/_types:VersionType" + } + }, + "required": [ + "index" + ] + }, + "_global.reindex:Source": { + "type": "object", + "properties": { + "index": { + "$ref": "#/components/schemas/_types:Indices" + }, + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "remote": { + "$ref": "#/components/schemas/_global.reindex:RemoteSource" + }, + "size": { + "description": "The number of documents to index per batch.\nUse when indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB.", + "type": "number" + }, + "slice": { + "$ref": "#/components/schemas/_types:SlicedScroll" + }, + "sort": { + "$ref": "#/components/schemas/_types:Sort" + }, + "_source": { + "$ref": "#/components/schemas/_types:Fields" + }, + "runtime_mappings": { + "$ref": "#/components/schemas/_types.mapping:RuntimeFields" + } + }, + "required": [ + "index" + ] + }, + "_global.reindex:RemoteSource": { + "type": "object", + "properties": { + "connect_timeout": { + "$ref": "#/components/schemas/_types:Duration" + }, + "headers": { + "description": "An object containing the headers of the request.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "host": { + "$ref": "#/components/schemas/_types:Host" + }, + "username": { + "$ref": "#/components/schemas/_types:Username" + }, + "password": { + "$ref": "#/components/schemas/_types:Password" + }, + "socket_timeout": { + "$ref": "#/components/schemas/_types:Duration" + } + }, + "required": [ + "host" + ] + }, + "_types:Host": { + "type": "string" + }, + "_types:Username": { + "type": "string" + }, + "_types:Password": { + "type": "string" + }, + "_global.scripts_painless_execute:PainlessContextSetup": { + "type": "object", + "properties": { + "document": { + "description": "Document that’s temporarily indexed in-memory and accessible from the script.", + "type": "object" + }, + "index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + } + }, + "required": [ + "document", + "index", + "query" + ] + }, + "_types:RankContainer": { + "type": "object", + "properties": { + "rrf": { + "$ref": "#/components/schemas/_types:RrfRank" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "_types:RrfRank": { + "allOf": [ + { + "$ref": "#/components/schemas/_types:RankBase" + }, + { + "type": "object", + "properties": { + "rank_constant": { + "description": "How much influence documents in individual result sets per query have over the final ranked result set", + "type": "number" + }, + "rank_window_size": { + "description": "Size of the individual result sets per query", + "type": "number" + } + } + } + ] + }, + "_types:RankBase": { + "type": "object" + }, + "_types:RetrieverContainer": { + "type": "object", + "properties": { + "standard": { + "$ref": "#/components/schemas/_types:StandardRetriever" + }, + "knn": { + "$ref": "#/components/schemas/_types:KnnRetriever" + }, + "rrf": { + "$ref": "#/components/schemas/_types:RRFRetriever" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "_types:StandardRetriever": { + "allOf": [ + { + "$ref": "#/components/schemas/_types:RetrieverBase" + }, + { + "type": "object", + "properties": { + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "search_after": { + "$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" + }, + "min_score": { + "description": "Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.", + "type": "number" + }, + "collapse": { + "$ref": "#/components/schemas/_global.search._types:FieldCollapse" + } + } + } + ] + }, + "_types:RetrieverBase": { + "type": "object", + "properties": { + "filter": { + "description": "Query to filter the documents that can match.", + "oneOf": [ + { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + } + } + ] + } + } + }, + "_types:KnnRetriever": { + "allOf": [ + { + "$ref": "#/components/schemas/_types:RetrieverBase" + }, + { + "type": "object", + "properties": { + "field": { + "description": "The name of the vector field to search against.", + "type": "string" + }, + "query_vector": { + "$ref": "#/components/schemas/_types:QueryVector" + }, + "query_vector_builder": { + "$ref": "#/components/schemas/_types:QueryVectorBuilder" + }, + "k": { + "description": "Number of nearest neighbors to return as top hits.", + "type": "number" + }, + "num_candidates": { + "description": "Number of nearest neighbor candidates to consider per shard.", + "type": "number" + }, + "similarity": { + "description": "The minimum similarity required for a document to be considered a match.", + "type": "number" + } + }, + "required": [ + "field", + "k", + "num_candidates" + ] + } + ] + }, + "_types:RRFRetriever": { + "allOf": [ + { + "$ref": "#/components/schemas/_types:RetrieverBase" + }, + { + "type": "object", + "properties": { + "retrievers": { + "description": "A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:RetrieverContainer" + } + }, + "rank_constant": { + "description": "This value determines how much influence documents in individual result sets per query have over the final ranked result set.", + "type": "number" + }, + "rank_window_size": { + "description": "This value determines the size of the individual result sets per query.", + "type": "number" + } + }, + "required": [ + "retrievers" + ] + } + ] + }, + "search_application._types:SearchApplication": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/_types:Name" + }, + "indices": { + "description": "Indices that are part of the Search Application.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:IndexName" + } + }, + "updated_at_millis": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "analytics_collection_name": { + "$ref": "#/components/schemas/_types:Name" + }, + "template": { + "$ref": "#/components/schemas/search_application._types:SearchApplicationTemplate" + } + }, + "required": [ + "name", + "indices", + "updated_at_millis" + ] + }, + "search_application._types:SearchApplicationTemplate": { + "type": "object", + "properties": { + "script": { + "$ref": "#/components/schemas/_types:Script" + } + }, + "required": [ + "script" + ] + }, + "search_application._types:AnalyticsCollection": { + "type": "object", + "properties": { + "event_data_stream": { + "$ref": "#/components/schemas/search_application._types:EventDataStream" + } + }, + "required": [ + "event_data_stream" + ] + }, + "search_application._types:EventDataStream": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/_types:IndexName" + } + }, + "required": [ + "name" + ] + }, + "search_application.list:SearchApplicationListItem": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/_types:Name" + }, + "indices": { + "description": "Indices that are part of the Search Application", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:IndexName" + } + }, + "updated_at_millis": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "analytics_collection_name": { + "$ref": "#/components/schemas/_types:Name" + } + }, + "required": [ + "name", + "indices", + "updated_at_millis" + ] + }, + "search_application.put_behavioral_analytics:AnalyticsAcknowledgeResponseBase": { + "allOf": [ + { + "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" + }, + { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/_types:Name" + } + }, + "required": [ + "name" + ] + } + ] + }, + "_global.search_mvt._types:ZoomLevel": { + "type": "number" + }, + "_global.search_mvt._types:Coordinate": { + "type": "number" + }, + "_global.search_mvt._types:GridAggregationType": { + "type": "string", + "enum": [ + "geotile", + "geohex" + ] + }, + "_global.search_mvt._types:GridType": { + "type": "string", + "enum": [ + "grid", + "point", + "centroid" + ] + }, + "_types:MapboxVectorTiles": { + "type": "object" + }, + "security._types:ApiKey": { + "type": "object", + "properties": { + "creation": { + "description": "Creation time for the API key in milliseconds.", + "type": "number" + }, + "expiration": { + "description": "Expiration time for the API key in milliseconds.", + "type": "number" + }, + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "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" + }, + "name": { + "$ref": "#/components/schemas/_types:Name" + }, + "realm": { + "description": "Realm name of the principal for which this API key was created.", + "type": "string" + }, + "realm_type": { + "description": "Realm type of the principal for which this API key was created", + "x-available-since": "8.14.0", + "type": "string" + }, + "username": { + "$ref": "#/components/schemas/_types:Username" + }, + "profile_uid": { + "description": "The profile uid for the API key owner principal, if requested and if it exists", + "x-available-since": "8.14.0", + "type": "string" + }, + "metadata": { + "$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.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/security._types:RoleDescriptor" + } + }, + "limited_by": { + "description": "The owner user’s permissions associated with the API key.\nIt is a point-in-time snapshot captured at creation and subsequent updates.\nAn API key’s effective permissions are an intersection of its assigned privileges and the owner user’s permissions.", + "x-available-since": "8.5.0", + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/security._types:RoleDescriptor" + } + } + }, + "_sort": { + "$ref": "#/components/schemas/_types:SortResults" + } + }, + "required": [ + "id", + "name" + ] + }, + "security._types:RoleDescriptor": { + "type": "object", + "properties": { + "cluster": { + "description": "A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute.", + "type": "array", + "items": { + "$ref": "#/components/schemas/security._types:ClusterPrivilege" + } + }, + "indices": { + "description": "A list of indices permissions entries.", + "type": "array", + "items": { + "$ref": "#/components/schemas/security._types:IndicesPrivileges" + } + }, + "applications": { + "description": "A list of application privilege entries", + "type": "array", + "items": { + "$ref": "#/components/schemas/security._types:ApplicationPrivileges" + } + }, + "metadata": { + "$ref": "#/components/schemas/_types:Metadata" + }, + "run_as": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/run-as-privilege.html" + }, + "description": "A list of users that the API keys can impersonate. *Note*: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected.", + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "description": "Optional description of the role descriptor", + "type": "string" + }, + "transient_metadata": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "security._types:ClusterPrivilege": { + "anyOf": [ + { + "type": "string", + "enum": [ + "all", + "cancel_task", + "manage", + "manage_api_key", + "manage_behavioral_analytics", + "manage_enrich", + "manage_index_templates", + "manage_inference", + "manage_ingest_pipelines", + "manage_logstash_pipelines", + "manage_ml", + "manage_own_api_key", + "manage_pipeline", + "manage_search_application", + "manage_search_query_rules", + "manage_search_synonyms", + "manage_security", + "manage_transform", + "monitor", + "monitor_enrich", + "monitor_inference", + "monitor_ml", + "monitor_transform", + "none", + "post_behavioral_analytics_event", + "read_pipeline", + "read_security" + ] + }, + { + "type": "string" + } + ] + }, + "security._types:IndicesPrivileges": { + "type": "object", + "properties": { + "field_security": { + "$ref": "#/components/schemas/security._types:FieldSecurity" + }, + "names": { + "$ref": "#/components/schemas/_types:Indices" + }, + "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" + } + }, + "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", + "delete", + "delete_index", + "index", + "maintenance", + "manage", + "manage_data_stream_lifecycle", + "monitor", + "none", + "read", + "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:ApplicationPrivileges": { + "type": "object", + "properties": { + "application": { + "description": "The name of the application to which this entry applies.", + "type": "string" + }, + "privileges": { + "description": "A list of strings, where each element is the name of an application privilege or action.", + "type": "array", + "items": { + "type": "string" + } + }, + "resources": { + "description": "A list resources to which the privileges are applied.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "application", + "privileges", + "resources" + ] + }, + "security._types:RealmInfo": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/_types:Name" + }, + "type": { + "type": "string" + } + }, + "required": [ + "name", + "type" + ] + }, + "security.authenticate:Token": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/_types:Name" + }, + "type": { + "x-available-since": "7.14.0", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "security.has_privileges:ApplicationPrivilegesCheck": { + "type": "object", + "properties": { + "application": { + "description": "The name of the application.", + "type": "string" + }, + "privileges": { + "description": "A list of the privileges that you want to check for the specified resources. May be either application privilege names, or the names of actions that are granted by those privileges", + "type": "array", + "items": { + "type": "string" + } + }, + "resources": { + "description": "A list of resource names against which the privileges should be checked", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "application", + "privileges", + "resources" + ] + }, + "security.has_privileges:IndexPrivilegesCheck": { + "type": "object", + "properties": { + "names": { + "$ref": "#/components/schemas/_types:Indices" + }, + "privileges": { + "description": "A list of the privileges that you want to check for the specified indices.", + "type": "array", + "items": { + "$ref": "#/components/schemas/security._types:IndexPrivilege" + } + }, + "allow_restricted_indices": { + "description": "This needs to be set to true (default is false) if using wildcards or regexps for patterns that cover restricted indices.\nImplicitly, restricted indices do not match index patterns because restricted indices usually have limited privileges and including them in pattern tests would render most such tests false.\nIf restricted indices are explicitly included in the names list, privileges will be checked against them regardless of the value of allow_restricted_indices.", + "type": "boolean" + } + }, + "required": [ + "names", + "privileges" + ] + }, + "security.has_privileges:ApplicationsPrivileges": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/security.has_privileges:ResourcePrivileges" + } + }, + "security.has_privileges:ResourcePrivileges": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/security.has_privileges:Privileges" + } + }, + "security.has_privileges:Privileges": { + "type": "object", + "additionalProperties": { + "type": "boolean" + } + }, + "security.query_api_keys:ApiKeyAggregationContainer": { + "allOf": [ + { + "type": "object", + "properties": { + "aggregations": { + "description": "Sub-aggregations for this aggregation.\nOnly applies to bucket aggregations.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/security.query_api_keys:ApiKeyAggregationContainer" + } + }, + "meta": { + "$ref": "#/components/schemas/_types:Metadata" + } + } + }, + { + "type": "object", + "properties": { + "cardinality": { + "$ref": "#/components/schemas/_types.aggregations:CardinalityAggregation" + }, + "composite": { + "$ref": "#/components/schemas/_types.aggregations:CompositeAggregation" + }, + "date_range": { + "$ref": "#/components/schemas/_types.aggregations:DateRangeAggregation" + }, + "filter": { + "$ref": "#/components/schemas/security.query_api_keys:ApiKeyQueryContainer" + }, + "filters": { + "$ref": "#/components/schemas/security.query_api_keys:ApiKeyFiltersAggregation" + }, + "missing": { + "$ref": "#/components/schemas/_types.aggregations:MissingAggregation" + }, + "range": { + "$ref": "#/components/schemas/_types.aggregations:RangeAggregation" + }, + "terms": { + "$ref": "#/components/schemas/_types.aggregations:TermsAggregation" + }, + "value_count": { + "$ref": "#/components/schemas/_types.aggregations:ValueCountAggregation" + } + }, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "security.query_api_keys:ApiKeyQueryContainer": { + "type": "object", + "properties": { + "bool": { + "$ref": "#/components/schemas/_types.query_dsl:BoolQuery" + }, + "exists": { + "$ref": "#/components/schemas/_types.query_dsl:ExistsQuery" + }, + "ids": { + "$ref": "#/components/schemas/_types.query_dsl:IdsQuery" + }, + "match": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html" + }, + "description": "Returns documents that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.query_dsl:MatchQuery" + }, + "minProperties": 1, + "maxProperties": 1 + }, + "match_all": { + "$ref": "#/components/schemas/_types.query_dsl:MatchAllQuery" + }, + "prefix": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-prefix-query.html" + }, + "description": "Returns documents that contain a specific prefix in a provided field.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.query_dsl:PrefixQuery" + }, + "minProperties": 1, + "maxProperties": 1 + }, + "range": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html" + }, + "description": "Returns documents that contain terms within a provided range.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.query_dsl:RangeQuery" + }, + "minProperties": 1, + "maxProperties": 1 + }, + "simple_query_string": { + "$ref": "#/components/schemas/_types.query_dsl:SimpleQueryStringQuery" + }, + "term": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html" + }, + "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.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.query_dsl:TermQuery" + }, + "minProperties": 1, + "maxProperties": 1 + }, + "terms": { + "$ref": "#/components/schemas/_types.query_dsl:TermsQuery" + }, + "wildcard": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html" + }, + "description": "Returns documents that contain terms matching a wildcard pattern.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.query_dsl:WildcardQuery" + }, + "minProperties": 1, + "maxProperties": 1 + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "security.query_api_keys:ApiKeyFiltersAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:BucketAggregationBase" + }, + { + "type": "object", + "properties": { + "filters": { + "$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.", + "type": "boolean" + }, + "other_bucket_key": { + "description": "The key with which the other bucket is returned.", + "type": "string" + }, + "keyed": { + "description": "By default, the named filters aggregation returns the buckets as an object.\nSet to `false` to return the buckets as an array of objects.", + "type": "boolean" + } + } + } + ] + }, + "_types.aggregations:BucketsApiKeyQueryContainer": { + "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.", + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/security.query_api_keys:ApiKeyQueryContainer" + } + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/security.query_api_keys:ApiKeyQueryContainer" + } + } + ] + }, + "security.query_api_keys:ApiKeyAggregate": { + "oneOf": [ + { + "$ref": "#/components/schemas/_types.aggregations:CardinalityAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:ValueCountAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:StringTermsAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:LongTermsAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:DoubleTermsAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:UnmappedTermsAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:MultiTermsAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:MissingAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:FilterAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:FiltersAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:RangeAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:DateRangeAggregate" + }, + { + "$ref": "#/components/schemas/_types.aggregations:CompositeAggregate" + } + ] + }, + "sql:Column": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/_types:Name" + }, + "type": { + "type": "string" + } + }, + "required": [ + "name", + "type" + ] + }, + "sql:Row": { + "type": "array", + "items": { + "type": "object" + } + }, + "synonyms._types:SynonymsUpdateResult": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/_types:Result" + }, + "reload_analyzers_details": { + "$ref": "#/components/schemas/indices.reload_search_analyzers:ReloadResult" + } + }, + "required": [ + "result", + "reload_analyzers_details" + ] + }, + "indices.reload_search_analyzers:ReloadResult": { + "type": "object", + "properties": { + "reload_details": { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.reload_search_analyzers:ReloadDetails" + } + }, + "_shards": { + "$ref": "#/components/schemas/_types:ShardStatistics" + } + }, + "required": [ + "reload_details", + "_shards" + ] + }, + "indices.reload_search_analyzers:ReloadDetails": { + "type": "object", + "properties": { + "index": { + "type": "string" + }, + "reloaded_analyzers": { + "type": "array", + "items": { + "type": "string" + } + }, + "reloaded_node_ids": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "index", + "reloaded_analyzers", + "reloaded_node_ids" + ] + }, + "synonyms._types:SynonymRuleRead": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "synonyms": { + "$ref": "#/components/schemas/synonyms._types:SynonymString" + } + }, + "required": [ + "id", + "synonyms" + ] + }, + "synonyms._types:SynonymString": { + "type": "string" + }, + "synonyms.get_synonyms_sets:SynonymsSetItem": { + "type": "object", + "properties": { + "synonyms_set": { + "$ref": "#/components/schemas/_types:Id" + }, + "count": { + "description": "Number of synonym rules that the synonym set contains", + "type": "number" + } + }, + "required": [ + "synonyms_set", + "count" + ] + }, + "synonyms._types:SynonymRule": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "synonyms": { + "$ref": "#/components/schemas/synonyms._types:SynonymString" + } + }, + "required": [ + "synonyms" + ] + }, + "transform.get_transform:TransformSummary": { + "type": "object", + "properties": { + "authorization": { + "$ref": "#/components/schemas/ml._types:TransformAuthorization" + }, + "create_time": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "description": { + "description": "Free text description of the transform.", + "type": "string" + }, + "dest": { + "$ref": "#/components/schemas/_global.reindex:Destination" + }, + "frequency": { + "$ref": "#/components/schemas/_types:Duration" + }, + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "latest": { + "$ref": "#/components/schemas/transform._types:Latest" + }, + "pivot": { + "$ref": "#/components/schemas/transform._types:Pivot" + }, + "retention_policy": { + "$ref": "#/components/schemas/transform._types:RetentionPolicyContainer" + }, + "settings": { + "$ref": "#/components/schemas/transform._types:Settings" + }, + "source": { + "$ref": "#/components/schemas/transform._types:Source" + }, + "sync": { + "$ref": "#/components/schemas/transform._types:SyncContainer" + }, + "version": { + "$ref": "#/components/schemas/_types:VersionString" + }, + "_meta": { + "$ref": "#/components/schemas/_types:Metadata" + } + }, + "required": [ + "dest", + "id", + "source" + ] + }, + "ml._types:TransformAuthorization": { + "type": "object", + "properties": { + "api_key": { + "$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.", + "type": "array", + "items": { + "type": "string" + } + }, + "service_account": { + "description": "If a service account was used for the most recent update to the transform, the account name is listed in the response.", + "type": "string" + } + } + }, + "transform._types:Latest": { + "type": "object", + "properties": { + "sort": { + "$ref": "#/components/schemas/_types:Field" + }, + "unique_key": { + "description": "Specifies an array of one or more fields that are used to group the data.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Field" + } + } + }, + "required": [ + "sort", + "unique_key" + ] + }, + "transform._types:Pivot": { + "type": "object", + "properties": { + "aggregations": { + "description": "Defines how to aggregate the grouped data. The following aggregations are currently supported: average, bucket\nscript, bucket selector, cardinality, filter, geo bounds, geo centroid, geo line, max, median absolute deviation,\nmin, missing, percentiles, rare terms, scripted metric, stats, sum, terms, top metrics, value count, weighted\naverage.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/_types.aggregations:AggregationContainer" + } + }, + "group_by": { + "description": "Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are\ncurrently supported: date histogram, geotile grid, histogram, terms.", + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/transform._types:PivotGroupByContainer" + } + } + } + }, + "transform._types:PivotGroupByContainer": { + "type": "object", + "properties": { + "date_histogram": { + "$ref": "#/components/schemas/_types.aggregations:DateHistogramAggregation" + }, + "geotile_grid": { + "$ref": "#/components/schemas/_types.aggregations:GeoTileGridAggregation" + }, + "histogram": { + "$ref": "#/components/schemas/_types.aggregations:HistogramAggregation" + }, + "terms": { + "$ref": "#/components/schemas/_types.aggregations:TermsAggregation" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "transform._types:RetentionPolicyContainer": { + "type": "object", + "properties": { + "time": { + "$ref": "#/components/schemas/transform._types:RetentionPolicy" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "transform._types:RetentionPolicy": { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "max_age": { + "$ref": "#/components/schemas/_types:Duration" + } + }, + "required": [ + "field", + "max_age" + ] + }, + "transform._types:Settings": { + "type": "object", + "properties": { + "align_checkpoints": { + "description": "Specifies whether the transform checkpoint ranges should be optimized for performance. Such optimization can align\ncheckpoint ranges with the date histogram interval when date histogram is specified as a group source in the\ntransform config. As a result, less document updates in the destination index will be performed thus improving\noverall performance.", + "type": "boolean" + }, + "dates_as_epoch_millis": { + "description": "Defines if dates in the ouput should be written as ISO formatted string or as millis since epoch. epoch_millis was\nthe default for transforms created before version 7.11. For compatible output set this value to `true`.", + "type": "boolean" + }, + "deduce_mappings": { + "description": "Specifies whether the transform should deduce the destination index mappings from the transform configuration.", + "type": "boolean" + }, + "docs_per_second": { + "description": "Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a\nwait time between search requests. The default value is null, which disables throttling.", + "type": "number" + }, + "max_page_search_size": { + "description": "Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker\nexceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is `10` and the\nmaximum is `65,536`.", + "type": "number" + }, + "unattended": { + "description": "If `true`, the transform runs in unattended mode. In unattended mode, the transform retries indefinitely in case\nof an error which means the transform never fails. Setting the number of retries other than infinite fails in\nvalidation.", + "x-available-since": "8.5.0", + "type": "boolean" + } + } + }, + "transform._types:Source": { + "type": "object", + "properties": { + "index": { + "$ref": "#/components/schemas/_types:Indices" + }, + "query": { + "$ref": "#/components/schemas/_types.query_dsl:QueryContainer" + }, + "runtime_mappings": { + "$ref": "#/components/schemas/_types.mapping:RuntimeFields" + } + }, + "required": [ + "index" + ] + }, + "transform._types:SyncContainer": { + "type": "object", + "properties": { + "time": { + "$ref": "#/components/schemas/transform._types:TimeSync" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "transform._types:TimeSync": { + "type": "object", + "properties": { + "delay": { + "$ref": "#/components/schemas/_types:Duration" + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "field" + ] + }, + "transform.get_transform_stats:TransformStats": { + "type": "object", + "properties": { + "checkpointing": { + "$ref": "#/components/schemas/transform.get_transform_stats:Checkpointing" + }, + "health": { + "$ref": "#/components/schemas/transform.get_transform_stats:TransformStatsHealth" + }, + "id": { + "$ref": "#/components/schemas/_types:Id" + }, + "reason": { + "type": "string" + }, + "state": { + "type": "string" + }, + "stats": { + "$ref": "#/components/schemas/transform.get_transform_stats:TransformIndexerStats" + } + }, + "required": [ + "checkpointing", + "id", + "state", + "stats" + ] + }, + "transform.get_transform_stats:Checkpointing": { + "type": "object", + "properties": { + "changes_last_detected_at": { + "type": "number" + }, + "changes_last_detected_at_date_time": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "last": { + "$ref": "#/components/schemas/transform.get_transform_stats:CheckpointStats" + }, + "next": { + "$ref": "#/components/schemas/transform.get_transform_stats:CheckpointStats" + }, + "operations_behind": { + "type": "number" + }, + "last_search_time": { + "type": "number" + } + }, + "required": [ + "last" + ] + }, + "transform.get_transform_stats:CheckpointStats": { + "type": "object", + "properties": { + "checkpoint": { + "type": "number" + }, + "checkpoint_progress": { + "$ref": "#/components/schemas/transform.get_transform_stats:TransformProgress" + }, + "timestamp": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "timestamp_millis": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "time_upper_bound": { + "$ref": "#/components/schemas/_types:DateTime" + }, + "time_upper_bound_millis": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + } + }, + "required": [ + "checkpoint" + ] + }, + "transform.get_transform_stats:TransformProgress": { + "type": "object", + "properties": { + "docs_indexed": { + "type": "number" + }, + "docs_processed": { + "type": "number" + }, + "docs_remaining": { + "type": "number" + }, + "percent_complete": { + "type": "number" + }, + "total_docs": { + "type": "number" + } + }, + "required": [ + "docs_indexed", + "docs_processed" + ] + }, + "transform.get_transform_stats:TransformStatsHealth": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/_types:HealthStatus" + } + }, + "required": [ + "status" + ] + }, + "transform.get_transform_stats:TransformIndexerStats": { + "type": "object", + "properties": { + "delete_time_in_ms": { + "$ref": "#/components/schemas/_types:EpochTimeUnitMillis" + }, + "documents_indexed": { + "type": "number" + }, + "documents_deleted": { + "type": "number" + }, + "documents_processed": { + "type": "number" + }, + "exponential_avg_checkpoint_duration_ms": { + "$ref": "#/components/schemas/_types:DurationValueUnitFloatMillis" + }, + "exponential_avg_documents_indexed": { + "type": "number" + }, + "exponential_avg_documents_processed": { + "type": "number" + }, + "index_failures": { + "type": "number" + }, + "index_time_in_ms": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + }, + "index_total": { + "type": "number" + }, + "pages_processed": { + "type": "number" + }, + "processing_time_in_ms": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + }, + "processing_total": { + "type": "number" + }, + "search_failures": { + "type": "number" + }, + "search_time_in_ms": { + "$ref": "#/components/schemas/_types:DurationValueUnitMillis" + }, + "search_total": { + "type": "number" + }, + "trigger_count": { + "type": "number" + } + }, + "required": [ + "documents_indexed", + "documents_processed", + "exponential_avg_checkpoint_duration_ms", + "exponential_avg_documents_indexed", + "exponential_avg_documents_processed", + "index_failures", + "index_time_in_ms", + "index_total", + "pages_processed", + "processing_time_in_ms", + "processing_total", + "search_failures", + "search_time_in_ms", + "search_total", + "trigger_count" + ] + }, + "transform._types:Destination": { + "type": "object", + "properties": { + "index": { + "$ref": "#/components/schemas/_types:IndexName" + }, + "pipeline": { + "description": "The unique identifier for an ingest pipeline.", + "type": "string" + } + } + }, + "_global.update:UpdateWriteResponseBase": { + "allOf": [ + { + "$ref": "#/components/schemas/_types:WriteResponseBase" + }, + { + "type": "object", + "properties": { + "get": { + "$ref": "#/components/schemas/_types:InlineGet" + } + } + } + ] + } + }, + "examples": { + "PutTransformRequestExample1": { + "summary": "A request to create a transform that uses the pivot method.", + "value": { + "source": { + "index": "kibana_sample_data_ecommerce", + "query": { + "term": { + "geoip.continent_name": { + "value": "Asia" + } + } + } + }, + "pivot": { + "group_by": { + "customer_id": { + "terms": { + "field": "customer_id", + "missing_bucket": true + } + } + }, + "aggregations": { + "max_price": { + "max": { + "field": "taxful_total_price" + } + } + } + }, + "description": "Maximum priced ecommerce data by customer_id in Asia", + "dest": { + "index": "kibana_sample_data_ecommerce_transform1", + "pipeline": "add_timestamp_pipeline" + }, + "frequency": "5m", + "sync": { + "time": { + "field": "order_date", + "delay": "60s" + } + }, + "retention_policy": { + "time": { + "field": "order_date", + "max_age": "30d" + } + } + } + }, + "PutTransformRequestExample2": { + "summary": "A request to create a transform that uses the latest method.", + "value": { + "source": { + "index": "kibana_sample_data_ecommerce" + }, + "latest": { + "unique_key": [ + "customer_id" + ], + "sort": "order_date" + }, + "description": "Latest order for each customer", + "dest": { + "index": "kibana_sample_data_ecommerce_transform2" + }, + "frequency": "5m", + "sync": { + "time": { + "field": "order_date", + "delay": "60s" + } + } + } + }, + "PutTransformResponseExample1": { + "summary": "A successful response when creating a transform.", + "value": { + "acknowledged": true + } + } + } + } +} \ No newline at end of file