@elastic/schemas 0.4.5 → 0.5.1

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"async_search.delete","type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the async search.","x-found-in":"path"}},"required":["id"],"description":"Delete an async search.\n\nIf the asynchronous search is still running, it is cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"async_search.delete","description":"Delete an async search.\n\nIf the asynchronous search is still running, it is cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.","x-api":{"id":"async-search.delete","name":"delete","namespace":"async-search"},"x-method":"DELETE","x-path":"/_async_search/{id}","x-urls":[{"path":"/_async_search/{id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.7.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the async search.","x-found-in":"path"}},"required":["id"]}

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

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

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"async_search.get","type":"object","properties":{"keep_alive":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The length of time that the async search should be available in the cluster.\nWhen not specified, the `keep_alive` set with the corresponding submit async request will be used.\nOtherwise, it is possible to override the value and extend the validity of the request.\nWhen this period expires, the search, if still running, is cancelled.\nIf the search is completed, its saved results are deleted.","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"},"wait_for_completion_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies to wait for the search to be completed up until the provided timeout.\nFinal results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires.\nBy default no timeout is set meaning that the currently available results will be returned without any additional wait.","x-found-in":"query"},"return_intermediate_results":{"type":"boolean","description":"Specifies whether the response should contain intermediate results if the query is still running when the wait_for_completion_timeout\nexpires or if no wait_for_completion_timeout is specified.\nIf true and the search is still running, the search response\nwill include any hits and partial aggregations that are available.\nIf false and the search is still running, the search response will not include any hits (but possibly include\ntotal hits) nor will include any partial aggregations.\nWhen not specified, the intermediate results are returned for running queries.","x-found-in":"query"},"id":{"type":"string","description":"A unique identifier for the async search.","x-found-in":"path"}},"required":["id"],"description":"Get async search results.\n\nRetrieve the results of a previously submitted asynchronous search request.\nIf the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"async_search.get","description":"Get async search results.\n\nRetrieve the results of a previously submitted asynchronous search request.\nIf the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.","x-api":{"id":"async-search.get","name":"get","namespace":"async-search"},"x-method":"GET","x-path":"/_async_search/{id}","x-urls":[{"path":"/_async_search/{id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.7.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"keep_alive":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The length of time that the async search should be available in the cluster.\nWhen not specified, the `keep_alive` set with the corresponding submit async request will be used.\nOtherwise, it is possible to override the value and extend the validity of the request.\nWhen this period expires, the search, if still running, is cancelled.\nIf the search is completed, its saved results are deleted.","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"},"wait_for_completion_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies to wait for the search to be completed up until the provided timeout.\nFinal results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires.\nBy default no timeout is set meaning that the currently available results will be returned without any additional wait.","x-found-in":"query"},"return_intermediate_results":{"type":"boolean","description":"Specifies whether the response should contain intermediate results if the query is still running when the wait_for_completion_timeout\nexpires or if no wait_for_completion_timeout is specified.\nIf true and the search is still running, the search response\nwill include any hits and partial aggregations that are available.\nIf false and the search is still running, the search response will not include any hits (but possibly include\ntotal hits) nor will include any partial aggregations.\nWhen not specified, the intermediate results are returned for running queries.","x-found-in":"query"},"id":{"type":"string","description":"A unique identifier for the async search.","x-found-in":"path"}},"required":["id"]}

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

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

