@elastic/schemas 0.5.0 → 0.5.1

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

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

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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.ml_jobs","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.","x-api":{"id":"cat.ml_jobs","name":"ml-jobs","namespace":"cat"},"x-method":"GET","x-path":"/_cat/ml/anomaly_detectors/{job_id}","x-urls":[{"path":"/_cat/ml/anomaly_detectors","methods":["GET"]},{"path":"/_cat/ml/anomaly_detectors/{job_id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.7.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"x-response-type":"text","type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request:\n\n* Contains wildcard expressions and there are no 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"}}}

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

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

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"cat.ml_trained_models__TrainedModelsRecord":{"type":"object","properties":{"id":{"type":"string","description":"The model identifier."},"created_by":{"type":"string","description":"Information about the creator of the model."},"heap_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The estimated heap size to keep the model in memory."},"operations":{"type":"string","description":"The estimated number of operations to use the model.\nThis number helps to measure the computational complexity of the model."},"license":{"type":"string","description":"The license level of the model."},"create_time":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The time the model was created."},"version":{"type":"string","description":"The version of Elasticsearch when the model was created."},"description":{"type":"string","description":"A description of the model."},"ingest.pipelines":{"type":"string","description":"The number of pipelines that are referencing the model."},"ingest.count":{"type":"string","description":"The total number of documents that are processed by the model."},"ingest.time":{"type":"string","description":"The total time spent processing documents with thie model."},"ingest.current":{"type":"string","description":"The total number of documents that are currently being handled by the model."},"ingest.failed":{"type":"string","description":"The total number of failed ingest attempts with the model."},"data_frame.id":{"type":"string","description":"The identifier for the data frame analytics job that created the model.\nOnly displayed if the job is still available."},"data_frame.create_time":{"type":"string","description":"The time the data frame analytics job was created."},"data_frame.source_index":{"type":"string","description":"The source index used to train in the data frame analysis."},"data_frame.analysis":{"type":"string","description":"The analysis used by the data frame to build the model."},"type":{"type":"string"}}}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"cat.ml_trained_models__TrainedModelsRecord":{"type":"object","properties":{"id":{"type":"string","description":"The model identifier."},"created_by":{"type":"string","description":"Information about the creator of the model."},"heap_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The estimated heap size to keep the model in memory."},"operations":{"type":"string","description":"The estimated number of operations to use the model.\nThis number helps to measure the computational complexity of the model."},"license":{"type":"string","description":"The license level of the model."},"create_time":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The time the model was created."},"version":{"type":"string","description":"The version of Elasticsearch when the model was created."},"description":{"type":"string","description":"A description of the model."},"ingest.pipelines":{"type":"string","description":"The number of pipelines that are referencing the model."},"ingest.count":{"type":"string","description":"The total number of documents that are processed by the model."},"ingest.time":{"type":"string","description":"The total time spent processing documents with thie model."},"ingest.current":{"type":"string","description":"The total number of documents that are currently being handled by the model."},"ingest.failed":{"type":"string","description":"The total number of failed ingest attempts with the model."},"data_frame.id":{"type":"string","description":"The identifier for the data frame analytics job that created the model.\nOnly displayed if the job is still available."},"data_frame.create_time":{"type":"string","description":"The time the data frame analytics job was created."},"data_frame.source_index":{"type":"string","description":"The source index used to train in the data frame analysis."},"data_frame.analysis":{"type":"string","description":"The analysis used by the data frame to build the model."},"type":{"type":"string","x-availability":{"stack":{"since":"8.0.0"},"serverless":{}}}}}}}

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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.ml_trained_models","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.","x-api":{"id":"cat.ml_trained_models","name":"ml-trained-models","namespace":"cat"},"x-method":"GET","x-path":"/_cat/ml/trained_models/{model_id}","x-urls":[{"path":"/_cat/ml/trained_models","methods":["GET"]},{"path":"/_cat/ml/trained_models/{model_id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.7.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"x-response-type":"text","type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request: 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"}}}

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

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

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

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

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

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

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.nodes","type":"object","properties":{"full_id":{"type":"boolean","description":"If `true`, return the full node ID. If `false`, return the shortened node ID.","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"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatNodeColumns","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"},"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 node information.\n\nGet information about the nodes in a 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 nodes info API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.nodes","description":"Get node information.\n\nGet information about the nodes in a 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 nodes info API.","x-api":{"id":"cat.nodes","name":"nodes","namespace":"cat"},"x-method":"GET","x-path":"/_cat/nodes","x-urls":[{"path":"/_cat/nodes","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","type":"object","properties":{"full_id":{"type":"boolean","description":"If `true`, return the full node ID. If `false`, return the shortened node ID.","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"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatNodeColumns","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"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.","x-found-in":"query"}}}

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

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

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.pending_tasks","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatPendingTasksColumns","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 pending task information.\n\nGet information about cluster-level changes that have not yet taken effect.\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 pending cluster tasks API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.pending_tasks","description":"Get pending task information.\n\nGet information about cluster-level changes that have not yet taken effect.\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 pending cluster tasks API.","x-api":{"id":"cat.pending_tasks","name":"pending-tasks","namespace":"cat"},"x-method":"GET","x-path":"/_cat/pending_tasks","x-urls":[{"path":"/_cat/pending_tasks","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatPendingTasksColumns","description":"A comma-separated list of columns names to display. It supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"},"local":{"type":"boolean","description":"If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"}}}

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

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

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.plugins","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatPluginsColumns","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"},"include_bootstrap":{"type":"boolean","description":"Include bootstrap plugins in the response","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 plugin information.\n\nGet a list of plugins running on each node of a 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 nodes info API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.plugins","description":"Get plugin information.\n\nGet a list of plugins running on each node of a 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 nodes info API.","x-api":{"id":"cat.plugins","name":"plugins","namespace":"cat"},"x-method":"GET","x-path":"/_cat/plugins","x-urls":[{"path":"/_cat/plugins","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatPluginsColumns","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"},"include_bootstrap":{"type":"boolean","description":"Include bootstrap plugins in the response","x-found-in":"query"},"local":{"type":"boolean","description":"If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"}}}

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

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

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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.recovery","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.","x-api":{"id":"cat.recovery","name":"recovery","namespace":"cat"},"x-method":"GET","x-path":"/_cat/recovery/{index}","x-urls":[{"path":"/_cat/recovery","methods":["GET"]},{"path":"/_cat/recovery/{index}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","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"}}}

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

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

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.repositories","type":"object","properties":{"h":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns to appear in the response. 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 snapshot repository information.\n\nGet a list of snapshot repositories for a 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 repository API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.repositories","description":"Get snapshot repository information.\n\nGet a list of snapshot repositories for a 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 repository API.","x-api":{"id":"cat.repositories","name":"repositories","namespace":"cat"},"x-method":"GET","x-path":"/_cat/repositories","x-urls":[{"path":"/_cat/repositories","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"2.1.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","type":"object","properties":{"h":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns to appear in the response. Supports simple wildcards.","x-found-in":"query"},"s":{"$ref":"./_types.json#/$defs/_types__Names","description":"List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.","x-found-in":"query"},"local":{"type":"boolean","description":"If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"}}}

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

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

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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.segments","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.","x-api":{"id":"cat.segments","name":"segments","namespace":"cat"},"x-method":"GET","x-path":"/_cat/segments/{index}","x-urls":[{"path":"/_cat/segments","methods":["GET"]},{"path":"/_cat/segments/{index}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__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"}}}

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

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

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"cat.shards__ShardsRecord":{"type":"object","properties":{"index":{"type":"string","description":"The index name."},"shard":{"type":"string","description":"The shard name."},"prirep":{"type":"string","description":"The shard type: `primary` or `replica`."},"state":{"type":"string","description":"The shard state.\nReturned values include:\n`INITIALIZING`: The shard is recovering from a peer shard or gateway.\n`RELOCATING`: The shard is relocating.\n`STARTED`: The shard has started.\n`UNASSIGNED`: The shard is not assigned to any node."},"docs":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number of documents in the shard."},"store":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The disk space used by the shard."},"dataset":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"total size of dataset (including the cache for partially mounted indices)"},"ip":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The IP address of the node."},"id":{"type":"string","description":"The unique identifier for the node."},"node":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of node."},"sync_id":{"type":"string","description":"The sync identifier."},"unassigned.reason":{"type":"string","description":"The reason for the last change to the state of an unassigned shard.\nIt does not explain why the shard is currently unassigned; use the cluster allocation explain API for that information.\nReturned values include:\n`ALLOCATION_FAILED`: Unassigned as a result of a failed allocation of the shard.\n`CLUSTER_RECOVERED`: Unassigned as a result of a full cluster recovery.\n`DANGLING_INDEX_IMPORTED`: Unassigned as a result of importing a dangling index.\n`EXISTING_INDEX_RESTORED`: Unassigned as a result of restoring into a closed index.\n`FORCED_EMPTY_PRIMARY`: The shard’s allocation was last modified by forcing an empty primary using the cluster reroute API.\n`INDEX_CLOSED`: Unassigned because the index was closed.\n`INDEX_CREATED`: Unassigned as a result of an API creation of an index.\n`INDEX_REOPENED`: Unassigned as a result of opening a closed index.\n`MANUAL_ALLOCATION`: The shard’s allocation was last modified by the cluster reroute API.\n`NEW_INDEX_RESTORED`: Unassigned as a result of restoring into a new index.\n`NODE_LEFT`: Unassigned as a result of the node hosting it leaving the cluster.\n`NODE_RESTARTING`: Similar to `NODE_LEFT`, except that the node was registered as restarting using the node shutdown API.\n`PRIMARY_FAILED`: The shard was initializing as a replica, but the primary shard failed before the initialization completed.\n`REALLOCATED_REPLICA`: A better replica location is identified and causes the existing replica allocation to be cancelled.\n`REINITIALIZED`: When a shard moves from started back to initializing.\n`REPLICA_ADDED`: Unassigned as a result of explicit addition of a replica.\n`REROUTE_CANCELLED`: Unassigned as a result of explicit cancel reroute command."},"unassigned.at":{"type":"string","description":"The time at which the shard became unassigned in Coordinated Universal Time (UTC)."},"unassigned.for":{"type":"string","description":"The time at which the shard was requested to be unassigned in Coordinated Universal Time (UTC)."},"unassigned.details":{"type":"string","description":"Additional details as to why the shard became unassigned.\nIt does not explain why the shard is not assigned; use the cluster allocation explain API for that information."},"recoverysource.type":{"type":"string","description":"The type of recovery source."},"completion.size":{"type":"string","description":"The size of completion."},"fielddata.memory_size":{"type":"string","description":"The used fielddata cache memory."},"fielddata.evictions":{"type":"string","description":"The fielddata cache evictions."},"query_cache.memory_size":{"type":"string","description":"The used query cache memory."},"query_cache.evictions":{"type":"string","description":"The query cache evictions."},"flush.total":{"type":"string","description":"The number of flushes."},"flush.total_time":{"type":"string","description":"The time spent in flush."},"get.current":{"type":"string","description":"The number of current get operations."},"get.time":{"type":"string","description":"The time spent in get operations."},"get.total":{"type":"string","description":"The number of get operations."},"get.exists_time":{"type":"string","description":"The time spent in successful get operations."},"get.exists_total":{"type":"string","description":"The number of successful get operations."},"get.missing_time":{"type":"string","description":"The time spent in failed get operations."},"get.missing_total":{"type":"string","description":"The number of failed get operations."},"indexing.delete_current":{"type":"string","description":"The number of current deletion operations."},"indexing.delete_time":{"type":"string","description":"The time spent in deletion operations."},"indexing.delete_total":{"type":"string","description":"The number of delete operations."},"indexing.index_current":{"type":"string","description":"The number of current indexing operations."},"indexing.index_time":{"type":"string","description":"The time spent in indexing operations."},"indexing.index_total":{"type":"string","description":"The number of indexing operations."},"indexing.index_failed":{"type":"string","description":"The number of failed indexing operations."},"merges.current":{"type":"string","description":"The number of current merge operations."},"merges.current_docs":{"type":"string","description":"The number of current merging documents."},"merges.current_size":{"type":"string","description":"The size of current merge operations."},"merges.total":{"type":"string","description":"The number of completed merge operations."},"merges.total_docs":{"type":"string","description":"The nuber of merged documents."},"merges.total_size":{"type":"string","description":"The size of current merges."},"merges.total_time":{"type":"string","description":"The time spent merging documents."},"refresh.total":{"type":"string","description":"The total number of refreshes."},"refresh.time":{"type":"string","description":"The time spent in refreshes."},"refresh.external_total":{"type":"string","description":"The total nunber of external refreshes."},"refresh.external_time":{"type":"string","description":"The time spent in external refreshes."},"refresh.listeners":{"type":"string","description":"The number of pending refresh listeners."},"search.fetch_current":{"type":"string","description":"The current fetch phase operations."},"search.fetch_time":{"type":"string","description":"The time spent in fetch phase."},"search.fetch_total":{"type":"string","description":"The total number of fetch operations."},"search.open_contexts":{"type":"string","description":"The number of open search contexts."},"search.query_current":{"type":"string","description":"The current query phase operations."},"search.query_time":{"type":"string","description":"The time spent in query phase."},"search.query_total":{"type":"string","description":"The total number of query phase operations."},"search.scroll_current":{"type":"string","description":"The open scroll contexts."},"search.scroll_time":{"type":"string","description":"The time scroll contexts were held open."},"search.scroll_total":{"type":"string","description":"The number of completed scroll contexts."},"segments.count":{"type":"string","description":"The number of segments."},"segments.memory":{"type":"string","description":"The memory used by segments."},"segments.index_writer_memory":{"type":"string","description":"The memory used by the index writer."},"segments.version_map_memory":{"type":"string","description":"The memory used by the version map."},"segments.fixed_bitset_memory":{"type":"string","description":"The memory used by fixed bit sets for nested object field types and export type filters for types referred in `_parent` fields."},"seq_no.max":{"type":"string","description":"The maximum sequence number."},"seq_no.local_checkpoint":{"type":"string","description":"The local checkpoint."},"seq_no.global_checkpoint":{"type":"string","description":"The global checkpoint."},"warmer.current":{"type":"string","description":"The number of current warmer operations."},"warmer.total":{"type":"string","description":"The total number of warmer operations."},"warmer.total_time":{"type":"string","description":"The time spent in warmer operations."},"path.data":{"type":"string","description":"The shard data path."},"path.state":{"type":"string","description":"The shard state path."},"bulk.total_operations":{"type":"string","description":"The number of bulk shard operations."},"bulk.total_time":{"type":"string","description":"The time spent in shard bulk operations."},"bulk.total_size_in_bytes":{"type":"string","description":"The total size in bytes of shard bulk operations."},"bulk.avg_time":{"type":"string","description":"The average time spent in shard bulk operations."},"bulk.avg_size_in_bytes":{"type":"string","description":"The average size in bytes of shard bulk operations."}}}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"cat.shards__ShardsRecord":{"type":"object","properties":{"index":{"type":"string","description":"The index name."},"shard":{"type":"string","description":"The shard name."},"prirep":{"type":"string","description":"The shard type: `primary` or `replica`."},"state":{"type":"string","description":"The shard state.\nReturned values include:\n`INITIALIZING`: The shard is recovering from a peer shard or gateway.\n`RELOCATING`: The shard is relocating.\n`STARTED`: The shard has started.\n`UNASSIGNED`: The shard is not assigned to any node."},"docs":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The number of documents in the shard."},"store":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The disk space used by the shard."},"dataset":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"total size of dataset (including the cache for partially mounted indices)","x-availability":{"stack":{"since":"8.11.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}}},"ip":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The IP address of the node."},"id":{"type":"string","description":"The unique identifier for the node."},"node":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of node."},"sync_id":{"type":"string","description":"The sync identifier."},"unassigned.reason":{"type":"string","description":"The reason for the last change to the state of an unassigned shard.\nIt does not explain why the shard is currently unassigned; use the cluster allocation explain API for that information.\nReturned values include:\n`ALLOCATION_FAILED`: Unassigned as a result of a failed allocation of the shard.\n`CLUSTER_RECOVERED`: Unassigned as a result of a full cluster recovery.\n`DANGLING_INDEX_IMPORTED`: Unassigned as a result of importing a dangling index.\n`EXISTING_INDEX_RESTORED`: Unassigned as a result of restoring into a closed index.\n`FORCED_EMPTY_PRIMARY`: The shard’s allocation was last modified by forcing an empty primary using the cluster reroute API.\n`INDEX_CLOSED`: Unassigned because the index was closed.\n`INDEX_CREATED`: Unassigned as a result of an API creation of an index.\n`INDEX_REOPENED`: Unassigned as a result of opening a closed index.\n`MANUAL_ALLOCATION`: The shard’s allocation was last modified by the cluster reroute API.\n`NEW_INDEX_RESTORED`: Unassigned as a result of restoring into a new index.\n`NODE_LEFT`: Unassigned as a result of the node hosting it leaving the cluster.\n`NODE_RESTARTING`: Similar to `NODE_LEFT`, except that the node was registered as restarting using the node shutdown API.\n`PRIMARY_FAILED`: The shard was initializing as a replica, but the primary shard failed before the initialization completed.\n`REALLOCATED_REPLICA`: A better replica location is identified and causes the existing replica allocation to be cancelled.\n`REINITIALIZED`: When a shard moves from started back to initializing.\n`REPLICA_ADDED`: Unassigned as a result of explicit addition of a replica.\n`REROUTE_CANCELLED`: Unassigned as a result of explicit cancel reroute command."},"unassigned.at":{"type":"string","description":"The time at which the shard became unassigned in Coordinated Universal Time (UTC)."},"unassigned.for":{"type":"string","description":"The time at which the shard was requested to be unassigned in Coordinated Universal Time (UTC)."},"unassigned.details":{"type":"string","description":"Additional details as to why the shard became unassigned.\nIt does not explain why the shard is not assigned; use the cluster allocation explain API for that information."},"recoverysource.type":{"type":"string","description":"The type of recovery source."},"completion.size":{"type":"string","description":"The size of completion."},"fielddata.memory_size":{"type":"string","description":"The used fielddata cache memory."},"fielddata.evictions":{"type":"string","description":"The fielddata cache evictions."},"query_cache.memory_size":{"type":"string","description":"The used query cache memory."},"query_cache.evictions":{"type":"string","description":"The query cache evictions."},"flush.total":{"type":"string","description":"The number of flushes."},"flush.total_time":{"type":"string","description":"The time spent in flush."},"get.current":{"type":"string","description":"The number of current get operations."},"get.time":{"type":"string","description":"The time spent in get operations."},"get.total":{"type":"string","description":"The number of get operations."},"get.exists_time":{"type":"string","description":"The time spent in successful get operations."},"get.exists_total":{"type":"string","description":"The number of successful get operations."},"get.missing_time":{"type":"string","description":"The time spent in failed get operations."},"get.missing_total":{"type":"string","description":"The number of failed get operations."},"indexing.delete_current":{"type":"string","description":"The number of current deletion operations."},"indexing.delete_time":{"type":"string","description":"The time spent in deletion operations."},"indexing.delete_total":{"type":"string","description":"The number of delete operations."},"indexing.index_current":{"type":"string","description":"The number of current indexing operations."},"indexing.index_time":{"type":"string","description":"The time spent in indexing operations."},"indexing.index_total":{"type":"string","description":"The number of indexing operations."},"indexing.index_failed":{"type":"string","description":"The number of failed indexing operations."},"merges.current":{"type":"string","description":"The number of current merge operations."},"merges.current_docs":{"type":"string","description":"The number of current merging documents."},"merges.current_size":{"type":"string","description":"The size of current merge operations."},"merges.total":{"type":"string","description":"The number of completed merge operations."},"merges.total_docs":{"type":"string","description":"The nuber of merged documents."},"merges.total_size":{"type":"string","description":"The size of current merges."},"merges.total_time":{"type":"string","description":"The time spent merging documents."},"refresh.total":{"type":"string","description":"The total number of refreshes."},"refresh.time":{"type":"string","description":"The time spent in refreshes."},"refresh.external_total":{"type":"string","description":"The total nunber of external refreshes."},"refresh.external_time":{"type":"string","description":"The time spent in external refreshes."},"refresh.listeners":{"type":"string","description":"The number of pending refresh listeners."},"search.fetch_current":{"type":"string","description":"The current fetch phase operations."},"search.fetch_time":{"type":"string","description":"The time spent in fetch phase."},"search.fetch_total":{"type":"string","description":"The total number of fetch operations."},"search.open_contexts":{"type":"string","description":"The number of open search contexts."},"search.query_current":{"type":"string","description":"The current query phase operations."},"search.query_time":{"type":"string","description":"The time spent in query phase."},"search.query_total":{"type":"string","description":"The total number of query phase operations."},"search.scroll_current":{"type":"string","description":"The open scroll contexts."},"search.scroll_time":{"type":"string","description":"The time scroll contexts were held open."},"search.scroll_total":{"type":"string","description":"The number of completed scroll contexts."},"segments.count":{"type":"string","description":"The number of segments."},"segments.memory":{"type":"string","description":"The memory used by segments."},"segments.index_writer_memory":{"type":"string","description":"The memory used by the index writer."},"segments.version_map_memory":{"type":"string","description":"The memory used by the version map."},"segments.fixed_bitset_memory":{"type":"string","description":"The memory used by fixed bit sets for nested object field types and export type filters for types referred in `_parent` fields."},"seq_no.max":{"type":"string","description":"The maximum sequence number."},"seq_no.local_checkpoint":{"type":"string","description":"The local checkpoint."},"seq_no.global_checkpoint":{"type":"string","description":"The global checkpoint."},"warmer.current":{"type":"string","description":"The number of current warmer operations."},"warmer.total":{"type":"string","description":"The total number of warmer operations."},"warmer.total_time":{"type":"string","description":"The time spent in warmer operations."},"path.data":{"type":"string","description":"The shard data path."},"path.state":{"type":"string","description":"The shard state path."},"bulk.total_operations":{"type":"string","description":"The number of bulk shard operations."},"bulk.total_time":{"type":"string","description":"The time spent in shard bulk operations."},"bulk.total_size_in_bytes":{"type":"string","description":"The total size in bytes of shard bulk operations."},"bulk.avg_time":{"type":"string","description":"The average time spent in shard bulk operations."},"bulk.avg_size_in_bytes":{"type":"string","description":"The average size in bytes of shard bulk operations."}}}}}

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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.shards","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.","x-api":{"id":"cat.shards","name":"shards","namespace":"cat"},"x-method":"GET","x-path":"/_cat/shards/{index}","x-urls":[{"path":"/_cat/shards","methods":["GET"]},{"path":"/_cat/shards/{index}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__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"}}}

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

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

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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.snapshots","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.","x-api":{"id":"cat.snapshots","name":"snapshots","namespace":"cat"},"x-method":"GET","x-path":"/_cat/snapshots/{repository}","x-urls":[{"path":"/_cat/snapshots","methods":["GET"]},{"path":"/_cat/snapshots/{repository}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"2.1.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","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"}}}

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

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

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.tasks","type":"object","properties":{"actions":{"type":"array","items":{"type":"string"},"description":"The task action names, which are used to limit the response.","x-found-in":"query"},"detailed":{"type":"boolean","description":"If `true`, the response includes detailed information about shard recoveries.","x-found-in":"query"},"nodes":{"type":"array","items":{"type":"string"},"description":"Unique node identifiers, which are used to limit the response.","x-found-in":"query"},"parent_task_id":{"type":"string","description":"The parent task identifier, which is used to limit the response.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatTasksColumns","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"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"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"},"wait_for_completion":{"type":"boolean","description":"If `true`, the request blocks until the task has completed.","x-found-in":"query"}},"description":"Get task information.\n\nGet information about tasks currently running in the 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 task management API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.tasks","description":"Get task information.\n\nGet information about tasks currently running in the 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 task management API.","x-api":{"id":"cat.tasks","name":"tasks","namespace":"cat"},"x-method":"GET","x-path":"/_cat/tasks","x-urls":[{"path":"/_cat/tasks","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"5.0.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"private"}},"x-response-type":"text","type":"object","properties":{"actions":{"type":"array","items":{"type":"string"},"description":"The task action names, which are used to limit the response.","x-found-in":"query"},"detailed":{"type":"boolean","description":"If `true`, the response includes detailed information about shard recoveries.","x-found-in":"query"},"nodes":{"type":"array","items":{"type":"string"},"description":"Unique node identifiers, which are used to limit the response.","x-found-in":"query"},"parent_task_id":{"type":"string","description":"The parent task identifier, which is used to limit the response.","x-found-in":"query"},"h":{"$ref":"./cat._types.json#/$defs/cat._types__CatTasksColumns","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"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"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"},"wait_for_completion":{"type":"boolean","description":"If `true`, the request blocks until the task has completed.","x-found-in":"query"}}}

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

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

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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.templates","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.","x-api":{"id":"cat.templates","name":"templates","namespace":"cat"},"x-method":"GET","x-path":"/_cat/templates/{name}","x-urls":[{"path":"/_cat/templates","methods":["GET"]},{"path":"/_cat/templates/{name}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"5.2.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","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"}}}

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

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

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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.thread_pool","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.","x-api":{"id":"cat.thread_pool","name":"thread-pool","namespace":"cat"},"x-method":"GET","x-path":"/_cat/thread_pool/{thread_pool_patterns}","x-urls":[{"path":"/_cat/thread_pool","methods":["GET"]},{"path":"/_cat/thread_pool/{thread_pool_patterns}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"x-response-type":"text","type":"object","properties":{"h":{"$ref":"./cat._types.json#/$defs/cat._types__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"}}}

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

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

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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"cat.transforms","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.","x-api":{"id":"cat.transforms","name":"transforms","namespace":"cat"},"x-method":"GET","x-path":"/_cat/transforms/{transform_id}","x-urls":[{"path":"/_cat/transforms","methods":["GET"]},{"path":"/_cat/transforms/{transform_id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.7.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"x-response-type":"text","type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request: 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"}}}

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

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

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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.delete_auto_follow_pattern","description":"Delete auto-follow patterns.\n\nDelete a collection of cross-cluster replication auto-follow patterns.","x-api":{"id":"ccr.delete_auto_follow_pattern","name":"delete-auto-follow-pattern","namespace":"ccr"},"x-method":"DELETE","x-path":"/_ccr/auto_follow/{name}","x-urls":[{"path":"/_ccr/auto_follow/{name}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"6.5.0","stability":"stable"}},"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"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.delete_auto_follow_pattern","$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.delete_auto_follow_pattern","x-api":{"id":"ccr.delete_auto_follow_pattern","name":"delete-auto-follow-pattern","namespace":"ccr"},"$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}

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":{"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"},"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.follow","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.","x-api":{"id":"ccr.follow","name":"follow","namespace":"ccr"},"x-method":"PUT","x-path":"/{index}/_ccr/follow","x-urls":[{"path":"/{index}/_ccr/follow","methods":["PUT"]}],"x-destructive":false,"x-availability":{"stack":{"since":"6.5.0","stability":"stable"}},"type":"object","properties":{"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","x-availability":{"stack":{}}},"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"},"index":{"type":"string","description":"The name of the follower index.","x-found-in":"path"}},"required":["index","leader_index","remote_cluster"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.follow","type":"object","properties":{"follow_index_created":{"type":"boolean"},"follow_index_shards_acked":{"type":"boolean"},"index_following_started":{"type":"boolean"}},"required":["follow_index_created","follow_index_shards_acked","index_following_started"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.follow","x-api":{"id":"ccr.follow","name":"follow","namespace":"ccr"},"type":"object","properties":{"follow_index_created":{"type":"boolean"},"follow_index_shards_acked":{"type":"boolean"},"index_following_started":{"type":"boolean"}},"required":["follow_index_created","follow_index_shards_acked","index_following_started"]}

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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.follow_info","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.","x-api":{"id":"ccr.follow_info","name":"follow-info","namespace":"ccr"},"x-method":"GET","x-path":"/{index}/_ccr/info","x-urls":[{"path":"/{index}/_ccr/info","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"6.7.0","stability":"stable"}},"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"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.follow_info","type":"object","properties":{"follower_indices":{"type":"array","items":{"$ref":"./ccr.follow_info.json#/$defs/ccr.follow_info__FollowerIndex"}}},"required":["follower_indices"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.follow_info","x-api":{"id":"ccr.follow_info","name":"follow-info","namespace":"ccr"},"type":"object","properties":{"follower_indices":{"type":"array","items":{"$ref":"./ccr.follow_info.json#/$defs/ccr.follow_info__FollowerIndex"}}},"required":["follower_indices"]}

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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.follow_stats","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.","x-api":{"id":"ccr.follow_stats","name":"follow-stats","namespace":"ccr"},"x-method":"GET","x-path":"/{index}/_ccr/stats","x-urls":[{"path":"/{index}/_ccr/stats","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"6.5.0","stability":"stable"}},"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"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.follow_stats","type":"object","properties":{"indices":{"type":"array","items":{"$ref":"./ccr._types.json#/$defs/ccr._types__FollowIndexStats"},"description":"An array of follower index statistics."}},"required":["indices"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.follow_stats","x-api":{"id":"ccr.follow_stats","name":"follow-stats","namespace":"ccr"},"type":"object","properties":{"indices":{"type":"array","items":{"$ref":"./ccr._types.json#/$defs/ccr._types__FollowIndexStats"},"description":"An array of follower index statistics."}},"required":["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":{"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"},"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.forget_follower","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.","x-api":{"id":"ccr.forget_follower","name":"forget-follower","namespace":"ccr"},"x-method":"POST","x-path":"/{index}/_ccr/forget_follower","x-urls":[{"path":"/{index}/_ccr/forget_follower","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"6.7.0","stability":"stable"}},"type":"object","properties":{"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"},"index":{"type":"string","description":"Name of the leader index for which specified follower retention leases should be removed","x-found-in":"path"}},"required":["index"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.forget_follower","type":"object","properties":{"_shards":{"$ref":"./_types.json#/$defs/_types__ShardStatistics"}},"required":["_shards"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.forget_follower","x-api":{"id":"ccr.forget_follower","name":"forget-follower","namespace":"ccr"},"type":"object","properties":{"_shards":{"$ref":"./_types.json#/$defs/_types__ShardStatistics"}},"required":["_shards"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"ccr.get_auto_follow_pattern__AutoFollowPattern":{"type":"object","properties":{"name":{"type":"string"},"pattern":{"$ref":"./ccr.get_auto_follow_pattern.json#/$defs/ccr.get_auto_follow_pattern__AutoFollowPatternSummary"}},"required":["name","pattern"]},"ccr.get_auto_follow_pattern__AutoFollowPatternSummary":{"type":"object","properties":{"active":{"type":"boolean"},"remote_cluster":{"type":"string","description":"The remote cluster containing the leader indices to match against."},"follow_index_pattern":{"type":"string","description":"The name of follower index."},"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."},"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."},"max_outstanding_read_requests":{"type":"number","description":"The maximum number of outstanding reads requests from the remote cluster."}},"required":["active","remote_cluster","leader_index_patterns","leader_index_exclusion_patterns","max_outstanding_read_requests"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"ccr.get_auto_follow_pattern__AutoFollowPattern":{"type":"object","properties":{"name":{"type":"string"},"pattern":{"$ref":"./ccr.get_auto_follow_pattern.json#/$defs/ccr.get_auto_follow_pattern__AutoFollowPatternSummary"}},"required":["name","pattern"]},"ccr.get_auto_follow_pattern__AutoFollowPatternSummary":{"type":"object","properties":{"active":{"type":"boolean"},"remote_cluster":{"type":"string","description":"The remote cluster containing the leader indices to match against."},"follow_index_pattern":{"type":"string","description":"The name of follower index."},"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."},"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.","x-availability":{"stack":{"since":"7.14.0"},"serverless":{}}},"max_outstanding_read_requests":{"type":"number","description":"The maximum number of outstanding reads requests from the remote cluster."}},"required":["active","remote_cluster","leader_index_patterns","leader_index_exclusion_patterns","max_outstanding_read_requests"]}}}

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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.get_auto_follow_pattern","description":"Get auto-follow patterns.\n\nGet cross-cluster replication auto-follow patterns.","x-api":{"id":"ccr.get_auto_follow_pattern","name":"get-auto-follow-pattern","namespace":"ccr"},"x-method":"GET","x-path":"/_ccr/auto_follow/{name}","x-urls":[{"path":"/_ccr/auto_follow","methods":["GET"]},{"path":"/_ccr/auto_follow/{name}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"6.5.0","stability":"stable"}},"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"}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.get_auto_follow_pattern","type":"object","properties":{"patterns":{"type":"array","items":{"$ref":"./ccr.get_auto_follow_pattern.json#/$defs/ccr.get_auto_follow_pattern__AutoFollowPattern"}}},"required":["patterns"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.get_auto_follow_pattern","x-api":{"id":"ccr.get_auto_follow_pattern","name":"get-auto-follow-pattern","namespace":"ccr"},"type":"object","properties":{"patterns":{"type":"array","items":{"$ref":"./ccr.get_auto_follow_pattern.json#/$defs/ccr.get_auto_follow_pattern__AutoFollowPattern"}}},"required":["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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.pause_auto_follow_pattern","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.","x-api":{"id":"ccr.pause_auto_follow_pattern","name":"pause-auto-follow-pattern","namespace":"ccr"},"x-method":"POST","x-path":"/_ccr/auto_follow/{name}/pause","x-urls":[{"path":"/_ccr/auto_follow/{name}/pause","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.5.0","stability":"stable"}},"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"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.pause_auto_follow_pattern","$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.pause_auto_follow_pattern","x-api":{"id":"ccr.pause_auto_follow_pattern","name":"pause-auto-follow-pattern","namespace":"ccr"},"$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}

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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ccr.pause_follow","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.","x-api":{"id":"ccr.pause_follow","name":"pause-follow","namespace":"ccr"},"x-method":"POST","x-path":"/{index}/_ccr/pause_follow","x-urls":[{"path":"/{index}/_ccr/pause_follow","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"6.5.0","stability":"stable"}},"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"]}