@elastic/schemas 0.4.5 → 0.5.1

package/src/es/json/rollup.put_job.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"rollup.put_job","type":"object","properties":{"cron":{"type":"string","description":"A cron string which defines the intervals when the rollup job should be executed. When the interval\ntriggers, the indexer attempts to rollup the data in the index pattern. The cron pattern is unrelated\nto the time interval of the data being rolled up. For example, you may wish to create hourly rollups\nof your document but to only run the indexer on a daily basis at midnight, as defined by the cron. The\ncron pattern is defined just like a Watcher cron schedule.","x-found-in":"body"},"groups":{"$ref":"./rollup._types.json#/$defs/rollup._types__Groupings","description":"Defines the grouping fields and aggregations that are defined for this rollup job. These fields will then be\navailable later for aggregating into buckets. These aggs and fields can be used in any combination. Think of\nthe groups configuration as defining a set of tools that can later be used in aggregations to partition the\ndata. Unlike raw data, we have to think ahead to which fields and aggregations might be used. Rollups provide\nenough flexibility that you simply need to determine which fields are needed, not in what order they are needed.","x-found-in":"body"},"index_pattern":{"type":"string","description":"The index or index pattern to roll up. Supports wildcard-style patterns (`logstash-*`). The job attempts to\nrollup the entire index or index-pattern.","x-found-in":"body"},"metrics":{"type":"array","items":{"$ref":"./rollup._types.json#/$defs/rollup._types__FieldMetric"},"description":"Defines the metrics to collect for each grouping tuple. By default, only the doc_counts are collected for each\ngroup. To make rollup useful, you will often add metrics like averages, mins, maxes, etc. Metrics are defined\non a per-field basis and for each field you configure which metric should be collected.","x-found-in":"body"},"page_size":{"type":"number","description":"The number of bucket results that are processed on each iteration of the rollup indexer. A larger value tends\nto execute faster, but requires more memory during processing. This value has no effect on how the data is\nrolled up; it is merely used for tweaking the speed or memory cost of the indexer.","x-found-in":"body"},"rollup_index":{"type":"string","description":"The index that contains the rollup results. The index can be shared with other rollup jobs. The data is stored so that it doesn’t interfere with unrelated jobs.","x-found-in":"body"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Time to wait for the request to complete.","x-found-in":"body"},"headers":{"$ref":"./_types.json#/$defs/_types__HttpHeaders","x-found-in":"body"},"id":{"type":"string","description":"Identifier for the rollup job. This can be any alphanumeric string and uniquely identifies the\ndata that is associated with the rollup job. The ID is persistent; it is stored with the rolled\nup data. If you create a job, let it run for a while, then delete the job, the data that the job\nrolled up is still be associated with this job ID. You cannot create a new job with the same ID\nsince that could lead to problems with mismatched job configurations.","x-found-in":"path"}},"required":["id","cron","groups","index_pattern","page_size","rollup_index"],"description":"Create a rollup job.\n\nWARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run.\n\nThe rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index.\n\nThere are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group.\n\nJobs are created in a `STOPPED` state. You can start them with the start rollup jobs API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"rollup.put_job","description":"Create a rollup job.\n\nWARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run.\n\nThe rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index.\n\nThere are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group.\n\nJobs are created in a `STOPPED` state. You can start them with the start rollup jobs API.","x-api":{"id":"rollup.put_job","name":"put-job","namespace":"rollup"},"x-method":"PUT","x-path":"/_rollup/job/{id}","x-urls":[{"path":"/_rollup/job/{id}","methods":["PUT"]}],"x-destructive":false,"x-availability":{"stack":{"since":"6.3.0","stability":"experimental"}},"x-deprecated":{"since":"8.11.0"},"type":"object","properties":{"cron":{"type":"string","description":"A cron string which defines the intervals when the rollup job should be executed. When the interval\ntriggers, the indexer attempts to rollup the data in the index pattern. The cron pattern is unrelated\nto the time interval of the data being rolled up. For example, you may wish to create hourly rollups\nof your document but to only run the indexer on a daily basis at midnight, as defined by the cron. The\ncron pattern is defined just like a Watcher cron schedule.","x-found-in":"body"},"groups":{"$ref":"./rollup._types.json#/$defs/rollup._types__Groupings","description":"Defines the grouping fields and aggregations that are defined for this rollup job. These fields will then be\navailable later for aggregating into buckets. These aggs and fields can be used in any combination. Think of\nthe groups configuration as defining a set of tools that can later be used in aggregations to partition the\ndata. Unlike raw data, we have to think ahead to which fields and aggregations might be used. Rollups provide\nenough flexibility that you simply need to determine which fields are needed, not in what order they are needed.","x-found-in":"body"},"index_pattern":{"type":"string","description":"The index or index pattern to roll up. Supports wildcard-style patterns (`logstash-*`). The job attempts to\nrollup the entire index or index-pattern.","x-found-in":"body"},"metrics":{"type":"array","items":{"$ref":"./rollup._types.json#/$defs/rollup._types__FieldMetric"},"description":"Defines the metrics to collect for each grouping tuple. By default, only the doc_counts are collected for each\ngroup. To make rollup useful, you will often add metrics like averages, mins, maxes, etc. Metrics are defined\non a per-field basis and for each field you configure which metric should be collected.","x-found-in":"body"},"page_size":{"type":"number","description":"The number of bucket results that are processed on each iteration of the rollup indexer. A larger value tends\nto execute faster, but requires more memory during processing. This value has no effect on how the data is\nrolled up; it is merely used for tweaking the speed or memory cost of the indexer.","x-found-in":"body"},"rollup_index":{"type":"string","description":"The index that contains the rollup results. The index can be shared with other rollup jobs. The data is stored so that it doesn’t interfere with unrelated jobs.","x-found-in":"body"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Time to wait for the request to complete.","x-found-in":"body"},"headers":{"$ref":"./_types.json#/$defs/_types__HttpHeaders","x-found-in":"body"},"id":{"type":"string","description":"Identifier for the rollup job. This can be any alphanumeric string and uniquely identifies the\ndata that is associated with the rollup job. The ID is persistent; it is stored with the rolled\nup data. If you create a job, let it run for a while, then delete the job, the data that the job\nrolled up is still be associated with this job ID. You cannot create a new job with the same ID\nsince that could lead to problems with mismatched job configurations.","x-found-in":"path"}},"required":["id","cron","groups","index_pattern","page_size","rollup_index"]}

package/src/es/json/rollup.put_job.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"rollup.put_job","$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"rollup.put_job","x-api":{"id":"rollup.put_job","name":"put-job","namespace":"rollup"},"$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}

package/src/es/json/rollup.rollup_search.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"rollup.rollup_search","type":"object","properties":{"rest_total_hits_as_int":{"type":"boolean","description":"Indicates whether hits.total should be rendered as an integer or an object in the rest search response","x-found-in":"query"},"typed_keys":{"type":"boolean","description":"Specify whether aggregation and suggester names should be prefixed by their respective types in the response","x-found-in":"query"},"aggregations":{"type":"object","additionalProperties":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer"},"description":"Specifies aggregations.","x-found-in":"body"},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Specifies a DSL query that is subject to some limitations.","x-found-in":"body"},"size":{"type":"number","description":"Must be zero if set, as rollups work on pre-aggregated data.","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams and indices used to limit the request.\nThis parameter has the following rules:\n\n* At least one data stream, index, or wildcard expression must be specified. This target can include a rollup or non-rollup index. For data streams, the stream's backing indices can only serve as non-rollup indices. Omitting the parameter or using `_all` are not permitted.\n* Multiple non-rollup indices may be specified.\n* Only one rollup index may be specified. If more than one are supplied, an exception occurs.\n* Wildcard expressions (`*`) may be used. If they match more than one rollup index, an exception occurs. However, you can use an expression to match multiple non-rollup indices or data streams.","x-found-in":"path"}},"required":["index"],"description":"Search rolled-up data.\n\nThe rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data.\nIt rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query.\n\nThe request body supports a subset of features from the regular search API.\nThe following functionality is not available:\n\n`size`: Because rollups work on pre-aggregated data, no search hits can be returned and so size must be set to zero or omitted entirely.\n`highlighter`, `suggestors`, `post_filter`, `profile`, `explain`: These are similarly disallowed.\n\nFor more detailed examples of using the rollup search API, including querying rolled-up data only or combining rolled-up and live data, refer to the External documentation."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"rollup.rollup_search","description":"Search rolled-up data.\n\nThe rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data.\nIt rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query.\n\nThe request body supports a subset of features from the regular search API.\nThe following functionality is not available:\n\n`size`: Because rollups work on pre-aggregated data, no search hits can be returned and so size must be set to zero or omitted entirely.\n`highlighter`, `suggestors`, `post_filter`, `profile`, `explain`: These are similarly disallowed.\n\nFor more detailed examples of using the rollup search API, including querying rolled-up data only or combining rolled-up and live data, refer to the External documentation.","x-api":{"id":"rollup.rollup_search","name":"rollup-search","namespace":"rollup"},"x-method":"GET","x-path":"/{index}/_rollup_search","x-urls":[{"path":"/{index}/_rollup_search","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"6.3.0","stability":"experimental"}},"x-deprecated":{"since":"8.11.0"},"type":"object","properties":{"rest_total_hits_as_int":{"type":"boolean","description":"Indicates whether hits.total should be rendered as an integer or an object in the rest search response","x-found-in":"query"},"typed_keys":{"type":"boolean","description":"Specify whether aggregation and suggester names should be prefixed by their respective types in the response","x-found-in":"query"},"aggregations":{"type":"object","additionalProperties":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer"},"description":"Specifies aggregations.","x-found-in":"body"},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Specifies a DSL query that is subject to some limitations.","x-found-in":"body"},"size":{"type":"number","description":"Must be zero if set, as rollups work on pre-aggregated data.","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams and indices used to limit the request.\nThis parameter has the following rules:\n\n* At least one data stream, index, or wildcard expression must be specified. This target can include a rollup or non-rollup index. For data streams, the stream's backing indices can only serve as non-rollup indices. Omitting the parameter or using `_all` are not permitted.\n* Multiple non-rollup indices may be specified.\n* Only one rollup index may be specified. If more than one are supplied, an exception occurs.\n* Wildcard expressions (`*`) may be used. If they match more than one rollup index, an exception occurs. However, you can use an expression to match multiple non-rollup indices or data streams.","x-found-in":"path"}},"required":["index"]}

package/src/es/json/rollup.rollup_search.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"rollup.rollup_search","type":"object","properties":{"took":{"type":"number"},"timed_out":{"type":"boolean"},"terminated_early":{"type":"boolean"},"_shards":{"$ref":"./_types.json#/$defs/_types__ShardStatistics"},"hits":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HitsMetadata"},"aggregations":{}},"required":["took","timed_out","_shards","hits"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"rollup.rollup_search","x-api":{"id":"rollup.rollup_search","name":"rollup-search","namespace":"rollup"},"type":"object","properties":{"took":{"type":"number"},"timed_out":{"type":"boolean"},"terminated_early":{"type":"boolean"},"_shards":{"$ref":"./_types.json#/$defs/_types__ShardStatistics"},"hits":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HitsMetadata"},"aggregations":{}},"required":["took","timed_out","_shards","hits"]}

package/src/es/json/rollup.start_job.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"rollup.start_job","type":"object","properties":{"id":{"type":"string","description":"Identifier for the rollup job.","x-found-in":"path"}},"required":["id"],"description":"Start rollup jobs.\n\nIf you try to start a job that does not exist, an exception occurs.\nIf you try to start a job that is already started, nothing happens."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"rollup.start_job","description":"Start rollup jobs.\n\nIf you try to start a job that does not exist, an exception occurs.\nIf you try to start a job that is already started, nothing happens.","x-api":{"id":"rollup.start_job","name":"start-job","namespace":"rollup"},"x-method":"POST","x-path":"/_rollup/job/{id}/_start","x-urls":[{"path":"/_rollup/job/{id}/_start","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"6.3.0","stability":"experimental"}},"x-deprecated":{"since":"8.11.0"},"type":"object","properties":{"id":{"type":"string","description":"Identifier for the rollup job.","x-found-in":"path"}},"required":["id"]}

package/src/es/json/rollup.start_job.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"rollup.start_job","type":"object","properties":{"started":{"type":"boolean"}},"required":["started"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"rollup.start_job","x-api":{"id":"rollup.start_job","name":"start-job","namespace":"rollup"},"type":"object","properties":{"started":{"type":"boolean"}},"required":["started"]}

package/src/es/json/rollup.stop_job.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"rollup.stop_job","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"If `wait_for_completion` is `true`, the API blocks for (at maximum) the specified duration while waiting for the job to stop.\nIf more than `timeout` time has passed, the API throws a timeout exception.\nNOTE: Even if a timeout occurs, the stop request is still processing and eventually moves the job to STOPPED.\nThe timeout simply means the API call itself timed out while waiting for the status change.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If set to `true`, causes the API to block until the indexer state completely stops.\nIf set to `false`, the API returns immediately and the indexer is stopped asynchronously in the background.","x-found-in":"query"},"id":{"type":"string","description":"Identifier for the rollup job.","x-found-in":"path"}},"required":["id"],"description":"Stop rollup jobs.\n\nIf you try to stop a job that does not exist, an exception occurs.\nIf you try to stop a job that is already stopped, nothing happens.\n\nSince only a stopped job can be deleted, it can be useful to block the API until the indexer has fully stopped.\nThis is accomplished with the `wait_for_completion` query parameter, and optionally a timeout. For example:\n\n```\nPOST _rollup/job/sensor/_stop?wait_for_completion=true&timeout=10s\n```\nThe parameter blocks the API call from returning until either the job has moved to STOPPED or the specified time has elapsed.\nIf the specified time elapses without the job moving to STOPPED, a timeout exception occurs."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"rollup.stop_job","description":"Stop rollup jobs.\n\nIf you try to stop a job that does not exist, an exception occurs.\nIf you try to stop a job that is already stopped, nothing happens.\n\nSince only a stopped job can be deleted, it can be useful to block the API until the indexer has fully stopped.\nThis is accomplished with the `wait_for_completion` query parameter, and optionally a timeout. For example:\n\n```\nPOST _rollup/job/sensor/_stop?wait_for_completion=true&timeout=10s\n```\nThe parameter blocks the API call from returning until either the job has moved to STOPPED or the specified time has elapsed.\nIf the specified time elapses without the job moving to STOPPED, a timeout exception occurs.","x-api":{"id":"rollup.stop_job","name":"stop-job","namespace":"rollup"},"x-method":"POST","x-path":"/_rollup/job/{id}/_stop","x-urls":[{"path":"/_rollup/job/{id}/_stop","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"6.3.0","stability":"experimental"}},"x-deprecated":{"since":"8.11.0"},"type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"If `wait_for_completion` is `true`, the API blocks for (at maximum) the specified duration while waiting for the job to stop.\nIf more than `timeout` time has passed, the API throws a timeout exception.\nNOTE: Even if a timeout occurs, the stop request is still processing and eventually moves the job to STOPPED.\nThe timeout simply means the API call itself timed out while waiting for the status change.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If set to `true`, causes the API to block until the indexer state completely stops.\nIf set to `false`, the API returns immediately and the indexer is stopped asynchronously in the background.","x-found-in":"query"},"id":{"type":"string","description":"Identifier for the rollup job.","x-found-in":"path"}},"required":["id"]}

package/src/es/json/rollup.stop_job.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"rollup.stop_job","type":"object","properties":{"stopped":{"type":"boolean"}},"required":["stopped"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"rollup.stop_job","x-api":{"id":"rollup.stop_job","name":"stop-job","namespace":"rollup"},"type":"object","properties":{"stopped":{"type":"boolean"}},"required":["stopped"]}

package/src/es/json/scripts_painless_execute.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"scripts_painless_execute","type":"object","properties":{"context":{"$ref":"./_global.scripts_painless_execute.json#/$defs/_global.scripts_painless_execute__PainlessContext","description":"The context that the script should run in.\nNOTE: Result ordering in the field contexts is not guaranteed.","x-found-in":"body"},"context_setup":{"$ref":"./_global.scripts_painless_execute.json#/$defs/_global.scripts_painless_execute__PainlessContextSetup","description":"Additional parameters for the `context`.\nNOTE: This parameter is required for all contexts except `painless_test`, which is the default if no value is provided for `context`.","x-found-in":"body"},"script":{"$ref":"./_types.json#/$defs/_types__Script","description":"The Painless script to run.","x-found-in":"body"}},"description":"Run a script.\n\nRuns a script and returns a result.\nUse this API to build and test scripts, such as when defining a script for a runtime field.\nThis API requires very few dependencies and is especially useful if you don't have permissions to write documents on a cluster.\n\nThe API uses several _contexts_, which control how scripts are run, what variables are available at runtime, and what the return type is.\n\nEach context requires a script, but additional parameters depend on the context you're using for that script."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"scripts_painless_execute","description":"Run a script.\n\nRuns a script and returns a result.\nUse this API to build and test scripts, such as when defining a script for a runtime field.\nThis API requires very few dependencies and is especially useful if you don't have permissions to write documents on a cluster.\n\nThe API uses several _contexts_, which control how scripts are run, what variables are available at runtime, and what the return type is.\n\nEach context requires a script, but additional parameters depend on the context you're using for that script.","x-api":{"id":"scripts_painless_execute","name":"scripts-painless-execute","namespace":null},"x-method":"GET","x-path":"/_scripts/painless/_execute","x-urls":[{"path":"/_scripts/painless/_execute","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"6.3.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"context":{"$ref":"./_global.scripts_painless_execute.json#/$defs/_global.scripts_painless_execute__PainlessContext","description":"The context that the script should run in.\nNOTE: Result ordering in the field contexts is not guaranteed.","x-found-in":"body"},"context_setup":{"$ref":"./_global.scripts_painless_execute.json#/$defs/_global.scripts_painless_execute__PainlessContextSetup","description":"Additional parameters for the `context`.\nNOTE: This parameter is required for all contexts except `painless_test`, which is the default if no value is provided for `context`.","x-found-in":"body"},"script":{"$ref":"./_types.json#/$defs/_types__Script","description":"The Painless script to run.","x-found-in":"body"}}}

package/src/es/json/scripts_painless_execute.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"scripts_painless_execute","type":"object","properties":{"result":{}},"required":["result"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"scripts_painless_execute","x-api":{"id":"scripts_painless_execute","name":"scripts-painless-execute","namespace":null},"type":"object","properties":{"result":{}},"required":["result"]}

package/src/es/json/scroll.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"scroll","type":"object","properties":{"scroll":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to retain the search context for scrolling.","x-found-in":"body"},"scroll_id":{"type":"string","description":"The scroll ID","x-found-in":"body"},"rest_total_hits_as_int":{"type":"boolean","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.","x-found-in":"query"}},"required":["scroll_id"],"description":"Run a scrolling search.\n\nIMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"scroll","description":"Run a scrolling search.\n\nIMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.","x-api":{"id":"scroll","name":"scroll","namespace":null},"x-method":"GET","x-path":"/_search/scroll","x-urls":[{"path":"/_search/scroll","methods":["GET","POST"]},{"path":"/_search/scroll/{scroll_id}","methods":["GET","POST"],"deprecated":{"since":"7.0.0","description":"A scroll id can be quite large and should be specified as part of the body"}}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"scroll":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to retain the search context for scrolling.","x-found-in":"body"},"scroll_id":{"type":"string","description":"The scroll ID","x-found-in":"body","x-deprecated":{"since":"7.0.0"}},"rest_total_hits_as_int":{"type":"boolean","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.","x-found-in":"query"}},"required":["scroll_id"]}

package/src/es/json/scroll.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"scroll","$ref":"./_global.search.json#/$defs/_global.search__ResponseBody"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"scroll","x-api":{"id":"scroll","name":"scroll","namespace":null},"$ref":"./_global.search.json#/$defs/_global.search__ResponseBody"}

package/src/es/json/search.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search","type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"allow_partial_search_results":{"type":"boolean","description":"If `true` and there are shard request timeouts or shard failures, the request returns partial results.\nIf `false`, it returns an error with no partial results.\n\nTo override the default behavior, you can set the `search.default_allow_partial_results` cluster setting to `false`.","x-found-in":"query"},"analyzer":{"type":"string","description":"The analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"analyze_wildcard":{"type":"boolean","description":"If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"batched_reduce_size":{"type":"number","description":"The number of shard results that should be reduced at once on the coordinating node.\nIf the potential number of shards in the request can be large, this value should be used as a protection mechanism to reduce the memory overhead per search request.","x-found-in":"query"},"ccs_minimize_roundtrips":{"type":"boolean","description":"If `true`, network round-trips between the coordinating node and the remote clusters are minimized when running cross-cluster search (CCS) requests.","x-found-in":"query"},"default_operator":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__Operator","description":"The default operator for the query string query: `and` or `or`.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"df":{"type":"string","description":"The field to use as a default when no field prefix is given in the query string.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"docvalue_fields":{"type":"array","items":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat"},"description":"An array of wildcard (`*`) field patterns.\nThe request returns doc values for field names matching these patterns in the `hits.fields` property of the response.","x-found-in":"body"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"The 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.\nIt supports comma-separated values such as `open,hidden`.","x-found-in":"query"},"explain":{"type":"boolean","description":"If `true`, the request returns detailed information about score computation as part of a hit.","x-found-in":"body"},"ignore_throttled":{"type":"boolean","description":"If `true`, concrete, expanded or aliased indices will be ignored when frozen.","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"include_named_queries_score":{"type":"boolean","description":"If `true`, the response includes the score contribution from any named queries.\n\nThis functionality reruns each named query on every hit in a search response.\nTypically, this adds a small overhead to a request.\nHowever, using computationally expensive named queries on a large number of hits may add significant overhead.","x-found-in":"query"},"lenient":{"type":"boolean","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 be used only when the `q` query string parameter is specified.","x-found-in":"query"},"max_concurrent_shard_requests":{"type":"number","description":"The number of concurrent shard requests per node that the search runs 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.","x-found-in":"query"},"preference":{"type":"string","description":"The nodes and shards used for the search.\nBy default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness.\nValid values are:\n\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:<node-id>,<node-id>` to run the search on only the specified nodes IDs. If suitable shards exist on more than one selected node, use shards on those nodes using the default method. If none of the specified nodes are available, select shards from any available node using the default method.\n* `_prefer_nodes:<node-id>,<node-id>` to if possible, run the search on the specified nodes IDs. If not, select shards using the default method.\n* `_shards:<shard>,<shard>` to run the search only on the specified shards. You can combine this value with other `preference` values. However, the `_shards` value must come first. For example: `_shards:2,3|_local`.\n* `<custom-string>` (any string that does not start with `_`) to route searches with the same `<custom-string>` to the same shards in the same order.","x-found-in":"query"},"pre_filter_shard_size":{"type":"number","description":"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:\n\n* The request targets more than 128 shards.\n* The request targets one or more read-only index.\n* The primary sort of the query targets an indexed field.","x-found-in":"query"},"request_cache":{"type":"boolean","description":"If `true`, the caching of search results is enabled for requests where `size` is `0`.\nIt defaults to index level settings.","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A custom value that is used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.","x-found-in":"query"},"scroll":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to retain the search context for scrolling.\nBy default, this value cannot exceed `1d` (24 hours).\nYou can change this limit by using the `search.max_keep_alive` cluster-level setting.","x-found-in":"query"},"search_type":{"$ref":"./_types.json#/$defs/_types__SearchType","description":"Indicates how distributed term frequencies are calculated for relevance scoring.","x-found-in":"query"},"stats":{"type":"array","items":{"type":"string"},"description":"The stats groups to associate with the search.\nEach group maintains a statistics aggregation for its associated searches.\nYou can retrieve these stats using the indices stats API.","x-found-in":"body"},"stored_fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` property defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.","x-found-in":"body"},"suggest_field":{"type":"string","description":"The field to use for suggestions.","x-found-in":"query"},"suggest_mode":{"$ref":"./_types.json#/$defs/_types__SuggestMode","description":"The suggest mode.\nThis parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.","x-found-in":"query"},"suggest_size":{"type":"number","description":"The number of suggestions to return.\nThis parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.","x-found-in":"query"},"suggest_text":{"type":"string","description":"The source text for which the suggestions should be returned.\nThis parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.","x-found-in":"query"},"terminate_after":{"type":"number","description":"The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this property to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this property for requests that target data streams with backing indices across multiple data tiers.\n\nIf set to `0` (default), the query does not terminate early.","x-found-in":"body"},"timeout":{"type":"string","description":"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.","x-found-in":"body"},"track_total_hits":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__TrackHits","description":"Number of hits matching the query to count accurately.\nIf `true`, the exact number of hits is returned at the cost of some performance.\nIf `false`, the  response does not include the total number of hits matching the query.","x-found-in":"body"},"track_scores":{"type":"boolean","description":"If `true`, calculate and return document scores, even if the scores are not used for sorting.","x-found-in":"body"},"typed_keys":{"type":"boolean","description":"If `true`, aggregation and suggester names are be prefixed by their respective types in the response.","x-found-in":"query"},"rest_total_hits_as_int":{"type":"boolean","description":"Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response.","x-found-in":"query"},"version":{"type":"boolean","description":"If `true`, the request returns the document version as part of a hit.","x-found-in":"body"},"_source":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SourceConfig","description":"The source fields that are returned for matching documents.\nThese fields are returned in the `hits._source` property of the search response.\nIf the `stored_fields` property is specified, the `_source` property defaults to `false`.\nOtherwise, it defaults to `true`.","x-found-in":"body"},"_source_excludes":{"$ref":"./_types.json#/$defs/_types__Fields","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.","x-found-in":"query"},"_source_exclude_vectors":{"type":"boolean","description":"Whether vectors should be excluded from _source","x-found-in":"query"},"_source_includes":{"$ref":"./_types.json#/$defs/_types__Fields","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.","x-found-in":"query"},"seq_no_primary_term":{"type":"boolean","description":"If `true`, the request returns sequence number and primary term of the last modification of each hit.","x-found-in":"body"},"q":{"type":"string","description":"A query in the Lucene query string syntax.\nQuery parameter searches do not support the full Elasticsearch Query DSL but are handy for testing.\n\nIMPORTANT: This parameter overrides the query parameter in the request body.\nIf both parameters are specified, documents matching the query request body parameter are not returned.","x-found-in":"query"},"size":{"type":"number","description":"The number of hits to return, which must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` property.","x-found-in":"body"},"from":{"type":"number","description":"The starting document offset, which must 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.","x-found-in":"body"},"sort":{"$ref":"./_types.json#/$defs/_types__Sort","description":"A comma-separated list of <field>:<direction> pairs.","x-found-in":"body"},"aggregations":{"type":"object","additionalProperties":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer"},"description":"Defines the aggregations that are run as part of the search request.","x-found-in":"body"},"collapse":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__FieldCollapse","description":"Collapses search results the values of the specified field.","x-found-in":"body"},"ext":{"type":"object","additionalProperties":{},"description":"Configuration of search extensions defined by Elasticsearch plugins.","x-found-in":"body"},"highlight":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Highlight","description":"Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results.","x-found-in":"body"},"indices_boost":{"type":"array","items":{"type":"object","additionalProperties":{"type":"number"}},"description":"Boost the `_score` of documents from specified indices.\nThe boost value is the factor by which scores are multiplied.\nA boost value greater than `1.0` increases the score.\nA boost value between `0` and `1.0` decreases the score.","x-found-in":"body"},"knn":{"anyOf":[{"$ref":"./_types.json#/$defs/_types__KnnSearch"},{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__KnnSearch"}}],"description":"The approximate kNN search to run.","x-found-in":"body"},"rank":{"$ref":"./_types.json#/$defs/_types__RankContainer","description":"The Reciprocal Rank Fusion (RRF) to use.","x-found-in":"body"},"min_score":{"type":"number","description":"The minimum `_score` for matching documents.\nDocuments with a lower `_score` are not included in search results and results collected by aggregations.","x-found-in":"body"},"post_filter":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Use the `post_filter` parameter to filter search results.\nThe search hits are filtered after the aggregations are calculated.\nA post filter has no impact on the aggregation results.","x-found-in":"body"},"profile":{"type":"boolean","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.","x-found-in":"body"},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The search definition using the Query DSL.","x-found-in":"body"},"rescore":{"anyOf":[{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Rescore"},{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__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.","x-found-in":"body"},"retriever":{"$ref":"./_types.json#/$defs/_types__RetrieverContainer","description":"A retriever is a specification to describe top documents returned from a search.\nA retriever replaces other elements of the search API that also return top documents such as `query` and `knn`.","x-found-in":"body"},"script_fields":{"type":"object","additionalProperties":{"$ref":"./_types.json#/$defs/_types__ScriptField"},"description":"Retrieve a script evaluation (based on different fields) for each hit.","x-found-in":"body"},"search_after":{"$ref":"./_types.json#/$defs/_types__SortResults","description":"Used to retrieve the next page of hits using a set of sort values from the previous page.","x-found-in":"body"},"slice":{"$ref":"./_types.json#/$defs/_types__SlicedScroll","description":"Split a scrolled search into multiple slices that can be consumed independently.","x-found-in":"body"},"fields":{"type":"array","items":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat"},"description":"An array of wildcard (`*`) field patterns.\nThe request returns values for field names matching these patterns in the `hits.fields` property of the response.","x-found-in":"body"},"suggest":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Suggester","description":"Defines a suggester that provides similar looking terms based on a provided text.","x-found-in":"body"},"pit":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__PointInTimeReference","description":"Limit the search to a point in time (PIT).\nIf you provide a PIT, you cannot specify an `<index>` in the request path.","x-found-in":"body"},"runtime_mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__RuntimeFields","description":"One or more runtime fields in the search request.\nThese fields take precedence over mapped fields with the same name.","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.","x-found-in":"path"}},"description":"Run a search.\n\nGet search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.\n\nIf the Elasticsearch security features are enabled, you must have the read index privilege for the target data stream, index, or alias. For cross-cluster search, refer to the documentation about configuring CCS privileges.\nTo search a point in time (PIT) for an alias, you must have the `read` index privilege for the alias's data streams or indices.\n\n**Search slicing**\n\nWhen paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently with the `slice` and `pit` properties.\nBy default the splitting is done first on the shards, then locally on each shard.\n\nFor instance if the number of shards is equal to 2 and you request 4 slices, the slices 0 and 2 are assigned to the first shard and the slices 1 and 3 are assigned to the second shard.\n\nIMPORTANT: The same point-in-time ID should be used for all slices.\nIf different PIT IDs are used, slices can overlap and miss documents.\nThis situation can occur because, by default, the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search","description":"Run a search.\n\nGet search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.\n\nIf the Elasticsearch security features are enabled, you must have the read index privilege for the target data stream, index, or alias. For cross-cluster search, refer to the documentation about configuring CCS privileges.\nTo search a point in time (PIT) for an alias, you must have the `read` index privilege for the alias's data streams or indices.\n\n**Search slicing**\n\nWhen paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently with the `slice` and `pit` properties.\nBy default the splitting is done first on the shards, then locally on each shard.\n\nFor instance if the number of shards is equal to 2 and you request 4 slices, the slices 0 and 2 are assigned to the first shard and the slices 1 and 3 are assigned to the second shard.\n\nIMPORTANT: The same point-in-time ID should be used for all slices.\nIf different PIT IDs are used, slices can overlap and miss documents.\nThis situation can occur because, by default, the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index.","x-api":{"id":"search","name":"search","namespace":null},"x-method":"GET","x-path":"/{index}/_search","x-urls":[{"path":"/_search","methods":["GET","POST"]},{"path":"/{index}/_search","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"allow_partial_search_results":{"type":"boolean","description":"If `true` and there are shard request timeouts or shard failures, the request returns partial results.\nIf `false`, it returns an error with no partial results.\n\nTo override the default behavior, you can set the `search.default_allow_partial_results` cluster setting to `false`.","x-found-in":"query"},"analyzer":{"type":"string","description":"The analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"analyze_wildcard":{"type":"boolean","description":"If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"batched_reduce_size":{"type":"number","description":"The number of shard results that should be reduced at once on the coordinating node.\nIf the potential number of shards in the request can be large, this value should be used as a protection mechanism to reduce the memory overhead per search request.","x-found-in":"query"},"ccs_minimize_roundtrips":{"type":"boolean","description":"If `true`, network round-trips between the coordinating node and the remote clusters are minimized when running cross-cluster search (CCS) requests.","x-found-in":"query"},"default_operator":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__Operator","description":"The default operator for the query string query: `and` or `or`.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"df":{"type":"string","description":"The field to use as a default when no field prefix is given in the query string.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"docvalue_fields":{"type":"array","items":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat"},"description":"An array of wildcard (`*`) field patterns.\nThe request returns doc values for field names matching these patterns in the `hits.fields` property of the response.","x-found-in":"body"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"The 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.\nIt supports comma-separated values such as `open,hidden`.","x-found-in":"query"},"explain":{"type":"boolean","description":"If `true`, the request returns detailed information about score computation as part of a hit.","x-found-in":"body"},"ignore_throttled":{"type":"boolean","description":"If `true`, concrete, expanded or aliased indices will be ignored when frozen.","x-found-in":"query","x-deprecated":{"since":"7.16.0"}},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"include_named_queries_score":{"type":"boolean","description":"If `true`, the response includes the score contribution from any named queries.\n\nThis functionality reruns each named query on every hit in a search response.\nTypically, this adds a small overhead to a request.\nHowever, using computationally expensive named queries on a large number of hits may add significant overhead.","x-found-in":"query"},"lenient":{"type":"boolean","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 be used only when the `q` query string parameter is specified.","x-found-in":"query"},"max_concurrent_shard_requests":{"type":"number","description":"The number of concurrent shard requests per node that the search runs 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.","x-found-in":"query"},"preference":{"type":"string","description":"The nodes and shards used for the search.\nBy default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness.\nValid values are:\n\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:<node-id>,<node-id>` to run the search on only the specified nodes IDs. If suitable shards exist on more than one selected node, use shards on those nodes using the default method. If none of the specified nodes are available, select shards from any available node using the default method.\n* `_prefer_nodes:<node-id>,<node-id>` to if possible, run the search on the specified nodes IDs. If not, select shards using the default method.\n* `_shards:<shard>,<shard>` to run the search only on the specified shards. You can combine this value with other `preference` values. However, the `_shards` value must come first. For example: `_shards:2,3|_local`.\n* `<custom-string>` (any string that does not start with `_`) to route searches with the same `<custom-string>` to the same shards in the same order.","x-found-in":"query"},"pre_filter_shard_size":{"type":"number","description":"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:\n\n* The request targets more than 128 shards.\n* The request targets one or more read-only index.\n* The primary sort of the query targets an indexed field.","x-found-in":"query"},"request_cache":{"type":"boolean","description":"If `true`, the caching of search results is enabled for requests where `size` is `0`.\nIt defaults to index level settings.","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A custom value that is used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.","x-found-in":"query"},"scroll":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to retain the search context for scrolling.\nBy default, this value cannot exceed `1d` (24 hours).\nYou can change this limit by using the `search.max_keep_alive` cluster-level setting.","x-found-in":"query"},"search_type":{"$ref":"./_types.json#/$defs/_types__SearchType","description":"Indicates how distributed term frequencies are calculated for relevance scoring.","x-found-in":"query"},"stats":{"type":"array","items":{"type":"string"},"description":"The stats groups to associate with the search.\nEach group maintains a statistics aggregation for its associated searches.\nYou can retrieve these stats using the indices stats API.","x-found-in":"body"},"stored_fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` property defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.","x-found-in":"body"},"suggest_field":{"type":"string","description":"The field to use for suggestions.","x-found-in":"query"},"suggest_mode":{"$ref":"./_types.json#/$defs/_types__SuggestMode","description":"The suggest mode.\nThis parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.","x-found-in":"query"},"suggest_size":{"type":"number","description":"The number of suggestions to return.\nThis parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.","x-found-in":"query"},"suggest_text":{"type":"string","description":"The source text for which the suggestions should be returned.\nThis parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.","x-found-in":"query"},"terminate_after":{"type":"number","description":"The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this property to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this property for requests that target data streams with backing indices across multiple data tiers.\n\nIf set to `0` (default), the query does not terminate early.","x-found-in":"body"},"timeout":{"type":"string","description":"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.","x-found-in":"body"},"track_total_hits":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__TrackHits","description":"Number of hits matching the query to count accurately.\nIf `true`, the exact number of hits is returned at the cost of some performance.\nIf `false`, the  response does not include the total number of hits matching the query.","x-found-in":"body"},"track_scores":{"type":"boolean","description":"If `true`, calculate and return document scores, even if the scores are not used for sorting.","x-found-in":"body"},"typed_keys":{"type":"boolean","description":"If `true`, aggregation and suggester names are be prefixed by their respective types in the response.","x-found-in":"query"},"rest_total_hits_as_int":{"type":"boolean","description":"Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response.","x-found-in":"query"},"version":{"type":"boolean","description":"If `true`, the request returns the document version as part of a hit.","x-found-in":"body"},"_source":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SourceConfig","description":"The source fields that are returned for matching documents.\nThese fields are returned in the `hits._source` property of the search response.\nIf the `stored_fields` property is specified, the `_source` property defaults to `false`.\nOtherwise, it defaults to `true`.","x-found-in":"body"},"_source_excludes":{"$ref":"./_types.json#/$defs/_types__Fields","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.","x-found-in":"query"},"_source_exclude_vectors":{"type":"boolean","description":"Whether vectors should be excluded from _source","x-found-in":"query","x-availability":{"stack":{"since":"9.2.0"},"serverless":{}}},"_source_includes":{"$ref":"./_types.json#/$defs/_types__Fields","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.","x-found-in":"query"},"seq_no_primary_term":{"type":"boolean","description":"If `true`, the request returns sequence number and primary term of the last modification of each hit.","x-found-in":"body"},"q":{"type":"string","description":"A query in the Lucene query string syntax.\nQuery parameter searches do not support the full Elasticsearch Query DSL but are handy for testing.\n\nIMPORTANT: This parameter overrides the query parameter in the request body.\nIf both parameters are specified, documents matching the query request body parameter are not returned.","x-found-in":"query"},"size":{"type":"number","description":"The number of hits to return, which must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` property.","x-found-in":"body"},"from":{"type":"number","description":"The starting document offset, which must 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.","x-found-in":"body"},"sort":{"$ref":"./_types.json#/$defs/_types__Sort","description":"A comma-separated list of <field>:<direction> pairs.","x-found-in":"body"},"aggregations":{"type":"object","additionalProperties":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer"},"description":"Defines the aggregations that are run as part of the search request.","x-found-in":"body"},"collapse":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__FieldCollapse","description":"Collapses search results the values of the specified field.","x-found-in":"body"},"ext":{"type":"object","additionalProperties":{},"description":"Configuration of search extensions defined by Elasticsearch plugins.","x-found-in":"body"},"highlight":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Highlight","description":"Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results.","x-found-in":"body"},"indices_boost":{"type":"array","items":{"type":"object","additionalProperties":{"type":"number"}},"description":"Boost the `_score` of documents from specified indices.\nThe boost value is the factor by which scores are multiplied.\nA boost value greater than `1.0` increases the score.\nA boost value between `0` and `1.0` decreases the score.","x-found-in":"body"},"knn":{"anyOf":[{"$ref":"./_types.json#/$defs/_types__KnnSearch"},{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__KnnSearch"}}],"description":"The approximate kNN search to run.","x-found-in":"body","x-availability":{"stack":{"since":"8.4.0"},"serverless":{}}},"rank":{"$ref":"./_types.json#/$defs/_types__RankContainer","description":"The Reciprocal Rank Fusion (RRF) to use.","x-found-in":"body","x-availability":{"stack":{"since":"8.8.0"}}},"min_score":{"type":"number","description":"The minimum `_score` for matching documents.\nDocuments with a lower `_score` are not included in search results and results collected by aggregations.","x-found-in":"body"},"post_filter":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Use the `post_filter` parameter to filter search results.\nThe search hits are filtered after the aggregations are calculated.\nA post filter has no impact on the aggregation results.","x-found-in":"body"},"profile":{"type":"boolean","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.","x-found-in":"body"},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The search definition using the Query DSL.","x-found-in":"body"},"rescore":{"anyOf":[{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Rescore"},{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__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.","x-found-in":"body"},"retriever":{"$ref":"./_types.json#/$defs/_types__RetrieverContainer","description":"A retriever is a specification to describe top documents returned from a search.\nA retriever replaces other elements of the search API that also return top documents such as `query` and `knn`.","x-found-in":"body","x-availability":{"stack":{"since":"8.14.0","stability":"stable"},"serverless":{"stability":"stable"}}},"script_fields":{"type":"object","additionalProperties":{"$ref":"./_types.json#/$defs/_types__ScriptField"},"description":"Retrieve a script evaluation (based on different fields) for each hit.","x-found-in":"body"},"search_after":{"$ref":"./_types.json#/$defs/_types__SortResults","description":"Used to retrieve the next page of hits using a set of sort values from the previous page.","x-found-in":"body"},"slice":{"$ref":"./_types.json#/$defs/_types__SlicedScroll","description":"Split a scrolled search into multiple slices that can be consumed independently.","x-found-in":"body"},"fields":{"type":"array","items":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat"},"description":"An array of wildcard (`*`) field patterns.\nThe request returns values for field names matching these patterns in the `hits.fields` property of the response.","x-found-in":"body"},"suggest":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Suggester","description":"Defines a suggester that provides similar looking terms based on a provided text.","x-found-in":"body"},"pit":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__PointInTimeReference","description":"Limit the search to a point in time (PIT).\nIf you provide a PIT, you cannot specify an `<index>` in the request path.","x-found-in":"body"},"runtime_mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__RuntimeFields","description":"One or more runtime fields in the search request.\nThese fields take precedence over mapped fields with the same name.","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.","x-found-in":"path"}}}

package/src/es/json/search.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search","$ref":"./_global.search.json#/$defs/_global.search__ResponseBody"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search","x-api":{"id":"search","name":"search","namespace":null},"$ref":"./_global.search.json#/$defs/_global.search__ResponseBody"}

package/src/es/json/search_application.delete.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.delete","type":"object","properties":{"name":{"type":"string","description":"The name of the search application to delete.","x-found-in":"path"}},"required":["name"],"description":"Delete a search application.\n\nRemove a search application and its associated alias. Indices attached to the search application are not removed."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.delete","description":"Delete a search application.\n\nRemove a search application and its associated alias. Indices attached to the search application are not removed.","x-api":{"id":"search-application.delete","name":"delete","namespace":"search-application"},"x-method":"DELETE","x-path":"/_application/search_application/{name}","x-urls":[{"path":"/_application/search_application/{name}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.8.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"name":{"type":"string","description":"The name of the search application to delete.","x-found-in":"path"}},"required":["name"]}

package/src/es/json/search_application.delete.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.delete","$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.delete","x-api":{"id":"search-application.delete","name":"delete","namespace":"search-application"},"$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}

package/src/es/json/search_application.delete_behavioral_analytics.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.delete_behavioral_analytics","type":"object","properties":{"name":{"type":"string","description":"The name of the analytics collection to be deleted","x-found-in":"path"}},"required":["name"],"description":"Delete a behavioral analytics collection.\n\nThe associated data stream is also deleted."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.delete_behavioral_analytics","description":"Delete a behavioral analytics collection.\n\nThe associated data stream is also deleted.","x-api":{"id":"search-application.delete_behavioral_analytics","name":"delete-behavioral-analytics","namespace":"search-application"},"x-method":"DELETE","x-path":"/_application/analytics/{name}","x-urls":[{"path":"/_application/analytics/{name}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.8.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"public"}},"x-deprecated":{"since":"9.0.0"},"type":"object","properties":{"name":{"type":"string","description":"The name of the analytics collection to be deleted","x-found-in":"path"}},"required":["name"]}

package/src/es/json/search_application.delete_behavioral_analytics.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.delete_behavioral_analytics","$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.delete_behavioral_analytics","x-api":{"id":"search-application.delete_behavioral_analytics","name":"delete-behavioral-analytics","namespace":"search-application"},"$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}

package/src/es/json/search_application.get.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.get","type":"object","properties":{"name":{"type":"string","description":"The name of the search application","x-found-in":"path"}},"required":["name"],"description":"Get search application details."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.get","description":"Get search application details.","x-api":{"id":"search-application.get","name":"get","namespace":"search-application"},"x-method":"GET","x-path":"/_application/search_application/{name}","x-urls":[{"path":"/_application/search_application/{name}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.8.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"name":{"type":"string","description":"The name of the search application","x-found-in":"path"}},"required":["name"]}

package/src/es/json/search_application.get.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.get","$ref":"./search_application._types.json#/$defs/search_application._types__SearchApplication"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.get","x-api":{"id":"search-application.get","name":"get","namespace":"search-application"},"$ref":"./search_application._types.json#/$defs/search_application._types__SearchApplication"}

package/src/es/json/search_application.get_behavioral_analytics.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.get_behavioral_analytics","type":"object","properties":{"name":{"type":"array","items":{"type":"string"},"description":"A list of analytics collections to limit the returned information","x-found-in":"path"}},"description":"Get behavioral analytics collections."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.get_behavioral_analytics","description":"Get behavioral analytics collections.","x-api":{"id":"search-application.get_behavioral_analytics","name":"get-behavioral-analytics","namespace":"search-application"},"x-method":"GET","x-path":"/_application/analytics/{name}","x-urls":[{"path":"/_application/analytics","methods":["GET"]},{"path":"/_application/analytics/{name}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.8.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"public"}},"x-deprecated":{"since":"9.0.0"},"type":"object","properties":{"name":{"type":"array","items":{"type":"string"},"description":"A list of analytics collections to limit the returned information","x-found-in":"path"}}}

package/src/es/json/search_application.get_behavioral_analytics.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.get_behavioral_analytics","type":"object","additionalProperties":{"$ref":"./search_application._types.json#/$defs/search_application._types__AnalyticsCollection"}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.get_behavioral_analytics","x-api":{"id":"search-application.get_behavioral_analytics","name":"get-behavioral-analytics","namespace":"search-application"},"type":"object","additionalProperties":{"$ref":"./search_application._types.json#/$defs/search_application._types__AnalyticsCollection"}}

package/src/es/json/search_application.list.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.list","type":"object","properties":{"q":{"type":"string","description":"Query in the Lucene query string syntax.","x-found-in":"query"},"from":{"type":"number","description":"Starting offset.","x-found-in":"query"},"size":{"type":"number","description":"Specifies a max number of results to get.","x-found-in":"query"}},"description":"Get search applications.\n\nGet information about search applications."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.list","description":"Get search applications.\n\nGet information about search applications.","x-api":{"id":"search-application.list","name":"list","namespace":"search-application"},"x-method":"GET","x-path":"/_application/search_application","x-urls":[{"path":"/_application/search_application","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.8.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"q":{"type":"string","description":"Query in the Lucene query string syntax.","x-found-in":"query"},"from":{"type":"number","description":"Starting offset.","x-found-in":"query"},"size":{"type":"number","description":"Specifies a max number of results to get.","x-found-in":"query"}}}

package/src/es/json/search_application.list.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.list","type":"object","properties":{"count":{"type":"number"},"results":{"type":"array","items":{"$ref":"./search_application._types.json#/$defs/search_application._types__SearchApplication"}}},"required":["count","results"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.list","x-api":{"id":"search-application.list","name":"list","namespace":"search-application"},"type":"object","properties":{"count":{"type":"number"},"results":{"type":"array","items":{"$ref":"./search_application._types.json#/$defs/search_application._types__SearchApplication"}}},"required":["count","results"]}

package/src/es/json/search_application.post_behavioral_analytics_event.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.post_behavioral_analytics_event","type":"object","properties":{"debug":{"type":"boolean","description":"Whether the response type has to include more details","x-found-in":"query"},"payload":{"x-found-in":"body"},"collection_name":{"type":"string","description":"The name of the behavioral analytics collection.","x-found-in":"path"},"event_type":{"$ref":"./search_application._types.json#/$defs/search_application._types__EventType","description":"The analytics event type.","x-found-in":"path"}},"required":["collection_name","event_type"],"description":"Create a behavioral analytics collection event."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.post_behavioral_analytics_event","description":"Create a behavioral analytics collection event.","x-api":{"id":"search-application.post_behavioral_analytics_event","name":"post-behavioral-analytics-event","namespace":"search-application"},"x-method":"POST","x-path":"/_application/analytics/{collection_name}/event/{event_type}","x-urls":[{"path":"/_application/analytics/{collection_name}/event/{event_type}","methods":["POST"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"experimental","visibility":"public"}},"x-deprecated":{"since":"9.0.0"},"type":"object","properties":{"debug":{"type":"boolean","description":"Whether the response type has to include more details","x-found-in":"query"},"payload":{"x-found-in":"body","x-body-root":true},"collection_name":{"type":"string","description":"The name of the behavioral analytics collection.","x-found-in":"path"},"event_type":{"$ref":"./search_application._types.json#/$defs/search_application._types__EventType","description":"The analytics event type.","x-found-in":"path"}},"required":["collection_name","event_type"]}

package/src/es/json/search_application.post_behavioral_analytics_event.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.post_behavioral_analytics_event","type":"object","properties":{"accepted":{"type":"boolean"},"event":{}},"required":["accepted"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.post_behavioral_analytics_event","x-api":{"id":"search-application.post_behavioral_analytics_event","name":"post-behavioral-analytics-event","namespace":"search-application"},"type":"object","properties":{"accepted":{"type":"boolean"},"event":{}},"required":["accepted"]}

package/src/es/json/search_application.put.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.put","type":"object","properties":{"create":{"type":"boolean","description":"If `true`, this request cannot replace or update existing Search Applications.","x-found-in":"query"},"search_application":{"$ref":"./search_application._types.json#/$defs/search_application._types__SearchApplicationParameters","x-found-in":"body"},"name":{"type":"string","description":"The name of the search application to be created or updated.","x-found-in":"path"}},"required":["name"],"description":"Create or update a search application."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.put","description":"Create or update a search application.","x-api":{"id":"search-application.put","name":"put","namespace":"search-application"},"x-method":"PUT","x-path":"/_application/search_application/{name}","x-urls":[{"path":"/_application/search_application/{name}","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.8.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"create":{"type":"boolean","description":"If `true`, this request cannot replace or update existing Search Applications.","x-found-in":"query"},"search_application":{"$ref":"./search_application._types.json#/$defs/search_application._types__SearchApplicationParameters","x-found-in":"body","x-body-root":true},"name":{"type":"string","description":"The name of the search application to be created or updated.","x-found-in":"path"}},"required":["name"]}

package/src/es/json/search_application.put.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.put","type":"object","properties":{"result":{"$ref":"./_types.json#/$defs/_types__Result"}},"required":["result"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.put","x-api":{"id":"search-application.put","name":"put","namespace":"search-application"},"type":"object","properties":{"result":{"$ref":"./_types.json#/$defs/_types__Result"}},"required":["result"]}

package/src/es/json/search_application.put_behavioral_analytics.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.put_behavioral_analytics","type":"object","properties":{"name":{"type":"string","description":"The name of the analytics collection to be created or updated.","x-found-in":"path"}},"required":["name"],"description":"Create a behavioral analytics collection."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.put_behavioral_analytics","description":"Create a behavioral analytics collection.","x-api":{"id":"search-application.put_behavioral_analytics","name":"put-behavioral-analytics","namespace":"search-application"},"x-method":"PUT","x-path":"/_application/analytics/{name}","x-urls":[{"path":"/_application/analytics/{name}","methods":["PUT"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.8.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"public"}},"x-deprecated":{"since":"9.0.0"},"type":"object","properties":{"name":{"type":"string","description":"The name of the analytics collection to be created or updated.","x-found-in":"path"}},"required":["name"]}

package/src/es/json/search_application.put_behavioral_analytics.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.put_behavioral_analytics","$ref":"./search_application.put_behavioral_analytics.json#/$defs/search_application.put_behavioral_analytics__AnalyticsAcknowledgeResponseBase"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.put_behavioral_analytics","x-api":{"id":"search-application.put_behavioral_analytics","name":"put-behavioral-analytics","namespace":"search-application"},"$ref":"./search_application.put_behavioral_analytics.json#/$defs/search_application.put_behavioral_analytics__AnalyticsAcknowledgeResponseBase"}

package/src/es/json/search_application.render_query.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.render_query","type":"object","properties":{"params":{"type":"object","additionalProperties":{},"x-found-in":"body"},"name":{"type":"string","description":"The name of the search application to render teh query for.","x-found-in":"path"}},"required":["name"],"description":"Render a search application query.\n\nGenerate an Elasticsearch query using the specified query parameters and the search template associated with the search application or a default template if none is specified.\nIf a parameter used in the search template is not specified in `params`, the parameter's default value will be used.\nThe API returns the specific Elasticsearch query that would be generated and run by calling the search application search API.\n\nYou must have `read` privileges on the backing alias of the search application."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.render_query","description":"Render a search application query.\n\nGenerate an Elasticsearch query using the specified query parameters and the search template associated with the search application or a default template if none is specified.\nIf a parameter used in the search template is not specified in `params`, the parameter's default value will be used.\nThe API returns the specific Elasticsearch query that would be generated and run by calling the search application search API.\n\nYou must have `read` privileges on the backing alias of the search application.","x-api":{"id":"search-application.render_query","name":"render-query","namespace":"search-application"},"x-method":"POST","x-path":"/_application/search_application/{name}/_render_query","x-urls":[{"path":"/_application/search_application/{name}/_render_query","methods":["POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.9.0","stability":"experimental","visibility":"public"}},"type":"object","properties":{"params":{"type":"object","additionalProperties":{},"x-found-in":"body"},"name":{"type":"string","description":"The name of the search application to render teh query for.","x-found-in":"path"}},"required":["name"]}

package/src/es/json/search_application.render_query.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.render_query","type":"object","properties":{}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.render_query","x-api":{"id":"search-application.render_query","name":"render-query","namespace":"search-application"},"type":"object","properties":{}}

package/src/es/json/search_application.search.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.search","type":"object","properties":{"typed_keys":{"type":"boolean","description":"Determines whether aggregation names are prefixed by their respective types in the response.","x-found-in":"query"},"params":{"type":"object","additionalProperties":{},"description":"Query parameters specific to this request, which will override any defaults specified in the template.","x-found-in":"body"},"name":{"type":"string","description":"The name of the search application to be searched.","x-found-in":"path"}},"required":["name"],"description":"Run a search application search.\n\nGenerate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template.\nUnspecified template parameters are assigned their default values if applicable."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.search","description":"Run a search application search.\n\nGenerate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template.\nUnspecified template parameters are assigned their default values if applicable.","x-api":{"id":"search-application.search","name":"search","namespace":"search-application"},"x-method":"GET","x-path":"/_application/search_application/{name}/_search","x-urls":[{"path":"/_application/search_application/{name}/_search","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.8.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"typed_keys":{"type":"boolean","description":"Determines whether aggregation names are prefixed by their respective types in the response.","x-found-in":"query","x-availability":{"stack":{"since":"8.14.0"},"serverless":{}}},"params":{"type":"object","additionalProperties":{},"description":"Query parameters specific to this request, which will override any defaults specified in the template.","x-found-in":"body"},"name":{"type":"string","description":"The name of the search application to be searched.","x-found-in":"path"}},"required":["name"]}

package/src/es/json/search_application.search.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.search","$ref":"./_global.search.json#/$defs/_global.search__ResponseBody"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_application.search","x-api":{"id":"search-application.search","name":"search","namespace":"search-application"},"$ref":"./_global.search.json#/$defs/_global.search__ResponseBody"}

package/src/es/json/search_mvt.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_mvt","type":"object","properties":{"exact_bounds":{"type":"boolean","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\n`geo_bounds` aggregation. The aggregation runs on <field> values that intersect\nthe `<zoom>/<x>/<y>` tile with `wrap_longitude` set to `false`. The resulting\nbounding box may be larger than the vector tile.","x-found-in":"body"},"extent":{"type":"number","description":"The size, in pixels, of a side of the tile. Vector tiles are square with equal sides.","x-found-in":"body"},"grid_agg":{"$ref":"./_global.search_mvt._types.json#/$defs/_global.search_mvt._types__GridAggregationType","description":"The aggregation used to create a grid for the `field`.","x-found-in":"body"},"grid_precision":{"type":"number","description":"Additional zoom levels available through the aggs layer. For example, if `<zoom>` 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.","x-found-in":"body"},"grid_type":{"$ref":"./_global.search_mvt._types.json#/$defs/_global.search_mvt._types__GridType","description":"Determines the geometry type for features in the aggs layer. In the aggs layer,\neach feature represents a `geotile_grid` cell. If `grid, each feature is a polygon\nof the cells bounding box. If `point`, each feature is a Point that is the centroid\nof the cell.","x-found-in":"body"},"size":{"type":"number","description":"The maximum number of features to return in the hits layer. Accepts 0-10000.\nIf 0, results don't include the hits layer.","x-found-in":"body"},"track_total_hits":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__TrackHits","description":"The number of hits matching the query to count accurately. If `true`, the exact number\nof hits is returned at the cost of some performance. If `false`, the response does\nnot include the total number of hits matching the query.","x-found-in":"body"},"with_labels":{"type":"boolean","description":"If `true`, the hits and aggs layers will contain additional point features representing\nsuggested label positions for the original features.\n\n* `Point` and `MultiPoint` features will have one of the points selected.\n* `Polygon` and `MultiPolygon` features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree.\n* `LineString` features will likewise provide a roughly central point selected from the triangle-tree.\n* The aggregation results will provide one central point for each aggregation bucket.\n\nAll attributes from the original features will also be copied to the new label features.\nIn addition, the new features will be distinguishable using the tag `_mvt_label_position`.","x-found-in":"body"},"aggs":{"type":"object","additionalProperties":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer"},"description":"Sub-aggregations for the geotile_grid.\n\nIt supports the following aggregation types:\n\n- `avg`\n- `boxplot`\n- `cardinality`\n- `extended stats`\n- `max`\n- `median absolute deviation`\n- `min`\n- `percentile`\n- `percentile-rank`\n- `stats`\n- `sum`\n- `value count`\n\nThe aggregation names can't start with `_mvt_`. The `_mvt_` prefix is reserved for internal aggregations.","x-found-in":"body"},"buffer":{"type":"number","description":"The 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.","x-found-in":"body"},"fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"The fields to return in the `hits` layer.\nIt supports wildcards (`*`).\nThis parameter does not support fields with array values. Fields with array\nvalues may return inconsistent results.","x-found-in":"body"},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The query DSL used to filter documents for the search.","x-found-in":"body"},"runtime_mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__RuntimeFields","description":"Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.","x-found-in":"body"},"sort":{"$ref":"./_types.json#/$defs/_types__Sort","description":"Sort the features in the hits layer. By default, the API calculates a bounding\nbox for each feature. It sorts features based on this box's diagonal length,\nfrom longest to shortest.","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A list of indices, data streams, or aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.\nTo search a remote cluster, use the `<cluster>:<target>` syntax.","x-found-in":"path"},"field":{"type":"string","description":"A field that contains the geospatial data to return.\nIt must be a `geo_point` or `geo_shape` field.\nThe field must have doc values enabled. It cannot be a nested field.\n\nNOTE: Vector tiles do not natively support geometry collections.\nFor `geometrycollection` values in a `geo_shape` field, the API returns a hits layer feature for each element of the collection.\nThis behavior may change in a future release.","x-found-in":"path"},"zoom":{"type":"number","description":"The zoom level of the vector tile to search. It accepts `0` to `29`.","x-found-in":"path"},"x":{"type":"number","description":"The X coordinate for the vector tile to search.","x-found-in":"path"},"y":{"type":"number","description":"The Y coordinate for the vector tile to search.","x-found-in":"path"}},"required":["index","field","zoom","x","y"],"description":"Search a vector tile.\n\nSearch a vector tile for geospatial values.\nBefore using this API, you should be familiar with the Mapbox vector tile specification.\nThe API returns results as a binary mapbox vector tile.\n\nInternally, Elasticsearch translates a vector tile search API request into a search containing:\n\n* A `geo_bounding_box` query on the `<field>`. The query uses the `<zoom>/<x>/<y>` tile as a bounding box.\n* A `geotile_grid` or `geohex_grid` aggregation on the `<field>`. The `grid_agg` parameter determines the aggregation type. The aggregation uses the `<zoom>/<x>/<y>` tile as a bounding box.\n* Optionally, a `geo_bounds` aggregation on the `<field>`. The search only includes this aggregation if the `exact_bounds` parameter is `true`.\n* If the optional parameter `with_labels` is `true`, the internal search will include a dynamic runtime field that calls the `getLabelPosition` function of the geometry doc value. This enables the generation of new point features containing suggested geometry labels, so that, for example, multi-polygons will have only one label.\n\nThe API returns results as a binary Mapbox vector tile.\nMapbox vector tiles are encoded as Google Protobufs (PBF). By default, the tile contains three layers:\n\n* A `hits` layer containing a feature for each `<field>` value matching the `geo_bounding_box` query.\n* An `aggs` layer containing a feature for each cell of the `geotile_grid` or `geohex_grid`. The layer only contains features for cells with matching data.\n* A meta layer containing:\n  * A feature containing a bounding box. By default, this is the bounding box of the tile.\n  * Value ranges for any sub-aggregations on the `geotile_grid` or `geohex_grid`.\n  * Metadata for the search.\n\nThe API only returns features that can display at its zoom level.\nFor example, if a polygon feature has no area at its zoom level, the API omits it.\nThe API returns errors as UTF-8 encoded JSON.\n\nIMPORTANT: You can specify several options for this API as either a query parameter or request body parameter.\nIf you specify both parameters, the query parameter takes precedence.\n\n**Grid precision for geotile**\n\nFor a `grid_agg` of `geotile`, you can use cells in the `aggs` layer as tiles for lower zoom levels.\n`grid_precision` represents the additional zoom levels available through these cells. The final precision is computed by as follows: `<zoom> + grid_precision`.\nFor example, if `<zoom>` is 7 and `grid_precision` is 8, then the `geotile_grid` aggregation will use a precision of 15.\nThe maximum final precision is 29.\nThe `grid_precision` also determines the number of cells for the grid as follows: `(2^grid_precision) x (2^grid_precision)`.\nFor example, a value of 8 divides the tile into a grid of 256 x 256 cells.\nThe `aggs` layer only contains features for cells with matching data.\n\n**Grid precision for geohex**\n\nFor a `grid_agg` of `geohex`, Elasticsearch uses `<zoom>` and `grid_precision` to calculate a final precision as follows: `<zoom> + grid_precision`.\n\nThis precision determines the H3 resolution of the hexagonal cells produced by the `geohex` aggregation.\nThe following table maps the H3 resolution for each precision.\nFor example, if `<zoom>` is 3 and `grid_precision` is 3, the precision is 6.\nAt a precision of 6, hexagonal cells have an H3 resolution of 2.\nIf `<zoom>` is 3 and `grid_precision` is 4, the precision is 7.\nAt a precision of 7, hexagonal cells have an H3 resolution of 3.\n\n| Precision | Unique tile bins | H3 resolution | Unique hex bins |\tRatio |\n| --------- | ---------------- | ------------- | ----------------| ----- |\n| 1  | 4                  | 0  | 122             | 30.5           |\n| 2  | 16                 | 0  | 122             | 7.625          |\n| 3  | 64                 | 1  | 842             | 13.15625       |\n| 4  | 256                | 1  | 842             | 3.2890625      |\n| 5  | 1024               | 2  | 5882            | 5.744140625    |\n| 6  | 4096               | 2  | 5882            | 1.436035156    |\n| 7  | 16384              | 3  | 41162           | 2.512329102    |\n| 8  | 65536              | 3  | 41162           | 0.6280822754   |\n| 9  | 262144             | 4  | 288122          | 1.099098206    |\n| 10 | 1048576            | 4  | 288122          | 0.2747745514   |\n| 11 | 4194304            | 5  | 2016842         | 0.4808526039   |\n| 12 | 16777216           | 6  | 14117882        | 0.8414913416   |\n| 13 | 67108864           | 6  | 14117882        | 0.2103728354   |\n| 14 | 268435456          | 7  | 98825162        | 0.3681524172   |\n| 15 | 1073741824         | 8  | 691776122       | 0.644266719    |\n| 16 | 4294967296         | 8  | 691776122       | 0.1610666797   |\n| 17 | 17179869184        | 9  | 4842432842      | 0.2818666889   |\n| 18 | 68719476736        | 10 | 33897029882     | 0.4932667053   |\n| 19 | 274877906944       | 11 | 237279209162    | 0.8632167343   |\n| 20 | 1099511627776      | 11 | 237279209162    | 0.2158041836   |\n| 21 | 4398046511104      | 12 | 1660954464122   | 0.3776573213   |\n| 22 | 17592186044416     | 13 | 11626681248842  | 0.6609003122   |\n| 23 | 70368744177664     | 13 | 11626681248842  | 0.165225078    |\n| 24 | 281474976710656    | 14 | 81386768741882  | 0.2891438866   |\n| 25 | 1125899906842620   | 15 | 569707381193162 | 0.5060018015   |\n| 26 | 4503599627370500   | 15 | 569707381193162 | 0.1265004504   |\n| 27 | 18014398509482000  | 15 | 569707381193162 | 0.03162511259  |\n| 28 | 72057594037927900  | 15 | 569707381193162 | 0.007906278149 |\n| 29 | 288230376151712000 | 15 | 569707381193162 | 0.001976569537 |\n\nHexagonal cells don't align perfectly on a vector tile.\nSome cells may intersect more than one vector tile.\nTo compute the H3 resolution for each precision, Elasticsearch compares the average density of hexagonal bins at each resolution with the average density of tile bins at each zoom level.\nElasticsearch uses the H3 resolution that is closest to the corresponding geotile density.\n\nLearn how to use the vector tile search API with practical examples in the [Vector tile search examples](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/vector-tile-search) guide."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_mvt","description":"Search a vector tile.\n\nSearch a vector tile for geospatial values.\nBefore using this API, you should be familiar with the Mapbox vector tile specification.\nThe API returns results as a binary mapbox vector tile.\n\nInternally, Elasticsearch translates a vector tile search API request into a search containing:\n\n* A `geo_bounding_box` query on the `<field>`. The query uses the `<zoom>/<x>/<y>` tile as a bounding box.\n* A `geotile_grid` or `geohex_grid` aggregation on the `<field>`. The `grid_agg` parameter determines the aggregation type. The aggregation uses the `<zoom>/<x>/<y>` tile as a bounding box.\n* Optionally, a `geo_bounds` aggregation on the `<field>`. The search only includes this aggregation if the `exact_bounds` parameter is `true`.\n* If the optional parameter `with_labels` is `true`, the internal search will include a dynamic runtime field that calls the `getLabelPosition` function of the geometry doc value. This enables the generation of new point features containing suggested geometry labels, so that, for example, multi-polygons will have only one label.\n\nThe API returns results as a binary Mapbox vector tile.\nMapbox vector tiles are encoded as Google Protobufs (PBF). By default, the tile contains three layers:\n\n* A `hits` layer containing a feature for each `<field>` value matching the `geo_bounding_box` query.\n* An `aggs` layer containing a feature for each cell of the `geotile_grid` or `geohex_grid`. The layer only contains features for cells with matching data.\n* A meta layer containing:\n  * A feature containing a bounding box. By default, this is the bounding box of the tile.\n  * Value ranges for any sub-aggregations on the `geotile_grid` or `geohex_grid`.\n  * Metadata for the search.\n\nThe API only returns features that can display at its zoom level.\nFor example, if a polygon feature has no area at its zoom level, the API omits it.\nThe API returns errors as UTF-8 encoded JSON.\n\nIMPORTANT: You can specify several options for this API as either a query parameter or request body parameter.\nIf you specify both parameters, the query parameter takes precedence.\n\n**Grid precision for geotile**\n\nFor a `grid_agg` of `geotile`, you can use cells in the `aggs` layer as tiles for lower zoom levels.\n`grid_precision` represents the additional zoom levels available through these cells. The final precision is computed by as follows: `<zoom> + grid_precision`.\nFor example, if `<zoom>` is 7 and `grid_precision` is 8, then the `geotile_grid` aggregation will use a precision of 15.\nThe maximum final precision is 29.\nThe `grid_precision` also determines the number of cells for the grid as follows: `(2^grid_precision) x (2^grid_precision)`.\nFor example, a value of 8 divides the tile into a grid of 256 x 256 cells.\nThe `aggs` layer only contains features for cells with matching data.\n\n**Grid precision for geohex**\n\nFor a `grid_agg` of `geohex`, Elasticsearch uses `<zoom>` and `grid_precision` to calculate a final precision as follows: `<zoom> + grid_precision`.\n\nThis precision determines the H3 resolution of the hexagonal cells produced by the `geohex` aggregation.\nThe following table maps the H3 resolution for each precision.\nFor example, if `<zoom>` is 3 and `grid_precision` is 3, the precision is 6.\nAt a precision of 6, hexagonal cells have an H3 resolution of 2.\nIf `<zoom>` is 3 and `grid_precision` is 4, the precision is 7.\nAt a precision of 7, hexagonal cells have an H3 resolution of 3.\n\n| Precision | Unique tile bins | H3 resolution | Unique hex bins |\tRatio |\n| --------- | ---------------- | ------------- | ----------------| ----- |\n| 1  | 4                  | 0  | 122             | 30.5           |\n| 2  | 16                 | 0  | 122             | 7.625          |\n| 3  | 64                 | 1  | 842             | 13.15625       |\n| 4  | 256                | 1  | 842             | 3.2890625      |\n| 5  | 1024               | 2  | 5882            | 5.744140625    |\n| 6  | 4096               | 2  | 5882            | 1.436035156    |\n| 7  | 16384              | 3  | 41162           | 2.512329102    |\n| 8  | 65536              | 3  | 41162           | 0.6280822754   |\n| 9  | 262144             | 4  | 288122          | 1.099098206    |\n| 10 | 1048576            | 4  | 288122          | 0.2747745514   |\n| 11 | 4194304            | 5  | 2016842         | 0.4808526039   |\n| 12 | 16777216           | 6  | 14117882        | 0.8414913416   |\n| 13 | 67108864           | 6  | 14117882        | 0.2103728354   |\n| 14 | 268435456          | 7  | 98825162        | 0.3681524172   |\n| 15 | 1073741824         | 8  | 691776122       | 0.644266719    |\n| 16 | 4294967296         | 8  | 691776122       | 0.1610666797   |\n| 17 | 17179869184        | 9  | 4842432842      | 0.2818666889   |\n| 18 | 68719476736        | 10 | 33897029882     | 0.4932667053   |\n| 19 | 274877906944       | 11 | 237279209162    | 0.8632167343   |\n| 20 | 1099511627776      | 11 | 237279209162    | 0.2158041836   |\n| 21 | 4398046511104      | 12 | 1660954464122   | 0.3776573213   |\n| 22 | 17592186044416     | 13 | 11626681248842  | 0.6609003122   |\n| 23 | 70368744177664     | 13 | 11626681248842  | 0.165225078    |\n| 24 | 281474976710656    | 14 | 81386768741882  | 0.2891438866   |\n| 25 | 1125899906842620   | 15 | 569707381193162 | 0.5060018015   |\n| 26 | 4503599627370500   | 15 | 569707381193162 | 0.1265004504   |\n| 27 | 18014398509482000  | 15 | 569707381193162 | 0.03162511259  |\n| 28 | 72057594037927900  | 15 | 569707381193162 | 0.007906278149 |\n| 29 | 288230376151712000 | 15 | 569707381193162 | 0.001976569537 |\n\nHexagonal cells don't align perfectly on a vector tile.\nSome cells may intersect more than one vector tile.\nTo compute the H3 resolution for each precision, Elasticsearch compares the average density of hexagonal bins at each resolution with the average density of tile bins at each zoom level.\nElasticsearch uses the H3 resolution that is closest to the corresponding geotile density.\n\nLearn how to use the vector tile search API with practical examples in the [Vector tile search examples](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/vector-tile-search) guide.","x-api":{"id":"search_mvt","name":"search-mvt","namespace":null},"x-method":"POST","x-path":"/{index}/_mvt/{field}/{zoom}/{x}/{y}","x-urls":[{"path":"/{index}/_mvt/{field}/{zoom}/{x}/{y}","methods":["POST","GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.15.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"exact_bounds":{"type":"boolean","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\n`geo_bounds` aggregation. The aggregation runs on <field> values that intersect\nthe `<zoom>/<x>/<y>` tile with `wrap_longitude` set to `false`. The resulting\nbounding box may be larger than the vector tile.","x-found-in":"body"},"extent":{"type":"number","description":"The size, in pixels, of a side of the tile. Vector tiles are square with equal sides.","x-found-in":"body"},"grid_agg":{"$ref":"./_global.search_mvt._types.json#/$defs/_global.search_mvt._types__GridAggregationType","description":"The aggregation used to create a grid for the `field`.","x-found-in":"body"},"grid_precision":{"type":"number","description":"Additional zoom levels available through the aggs layer. For example, if `<zoom>` 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.","x-found-in":"body"},"grid_type":{"$ref":"./_global.search_mvt._types.json#/$defs/_global.search_mvt._types__GridType","description":"Determines the geometry type for features in the aggs layer. In the aggs layer,\neach feature represents a `geotile_grid` cell. If `grid, each feature is a polygon\nof the cells bounding box. If `point`, each feature is a Point that is the centroid\nof the cell.","x-found-in":"body"},"size":{"type":"number","description":"The maximum number of features to return in the hits layer. Accepts 0-10000.\nIf 0, results don't include the hits layer.","x-found-in":"body"},"track_total_hits":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__TrackHits","description":"The number of hits matching the query to count accurately. If `true`, the exact number\nof hits is returned at the cost of some performance. If `false`, the response does\nnot include the total number of hits matching the query.","x-found-in":"body"},"with_labels":{"type":"boolean","description":"If `true`, the hits and aggs layers will contain additional point features representing\nsuggested label positions for the original features.\n\n* `Point` and `MultiPoint` features will have one of the points selected.\n* `Polygon` and `MultiPolygon` features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree.\n* `LineString` features will likewise provide a roughly central point selected from the triangle-tree.\n* The aggregation results will provide one central point for each aggregation bucket.\n\nAll attributes from the original features will also be copied to the new label features.\nIn addition, the new features will be distinguishable using the tag `_mvt_label_position`.","x-found-in":"body"},"aggs":{"type":"object","additionalProperties":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer"},"description":"Sub-aggregations for the geotile_grid.\n\nIt supports the following aggregation types:\n\n- `avg`\n- `boxplot`\n- `cardinality`\n- `extended stats`\n- `max`\n- `median absolute deviation`\n- `min`\n- `percentile`\n- `percentile-rank`\n- `stats`\n- `sum`\n- `value count`\n\nThe aggregation names can't start with `_mvt_`. The `_mvt_` prefix is reserved for internal aggregations.","x-found-in":"body"},"buffer":{"type":"number","description":"The 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.","x-found-in":"body"},"fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"The fields to return in the `hits` layer.\nIt supports wildcards (`*`).\nThis parameter does not support fields with array values. Fields with array\nvalues may return inconsistent results.","x-found-in":"body"},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The query DSL used to filter documents for the search.","x-found-in":"body"},"runtime_mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__RuntimeFields","description":"Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.","x-found-in":"body"},"sort":{"$ref":"./_types.json#/$defs/_types__Sort","description":"Sort the features in the hits layer. By default, the API calculates a bounding\nbox for each feature. It sorts features based on this box's diagonal length,\nfrom longest to shortest.","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A list of indices, data streams, or aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.\nTo search a remote cluster, use the `<cluster>:<target>` syntax.","x-found-in":"path"},"field":{"type":"string","description":"A field that contains the geospatial data to return.\nIt must be a `geo_point` or `geo_shape` field.\nThe field must have doc values enabled. It cannot be a nested field.\n\nNOTE: Vector tiles do not natively support geometry collections.\nFor `geometrycollection` values in a `geo_shape` field, the API returns a hits layer feature for each element of the collection.\nThis behavior may change in a future release.","x-found-in":"path"},"zoom":{"type":"number","description":"The zoom level of the vector tile to search. It accepts `0` to `29`.","x-found-in":"path"},"x":{"type":"number","description":"The X coordinate for the vector tile to search.","x-found-in":"path"},"y":{"type":"number","description":"The Y coordinate for the vector tile to search.","x-found-in":"path"}},"required":["index","field","zoom","x","y"]}

package/src/es/json/search_mvt.response.json

@@ -1 +1 @@
-{"type":"string","description":"base64-encoded binary","$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_mvt"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_mvt","description":"base64-encoded binary","x-api":{"id":"search_mvt","name":"search-mvt","namespace":null},"type":"string"}

package/src/es/json/search_shards.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_shards","type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","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`.","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"local":{"type":"boolean","description":"If `true`, the request retrieves information from the local node only.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIT can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"},"preference":{"type":"string","description":"The node or shard the operation should be performed on.\nIt is random by default.","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A custom value used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.","x-found-in":"path"}},"description":"Get the search shards.\n\nGet the indices and shards that a search request would be run against.\nThis information can be useful for working out issues or planning optimizations with routing and shard preferences.\nWhen filtered aliases are used, the filter is returned as part of the `indices` section.\n\nIf the Elasticsearch security features are enabled, you must have the `view_index_metadata` or `manage` index privilege for the target data stream, index, or alias."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_shards","description":"Get the search shards.\n\nGet the indices and shards that a search request would be run against.\nThis information can be useful for working out issues or planning optimizations with routing and shard preferences.\nWhen filtered aliases are used, the filter is returned as part of the `indices` section.\n\nIf the Elasticsearch security features are enabled, you must have the `view_index_metadata` or `manage` index privilege for the target data stream, index, or alias.","x-api":{"id":"search_shards","name":"search-shards","namespace":null},"x-method":"GET","x-path":"/{index}/_search_shards","x-urls":[{"path":"/_search_shards","methods":["GET","POST"]},{"path":"/{index}/_search_shards","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"}},"type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","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`.","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"local":{"type":"boolean","description":"If `true`, the request retrieves information from the local node only.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIT can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"},"preference":{"type":"string","description":"The node or shard the operation should be performed on.\nIt is random by default.","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A custom value used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.","x-found-in":"path"}}}

package/src/es/json/search_shards.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_shards","type":"object","properties":{"nodes":{"type":"object","additionalProperties":{"$ref":"./_global.search_shards.json#/$defs/_global.search_shards__SearchShardsNodeAttributes"}},"shards":{"type":"array","items":{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__NodeShard"}}},"indices":{"type":"object","additionalProperties":{"$ref":"./_global.search_shards.json#/$defs/_global.search_shards__ShardStoreIndex"}}},"required":["nodes","shards","indices"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_shards","x-api":{"id":"search_shards","name":"search-shards","namespace":null},"type":"object","properties":{"nodes":{"type":"object","additionalProperties":{"$ref":"./_global.search_shards.json#/$defs/_global.search_shards__SearchShardsNodeAttributes"}},"shards":{"type":"array","items":{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__NodeShard"}}},"indices":{"type":"object","additionalProperties":{"$ref":"./_global.search_shards.json#/$defs/_global.search_shards__ShardStoreIndex"}}},"required":["nodes","shards","indices"]}

package/src/es/json/search_template.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_template","type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"ccs_minimize_roundtrips":{"type":"boolean","description":"Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"The 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`.","x-found-in":"query"},"explain":{"type":"boolean","description":"If `true`, returns detailed information about score calculation as part of each hit.\nIf you specify both this and the `explain` query parameter, the API uses only the query parameter.","x-found-in":"body"},"ignore_throttled":{"type":"boolean","description":"If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled.","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"preference":{"type":"string","description":"The node or shard the operation should be performed on.\nIt is random by default.","x-found-in":"query"},"profile":{"type":"boolean","description":"If `true`, the query execution is profiled.","x-found-in":"body"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A custom value used to route operations to a specific shard.","x-found-in":"query"},"scroll":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies how long a consistent view of the index\nshould be maintained for scrolled search.","x-found-in":"query"},"search_type":{"$ref":"./_types.json#/$defs/_types__SearchType","description":"The type of the search operation.","x-found-in":"query"},"rest_total_hits_as_int":{"type":"boolean","description":"If `true`, `hits.total` is rendered as an integer in the response.\nIf `false`, it is rendered as an object.","x-found-in":"query"},"typed_keys":{"type":"boolean","description":"If `true`, the response prefixes aggregation and suggester names with their respective types.","x-found-in":"query"},"id":{"type":"string","description":"The ID of the search template to use. If no `source` is specified,\nthis parameter is required.","x-found-in":"body"},"params":{"type":"object","additionalProperties":{},"description":"Key-value pairs used to replace Mustache variables in the template.\nThe key is the variable name.\nThe value is the variable value.","x-found-in":"body"},"source":{"$ref":"./_types.json#/$defs/_types__ScriptSource","description":"An inline search template. Supports the same parameters as the search API's\nrequest body. It also supports Mustache variables. If no `id` is specified, this\nparameter is required.","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).","x-found-in":"path"}},"description":"Run a search with a search template."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_template","description":"Run a search with a search template.","x-api":{"id":"search_template","name":"search-template","namespace":null},"x-method":"GET","x-path":"/{index}/_search/template","x-urls":[{"path":"/_search/template","methods":["GET","POST"]},{"path":"/{index}/_search/template","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"2.0.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"ccs_minimize_roundtrips":{"type":"boolean","description":"Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"The 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`.","x-found-in":"query"},"explain":{"type":"boolean","description":"If `true`, returns detailed information about score calculation as part of each hit.\nIf you specify both this and the `explain` query parameter, the API uses only the query parameter.","x-found-in":"body"},"ignore_throttled":{"type":"boolean","description":"If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled.","x-found-in":"query","x-deprecated":{"since":"7.16.0"}},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"preference":{"type":"string","description":"The node or shard the operation should be performed on.\nIt is random by default.","x-found-in":"query"},"profile":{"type":"boolean","description":"If `true`, the query execution is profiled.","x-found-in":"body"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A custom value used to route operations to a specific shard.","x-found-in":"query"},"scroll":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies how long a consistent view of the index\nshould be maintained for scrolled search.","x-found-in":"query"},"search_type":{"$ref":"./_types.json#/$defs/_types__SearchType","description":"The type of the search operation.","x-found-in":"query"},"rest_total_hits_as_int":{"type":"boolean","description":"If `true`, `hits.total` is rendered as an integer in the response.\nIf `false`, it is rendered as an object.","x-found-in":"query","x-availability":{"stack":{"since":"7.0.0"},"serverless":{}}},"typed_keys":{"type":"boolean","description":"If `true`, the response prefixes aggregation and suggester names with their respective types.","x-found-in":"query"},"id":{"type":"string","description":"The ID of the search template to use. If no `source` is specified,\nthis parameter is required.","x-found-in":"body"},"params":{"type":"object","additionalProperties":{},"description":"Key-value pairs used to replace Mustache variables in the template.\nThe key is the variable name.\nThe value is the variable value.","x-found-in":"body"},"source":{"$ref":"./_types.json#/$defs/_types__ScriptSource","description":"An inline search template. Supports the same parameters as the search API's\nrequest body. It also supports Mustache variables. If no `id` is specified, this\nparameter is required.","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).","x-found-in":"path"}}}

package/src/es/json/search_template.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_template","type":"object","properties":{"took":{"type":"number"},"timed_out":{"type":"boolean"},"_shards":{"$ref":"./_types.json#/$defs/_types__ShardStatistics"},"hits":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HitsMetadata"},"aggregations":{"type":"object","additionalProperties":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__Aggregate"}},"_clusters":{"$ref":"./_types.json#/$defs/_types__ClusterStatistics"},"fields":{"type":"object","additionalProperties":{}},"max_score":{"type":"number"},"num_reduce_phases":{"type":"number"},"profile":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Profile"},"pit_id":{"type":"string"},"_scroll_id":{"type":"string"},"suggest":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Suggest"}}},"terminated_early":{"type":"boolean"}},"required":["took","timed_out","_shards","hits"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_template","x-api":{"id":"search_template","name":"search-template","namespace":null},"type":"object","properties":{"took":{"type":"number"},"timed_out":{"type":"boolean"},"_shards":{"$ref":"./_types.json#/$defs/_types__ShardStatistics"},"hits":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__HitsMetadata"},"aggregations":{"type":"object","additionalProperties":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__Aggregate"}},"_clusters":{"$ref":"./_types.json#/$defs/_types__ClusterStatistics"},"fields":{"type":"object","additionalProperties":{}},"max_score":{"type":"number"},"num_reduce_phases":{"type":"number"},"profile":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Profile"},"pit_id":{"type":"string"},"_scroll_id":{"type":"string"},"suggest":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Suggest"}}},"terminated_early":{"type":"boolean"}},"required":["took","timed_out","_shards","hits"]}

package/src/es/json/searchable_snapshots.cache_stats.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"searchable_snapshots.cache_stats","type":"object","properties":{"node_id":{"$ref":"./_types.json#/$defs/_types__NodeIds","description":"The names of the nodes in the cluster to target.","x-found-in":"path"}},"description":"Get cache statistics.\n\nGet statistics about the shared cache for partially mounted indices."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"searchable_snapshots.cache_stats","description":"Get cache statistics.\n\nGet statistics about the shared cache for partially mounted indices.","x-api":{"id":"searchable-snapshots.cache_stats","name":"cache-stats","namespace":"searchable-snapshots"},"x-method":"GET","x-path":"/_searchable_snapshots/{node_id}/cache/stats","x-urls":[{"path":"/_searchable_snapshots/cache/stats","methods":["GET"]},{"path":"/_searchable_snapshots/{node_id}/cache/stats","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.13.0","stability":"experimental"}},"type":"object","properties":{"node_id":{"$ref":"./_types.json#/$defs/_types__NodeIds","description":"The names of the nodes in the cluster to target.","x-found-in":"path"}}}

package/src/es/json/searchable_snapshots.cache_stats.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"searchable_snapshots.cache_stats","type":"object","properties":{"nodes":{"type":"object","additionalProperties":{"$ref":"./searchable_snapshots.cache_stats.json#/$defs/searchable_snapshots.cache_stats__Node"}}},"required":["nodes"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"searchable_snapshots.cache_stats","x-api":{"id":"searchable-snapshots.cache_stats","name":"cache-stats","namespace":"searchable-snapshots"},"type":"object","properties":{"nodes":{"type":"object","additionalProperties":{"$ref":"./searchable_snapshots.cache_stats.json#/$defs/searchable_snapshots.cache_stats__Node"}}},"required":["nodes"]}