package/src/es/json/async_search.status.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"async_search.status","type":"object","properties":{"keep_alive":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The length of time that the async search needs to be available.\nOngoing async searches and any saved search results are deleted after this period.","x-found-in":"query"},"id":{"type":"string","description":"A unique identifier for the async search.","x-found-in":"path"}},"required":["id"],"description":"Get the async search status.\n\nGet the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to:\n\n* The user or API key that submitted the original async search request.\n* Users that have the `monitor` cluster privilege or greater privileges."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"async_search.status","description":"Get the async search status.\n\nGet the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to:\n\n* The user or API key that submitted the original async search request.\n* Users that have the `monitor` cluster privilege or greater privileges.","x-api":{"id":"async-search.status","name":"status","namespace":"async-search"},"x-method":"GET","x-path":"/_async_search/status/{id}","x-urls":[{"path":"/_async_search/status/{id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.11.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"keep_alive":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The length of time that the async search needs to be available.\nOngoing async searches and any saved search results are deleted after this period.","x-found-in":"query"},"id":{"type":"string","description":"A unique identifier for the async search.","x-found-in":"path"}},"required":["id"]}

package/src/es/json/async_search.status.response.json

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

package/src/es/json/async_search.submit.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"async_search.submit","type":"object","properties":{"wait_for_completion_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Blocks and waits until the search is completed up to a certain timeout.\nWhen the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster.","x-found-in":"query"},"keep_alive":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies how long the async search needs to be available.\nOngoing async searches and any saved search results are deleted after this period.","x-found-in":"query"},"keep_on_completion":{"type":"boolean","description":"If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`.","x-found-in":"query"},"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":"Indicate if an error should be returned if there is a partial search failure or timeout","x-found-in":"query"},"analyzer":{"type":"string","description":"The analyzer to use for the query string","x-found-in":"query"},"analyze_wildcard":{"type":"boolean","description":"Specify whether wildcard and prefix queries should be analyzed","x-found-in":"query"},"batched_reduce_size":{"type":"number","description":"Affects how often partial results become available, which happens whenever shard results are reduced.\nA partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default).","x-found-in":"query"},"ccs_minimize_roundtrips":{"type":"boolean","description":"The default value is the only supported value.","x-found-in":"query"},"default_operator":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__Operator","description":"The default operator for query string query (AND or OR)","x-found-in":"query"},"df":{"type":"string","description":"The field to use as default where no field prefix is given in the query string","x-found-in":"query"},"docvalue_fields":{"type":"array","items":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat"},"description":"Array of wildcard (*) patterns. The request returns doc values for field\nnames matching these patterns in the hits.fields property of the response.","x-found-in":"body"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Whether to expand wildcard expression to concrete indices that are open, closed or both","x-found-in":"query"},"explain":{"type":"boolean","description":"If true, returns detailed information about score computation as part of a hit.","x-found-in":"body"},"ignore_throttled":{"type":"boolean","description":"Whether specified concrete, expanded or aliased indices should be ignored 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"},"lenient":{"type":"boolean","description":"Specify whether format-based query failures (such as providing text to a numeric field) should be ignored","x-found-in":"query"},"max_concurrent_shard_requests":{"type":"number","description":"The number of concurrent shard requests per node this search executes concurrently.\nThis value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests","x-found-in":"query"},"preference":{"type":"string","description":"Specify the node or shard the operation should be performed on","x-found-in":"query"},"request_cache":{"type":"boolean","description":"Specify if request cache should be used for this request or not, defaults to true","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A comma-separated list of specific routing values","x-found-in":"query"},"search_type":{"$ref":"./_types.json#/$defs/_types__SearchType","description":"Search operation type","x-found-in":"query"},"stats":{"type":"array","items":{"type":"string"},"description":"Stats groups to associate with the search. Each group maintains a statistics\naggregation for its associated searches. You can retrieve these stats using\nthe indices stats API.","x-found-in":"body"},"stored_fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"List of stored fields to return as part of a hit. If no fields are specified,\nno stored fields are included in the response. If this field is specified, the _source\nparameter defaults to false. You can pass _source: true to return both source fields\nand stored fields in the search response.","x-found-in":"body"},"suggest_field":{"type":"string","description":"Specifies which field to use for suggestions.","x-found-in":"query"},"suggest_mode":{"$ref":"./_types.json#/$defs/_types__SuggestMode","description":"Specify suggest mode","x-found-in":"query"},"suggest_size":{"type":"number","description":"How many suggestions to return in response","x-found-in":"query"},"suggest_text":{"type":"string","description":"The source text for which the suggestions should be returned.","x-found-in":"query"},"terminate_after":{"type":"number","description":"Maximum number of documents to collect for each shard. If a query reaches this\nlimit, Elasticsearch terminates the query early. Elasticsearch collects documents\nbefore sorting. Defaults to 0, which does not terminate query execution early.","x-found-in":"body"},"timeout":{"type":"string","description":"Specifies the period of time to wait for a response from each shard. If no response\nis received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.","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. If true, the exact\nnumber of hits is returned at the cost of some performance. If false, the\nresponse does not include the total number of hits matching the query.\nDefaults to 10,000 hits.","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":"Specify whether aggregation and suggester names should 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, returns document version as part of a hit.","x-found-in":"body"},"_source":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SourceConfig","description":"Indicates which source fields are returned for matching documents. These\nfields are returned in the hits._source property of the search response.","x-found-in":"body"},"_source_excludes":{"$ref":"./_types.json#/$defs/_types__Fields","description":"A list of fields to exclude from the returned _source field","x-found-in":"query"},"_source_includes":{"$ref":"./_types.json#/$defs/_types__Fields","description":"A list of fields to extract and return from the _source field","x-found-in":"query"},"seq_no_primary_term":{"type":"boolean","description":"If true, returns sequence number and primary term of the last modification\nof each hit. See Optimistic concurrency control.","x-found-in":"body"},"q":{"type":"string","description":"Query in the Lucene query string syntax","x-found-in":"query"},"size":{"type":"number","description":"The number of hits to return. By default, you cannot page through more\nthan 10,000 hits using the from and size parameters. To page through more\nhits, use the search_after parameter.","x-found-in":"body"},"from":{"type":"number","description":"Starting document offset. By default, you cannot page through more than 10,000\nhits using the from and size parameters. To page through more hits, use the\nsearch_after parameter.","x-found-in":"body"},"sort":{"$ref":"./_types.json#/$defs/_types__Sort","x-found-in":"body"},"aggregations":{"type":"object","additionalProperties":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer"},"x-found-in":"body"},"collapse":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__FieldCollapse","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","x-found-in":"body"},"indices_boost":{"type":"array","items":{"type":"object","additionalProperties":{"type":"number"}},"description":"Boosts the _score of documents from specified indices.","x-found-in":"body"},"knn":{"anyOf":[{"$ref":"./_types.json#/$defs/_types__KnnSearch"},{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__KnnSearch"}}],"description":"Defines the approximate kNN search to run.","x-found-in":"body"},"min_score":{"type":"number","description":"Minimum _score for matching documents. Documents with a lower _score are\nnot 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","x-found-in":"body"},"profile":{"type":"boolean","x-found-in":"body"},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Defines 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"}}],"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","x-found-in":"body"},"slice":{"$ref":"./_types.json#/$defs/_types__SlicedScroll","x-found-in":"body"},"fields":{"type":"array","items":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat"},"description":"Array of wildcard (*) patterns. The request returns values for field names\nmatching 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","x-found-in":"body"},"pit":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__PointInTimeReference","description":"Limits the search to a point in time (PIT). If you provide a PIT, you\ncannot specify an <index> in the request path.","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"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices","x-found-in":"path"}},"description":"Run an async search.\n\nWhen the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.\n\nWarning: Asynchronous search does not support scroll or search requests that include only the suggest section.\n\nBy default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"async_search.submit","description":"Run an async search.\n\nWhen the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.\n\nWarning: Asynchronous search does not support scroll or search requests that include only the suggest section.\n\nBy default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.","x-api":{"id":"async-search.submit","name":"submit","namespace":"async-search"},"x-method":"POST","x-path":"/{index}/_async_search","x-urls":[{"path":"/_async_search","methods":["POST"]},{"path":"/{index}/_async_search","methods":["POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.7.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"wait_for_completion_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Blocks and waits until the search is completed up to a certain timeout.\nWhen the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster.","x-found-in":"query"},"keep_alive":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies how long the async search needs to be available.\nOngoing async searches and any saved search results are deleted after this period.","x-found-in":"query"},"keep_on_completion":{"type":"boolean","description":"If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`.","x-found-in":"query"},"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":"Indicate if an error should be returned if there is a partial search failure or timeout","x-found-in":"query"},"analyzer":{"type":"string","description":"The analyzer to use for the query string","x-found-in":"query"},"analyze_wildcard":{"type":"boolean","description":"Specify whether wildcard and prefix queries should be analyzed","x-found-in":"query"},"batched_reduce_size":{"type":"number","description":"Affects how often partial results become available, which happens whenever shard results are reduced.\nA partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default).","x-found-in":"query"},"ccs_minimize_roundtrips":{"type":"boolean","description":"The default value is the only supported value.","x-found-in":"query"},"default_operator":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__Operator","description":"The default operator for query string query (AND or OR)","x-found-in":"query"},"df":{"type":"string","description":"The field to use as default where no field prefix is given in the query string","x-found-in":"query"},"docvalue_fields":{"type":"array","items":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat"},"description":"Array of wildcard (*) patterns. The request returns doc values for field\nnames matching these patterns in the hits.fields property of the response.","x-found-in":"body"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Whether to expand wildcard expression to concrete indices that are open, closed or both","x-found-in":"query"},"explain":{"type":"boolean","description":"If true, returns detailed information about score computation as part of a hit.","x-found-in":"body"},"ignore_throttled":{"type":"boolean","description":"Whether specified concrete, expanded or aliased indices should be ignored 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"},"lenient":{"type":"boolean","description":"Specify whether format-based query failures (such as providing text to a numeric field) should be ignored","x-found-in":"query"},"max_concurrent_shard_requests":{"type":"number","description":"The number of concurrent shard requests per node this search executes concurrently.\nThis value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests","x-found-in":"query"},"preference":{"type":"string","description":"Specify the node or shard the operation should be performed on","x-found-in":"query"},"request_cache":{"type":"boolean","description":"Specify if request cache should be used for this request or not, defaults to true","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A comma-separated list of specific routing values","x-found-in":"query"},"search_type":{"$ref":"./_types.json#/$defs/_types__SearchType","description":"Search operation type","x-found-in":"query"},"stats":{"type":"array","items":{"type":"string"},"description":"Stats groups to associate with the search. Each group maintains a statistics\naggregation for its associated searches. You can retrieve these stats using\nthe indices stats API.","x-found-in":"body"},"stored_fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"List of stored fields to return as part of a hit. If no fields are specified,\nno stored fields are included in the response. If this field is specified, the _source\nparameter defaults to false. You can pass _source: true to return both source fields\nand stored fields in the search response.","x-found-in":"body"},"suggest_field":{"type":"string","description":"Specifies which field to use for suggestions.","x-found-in":"query"},"suggest_mode":{"$ref":"./_types.json#/$defs/_types__SuggestMode","description":"Specify suggest mode","x-found-in":"query"},"suggest_size":{"type":"number","description":"How many suggestions to return in response","x-found-in":"query"},"suggest_text":{"type":"string","description":"The source text for which the suggestions should be returned.","x-found-in":"query"},"terminate_after":{"type":"number","description":"Maximum number of documents to collect for each shard. If a query reaches this\nlimit, Elasticsearch terminates the query early. Elasticsearch collects documents\nbefore sorting. Defaults to 0, which does not terminate query execution early.","x-found-in":"body"},"timeout":{"type":"string","description":"Specifies the period of time to wait for a response from each shard. If no response\nis received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.","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. If true, the exact\nnumber of hits is returned at the cost of some performance. If false, the\nresponse does not include the total number of hits matching the query.\nDefaults to 10,000 hits.","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":"Specify whether aggregation and suggester names should 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, returns document version as part of a hit.","x-found-in":"body"},"_source":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SourceConfig","description":"Indicates which source fields are returned for matching documents. These\nfields are returned in the hits._source property of the search response.","x-found-in":"body"},"_source_excludes":{"$ref":"./_types.json#/$defs/_types__Fields","description":"A list of fields to exclude from the returned _source field","x-found-in":"query"},"_source_includes":{"$ref":"./_types.json#/$defs/_types__Fields","description":"A list of fields to extract and return from the _source field","x-found-in":"query"},"seq_no_primary_term":{"type":"boolean","description":"If true, returns sequence number and primary term of the last modification\nof each hit. See Optimistic concurrency control.","x-found-in":"body"},"q":{"type":"string","description":"Query in the Lucene query string syntax","x-found-in":"query"},"size":{"type":"number","description":"The number of hits to return. By default, you cannot page through more\nthan 10,000 hits using the from and size parameters. To page through more\nhits, use the search_after parameter.","x-found-in":"body"},"from":{"type":"number","description":"Starting document offset. By default, you cannot page through more than 10,000\nhits using the from and size parameters. To page through more hits, use the\nsearch_after parameter.","x-found-in":"body"},"sort":{"$ref":"./_types.json#/$defs/_types__Sort","x-found-in":"body"},"aggregations":{"type":"object","additionalProperties":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer"},"x-found-in":"body"},"collapse":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__FieldCollapse","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","x-found-in":"body"},"indices_boost":{"type":"array","items":{"type":"object","additionalProperties":{"type":"number"}},"description":"Boosts the _score of documents from specified indices.","x-found-in":"body"},"knn":{"anyOf":[{"$ref":"./_types.json#/$defs/_types__KnnSearch"},{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__KnnSearch"}}],"description":"Defines the approximate kNN search to run.","x-found-in":"body","x-availability":{"stack":{"since":"8.4.0"},"serverless":{}}},"min_score":{"type":"number","description":"Minimum _score for matching documents. Documents with a lower _score are\nnot 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","x-found-in":"body"},"profile":{"type":"boolean","x-found-in":"body"},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Defines 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"}}],"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","x-found-in":"body"},"slice":{"$ref":"./_types.json#/$defs/_types__SlicedScroll","x-found-in":"body"},"fields":{"type":"array","items":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat"},"description":"Array of wildcard (*) patterns. The request returns values for field names\nmatching 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","x-found-in":"body"},"pit":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__PointInTimeReference","description":"Limits the search to a point in time (PIT). If you provide a PIT, you\ncannot specify an <index> in the request path.","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"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices","x-found-in":"path"}}}

package/src/es/json/async_search.submit.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"async_search.submit","$ref":"./async_search._types.json#/$defs/async_search._types__AsyncSearchDocumentResponseBase"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"async_search.submit","x-api":{"id":"async-search.submit","name":"submit","namespace":"async-search"},"$ref":"./async_search._types.json#/$defs/async_search._types__AsyncSearchDocumentResponseBase"}

