@elastic/schemas 0.4.3 → 0.4.4

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":{"id":{"type":"string","description":"A unique identifier for the async search.","x-found-in":"path"},"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"}},"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","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."}

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":{"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"},"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":{"oneOf":[{"$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":{"oneOf":[{"$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"}},"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","type":"object","properties":{"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"},"explain":{"type":"boolean","description":"Specify whether to return detailed information about score computation as part of a hit","x-found-in":"query"},"ext":{"type":"object","additionalProperties":{},"description":"Configuration of search extensions defined by Elasticsearch plugins.","x-found-in":"body"},"from":{"type":"number","description":"Starting offset","x-found-in":"query"},"highlight":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__Highlight","x-found-in":"body"},"track_total_hits":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__TrackHits","description":"Indicate if the number of documents that match the query should be tracked.\nA number can also be specified, to accurately track the total hit count up to the number.","x-found-in":"query"},"indices_boost":{"type":"array","items":{"type":"object","additionalProperties":{"type":"number"}},"description":"Boosts the _score of documents from specified indices.","x-found-in":"body"},"docvalue_fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"A comma-separated list of fields to return as the docvalue representation of a field for each hit","x-found-in":"query"},"knn":{"oneOf":[{"$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":{"oneOf":[{"$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"},"size":{"type":"number","description":"Number of hits to return","x-found-in":"query"},"slice":{"$ref":"./_types.json#/$defs/_types__SlicedScroll","x-found-in":"body"},"sort":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A comma-separated list of <field>:<direction> pairs","x-found-in":"query"},"_source":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam","description":"True or false to return the _source field or not, or a list of fields to return","x-found-in":"query"},"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"},"terminate_after":{"type":"number","description":"The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Explicit operation timeout","x-found-in":"query"},"track_scores":{"type":"boolean","description":"Whether to calculate and return scores even if they are not used for sorting","x-found-in":"query"},"version":{"type":"boolean","description":"Specify whether to return document version as part of a hit","x-found-in":"query"},"seq_no_primary_term":{"type":"boolean","description":"Specify whether to return sequence number and primary term of the last modification of each hit","x-found-in":"query"},"stored_fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"A comma-separated list of stored fields to return as part of a hit","x-found-in":"query"},"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"},"stats":{"type":"array","items":{"type":"string"},"description":"Specific 'tag' of the request for logging and statistical purposes","x-found-in":"query"},"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"},"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"},"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"},"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"},"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"},"_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"},"q":{"type":"string","description":"Query in the Lucene query string syntax","x-found-in":"query"},"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."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"bulk","type":"object","properties":{"index":{"type":"string","description":"The name of the data stream, index, or index alias to perform bulk actions on.","x-found-in":"path"},"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"}},"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","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"},"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."}

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":{"task_id":{"type":"string","description":"The ID of the reindex task to cancel.","x-found-in":"path"},"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"}},"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","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```"}

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":{"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"},"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"}},"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","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."}

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":{"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"},"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"}},"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","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."}

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":{"circuit_breaker_patterns":{"oneOf":[{"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"},"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"}},"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","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":{"oneOf":[{"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."}

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":{"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"},"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"}},"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","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."}

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":{"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"},"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"}},"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","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."}

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.","x-found-in":"query"},"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","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."}

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":{"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"},"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"}},"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","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."}

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":{"id":{"type":"string","description":"The ID of the data frame analytics to fetch","x-found-in":"path"},"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"}},"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","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."}

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":{"datafeed_id":{"type":"string","description":"A numerical character string that uniquely identifies the datafeed.","x-found-in":"path"},"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"}},"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","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."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.ml_jobs","type":"object","properties":{"job_id":{"type":"string","description":"Identifier for the anomaly detection job.","x-found-in":"path"},"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request:\n\n* Contains wildcard expressions and there are no jobs that match.\n* Contains the `_all` string or no identifiers and there are no matches.\n* Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the API returns an empty jobs array when there are no matches and the subset of results when there\nare partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial\nmatches.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatAnomalyDetectorColumns","description":"Comma-separated list of column names to display.","x-found-in":"query"},"s":{"$ref":"./cat._types.json#/$defs/cat._types__CatAnomalyDetectorColumns","description":"Comma-separated list of column names or column aliases used to sort the response.","x-found-in":"query"}},"description":"Get anomaly detection jobs.\n\nGet configuration and usage information for anomaly detection jobs.\nThis API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\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 anomaly detection job statistics API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.ml_jobs","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 jobs that match.\n* Contains the `_all` string or no identifiers and there are no matches.\n* Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the API returns an empty jobs array when there are no matches and the subset of results when there\nare partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial\nmatches.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatAnomalyDetectorColumns","description":"Comma-separated list of column names to display.","x-found-in":"query"},"s":{"$ref":"./cat._types.json#/$defs/cat._types__CatAnomalyDetectorColumns","description":"Comma-separated list of column names or column aliases used to sort the response.","x-found-in":"query"},"job_id":{"type":"string","description":"Identifier for the anomaly detection job.","x-found-in":"path"}},"description":"Get anomaly detection jobs.\n\nGet configuration and usage information for anomaly detection jobs.\nThis API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\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 anomaly detection job statistics API."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.ml_trained_models","type":"object","properties":{"model_id":{"type":"string","description":"A unique identifier for the trained model.","x-found-in":"path"},"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches.\nIf `true`, the API returns an empty array when there are no matches and the subset of results when there are partial matches.\nIf `false`, the API returns a 404 status code when there are no matches or only partial matches.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatTrainedModelsColumns","description":"A comma-separated list of column names to display.","x-found-in":"query"},"s":{"$ref":"./cat._types.json#/$defs/cat._types__CatTrainedModelsColumns","description":"A comma-separated list of column names or aliases used to sort the response.","x-found-in":"query"},"from":{"type":"number","description":"Skips the specified number of transforms.","x-found-in":"query"},"size":{"type":"number","description":"The maximum number of transforms to display.","x-found-in":"query"}},"description":"Get trained models.\n\nGet configuration and usage information about inference trained models.\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 trained models statistics API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.ml_trained_models","type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches.\nIf `true`, the API returns an empty array when there are no matches and the subset of results when there are partial matches.\nIf `false`, the API returns a 404 status code when there are no matches or only partial matches.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatTrainedModelsColumns","description":"A comma-separated list of column names to display.","x-found-in":"query"},"s":{"$ref":"./cat._types.json#/$defs/cat._types__CatTrainedModelsColumns","description":"A comma-separated list of column names or aliases used to sort the response.","x-found-in":"query"},"from":{"type":"number","description":"Skips the specified number of transforms.","x-found-in":"query"},"size":{"type":"number","description":"The maximum number of transforms to display.","x-found-in":"query"},"model_id":{"type":"string","description":"A unique identifier for the trained model.","x-found-in":"path"}},"description":"Get trained models.\n\nGet configuration and usage information about inference trained models.\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 trained models statistics API."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.recovery","type":"object","properties":{"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"Comma-separated list or wildcard expression of index names to limit the returned information","x-found-in":"query"},"active_only":{"type":"boolean","description":"If `true`, the response only includes ongoing shard recoveries.","x-found-in":"query"},"detailed":{"type":"boolean","description":"If `true`, the response includes detailed information about shard recoveries.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatRecoveryColumns","description":"A comma-separated list of columns names to display.\nIt supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of column names or aliases that determines the sort order.\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 shard recovery information.\n\nGet information about ongoing and completed shard recoveries.\nShard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing.\nFor data streams, the API returns information about the stream’s backing indices.\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 index recovery API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.recovery","type":"object","properties":{"active_only":{"type":"boolean","description":"If `true`, the response only includes ongoing shard recoveries.","x-found-in":"query"},"detailed":{"type":"boolean","description":"If `true`, the response includes detailed information about shard recoveries.","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.\nSupports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.","x-found-in":"path"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatRecoveryColumns","description":"A comma-separated list of columns names to display.\nIt supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of column names or aliases that determines the sort order.\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 shard recovery information.\n\nGet information about ongoing and completed shard recoveries.\nShard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing.\nFor data streams, the API returns information about the stream’s backing indices.\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 index recovery API."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.segments","type":"object","properties":{"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.","x-found-in":"path"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatSegmentsColumns","description":"A comma-separated list of columns names to display.\nIt supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of column names or aliases that determines the sort order.\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"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Type of index that wildcard expressions can match. If the request can target data streams, this argument\ndetermines whether wildcard expressions match hidden data streams. Supports comma-separated values,\nsuch as open,hidden.","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"},"ignore_throttled":{"type":"boolean","description":"If true, concrete, expanded or aliased indices are ignored when frozen.","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"allow_closed":{"type":"boolean","description":"If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour\nof throwing an exception if index pattern matches closed indices","x-found-in":"query"}},"description":"Get segment information.\n\nGet low-level information about the Lucene segments in index shards.\nFor data streams, the API returns information about the backing indices.\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 index segments API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.segments","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatSegmentsColumns","description":"A comma-separated list of columns names to display.\nIt supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of column names or aliases that determines the sort order.\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"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Type of index that wildcard expressions can match. If the request can target data streams, this argument\ndetermines whether wildcard expressions match hidden data streams. Supports comma-separated values,\nsuch as open,hidden.","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"},"ignore_throttled":{"type":"boolean","description":"If true, concrete, expanded or aliased indices are ignored when frozen.","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"allow_closed":{"type":"boolean","description":"If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour\nof throwing an exception if index pattern matches closed indices","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.\nSupports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.","x-found-in":"path"}},"description":"Get segment information.\n\nGet low-level information about the Lucene segments in index shards.\nFor data streams, the API returns information about the backing indices.\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 index segments API."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.shards","type":"object","properties":{"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.","x-found-in":"path"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatShardColumns","description":"List of columns to appear in the response. Supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of column names or aliases that determines the sort order.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","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"}},"description":"Get shard information.\n\nGet information about the shards in a cluster.\nFor data streams, the API returns information about the backing indices.\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.shards","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatShardColumns","description":"List of columns to appear in the response. Supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of column names or aliases that determines the sort order.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","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"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.","x-found-in":"path"}},"description":"Get shard information.\n\nGet information about the shards in a cluster.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.snapshots","type":"object","properties":{"repository":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of snapshot repositories used to limit the request.\nAccepts wildcard expressions.\n`_all` returns all repositories.\nIf any repository fails during the request, Elasticsearch returns an error.","x-found-in":"path"},"ignore_unavailable":{"type":"boolean","description":"If `true`, the response does not include information from unavailable snapshots.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatSnapshotsColumns","description":"A comma-separated list of columns names to display.\nIt 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"},"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 snapshot information.\n\nGet information about the snapshots stored in one or more repositories.\nA snapshot is a backup of an index or running Elasticsearch cluster.\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 get snapshot API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.snapshots","type":"object","properties":{"ignore_unavailable":{"type":"boolean","description":"If `true`, the response does not include information from unavailable snapshots.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatSnapshotsColumns","description":"A comma-separated list of columns names to display.\nIt 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"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"repository":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of snapshot repositories used to limit the request.\nAccepts wildcard expressions.\n`_all` returns all repositories.\nIf any repository fails during the request, Elasticsearch returns an error.","x-found-in":"path"}},"description":"Get snapshot information.\n\nGet information about the snapshots stored in one or more repositories.\nA snapshot is a backup of an index or running Elasticsearch cluster.\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 get snapshot API."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.templates","type":"object","properties":{"name":{"type":"string","description":"The name of the template to return.\nAccepts wildcard expressions. If omitted, all templates are returned.","x-found-in":"path"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatTemplatesColumns","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 index template information.\n\nGet information about the index templates in a cluster.\nYou can use index templates to apply index settings and field mappings to new indices at creation.\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 get index template API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.templates","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatTemplatesColumns","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"},"name":{"type":"string","description":"The name of the template to return.\nAccepts wildcard expressions. If omitted, all templates are returned.","x-found-in":"path"}},"description":"Get index template information.\n\nGet information about the index templates in a cluster.\nYou can use index templates to apply index settings and field mappings to new indices at creation.\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 get index template API."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.thread_pool","type":"object","properties":{"thread_pool_patterns":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of thread pool names used to limit the request.\nAccepts wildcard expressions.","x-found-in":"path"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatThreadPoolColumns","description":"List of columns to appear in the response. Supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of column names or aliases that determines the sort order.\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"}},"description":"Get thread pool statistics.\n\nGet thread pool statistics for each node in a cluster.\nReturned information includes all built-in thread pools and custom thread pools.\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.thread_pool","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatThreadPoolColumns","description":"List of columns to appear in the response. Supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of column names or aliases that determines the sort order.\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"},"thread_pool_patterns":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of thread pool names used to limit the request.\nAccepts wildcard expressions.","x-found-in":"path"}},"description":"Get thread pool statistics.\n\nGet thread pool statistics for each node in a cluster.\nReturned information includes all built-in thread pools and custom thread pools.\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."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.transforms","type":"object","properties":{"transform_id":{"type":"string","description":"A transform identifier or a wildcard expression.\nIf you do not specify one of these options, the API returns information for all transforms.","x-found-in":"path"},"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches.\nIf `true`, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches.\nIf `false`, the request returns a 404 status code when there are no matches or only partial matches.","x-found-in":"query"},"from":{"type":"number","description":"Skips the specified number of transforms.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatTransformColumns","description":"Comma-separated list of column names to display.","x-found-in":"query"},"s":{"$ref":"./cat._types.json#/$defs/cat._types__CatTransformColumns","description":"Comma-separated list of column names or column aliases used to sort the response.","x-found-in":"query"},"size":{"type":"number","description":"The maximum number of transforms to obtain.","x-found-in":"query"}},"description":"Get transform information.\n\nGet configuration and usage information about transforms.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.transforms","type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches.\nIf `true`, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches.\nIf `false`, the request returns a 404 status code when there are no matches or only partial matches.","x-found-in":"query"},"from":{"type":"number","description":"Skips the specified number of transforms.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatTransformColumns","description":"Comma-separated list of column names to display.","x-found-in":"query"},"s":{"$ref":"./cat._types.json#/$defs/cat._types__CatTransformColumns","description":"Comma-separated list of column names or column aliases used to sort the response.","x-found-in":"query"},"size":{"type":"number","description":"The maximum number of transforms to obtain.","x-found-in":"query"},"transform_id":{"type":"string","description":"A transform identifier or a wildcard expression.\nIf you do not specify one of these options, the API returns information for all transforms.","x-found-in":"path"}},"description":"Get transform information.\n\nGet configuration and usage information about transforms.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API."}

package/src/es/json/ccr.delete_auto_follow_pattern.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.delete_auto_follow_pattern","type":"object","properties":{"name":{"type":"string","description":"The auto-follow pattern collection to delete.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"}},"required":["name"],"description":"Delete auto-follow patterns.\n\nDelete a collection of cross-cluster replication auto-follow patterns."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.delete_auto_follow_pattern","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"},"name":{"type":"string","description":"The auto-follow pattern collection to delete.","x-found-in":"path"}},"required":["name"],"description":"Delete auto-follow patterns.\n\nDelete a collection of cross-cluster replication auto-follow patterns."}

package/src/es/json/ccr.follow.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.follow","type":"object","properties":{"index":{"type":"string","description":"The name of the follower index.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"wait_for_active_shards":{"$ref":"./_types.json#/$defs/_types__WaitForActiveShards","description":"Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be\nactive.\nA shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the\nremote Lucene segment files to the follower index.","x-found-in":"query"},"data_stream_name":{"type":"string","description":"If the leader index is part of a data stream, the name to which the local data stream for the followed index should be renamed.","x-found-in":"body"},"leader_index":{"type":"string","description":"The name of the index in the leader cluster to follow.","x-found-in":"body"},"max_outstanding_read_requests":{"type":"number","description":"The maximum number of outstanding reads requests from the remote cluster.","x-found-in":"body"},"max_outstanding_write_requests":{"type":"number","description":"The maximum number of outstanding write requests on the follower.","x-found-in":"body"},"max_read_request_operation_count":{"type":"number","description":"The maximum number of operations to pull per read from the remote cluster.","x-found-in":"body"},"max_read_request_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.","x-found-in":"body"},"max_retry_delay":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when\nretrying.","x-found-in":"body"},"max_write_buffer_count":{"type":"number","description":"The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be\ndeferred until the number of queued operations goes below the limit.","x-found-in":"body"},"max_write_buffer_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will\nbe deferred until the total bytes of queued operations goes below the limit.","x-found-in":"body"},"max_write_request_operation_count":{"type":"number","description":"The maximum number of operations per bulk write request executed on the follower.","x-found-in":"body"},"max_write_request_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum total bytes of operations per bulk write request executed on the follower.","x-found-in":"body"},"read_poll_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index.\nWhen the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics.\nThen the follower will immediately attempt to read from the leader again.","x-found-in":"body"},"remote_cluster":{"type":"string","description":"The remote cluster containing the leader index.","x-found-in":"body"},"settings":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings","description":"Settings to override from the leader index.","x-found-in":"body"}},"required":["index","leader_index","remote_cluster"],"description":"Create a follower.\n\nCreate a cross-cluster replication follower index that follows a specific leader index.\nWhen the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.follow","type":"object","properties":{"data_stream_name":{"type":"string","description":"If the leader index is part of a data stream, the name to which the local data stream for the followed index should be renamed.","x-found-in":"body"},"leader_index":{"type":"string","description":"The name of the index in the leader cluster to follow.","x-found-in":"body"},"max_outstanding_read_requests":{"type":"number","description":"The maximum number of outstanding reads requests from the remote cluster.","x-found-in":"body"},"max_outstanding_write_requests":{"type":"number","description":"The maximum number of outstanding write requests on the follower.","x-found-in":"body"},"max_read_request_operation_count":{"type":"number","description":"The maximum number of operations to pull per read from the remote cluster.","x-found-in":"body"},"max_read_request_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.","x-found-in":"body"},"max_retry_delay":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when\nretrying.","x-found-in":"body"},"max_write_buffer_count":{"type":"number","description":"The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be\ndeferred until the number of queued operations goes below the limit.","x-found-in":"body"},"max_write_buffer_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will\nbe deferred until the total bytes of queued operations goes below the limit.","x-found-in":"body"},"max_write_request_operation_count":{"type":"number","description":"The maximum number of operations per bulk write request executed on the follower.","x-found-in":"body"},"max_write_request_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum total bytes of operations per bulk write request executed on the follower.","x-found-in":"body"},"read_poll_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index.\nWhen the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics.\nThen the follower will immediately attempt to read from the leader again.","x-found-in":"body"},"remote_cluster":{"type":"string","description":"The remote cluster containing the leader index.","x-found-in":"body"},"settings":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings","description":"Settings to override from the leader index.","x-found-in":"body"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"wait_for_active_shards":{"$ref":"./_types.json#/$defs/_types__WaitForActiveShards","description":"Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be\nactive.\nA shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the\nremote Lucene segment files to the follower index.","x-found-in":"query"},"index":{"type":"string","description":"The name of the follower index.","x-found-in":"path"}},"required":["index","leader_index","remote_cluster"],"description":"Create a follower.\n\nCreate a cross-cluster replication follower index that follows a specific leader index.\nWhen the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index."}

package/src/es/json/ccr.follow_info.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.follow_info","type":"object","properties":{"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-delimited list of follower index patterns.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"}},"required":["index"],"description":"Get follower information.\n\nGet information about all cross-cluster replication follower indices.\nFor example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.follow_info","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-delimited list of follower index patterns.","x-found-in":"path"}},"required":["index"],"description":"Get follower information.\n\nGet information about all cross-cluster replication follower indices.\nFor example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused."}

package/src/es/json/ccr.follow_stats.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.follow_stats","type":"object","properties":{"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-delimited list of index patterns.","x-found-in":"path"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"}},"required":["index"],"description":"Get follower stats.\n\nGet cross-cluster replication follower stats.\nThe API returns shard-level stats about the \"following tasks\" associated with each shard for the specified indices."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.follow_stats","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-delimited list of index patterns.","x-found-in":"path"}},"required":["index"],"description":"Get follower stats.\n\nGet cross-cluster replication follower stats.\nThe API returns shard-level stats about the \"following tasks\" associated with each shard for the specified indices."}

package/src/es/json/ccr.forget_follower.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.forget_follower","type":"object","properties":{"index":{"type":"string","description":"Name of the leader index for which specified follower retention leases should be removed","x-found-in":"path"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"follower_cluster":{"type":"string","x-found-in":"body"},"follower_index":{"type":"string","x-found-in":"body"},"follower_index_uuid":{"type":"string","x-found-in":"body"},"leader_remote_cluster":{"type":"string","x-found-in":"body"}},"required":["index"],"description":"Forget a follower.\n\nRemove the cross-cluster replication follower retention leases from the leader.\n\nA following index takes out retention leases on its leader index.\nThese leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication.\nWhen a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed.\nHowever, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable.\nWhile the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index.\nThis API exists to enable manually removing the leases when the unfollow API is unable to do so.\n\nNOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader.\nThe only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.forget_follower","type":"object","properties":{"follower_cluster":{"type":"string","x-found-in":"body"},"follower_index":{"type":"string","x-found-in":"body"},"follower_index_uuid":{"type":"string","x-found-in":"body"},"leader_remote_cluster":{"type":"string","x-found-in":"body"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"index":{"type":"string","description":"Name of the leader index for which specified follower retention leases should be removed","x-found-in":"path"}},"required":["index"],"description":"Forget a follower.\n\nRemove the cross-cluster replication follower retention leases from the leader.\n\nA following index takes out retention leases on its leader index.\nThese leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication.\nWhen a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed.\nHowever, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable.\nWhile the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index.\nThis API exists to enable manually removing the leases when the unfollow API is unable to do so.\n\nNOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader.\nThe only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked."}

package/src/es/json/ccr.get_auto_follow_pattern.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.get_auto_follow_pattern","type":"object","properties":{"name":{"type":"string","description":"The auto-follow pattern collection that you want to retrieve.\nIf you do not specify a name, the API returns information for all collections.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"}},"description":"Get auto-follow patterns.\n\nGet cross-cluster replication auto-follow patterns."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.get_auto_follow_pattern","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"},"name":{"type":"string","description":"The auto-follow pattern collection that you want to retrieve.\nIf you do not specify a name, the API returns information for all collections.","x-found-in":"path"}},"description":"Get auto-follow patterns.\n\nGet cross-cluster replication auto-follow patterns."}

package/src/es/json/ccr.pause_auto_follow_pattern.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.pause_auto_follow_pattern","type":"object","properties":{"name":{"type":"string","description":"The name of the auto-follow pattern to pause.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"}},"required":["name"],"description":"Pause an auto-follow pattern.\n\nPause a cross-cluster replication auto-follow pattern.\nWhen the API returns, the auto-follow pattern is inactive.\nNew indices that are created on the remote cluster and match the auto-follow patterns are ignored.\n\nYou can resume auto-following with the resume auto-follow pattern API.\nWhen it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns.\nRemote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.pause_auto_follow_pattern","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"},"name":{"type":"string","description":"The name of the auto-follow pattern to pause.","x-found-in":"path"}},"required":["name"],"description":"Pause an auto-follow pattern.\n\nPause a cross-cluster replication auto-follow pattern.\nWhen the API returns, the auto-follow pattern is inactive.\nNew indices that are created on the remote cluster and match the auto-follow patterns are ignored.\n\nYou can resume auto-following with the resume auto-follow pattern API.\nWhen it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns.\nRemote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim."}

package/src/es/json/ccr.pause_follow.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.pause_follow","type":"object","properties":{"index":{"type":"string","description":"The name of the follower index.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"}},"required":["index"],"description":"Pause a follower.\n\nPause a cross-cluster replication follower index.\nThe follower index will not fetch any additional operations from the leader index.\nYou can resume following with the resume follower API.\nYou can pause and resume a follower index to change the configuration of the following task."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.pause_follow","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"},"index":{"type":"string","description":"The name of the follower index.","x-found-in":"path"}},"required":["index"],"description":"Pause a follower.\n\nPause a cross-cluster replication follower index.\nThe follower index will not fetch any additional operations from the leader index.\nYou can resume following with the resume follower API.\nYou can pause and resume a follower index to change the configuration of the following task."}

package/src/es/json/ccr.put_auto_follow_pattern.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.put_auto_follow_pattern","type":"object","properties":{"name":{"type":"string","description":"The name of the collection of auto-follow patterns.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"remote_cluster":{"type":"string","description":"The remote cluster containing the leader indices to match against.","x-found-in":"body"},"follow_index_pattern":{"type":"string","description":"The name of follower index. The template {{leader_index}} can be used to derive the name of the follower index from the name of the leader index. When following a data stream, use {{leader_index}}; CCR does not support changes to the names of a follower data stream’s backing indices.","x-found-in":"body"},"leader_index_patterns":{"$ref":"./_types.json#/$defs/_types__IndexPatterns","description":"An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.","x-found-in":"body"},"leader_index_exclusion_patterns":{"$ref":"./_types.json#/$defs/_types__IndexPatterns","description":"An array of simple index patterns that can be used to exclude indices from being auto-followed. Indices in the remote cluster whose names are matching one or more leader_index_patterns and one or more leader_index_exclusion_patterns won’t be followed.","x-found-in":"body"},"max_outstanding_read_requests":{"type":"number","description":"The maximum number of outstanding reads requests from the remote cluster.","x-found-in":"body"},"settings":{"type":"object","additionalProperties":{},"description":"Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards).","x-found-in":"body"},"max_outstanding_write_requests":{"type":"number","description":"The maximum number of outstanding reads requests from the remote cluster.","x-found-in":"body"},"read_poll_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again.","x-found-in":"body"},"max_read_request_operation_count":{"type":"number","description":"The maximum number of operations to pull per read from the remote cluster.","x-found-in":"body"},"max_read_request_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.","x-found-in":"body"},"max_retry_delay":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying.","x-found-in":"body"},"max_write_buffer_count":{"type":"number","description":"The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit.","x-found-in":"body"},"max_write_buffer_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit.","x-found-in":"body"},"max_write_request_operation_count":{"type":"number","description":"The maximum number of operations per bulk write request executed on the follower.","x-found-in":"body"},"max_write_request_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum total bytes of operations per bulk write request executed on the follower.","x-found-in":"body"}},"required":["name","remote_cluster"],"description":"Create or update auto-follow patterns.\n\nCreate a collection of cross-cluster replication auto-follow patterns for a remote cluster.\nNewly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices.\nIndices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern.\n\nThis API can also be used to update auto-follow patterns.\nNOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.put_auto_follow_pattern","type":"object","properties":{"remote_cluster":{"type":"string","description":"The remote cluster containing the leader indices to match against.","x-found-in":"body"},"follow_index_pattern":{"type":"string","description":"The name of follower index. The template {{leader_index}} can be used to derive the name of the follower index from the name of the leader index. When following a data stream, use {{leader_index}}; CCR does not support changes to the names of a follower data stream’s backing indices.","x-found-in":"body"},"leader_index_patterns":{"$ref":"./_types.json#/$defs/_types__IndexPatterns","description":"An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.","x-found-in":"body"},"leader_index_exclusion_patterns":{"$ref":"./_types.json#/$defs/_types__IndexPatterns","description":"An array of simple index patterns that can be used to exclude indices from being auto-followed. Indices in the remote cluster whose names are matching one or more leader_index_patterns and one or more leader_index_exclusion_patterns won’t be followed.","x-found-in":"body"},"max_outstanding_read_requests":{"type":"number","description":"The maximum number of outstanding reads requests from the remote cluster.","x-found-in":"body"},"settings":{"type":"object","additionalProperties":{},"description":"Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards).","x-found-in":"body"},"max_outstanding_write_requests":{"type":"number","description":"The maximum number of outstanding reads requests from the remote cluster.","x-found-in":"body"},"read_poll_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again.","x-found-in":"body"},"max_read_request_operation_count":{"type":"number","description":"The maximum number of operations to pull per read from the remote cluster.","x-found-in":"body"},"max_read_request_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.","x-found-in":"body"},"max_retry_delay":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying.","x-found-in":"body"},"max_write_buffer_count":{"type":"number","description":"The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit.","x-found-in":"body"},"max_write_buffer_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit.","x-found-in":"body"},"max_write_request_operation_count":{"type":"number","description":"The maximum number of operations per bulk write request executed on the follower.","x-found-in":"body"},"max_write_request_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum total bytes of operations per bulk write request executed on the follower.","x-found-in":"body"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"name":{"type":"string","description":"The name of the collection of auto-follow patterns.","x-found-in":"path"}},"required":["name","remote_cluster"],"description":"Create or update auto-follow patterns.\n\nCreate a collection of cross-cluster replication auto-follow patterns for a remote cluster.\nNewly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices.\nIndices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern.\n\nThis API can also be used to update auto-follow patterns.\nNOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns."}

package/src/es/json/ccr.resume_auto_follow_pattern.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.resume_auto_follow_pattern","type":"object","properties":{"name":{"type":"string","description":"The name of the auto-follow pattern to resume.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"}},"required":["name"],"description":"Resume an auto-follow pattern.\n\nResume a cross-cluster replication auto-follow pattern that was paused.\nThe auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster.\nRemote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.resume_auto_follow_pattern","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"},"name":{"type":"string","description":"The name of the auto-follow pattern to resume.","x-found-in":"path"}},"required":["name"],"description":"Resume an auto-follow pattern.\n\nResume a cross-cluster replication auto-follow pattern that was paused.\nThe auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster.\nRemote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim."}

package/src/es/json/ccr.resume_follow.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.resume_follow","type":"object","properties":{"index":{"type":"string","description":"Name of the follow index to resume following","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"max_outstanding_read_requests":{"type":"number","x-found-in":"body"},"max_outstanding_write_requests":{"type":"number","x-found-in":"body"},"max_read_request_operation_count":{"type":"number","x-found-in":"body"},"max_read_request_size":{"type":"string","x-found-in":"body"},"max_retry_delay":{"$ref":"./_types.json#/$defs/_types__Duration","x-found-in":"body"},"max_write_buffer_count":{"type":"number","x-found-in":"body"},"max_write_buffer_size":{"type":"string","x-found-in":"body"},"max_write_request_operation_count":{"type":"number","x-found-in":"body"},"max_write_request_size":{"type":"string","x-found-in":"body"},"read_poll_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","x-found-in":"body"}},"required":["index"],"description":"Resume a follower.\n\nResume a cross-cluster replication follower index that was paused.\nThe follower index could have been paused with the pause follower API.\nAlternatively it could be paused due to replication that cannot be retried due to failures during following tasks.\nWhen this API returns, the follower index will resume fetching operations from the leader index."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.resume_follow","type":"object","properties":{"max_outstanding_read_requests":{"type":"number","x-found-in":"body"},"max_outstanding_write_requests":{"type":"number","x-found-in":"body"},"max_read_request_operation_count":{"type":"number","x-found-in":"body"},"max_read_request_size":{"type":"string","x-found-in":"body"},"max_retry_delay":{"$ref":"./_types.json#/$defs/_types__Duration","x-found-in":"body"},"max_write_buffer_count":{"type":"number","x-found-in":"body"},"max_write_buffer_size":{"type":"string","x-found-in":"body"},"max_write_request_operation_count":{"type":"number","x-found-in":"body"},"max_write_request_size":{"type":"string","x-found-in":"body"},"read_poll_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","x-found-in":"body"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"index":{"type":"string","description":"Name of the follow index to resume following","x-found-in":"path"}},"required":["index"],"description":"Resume a follower.\n\nResume a cross-cluster replication follower index that was paused.\nThe follower index could have been paused with the pause follower API.\nAlternatively it could be paused due to replication that cannot be retried due to failures during following tasks.\nWhen this API returns, the follower index will resume fetching operations from the leader index."}