package/src/es/json/bulk.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"bulk","type":"object","properties":{"include_source_on_error":{"type":"boolean","description":"True or false if to include the document source in the error message in case of parsing errors.","x-found-in":"query"},"list_executed_pipelines":{"type":"boolean","description":"If `true`, the response will include the ingest pipelines that were run for each index or create.","x-found-in":"query"},"pipeline":{"type":"string","description":"The pipeline identifier to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request.\nIf a final pipeline is configured, it will always run regardless of the value of this parameter.","x-found-in":"query"},"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf `wait_for`, wait for a refresh to make this operation visible to search.\nIf `false`, do nothing with refreshes.\nValid values: `true`, `false`, `wait_for`.","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"},"_source":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam","description":"Indicates whether to return the `_source` field (`true` or `false`) or contains a list of fields to return.","x-found-in":"query"},"_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_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"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period each action waits for the following operations: automatic index creation, dynamic mapping updates, and waiting for active shards.\nThe default is `1m` (one minute), which guarantees Elasticsearch waits for at least the timeout before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.","x-found-in":"query"},"wait_for_active_shards":{"$ref":"./_types.json#/$defs/_types__WaitForActiveShards","description":"The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe default is `1`, which waits for each primary shard to be active.","x-found-in":"query"},"require_alias":{"type":"boolean","description":"If `true`, the request's actions must target an index alias.","x-found-in":"query"},"require_data_stream":{"type":"boolean","description":"If `true`, the request's actions must target a data stream (existing or to be created).","x-found-in":"query"},"operations":{"type":"array","items":{"anyOf":[{"$ref":"./_global.bulk.json#/$defs/_global.bulk__OperationContainer"},{"$ref":"./_global.bulk.json#/$defs/_global.bulk__UpdateAction"},{}]},"x-found-in":"body"},"index":{"type":"string","description":"The name of the data stream, index, or index alias to perform bulk actions on.","x-found-in":"path"}},"description":"Bulk index or delete documents.\n\nPerform multiple `index`, `create`, `delete`, and `update` actions in a single request.\nThis reduces overhead and can greatly increase indexing speed.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To use the `create` action, you must have the `create_doc`, `create`, `index`, or `write` index privilege. Data streams support only the `create` action.\n* To use the `index` action, you must have the `create`, `index`, or `write` index privilege.\n* To use the `delete` action, you must have the `delete` or `write` index privilege.\n* To use the `update` action, you must have the `index` or `write` index privilege.\n* To automatically create a data stream or index with a bulk API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n* To make the result of a bulk operation visible to search using the `refresh` parameter, you must have the `maintenance` or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nThe actions are specified in the request body using a newline delimited JSON (NDJSON) structure:\n\n```\naction_and_meta_data\\n\noptional_source\\n\naction_and_meta_data\\n\noptional_source\\n\n....\naction_and_meta_data\\n\noptional_source\\n\n```\n\nThe `index` and `create` actions expect a source on the next line and have the same semantics as the `op_type` parameter in the standard index API.\nA `create` action fails if a document with the same ID already exists in the target\nAn `index` action adds or replaces a document as necessary.\n\nNOTE: Data streams support only the `create` action.\nTo update or delete a document in a data stream, you must target the backing index containing the document.\n\nAn `update` action expects that the partial doc, upsert, and script and its options are specified on the next line.\n\nA `delete` action does not expect a source on the next line and has the same semantics as the standard delete API.\n\nNOTE: The final line of data must end with a newline character (`\\n`).\nEach newline character may be preceded by a carriage return (`\\r`).\nWhen sending NDJSON data to the `_bulk` endpoint, use a `Content-Type` header of `application/json` or `application/x-ndjson`.\nBecause this format uses literal newline characters (`\\n`) as delimiters, make sure that the JSON actions and sources are not pretty printed.\n\nIf you provide a target in the request path, it is used for any actions that don't explicitly specify an `_index` argument.\n\nA note on the format: the idea here is to make processing as fast as possible.\nAs some of the actions are redirected to other shards on other nodes, only `action_meta_data` is parsed on the receiving node side.\n\nClient libraries using this protocol should try and strive to do something similar on the client side, and reduce buffering as much as possible.\n\nThere is no \"correct\" number of actions to perform in a single bulk request.\nExperiment with different settings to find the optimal size for your particular workload.\nNote that Elasticsearch limits the maximum size of a HTTP request to 100mb by default so clients must ensure that no request exceeds this size.\nIt is not possible to index a single document that exceeds the size limit, so you must pre-process any such documents into smaller pieces before sending them to Elasticsearch.\nFor instance, split documents into pages or chapters before indexing them, or store raw binary data in a system outside Elasticsearch and replace the raw data with a link to the external system in the documents that you send to Elasticsearch.\n\n**Client suppport for bulk requests**\n\nSome of the officially supported clients provide helpers to assist with bulk requests and reindexing:\n\n* Go: Check out `esutil.BulkIndexer`\n* Perl: Check out `Search::Elasticsearch::Client::5_0::Bulk` and `Search::Elasticsearch::Client::5_0::Scroll`\n* Python: Check out `elasticsearch.helpers.*`\n* JavaScript: Check out `client.helpers.*`\n* Java: Check out `co.elastic.clients.elasticsearch._helpers.bulk.BulkIngester`\n* .NET: Check out `BulkAllObservable`\n* PHP: Check out bulk indexing.\n* Ruby: Check out `Elasticsearch::Helpers::BulkHelper`\n\n**Submitting bulk requests with cURL**\n\nIf you're providing text file input to `curl`, you must use the `--data-binary` flag instead of plain `-d`.\nThe latter doesn't preserve newlines. For example:\n\n```\n$ cat requests\n{ \"index\" : { \"_index\" : \"test\", \"_id\" : \"1\" } }\n{ \"field1\" : \"value1\" }\n$ curl -s -H \"Content-Type: application/x-ndjson\" -XPOST localhost:9200/_bulk --data-binary \"@requests\"; echo\n{\"took\":7, \"errors\": false, \"items\":[{\"index\":{\"_index\":\"test\",\"_id\":\"1\",\"_version\":1,\"result\":\"created\",\"forced_refresh\":false}}]}\n```\n\n**Optimistic concurrency control**\n\nEach `index` and `delete` action within a bulk API call may include the `if_seq_no` and `if_primary_term` parameters in their respective action and meta data lines.\nThe `if_seq_no` and `if_primary_term` parameters control how operations are run, based on the last modification to existing documents. See Optimistic concurrency control for more details.\n\n**Versioning**\n\nEach bulk item can include the version value using the `version` field.\nIt automatically follows the behavior of the index or delete operation based on the `_version` mapping.\nIt also support the `version_type`.\n\n**Routing**\n\nEach bulk item can include the routing value using the `routing` field.\nIt automatically follows the behavior of the index or delete operation based on the `_routing` mapping.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Refresh**\n\nControl when the changes made by this request are visible to search.\n\nNOTE: Only the shards that receive the bulk request will be affected by refresh.\nImagine a `_bulk?refresh=wait_for` request with three documents in it that happen to be routed to different shards in an index with five shards.\nThe request will only wait for those three shards to refresh.\nThe other two shards that make up the index do not participate in the `_bulk` request at all.\n\nYou might want to disable the refresh interval temporarily to improve indexing throughput for large bulk requests.\nRefer to the linked documentation for step-by-step instructions using the index settings API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"bulk","description":"Bulk index or delete documents.\n\nPerform multiple `index`, `create`, `delete`, and `update` actions in a single request.\nThis reduces overhead and can greatly increase indexing speed.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To use the `create` action, you must have the `create_doc`, `create`, `index`, or `write` index privilege. Data streams support only the `create` action.\n* To use the `index` action, you must have the `create`, `index`, or `write` index privilege.\n* To use the `delete` action, you must have the `delete` or `write` index privilege.\n* To use the `update` action, you must have the `index` or `write` index privilege.\n* To automatically create a data stream or index with a bulk API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n* To make the result of a bulk operation visible to search using the `refresh` parameter, you must have the `maintenance` or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nThe actions are specified in the request body using a newline delimited JSON (NDJSON) structure:\n\n```\naction_and_meta_data\\n\noptional_source\\n\naction_and_meta_data\\n\noptional_source\\n\n....\naction_and_meta_data\\n\noptional_source\\n\n```\n\nThe `index` and `create` actions expect a source on the next line and have the same semantics as the `op_type` parameter in the standard index API.\nA `create` action fails if a document with the same ID already exists in the target\nAn `index` action adds or replaces a document as necessary.\n\nNOTE: Data streams support only the `create` action.\nTo update or delete a document in a data stream, you must target the backing index containing the document.\n\nAn `update` action expects that the partial doc, upsert, and script and its options are specified on the next line.\n\nA `delete` action does not expect a source on the next line and has the same semantics as the standard delete API.\n\nNOTE: The final line of data must end with a newline character (`\\n`).\nEach newline character may be preceded by a carriage return (`\\r`).\nWhen sending NDJSON data to the `_bulk` endpoint, use a `Content-Type` header of `application/json` or `application/x-ndjson`.\nBecause this format uses literal newline characters (`\\n`) as delimiters, make sure that the JSON actions and sources are not pretty printed.\n\nIf you provide a target in the request path, it is used for any actions that don't explicitly specify an `_index` argument.\n\nA note on the format: the idea here is to make processing as fast as possible.\nAs some of the actions are redirected to other shards on other nodes, only `action_meta_data` is parsed on the receiving node side.\n\nClient libraries using this protocol should try and strive to do something similar on the client side, and reduce buffering as much as possible.\n\nThere is no \"correct\" number of actions to perform in a single bulk request.\nExperiment with different settings to find the optimal size for your particular workload.\nNote that Elasticsearch limits the maximum size of a HTTP request to 100mb by default so clients must ensure that no request exceeds this size.\nIt is not possible to index a single document that exceeds the size limit, so you must pre-process any such documents into smaller pieces before sending them to Elasticsearch.\nFor instance, split documents into pages or chapters before indexing them, or store raw binary data in a system outside Elasticsearch and replace the raw data with a link to the external system in the documents that you send to Elasticsearch.\n\n**Client suppport for bulk requests**\n\nSome of the officially supported clients provide helpers to assist with bulk requests and reindexing:\n\n* Go: Check out `esutil.BulkIndexer`\n* Perl: Check out `Search::Elasticsearch::Client::5_0::Bulk` and `Search::Elasticsearch::Client::5_0::Scroll`\n* Python: Check out `elasticsearch.helpers.*`\n* JavaScript: Check out `client.helpers.*`\n* Java: Check out `co.elastic.clients.elasticsearch._helpers.bulk.BulkIngester`\n* .NET: Check out `BulkAllObservable`\n* PHP: Check out bulk indexing.\n* Ruby: Check out `Elasticsearch::Helpers::BulkHelper`\n\n**Submitting bulk requests with cURL**\n\nIf you're providing text file input to `curl`, you must use the `--data-binary` flag instead of plain `-d`.\nThe latter doesn't preserve newlines. For example:\n\n```\n$ cat requests\n{ \"index\" : { \"_index\" : \"test\", \"_id\" : \"1\" } }\n{ \"field1\" : \"value1\" }\n$ curl -s -H \"Content-Type: application/x-ndjson\" -XPOST localhost:9200/_bulk --data-binary \"@requests\"; echo\n{\"took\":7, \"errors\": false, \"items\":[{\"index\":{\"_index\":\"test\",\"_id\":\"1\",\"_version\":1,\"result\":\"created\",\"forced_refresh\":false}}]}\n```\n\n**Optimistic concurrency control**\n\nEach `index` and `delete` action within a bulk API call may include the `if_seq_no` and `if_primary_term` parameters in their respective action and meta data lines.\nThe `if_seq_no` and `if_primary_term` parameters control how operations are run, based on the last modification to existing documents. See Optimistic concurrency control for more details.\n\n**Versioning**\n\nEach bulk item can include the version value using the `version` field.\nIt automatically follows the behavior of the index or delete operation based on the `_version` mapping.\nIt also support the `version_type`.\n\n**Routing**\n\nEach bulk item can include the routing value using the `routing` field.\nIt automatically follows the behavior of the index or delete operation based on the `_routing` mapping.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Refresh**\n\nControl when the changes made by this request are visible to search.\n\nNOTE: Only the shards that receive the bulk request will be affected by refresh.\nImagine a `_bulk?refresh=wait_for` request with three documents in it that happen to be routed to different shards in an index with five shards.\nThe request will only wait for those three shards to refresh.\nThe other two shards that make up the index do not participate in the `_bulk` request at all.\n\nYou might want to disable the refresh interval temporarily to improve indexing throughput for large bulk requests.\nRefer to the linked documentation for step-by-step instructions using the index settings API.","x-api":{"id":"bulk","name":"bulk","namespace":null},"x-method":"POST","x-path":"/{index}/_bulk","x-urls":[{"path":"/_bulk","methods":["POST","PUT"]},{"path":"/{index}/_bulk","methods":["POST","PUT"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"x-body-format":"ndjson","type":"object","properties":{"include_source_on_error":{"type":"boolean","description":"True or false if to include the document source in the error message in case of parsing errors.","x-found-in":"query"},"list_executed_pipelines":{"type":"boolean","description":"If `true`, the response will include the ingest pipelines that were run for each index or create.","x-found-in":"query"},"pipeline":{"type":"string","description":"The pipeline identifier to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request.\nIf a final pipeline is configured, it will always run regardless of the value of this parameter.","x-found-in":"query"},"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf `wait_for`, wait for a refresh to make this operation visible to search.\nIf `false`, do nothing with refreshes.\nValid values: `true`, `false`, `wait_for`.","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"},"_source":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam","description":"Indicates whether to return the `_source` field (`true` or `false`) or contains a list of fields to return.","x-found-in":"query"},"_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_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"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period each action waits for the following operations: automatic index creation, dynamic mapping updates, and waiting for active shards.\nThe default is `1m` (one minute), which guarantees Elasticsearch waits for at least the timeout before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.","x-found-in":"query"},"wait_for_active_shards":{"$ref":"./_types.json#/$defs/_types__WaitForActiveShards","description":"The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe default is `1`, which waits for each primary shard to be active.","x-found-in":"query","x-availability":{"stack":{}}},"require_alias":{"type":"boolean","description":"If `true`, the request's actions must target an index alias.","x-found-in":"query"},"require_data_stream":{"type":"boolean","description":"If `true`, the request's actions must target a data stream (existing or to be created).","x-found-in":"query"},"operations":{"type":"array","items":{"anyOf":[{"$ref":"./_global.bulk.json#/$defs/_global.bulk__OperationContainer"},{"$ref":"./_global.bulk.json#/$defs/_global.bulk__UpdateAction"},{}]},"x-found-in":"body","x-body-root":true},"index":{"type":"string","description":"The name of the data stream, index, or index alias to perform bulk actions on.","x-found-in":"path"}}}

package/src/es/json/bulk.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"bulk","type":"object","properties":{"errors":{"type":"boolean","description":"If `true`, one or more of the operations in the bulk request did not complete successfully."},"items":{"type":"array","items":{"type":"object","additionalProperties":{"$ref":"./_global.bulk.json#/$defs/_global.bulk__ResponseItem"}},"description":"The result of each operation in the bulk request, in the order they were submitted."},"took":{"type":"number","description":"The length of time, in milliseconds, it took to process the bulk request."},"ingest_took":{"type":"number"}},"required":["errors","items","took"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"bulk","x-api":{"id":"bulk","name":"bulk","namespace":null},"type":"object","properties":{"errors":{"type":"boolean","description":"If `true`, one or more of the operations in the bulk request did not complete successfully."},"items":{"type":"array","items":{"type":"object","additionalProperties":{"$ref":"./_global.bulk.json#/$defs/_global.bulk__ResponseItem"}},"description":"The result of each operation in the bulk request, in the order they were submitted."},"took":{"type":"number","description":"The length of time, in milliseconds, it took to process the bulk request."},"ingest_took":{"type":"number"}},"required":["errors","items","took"]}

package/src/es/json/cancel_reindex.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cancel_reindex","type":"object","properties":{"wait_for_completion":{"type":"boolean","description":"If `true` (the default), the request blocks until the cancellation is complete and returns the final task state.\nIf `false`, the request returns immediately with `acknowledged: true`.","x-found-in":"query"},"task_id":{"type":"string","description":"The ID of the reindex task to cancel.","x-found-in":"path"}},"required":["task_id"],"description":"Cancel an ongoing reindex task.\n\nIf `wait_for_completion` is `true` (the default), the response contains the final task state after cancellation.\nIf `wait_for_completion` is `false`, the response contains only `acknowledged: true`.\n\nThis API follows reindex tasks across node-shutdown relocations, so callers can\nkeep using the original task ID throughout the lifetime of the operation.\nReturned task IDs and timings reflect the original task, not its relocated successor.\nRelocated task IDs are also supported. They are followed transparently and return the task ID and timings of the original task.\n\nWhen the task ID cannot be cancelled (unknown ID, non-reindex task, sliced child, finished task, or node left with no stored result), the API returns the following response with a 404 status code:\n```\n{\n  \"error\": {\n    \"type\": \"resource_not_found_exception\",\n    \"reason\": \"reindex task [r1A2WoRbTwKZ516z6NEs5A:36619] either not found or completed\"\n  },\n  \"status\": 404\n}\n```\n\nDuring a brief handoff window of a node-shutdown relocation, you may receive the response below with a 503 status code.\nRetry with the same task ID; the retry follows the relocated task transparently.\n```\n{\n  \"error\": {\n    \"type\": \"status_exception\",\n    \"reason\": \"cannot cancel task [36619] because it is being relocated\"\n  },\n  \"status\": 503\n}\n```"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cancel_reindex","description":"Cancel an ongoing reindex task.\n\nIf `wait_for_completion` is `true` (the default), the response contains the final task state after cancellation.\nIf `wait_for_completion` is `false`, the response contains only `acknowledged: true`.\n\nThis API follows reindex tasks across node-shutdown relocations, so callers can\nkeep using the original task ID throughout the lifetime of the operation.\nReturned task IDs and timings reflect the original task, not its relocated successor.\nRelocated task IDs are also supported. They are followed transparently and return the task ID and timings of the original task.\n\nWhen the task ID cannot be cancelled (unknown ID, non-reindex task, sliced child, finished task, or node left with no stored result), the API returns the following response with a 404 status code:\n```\n{\n  \"error\": {\n    \"type\": \"resource_not_found_exception\",\n    \"reason\": \"reindex task [r1A2WoRbTwKZ516z6NEs5A:36619] either not found or completed\"\n  },\n  \"status\": 404\n}\n```\n\nDuring a brief handoff window of a node-shutdown relocation, you may receive the response below with a 503 status code.\nRetry with the same task ID; the retry follows the relocated task transparently.\n```\n{\n  \"error\": {\n    \"type\": \"status_exception\",\n    \"reason\": \"cannot cancel task [36619] because it is being relocated\"\n  },\n  \"status\": 503\n}\n```","x-api":{"id":"cancel_reindex","name":"cancel-reindex","namespace":null},"x-method":"POST","x-path":"/_reindex/{task_id}/_cancel","x-urls":[{"path":"/_reindex/{task_id}/_cancel","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"9.5.0","stability":"stable","visibility":"public"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"wait_for_completion":{"type":"boolean","description":"If `true` (the default), the request blocks until the cancellation is complete and returns the final task state.\nIf `false`, the request returns immediately with `acknowledged: true`.","x-found-in":"query"},"task_id":{"type":"string","description":"The ID of the reindex task to cancel.","x-found-in":"path"}},"required":["task_id"]}

package/src/es/json/cancel_reindex.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cancel_reindex","type":"object","properties":{"acknowledged":{"type":"boolean","description":"Present and `true` when `wait_for_completion=false`."},"completed":{"type":"boolean","description":"Whether the reindex task has completed. Present when `wait_for_completion=true`."},"id":{"type":"string","description":"The ID of the reindex task. The value is the ID assigned when the task was first created and remains stable across node-shutdown relocations. Present when `wait_for_completion=true`."},"description":{"type":"string","description":"A sanitized description of the reindex operation."},"start_time_in_millis":{"description":"The time at which the reindex task started, in milliseconds since the Unix epoch."},"start_time":{"type":"string","description":"The time at which the reindex task started, as an ISO 8601 formatted string."},"running_time":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The elapsed running time of the reindex task, in a human-readable format.\nOnly present when the request includes the `?human=true` query parameter."},"running_time_in_nanos":{"description":"The elapsed running time of the reindex task, in nanoseconds."},"cancelled":{"type":"boolean","description":"Whether the reindex task has been cancelled."},"status":{"$ref":"./_types.json#/$defs/_types__ReindexStatus","description":"The status of the reindex operation at the time of cancellation."},"error":{"$ref":"./_types.json#/$defs/_types__ErrorCause","description":"The error that caused the reindex task to fail, if any."},"response":{"$ref":"./_types.json#/$defs/_types__ReindexTaskResult","description":"The final result of the reindex operation, if it completed before being cancelled."}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cancel_reindex","x-api":{"id":"cancel_reindex","name":"cancel-reindex","namespace":null},"type":"object","properties":{"acknowledged":{"type":"boolean","description":"Present and `true` when `wait_for_completion=false`."},"completed":{"type":"boolean","description":"Whether the reindex task has completed. Present when `wait_for_completion=true`."},"id":{"type":"string","description":"The ID of the reindex task. The value is the ID assigned when the task was first created and remains stable across node-shutdown relocations. Present when `wait_for_completion=true`."},"description":{"type":"string","description":"A sanitized description of the reindex operation."},"start_time_in_millis":{"description":"The time at which the reindex task started, in milliseconds since the Unix epoch."},"start_time":{"type":"string","description":"The time at which the reindex task started, as an ISO 8601 formatted string."},"running_time":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The elapsed running time of the reindex task, in a human-readable format.\nOnly present when the request includes the `?human=true` query parameter."},"running_time_in_nanos":{"description":"The elapsed running time of the reindex task, in nanoseconds."},"cancelled":{"type":"boolean","description":"Whether the reindex task has been cancelled."},"status":{"$ref":"./_types.json#/$defs/_types__ReindexStatus","description":"The status of the reindex operation at the time of cancellation."},"error":{"$ref":"./_types.json#/$defs/_types__ErrorCause","description":"The error that caused the reindex task to fail, if any."},"response":{"$ref":"./_types.json#/$defs/_types__ReindexTaskResult","description":"The final result of the reindex operation, if it completed before being cancelled."}}}

package/src/es/json/cat.aliases.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.aliases","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatAliasesColumns","description":"A comma-separated list of columns names to display. It supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","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.\nIt supports comma-separated values, such as `open,hidden`.","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.\nTo indicated that the request should never timeout, you can set it to `-1`.","x-found-in":"query"},"name":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of aliases to retrieve. Supports wildcards (`*`).  To retrieve all aliases, omit this parameter or use `*` or `_all`.","x-found-in":"path"}},"description":"Get aliases.\n\nGet the cluster's index aliases, including filter and routing information.\nThis API does not return data stream aliases.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.aliases","description":"Get aliases.\n\nGet the cluster's index aliases, including filter and routing information.\nThis API does not return data stream aliases.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.","x-api":{"id":"cat.aliases","name":"aliases","namespace":"cat"},"x-method":"GET","x-path":"/_cat/aliases/{name}","x-urls":[{"path":"/_cat/aliases","methods":["GET"]},{"path":"/_cat/aliases/{name}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"x-response-type":"text","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatAliasesColumns","description":"A comma-separated list of columns names to display. It supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","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.\nIt supports comma-separated values, such as `open,hidden`.","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.\nTo indicated that the request should never timeout, you can set it to `-1`.","x-found-in":"query"},"name":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of aliases to retrieve. Supports wildcards (`*`).  To retrieve all aliases, omit this parameter or use `*` or `_all`.","x-found-in":"path"}}}

package/src/es/json/cat.aliases.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.aliases","type":"array","items":{"$ref":"./cat.aliases.json#/$defs/cat.aliases__AliasesRecord"}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.aliases","x-api":{"id":"cat.aliases","name":"aliases","namespace":"cat"},"type":"array","items":{"$ref":"./cat.aliases.json#/$defs/cat.aliases__AliasesRecord"}}

package/src/es/json/cat.allocation.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.allocation","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatAllocationColumns","description":"A comma-separated list of columns names to display. It supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"},"local":{"type":"boolean","description":"If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"node_id":{"$ref":"./_types.json#/$defs/_types__NodeIds","description":"A comma-separated list of node identifiers or names used to limit the returned information.","x-found-in":"path"}},"description":"Get shard allocation information.\n\nGet a snapshot of the number of shards allocated to each data node and their disk space.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.allocation","description":"Get shard allocation information.\n\nGet a snapshot of the number of shards allocated to each data node and their disk space.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.","x-api":{"id":"cat.allocation","name":"allocation","namespace":"cat"},"x-method":"GET","x-path":"/_cat/allocation/{node_id}","x-urls":[{"path":"/_cat/allocation","methods":["GET"]},{"path":"/_cat/allocation/{node_id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatAllocationColumns","description":"A comma-separated list of columns names to display. It supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"},"local":{"type":"boolean","description":"If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"node_id":{"$ref":"./_types.json#/$defs/_types__NodeIds","description":"A comma-separated list of node identifiers or names used to limit the returned information.","x-found-in":"path"}}}

package/src/es/json/cat.allocation.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.allocation","type":"array","items":{"$ref":"./cat.allocation.json#/$defs/cat.allocation__AllocationRecord"}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.allocation","x-api":{"id":"cat.allocation","name":"allocation","namespace":"cat"},"type":"array","items":{"$ref":"./cat.allocation.json#/$defs/cat.allocation__AllocationRecord"}}

package/src/es/json/cat.circuit_breaker.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.circuit_breaker","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatCircuitBreakerColumns","description":"A comma-separated list of columns names to display. It supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"},"local":{"type":"boolean","description":"If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"circuit_breaker_patterns":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A comma-separated list of regular-expressions to filter the circuit breakers in the output","x-found-in":"path"}},"description":"Get circuit breakers statistics.\n\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.circuit_breaker","description":"Get circuit breakers statistics.\n\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.","x-api":{"id":"cat.circuit_breaker","name":"circuit-breaker","namespace":"cat"},"x-method":"GET","x-path":"/_cat/circuit_breaker/{circuit_breaker_patterns}","x-urls":[{"path":"/_cat/circuit_breaker","methods":["GET"]},{"path":"/_cat/circuit_breaker/{circuit_breaker_patterns}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatCircuitBreakerColumns","description":"A comma-separated list of columns names to display. It supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"},"local":{"type":"boolean","description":"If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"circuit_breaker_patterns":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A comma-separated list of regular-expressions to filter the circuit breakers in the output","x-found-in":"path"}}}

package/src/es/json/cat.circuit_breaker.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.circuit_breaker","type":"array","items":{"$ref":"./cat.circuit_breaker.json#/$defs/cat.circuit_breaker__CircuitBreakerRecord"}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.circuit_breaker","x-api":{"id":"cat.circuit_breaker","name":"circuit-breaker","namespace":"cat"},"type":"array","items":{"$ref":"./cat.circuit_breaker.json#/$defs/cat.circuit_breaker__CircuitBreakerRecord"}}

package/src/es/json/cat.component_templates.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.component_templates","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatComponentColumns","description":"A comma-separated list of columns names to display. It supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"},"local":{"type":"boolean","description":"If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.","x-found-in":"query"},"name":{"type":"string","description":"The name of the component template.\nIt accepts wildcard expressions.\nIf it is omitted, all component templates are returned.","x-found-in":"path"}},"description":"Get component templates.\n\nGet information about component templates in a cluster.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get component template API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.component_templates","description":"Get component templates.\n\nGet information about component templates in a cluster.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get component template API.","x-api":{"id":"cat.component_templates","name":"component-templates","namespace":"cat"},"x-method":"GET","x-path":"/_cat/component_templates/{name}","x-urls":[{"path":"/_cat/component_templates","methods":["GET"]},{"path":"/_cat/component_templates/{name}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"5.1.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"x-response-type":"text","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatComponentColumns","description":"A comma-separated list of columns names to display. It supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"},"local":{"type":"boolean","description":"If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.","x-found-in":"query"},"name":{"type":"string","description":"The name of the component template.\nIt accepts wildcard expressions.\nIf it is omitted, all component templates are returned.","x-found-in":"path"}}}

package/src/es/json/cat.component_templates.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.component_templates","type":"array","items":{"$ref":"./cat.component_templates.json#/$defs/cat.component_templates__ComponentTemplate"}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.component_templates","x-api":{"id":"cat.component_templates","name":"component-templates","namespace":"cat"},"type":"array","items":{"$ref":"./cat.component_templates.json#/$defs/cat.component_templates__ComponentTemplate"}}

package/src/es/json/cat.count.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.count","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatCountColumns","description":"A comma-separated list of columns names to display. It supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases used to limit the request.\nIt supports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.","x-found-in":"path"}},"description":"Get a document count.\n\nGet quick access to a document count for a data stream, an index, or an entire cluster.\nThe document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the count API.\n\nNOTE: Starting in Elasticsearch 9.3.0, this endpoint also supports the `POST` method. This is primarily intended for project routing in serverless environments."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.count","description":"Get a document count.\n\nGet quick access to a document count for a data stream, an index, or an entire cluster.\nThe document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the count API.\n\nNOTE: Starting in Elasticsearch 9.3.0, this endpoint also supports the `POST` method. This is primarily intended for project routing in serverless environments.","x-api":{"id":"cat.count","name":"count","namespace":"cat"},"x-method":"POST","x-path":"/_cat/count/{index}","x-urls":[{"path":"/_cat/count","methods":["POST","GET"]},{"path":"/_cat/count/{index}","methods":["POST","GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"x-response-type":"text","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatCountColumns","description":"A comma-separated list of columns names to display. It supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases used to limit the request.\nIt supports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.","x-found-in":"path"}}}

package/src/es/json/cat.count.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.count","type":"array","items":{"$ref":"./cat.count.json#/$defs/cat.count__CountRecord"}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.count","x-api":{"id":"cat.count","name":"count","namespace":"cat"},"type":"array","items":{"$ref":"./cat.count.json#/$defs/cat.count__CountRecord"}}

package/src/es/json/cat.fielddata.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.fielddata","type":"object","properties":{"fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"Comma-separated list of fields used to limit returned information.\nTo retrieve all fields, omit this parameter.","x-found-in":"path"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatFieldDataColumns","description":"A comma-separated list of columns names to display. It supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"}},"description":"Get field data cache information.\n\nGet the amount of heap memory currently used by the field data cache on every data node in the cluster.\n\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the nodes stats API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.fielddata","description":"Get field data cache information.\n\nGet the amount of heap memory currently used by the field data cache on every data node in the cluster.\n\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the nodes stats API.","x-api":{"id":"cat.fielddata","name":"fielddata","namespace":"cat"},"x-method":"GET","x-path":"/_cat/fielddata/{fields}","x-urls":[{"path":"/_cat/fielddata","methods":["GET"]},{"path":"/_cat/fielddata/{fields}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","type":"object","properties":{"fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"Comma-separated list of fields used to limit returned information.\nTo retrieve all fields, omit this parameter.","x-found-in":"path"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatFieldDataColumns","description":"A comma-separated list of columns names to display. It supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"}}}

package/src/es/json/cat.fielddata.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.fielddata","type":"array","items":{"$ref":"./cat.fielddata.json#/$defs/cat.fielddata__FielddataRecord"}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.fielddata","x-api":{"id":"cat.fielddata","name":"fielddata","namespace":"cat"},"type":"array","items":{"$ref":"./cat.fielddata.json#/$defs/cat.fielddata__FielddataRecord"}}

package/src/es/json/cat.health.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.health","type":"object","properties":{"ts":{"type":"boolean","description":"If true, returns `HH:MM:SS` and Unix epoch timestamps.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatHealthColumns","description":"A comma-separated list of columns names to display. It supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"}},"description":"Get the cluster health status.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the cluster health API.\nThis API is often used to check malfunctioning clusters.\nTo help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats:\n`HH:MM:SS`, which is human-readable but includes no date information;\n`Unix epoch time`, which is machine-sortable and includes date information.\nThe latter format is useful for cluster recoveries that take multiple days.\nYou can use the cat health API to verify cluster health across multiple nodes.\nYou also can use the API to track the recovery of a large cluster over a longer period of time."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.health","description":"Get the cluster health status.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the cluster health API.\nThis API is often used to check malfunctioning clusters.\nTo help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats:\n`HH:MM:SS`, which is human-readable but includes no date information;\n`Unix epoch time`, which is machine-sortable and includes date information.\nThe latter format is useful for cluster recoveries that take multiple days.\nYou can use the cat health API to verify cluster health across multiple nodes.\nYou also can use the API to track the recovery of a large cluster over a longer period of time.","x-api":{"id":"cat.health","name":"health","namespace":"cat"},"x-method":"GET","x-path":"/_cat/health","x-urls":[{"path":"/_cat/health","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","type":"object","properties":{"ts":{"type":"boolean","description":"If true, returns `HH:MM:SS` and Unix epoch timestamps.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatHealthColumns","description":"A comma-separated list of columns names to display. It supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"}}}

package/src/es/json/cat.health.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.health","type":"array","items":{"$ref":"./cat.health.json#/$defs/cat.health__HealthRecord"}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.health","x-api":{"id":"cat.health","name":"health","namespace":"cat"},"type":"array","items":{"$ref":"./cat.health.json#/$defs/cat.health__HealthRecord"}}

package/src/es/json/cat.help.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.help","type":"object","properties":{},"description":"Get CAT help.\n\nGet help for the CAT APIs."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.help","description":"Get CAT help.\n\nGet help for the CAT APIs.","x-api":{"id":"cat.help","name":"help","namespace":"cat"},"x-method":"GET","x-path":"/_cat","x-urls":[{"path":"/_cat","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"x-response-type":"text","type":"object","properties":{}}

package/src/es/json/cat.help.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.help","type":"object","properties":{}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.help","x-api":{"id":"cat.help","name":"help","namespace":"cat"},"type":"object","properties":{}}

package/src/es/json/cat.indices.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"cat.indices__IndicesRecord":{"type":"object","properties":{"health":{"type":"string","description":"current health status"},"status":{"type":"string","description":"open/close status"},"index":{"type":"string","description":"index name"},"uuid":{"type":"string","description":"index uuid"},"pri":{"type":"string","description":"number of primary shards"},"rep":{"type":"string","description":"number of replica shards"},"docs.count":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number of documents in the index, including hidden nested documents.\nFor indices with `semantic_text` fields or other nested field types,\nthis count includes the internal nested documents.\nTo get the logical document count (excluding nested documents), use\nthe `_count` API or `_cat/count` API instead."},"docs.deleted":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"deleted docs"},"creation.date":{"type":"string","description":"index creation date (millisecond value)"},"creation.date.string":{"type":"string","description":"index creation date (as string)"},"store.size":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"store size of primaries & replicas"},"pri.store.size":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"store size of primaries"},"dataset.size":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"total size of dataset (including the cache for partially mounted indices)"},"completion.size":{"type":"string","description":"size of completion"},"pri.completion.size":{"type":"string","description":"size of completion"},"fielddata.memory_size":{"type":"string","description":"used fielddata cache"},"pri.fielddata.memory_size":{"type":"string","description":"used fielddata cache"},"fielddata.evictions":{"type":"string","description":"fielddata evictions"},"pri.fielddata.evictions":{"type":"string","description":"fielddata evictions"},"query_cache.memory_size":{"type":"string","description":"used query cache"},"pri.query_cache.memory_size":{"type":"string","description":"used query cache"},"query_cache.evictions":{"type":"string","description":"query cache evictions"},"pri.query_cache.evictions":{"type":"string","description":"query cache evictions"},"request_cache.memory_size":{"type":"string","description":"used request cache"},"pri.request_cache.memory_size":{"type":"string","description":"used request cache"},"request_cache.evictions":{"type":"string","description":"request cache evictions"},"pri.request_cache.evictions":{"type":"string","description":"request cache evictions"},"request_cache.hit_count":{"type":"string","description":"request cache hit count"},"pri.request_cache.hit_count":{"type":"string","description":"request cache hit count"},"request_cache.miss_count":{"type":"string","description":"request cache miss count"},"pri.request_cache.miss_count":{"type":"string","description":"request cache miss count"},"flush.total":{"type":"string","description":"number of flushes"},"pri.flush.total":{"type":"string","description":"number of flushes"},"flush.total_time":{"type":"string","description":"time spent in flush"},"pri.flush.total_time":{"type":"string","description":"time spent in flush"},"get.current":{"type":"string","description":"number of current get ops"},"pri.get.current":{"type":"string","description":"number of current get ops"},"get.time":{"type":"string","description":"time spent in get"},"pri.get.time":{"type":"string","description":"time spent in get"},"get.total":{"type":"string","description":"number of get ops"},"pri.get.total":{"type":"string","description":"number of get ops"},"get.exists_time":{"type":"string","description":"time spent in successful gets"},"pri.get.exists_time":{"type":"string","description":"time spent in successful gets"},"get.exists_total":{"type":"string","description":"number of successful gets"},"pri.get.exists_total":{"type":"string","description":"number of successful gets"},"get.missing_time":{"type":"string","description":"time spent in failed gets"},"pri.get.missing_time":{"type":"string","description":"time spent in failed gets"},"get.missing_total":{"type":"string","description":"number of failed gets"},"pri.get.missing_total":{"type":"string","description":"number of failed gets"},"indexing.delete_current":{"type":"string","description":"number of current deletions"},"pri.indexing.delete_current":{"type":"string","description":"number of current deletions"},"indexing.delete_time":{"type":"string","description":"time spent in deletions"},"pri.indexing.delete_time":{"type":"string","description":"time spent in deletions"},"indexing.delete_total":{"type":"string","description":"number of delete ops"},"pri.indexing.delete_total":{"type":"string","description":"number of delete ops"},"indexing.index_current":{"type":"string","description":"number of current indexing ops"},"pri.indexing.index_current":{"type":"string","description":"number of current indexing ops"},"indexing.index_time":{"type":"string","description":"time spent in indexing"},"pri.indexing.index_time":{"type":"string","description":"time spent in indexing"},"indexing.index_total":{"type":"string","description":"number of indexing ops"},"pri.indexing.index_total":{"type":"string","description":"number of indexing ops"},"indexing.index_failed":{"type":"string","description":"number of failed indexing ops"},"pri.indexing.index_failed":{"type":"string","description":"number of failed indexing ops"},"merges.current":{"type":"string","description":"number of current merges"},"pri.merges.current":{"type":"string","description":"number of current merges"},"merges.current_docs":{"type":"string","description":"number of current merging docs"},"pri.merges.current_docs":{"type":"string","description":"number of current merging docs"},"merges.current_size":{"type":"string","description":"size of current merges"},"pri.merges.current_size":{"type":"string","description":"size of current merges"},"merges.total":{"type":"string","description":"number of completed merge ops"},"pri.merges.total":{"type":"string","description":"number of completed merge ops"},"merges.total_docs":{"type":"string","description":"docs merged"},"pri.merges.total_docs":{"type":"string","description":"docs merged"},"merges.total_size":{"type":"string","description":"size merged"},"pri.merges.total_size":{"type":"string","description":"size merged"},"merges.total_time":{"type":"string","description":"time spent in merges"},"pri.merges.total_time":{"type":"string","description":"time spent in merges"},"refresh.total":{"type":"string","description":"total refreshes"},"pri.refresh.total":{"type":"string","description":"total refreshes"},"refresh.time":{"type":"string","description":"time spent in refreshes"},"pri.refresh.time":{"type":"string","description":"time spent in refreshes"},"refresh.external_total":{"type":"string","description":"total external refreshes"},"pri.refresh.external_total":{"type":"string","description":"total external refreshes"},"refresh.external_time":{"type":"string","description":"time spent in external refreshes"},"pri.refresh.external_time":{"type":"string","description":"time spent in external refreshes"},"refresh.listeners":{"type":"string","description":"number of pending refresh listeners"},"pri.refresh.listeners":{"type":"string","description":"number of pending refresh listeners"},"search.fetch_current":{"type":"string","description":"current fetch phase ops"},"pri.search.fetch_current":{"type":"string","description":"current fetch phase ops"},"search.fetch_time":{"type":"string","description":"time spent in fetch phase"},"pri.search.fetch_time":{"type":"string","description":"time spent in fetch phase"},"search.fetch_total":{"type":"string","description":"total fetch ops"},"pri.search.fetch_total":{"type":"string","description":"total fetch ops"},"search.open_contexts":{"type":"string","description":"open search contexts"},"pri.search.open_contexts":{"type":"string","description":"open search contexts"},"search.query_current":{"type":"string","description":"current query phase ops"},"pri.search.query_current":{"type":"string","description":"current query phase ops"},"search.query_time":{"type":"string","description":"time spent in query phase"},"pri.search.query_time":{"type":"string","description":"time spent in query phase"},"search.query_total":{"type":"string","description":"total query phase ops"},"pri.search.query_total":{"type":"string","description":"total query phase ops"},"search.scroll_current":{"type":"string","description":"open scroll contexts"},"pri.search.scroll_current":{"type":"string","description":"open scroll contexts"},"search.scroll_time":{"type":"string","description":"time scroll contexts held open"},"pri.search.scroll_time":{"type":"string","description":"time scroll contexts held open"},"search.scroll_total":{"type":"string","description":"completed scroll contexts"},"pri.search.scroll_total":{"type":"string","description":"completed scroll contexts"},"segments.count":{"type":"string","description":"number of segments"},"pri.segments.count":{"type":"string","description":"number of segments"},"segments.memory":{"type":"string","description":"memory used by segments"},"pri.segments.memory":{"type":"string","description":"memory used by segments"},"segments.index_writer_memory":{"type":"string","description":"memory used by index writer"},"pri.segments.index_writer_memory":{"type":"string","description":"memory used by index writer"},"segments.version_map_memory":{"type":"string","description":"memory used by version map"},"pri.segments.version_map_memory":{"type":"string","description":"memory used by version map"},"segments.fixed_bitset_memory":{"type":"string","description":"memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields"},"pri.segments.fixed_bitset_memory":{"type":"string","description":"memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields"},"warmer.current":{"type":"string","description":"current warmer ops"},"pri.warmer.current":{"type":"string","description":"current warmer ops"},"warmer.total":{"type":"string","description":"total warmer ops"},"pri.warmer.total":{"type":"string","description":"total warmer ops"},"warmer.total_time":{"type":"string","description":"time spent in warmers"},"pri.warmer.total_time":{"type":"string","description":"time spent in warmers"},"suggest.current":{"type":"string","description":"number of current suggest ops"},"pri.suggest.current":{"type":"string","description":"number of current suggest ops"},"suggest.time":{"type":"string","description":"time spend in suggest"},"pri.suggest.time":{"type":"string","description":"time spend in suggest"},"suggest.total":{"type":"string","description":"number of suggest ops"},"pri.suggest.total":{"type":"string","description":"number of suggest ops"},"memory.total":{"type":"string","description":"total used memory"},"pri.memory.total":{"type":"string","description":"total user memory"},"search.throttled":{"type":"string","description":"indicates if the index is search throttled"},"bulk.total_operations":{"type":"string","description":"number of bulk shard ops"},"pri.bulk.total_operations":{"type":"string","description":"number of bulk shard ops"},"bulk.total_time":{"type":"string","description":"time spend in shard bulk"},"pri.bulk.total_time":{"type":"string","description":"time spend in shard bulk"},"bulk.total_size_in_bytes":{"type":"string","description":"total size in bytes of shard bulk"},"pri.bulk.total_size_in_bytes":{"type":"string","description":"total size in bytes of shard bulk"},"bulk.avg_time":{"type":"string","description":"average time spend in shard bulk"},"pri.bulk.avg_time":{"type":"string","description":"average time spend in shard bulk"},"bulk.avg_size_in_bytes":{"type":"string","description":"average size in bytes of shard bulk"},"pri.bulk.avg_size_in_bytes":{"type":"string","description":"average size in bytes of shard bulk"}}}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"cat.indices__IndicesRecord":{"type":"object","properties":{"health":{"type":"string","description":"current health status"},"status":{"type":"string","description":"open/close status"},"index":{"type":"string","description":"index name"},"uuid":{"type":"string","description":"index uuid"},"pri":{"type":"string","description":"number of primary shards"},"rep":{"type":"string","description":"number of replica shards"},"docs.count":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number of documents in the index, including hidden nested documents.\nFor indices with `semantic_text` fields or other nested field types,\nthis count includes the internal nested documents.\nTo get the logical document count (excluding nested documents), use\nthe `_count` API or `_cat/count` API instead."},"docs.deleted":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"deleted docs"},"creation.date":{"type":"string","description":"index creation date (millisecond value)"},"creation.date.string":{"type":"string","description":"index creation date (as string)"},"store.size":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"store size of primaries & replicas"},"pri.store.size":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"store size of primaries"},"dataset.size":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"total size of dataset (including the cache for partially mounted indices)","x-availability":{"stack":{"since":"8.11.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}}},"completion.size":{"type":"string","description":"size of completion"},"pri.completion.size":{"type":"string","description":"size of completion"},"fielddata.memory_size":{"type":"string","description":"used fielddata cache"},"pri.fielddata.memory_size":{"type":"string","description":"used fielddata cache"},"fielddata.evictions":{"type":"string","description":"fielddata evictions"},"pri.fielddata.evictions":{"type":"string","description":"fielddata evictions"},"query_cache.memory_size":{"type":"string","description":"used query cache"},"pri.query_cache.memory_size":{"type":"string","description":"used query cache"},"query_cache.evictions":{"type":"string","description":"query cache evictions"},"pri.query_cache.evictions":{"type":"string","description":"query cache evictions"},"request_cache.memory_size":{"type":"string","description":"used request cache"},"pri.request_cache.memory_size":{"type":"string","description":"used request cache"},"request_cache.evictions":{"type":"string","description":"request cache evictions"},"pri.request_cache.evictions":{"type":"string","description":"request cache evictions"},"request_cache.hit_count":{"type":"string","description":"request cache hit count"},"pri.request_cache.hit_count":{"type":"string","description":"request cache hit count"},"request_cache.miss_count":{"type":"string","description":"request cache miss count"},"pri.request_cache.miss_count":{"type":"string","description":"request cache miss count"},"flush.total":{"type":"string","description":"number of flushes"},"pri.flush.total":{"type":"string","description":"number of flushes"},"flush.total_time":{"type":"string","description":"time spent in flush"},"pri.flush.total_time":{"type":"string","description":"time spent in flush"},"get.current":{"type":"string","description":"number of current get ops"},"pri.get.current":{"type":"string","description":"number of current get ops"},"get.time":{"type":"string","description":"time spent in get"},"pri.get.time":{"type":"string","description":"time spent in get"},"get.total":{"type":"string","description":"number of get ops"},"pri.get.total":{"type":"string","description":"number of get ops"},"get.exists_time":{"type":"string","description":"time spent in successful gets"},"pri.get.exists_time":{"type":"string","description":"time spent in successful gets"},"get.exists_total":{"type":"string","description":"number of successful gets"},"pri.get.exists_total":{"type":"string","description":"number of successful gets"},"get.missing_time":{"type":"string","description":"time spent in failed gets"},"pri.get.missing_time":{"type":"string","description":"time spent in failed gets"},"get.missing_total":{"type":"string","description":"number of failed gets"},"pri.get.missing_total":{"type":"string","description":"number of failed gets"},"indexing.delete_current":{"type":"string","description":"number of current deletions"},"pri.indexing.delete_current":{"type":"string","description":"number of current deletions"},"indexing.delete_time":{"type":"string","description":"time spent in deletions"},"pri.indexing.delete_time":{"type":"string","description":"time spent in deletions"},"indexing.delete_total":{"type":"string","description":"number of delete ops"},"pri.indexing.delete_total":{"type":"string","description":"number of delete ops"},"indexing.index_current":{"type":"string","description":"number of current indexing ops"},"pri.indexing.index_current":{"type":"string","description":"number of current indexing ops"},"indexing.index_time":{"type":"string","description":"time spent in indexing"},"pri.indexing.index_time":{"type":"string","description":"time spent in indexing"},"indexing.index_total":{"type":"string","description":"number of indexing ops"},"pri.indexing.index_total":{"type":"string","description":"number of indexing ops"},"indexing.index_failed":{"type":"string","description":"number of failed indexing ops"},"pri.indexing.index_failed":{"type":"string","description":"number of failed indexing ops"},"merges.current":{"type":"string","description":"number of current merges"},"pri.merges.current":{"type":"string","description":"number of current merges"},"merges.current_docs":{"type":"string","description":"number of current merging docs"},"pri.merges.current_docs":{"type":"string","description":"number of current merging docs"},"merges.current_size":{"type":"string","description":"size of current merges"},"pri.merges.current_size":{"type":"string","description":"size of current merges"},"merges.total":{"type":"string","description":"number of completed merge ops"},"pri.merges.total":{"type":"string","description":"number of completed merge ops"},"merges.total_docs":{"type":"string","description":"docs merged"},"pri.merges.total_docs":{"type":"string","description":"docs merged"},"merges.total_size":{"type":"string","description":"size merged"},"pri.merges.total_size":{"type":"string","description":"size merged"},"merges.total_time":{"type":"string","description":"time spent in merges"},"pri.merges.total_time":{"type":"string","description":"time spent in merges"},"refresh.total":{"type":"string","description":"total refreshes"},"pri.refresh.total":{"type":"string","description":"total refreshes"},"refresh.time":{"type":"string","description":"time spent in refreshes"},"pri.refresh.time":{"type":"string","description":"time spent in refreshes"},"refresh.external_total":{"type":"string","description":"total external refreshes"},"pri.refresh.external_total":{"type":"string","description":"total external refreshes"},"refresh.external_time":{"type":"string","description":"time spent in external refreshes"},"pri.refresh.external_time":{"type":"string","description":"time spent in external refreshes"},"refresh.listeners":{"type":"string","description":"number of pending refresh listeners"},"pri.refresh.listeners":{"type":"string","description":"number of pending refresh listeners"},"search.fetch_current":{"type":"string","description":"current fetch phase ops"},"pri.search.fetch_current":{"type":"string","description":"current fetch phase ops"},"search.fetch_time":{"type":"string","description":"time spent in fetch phase"},"pri.search.fetch_time":{"type":"string","description":"time spent in fetch phase"},"search.fetch_total":{"type":"string","description":"total fetch ops"},"pri.search.fetch_total":{"type":"string","description":"total fetch ops"},"search.open_contexts":{"type":"string","description":"open search contexts"},"pri.search.open_contexts":{"type":"string","description":"open search contexts"},"search.query_current":{"type":"string","description":"current query phase ops"},"pri.search.query_current":{"type":"string","description":"current query phase ops"},"search.query_time":{"type":"string","description":"time spent in query phase"},"pri.search.query_time":{"type":"string","description":"time spent in query phase"},"search.query_total":{"type":"string","description":"total query phase ops"},"pri.search.query_total":{"type":"string","description":"total query phase ops"},"search.scroll_current":{"type":"string","description":"open scroll contexts"},"pri.search.scroll_current":{"type":"string","description":"open scroll contexts"},"search.scroll_time":{"type":"string","description":"time scroll contexts held open"},"pri.search.scroll_time":{"type":"string","description":"time scroll contexts held open"},"search.scroll_total":{"type":"string","description":"completed scroll contexts"},"pri.search.scroll_total":{"type":"string","description":"completed scroll contexts"},"segments.count":{"type":"string","description":"number of segments"},"pri.segments.count":{"type":"string","description":"number of segments"},"segments.memory":{"type":"string","description":"memory used by segments"},"pri.segments.memory":{"type":"string","description":"memory used by segments"},"segments.index_writer_memory":{"type":"string","description":"memory used by index writer"},"pri.segments.index_writer_memory":{"type":"string","description":"memory used by index writer"},"segments.version_map_memory":{"type":"string","description":"memory used by version map"},"pri.segments.version_map_memory":{"type":"string","description":"memory used by version map"},"segments.fixed_bitset_memory":{"type":"string","description":"memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields"},"pri.segments.fixed_bitset_memory":{"type":"string","description":"memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields"},"warmer.current":{"type":"string","description":"current warmer ops"},"pri.warmer.current":{"type":"string","description":"current warmer ops"},"warmer.total":{"type":"string","description":"total warmer ops"},"pri.warmer.total":{"type":"string","description":"total warmer ops"},"warmer.total_time":{"type":"string","description":"time spent in warmers"},"pri.warmer.total_time":{"type":"string","description":"time spent in warmers"},"suggest.current":{"type":"string","description":"number of current suggest ops"},"pri.suggest.current":{"type":"string","description":"number of current suggest ops"},"suggest.time":{"type":"string","description":"time spend in suggest"},"pri.suggest.time":{"type":"string","description":"time spend in suggest"},"suggest.total":{"type":"string","description":"number of suggest ops"},"pri.suggest.total":{"type":"string","description":"number of suggest ops"},"memory.total":{"type":"string","description":"total used memory"},"pri.memory.total":{"type":"string","description":"total user memory"},"search.throttled":{"type":"string","description":"indicates if the index is search throttled"},"bulk.total_operations":{"type":"string","description":"number of bulk shard ops"},"pri.bulk.total_operations":{"type":"string","description":"number of bulk shard ops"},"bulk.total_time":{"type":"string","description":"time spend in shard bulk"},"pri.bulk.total_time":{"type":"string","description":"time spend in shard bulk"},"bulk.total_size_in_bytes":{"type":"string","description":"total size in bytes of shard bulk"},"pri.bulk.total_size_in_bytes":{"type":"string","description":"total size in bytes of shard bulk"},"bulk.avg_time":{"type":"string","description":"average time spend in shard bulk"},"pri.bulk.avg_time":{"type":"string","description":"average time spend in shard bulk"},"bulk.avg_size_in_bytes":{"type":"string","description":"average size in bytes of shard bulk"},"pri.bulk.avg_size_in_bytes":{"type":"string","description":"average size in bytes of shard bulk"}}}}}

package/src/es/json/cat.indices.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.indices","type":"object","properties":{"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"The type of index that wildcard patterns can match.","x-found-in":"query"},"health":{"$ref":"./_types.json#/$defs/_types__HealthStatus","description":"The health status used to limit returned indices. By default, the response includes indices of any health status.","x-found-in":"query"},"include_unloaded_segments":{"type":"boolean","description":"If true, the response includes information from segments that are not loaded into memory.","x-found-in":"query"},"pri":{"type":"boolean","description":"If true, the response only includes information from primary shards.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatIndicesColumns","description":"A comma-separated list of columns names to display. It supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.","x-found-in":"path"}},"description":"Get index information.\n\nGet high-level information about indices in a cluster, including backing indices for data streams.\n\nUse this request to get the following information for each index in a cluster:\n- shard count\n- document count\n- deleted document count\n- primary store size\n- total store size of all shards, including shard replicas\n\nThese metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents.\nTo get an accurate count of Elasticsearch documents, use the cat count or count APIs.\n\nNOTE: Storage metrics reported by this API reflect the post-compression size of the indices on disk. Because these values are calculated after Elasticsearch compresses the data and processes deletions, they are typically significantly smaller than the raw, uncompressed data volume ingested.\n\nIMPORTANT: For Elastic Cloud Serverless, ingest billing is based on the raw, uncompressed data volume, not the post-compression metrics reported here. To learn more, refer to [Elasticsearch billing dimensions](https://www.elastic.co/docs/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions).\n\nCAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use an index endpoint."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.indices","description":"Get index information.\n\nGet high-level information about indices in a cluster, including backing indices for data streams.\n\nUse this request to get the following information for each index in a cluster:\n- shard count\n- document count\n- deleted document count\n- primary store size\n- total store size of all shards, including shard replicas\n\nThese metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents.\nTo get an accurate count of Elasticsearch documents, use the cat count or count APIs.\n\nNOTE: Storage metrics reported by this API reflect the post-compression size of the indices on disk. Because these values are calculated after Elasticsearch compresses the data and processes deletions, they are typically significantly smaller than the raw, uncompressed data volume ingested.\n\nIMPORTANT: For Elastic Cloud Serverless, ingest billing is based on the raw, uncompressed data volume, not the post-compression metrics reported here. To learn more, refer to [Elasticsearch billing dimensions](https://www.elastic.co/docs/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions).\n\nCAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use an index endpoint.","x-api":{"id":"cat.indices","name":"indices","namespace":"cat"},"x-method":"GET","x-path":"/_cat/indices/{index}","x-urls":[{"path":"/_cat/indices","methods":["GET"]},{"path":"/_cat/indices/{index}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"x-response-type":"text","type":"object","properties":{"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"The type of index that wildcard patterns can match.","x-found-in":"query"},"health":{"$ref":"./_types.json#/$defs/_types__HealthStatus","description":"The health status used to limit returned indices. By default, the response includes indices of any health status.","x-found-in":"query"},"include_unloaded_segments":{"type":"boolean","description":"If true, the response includes information from segments that are not loaded into memory.","x-found-in":"query"},"pri":{"type":"boolean","description":"If true, the response only includes information from primary shards.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatIndicesColumns","description":"A comma-separated list of columns names to display. It supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.","x-found-in":"path"}}}

package/src/es/json/cat.indices.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.indices","type":"array","items":{"$ref":"./cat.indices.json#/$defs/cat.indices__IndicesRecord"}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.indices","x-api":{"id":"cat.indices","name":"indices","namespace":"cat"},"type":"array","items":{"$ref":"./cat.indices.json#/$defs/cat.indices__IndicesRecord"}}

package/src/es/json/cat.master.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.master","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatMasterColumns","description":"A comma-separated list of columns names to display. It supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"},"local":{"type":"boolean","description":"If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"}},"description":"Get master node information.\n\nGet information about the master node, including the ID, bound IP address, and name.\n\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.master","description":"Get master node information.\n\nGet information about the master node, including the ID, bound IP address, and name.\n\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.","x-api":{"id":"cat.master","name":"master","namespace":"cat"},"x-method":"GET","x-path":"/_cat/master","x-urls":[{"path":"/_cat/master","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatMasterColumns","description":"A comma-separated list of columns names to display. It supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"},"local":{"type":"boolean","description":"If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"}}}

package/src/es/json/cat.master.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.master","type":"array","items":{"$ref":"./cat.master.json#/$defs/cat.master__MasterRecord"}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.master","x-api":{"id":"cat.master","name":"master","namespace":"cat"},"type":"array","items":{"$ref":"./cat.master.json#/$defs/cat.master__MasterRecord"}}

package/src/es/json/cat.ml_data_frame_analytics.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.ml_data_frame_analytics","type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Whether to ignore if a wildcard expression matches no configs.\n(This includes `_all` string or when no configs have been specified.)","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatDfaColumns","description":"Comma-separated list of column names to display.","x-found-in":"query"},"s":{"$ref":"./cat._types.json#/$defs/cat._types__CatDfaColumns","description":"Comma-separated list of column names or column aliases used to sort the\nresponse.","x-found-in":"query"},"id":{"type":"string","description":"The ID of the data frame analytics to fetch","x-found-in":"path"}},"description":"Get data frame analytics jobs.\n\nGet configuration and usage information about data frame analytics jobs.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get data frame analytics jobs statistics API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.ml_data_frame_analytics","description":"Get data frame analytics jobs.\n\nGet configuration and usage information about data frame analytics jobs.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get data frame analytics jobs statistics API.","x-api":{"id":"cat.ml_data_frame_analytics","name":"ml-data-frame-analytics","namespace":"cat"},"x-method":"GET","x-path":"/_cat/ml/data_frame/analytics/{id}","x-urls":[{"path":"/_cat/ml/data_frame/analytics","methods":["GET"]},{"path":"/_cat/ml/data_frame/analytics/{id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.7.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"x-response-type":"text","type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Whether to ignore if a wildcard expression matches no configs.\n(This includes `_all` string or when no configs have been specified.)","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatDfaColumns","description":"Comma-separated list of column names to display.","x-found-in":"query"},"s":{"$ref":"./cat._types.json#/$defs/cat._types__CatDfaColumns","description":"Comma-separated list of column names or column aliases used to sort the\nresponse.","x-found-in":"query"},"id":{"type":"string","description":"The ID of the data frame analytics to fetch","x-found-in":"path"}}}

package/src/es/json/cat.ml_data_frame_analytics.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.ml_data_frame_analytics","type":"array","items":{"$ref":"./cat.ml_data_frame_analytics.json#/$defs/cat.ml_data_frame_analytics__DataFrameAnalyticsRecord"}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.ml_data_frame_analytics","x-api":{"id":"cat.ml_data_frame_analytics","name":"ml-data-frame-analytics","namespace":"cat"},"type":"array","items":{"$ref":"./cat.ml_data_frame_analytics.json#/$defs/cat.ml_data_frame_analytics__DataFrameAnalyticsRecord"}}

package/src/es/json/cat.ml_datafeeds.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.ml_datafeeds","type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request:\n\n* Contains wildcard expressions and there are no datafeeds that match.\n* Contains the `_all` string or no identifiers and there are no matches.\n* Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when\nthere are partial matches. If `false`, the API returns a 404 status code when there are no matches or only\npartial matches.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatDatafeedColumns","description":"Comma-separated list of column names to display.","x-found-in":"query"},"s":{"$ref":"./cat._types.json#/$defs/cat._types__CatDatafeedColumns","description":"Comma-separated list of column names or column aliases used to sort the response.","x-found-in":"query"},"datafeed_id":{"type":"string","description":"A numerical character string that uniquely identifies the datafeed.","x-found-in":"path"}},"description":"Get datafeeds.\n\nGet configuration and usage information about datafeeds.\nThis API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get datafeed statistics API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.ml_datafeeds","description":"Get datafeeds.\n\nGet configuration and usage information about datafeeds.\nThis API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get datafeed statistics API.","x-api":{"id":"cat.ml_datafeeds","name":"ml-datafeeds","namespace":"cat"},"x-method":"GET","x-path":"/_cat/ml/datafeeds/{datafeed_id}","x-urls":[{"path":"/_cat/ml/datafeeds","methods":["GET"]},{"path":"/_cat/ml/datafeeds/{datafeed_id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.7.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"x-response-type":"text","type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request:\n\n* Contains wildcard expressions and there are no datafeeds that match.\n* Contains the `_all` string or no identifiers and there are no matches.\n* Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when\nthere are partial matches. If `false`, the API returns a 404 status code when there are no matches or only\npartial matches.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatDatafeedColumns","description":"Comma-separated list of column names to display.","x-found-in":"query"},"s":{"$ref":"./cat._types.json#/$defs/cat._types__CatDatafeedColumns","description":"Comma-separated list of column names or column aliases used to sort the response.","x-found-in":"query"},"datafeed_id":{"type":"string","description":"A numerical character string that uniquely identifies the datafeed.","x-found-in":"path"}}}