diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index b3ae287d4f..3c1cfe8bd3 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -1331,8 +1331,8 @@ }, "examples": { "CatHealthResponseExample1": { - "description": "A successful response from `GET /_cat/health?v=true`. By default, it returns `HH:MM:SS` and Unix epoch timestamps.\n", - "value": "epoch timestamp cluster status node.total node.data shards pri relo init unassign unassign.pri pending_tasks max_task_wait_time active_shards_percent\n1475871424 16:17:04 elasticsearch green 1 1 1 1 0 0 0 0 0 - 100.0%" + "description": "A successful response from `GET /_cat/health?v=true&format=json`. By default, it returns `HH:MM:SS` and Unix epoch timestamps.\n", + "value": "[\n {\n \"epoch\": \"1475871424\",\n \"timestamp\": \"16:17:04\",\n \"cluster\": \"elasticsearch\",\n \"status\": \"green\",\n \"node.total\": \"1\",\n \"node.data\": \"1\",\n \"shards\": \"1\",\n \"pri\": \"1\",\n \"relo\": \"0\",\n \"init\": \"0\",\n \"unassign\": \"0\",\n \"unassign.pri\": \"0\",\n \"pending_tasks\": \"0\",\n \"max_task_wait_time\": \"-\",\n \"active_shards_percent\": \"100.0%\"\n }\n]" } } } @@ -1517,8 +1517,8 @@ }, "examples": { "CatMasterResponseExample1": { - "description": "A successful response from `GET /_cat/master?v=true`.\n", - "value": "id host ip node\nYzWoH_2BT-6UjVGDyPdqYg 127.0.0.1 127.0.0.1 YzWoH_2" + "description": "A successful response from `GET /_cat/master?v=true&format=json`.\n", + "value": "[\n {\n \"id\": \"YzWoH_2BT-6UjVGDyPdqYg\",\n \"host\": \"127.0.0.1\",\n \"ip\": \"127.0.0.1\",\n \"node\": \"YzWoH_2\"\n }\n]" } } } @@ -1873,13 +1873,13 @@ "examples": { "CatNodeAttributesResponseExample1": { "summary": "Default columns", - "description": "A successful response from `GET /_cat/nodeattrs?v=true`. The `node`, `host`, and `ip` columns provide basic information about each node. The `attr` and `value` columns return custom node attributes, one per line.\n", - "value": "node host ip attr value\nnode-0 127.0.0.1 127.0.0.1 testattr test" + "description": "A successful response from `GET /_cat/nodeattrs?v=true&format=json`. The `node`, `host`, and `ip` columns provide basic information about each node. The `attr` and `value` columns return custom node attributes, one per line.\n", + "value": "[\n {\n \"node\": \"node-0\",\n \"host\": \"127.0.0.1\",\n \"ip\": \"127.0.0.1\",\n \"attr\": \"testattr\",\n \"value\": \"test\"\n }\n]" }, "CatNodeAttributesResponseExample2": { "summary": "Explicit columns", "description": "A successful response from `GET /_cat/nodeattrs?v=true&h=name,pid,attr,value`. It returns the `name`, `pid`, `attr`, and `value` columns.\n", - "value": "name pid attr value\nnode-0 19566 testattr test" + "value": "[\n {\n \"name\": \"node-0\",\n \"pid\": \"19566\",\n \"attr\": \"testattr\",\n \"value\": \"test\"\n }\n]" } } } @@ -1989,13 +1989,13 @@ "examples": { "CatNodesResponseExample1": { "summary": "Default columns", - "description": "A successful response from `GET /_cat/nodes?v=true`. The `ip`, `heap.percent`, `ram.percent`, `cpu`, and `load_*` columns provide the IP addresses and performance information of each node. The `node.role`, `master`, and `name` columns provide information useful for monitoring an entire cluster, particularly large ones.\n", - "value": "ip heap.percent ram.percent cpu load_1m load_5m load_15m node.role master name\n127.0.0.1 65 99 42 3.07 dim * mJw06l1" + "description": "A successful response from `GET /_cat/nodes?v=true&format=json`. The `ip`, `heap.percent`, `ram.percent`, `cpu`, and `load_*` columns provide the IP addresses and performance information of each node. The `node.role`, `master`, and `name` columns provide information useful for monitoring an entire cluster, particularly large ones.\n", + "value": "[\n {\n \"ip\": \"127.0.0.1\",\n \"heap.percent\": \"65\",\n \"ram.percent\": \"99\",\n \"cpu\": \"42\",\n \"load_1m\": \"3.07\",\n \"load_5m\": null,\n \"load_15m\": null,\n \"node.role\": \"cdfhilmrstw\",\n \"master\": \"*\",\n \"name\": \"mJw06l1\"\n }\n]" }, "CatNodesResponseExample2": { "summary": "Explicit columns", - "description": "A successful response from `GET /_cat/nodes?v=true&h=id,ip,port,v,m`. It returns the `id`, `ip`, `port`, `v` (version), and `m` (master) columns.\n", - "value": "id ip port v m\nveJR 127.0.0.1 59938 8.17.0 *" + "description": "A successful response from `GET /_cat/nodes?v=true&h=id,ip,port,v,m&format=json`. It returns the `id`, `ip`, `port`, `v` (version), and `m` (master) columns.\n", + "value": "[\n {\n \"id\": \"veJR\",\n \"ip\": \"127.0.0.1\",\n \"port\": \"59938\",\n \"v\": \"9.0.0\",\n \"m\": \"*\"\n }\n]" } } } @@ -2077,8 +2077,8 @@ }, "examples": { "CatPendingTasksResponseExample1": { - "description": "A successful response from `GET /_cat/pending_tasks?v=true`.\n", - "value": "insertOrder timeInQueue priority source\n 1685 855ms HIGH update-mapping [foo][t]\n 1686 843ms HIGH update-mapping [foo][t]\n 1693 753ms HIGH refresh-mapping [foo][[t]]\n 1688 816ms HIGH update-mapping [foo][t]\n 1689 802ms HIGH update-mapping [foo][t]\n 1690 787ms HIGH update-mapping [foo][t]\n 1691 773ms HIGH update-mapping [foo][t]" + "description": "A successful response from `GET /_cat/pending_tasks?v=trueh=insertOrder,timeInQueue,priority,source&format=json`.\n", + "value": "[\n { \"insertOrder\": \"1685\", \"timeInQueue\": \"855ms\", \"priority\": \"HIGH\", \"source\": \"update-mapping [foo][t]\"},\n { \"insertOrder\": \"1686\", \"timeInQueue\": \"843ms\", \"priority\": \"HIGH\", \"source\": \"update-mapping [foo][t]\"},\n { \"insertOrder\": \"1693\", \"timeInQueue\": \"753ms\", \"priority\": \"HIGH\", \"source\": \"refresh-mapping [foo][[t]]\"},\n { \"insertOrder\": \"1688\", \"timeInQueue\": \"816ms\", \"priority\": \"HIGH\", \"source\": \"update-mapping [foo][t]\"},\n { \"insertOrder\": \"1689\", \"timeInQueue\": \"802ms\", \"priority\": \"HIGH\", \"source\": \"update-mapping [foo][t]\"},\n { \"insertOrder\": \"1690\", \"timeInQueue\": \"787ms\", \"priority\": \"HIGH\", \"source\": \"update-mapping [foo][t]\"},\n { \"insertOrder\": \"1691\", \"timeInQueue\": \"773ms\", \"priority\": \"HIGH\", \"source\": \"update-mapping [foo][t]\"}\n]" } } } @@ -2160,8 +2160,8 @@ }, "examples": { "CatPluginsResponseExample1": { - "description": "A successful response from `GET /_cat/plugins?v=true&s=component&h=name,component,version,description`.\n", - "value": "name component version description\nU7321H6 analysis-icu 8.17.0 The ICU Analysis plugin integrates the Lucene ICU module into Elasticsearch, adding ICU-related analysis components.\nU7321H6 analysis-kuromoji 8.17.0 The Japanese (kuromoji) Analysis plugin integrates Lucene kuromoji analysis module into elasticsearch.\nU7321H6 analysis-nori 8.17.0 The Korean (nori) Analysis plugin integrates Lucene nori analysis module into elasticsearch.\nU7321H6 analysis-phonetic 8.17.0 The Phonetic Analysis plugin integrates phonetic token filter analysis with elasticsearch.\nU7321H6 analysis-smartcn 8.17.0 Smart Chinese Analysis plugin integrates Lucene Smart Chinese analysis module into elasticsearch.\nU7321H6 analysis-stempel 8.17.0 The Stempel (Polish) Analysis plugin integrates Lucene stempel (polish) analysis module into elasticsearch.\nU7321H6 analysis-ukrainian 8.17.0 The Ukrainian Analysis plugin integrates the Lucene UkrainianMorfologikAnalyzer into elasticsearch.\nU7321H6 discovery-azure-classic 8.17.0 The Azure Classic Discovery plugin allows to use Azure Classic API for the unicast discovery mechanism\nU7321H6 discovery-ec2 8.17.0 The EC2 discovery plugin allows to use AWS API for the unicast discovery mechanism.\nU7321H6 discovery-gce 8.17.0 The Google Compute Engine (GCE) Discovery plugin allows to use GCE API for the unicast discovery mechanism.\nU7321H6 mapper-annotated-text 8.17.0 The Mapper Annotated_text plugin adds support for text fields with markup used to inject annotation tokens into the index.\nU7321H6 mapper-murmur3 8.17.0 The Mapper Murmur3 plugin allows to compute hashes of a field's values at index-time and to store them in the index.\nU7321H6 mapper-size 8.17.0 The Mapper Size plugin allows document to record their uncompressed size at index time.\nU7321H6 store-smb 8.17.0 The Store SMB plugin adds support for SMB stores." + "description": "A successful response from `GET /_cat/plugins?v=true&s=component&h=name,component,version,description&format=json`.\n", + "value": "[\n { \"name\": \"U7321H6\", \"component\": \"analysis-icu\", \"version\": \"8.17.0\", \"description\": \"The ICU Analysis plugin integrates the Lucene ICU module into Elasticsearch, adding ICU-related analysis components.\"},\n {\"name\": \"U7321H6\", \"component\": \"analysis-kuromoji\", \"verison\": \"8.17.0\", description: \"The Japanese (kuromoji) Analysis plugin integrates Lucene kuromoji analysis module into elasticsearch.\"},\n {\"name\" \"U7321H6\", \"component\": \"analysis-nori\", \"version\": \"8.17.0\", \"description\": \"The Korean (nori) Analysis plugin integrates Lucene nori analysis module into elasticsearch.\"},\n {\"name\": \"U7321H6\", \"component\": \"analysis-phonetic\", \"verison\": \"8.17.0\", \"description\": \"The Phonetic Analysis plugin integrates phonetic token filter analysis with elasticsearch.\"},\n {\"name\": \"U7321H6\", \"component\": \"analysis-smartcn\", \"verison\": \"8.17.0\", \"description\": \"Smart Chinese Analysis plugin integrates Lucene Smart Chinese analysis module into elasticsearch.\"},\n {\"name\": \"U7321H6\", \"component\": \"analysis-stempel\", \"verison\": \"8.17.0\", \"description\": \"The Stempel (Polish) Analysis plugin integrates Lucene stempel (polish) analysis module into elasticsearch.\"},\n {\"name\": \"U7321H6\", \"component\": \"analysis-ukrainian\", \"verison\": \"8.17.0\", \"description\": \"The Ukrainian Analysis plugin integrates the Lucene UkrainianMorfologikAnalyzer into elasticsearch.\"},\n {\"name\": \"U7321H6\", \"component\": \"discovery-azure-classic\", \"verison\": \"8.17.0\", \"description\": \"The Azure Classic Discovery plugin allows to use Azure Classic API for the unicast discovery mechanism\"},\n {\"name\": \"U7321H6\", \"component\": \"discovery-ec2\", \"verison\": \"8.17.0\", \"description\": \"The EC2 discovery plugin allows to use AWS API for the unicast discovery mechanism.\"},\n {\"name\": \"U7321H6\", \"component\": \"discovery-gce\", \"verison\": \"8.17.0\", \"description\": \"The Google Compute Engine (GCE) Discovery plugin allows to use GCE API for the unicast discovery mechanism.\"},\n {\"name\": \"U7321H6\", \"component\": \"mapper-annotated-text\", \"verison\": \"8.17.0\", \"description\": \"The Mapper Annotated_text plugin adds support for text fields with markup used to inject annotation tokens into the index.\"},\n {\"name\": \"U7321H6\", \"component\": \"mapper-murmur3\", \"verison\": \"8.17.0\", \"description\": \"The Mapper Murmur3 plugin allows to compute hashes of a field's values at index-time and to store them in the index.\"},\n {\"name\": \"U7321H6\", \"component\": \"mapper-size\", \"verison\": \"8.17.0\", \"description\": \"The Mapper Size plugin allows document to record their uncompressed size at index time.\"},\n {\"name\": \"U7321H6\", \"component\": \"store-smb\", \"verison\": \"8.17.0\", \"description\": \"The Store SMB plugin adds support for SMB stores.\"}\n]" } } } @@ -2312,8 +2312,8 @@ }, "examples": { "CatRepositoriesResponseExample1": { - "description": "A successful response from `GET /_cat/repositories?v=true`.\n", - "value": "id type\nrepo1 fs\nrepo2 s3" + "description": "A successful response from `GET /_cat/repositories?v=true&format=json`.\n", + "value": "[\n {\n \"id\": \"repo1\",\n \"type\": \"fs\"\n },\n {\n \"id\": \"repo2\",\n \"type\": \"s3\"\n }\n]" } } } @@ -2645,8 +2645,8 @@ }, "examples": { "CatTasksResponseExample1": { - "description": "A successful response from `GET _cat/tasks?v=true`.", - "value": "action task_id parent_task_id type start_time timestamp running_time ip node\ncluster:monitor/tasks/lists[n] oTUltX4IQMOUUVeiohTt8A:124 oTUltX4IQMOUUVeiohTt8A:123 direct 1458585884904 01:48:24 44.1micros 127.0.0.1:9300 oTUltX4IQMOUUVeiohTt8A\ncluster:monitor/tasks/lists oTUltX4IQMOUUVeiohTt8A:123 - transport 1458585884904 01:48:24 186.2micros 127.0.0.1:9300 oTUltX4IQMOUUVeiohTt8A" + "description": "A successful response from `GET _cat/tasks?v=true&format=json`.", + "value": "[\n {\n \"action\": \"cluster:monitor/tasks/lists[n]\",\n \"task_id\": \"oTUltX4IQMOUUVeiohTt8A:124\",\n \"parent_task_id\": \"oTUltX4IQMOUUVeiohTt8A:123\",\n \"type\": \"direct\",\n \"start_time\": \"1458585884904\",\n \"timestamp\": \"01:48:24\",\n \"running_time\": \"44.1micros\",\n \"ip\": \"127.0.0.1:9300\",\n \"node\": \"oTUltX4IQMOUUVeiohTt8A\"\n },\n {\n \"action\": \"cluster:monitor/tasks/lists\",\n \"task_id\": \"oTUltX4IQMOUUVeiohTt8A:123\",\n \"parent_task_id\": \"-\",\n \"type\": \"transport\",\n \"start_time\": \"1458585884904\",\n \"timestamp\": \"01:48:24\",\n \"running_time\": \"186.2micros\",\n \"ip\": \"127.0.0.1:9300\",\n \"node\": \"oTUltX4IQMOUUVeiohTt8A\"\n }\n]" } } } @@ -99437,8 +99437,8 @@ }, "examples": { "CatAliasesResponseExample1": { - "description": "A successful response from `GET _cat/aliases?v=true`. This response shows that `alias2` has configured a filter and `alias3` and `alias4` have routing configurations.\n", - "value": "alias index filter routing.index routing.search is_write_index\nalias1 test1 - - - -\nalias2 test1 * - - -\nalias3 test1 - 1 1 -\nalias4 test1 - 2 1,2 -" + "description": "A successful response from `GET _cat/aliases?format=json&v=true`. This response shows that `alias2` has configured a filter and `alias3` and `alias4` have routing configurations.\n", + "value": "[\n {\n \"alias\": \"alias1\",\n \"index\": \"test1\",\n \"filter\": \"-\",\n \"routing.index\": \"-\",\n \"routing.search\": \"-\",\n \"is_write_index\": \"true\"\n },\n {\n \"alias\": \"alias1\",\n \"index\": \"test1\",\n \"filter\": \"*\",\n \"routing.index\": \"-\",\n \"routing.search\": \"-\",\n \"is_write_index\": \"true\"\n },\n {\n \"alias\": \"alias3\",\n \"index\": \"test1\",\n \"filter\": \"-\",\n \"routing.index\": \"1\",\n \"routing.search\": \"1\",\n \"is_write_index\": \"true\"\n },\n {\n \"alias\": \"alias4\",\n \"index\": \"test1\",\n \"filter\": \"-\",\n \"routing.index\": \"2\",\n \"routing.search\": \"1,2\",\n \"is_write_index\": \"true\"\n }\n]" } } } @@ -99456,8 +99456,8 @@ }, "examples": { "CatAllocationResponseExample1": { - "description": "A successful response from `GET /_cat/allocation?v=true`. It shows a single shard is allocated to the one node available.\n", - "value": "shards shards.undesired write_load.forecast disk.indices.forecast disk.indices disk.used disk.avail disk.total disk.percent host ip node node.role\n 1 0 0.0 260b 260b 47.3gb 43.4gb 100.7gb 46 127.0.0.1 127.0.0.1 CSUXak2 himrst" + "description": "A successful response from `GET /_cat/allocation?v=true&format=json`. It shows a single shard is allocated to the one node available.\n", + "value": "[\n {\n \"shards\": \"1\",\n \"shards.undesired\": \"0\",\n \"write_load.forecast\": \"0.0\",\n \"disk.indices.forecast\": \"260b\",\n \"disk.indices\": \"260b\",\n \"disk.used\": \"47.3gb\",\n \"disk.avail\": \"43.4gb\",\n \"disk.total\": \"100.7gb\",\n \"disk.percent\": \"46\",\n \"host\": \"127.0.0.1\",\n \"ip\": \"127.0.0.1\",\n \"node\": \"CSUXak2\",\n \"node.role\": \"himrst\"\n }\n]" } } } @@ -99475,8 +99475,8 @@ }, "examples": { "CatComponentTemplatesResponseExample1": { - "description": "A successful response from `GET _cat/aliases?v=true`. This response shows that `alias2` has configured a filter and `alias3` and `alias4` have routing configurations.\n", - "value": "alias index filter routing.index routing.search is_write_index\nalias1 test1 - - - -\nalias2 test1 * - - -\nalias3 test1 - 1 1 -\nalias4 test1 - 2 1,2 -" + "description": "A successful response from `GET _cat/component_templates/my-template-*?v=true&s=name&format=json`.\n", + "value": "[\n {\n \"name\": \"my-template-1\",\n \"version\": \"null\",\n \"alias_count\": \"0\",\n \"mapping_count\": \"0\",\n \"settings_count\": \"1\",\n \"metadata_count\": \"0\",\n \"included_in\": \"[my-index-template]\"\n },\n {\n \"name\": \"my-template-2\",\n \"version\": null,\n \"alias_count\": \"0\",\n \"mapping_count\": \"3\",\n \"settings_count\": \"0\",\n \"metadata_count\": \"0\",\n \"included_in\": \"[my-index-template]\"\n }\n]" } } } @@ -99495,13 +99495,13 @@ "examples": { "CatCountResponseExample1": { "summary": "Single data stream or index count", - "description": "A successful response from `GET /_cat/count/my-index-000001?v=true`. It retrieves the document count for the `my-index-000001` data stream or index.\n", - "value": "epoch timestamp count\n1475868259 15:24:20 120" + "description": "A successful response from `GET /_cat/count/my-index-000001?v=true&format=json`. It retrieves the document count for the `my-index-000001` data stream or index.\n", + "value": "[\n {\n \"epoch\": \"1475868259\",\n \"timestamp\": \"15:24:20\",\n \"count\": \"120\"\n }\n]" }, "CatCountResponseExample2": { "summary": "All data streams and indices count", - "description": "A successful response from `GET /_cat/count?v=true`. It retrieves the document count for all data streams and indices in the cluster.\n", - "value": "epoch timestamp count\n1475868259 15:24:20 121" + "description": "A successful response from `GET /_cat/count?v=true&format=json`. It retrieves the document count for all data streams and indices in the cluster.\n", + "value": "[\n {\n \"epoch\": \"1475868259\",\n \"timestamp\": \"15:24:20\",\n \"count\": \"121\"\n }\n]" } } } @@ -99520,13 +99520,13 @@ "examples": { "CatFielddataResponseExample1": { "summary": "Single field data", - "description": "A successful response from `GET /_cat/fielddata?v=true&fields=body`. You can specify an individual field in the request body or URL path. This example retrieves heap memory size information for the `body` field.\n", - "value": "id host ip node field size\nNqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in body 544b" + "description": "A successful response from `GET /_cat/fielddata?v=true&fields=body&format=json`. You can specify an individual field in the request body or URL path. This example retrieves heap memory size information for the `body` field.\n", + "value": "[\n {\n \"id\": \"Nqk-6inXQq-OxUfOUI8jNQ\",\n \"host\": \"127.0.0.1\",\n \"ip\": \"127.0.0.1\",\n \"node\": \"Nqk-6in\",\n \"field\": \"body\",\n \"size\": \"544b\"\n }\n]" }, "CatFielddataResponseExample2": { "summary": "Multiple fields data", - "description": "A successful response from `GET /_cat/fielddata/body,soul?v=true`. You can specify a comma-separated list of fields in the request body or URL path. This example retrieves heap memory size information for the `body` and `soul` fields. To get information for all fields, run `GET /_cat/fielddata?v=true`.\n", - "value": "id host ip node field size\nNqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in body 544b\nNqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in soul 480b" + "description": "A successful response from `GET /_cat/fielddata/body,soul?v=true&format=json`. You can specify a comma-separated list of fields in the request body or URL path. This example retrieves heap memory size information for the `body` and `soul` fields. To get information for all fields, run `GET /_cat/fielddata?v=true`.\n", + "value": "[\n {\n \"id\": \"Nqk-6inXQq-OxUfOUI8jNQ\",\n \"host\": \"1127.0.0.1\",\n \"ip\": \"127.0.0.1\",\n \"node\": \"Nqk-6in\",\n \"field\": \"body\",\n \"size\": \"544b\"\n },\n {\n \"id\": \"Nqk-6inXQq-OxUfOUI8jNQ\",\n \"host\": \"127.0.0.1\",\n \"ip\": \"127.0.0.1\",\n \"node\": \"Nqk-6in\",\n \"field\": \"soul\",\n \"size\": \"480b\"\n }\n]" } } } @@ -99544,8 +99544,8 @@ }, "examples": { "CatIndicesResponseExample1": { - "description": "A successful response from `GET /_cat/indices/my-index-*?v=true&s=index`.\n", - "value": "health status index uuid pri rep docs.count docs.deleted store.size pri.store.size dataset.size\nyellow open my-index-000001 u8FNjxh8Rfy_awN11oDKYQ 1 1 1200 0 88.1kb 88.1kb 88.1kb\ngreen open my-index-000002 nYFWZEO7TUiOjLQXBaYJpA 1 0 0 0 260b 260b 260b" + "description": "A successful response from `GET /_cat/indices/my-index-*?v=true&s=index&format=json`.\n", + "value": "[\n {\n \"health\": \"yellow\",\n \"status\": \"open\",\n \"index\": \"my-index-000001\",\n \"uuid\": \"u8FNjxh8Rfy_awN11oDKYQ\",\n \"pri\": \"1\",\n \"rep\": \"1\",\n \"docs.count\": \"1200\",\n \"docs.deleted\": \"0\",\n \"store.size\": \"88.1kb\",\n \"pri.store.size\": \"88.1kb\",\n \"dataset.size\": \"88.1kb\"\n },\n {\n \"health\": \"green\",\n \"status\": \"open\",\n \"index\": \"my-index-000002\",\n \"uuid\": \"nYFWZEO7TUiOjLQXBaYJpA \",\n \"pri\": \"1\",\n \"rep\": \"0\",\n \"docs.count\": \"0\",\n \"docs.deleted\": \"0\",\n \"store.size\": \"260b\",\n \"pri.store.size\": \"260b\",\n \"dataset.size\": \"260b\"\n }\n]" } } } @@ -99563,8 +99563,8 @@ }, "examples": { "CatDataframeanalyticsResponseExample1": { - "description": "A successful response from `GET _cat/ml/data_frame/analytics?v=true`.", - "value": "id create_time type state\nclassifier_job_1 2020-02-12T11:49:09.594Z classification stopped\nclassifier_job_2 2020-02-12T11:49:14.479Z classification stopped\nclassifier_job_3 2020-02-12T11:49:16.928Z classification stopped\nclassifier_job_4 2020-02-12T11:49:19.127Z classification stopped\nclassifier_job_5 2020-02-12T11:49:21.349Z classification stopped" + "description": "A successful response from `GET _cat/ml/data_frame/analytics?v=true&format=json`.", + "value": "[\n {\n \"id\": \"classifier_job_1\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:09.594Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_2\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:14.479Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_3\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:16.928Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_4\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:19.127Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_5\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:21.349Z\",\n \"state\": \"stopped\"\n }\n]" } } } @@ -99582,8 +99582,8 @@ }, "examples": { "CatDatafeedsResponseExample1": { - "description": "A successful response from `GET _cat/ml/datafeeds?v=true`.", - "value": "id state buckets.count search.count\ndatafeed-high_sum_total_sales stopped 743 7\ndatafeed-low_request_rate stopped 1457 3\ndatafeed-response_code_rates stopped 1460 18\ndatafeed-url_scanning stopped 1460 18" + "description": "A successful response from `GET _cat/ml/datafeeds?v=true&format=json`.", + "value": "[\n {\n \"id\": \"datafeed-high_sum_total_sales\",\n \"state\": \"stopped\",\n \"buckets.count\": \"743\",\n \"search.count\": \"7\"\n },\n {\n \"id\": \"datafeed-low_request_rate\",\n \"state\": \"stopped\",\n \"buckets.count\": \"1457\",\n \"search.count\": \"3\"\n },\n {\n \"id\": \"datafeed-response_code_rates\",\n \"state\": \"stopped\",\n \"buckets.count\": \"1460\",\n \"search.count\": \"18\"\n },\n {\n \"id\": \"datafeed-url_scanning\",\n \"state\": \"stopped\",\n \"buckets.count\": \"1460\",\n \"search.count\": \"18\"\n }\n]" } } } @@ -99601,8 +99601,8 @@ }, "examples": { "CatJobsResponseExample1": { - "description": "A succesful response from `GET _cat/component_templates/my-template-*?v=true&s=name`.", - "value": "name version alias_count mapping_count settings_count metadata_count included_in\nmy-template-1 0 0 1 0 [my-index-template]\nmy-template-2 0 3 0 0 [my-index-template]" + "description": "A successful response from `GET _cat/ml/anomaly_detectors?h=id,s,dpr,mb&v=true&format=json`.", + "value": "[\n {\n \"id\": \"high_sum_total_sales\",\n \"s\": \"closed\",\n \"dpr\": \"14022\",\n \"mb\": \"1.5mb\"\n },\n {\n \"id\": \"low_request_rate\",\n \"s\": \"closed\",\n \"dpr\": \"1216\",\n \"mb\": \"40.5kb\"\n },\n {\n \"id\": \"response_code_rates\",\n \"s\": \"closed\",\n \"dpr\": \"28146\",\n \"mb\": \"132.7kb\"\n },\n {\n \"id\": \"url_scanning\",\n \"s\": \"closed\",\n \"dpr\": \"28146\",\n \"mb\": \"501.6kb\"\n }\n]" } } } @@ -99620,8 +99620,8 @@ }, "examples": { "CatTrainedModelsResponseExample1": { - "description": "A successful response from `GET _cat/ml/trained_models?h=c,o,l,ct,v&v=true`.", - "value": "id created_by operations license create_time version\nddddd-1580216177138 _xpack 196 PLATINUM 2020-01-28T12:56:17.138Z 8.0.0\nflight-regress-1580215685537 _xpack 102 PLATINUM 2020-01-28T12:48:05.537Z 8.0.0\nlang_ident_model_1 _xpack 39629 BASIC 2019-12-05T12:28:34.594Z 7.6.0" + "description": "A successful response from `GET _cat/ml/trained_models?v=true&format=json`.", + "value": "[\n {\n \"id\": \"ddddd-1580216177138\",\n \"heap_size\": \"0b\",\n \"operations\": \"196\",\n \"create_time\": \"2025-03-25T00:01:38.662Z\",\n \"type\": \"pytorch\",\n \"ingest.pipelines\": \"0\",\n \"data_frame.id\": \"__none__\"\n },\n {\n \"id\": \"lang_ident_model_1\",\n \"heap_size\": \"1mb\",\n \"operations\": \"39629\",\n \"create_time\": \"2019-12-05T12:28:34.594Z\",\n \"type\": \"lang_ident\",\n \"ingest.pipelines\": \"0\",\n \"data_frame.id\": \"__none__\"\n }\n]" } } } @@ -99640,18 +99640,18 @@ "examples": { "CatRecoveryResponseExample1": { "summary": "No ongoing recoveries", - "description": "A successful response from `GET _cat/recovery?v=true`. In this example, the source and target nodes are the same because the recovery type is `store`, meaning they were read from local storage on node start.\n", - "value": "index shard time type stage source_host source_node target_host target_node repository snapshot files files_recovered files_percent files_total bytes bytes_recovered bytes_percent bytes_total translog_ops translog_ops_recovered translog_ops_percent\nmy-index-000001 0 13ms store done n/a n/a 127.0.0.1 node-0 n/a n/a 0 0 100% 13 0b 0b 100% 9928b 0 0 100.0%" + "description": "A successful response from `GET _cat/recovery?v=true&format=json`. In this example, the source and target nodes are the same because the recovery type is `store`, meaning they were read from local storage on node start.\n", + "value": "[\n {\n \"index\": \"my-index-000001 \",\n \"shard\": \"0\",\n \"time\": \"13ms\",\n \"type\": \"store\",\n \"stage\": \"done\",\n \"source_host\": \"n/a\",\n \"source_node\": \"n/a\",\n \"target_host\": \"127.0.0.1\",\n \"target_node\": \"node-0\",\n \"repository\": \"n/a\",\n \"snapshot\": \"n/a\",\n \"files\": \"0\",\n \"files_recovered\": \"0\",\n \"files_percent\": \"100.0%\",\n \"files_total\": \"13\",\n \"bytes\": \"0b\",\n \"bytes_recovered\": \"0b\",\n \"bytes_percent\": \"100.0%\",\n \"bytes_total\": \"9928b\",\n \"translog_ops\": \"0\",\n \"translog_ops_recovered\": \"0\",\n \"translog_ops_percent\": \"100.0%\"\n }\n]" }, "CatRecoveryResponseExample2": { "summary": "A live shard recovery", - "description": "A successful response from `GET _cat/recovery?v=true&h=i,s,t,ty,st,shost,thost,f,fp,b,bp`. You can retrieve information about an ongoing recovery for example when you increase the replica count of an index and bring another node online to host the replicas. In this example, the recovery type is `peer`, meaning the shard recovered from another node. The `files` and `bytes` are real-time measurements.\n", - "value": "i s t ty st shost thost f fp b bp\nmy-index-000001 0 1252ms peer done 192.168.1.1 192.168.1.2 0 100.0% 0b 100.0%" + "description": "A successful response from `GET _cat/recovery?v=true&h=i,s,t,ty,st,shost,thost,f,fp,b,bp&format=json`. You can retrieve information about an ongoing recovery for example when you increase the replica count of an index and bring another node online to host the replicas. In this example, the recovery type is `peer`, meaning the shard recovered from another node. The `files` and `bytes` are real-time measurements.\n", + "value": "[\n {\n \"i\": \"my-index-000001\",\n \"s\": \"0\",\n \"t\": \"1252ms\",\n \"ty\": \"peer\",\n \"st\": \"done\",\n \"shost\": \"192.168.1.1\",\n \"thost\": \"192.168.1.1\",\n \"f\": \"0\",\n \"fp\": \"100.0%\",\n \"b\": \"0b\",\n \"bp\": \"100.0%\",\n }\n]" }, "CatRecoveryResponseExample3": { "summary": "A snapshot recovery", - "description": "A successful response from `GET _cat/recovery?v=true&h=i,s,t,ty,st,rep,snap,f,fp,b,bp`. You can restore backups of an index using the snapshot and restore API. You can use the cat recovery API to get information about a snapshot recovery.\n", - "value": "i s t ty st rep snap f fp b bp\nmy-index-000001 0 1978ms snapshot done my-repo snap-1 79 8.0% 12086 9.0%" + "description": "A successful response from `GET _cat/recovery?v=true&h=i,s,t,ty,st,rep,snap,f,fp,b,bp&format=json`. You can restore backups of an index using the snapshot and restore API. You can use the cat recovery API to get information about a snapshot recovery.\n", + "value": "[\n {\n \"i\": \"my-index-000001\",\n \"s\": \"0\",\n \"t\": \"1978ms\",\n \"ty\": \"snapshot\",\n \"st\": \"done\",\n \"rep\": \"my-repo\",\n \"snap\": \"snap-1\",\n \"f\": \"79\",\n \"fp\": \"8.0%\",\n \"b\": \"12086\",\n \"bp\": \"9.0%\"\n }\n]" } } } @@ -99669,8 +99669,8 @@ }, "examples": { "CatSegmentsResponseExample1": { - "description": "A successful response from `GET /_cat/segments?v=true`.\n", - "value": "index shard prirep ip segment generation docs.count docs.deleted size size.memory committed searchable version compound\ntest 0 p 127.0.0.1 _0 0 1 0 3kb 0 false true 9.12.0 true\ntest1 0 p 127.0.0.1 _0 0 1 0 3kb 0 false true 9.12.0 true" + "description": "A successful response from `GET /_cat/segments?v=true&format=json`.\n", + "value": "[\n {\n \"index\": \"test\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"ip\": \"127.0.0.1\",\n \"segment\": \"_0\",\n \"generation\": \"0\",\n \"docs.count\": \"1\",\n \"docs.deleted\": \"0\",\n \"size\": \"3kb\",\n \"size.memory\": \"0\",\n \"committed\": \"false\",\n \"searchable\": \"true\",\n \"version\": \"9.12.0\",\n \"compound\": \"true\"\n },\n {\n \"index\": \"test1\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"ip\": \"127.0.0.1\",\n \"segment\": \"_0\",\n \"generation\": \"0\",\n \"docs.count\": \"1\",\n \"docs.deleted\": \"0\",\n \"size\": \"3kb\",\n \"size.memory\": \"0\",\n \"committed\": \"false\",\n \"searchable\": \"true\",\n \"version\": \"9.12.0\",\n \"compound\": \"true\"\n }\n]" } } } @@ -99689,28 +99689,28 @@ "examples": { "CatShardsResponseExample1": { "summary": "A single data stream or index", - "description": "A successful response from `GET _cat/shards`.\n", - "value": "my-index-000001 0 p STARTED 3014 31.1mb 192.168.56.10 H5dfFeA" + "description": "A successful response from `GET _cat/shards?format=json`.\n", + "value": "[\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"state\": \"STARTED\",\n \"docs\": \"3014\",\n \"store\": \"31.1mb\",\n \"dataset\": \"249b\",\n \"ip\": \"192.168.56.10\",\n \"node\": \"H5dfFeA\"\n }\n]" }, "CatShardsResponseExample2": { "summary": "A wildcard pattern", - "description": "A successful response from `GET _cat/shards/my-index-*`. It returns information for any data streams or indices beginning with `my-index-`.\n", - "value": "my-index-000001 0 p STARTED 3014 31.1mb 192.168.56.10 H5dfFeA" + "description": "A successful response from `GET _cat/shards/my-index-*?format=json`. It returns information for any data streams or indices beginning with `my-index-`.\n", + "value": "[\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"state\": \"STARTED\",\n \"docs\": \"3014\",\n \"store\": \"31.1mb\",\n \"dataset\": \"249b\",\n \"ip\": \"192.168.56.10\",\n \"node\": \"H5dfFeA\"\n }\n]" }, "CatShardsResponseExample3": { "summary": "A relocating shard", - "description": "A successful response from `GET _cat/shards`. The `RELOCATING` value in the `state` column indicates the index shard is relocating.\n", - "value": "my-index-000001 0 p RELOCATING 3014 31.1mb 192.168.56.10 H5dfFeA -> -> 192.168.56.30 bGG90GE" + "description": "A successful response from `GET _cat/shards?format=json`. The `RELOCATING` value in the `state` column indicates the index shard is relocating.\n", + "value": "[\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"state\": \"RELOCATING\",\n \"docs\": \"3014\",\n \"store\": \"31.1mb\",\n \"dataset\": \"249b\",\n \"ip\": \"192.168.56.10\",\n \"node\": \"H5dfFeA -> -> 192.168.56.30 bGG90GE\"\n }\n]" }, "CatShardsResponseExample4": { "summary": "Shard states", - "description": "A successful response from `GET _cat/shards`. Before a shard is available for use, it goes through an `INITIALIZING` state. You can use the cat shards API to see which shards are initializing.\n", - "value": "my-index-000001 0 p STARTED 3014 31.1mb 192.168.56.10 H5dfFeA\nmy-index-000001 0 r INITIALIZING 0 14.3mb 192.168.56.30 bGG90GE" + "description": "A successful response from `GET _cat/shards?format=json`. Before a shard is available for use, it goes through an `INITIALIZING` state. You can use the cat shards API to see which shards are initializing.\n", + "value": "[\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"state\": \"STARTED\",\n \"docs\": \"3014\",\n \"store\": \"31.1mb\",\n \"dataset\": \"249b\",\n \"ip\": \"192.168.56.10\",\n \"node\": \"H5dfFeA\"\n },\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"r\",\n \"state\": \"INITIALIZING\",\n \"docs\": \"0\",\n \"store\": \"14.3mb\",\n \"dataset\": \"249b\",\n \"ip\": \"192.168.56.30\",\n \"node\": \"bGG90GE\"\n }\n]" }, "CatShardsResponseExample5": { "summary": "Reasons for unassigned shards", - "description": "A successful response from `GET _cat/shards?h=index,shard,prirep,state,unassigned.reason`. It includes the `unassigned.reason` column, which indicates why a shard is unassigned.\n", - "value": "my-index-000001 0 p STARTED 3014 31.1mb 192.168.56.10 H5dfFeA\nmy-index-000001 0 r STARTED 3014 31.1mb 192.168.56.30 bGG90GE\nmy-index-000001 0 r STARTED 3014 31.1mb 192.168.56.20 I8hydUG\nmy-index-000001 0 r UNASSIGNED ALLOCATION_FAILED" + "description": "A successful response from `GET _cat/shards?h=index,shard,prirep,state,unassigned.reason&format=json`. It includes the `unassigned.reason` column, which indicates why a shard is unassigned.\n", + "value": "[\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"state\": \"STARTED\",\n \"unassigned.reason\": \"3014 31.1mb 192.168.56.10 H5dfFeA\"\n },\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"r\",\n \"state\": \"STARTED\",\n \"unassigned.reason\": \"3014 31.1mb 192.168.56.30 bGG90GE\"\n },\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"r\",\n \"state\": \"STARTED\",\n \"unassigned.reason\": \"3014 31.1mb 192.168.56.20 I8hydUG\"\n },\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"r\",\n \"state\": \"UNASSIGNED\",\n \"unassigned.reason\": \"ALLOCATION_FAILED\"\n }\n]" } } } @@ -99728,8 +99728,8 @@ }, "examples": { "CatSnapshotsResponseExample1": { - "description": "A successful response from `GET /_cat/snapshots/repo1?v=true&s=id`.\n", - "value": "id repository status start_epoch start_time end_epoch end_time duration indices successful_shards failed_shards total_shards\nsnap1 repo1 FAILED 1445616705 18:11:45 1445616978 18:16:18 4.6m 1 4 1 5\nsnap2 repo1 SUCCESS 1445634298 23:04:58 1445634672 23:11:12 6.2m 2 10 0 10" + "description": "A successful response from `GET /_cat/snapshots/repo1?v=true&s=id&format=json`.\n", + "value": "[\n {\n \"id\": \"snap1\",\n \"repository\": \"repo1\",\n \"status\": \"FAILED\",\n \"start_epoch\": \"1445616705\",\n \"start_time\": \"18:11:45\",\n \"end_epoch\": \"1445616978\",\n \"end_time\": \"18:16:18\",\n \"duration\": \"4.6m\",\n \"indices\": \"1\",\n \"successful_shards\": \"4\",\n \"failed_shards\": \"1\",\n \"total_shards\": \"5\"\n },\n {\n \"id\": \"snap2\",\n \"repository\": \"repo1\",\n \"status\": \"SUCCESS\",\n \"start_epoch\": \"1445634298\",\n \"start_time\": \"23:04:58\",\n \"end_epoch\": \"1445634672\",\n \"end_time\": \"23:11:12\",\n \"duration\": \"6.2m\",\n \"indices\": \"2\",\n \"successful_shards\": \"10\",\n \"failed_shards\": \"0\",\n \"total_shards\": \"10\"\n }\n]" } } } @@ -99747,8 +99747,8 @@ }, "examples": { "CatTemplatesResponseExample1": { - "description": "A successful response from `GET _cat/templates/my-template-*?v=true&s=name`.\n", - "value": "name index_patterns order version composed_of\nmy-template-0 [te*] 500 []\nmy-template-1 [tea*] 501 []\nmy-template-2 [teak*] 502 7 []" + "description": "A successful response from `GET _cat/templates/my-template-*?v=true&s=name&format=json`.\n", + "value": "[\n {\n \"name\": \"my-template-0\",\n \"index_patterns\": \"[te*]\",\n \"order\": \"500\",\n \"version\": null,\n \"composed_of\": \"[]\"\n },\n {\n \"name\": \"my-template-1\",\n \"index_patterns\": \"[tea*]\",\n \"order\": \"501\",\n \"version\": null,\n \"composed_of\": \"[]\"\n },\n {\n \"name\": \"my-template-2\",\n \"index_patterns\": \"[teak*]\",\n \"order\": \"502\",\n \"version\": \"7\",\n \"composed_of\": \"[]\"\n }\n]" } } } @@ -99767,13 +99767,13 @@ "examples": { "CatThreadPoolResponseExample1": { "summary": "Default columns", - "description": "A successful response from `GET /_cat/thread_pool`.\n", - "value": "node-0 analyze 0 0 0\nnode-0 fetch_shard_started 0 0 0\nnode-0 fetch_shard_store 0 0 0\nnode-0 flush 0 0 0\nnode-0 write 0 0 0" + "description": "A successful response from `GET /_cat/thread_pool?format=json`.\n", + "value": "[\n {\n \"node_name\": \"node-0\",\n \"name\": \"analyze\",\n \"active\": \"0\",\n \"queue\": \"0\",\n \"rejected\": \"0\"\n },\n {\n \"node_name\": \"node-0\",\n \"name\": \"fetch_shard_started\",\n \"active\": \"0\",\n \"queue\": \"0\",\n \"rejected\": \"0\"\n },\n {\n \"node_name\": \"node-0\",\n \"name\": \"fetch_shard_store\",\n \"active\": \"0\",\n \"queue\": \"0\",\n \"rejected\": \"0\"\n },\n {\n \"node_name\": \"node-0\",\n \"name\": \"flush\",\n \"active\": \"0\",\n \"queue\": \"0\",\n \"rejected\": \"0\"\n },\n {\n \"node_name\": \"node-0\",\n \"name\": \"write\",\n \"active\": \"0\",\n \"queue\": \"0\",\n \"rejected\": \"0\"\n }\n]" }, "CatThreadPoolResponseExample2": { "summary": "Explicit columns", - "description": "A successful response from `GET /_cat/thread_pool/generic?v=true&h=id,name,active,rejected,completed`. It returns the `id`, `name`, `active`, `rejected`, and `completed` columns. It also limits returned information to the generic thread pool.\n", - "value": "id name active rejected completed\n0EWUhXeBQtaVGlexUeVwMg generic 0 0 70" + "description": "A successful response from `GET /_cat/thread_pool/generic?v=true&h=id,name,active,rejected,completed&format=json`. It returns the `id`, `name`, `active`, `rejected`, and `completed` columns. It also limits returned information to the generic thread pool.\n", + "value": "[\n {\n \"id\": \"0EWUhXeBQtaVGlexUeVwMg\",\n \"name\": \"generic\",\n \"active\": \"0\",\n \"rejected\": \"0\",\n \"completed\": \"70\"\n }\n]" } } } diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index ab8986a659..d9cc376161 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -59931,8 +59931,8 @@ }, "examples": { "CatAliasesResponseExample1": { - "description": "A successful response from `GET _cat/aliases?v=true`. This response shows that `alias2` has configured a filter and `alias3` and `alias4` have routing configurations.\n", - "value": "alias index filter routing.index routing.search is_write_index\nalias1 test1 - - - -\nalias2 test1 * - - -\nalias3 test1 - 1 1 -\nalias4 test1 - 2 1,2 -" + "description": "A successful response from `GET _cat/aliases?format=json&v=true`. This response shows that `alias2` has configured a filter and `alias3` and `alias4` have routing configurations.\n", + "value": "[\n {\n \"alias\": \"alias1\",\n \"index\": \"test1\",\n \"filter\": \"-\",\n \"routing.index\": \"-\",\n \"routing.search\": \"-\",\n \"is_write_index\": \"true\"\n },\n {\n \"alias\": \"alias1\",\n \"index\": \"test1\",\n \"filter\": \"*\",\n \"routing.index\": \"-\",\n \"routing.search\": \"-\",\n \"is_write_index\": \"true\"\n },\n {\n \"alias\": \"alias3\",\n \"index\": \"test1\",\n \"filter\": \"-\",\n \"routing.index\": \"1\",\n \"routing.search\": \"1\",\n \"is_write_index\": \"true\"\n },\n {\n \"alias\": \"alias4\",\n \"index\": \"test1\",\n \"filter\": \"-\",\n \"routing.index\": \"2\",\n \"routing.search\": \"1,2\",\n \"is_write_index\": \"true\"\n }\n]" } } } @@ -59950,8 +59950,8 @@ }, "examples": { "CatComponentTemplatesResponseExample1": { - "description": "A successful response from `GET _cat/aliases?v=true`. This response shows that `alias2` has configured a filter and `alias3` and `alias4` have routing configurations.\n", - "value": "alias index filter routing.index routing.search is_write_index\nalias1 test1 - - - -\nalias2 test1 * - - -\nalias3 test1 - 1 1 -\nalias4 test1 - 2 1,2 -" + "description": "A successful response from `GET _cat/component_templates/my-template-*?v=true&s=name&format=json`.\n", + "value": "[\n {\n \"name\": \"my-template-1\",\n \"version\": \"null\",\n \"alias_count\": \"0\",\n \"mapping_count\": \"0\",\n \"settings_count\": \"1\",\n \"metadata_count\": \"0\",\n \"included_in\": \"[my-index-template]\"\n },\n {\n \"name\": \"my-template-2\",\n \"version\": null,\n \"alias_count\": \"0\",\n \"mapping_count\": \"3\",\n \"settings_count\": \"0\",\n \"metadata_count\": \"0\",\n \"included_in\": \"[my-index-template]\"\n }\n]" } } } @@ -59970,13 +59970,13 @@ "examples": { "CatCountResponseExample1": { "summary": "Single data stream or index count", - "description": "A successful response from `GET /_cat/count/my-index-000001?v=true`. It retrieves the document count for the `my-index-000001` data stream or index.\n", - "value": "epoch timestamp count\n1475868259 15:24:20 120" + "description": "A successful response from `GET /_cat/count/my-index-000001?v=true&format=json`. It retrieves the document count for the `my-index-000001` data stream or index.\n", + "value": "[\n {\n \"epoch\": \"1475868259\",\n \"timestamp\": \"15:24:20\",\n \"count\": \"120\"\n }\n]" }, "CatCountResponseExample2": { "summary": "All data streams and indices count", - "description": "A successful response from `GET /_cat/count?v=true`. It retrieves the document count for all data streams and indices in the cluster.\n", - "value": "epoch timestamp count\n1475868259 15:24:20 121" + "description": "A successful response from `GET /_cat/count?v=true&format=json`. It retrieves the document count for all data streams and indices in the cluster.\n", + "value": "[\n {\n \"epoch\": \"1475868259\",\n \"timestamp\": \"15:24:20\",\n \"count\": \"121\"\n }\n]" } } } @@ -59994,8 +59994,8 @@ }, "examples": { "CatIndicesResponseExample1": { - "description": "A successful response from `GET /_cat/indices/my-index-*?v=true&s=index`.\n", - "value": "health status index uuid pri rep docs.count docs.deleted store.size pri.store.size dataset.size\nyellow open my-index-000001 u8FNjxh8Rfy_awN11oDKYQ 1 1 1200 0 88.1kb 88.1kb 88.1kb\ngreen open my-index-000002 nYFWZEO7TUiOjLQXBaYJpA 1 0 0 0 260b 260b 260b" + "description": "A successful response from `GET /_cat/indices/my-index-*?v=true&s=index&format=json`.\n", + "value": "[\n {\n \"health\": \"yellow\",\n \"status\": \"open\",\n \"index\": \"my-index-000001\",\n \"uuid\": \"u8FNjxh8Rfy_awN11oDKYQ\",\n \"pri\": \"1\",\n \"rep\": \"1\",\n \"docs.count\": \"1200\",\n \"docs.deleted\": \"0\",\n \"store.size\": \"88.1kb\",\n \"pri.store.size\": \"88.1kb\",\n \"dataset.size\": \"88.1kb\"\n },\n {\n \"health\": \"green\",\n \"status\": \"open\",\n \"index\": \"my-index-000002\",\n \"uuid\": \"nYFWZEO7TUiOjLQXBaYJpA \",\n \"pri\": \"1\",\n \"rep\": \"0\",\n \"docs.count\": \"0\",\n \"docs.deleted\": \"0\",\n \"store.size\": \"260b\",\n \"pri.store.size\": \"260b\",\n \"dataset.size\": \"260b\"\n }\n]" } } } @@ -60013,8 +60013,8 @@ }, "examples": { "CatDataframeanalyticsResponseExample1": { - "description": "A successful response from `GET _cat/ml/data_frame/analytics?v=true`.", - "value": "id create_time type state\nclassifier_job_1 2020-02-12T11:49:09.594Z classification stopped\nclassifier_job_2 2020-02-12T11:49:14.479Z classification stopped\nclassifier_job_3 2020-02-12T11:49:16.928Z classification stopped\nclassifier_job_4 2020-02-12T11:49:19.127Z classification stopped\nclassifier_job_5 2020-02-12T11:49:21.349Z classification stopped" + "description": "A successful response from `GET _cat/ml/data_frame/analytics?v=true&format=json`.", + "value": "[\n {\n \"id\": \"classifier_job_1\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:09.594Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_2\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:14.479Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_3\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:16.928Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_4\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:19.127Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_5\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:21.349Z\",\n \"state\": \"stopped\"\n }\n]" } } } @@ -60032,8 +60032,8 @@ }, "examples": { "CatDatafeedsResponseExample1": { - "description": "A successful response from `GET _cat/ml/datafeeds?v=true`.", - "value": "id state buckets.count search.count\ndatafeed-high_sum_total_sales stopped 743 7\ndatafeed-low_request_rate stopped 1457 3\ndatafeed-response_code_rates stopped 1460 18\ndatafeed-url_scanning stopped 1460 18" + "description": "A successful response from `GET _cat/ml/datafeeds?v=true&format=json`.", + "value": "[\n {\n \"id\": \"datafeed-high_sum_total_sales\",\n \"state\": \"stopped\",\n \"buckets.count\": \"743\",\n \"search.count\": \"7\"\n },\n {\n \"id\": \"datafeed-low_request_rate\",\n \"state\": \"stopped\",\n \"buckets.count\": \"1457\",\n \"search.count\": \"3\"\n },\n {\n \"id\": \"datafeed-response_code_rates\",\n \"state\": \"stopped\",\n \"buckets.count\": \"1460\",\n \"search.count\": \"18\"\n },\n {\n \"id\": \"datafeed-url_scanning\",\n \"state\": \"stopped\",\n \"buckets.count\": \"1460\",\n \"search.count\": \"18\"\n }\n]" } } } @@ -60051,8 +60051,8 @@ }, "examples": { "CatJobsResponseExample1": { - "description": "A succesful response from `GET _cat/component_templates/my-template-*?v=true&s=name`.", - "value": "name version alias_count mapping_count settings_count metadata_count included_in\nmy-template-1 0 0 1 0 [my-index-template]\nmy-template-2 0 3 0 0 [my-index-template]" + "description": "A successful response from `GET _cat/ml/anomaly_detectors?h=id,s,dpr,mb&v=true&format=json`.", + "value": "[\n {\n \"id\": \"high_sum_total_sales\",\n \"s\": \"closed\",\n \"dpr\": \"14022\",\n \"mb\": \"1.5mb\"\n },\n {\n \"id\": \"low_request_rate\",\n \"s\": \"closed\",\n \"dpr\": \"1216\",\n \"mb\": \"40.5kb\"\n },\n {\n \"id\": \"response_code_rates\",\n \"s\": \"closed\",\n \"dpr\": \"28146\",\n \"mb\": \"132.7kb\"\n },\n {\n \"id\": \"url_scanning\",\n \"s\": \"closed\",\n \"dpr\": \"28146\",\n \"mb\": \"501.6kb\"\n }\n]" } } } @@ -60070,8 +60070,8 @@ }, "examples": { "CatTrainedModelsResponseExample1": { - "description": "A successful response from `GET _cat/ml/trained_models?h=c,o,l,ct,v&v=true`.", - "value": "id created_by operations license create_time version\nddddd-1580216177138 _xpack 196 PLATINUM 2020-01-28T12:56:17.138Z 8.0.0\nflight-regress-1580215685537 _xpack 102 PLATINUM 2020-01-28T12:48:05.537Z 8.0.0\nlang_ident_model_1 _xpack 39629 BASIC 2019-12-05T12:28:34.594Z 7.6.0" + "description": "A successful response from `GET _cat/ml/trained_models?v=true&format=json`.", + "value": "[\n {\n \"id\": \"ddddd-1580216177138\",\n \"heap_size\": \"0b\",\n \"operations\": \"196\",\n \"create_time\": \"2025-03-25T00:01:38.662Z\",\n \"type\": \"pytorch\",\n \"ingest.pipelines\": \"0\",\n \"data_frame.id\": \"__none__\"\n },\n {\n \"id\": \"lang_ident_model_1\",\n \"heap_size\": \"1mb\",\n \"operations\": \"39629\",\n \"create_time\": \"2019-12-05T12:28:34.594Z\",\n \"type\": \"lang_ident\",\n \"ingest.pipelines\": \"0\",\n \"data_frame.id\": \"__none__\"\n }\n]" } } } diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index c198e9d959..edfe7c6798 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -13479,8 +13479,8 @@ }, "examples": { "CatAliasesResponseExample1": { - "description": "A successful response from `GET _cat/aliases?v=true`. This response shows that `alias2` has configured a filter and `alias3` and `alias4` have routing configurations.\n", - "value": "alias index filter routing.index routing.search is_write_index\nalias1 test1 - - - -\nalias2 test1 * - - -\nalias3 test1 - 1 1 -\nalias4 test1 - 2 1,2 -" + "description": "A successful response from `GET _cat/aliases?format=json&v=true`. This response shows that `alias2` has configured a filter and `alias3` and `alias4` have routing configurations.\n", + "value": "[\n {\n \"alias\": \"alias1\",\n \"index\": \"test1\",\n \"filter\": \"-\",\n \"routing.index\": \"-\",\n \"routing.search\": \"-\",\n \"is_write_index\": \"true\"\n },\n {\n \"alias\": \"alias1\",\n \"index\": \"test1\",\n \"filter\": \"*\",\n \"routing.index\": \"-\",\n \"routing.search\": \"-\",\n \"is_write_index\": \"true\"\n },\n {\n \"alias\": \"alias3\",\n \"index\": \"test1\",\n \"filter\": \"-\",\n \"routing.index\": \"1\",\n \"routing.search\": \"1\",\n \"is_write_index\": \"true\"\n },\n {\n \"alias\": \"alias4\",\n \"index\": \"test1\",\n \"filter\": \"-\",\n \"routing.index\": \"2\",\n \"routing.search\": \"1,2\",\n \"is_write_index\": \"true\"\n }\n]" } }, "kind": "response", @@ -13594,8 +13594,8 @@ }, "examples": { "CatComponentTemplatesResponseExample1": { - "description": "A successful response from `GET _cat/aliases?v=true`. This response shows that `alias2` has configured a filter and `alias3` and `alias4` have routing configurations.\n", - "value": "alias index filter routing.index routing.search is_write_index\nalias1 test1 - - - -\nalias2 test1 * - - -\nalias3 test1 - 1 1 -\nalias4 test1 - 2 1,2 -" + "description": "A successful response from `GET _cat/component_templates/my-template-*?v=true&s=name&format=json`.\n", + "value": "[\n {\n \"name\": \"my-template-1\",\n \"version\": \"null\",\n \"alias_count\": \"0\",\n \"mapping_count\": \"0\",\n \"settings_count\": \"1\",\n \"metadata_count\": \"0\",\n \"included_in\": \"[my-index-template]\"\n },\n {\n \"name\": \"my-template-2\",\n \"version\": null,\n \"alias_count\": \"0\",\n \"mapping_count\": \"3\",\n \"settings_count\": \"0\",\n \"metadata_count\": \"0\",\n \"included_in\": \"[my-index-template]\"\n }\n]" } }, "kind": "response", @@ -13683,14 +13683,14 @@ }, "examples": { "CatCountResponseExample1": { - "description": "A successful response from `GET /_cat/count/my-index-000001?v=true`. It retrieves the document count for the `my-index-000001` data stream or index.\n", + "description": "A successful response from `GET /_cat/count/my-index-000001?v=true&format=json`. It retrieves the document count for the `my-index-000001` data stream or index.\n", "summary": "Single data stream or index count", - "value": "epoch timestamp count\n1475868259 15:24:20 120" + "value": "[\n {\n \"epoch\": \"1475868259\",\n \"timestamp\": \"15:24:20\",\n \"count\": \"120\"\n }\n]" }, "CatCountResponseExample2": { - "description": "A successful response from `GET /_cat/count?v=true`. It retrieves the document count for all data streams and indices in the cluster.\n", + "description": "A successful response from `GET /_cat/count?v=true&format=json`. It retrieves the document count for all data streams and indices in the cluster.\n", "summary": "All data streams and indices count", - "value": "epoch timestamp count\n1475868259 15:24:20 121" + "value": "[\n {\n \"epoch\": \"1475868259\",\n \"timestamp\": \"15:24:20\",\n \"count\": \"121\"\n }\n]" } }, "kind": "response", @@ -13891,8 +13891,8 @@ }, "examples": { "CatIndicesResponseExample1": { - "description": "A successful response from `GET /_cat/indices/my-index-*?v=true&s=index`.\n", - "value": "health status index uuid pri rep docs.count docs.deleted store.size pri.store.size dataset.size\nyellow open my-index-000001 u8FNjxh8Rfy_awN11oDKYQ 1 1 1200 0 88.1kb 88.1kb 88.1kb\ngreen open my-index-000002 nYFWZEO7TUiOjLQXBaYJpA 1 0 0 0 260b 260b 260b" + "description": "A successful response from `GET /_cat/indices/my-index-*?v=true&s=index&format=json`.\n", + "value": "[\n {\n \"health\": \"yellow\",\n \"status\": \"open\",\n \"index\": \"my-index-000001\",\n \"uuid\": \"u8FNjxh8Rfy_awN11oDKYQ\",\n \"pri\": \"1\",\n \"rep\": \"1\",\n \"docs.count\": \"1200\",\n \"docs.deleted\": \"0\",\n \"store.size\": \"88.1kb\",\n \"pri.store.size\": \"88.1kb\",\n \"dataset.size\": \"88.1kb\"\n },\n {\n \"health\": \"green\",\n \"status\": \"open\",\n \"index\": \"my-index-000002\",\n \"uuid\": \"nYFWZEO7TUiOjLQXBaYJpA \",\n \"pri\": \"1\",\n \"rep\": \"0\",\n \"docs.count\": \"0\",\n \"docs.deleted\": \"0\",\n \"store.size\": \"260b\",\n \"pri.store.size\": \"260b\",\n \"dataset.size\": \"260b\"\n }\n]" } }, "kind": "response", @@ -14017,8 +14017,8 @@ }, "examples": { "CatDataframeanalyticsResponseExample1": { - "description": "A successful response from `GET _cat/ml/data_frame/analytics?v=true`.", - "value": "id create_time type state\nclassifier_job_1 2020-02-12T11:49:09.594Z classification stopped\nclassifier_job_2 2020-02-12T11:49:14.479Z classification stopped\nclassifier_job_3 2020-02-12T11:49:16.928Z classification stopped\nclassifier_job_4 2020-02-12T11:49:19.127Z classification stopped\nclassifier_job_5 2020-02-12T11:49:21.349Z classification stopped" + "description": "A successful response from `GET _cat/ml/data_frame/analytics?v=true&format=json`.", + "value": "[\n {\n \"id\": \"classifier_job_1\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:09.594Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_2\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:14.479Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_3\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:16.928Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_4\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:19.127Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_5\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:21.349Z\",\n \"state\": \"stopped\"\n }\n]" } }, "kind": "response", @@ -14132,8 +14132,8 @@ }, "examples": { "CatDatafeedsResponseExample1": { - "description": "A successful response from `GET _cat/ml/datafeeds?v=true`.", - "value": "id state buckets.count search.count\ndatafeed-high_sum_total_sales stopped 743 7\ndatafeed-low_request_rate stopped 1457 3\ndatafeed-response_code_rates stopped 1460 18\ndatafeed-url_scanning stopped 1460 18" + "description": "A successful response from `GET _cat/ml/datafeeds?v=true&format=json`.", + "value": "[\n {\n \"id\": \"datafeed-high_sum_total_sales\",\n \"state\": \"stopped\",\n \"buckets.count\": \"743\",\n \"search.count\": \"7\"\n },\n {\n \"id\": \"datafeed-low_request_rate\",\n \"state\": \"stopped\",\n \"buckets.count\": \"1457\",\n \"search.count\": \"3\"\n },\n {\n \"id\": \"datafeed-response_code_rates\",\n \"state\": \"stopped\",\n \"buckets.count\": \"1460\",\n \"search.count\": \"18\"\n },\n {\n \"id\": \"datafeed-url_scanning\",\n \"state\": \"stopped\",\n \"buckets.count\": \"1460\",\n \"search.count\": \"18\"\n }\n]" } }, "kind": "response", @@ -14259,8 +14259,8 @@ }, "examples": { "CatJobsResponseExample1": { - "description": "A succesful response from `GET _cat/component_templates/my-template-*?v=true&s=name`.", - "value": "name version alias_count mapping_count settings_count metadata_count included_in\nmy-template-1 0 0 1 0 [my-index-template]\nmy-template-2 0 3 0 0 [my-index-template]" + "description": "A successful response from `GET _cat/ml/anomaly_detectors?h=id,s,dpr,mb&v=true&format=json`.", + "value": "[\n {\n \"id\": \"high_sum_total_sales\",\n \"s\": \"closed\",\n \"dpr\": \"14022\",\n \"mb\": \"1.5mb\"\n },\n {\n \"id\": \"low_request_rate\",\n \"s\": \"closed\",\n \"dpr\": \"1216\",\n \"mb\": \"40.5kb\"\n },\n {\n \"id\": \"response_code_rates\",\n \"s\": \"closed\",\n \"dpr\": \"28146\",\n \"mb\": \"132.7kb\"\n },\n {\n \"id\": \"url_scanning\",\n \"s\": \"closed\",\n \"dpr\": \"28146\",\n \"mb\": \"501.6kb\"\n }\n]" } }, "kind": "response", @@ -14409,8 +14409,8 @@ }, "examples": { "CatTrainedModelsResponseExample1": { - "description": "A successful response from `GET _cat/ml/trained_models?h=c,o,l,ct,v&v=true`.", - "value": "id created_by operations license create_time version\nddddd-1580216177138 _xpack 196 PLATINUM 2020-01-28T12:56:17.138Z 8.0.0\nflight-regress-1580215685537 _xpack 102 PLATINUM 2020-01-28T12:48:05.537Z 8.0.0\nlang_ident_model_1 _xpack 39629 BASIC 2019-12-05T12:28:34.594Z 7.6.0" + "description": "A successful response from `GET _cat/ml/trained_models?v=true&format=json`.", + "value": "[\n {\n \"id\": \"ddddd-1580216177138\",\n \"heap_size\": \"0b\",\n \"operations\": \"196\",\n \"create_time\": \"2025-03-25T00:01:38.662Z\",\n \"type\": \"pytorch\",\n \"ingest.pipelines\": \"0\",\n \"data_frame.id\": \"__none__\"\n },\n {\n \"id\": \"lang_ident_model_1\",\n \"heap_size\": \"1mb\",\n \"operations\": \"39629\",\n \"create_time\": \"2019-12-05T12:28:34.594Z\",\n \"type\": \"lang_ident\",\n \"ingest.pipelines\": \"0\",\n \"data_frame.id\": \"__none__\"\n }\n]" } }, "kind": "response", diff --git a/output/schema/schema.json b/output/schema/schema.json index 57d5616a52..026a6dcaec 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -95135,8 +95135,8 @@ }, "examples": { "CatAliasesResponseExample1": { - "description": "A successful response from `GET _cat/aliases?v=true`. This response shows that `alias2` has configured a filter and `alias3` and `alias4` have routing configurations.\n", - "value": "alias index filter routing.index routing.search is_write_index\nalias1 test1 - - - -\nalias2 test1 * - - -\nalias3 test1 - 1 1 -\nalias4 test1 - 2 1,2 -" + "description": "A successful response from `GET _cat/aliases?format=json&v=true`. This response shows that `alias2` has configured a filter and `alias3` and `alias4` have routing configurations.\n", + "value": "[\n {\n \"alias\": \"alias1\",\n \"index\": \"test1\",\n \"filter\": \"-\",\n \"routing.index\": \"-\",\n \"routing.search\": \"-\",\n \"is_write_index\": \"true\"\n },\n {\n \"alias\": \"alias1\",\n \"index\": \"test1\",\n \"filter\": \"*\",\n \"routing.index\": \"-\",\n \"routing.search\": \"-\",\n \"is_write_index\": \"true\"\n },\n {\n \"alias\": \"alias3\",\n \"index\": \"test1\",\n \"filter\": \"-\",\n \"routing.index\": \"1\",\n \"routing.search\": \"1\",\n \"is_write_index\": \"true\"\n },\n {\n \"alias\": \"alias4\",\n \"index\": \"test1\",\n \"filter\": \"-\",\n \"routing.index\": \"2\",\n \"routing.search\": \"1,2\",\n \"is_write_index\": \"true\"\n }\n]" } }, "name": { @@ -95611,8 +95611,8 @@ }, "examples": { "CatAllocationResponseExample1": { - "description": "A successful response from `GET /_cat/allocation?v=true`. It shows a single shard is allocated to the one node available.\n", - "value": "shards shards.undesired write_load.forecast disk.indices.forecast disk.indices disk.used disk.avail disk.total disk.percent host ip node node.role\n 1 0 0.0 260b 260b 47.3gb 43.4gb 100.7gb 46 127.0.0.1 127.0.0.1 CSUXak2 himrst" + "description": "A successful response from `GET /_cat/allocation?v=true&format=json`. It shows a single shard is allocated to the one node available.\n", + "value": "[\n {\n \"shards\": \"1\",\n \"shards.undesired\": \"0\",\n \"write_load.forecast\": \"0.0\",\n \"disk.indices.forecast\": \"260b\",\n \"disk.indices\": \"260b\",\n \"disk.used\": \"47.3gb\",\n \"disk.avail\": \"43.4gb\",\n \"disk.total\": \"100.7gb\",\n \"disk.percent\": \"46\",\n \"host\": \"127.0.0.1\",\n \"ip\": \"127.0.0.1\",\n \"node\": \"CSUXak2\",\n \"node.role\": \"himrst\"\n }\n]" } }, "name": { @@ -95825,8 +95825,8 @@ }, "examples": { "CatComponentTemplatesResponseExample1": { - "description": "A successful response from `GET _cat/aliases?v=true`. This response shows that `alias2` has configured a filter and `alias3` and `alias4` have routing configurations.\n", - "value": "alias index filter routing.index routing.search is_write_index\nalias1 test1 - - - -\nalias2 test1 * - - -\nalias3 test1 - 1 1 -\nalias4 test1 - 2 1,2 -" + "description": "A successful response from `GET _cat/component_templates/my-template-*?v=true&s=name&format=json`.\n", + "value": "[\n {\n \"name\": \"my-template-1\",\n \"version\": \"null\",\n \"alias_count\": \"0\",\n \"mapping_count\": \"0\",\n \"settings_count\": \"1\",\n \"metadata_count\": \"0\",\n \"included_in\": \"[my-index-template]\"\n },\n {\n \"name\": \"my-template-2\",\n \"version\": null,\n \"alias_count\": \"0\",\n \"mapping_count\": \"3\",\n \"settings_count\": \"0\",\n \"metadata_count\": \"0\",\n \"included_in\": \"[my-index-template]\"\n }\n]" } }, "name": { @@ -95992,14 +95992,14 @@ }, "examples": { "CatCountResponseExample1": { - "description": "A successful response from `GET /_cat/count/my-index-000001?v=true`. It retrieves the document count for the `my-index-000001` data stream or index.\n", + "description": "A successful response from `GET /_cat/count/my-index-000001?v=true&format=json`. It retrieves the document count for the `my-index-000001` data stream or index.\n", "summary": "Single data stream or index count", - "value": "epoch timestamp count\n1475868259 15:24:20 120" + "value": "[\n {\n \"epoch\": \"1475868259\",\n \"timestamp\": \"15:24:20\",\n \"count\": \"120\"\n }\n]" }, "CatCountResponseExample2": { - "description": "A successful response from `GET /_cat/count?v=true`. It retrieves the document count for all data streams and indices in the cluster.\n", + "description": "A successful response from `GET /_cat/count?v=true&format=json`. It retrieves the document count for all data streams and indices in the cluster.\n", "summary": "All data streams and indices count", - "value": "epoch timestamp count\n1475868259 15:24:20 121" + "value": "[\n {\n \"epoch\": \"1475868259\",\n \"timestamp\": \"15:24:20\",\n \"count\": \"121\"\n }\n]" } }, "name": { @@ -96202,14 +96202,14 @@ }, "examples": { "CatFielddataResponseExample1": { - "description": "A successful response from `GET /_cat/fielddata?v=true&fields=body`. You can specify an individual field in the request body or URL path. This example retrieves heap memory size information for the `body` field.\n", + "description": "A successful response from `GET /_cat/fielddata?v=true&fields=body&format=json`. You can specify an individual field in the request body or URL path. This example retrieves heap memory size information for the `body` field.\n", "summary": "Single field data", - "value": "id host ip node field size\nNqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in body 544b" + "value": "[\n {\n \"id\": \"Nqk-6inXQq-OxUfOUI8jNQ\",\n \"host\": \"127.0.0.1\",\n \"ip\": \"127.0.0.1\",\n \"node\": \"Nqk-6in\",\n \"field\": \"body\",\n \"size\": \"544b\"\n }\n]" }, "CatFielddataResponseExample2": { - "description": "A successful response from `GET /_cat/fielddata/body,soul?v=true`. You can specify a comma-separated list of fields in the request body or URL path. This example retrieves heap memory size information for the `body` and `soul` fields. To get information for all fields, run `GET /_cat/fielddata?v=true`.\n", + "description": "A successful response from `GET /_cat/fielddata/body,soul?v=true&format=json`. You can specify a comma-separated list of fields in the request body or URL path. This example retrieves heap memory size information for the `body` and `soul` fields. To get information for all fields, run `GET /_cat/fielddata?v=true`.\n", "summary": "Multiple fields data", - "value": "id host ip node field size\nNqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in body 544b\nNqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in soul 480b" + "value": "[\n {\n \"id\": \"Nqk-6inXQq-OxUfOUI8jNQ\",\n \"host\": \"1127.0.0.1\",\n \"ip\": \"127.0.0.1\",\n \"node\": \"Nqk-6in\",\n \"field\": \"body\",\n \"size\": \"544b\"\n },\n {\n \"id\": \"Nqk-6inXQq-OxUfOUI8jNQ\",\n \"host\": \"127.0.0.1\",\n \"ip\": \"127.0.0.1\",\n \"node\": \"Nqk-6in\",\n \"field\": \"soul\",\n \"size\": \"480b\"\n }\n]" } }, "name": { @@ -96582,8 +96582,8 @@ }, "examples": { "CatHealthResponseExample1": { - "description": "A successful response from `GET /_cat/health?v=true`. By default, it returns `HH:MM:SS` and Unix epoch timestamps.\n", - "value": "epoch timestamp cluster status node.total node.data shards pri relo init unassign unassign.pri pending_tasks max_task_wait_time active_shards_percent\n1475871424 16:17:04 elasticsearch green 1 1 1 1 0 0 0 0 0 - 100.0%" + "description": "A successful response from `GET /_cat/health?v=true&format=json`. By default, it returns `HH:MM:SS` and Unix epoch timestamps.\n", + "value": "[\n {\n \"epoch\": \"1475871424\",\n \"timestamp\": \"16:17:04\",\n \"cluster\": \"elasticsearch\",\n \"status\": \"green\",\n \"node.total\": \"1\",\n \"node.data\": \"1\",\n \"shards\": \"1\",\n \"pri\": \"1\",\n \"relo\": \"0\",\n \"init\": \"0\",\n \"unassign\": \"0\",\n \"unassign.pri\": \"0\",\n \"pending_tasks\": \"0\",\n \"max_task_wait_time\": \"-\",\n \"active_shards_percent\": \"100.0%\"\n }\n]" } }, "name": { @@ -98866,8 +98866,8 @@ }, "examples": { "CatIndicesResponseExample1": { - "description": "A successful response from `GET /_cat/indices/my-index-*?v=true&s=index`.\n", - "value": "health status index uuid pri rep docs.count docs.deleted store.size pri.store.size dataset.size\nyellow open my-index-000001 u8FNjxh8Rfy_awN11oDKYQ 1 1 1200 0 88.1kb 88.1kb 88.1kb\ngreen open my-index-000002 nYFWZEO7TUiOjLQXBaYJpA 1 0 0 0 260b 260b 260b" + "description": "A successful response from `GET /_cat/indices/my-index-*?v=true&s=index&format=json`.\n", + "value": "[\n {\n \"health\": \"yellow\",\n \"status\": \"open\",\n \"index\": \"my-index-000001\",\n \"uuid\": \"u8FNjxh8Rfy_awN11oDKYQ\",\n \"pri\": \"1\",\n \"rep\": \"1\",\n \"docs.count\": \"1200\",\n \"docs.deleted\": \"0\",\n \"store.size\": \"88.1kb\",\n \"pri.store.size\": \"88.1kb\",\n \"dataset.size\": \"88.1kb\"\n },\n {\n \"health\": \"green\",\n \"status\": \"open\",\n \"index\": \"my-index-000002\",\n \"uuid\": \"nYFWZEO7TUiOjLQXBaYJpA \",\n \"pri\": \"1\",\n \"rep\": \"0\",\n \"docs.count\": \"0\",\n \"docs.deleted\": \"0\",\n \"store.size\": \"260b\",\n \"pri.store.size\": \"260b\",\n \"dataset.size\": \"260b\"\n }\n]" } }, "name": { @@ -99032,8 +99032,8 @@ }, "examples": { "CatMasterResponseExample1": { - "description": "A successful response from `GET /_cat/master?v=true`.\n", - "value": "id host ip node\nYzWoH_2BT-6UjVGDyPdqYg 127.0.0.1 127.0.0.1 YzWoH_2" + "description": "A successful response from `GET /_cat/master?v=true&format=json`.\n", + "value": "[\n {\n \"id\": \"YzWoH_2BT-6UjVGDyPdqYg\",\n \"host\": \"127.0.0.1\",\n \"ip\": \"127.0.0.1\",\n \"node\": \"YzWoH_2\"\n }\n]" } }, "name": { @@ -99415,8 +99415,8 @@ }, "examples": { "CatDataframeanalyticsResponseExample1": { - "description": "A successful response from `GET _cat/ml/data_frame/analytics?v=true`.", - "value": "id create_time type state\nclassifier_job_1 2020-02-12T11:49:09.594Z classification stopped\nclassifier_job_2 2020-02-12T11:49:14.479Z classification stopped\nclassifier_job_3 2020-02-12T11:49:16.928Z classification stopped\nclassifier_job_4 2020-02-12T11:49:19.127Z classification stopped\nclassifier_job_5 2020-02-12T11:49:21.349Z classification stopped" + "description": "A successful response from `GET _cat/ml/data_frame/analytics?v=true&format=json`.", + "value": "[\n {\n \"id\": \"classifier_job_1\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:09.594Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_2\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:14.479Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_3\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:16.928Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_4\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:19.127Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_5\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:21.349Z\",\n \"state\": \"stopped\"\n }\n]" } }, "name": { @@ -99726,8 +99726,8 @@ }, "examples": { "CatDatafeedsResponseExample1": { - "description": "A successful response from `GET _cat/ml/datafeeds?v=true`.", - "value": "id state buckets.count search.count\ndatafeed-high_sum_total_sales stopped 743 7\ndatafeed-low_request_rate stopped 1457 3\ndatafeed-response_code_rates stopped 1460 18\ndatafeed-url_scanning stopped 1460 18" + "description": "A successful response from `GET _cat/ml/datafeeds?v=true&format=json`.", + "value": "[\n {\n \"id\": \"datafeed-high_sum_total_sales\",\n \"state\": \"stopped\",\n \"buckets.count\": \"743\",\n \"search.count\": \"7\"\n },\n {\n \"id\": \"datafeed-low_request_rate\",\n \"state\": \"stopped\",\n \"buckets.count\": \"1457\",\n \"search.count\": \"3\"\n },\n {\n \"id\": \"datafeed-response_code_rates\",\n \"state\": \"stopped\",\n \"buckets.count\": \"1460\",\n \"search.count\": \"18\"\n },\n {\n \"id\": \"datafeed-url_scanning\",\n \"state\": \"stopped\",\n \"buckets.count\": \"1460\",\n \"search.count\": \"18\"\n }\n]" } }, "name": { @@ -100815,8 +100815,8 @@ }, "examples": { "CatJobsResponseExample1": { - "description": "A succesful response from `GET _cat/component_templates/my-template-*?v=true&s=name`.", - "value": "name version alias_count mapping_count settings_count metadata_count included_in\nmy-template-1 0 0 1 0 [my-index-template]\nmy-template-2 0 3 0 0 [my-index-template]" + "description": "A successful response from `GET _cat/ml/anomaly_detectors?h=id,s,dpr,mb&v=true&format=json`.", + "value": "[\n {\n \"id\": \"high_sum_total_sales\",\n \"s\": \"closed\",\n \"dpr\": \"14022\",\n \"mb\": \"1.5mb\"\n },\n {\n \"id\": \"low_request_rate\",\n \"s\": \"closed\",\n \"dpr\": \"1216\",\n \"mb\": \"40.5kb\"\n },\n {\n \"id\": \"response_code_rates\",\n \"s\": \"closed\",\n \"dpr\": \"28146\",\n \"mb\": \"132.7kb\"\n },\n {\n \"id\": \"url_scanning\",\n \"s\": \"closed\",\n \"dpr\": \"28146\",\n \"mb\": \"501.6kb\"\n }\n]" } }, "name": { @@ -100965,8 +100965,8 @@ }, "examples": { "CatTrainedModelsResponseExample1": { - "description": "A successful response from `GET _cat/ml/trained_models?h=c,o,l,ct,v&v=true`.", - "value": "id created_by operations license create_time version\nddddd-1580216177138 _xpack 196 PLATINUM 2020-01-28T12:56:17.138Z 8.0.0\nflight-regress-1580215685537 _xpack 102 PLATINUM 2020-01-28T12:48:05.537Z 8.0.0\nlang_ident_model_1 _xpack 39629 BASIC 2019-12-05T12:28:34.594Z 7.6.0" + "description": "A successful response from `GET _cat/ml/trained_models?v=true&format=json`.", + "value": "[\n {\n \"id\": \"ddddd-1580216177138\",\n \"heap_size\": \"0b\",\n \"operations\": \"196\",\n \"create_time\": \"2025-03-25T00:01:38.662Z\",\n \"type\": \"pytorch\",\n \"ingest.pipelines\": \"0\",\n \"data_frame.id\": \"__none__\"\n },\n {\n \"id\": \"lang_ident_model_1\",\n \"heap_size\": \"1mb\",\n \"operations\": \"39629\",\n \"create_time\": \"2019-12-05T12:28:34.594Z\",\n \"type\": \"lang_ident\",\n \"ingest.pipelines\": \"0\",\n \"data_frame.id\": \"__none__\"\n }\n]" } }, "name": { @@ -101470,14 +101470,14 @@ }, "examples": { "CatNodeAttributesResponseExample1": { - "description": "A successful response from `GET /_cat/nodeattrs?v=true`. The `node`, `host`, and `ip` columns provide basic information about each node. The `attr` and `value` columns return custom node attributes, one per line.\n", + "description": "A successful response from `GET /_cat/nodeattrs?v=true&format=json`. The `node`, `host`, and `ip` columns provide basic information about each node. The `attr` and `value` columns return custom node attributes, one per line.\n", "summary": "Default columns", - "value": "node host ip attr value\nnode-0 127.0.0.1 127.0.0.1 testattr test" + "value": "[\n {\n \"node\": \"node-0\",\n \"host\": \"127.0.0.1\",\n \"ip\": \"127.0.0.1\",\n \"attr\": \"testattr\",\n \"value\": \"test\"\n }\n]" }, "CatNodeAttributesResponseExample2": { "description": "A successful response from `GET /_cat/nodeattrs?v=true&h=name,pid,attr,value`. It returns the `name`, `pid`, `attr`, and `value` columns.\n", "summary": "Explicit columns", - "value": "name pid attr value\nnode-0 19566 testattr test" + "value": "[\n {\n \"name\": \"node-0\",\n \"pid\": \"19566\",\n \"attr\": \"testattr\",\n \"value\": \"test\"\n }\n]" } }, "name": { @@ -103142,14 +103142,14 @@ }, "examples": { "CatNodesResponseExample1": { - "description": "A successful response from `GET /_cat/nodes?v=true`. The `ip`, `heap.percent`, `ram.percent`, `cpu`, and `load_*` columns provide the IP addresses and performance information of each node. The `node.role`, `master`, and `name` columns provide information useful for monitoring an entire cluster, particularly large ones.\n", + "description": "A successful response from `GET /_cat/nodes?v=true&format=json`. The `ip`, `heap.percent`, `ram.percent`, `cpu`, and `load_*` columns provide the IP addresses and performance information of each node. The `node.role`, `master`, and `name` columns provide information useful for monitoring an entire cluster, particularly large ones.\n", "summary": "Default columns", - "value": "ip heap.percent ram.percent cpu load_1m load_5m load_15m node.role master name\n127.0.0.1 65 99 42 3.07 dim * mJw06l1" + "value": "[\n {\n \"ip\": \"127.0.0.1\",\n \"heap.percent\": \"65\",\n \"ram.percent\": \"99\",\n \"cpu\": \"42\",\n \"load_1m\": \"3.07\",\n \"load_5m\": null,\n \"load_15m\": null,\n \"node.role\": \"cdfhilmrstw\",\n \"master\": \"*\",\n \"name\": \"mJw06l1\"\n }\n]" }, "CatNodesResponseExample2": { - "description": "A successful response from `GET /_cat/nodes?v=true&h=id,ip,port,v,m`. It returns the `id`, `ip`, `port`, `v` (version), and `m` (master) columns.\n", + "description": "A successful response from `GET /_cat/nodes?v=true&h=id,ip,port,v,m&format=json`. It returns the `id`, `ip`, `port`, `v` (version), and `m` (master) columns.\n", "summary": "Explicit columns", - "value": "id ip port v m\nveJR 127.0.0.1 59938 8.17.0 *" + "value": "[\n {\n \"id\": \"veJR\",\n \"ip\": \"127.0.0.1\",\n \"port\": \"59938\",\n \"v\": \"9.0.0\",\n \"m\": \"*\"\n }\n]" } }, "name": { @@ -103332,8 +103332,8 @@ }, "examples": { "CatPendingTasksResponseExample1": { - "description": "A successful response from `GET /_cat/pending_tasks?v=true`.\n", - "value": "insertOrder timeInQueue priority source\n 1685 855ms HIGH update-mapping [foo][t]\n 1686 843ms HIGH update-mapping [foo][t]\n 1693 753ms HIGH refresh-mapping [foo][[t]]\n 1688 816ms HIGH update-mapping [foo][t]\n 1689 802ms HIGH update-mapping [foo][t]\n 1690 787ms HIGH update-mapping [foo][t]\n 1691 773ms HIGH update-mapping [foo][t]" + "description": "A successful response from `GET /_cat/pending_tasks?v=trueh=insertOrder,timeInQueue,priority,source&format=json`.\n", + "value": "[\n { \"insertOrder\": \"1685\", \"timeInQueue\": \"855ms\", \"priority\": \"HIGH\", \"source\": \"update-mapping [foo][t]\"},\n { \"insertOrder\": \"1686\", \"timeInQueue\": \"843ms\", \"priority\": \"HIGH\", \"source\": \"update-mapping [foo][t]\"},\n { \"insertOrder\": \"1693\", \"timeInQueue\": \"753ms\", \"priority\": \"HIGH\", \"source\": \"refresh-mapping [foo][[t]]\"},\n { \"insertOrder\": \"1688\", \"timeInQueue\": \"816ms\", \"priority\": \"HIGH\", \"source\": \"update-mapping [foo][t]\"},\n { \"insertOrder\": \"1689\", \"timeInQueue\": \"802ms\", \"priority\": \"HIGH\", \"source\": \"update-mapping [foo][t]\"},\n { \"insertOrder\": \"1690\", \"timeInQueue\": \"787ms\", \"priority\": \"HIGH\", \"source\": \"update-mapping [foo][t]\"},\n { \"insertOrder\": \"1691\", \"timeInQueue\": \"773ms\", \"priority\": \"HIGH\", \"source\": \"update-mapping [foo][t]\"}\n]" } }, "name": { @@ -103544,8 +103544,8 @@ }, "examples": { "CatPluginsResponseExample1": { - "description": "A successful response from `GET /_cat/plugins?v=true&s=component&h=name,component,version,description`.\n", - "value": "name component version description\nU7321H6 analysis-icu 8.17.0 The ICU Analysis plugin integrates the Lucene ICU module into Elasticsearch, adding ICU-related analysis components.\nU7321H6 analysis-kuromoji 8.17.0 The Japanese (kuromoji) Analysis plugin integrates Lucene kuromoji analysis module into elasticsearch.\nU7321H6 analysis-nori 8.17.0 The Korean (nori) Analysis plugin integrates Lucene nori analysis module into elasticsearch.\nU7321H6 analysis-phonetic 8.17.0 The Phonetic Analysis plugin integrates phonetic token filter analysis with elasticsearch.\nU7321H6 analysis-smartcn 8.17.0 Smart Chinese Analysis plugin integrates Lucene Smart Chinese analysis module into elasticsearch.\nU7321H6 analysis-stempel 8.17.0 The Stempel (Polish) Analysis plugin integrates Lucene stempel (polish) analysis module into elasticsearch.\nU7321H6 analysis-ukrainian 8.17.0 The Ukrainian Analysis plugin integrates the Lucene UkrainianMorfologikAnalyzer into elasticsearch.\nU7321H6 discovery-azure-classic 8.17.0 The Azure Classic Discovery plugin allows to use Azure Classic API for the unicast discovery mechanism\nU7321H6 discovery-ec2 8.17.0 The EC2 discovery plugin allows to use AWS API for the unicast discovery mechanism.\nU7321H6 discovery-gce 8.17.0 The Google Compute Engine (GCE) Discovery plugin allows to use GCE API for the unicast discovery mechanism.\nU7321H6 mapper-annotated-text 8.17.0 The Mapper Annotated_text plugin adds support for text fields with markup used to inject annotation tokens into the index.\nU7321H6 mapper-murmur3 8.17.0 The Mapper Murmur3 plugin allows to compute hashes of a field's values at index-time and to store them in the index.\nU7321H6 mapper-size 8.17.0 The Mapper Size plugin allows document to record their uncompressed size at index time.\nU7321H6 store-smb 8.17.0 The Store SMB plugin adds support for SMB stores." + "description": "A successful response from `GET /_cat/plugins?v=true&s=component&h=name,component,version,description&format=json`.\n", + "value": "[\n { \"name\": \"U7321H6\", \"component\": \"analysis-icu\", \"version\": \"8.17.0\", \"description\": \"The ICU Analysis plugin integrates the Lucene ICU module into Elasticsearch, adding ICU-related analysis components.\"},\n {\"name\": \"U7321H6\", \"component\": \"analysis-kuromoji\", \"verison\": \"8.17.0\", description: \"The Japanese (kuromoji) Analysis plugin integrates Lucene kuromoji analysis module into elasticsearch.\"},\n {\"name\" \"U7321H6\", \"component\": \"analysis-nori\", \"version\": \"8.17.0\", \"description\": \"The Korean (nori) Analysis plugin integrates Lucene nori analysis module into elasticsearch.\"},\n {\"name\": \"U7321H6\", \"component\": \"analysis-phonetic\", \"verison\": \"8.17.0\", \"description\": \"The Phonetic Analysis plugin integrates phonetic token filter analysis with elasticsearch.\"},\n {\"name\": \"U7321H6\", \"component\": \"analysis-smartcn\", \"verison\": \"8.17.0\", \"description\": \"Smart Chinese Analysis plugin integrates Lucene Smart Chinese analysis module into elasticsearch.\"},\n {\"name\": \"U7321H6\", \"component\": \"analysis-stempel\", \"verison\": \"8.17.0\", \"description\": \"The Stempel (Polish) Analysis plugin integrates Lucene stempel (polish) analysis module into elasticsearch.\"},\n {\"name\": \"U7321H6\", \"component\": \"analysis-ukrainian\", \"verison\": \"8.17.0\", \"description\": \"The Ukrainian Analysis plugin integrates the Lucene UkrainianMorfologikAnalyzer into elasticsearch.\"},\n {\"name\": \"U7321H6\", \"component\": \"discovery-azure-classic\", \"verison\": \"8.17.0\", \"description\": \"The Azure Classic Discovery plugin allows to use Azure Classic API for the unicast discovery mechanism\"},\n {\"name\": \"U7321H6\", \"component\": \"discovery-ec2\", \"verison\": \"8.17.0\", \"description\": \"The EC2 discovery plugin allows to use AWS API for the unicast discovery mechanism.\"},\n {\"name\": \"U7321H6\", \"component\": \"discovery-gce\", \"verison\": \"8.17.0\", \"description\": \"The Google Compute Engine (GCE) Discovery plugin allows to use GCE API for the unicast discovery mechanism.\"},\n {\"name\": \"U7321H6\", \"component\": \"mapper-annotated-text\", \"verison\": \"8.17.0\", \"description\": \"The Mapper Annotated_text plugin adds support for text fields with markup used to inject annotation tokens into the index.\"},\n {\"name\": \"U7321H6\", \"component\": \"mapper-murmur3\", \"verison\": \"8.17.0\", \"description\": \"The Mapper Murmur3 plugin allows to compute hashes of a field's values at index-time and to store them in the index.\"},\n {\"name\": \"U7321H6\", \"component\": \"mapper-size\", \"verison\": \"8.17.0\", \"description\": \"The Mapper Size plugin allows document to record their uncompressed size at index time.\"},\n {\"name\": \"U7321H6\", \"component\": \"store-smb\", \"verison\": \"8.17.0\", \"description\": \"The Store SMB plugin adds support for SMB stores.\"}\n]" } }, "name": { @@ -104116,19 +104116,19 @@ }, "examples": { "CatRecoveryResponseExample1": { - "description": "A successful response from `GET _cat/recovery?v=true`. In this example, the source and target nodes are the same because the recovery type is `store`, meaning they were read from local storage on node start.\n", + "description": "A successful response from `GET _cat/recovery?v=true&format=json`. In this example, the source and target nodes are the same because the recovery type is `store`, meaning they were read from local storage on node start.\n", "summary": "No ongoing recoveries", - "value": "index shard time type stage source_host source_node target_host target_node repository snapshot files files_recovered files_percent files_total bytes bytes_recovered bytes_percent bytes_total translog_ops translog_ops_recovered translog_ops_percent\nmy-index-000001 0 13ms store done n/a n/a 127.0.0.1 node-0 n/a n/a 0 0 100% 13 0b 0b 100% 9928b 0 0 100.0%" + "value": "[\n {\n \"index\": \"my-index-000001 \",\n \"shard\": \"0\",\n \"time\": \"13ms\",\n \"type\": \"store\",\n \"stage\": \"done\",\n \"source_host\": \"n/a\",\n \"source_node\": \"n/a\",\n \"target_host\": \"127.0.0.1\",\n \"target_node\": \"node-0\",\n \"repository\": \"n/a\",\n \"snapshot\": \"n/a\",\n \"files\": \"0\",\n \"files_recovered\": \"0\",\n \"files_percent\": \"100.0%\",\n \"files_total\": \"13\",\n \"bytes\": \"0b\",\n \"bytes_recovered\": \"0b\",\n \"bytes_percent\": \"100.0%\",\n \"bytes_total\": \"9928b\",\n \"translog_ops\": \"0\",\n \"translog_ops_recovered\": \"0\",\n \"translog_ops_percent\": \"100.0%\"\n }\n]" }, "CatRecoveryResponseExample2": { - "description": "A successful response from `GET _cat/recovery?v=true&h=i,s,t,ty,st,shost,thost,f,fp,b,bp`. You can retrieve information about an ongoing recovery for example when you increase the replica count of an index and bring another node online to host the replicas. In this example, the recovery type is `peer`, meaning the shard recovered from another node. The `files` and `bytes` are real-time measurements.\n", + "description": "A successful response from `GET _cat/recovery?v=true&h=i,s,t,ty,st,shost,thost,f,fp,b,bp&format=json`. You can retrieve information about an ongoing recovery for example when you increase the replica count of an index and bring another node online to host the replicas. In this example, the recovery type is `peer`, meaning the shard recovered from another node. The `files` and `bytes` are real-time measurements.\n", "summary": "A live shard recovery", - "value": "i s t ty st shost thost f fp b bp\nmy-index-000001 0 1252ms peer done 192.168.1.1 192.168.1.2 0 100.0% 0b 100.0%" + "value": "[\n {\n \"i\": \"my-index-000001\",\n \"s\": \"0\",\n \"t\": \"1252ms\",\n \"ty\": \"peer\",\n \"st\": \"done\",\n \"shost\": \"192.168.1.1\",\n \"thost\": \"192.168.1.1\",\n \"f\": \"0\",\n \"fp\": \"100.0%\",\n \"b\": \"0b\",\n \"bp\": \"100.0%\",\n }\n]" }, "CatRecoveryResponseExample3": { - "description": "A successful response from `GET _cat/recovery?v=true&h=i,s,t,ty,st,rep,snap,f,fp,b,bp`. You can restore backups of an index using the snapshot and restore API. You can use the cat recovery API to get information about a snapshot recovery.\n", + "description": "A successful response from `GET _cat/recovery?v=true&h=i,s,t,ty,st,rep,snap,f,fp,b,bp&format=json`. You can restore backups of an index using the snapshot and restore API. You can use the cat recovery API to get information about a snapshot recovery.\n", "summary": "A snapshot recovery", - "value": "i s t ty st rep snap f fp b bp\nmy-index-000001 0 1978ms snapshot done my-repo snap-1 79 8.0% 12086 9.0%" + "value": "[\n {\n \"i\": \"my-index-000001\",\n \"s\": \"0\",\n \"t\": \"1978ms\",\n \"ty\": \"snapshot\",\n \"st\": \"done\",\n \"rep\": \"my-repo\",\n \"snap\": \"snap-1\",\n \"f\": \"79\",\n \"fp\": \"8.0%\",\n \"b\": \"12086\",\n \"bp\": \"9.0%\"\n }\n]" } }, "name": { @@ -104269,8 +104269,8 @@ }, "examples": { "CatRepositoriesResponseExample1": { - "description": "A successful response from `GET /_cat/repositories?v=true`.\n", - "value": "id type\nrepo1 fs\nrepo2 s3" + "description": "A successful response from `GET /_cat/repositories?v=true&format=json`.\n", + "value": "[\n {\n \"id\": \"repo1\",\n \"type\": \"fs\"\n },\n {\n \"id\": \"repo2\",\n \"type\": \"s3\"\n }\n]" } }, "name": { @@ -104396,8 +104396,8 @@ }, "examples": { "CatSegmentsResponseExample1": { - "description": "A successful response from `GET /_cat/segments?v=true`.\n", - "value": "index shard prirep ip segment generation docs.count docs.deleted size size.memory committed searchable version compound\ntest 0 p 127.0.0.1 _0 0 1 0 3kb 0 false true 9.12.0 true\ntest1 0 p 127.0.0.1 _0 0 1 0 3kb 0 false true 9.12.0 true" + "description": "A successful response from `GET /_cat/segments?v=true&format=json`.\n", + "value": "[\n {\n \"index\": \"test\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"ip\": \"127.0.0.1\",\n \"segment\": \"_0\",\n \"generation\": \"0\",\n \"docs.count\": \"1\",\n \"docs.deleted\": \"0\",\n \"size\": \"3kb\",\n \"size.memory\": \"0\",\n \"committed\": \"false\",\n \"searchable\": \"true\",\n \"version\": \"9.12.0\",\n \"compound\": \"true\"\n },\n {\n \"index\": \"test1\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"ip\": \"127.0.0.1\",\n \"segment\": \"_0\",\n \"generation\": \"0\",\n \"docs.count\": \"1\",\n \"docs.deleted\": \"0\",\n \"size\": \"3kb\",\n \"size.memory\": \"0\",\n \"committed\": \"false\",\n \"searchable\": \"true\",\n \"version\": \"9.12.0\",\n \"compound\": \"true\"\n }\n]" } }, "name": { @@ -104762,29 +104762,29 @@ }, "examples": { "CatShardsResponseExample1": { - "description": "A successful response from `GET _cat/shards`.\n", + "description": "A successful response from `GET _cat/shards?format=json`.\n", "summary": "A single data stream or index", - "value": "my-index-000001 0 p STARTED 3014 31.1mb 192.168.56.10 H5dfFeA" + "value": "[\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"state\": \"STARTED\",\n \"docs\": \"3014\",\n \"store\": \"31.1mb\",\n \"dataset\": \"249b\",\n \"ip\": \"192.168.56.10\",\n \"node\": \"H5dfFeA\"\n }\n]" }, "CatShardsResponseExample2": { - "description": "A successful response from `GET _cat/shards/my-index-*`. It returns information for any data streams or indices beginning with `my-index-`.\n", + "description": "A successful response from `GET _cat/shards/my-index-*?format=json`. It returns information for any data streams or indices beginning with `my-index-`.\n", "summary": "A wildcard pattern", - "value": "my-index-000001 0 p STARTED 3014 31.1mb 192.168.56.10 H5dfFeA" + "value": "[\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"state\": \"STARTED\",\n \"docs\": \"3014\",\n \"store\": \"31.1mb\",\n \"dataset\": \"249b\",\n \"ip\": \"192.168.56.10\",\n \"node\": \"H5dfFeA\"\n }\n]" }, "CatShardsResponseExample3": { - "description": "A successful response from `GET _cat/shards`. The `RELOCATING` value in the `state` column indicates the index shard is relocating.\n", + "description": "A successful response from `GET _cat/shards?format=json`. The `RELOCATING` value in the `state` column indicates the index shard is relocating.\n", "summary": "A relocating shard", - "value": "my-index-000001 0 p RELOCATING 3014 31.1mb 192.168.56.10 H5dfFeA -> -> 192.168.56.30 bGG90GE" + "value": "[\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"state\": \"RELOCATING\",\n \"docs\": \"3014\",\n \"store\": \"31.1mb\",\n \"dataset\": \"249b\",\n \"ip\": \"192.168.56.10\",\n \"node\": \"H5dfFeA -> -> 192.168.56.30 bGG90GE\"\n }\n]" }, "CatShardsResponseExample4": { - "description": "A successful response from `GET _cat/shards`. Before a shard is available for use, it goes through an `INITIALIZING` state. You can use the cat shards API to see which shards are initializing.\n", + "description": "A successful response from `GET _cat/shards?format=json`. Before a shard is available for use, it goes through an `INITIALIZING` state. You can use the cat shards API to see which shards are initializing.\n", "summary": "Shard states", - "value": "my-index-000001 0 p STARTED 3014 31.1mb 192.168.56.10 H5dfFeA\nmy-index-000001 0 r INITIALIZING 0 14.3mb 192.168.56.30 bGG90GE" + "value": "[\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"state\": \"STARTED\",\n \"docs\": \"3014\",\n \"store\": \"31.1mb\",\n \"dataset\": \"249b\",\n \"ip\": \"192.168.56.10\",\n \"node\": \"H5dfFeA\"\n },\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"r\",\n \"state\": \"INITIALIZING\",\n \"docs\": \"0\",\n \"store\": \"14.3mb\",\n \"dataset\": \"249b\",\n \"ip\": \"192.168.56.30\",\n \"node\": \"bGG90GE\"\n }\n]" }, "CatShardsResponseExample5": { - "description": "A successful response from `GET _cat/shards?h=index,shard,prirep,state,unassigned.reason`. It includes the `unassigned.reason` column, which indicates why a shard is unassigned.\n", + "description": "A successful response from `GET _cat/shards?h=index,shard,prirep,state,unassigned.reason&format=json`. It includes the `unassigned.reason` column, which indicates why a shard is unassigned.\n", "summary": "Reasons for unassigned shards", - "value": "my-index-000001 0 p STARTED 3014 31.1mb 192.168.56.10 H5dfFeA\nmy-index-000001 0 r STARTED 3014 31.1mb 192.168.56.30 bGG90GE\nmy-index-000001 0 r STARTED 3014 31.1mb 192.168.56.20 I8hydUG\nmy-index-000001 0 r UNASSIGNED ALLOCATION_FAILED" + "value": "[\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"p\",\n \"state\": \"STARTED\",\n \"unassigned.reason\": \"3014 31.1mb 192.168.56.10 H5dfFeA\"\n },\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"r\",\n \"state\": \"STARTED\",\n \"unassigned.reason\": \"3014 31.1mb 192.168.56.30 bGG90GE\"\n },\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"r\",\n \"state\": \"STARTED\",\n \"unassigned.reason\": \"3014 31.1mb 192.168.56.20 I8hydUG\"\n },\n {\n \"index\": \"my-index-000001\",\n \"shard\": \"0\",\n \"prirep\": \"r\",\n \"state\": \"UNASSIGNED\",\n \"unassigned.reason\": \"ALLOCATION_FAILED\"\n }\n]" } }, "name": { @@ -106191,8 +106191,8 @@ }, "examples": { "CatSnapshotsResponseExample1": { - "description": "A successful response from `GET /_cat/snapshots/repo1?v=true&s=id`.\n", - "value": "id repository status start_epoch start_time end_epoch end_time duration indices successful_shards failed_shards total_shards\nsnap1 repo1 FAILED 1445616705 18:11:45 1445616978 18:16:18 4.6m 1 4 1 5\nsnap2 repo1 SUCCESS 1445634298 23:04:58 1445634672 23:11:12 6.2m 2 10 0 10" + "description": "A successful response from `GET /_cat/snapshots/repo1?v=true&s=id&format=json`.\n", + "value": "[\n {\n \"id\": \"snap1\",\n \"repository\": \"repo1\",\n \"status\": \"FAILED\",\n \"start_epoch\": \"1445616705\",\n \"start_time\": \"18:11:45\",\n \"end_epoch\": \"1445616978\",\n \"end_time\": \"18:16:18\",\n \"duration\": \"4.6m\",\n \"indices\": \"1\",\n \"successful_shards\": \"4\",\n \"failed_shards\": \"1\",\n \"total_shards\": \"5\"\n },\n {\n \"id\": \"snap2\",\n \"repository\": \"repo1\",\n \"status\": \"SUCCESS\",\n \"start_epoch\": \"1445634298\",\n \"start_time\": \"23:04:58\",\n \"end_epoch\": \"1445634672\",\n \"end_time\": \"23:11:12\",\n \"duration\": \"6.2m\",\n \"indices\": \"2\",\n \"successful_shards\": \"10\",\n \"failed_shards\": \"0\",\n \"total_shards\": \"10\"\n }\n]" } }, "name": { @@ -106606,8 +106606,8 @@ }, "examples": { "CatTasksResponseExample1": { - "description": "A successful response from `GET _cat/tasks?v=true`.", - "value": "action task_id parent_task_id type start_time timestamp running_time ip node\ncluster:monitor/tasks/lists[n] oTUltX4IQMOUUVeiohTt8A:124 oTUltX4IQMOUUVeiohTt8A:123 direct 1458585884904 01:48:24 44.1micros 127.0.0.1:9300 oTUltX4IQMOUUVeiohTt8A\ncluster:monitor/tasks/lists oTUltX4IQMOUUVeiohTt8A:123 - transport 1458585884904 01:48:24 186.2micros 127.0.0.1:9300 oTUltX4IQMOUUVeiohTt8A" + "description": "A successful response from `GET _cat/tasks?v=true&format=json`.", + "value": "[\n {\n \"action\": \"cluster:monitor/tasks/lists[n]\",\n \"task_id\": \"oTUltX4IQMOUUVeiohTt8A:124\",\n \"parent_task_id\": \"oTUltX4IQMOUUVeiohTt8A:123\",\n \"type\": \"direct\",\n \"start_time\": \"1458585884904\",\n \"timestamp\": \"01:48:24\",\n \"running_time\": \"44.1micros\",\n \"ip\": \"127.0.0.1:9300\",\n \"node\": \"oTUltX4IQMOUUVeiohTt8A\"\n },\n {\n \"action\": \"cluster:monitor/tasks/lists\",\n \"task_id\": \"oTUltX4IQMOUUVeiohTt8A:123\",\n \"parent_task_id\": \"-\",\n \"type\": \"transport\",\n \"start_time\": \"1458585884904\",\n \"timestamp\": \"01:48:24\",\n \"running_time\": \"186.2micros\",\n \"ip\": \"127.0.0.1:9300\",\n \"node\": \"oTUltX4IQMOUUVeiohTt8A\"\n }\n]" } }, "name": { @@ -106967,8 +106967,8 @@ }, "examples": { "CatTemplatesResponseExample1": { - "description": "A successful response from `GET _cat/templates/my-template-*?v=true&s=name`.\n", - "value": "name index_patterns order version composed_of\nmy-template-0 [te*] 500 []\nmy-template-1 [tea*] 501 []\nmy-template-2 [teak*] 502 7 []" + "description": "A successful response from `GET _cat/templates/my-template-*?v=true&s=name&format=json`.\n", + "value": "[\n {\n \"name\": \"my-template-0\",\n \"index_patterns\": \"[te*]\",\n \"order\": \"500\",\n \"version\": null,\n \"composed_of\": \"[]\"\n },\n {\n \"name\": \"my-template-1\",\n \"index_patterns\": \"[tea*]\",\n \"order\": \"501\",\n \"version\": null,\n \"composed_of\": \"[]\"\n },\n {\n \"name\": \"my-template-2\",\n \"index_patterns\": \"[teak*]\",\n \"order\": \"502\",\n \"version\": \"7\",\n \"composed_of\": \"[]\"\n }\n]" } }, "name": { @@ -107192,14 +107192,14 @@ }, "examples": { "CatThreadPoolResponseExample1": { - "description": "A successful response from `GET /_cat/thread_pool`.\n", + "description": "A successful response from `GET /_cat/thread_pool?format=json`.\n", "summary": "Default columns", - "value": "node-0 analyze 0 0 0\nnode-0 fetch_shard_started 0 0 0\nnode-0 fetch_shard_store 0 0 0\nnode-0 flush 0 0 0\nnode-0 write 0 0 0" + "value": "[\n {\n \"node_name\": \"node-0\",\n \"name\": \"analyze\",\n \"active\": \"0\",\n \"queue\": \"0\",\n \"rejected\": \"0\"\n },\n {\n \"node_name\": \"node-0\",\n \"name\": \"fetch_shard_started\",\n \"active\": \"0\",\n \"queue\": \"0\",\n \"rejected\": \"0\"\n },\n {\n \"node_name\": \"node-0\",\n \"name\": \"fetch_shard_store\",\n \"active\": \"0\",\n \"queue\": \"0\",\n \"rejected\": \"0\"\n },\n {\n \"node_name\": \"node-0\",\n \"name\": \"flush\",\n \"active\": \"0\",\n \"queue\": \"0\",\n \"rejected\": \"0\"\n },\n {\n \"node_name\": \"node-0\",\n \"name\": \"write\",\n \"active\": \"0\",\n \"queue\": \"0\",\n \"rejected\": \"0\"\n }\n]" }, "CatThreadPoolResponseExample2": { - "description": "A successful response from `GET /_cat/thread_pool/generic?v=true&h=id,name,active,rejected,completed`. It returns the `id`, `name`, `active`, `rejected`, and `completed` columns. It also limits returned information to the generic thread pool.\n", + "description": "A successful response from `GET /_cat/thread_pool/generic?v=true&h=id,name,active,rejected,completed&format=json`. It returns the `id`, `name`, `active`, `rejected`, and `completed` columns. It also limits returned information to the generic thread pool.\n", "summary": "Explicit columns", - "value": "id name active rejected completed\n0EWUhXeBQtaVGlexUeVwMg generic 0 0 70" + "value": "[\n {\n \"id\": \"0EWUhXeBQtaVGlexUeVwMg\",\n \"name\": \"generic\",\n \"active\": \"0\",\n \"rejected\": \"0\",\n \"completed\": \"70\"\n }\n]" } }, "name": { diff --git a/package.json b/package.json index 8ca14babae..f9d0d7b82d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "dependencies": { - "@redocly/cli": "^1.33.1", + "@redocly/cli": "^1.34.0", "@stoplight/spectral-cli": "^6.14.2" } } diff --git a/specification/cat/aliases/examples/200_response/CatAliasesResponseExample1.yaml b/specification/cat/aliases/examples/200_response/CatAliasesResponseExample1.yaml index f26b38c391..d142b5c588 100644 --- a/specification/cat/aliases/examples/200_response/CatAliasesResponseExample1.yaml +++ b/specification/cat/aliases/examples/200_response/CatAliasesResponseExample1.yaml @@ -1,12 +1,41 @@ # summary: description: > - A successful response from `GET _cat/aliases?v=true`. + A successful response from `GET _cat/aliases?format=json&v=true`. This response shows that `alias2` has configured a filter and `alias3` and `alias4` have routing configurations. # type: response # response_code: 200 value: |- - alias index filter routing.index routing.search is_write_index - alias1 test1 - - - - - alias2 test1 * - - - - alias3 test1 - 1 1 - - alias4 test1 - 2 1,2 - + [ + { + "alias": "alias1", + "index": "test1", + "filter": "-", + "routing.index": "-", + "routing.search": "-", + "is_write_index": "true" + }, + { + "alias": "alias1", + "index": "test1", + "filter": "*", + "routing.index": "-", + "routing.search": "-", + "is_write_index": "true" + }, + { + "alias": "alias3", + "index": "test1", + "filter": "-", + "routing.index": "1", + "routing.search": "1", + "is_write_index": "true" + }, + { + "alias": "alias4", + "index": "test1", + "filter": "-", + "routing.index": "2", + "routing.search": "1,2", + "is_write_index": "true" + } + ] diff --git a/specification/cat/allocation/examples/200_response/CatAllocationResponseExample1.yaml b/specification/cat/allocation/examples/200_response/CatAllocationResponseExample1.yaml index 679eb5ec63..4eebf24649 100644 --- a/specification/cat/allocation/examples/200_response/CatAllocationResponseExample1.yaml +++ b/specification/cat/allocation/examples/200_response/CatAllocationResponseExample1.yaml @@ -1,9 +1,24 @@ # summary: description: > - A successful response from `GET /_cat/allocation?v=true`. + A successful response from `GET /_cat/allocation?v=true&format=json`. It shows a single shard is allocated to the one node available. # type: response # response_code: 200 value: |- - shards shards.undesired write_load.forecast disk.indices.forecast disk.indices disk.used disk.avail disk.total disk.percent host ip node node.role - 1 0 0.0 260b 260b 47.3gb 43.4gb 100.7gb 46 127.0.0.1 127.0.0.1 CSUXak2 himrst + [ + { + "shards": "1", + "shards.undesired": "0", + "write_load.forecast": "0.0", + "disk.indices.forecast": "260b", + "disk.indices": "260b", + "disk.used": "47.3gb", + "disk.avail": "43.4gb", + "disk.total": "100.7gb", + "disk.percent": "46", + "host": "127.0.0.1", + "ip": "127.0.0.1", + "node": "CSUXak2", + "node.role": "himrst" + } + ] diff --git a/specification/cat/component_templates/examples/200_response/CatComponentTemplatesResponseExample1.yaml b/specification/cat/component_templates/examples/200_response/CatComponentTemplatesResponseExample1.yaml index f26b38c391..8a98ba2332 100644 --- a/specification/cat/component_templates/examples/200_response/CatComponentTemplatesResponseExample1.yaml +++ b/specification/cat/component_templates/examples/200_response/CatComponentTemplatesResponseExample1.yaml @@ -1,12 +1,26 @@ # summary: description: > - A successful response from `GET _cat/aliases?v=true`. - This response shows that `alias2` has configured a filter and `alias3` and `alias4` have routing configurations. + A successful response from `GET _cat/component_templates/my-template-*?v=true&s=name&format=json`. # type: response # response_code: 200 value: |- - alias index filter routing.index routing.search is_write_index - alias1 test1 - - - - - alias2 test1 * - - - - alias3 test1 - 1 1 - - alias4 test1 - 2 1,2 - + [ + { + "name": "my-template-1", + "version": "null", + "alias_count": "0", + "mapping_count": "0", + "settings_count": "1", + "metadata_count": "0", + "included_in": "[my-index-template]" + }, + { + "name": "my-template-2", + "version": null, + "alias_count": "0", + "mapping_count": "3", + "settings_count": "0", + "metadata_count": "0", + "included_in": "[my-index-template]" + } + ] diff --git a/specification/cat/count/examples/200_response/CatCountResponseExample1.yaml b/specification/cat/count/examples/200_response/CatCountResponseExample1.yaml index af1f820407..2dfb440e12 100644 --- a/specification/cat/count/examples/200_response/CatCountResponseExample1.yaml +++ b/specification/cat/count/examples/200_response/CatCountResponseExample1.yaml @@ -1,9 +1,14 @@ summary: Single data stream or index count description: > - A successful response from `GET /_cat/count/my-index-000001?v=true`. + A successful response from `GET /_cat/count/my-index-000001?v=true&format=json`. It retrieves the document count for the `my-index-000001` data stream or index. # type: response # response_code: 200 value: |- - epoch timestamp count - 1475868259 15:24:20 120 + [ + { + "epoch": "1475868259", + "timestamp": "15:24:20", + "count": "120" + } + ] diff --git a/specification/cat/count/examples/200_response/CatCountResponseExample2.yaml b/specification/cat/count/examples/200_response/CatCountResponseExample2.yaml index 326450b3a2..d59ccfda12 100644 --- a/specification/cat/count/examples/200_response/CatCountResponseExample2.yaml +++ b/specification/cat/count/examples/200_response/CatCountResponseExample2.yaml @@ -1,9 +1,14 @@ summary: All data streams and indices count description: > - A successful response from `GET /_cat/count?v=true`. + A successful response from `GET /_cat/count?v=true&format=json`. It retrieves the document count for all data streams and indices in the cluster. # type: response # response_code: 200 value: |- - epoch timestamp count - 1475868259 15:24:20 121 + [ + { + "epoch": "1475868259", + "timestamp": "15:24:20", + "count": "121" + } + ] diff --git a/specification/cat/fielddata/examples/200_response/CatFielddataResponseExample1.yaml b/specification/cat/fielddata/examples/200_response/CatFielddataResponseExample1.yaml index 56090cf442..96f7655540 100644 --- a/specification/cat/fielddata/examples/200_response/CatFielddataResponseExample1.yaml +++ b/specification/cat/fielddata/examples/200_response/CatFielddataResponseExample1.yaml @@ -1,10 +1,18 @@ summary: Single field data description: > - A successful response from `GET /_cat/fielddata?v=true&fields=body`. + A successful response from `GET /_cat/fielddata?v=true&fields=body&format=json`. You can specify an individual field in the request body or URL path. This example retrieves heap memory size information for the `body` field. # type: response # response_code: value: |- - id host ip node field size - Nqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in body 544b + [ + { + "id": "Nqk-6inXQq-OxUfOUI8jNQ", + "host": "127.0.0.1", + "ip": "127.0.0.1", + "node": "Nqk-6in", + "field": "body", + "size": "544b" + } + ] diff --git a/specification/cat/fielddata/examples/200_response/CatFielddataResponseExample2.yaml b/specification/cat/fielddata/examples/200_response/CatFielddataResponseExample2.yaml index dd4b44a770..51053614cb 100644 --- a/specification/cat/fielddata/examples/200_response/CatFielddataResponseExample2.yaml +++ b/specification/cat/fielddata/examples/200_response/CatFielddataResponseExample2.yaml @@ -1,12 +1,27 @@ summary: Multiple fields data description: > - A successful response from `GET /_cat/fielddata/body,soul?v=true`. + A successful response from `GET /_cat/fielddata/body,soul?v=true&format=json`. You can specify a comma-separated list of fields in the request body or URL path. This example retrieves heap memory size information for the `body` and `soul` fields. To get information for all fields, run `GET /_cat/fielddata?v=true`. # type: response # response_code: value: |- - id host ip node field size - Nqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in body 544b - Nqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in soul 480b + [ + { + "id": "Nqk-6inXQq-OxUfOUI8jNQ", + "host": "1127.0.0.1", + "ip": "127.0.0.1", + "node": "Nqk-6in", + "field": "body", + "size": "544b" + }, + { + "id": "Nqk-6inXQq-OxUfOUI8jNQ", + "host": "127.0.0.1", + "ip": "127.0.0.1", + "node": "Nqk-6in", + "field": "soul", + "size": "480b" + } + ] diff --git a/specification/cat/health/examples/200_response/CatHealthResponseExample1.yaml b/specification/cat/health/examples/200_response/CatHealthResponseExample1.yaml index cbe596f9d9..e9b3690f66 100644 --- a/specification/cat/health/examples/200_response/CatHealthResponseExample1.yaml +++ b/specification/cat/health/examples/200_response/CatHealthResponseExample1.yaml @@ -1,9 +1,26 @@ # summary: description: > - A successful response from `GET /_cat/health?v=true`. + A successful response from `GET /_cat/health?v=true&format=json`. By default, it returns `HH:MM:SS` and Unix epoch timestamps. # type: response # response_code: 200 value: |- - epoch timestamp cluster status node.total node.data shards pri relo init unassign unassign.pri pending_tasks max_task_wait_time active_shards_percent - 1475871424 16:17:04 elasticsearch green 1 1 1 1 0 0 0 0 0 - 100.0% + [ + { + "epoch": "1475871424", + "timestamp": "16:17:04", + "cluster": "elasticsearch", + "status": "green", + "node.total": "1", + "node.data": "1", + "shards": "1", + "pri": "1", + "relo": "0", + "init": "0", + "unassign": "0", + "unassign.pri": "0", + "pending_tasks": "0", + "max_task_wait_time": "-", + "active_shards_percent": "100.0%" + } + ] diff --git a/specification/cat/indices/examples/200_response/CatIndicesResponseExample1.yaml b/specification/cat/indices/examples/200_response/CatIndicesResponseExample1.yaml index ceb5b24974..26f1f85633 100644 --- a/specification/cat/indices/examples/200_response/CatIndicesResponseExample1.yaml +++ b/specification/cat/indices/examples/200_response/CatIndicesResponseExample1.yaml @@ -1,9 +1,34 @@ # summary: description: > - A successful response from `GET /_cat/indices/my-index-*?v=true&s=index`. + A successful response from `GET /_cat/indices/my-index-*?v=true&s=index&format=json`. # type: response # response_code: value: |- - health status index uuid pri rep docs.count docs.deleted store.size pri.store.size dataset.size - yellow open my-index-000001 u8FNjxh8Rfy_awN11oDKYQ 1 1 1200 0 88.1kb 88.1kb 88.1kb - green open my-index-000002 nYFWZEO7TUiOjLQXBaYJpA 1 0 0 0 260b 260b 260b + [ + { + "health": "yellow", + "status": "open", + "index": "my-index-000001", + "uuid": "u8FNjxh8Rfy_awN11oDKYQ", + "pri": "1", + "rep": "1", + "docs.count": "1200", + "docs.deleted": "0", + "store.size": "88.1kb", + "pri.store.size": "88.1kb", + "dataset.size": "88.1kb" + }, + { + "health": "green", + "status": "open", + "index": "my-index-000002", + "uuid": "nYFWZEO7TUiOjLQXBaYJpA ", + "pri": "1", + "rep": "0", + "docs.count": "0", + "docs.deleted": "0", + "store.size": "260b", + "pri.store.size": "260b", + "dataset.size": "260b" + } + ] diff --git a/specification/cat/master/examples/200_response/CatMasterResponseExample1.yaml b/specification/cat/master/examples/200_response/CatMasterResponseExample1.yaml index 4124b3a62e..ac516509ca 100644 --- a/specification/cat/master/examples/200_response/CatMasterResponseExample1.yaml +++ b/specification/cat/master/examples/200_response/CatMasterResponseExample1.yaml @@ -1,8 +1,14 @@ # summary: description: > - A successful response from `GET /_cat/master?v=true`. + A successful response from `GET /_cat/master?v=true&format=json`. # type: response # response_code: value: |- - id host ip node - YzWoH_2BT-6UjVGDyPdqYg 127.0.0.1 127.0.0.1 YzWoH_2 + [ + { + "id": "YzWoH_2BT-6UjVGDyPdqYg", + "host": "127.0.0.1", + "ip": "127.0.0.1", + "node": "YzWoH_2" + } + ] diff --git a/specification/cat/ml_data_frame_analytics/examples/200_response/CatDataframeanalyticsResponseExample1.yaml b/specification/cat/ml_data_frame_analytics/examples/200_response/CatDataframeanalyticsResponseExample1.yaml index 7c0ab4cca3..b641e3bf83 100644 --- a/specification/cat/ml_data_frame_analytics/examples/200_response/CatDataframeanalyticsResponseExample1.yaml +++ b/specification/cat/ml_data_frame_analytics/examples/200_response/CatDataframeanalyticsResponseExample1.yaml @@ -1,11 +1,37 @@ # summary: -description: A successful response from `GET _cat/ml/data_frame/analytics?v=true`. +description: A successful response from `GET _cat/ml/data_frame/analytics?v=true&format=json`. # type: response # response_code: 200 value: |- - id create_time type state - classifier_job_1 2020-02-12T11:49:09.594Z classification stopped - classifier_job_2 2020-02-12T11:49:14.479Z classification stopped - classifier_job_3 2020-02-12T11:49:16.928Z classification stopped - classifier_job_4 2020-02-12T11:49:19.127Z classification stopped - classifier_job_5 2020-02-12T11:49:21.349Z classification stopped + [ + { + "id": "classifier_job_1", + "type": "classification", + "create_time": "2020-02-12T11:49:09.594Z", + "state": "stopped" + }, + { + "id": "classifier_job_2", + "type": "classification", + "create_time": "2020-02-12T11:49:14.479Z", + "state": "stopped" + }, + { + "id": "classifier_job_3", + "type": "classification", + "create_time": "2020-02-12T11:49:16.928Z", + "state": "stopped" + }, + { + "id": "classifier_job_4", + "type": "classification", + "create_time": "2020-02-12T11:49:19.127Z", + "state": "stopped" + }, + { + "id": "classifier_job_5", + "type": "classification", + "create_time": "2020-02-12T11:49:21.349Z", + "state": "stopped" + } + ] diff --git a/specification/cat/ml_datafeeds/examples/200_response/CatDatafeedsResponseExample1.yaml b/specification/cat/ml_datafeeds/examples/200_response/CatDatafeedsResponseExample1.yaml index e2e17713f1..8d0aa11e5e 100644 --- a/specification/cat/ml_datafeeds/examples/200_response/CatDatafeedsResponseExample1.yaml +++ b/specification/cat/ml_datafeeds/examples/200_response/CatDatafeedsResponseExample1.yaml @@ -1,10 +1,31 @@ # summary: -description: A successful response from `GET _cat/ml/datafeeds?v=true`. +description: A successful response from `GET _cat/ml/datafeeds?v=true&format=json`. # type: response # response_code: value: |- - id state buckets.count search.count - datafeed-high_sum_total_sales stopped 743 7 - datafeed-low_request_rate stopped 1457 3 - datafeed-response_code_rates stopped 1460 18 - datafeed-url_scanning stopped 1460 18 + [ + { + "id": "datafeed-high_sum_total_sales", + "state": "stopped", + "buckets.count": "743", + "search.count": "7" + }, + { + "id": "datafeed-low_request_rate", + "state": "stopped", + "buckets.count": "1457", + "search.count": "3" + }, + { + "id": "datafeed-response_code_rates", + "state": "stopped", + "buckets.count": "1460", + "search.count": "18" + }, + { + "id": "datafeed-url_scanning", + "state": "stopped", + "buckets.count": "1460", + "search.count": "18" + } + ] diff --git a/specification/cat/ml_jobs/examples/200_response/CatJobsResponseExample1.yaml b/specification/cat/ml_jobs/examples/200_response/CatJobsResponseExample1.yaml index 1b1d38f386..28010cc26f 100644 --- a/specification/cat/ml_jobs/examples/200_response/CatJobsResponseExample1.yaml +++ b/specification/cat/ml_jobs/examples/200_response/CatJobsResponseExample1.yaml @@ -1,8 +1,31 @@ # summary: -description: A succesful response from `GET _cat/component_templates/my-template-*?v=true&s=name`. +description: A successful response from `GET _cat/ml/anomaly_detectors?h=id,s,dpr,mb&v=true&format=json`. # type: response # response_code: '' value: |- - name version alias_count mapping_count settings_count metadata_count included_in - my-template-1 0 0 1 0 [my-index-template] - my-template-2 0 3 0 0 [my-index-template] + [ + { + "id": "high_sum_total_sales", + "s": "closed", + "dpr": "14022", + "mb": "1.5mb" + }, + { + "id": "low_request_rate", + "s": "closed", + "dpr": "1216", + "mb": "40.5kb" + }, + { + "id": "response_code_rates", + "s": "closed", + "dpr": "28146", + "mb": "132.7kb" + }, + { + "id": "url_scanning", + "s": "closed", + "dpr": "28146", + "mb": "501.6kb" + } + ] diff --git a/specification/cat/ml_trained_models/examples/200_response/CatTrainedModelsResponseExample1.yaml b/specification/cat/ml_trained_models/examples/200_response/CatTrainedModelsResponseExample1.yaml index a213f32400..0f541bd42d 100644 --- a/specification/cat/ml_trained_models/examples/200_response/CatTrainedModelsResponseExample1.yaml +++ b/specification/cat/ml_trained_models/examples/200_response/CatTrainedModelsResponseExample1.yaml @@ -1,9 +1,25 @@ # summary: -description: A successful response from `GET _cat/ml/trained_models?h=c,o,l,ct,v&v=true`. +description: A successful response from `GET _cat/ml/trained_models?v=true&format=json`. # type: response # response_code: '' value: |- - id created_by operations license create_time version - ddddd-1580216177138 _xpack 196 PLATINUM 2020-01-28T12:56:17.138Z 8.0.0 - flight-regress-1580215685537 _xpack 102 PLATINUM 2020-01-28T12:48:05.537Z 8.0.0 - lang_ident_model_1 _xpack 39629 BASIC 2019-12-05T12:28:34.594Z 7.6.0 + [ + { + "id": "ddddd-1580216177138", + "heap_size": "0b", + "operations": "196", + "create_time": "2025-03-25T00:01:38.662Z", + "type": "pytorch", + "ingest.pipelines": "0", + "data_frame.id": "__none__" + }, + { + "id": "lang_ident_model_1", + "heap_size": "1mb", + "operations": "39629", + "create_time": "2019-12-05T12:28:34.594Z", + "type": "lang_ident", + "ingest.pipelines": "0", + "data_frame.id": "__none__" + } + ] diff --git a/specification/cat/nodeattrs/examples/200_response/CatNodeAttributesResponseExample1.yaml b/specification/cat/nodeattrs/examples/200_response/CatNodeAttributesResponseExample1.yaml index 6d7affe4cf..dc5eafd1b3 100644 --- a/specification/cat/nodeattrs/examples/200_response/CatNodeAttributesResponseExample1.yaml +++ b/specification/cat/nodeattrs/examples/200_response/CatNodeAttributesResponseExample1.yaml @@ -1,10 +1,17 @@ summary: Default columns description: > - A successful response from `GET /_cat/nodeattrs?v=true`. + A successful response from `GET /_cat/nodeattrs?v=true&format=json`. The `node`, `host`, and `ip` columns provide basic information about each node. The `attr` and `value` columns return custom node attributes, one per line. # type: response # response_code: 200 value: |- - node host ip attr value - node-0 127.0.0.1 127.0.0.1 testattr test + [ + { + "node": "node-0", + "host": "127.0.0.1", + "ip": "127.0.0.1", + "attr": "testattr", + "value": "test" + } + ] diff --git a/specification/cat/nodeattrs/examples/200_response/CatNodeAttributesResponseExample2.yaml b/specification/cat/nodeattrs/examples/200_response/CatNodeAttributesResponseExample2.yaml index 4fae5ed416..1a77198435 100644 --- a/specification/cat/nodeattrs/examples/200_response/CatNodeAttributesResponseExample2.yaml +++ b/specification/cat/nodeattrs/examples/200_response/CatNodeAttributesResponseExample2.yaml @@ -5,5 +5,11 @@ description: > # type: response # response_code: 200 value: |- - name pid attr value - node-0 19566 testattr test + [ + { + "name": "node-0", + "pid": "19566", + "attr": "testattr", + "value": "test" + } + ] diff --git a/specification/cat/nodes/examples/200_response/CatNodesResponseExample1.yaml b/specification/cat/nodes/examples/200_response/CatNodesResponseExample1.yaml index 01fdfc7718..904b13bb31 100644 --- a/specification/cat/nodes/examples/200_response/CatNodesResponseExample1.yaml +++ b/specification/cat/nodes/examples/200_response/CatNodesResponseExample1.yaml @@ -1,10 +1,22 @@ summary: Default columns description: > - A successful response from `GET /_cat/nodes?v=true`. + A successful response from `GET /_cat/nodes?v=true&format=json`. The `ip`, `heap.percent`, `ram.percent`, `cpu`, and `load_*` columns provide the IP addresses and performance information of each node. The `node.role`, `master`, and `name` columns provide information useful for monitoring an entire cluster, particularly large ones. # type: response # response_code: 200 value: |- - ip heap.percent ram.percent cpu load_1m load_5m load_15m node.role master name - 127.0.0.1 65 99 42 3.07 dim * mJw06l1 + [ + { + "ip": "127.0.0.1", + "heap.percent": "65", + "ram.percent": "99", + "cpu": "42", + "load_1m": "3.07", + "load_5m": null, + "load_15m": null, + "node.role": "cdfhilmrstw", + "master": "*", + "name": "mJw06l1" + } + ] diff --git a/specification/cat/nodes/examples/200_response/CatNodesResponseExample2.yaml b/specification/cat/nodes/examples/200_response/CatNodesResponseExample2.yaml index e275a47985..71bc08096d 100644 --- a/specification/cat/nodes/examples/200_response/CatNodesResponseExample2.yaml +++ b/specification/cat/nodes/examples/200_response/CatNodesResponseExample2.yaml @@ -1,9 +1,16 @@ summary: Explicit columns description: > - A successful response from `GET /_cat/nodes?v=true&h=id,ip,port,v,m`. + A successful response from `GET /_cat/nodes?v=true&h=id,ip,port,v,m&format=json`. It returns the `id`, `ip`, `port`, `v` (version), and `m` (master) columns. # type: response # response_code: value: |- - id ip port v m - veJR 127.0.0.1 59938 8.17.0 * + [ + { + "id": "veJR", + "ip": "127.0.0.1", + "port": "59938", + "v": "9.0.0", + "m": "*" + } + ] diff --git a/specification/cat/pending_tasks/examples/200_response/CatPendingTasksResponseExample1.yaml b/specification/cat/pending_tasks/examples/200_response/CatPendingTasksResponseExample1.yaml index 9a021ada26..e45a92b23f 100644 --- a/specification/cat/pending_tasks/examples/200_response/CatPendingTasksResponseExample1.yaml +++ b/specification/cat/pending_tasks/examples/200_response/CatPendingTasksResponseExample1.yaml @@ -1,14 +1,15 @@ # summary: description: > - A successful response from `GET /_cat/pending_tasks?v=true`. + A successful response from `GET /_cat/pending_tasks?v=trueh=insertOrder,timeInQueue,priority,source&format=json`. # type: response # response_code: 200 value: |- - insertOrder timeInQueue priority source - 1685 855ms HIGH update-mapping [foo][t] - 1686 843ms HIGH update-mapping [foo][t] - 1693 753ms HIGH refresh-mapping [foo][[t]] - 1688 816ms HIGH update-mapping [foo][t] - 1689 802ms HIGH update-mapping [foo][t] - 1690 787ms HIGH update-mapping [foo][t] - 1691 773ms HIGH update-mapping [foo][t] + [ + { "insertOrder": "1685", "timeInQueue": "855ms", "priority": "HIGH", "source": "update-mapping [foo][t]"}, + { "insertOrder": "1686", "timeInQueue": "843ms", "priority": "HIGH", "source": "update-mapping [foo][t]"}, + { "insertOrder": "1693", "timeInQueue": "753ms", "priority": "HIGH", "source": "refresh-mapping [foo][[t]]"}, + { "insertOrder": "1688", "timeInQueue": "816ms", "priority": "HIGH", "source": "update-mapping [foo][t]"}, + { "insertOrder": "1689", "timeInQueue": "802ms", "priority": "HIGH", "source": "update-mapping [foo][t]"}, + { "insertOrder": "1690", "timeInQueue": "787ms", "priority": "HIGH", "source": "update-mapping [foo][t]"}, + { "insertOrder": "1691", "timeInQueue": "773ms", "priority": "HIGH", "source": "update-mapping [foo][t]"} + ] diff --git a/specification/cat/plugins/examples/200_response/CatPluginsResponseExample1.yaml b/specification/cat/plugins/examples/200_response/CatPluginsResponseExample1.yaml index 1fba45a722..1183e39563 100644 --- a/specification/cat/plugins/examples/200_response/CatPluginsResponseExample1.yaml +++ b/specification/cat/plugins/examples/200_response/CatPluginsResponseExample1.yaml @@ -1,21 +1,22 @@ # summary: description: > - A successful response from `GET /_cat/plugins?v=true&s=component&h=name,component,version,description`. + A successful response from `GET /_cat/plugins?v=true&s=component&h=name,component,version,description&format=json`. # type: response # response_code: value: |- - name component version description - U7321H6 analysis-icu 8.17.0 The ICU Analysis plugin integrates the Lucene ICU module into Elasticsearch, adding ICU-related analysis components. - U7321H6 analysis-kuromoji 8.17.0 The Japanese (kuromoji) Analysis plugin integrates Lucene kuromoji analysis module into elasticsearch. - U7321H6 analysis-nori 8.17.0 The Korean (nori) Analysis plugin integrates Lucene nori analysis module into elasticsearch. - U7321H6 analysis-phonetic 8.17.0 The Phonetic Analysis plugin integrates phonetic token filter analysis with elasticsearch. - U7321H6 analysis-smartcn 8.17.0 Smart Chinese Analysis plugin integrates Lucene Smart Chinese analysis module into elasticsearch. - U7321H6 analysis-stempel 8.17.0 The Stempel (Polish) Analysis plugin integrates Lucene stempel (polish) analysis module into elasticsearch. - U7321H6 analysis-ukrainian 8.17.0 The Ukrainian Analysis plugin integrates the Lucene UkrainianMorfologikAnalyzer into elasticsearch. - U7321H6 discovery-azure-classic 8.17.0 The Azure Classic Discovery plugin allows to use Azure Classic API for the unicast discovery mechanism - U7321H6 discovery-ec2 8.17.0 The EC2 discovery plugin allows to use AWS API for the unicast discovery mechanism. - U7321H6 discovery-gce 8.17.0 The Google Compute Engine (GCE) Discovery plugin allows to use GCE API for the unicast discovery mechanism. - U7321H6 mapper-annotated-text 8.17.0 The Mapper Annotated_text plugin adds support for text fields with markup used to inject annotation tokens into the index. - U7321H6 mapper-murmur3 8.17.0 The Mapper Murmur3 plugin allows to compute hashes of a field's values at index-time and to store them in the index. - U7321H6 mapper-size 8.17.0 The Mapper Size plugin allows document to record their uncompressed size at index time. - U7321H6 store-smb 8.17.0 The Store SMB plugin adds support for SMB stores. + [ + { "name": "U7321H6", "component": "analysis-icu", "version": "8.17.0", "description": "The ICU Analysis plugin integrates the Lucene ICU module into Elasticsearch, adding ICU-related analysis components."}, + {"name": "U7321H6", "component": "analysis-kuromoji", "verison": "8.17.0", description: "The Japanese (kuromoji) Analysis plugin integrates Lucene kuromoji analysis module into elasticsearch."}, + {"name" "U7321H6", "component": "analysis-nori", "version": "8.17.0", "description": "The Korean (nori) Analysis plugin integrates Lucene nori analysis module into elasticsearch."}, + {"name": "U7321H6", "component": "analysis-phonetic", "verison": "8.17.0", "description": "The Phonetic Analysis plugin integrates phonetic token filter analysis with elasticsearch."}, + {"name": "U7321H6", "component": "analysis-smartcn", "verison": "8.17.0", "description": "Smart Chinese Analysis plugin integrates Lucene Smart Chinese analysis module into elasticsearch."}, + {"name": "U7321H6", "component": "analysis-stempel", "verison": "8.17.0", "description": "The Stempel (Polish) Analysis plugin integrates Lucene stempel (polish) analysis module into elasticsearch."}, + {"name": "U7321H6", "component": "analysis-ukrainian", "verison": "8.17.0", "description": "The Ukrainian Analysis plugin integrates the Lucene UkrainianMorfologikAnalyzer into elasticsearch."}, + {"name": "U7321H6", "component": "discovery-azure-classic", "verison": "8.17.0", "description": "The Azure Classic Discovery plugin allows to use Azure Classic API for the unicast discovery mechanism"}, + {"name": "U7321H6", "component": "discovery-ec2", "verison": "8.17.0", "description": "The EC2 discovery plugin allows to use AWS API for the unicast discovery mechanism."}, + {"name": "U7321H6", "component": "discovery-gce", "verison": "8.17.0", "description": "The Google Compute Engine (GCE) Discovery plugin allows to use GCE API for the unicast discovery mechanism."}, + {"name": "U7321H6", "component": "mapper-annotated-text", "verison": "8.17.0", "description": "The Mapper Annotated_text plugin adds support for text fields with markup used to inject annotation tokens into the index."}, + {"name": "U7321H6", "component": "mapper-murmur3", "verison": "8.17.0", "description": "The Mapper Murmur3 plugin allows to compute hashes of a field's values at index-time and to store them in the index."}, + {"name": "U7321H6", "component": "mapper-size", "verison": "8.17.0", "description": "The Mapper Size plugin allows document to record their uncompressed size at index time."}, + {"name": "U7321H6", "component": "store-smb", "verison": "8.17.0", "description": "The Store SMB plugin adds support for SMB stores."} + ] diff --git a/specification/cat/recovery/examples/200_response/CatRecoveryResponseExample1.yaml b/specification/cat/recovery/examples/200_response/CatRecoveryResponseExample1.yaml index 34ed5bcd39..9af7adbebb 100644 --- a/specification/cat/recovery/examples/200_response/CatRecoveryResponseExample1.yaml +++ b/specification/cat/recovery/examples/200_response/CatRecoveryResponseExample1.yaml @@ -1,9 +1,33 @@ summary: No ongoing recoveries description: > - A successful response from `GET _cat/recovery?v=true`. + A successful response from `GET _cat/recovery?v=true&format=json`. In this example, the source and target nodes are the same because the recovery type is `store`, meaning they were read from local storage on node start. # type: response # response_code: 200 value: |- - index shard time type stage source_host source_node target_host target_node repository snapshot files files_recovered files_percent files_total bytes bytes_recovered bytes_percent bytes_total translog_ops translog_ops_recovered translog_ops_percent - my-index-000001 0 13ms store done n/a n/a 127.0.0.1 node-0 n/a n/a 0 0 100% 13 0b 0b 100% 9928b 0 0 100.0% + [ + { + "index": "my-index-000001 ", + "shard": "0", + "time": "13ms", + "type": "store", + "stage": "done", + "source_host": "n/a", + "source_node": "n/a", + "target_host": "127.0.0.1", + "target_node": "node-0", + "repository": "n/a", + "snapshot": "n/a", + "files": "0", + "files_recovered": "0", + "files_percent": "100.0%", + "files_total": "13", + "bytes": "0b", + "bytes_recovered": "0b", + "bytes_percent": "100.0%", + "bytes_total": "9928b", + "translog_ops": "0", + "translog_ops_recovered": "0", + "translog_ops_percent": "100.0%" + } + ] diff --git a/specification/cat/recovery/examples/200_response/CatRecoveryResponseExample2.yaml b/specification/cat/recovery/examples/200_response/CatRecoveryResponseExample2.yaml index df7f8f6c7b..814047a0d2 100644 --- a/specification/cat/recovery/examples/200_response/CatRecoveryResponseExample2.yaml +++ b/specification/cat/recovery/examples/200_response/CatRecoveryResponseExample2.yaml @@ -1,11 +1,24 @@ summary: A live shard recovery description: > - A successful response from `GET _cat/recovery?v=true&h=i,s,t,ty,st,shost,thost,f,fp,b,bp`. + A successful response from `GET _cat/recovery?v=true&h=i,s,t,ty,st,shost,thost,f,fp,b,bp&format=json`. You can retrieve information about an ongoing recovery for example when you increase the replica count of an index and bring another node online to host the replicas. In this example, the recovery type is `peer`, meaning the shard recovered from another node. The `files` and `bytes` are real-time measurements. # type: response # response_code: 200 value: |- - i s t ty st shost thost f fp b bp - my-index-000001 0 1252ms peer done 192.168.1.1 192.168.1.2 0 100.0% 0b 100.0% + [ + { + "i": "my-index-000001", + "s": "0", + "t": "1252ms", + "ty": "peer", + "st": "done", + "shost": "192.168.1.1", + "thost": "192.168.1.1", + "f": "0", + "fp": "100.0%", + "b": "0b", + "bp": "100.0%", + } + ] diff --git a/specification/cat/recovery/examples/200_response/CatRecoveryResponseExample3.yaml b/specification/cat/recovery/examples/200_response/CatRecoveryResponseExample3.yaml index 2e4c852e75..5e5b7a04f7 100644 --- a/specification/cat/recovery/examples/200_response/CatRecoveryResponseExample3.yaml +++ b/specification/cat/recovery/examples/200_response/CatRecoveryResponseExample3.yaml @@ -1,10 +1,23 @@ summary: A snapshot recovery description: > - A successful response from `GET _cat/recovery?v=true&h=i,s,t,ty,st,rep,snap,f,fp,b,bp`. + A successful response from `GET _cat/recovery?v=true&h=i,s,t,ty,st,rep,snap,f,fp,b,bp&format=json`. You can restore backups of an index using the snapshot and restore API. You can use the cat recovery API to get information about a snapshot recovery. # type: response # response_code: 200 value: |- - i s t ty st rep snap f fp b bp - my-index-000001 0 1978ms snapshot done my-repo snap-1 79 8.0% 12086 9.0% + [ + { + "i": "my-index-000001", + "s": "0", + "t": "1978ms", + "ty": "snapshot", + "st": "done", + "rep": "my-repo", + "snap": "snap-1", + "f": "79", + "fp": "8.0%", + "b": "12086", + "bp": "9.0%" + } + ] diff --git a/specification/cat/repositories/examples/200_response/CatRepositoriesResponseExample1.yaml b/specification/cat/repositories/examples/200_response/CatRepositoriesResponseExample1.yaml index 3a857df658..e2d6e3c23f 100644 --- a/specification/cat/repositories/examples/200_response/CatRepositoriesResponseExample1.yaml +++ b/specification/cat/repositories/examples/200_response/CatRepositoriesResponseExample1.yaml @@ -1,9 +1,16 @@ # summary: description: > - A successful response from `GET /_cat/repositories?v=true`. + A successful response from `GET /_cat/repositories?v=true&format=json`. # type: response # response_code: 200 value: |- - id type - repo1 fs - repo2 s3 + [ + { + "id": "repo1", + "type": "fs" + }, + { + "id": "repo2", + "type": "s3" + } + ] diff --git a/specification/cat/segments/examples/200_response/CatSegmentsResponseExample1.yaml b/specification/cat/segments/examples/200_response/CatSegmentsResponseExample1.yaml index a93ad160fa..842cc08021 100644 --- a/specification/cat/segments/examples/200_response/CatSegmentsResponseExample1.yaml +++ b/specification/cat/segments/examples/200_response/CatSegmentsResponseExample1.yaml @@ -1,9 +1,40 @@ # summary: description: > - A successful response from `GET /_cat/segments?v=true`. + A successful response from `GET /_cat/segments?v=true&format=json`. # type: response # response_code: 200 value: |- - index shard prirep ip segment generation docs.count docs.deleted size size.memory committed searchable version compound - test 0 p 127.0.0.1 _0 0 1 0 3kb 0 false true 9.12.0 true - test1 0 p 127.0.0.1 _0 0 1 0 3kb 0 false true 9.12.0 true + [ + { + "index": "test", + "shard": "0", + "prirep": "p", + "ip": "127.0.0.1", + "segment": "_0", + "generation": "0", + "docs.count": "1", + "docs.deleted": "0", + "size": "3kb", + "size.memory": "0", + "committed": "false", + "searchable": "true", + "version": "9.12.0", + "compound": "true" + }, + { + "index": "test1", + "shard": "0", + "prirep": "p", + "ip": "127.0.0.1", + "segment": "_0", + "generation": "0", + "docs.count": "1", + "docs.deleted": "0", + "size": "3kb", + "size.memory": "0", + "committed": "false", + "searchable": "true", + "version": "9.12.0", + "compound": "true" + } + ] diff --git a/specification/cat/shards/examples/200_response/CatShardsResponseExample1.yaml b/specification/cat/shards/examples/200_response/CatShardsResponseExample1.yaml index 8f473d6578..5382e345a1 100644 --- a/specification/cat/shards/examples/200_response/CatShardsResponseExample1.yaml +++ b/specification/cat/shards/examples/200_response/CatShardsResponseExample1.yaml @@ -1,7 +1,19 @@ summary: A single data stream or index description: > - A successful response from `GET _cat/shards`. + A successful response from `GET _cat/shards?format=json`. # type: response # response_code: 200 value: |- - my-index-000001 0 p STARTED 3014 31.1mb 192.168.56.10 H5dfFeA + [ + { + "index": "my-index-000001", + "shard": "0", + "prirep": "p", + "state": "STARTED", + "docs": "3014", + "store": "31.1mb", + "dataset": "249b", + "ip": "192.168.56.10", + "node": "H5dfFeA" + } + ] diff --git a/specification/cat/shards/examples/200_response/CatShardsResponseExample2.yaml b/specification/cat/shards/examples/200_response/CatShardsResponseExample2.yaml index d92faac6b2..623ab69962 100644 --- a/specification/cat/shards/examples/200_response/CatShardsResponseExample2.yaml +++ b/specification/cat/shards/examples/200_response/CatShardsResponseExample2.yaml @@ -1,8 +1,20 @@ summary: A wildcard pattern description: > - A successful response from `GET _cat/shards/my-index-*`. + A successful response from `GET _cat/shards/my-index-*?format=json`. It returns information for any data streams or indices beginning with `my-index-`. # type: response # response_code: 200 value: |- - my-index-000001 0 p STARTED 3014 31.1mb 192.168.56.10 H5dfFeA + [ + { + "index": "my-index-000001", + "shard": "0", + "prirep": "p", + "state": "STARTED", + "docs": "3014", + "store": "31.1mb", + "dataset": "249b", + "ip": "192.168.56.10", + "node": "H5dfFeA" + } + ] diff --git a/specification/cat/shards/examples/200_response/CatShardsResponseExample3.yaml b/specification/cat/shards/examples/200_response/CatShardsResponseExample3.yaml index e4380dacc0..3e57c66b71 100644 --- a/specification/cat/shards/examples/200_response/CatShardsResponseExample3.yaml +++ b/specification/cat/shards/examples/200_response/CatShardsResponseExample3.yaml @@ -1,8 +1,20 @@ summary: A relocating shard description: > - A successful response from `GET _cat/shards`. + A successful response from `GET _cat/shards?format=json`. The `RELOCATING` value in the `state` column indicates the index shard is relocating. # type: response # response_code: 200 value: |- - my-index-000001 0 p RELOCATING 3014 31.1mb 192.168.56.10 H5dfFeA -> -> 192.168.56.30 bGG90GE + [ + { + "index": "my-index-000001", + "shard": "0", + "prirep": "p", + "state": "RELOCATING", + "docs": "3014", + "store": "31.1mb", + "dataset": "249b", + "ip": "192.168.56.10", + "node": "H5dfFeA -> -> 192.168.56.30 bGG90GE" + } + ] diff --git a/specification/cat/shards/examples/200_response/CatShardsResponseExample4.yaml b/specification/cat/shards/examples/200_response/CatShardsResponseExample4.yaml index 01ad25c9be..193ff6bd3b 100644 --- a/specification/cat/shards/examples/200_response/CatShardsResponseExample4.yaml +++ b/specification/cat/shards/examples/200_response/CatShardsResponseExample4.yaml @@ -1,10 +1,32 @@ summary: Shard states description: > - A successful response from `GET _cat/shards`. + A successful response from `GET _cat/shards?format=json`. Before a shard is available for use, it goes through an `INITIALIZING` state. You can use the cat shards API to see which shards are initializing. # type: response # response_code: 200 value: |- - my-index-000001 0 p STARTED 3014 31.1mb 192.168.56.10 H5dfFeA - my-index-000001 0 r INITIALIZING 0 14.3mb 192.168.56.30 bGG90GE + [ + { + "index": "my-index-000001", + "shard": "0", + "prirep": "p", + "state": "STARTED", + "docs": "3014", + "store": "31.1mb", + "dataset": "249b", + "ip": "192.168.56.10", + "node": "H5dfFeA" + }, + { + "index": "my-index-000001", + "shard": "0", + "prirep": "r", + "state": "INITIALIZING", + "docs": "0", + "store": "14.3mb", + "dataset": "249b", + "ip": "192.168.56.30", + "node": "bGG90GE" + } + ] diff --git a/specification/cat/shards/examples/200_response/CatShardsResponseExample5.yaml b/specification/cat/shards/examples/200_response/CatShardsResponseExample5.yaml index 25313b1b70..b7b09dbb49 100644 --- a/specification/cat/shards/examples/200_response/CatShardsResponseExample5.yaml +++ b/specification/cat/shards/examples/200_response/CatShardsResponseExample5.yaml @@ -1,11 +1,37 @@ summary: Reasons for unassigned shards description: > - A successful response from `GET _cat/shards?h=index,shard,prirep,state,unassigned.reason`. + A successful response from `GET _cat/shards?h=index,shard,prirep,state,unassigned.reason&format=json`. It includes the `unassigned.reason` column, which indicates why a shard is unassigned. # type: response # response_code: 200 value: |- - my-index-000001 0 p STARTED 3014 31.1mb 192.168.56.10 H5dfFeA - my-index-000001 0 r STARTED 3014 31.1mb 192.168.56.30 bGG90GE - my-index-000001 0 r STARTED 3014 31.1mb 192.168.56.20 I8hydUG - my-index-000001 0 r UNASSIGNED ALLOCATION_FAILED + [ + { + "index": "my-index-000001", + "shard": "0", + "prirep": "p", + "state": "STARTED", + "unassigned.reason": "3014 31.1mb 192.168.56.10 H5dfFeA" + }, + { + "index": "my-index-000001", + "shard": "0", + "prirep": "r", + "state": "STARTED", + "unassigned.reason": "3014 31.1mb 192.168.56.30 bGG90GE" + }, + { + "index": "my-index-000001", + "shard": "0", + "prirep": "r", + "state": "STARTED", + "unassigned.reason": "3014 31.1mb 192.168.56.20 I8hydUG" + }, + { + "index": "my-index-000001", + "shard": "0", + "prirep": "r", + "state": "UNASSIGNED", + "unassigned.reason": "ALLOCATION_FAILED" + } + ] diff --git a/specification/cat/snapshots/examples/200_response/CatSnapshotsResponseExample1.yaml b/specification/cat/snapshots/examples/200_response/CatSnapshotsResponseExample1.yaml index c9f31cf7a8..87e6bc4ed6 100644 --- a/specification/cat/snapshots/examples/200_response/CatSnapshotsResponseExample1.yaml +++ b/specification/cat/snapshots/examples/200_response/CatSnapshotsResponseExample1.yaml @@ -1,9 +1,36 @@ # summary: description: > - A successful response from `GET /_cat/snapshots/repo1?v=true&s=id`. + A successful response from `GET /_cat/snapshots/repo1?v=true&s=id&format=json`. # type: response # response_code: 200 value: |- - id repository status start_epoch start_time end_epoch end_time duration indices successful_shards failed_shards total_shards - snap1 repo1 FAILED 1445616705 18:11:45 1445616978 18:16:18 4.6m 1 4 1 5 - snap2 repo1 SUCCESS 1445634298 23:04:58 1445634672 23:11:12 6.2m 2 10 0 10 + [ + { + "id": "snap1", + "repository": "repo1", + "status": "FAILED", + "start_epoch": "1445616705", + "start_time": "18:11:45", + "end_epoch": "1445616978", + "end_time": "18:16:18", + "duration": "4.6m", + "indices": "1", + "successful_shards": "4", + "failed_shards": "1", + "total_shards": "5" + }, + { + "id": "snap2", + "repository": "repo1", + "status": "SUCCESS", + "start_epoch": "1445634298", + "start_time": "23:04:58", + "end_epoch": "1445634672", + "end_time": "23:11:12", + "duration": "6.2m", + "indices": "2", + "successful_shards": "10", + "failed_shards": "0", + "total_shards": "10" + } + ] diff --git a/specification/cat/tasks/examples/200_response/CatTasksResponseExample1.yaml b/specification/cat/tasks/examples/200_response/CatTasksResponseExample1.yaml index 8d05b0a9d2..acfea87edd 100644 --- a/specification/cat/tasks/examples/200_response/CatTasksResponseExample1.yaml +++ b/specification/cat/tasks/examples/200_response/CatTasksResponseExample1.yaml @@ -1,8 +1,29 @@ # summary: -description: A successful response from `GET _cat/tasks?v=true`. +description: A successful response from `GET _cat/tasks?v=true&format=json`. # type: response # response_code: 200 value: |- - action task_id parent_task_id type start_time timestamp running_time ip node - cluster:monitor/tasks/lists[n] oTUltX4IQMOUUVeiohTt8A:124 oTUltX4IQMOUUVeiohTt8A:123 direct 1458585884904 01:48:24 44.1micros 127.0.0.1:9300 oTUltX4IQMOUUVeiohTt8A - cluster:monitor/tasks/lists oTUltX4IQMOUUVeiohTt8A:123 - transport 1458585884904 01:48:24 186.2micros 127.0.0.1:9300 oTUltX4IQMOUUVeiohTt8A + [ + { + "action": "cluster:monitor/tasks/lists[n]", + "task_id": "oTUltX4IQMOUUVeiohTt8A:124", + "parent_task_id": "oTUltX4IQMOUUVeiohTt8A:123", + "type": "direct", + "start_time": "1458585884904", + "timestamp": "01:48:24", + "running_time": "44.1micros", + "ip": "127.0.0.1:9300", + "node": "oTUltX4IQMOUUVeiohTt8A" + }, + { + "action": "cluster:monitor/tasks/lists", + "task_id": "oTUltX4IQMOUUVeiohTt8A:123", + "parent_task_id": "-", + "type": "transport", + "start_time": "1458585884904", + "timestamp": "01:48:24", + "running_time": "186.2micros", + "ip": "127.0.0.1:9300", + "node": "oTUltX4IQMOUUVeiohTt8A" + } + ] diff --git a/specification/cat/templates/examples/200_response/CatTemplatesResponseExample1.yaml b/specification/cat/templates/examples/200_response/CatTemplatesResponseExample1.yaml index af3110b0f8..3d08e3bd60 100644 --- a/specification/cat/templates/examples/200_response/CatTemplatesResponseExample1.yaml +++ b/specification/cat/templates/examples/200_response/CatTemplatesResponseExample1.yaml @@ -1,10 +1,29 @@ # summary: description: > - A successful response from `GET _cat/templates/my-template-*?v=true&s=name`. + A successful response from `GET _cat/templates/my-template-*?v=true&s=name&format=json`. # type: response # response_code: 200 value: |- - name index_patterns order version composed_of - my-template-0 [te*] 500 [] - my-template-1 [tea*] 501 [] - my-template-2 [teak*] 502 7 [] + [ + { + "name": "my-template-0", + "index_patterns": "[te*]", + "order": "500", + "version": null, + "composed_of": "[]" + }, + { + "name": "my-template-1", + "index_patterns": "[tea*]", + "order": "501", + "version": null, + "composed_of": "[]" + }, + { + "name": "my-template-2", + "index_patterns": "[teak*]", + "order": "502", + "version": "7", + "composed_of": "[]" + } + ] diff --git a/specification/cat/thread_pool/examples/200_response/CatThreadPoolResponseExample1.yaml b/specification/cat/thread_pool/examples/200_response/CatThreadPoolResponseExample1.yaml index e62c1780cc..b3e025acd7 100644 --- a/specification/cat/thread_pool/examples/200_response/CatThreadPoolResponseExample1.yaml +++ b/specification/cat/thread_pool/examples/200_response/CatThreadPoolResponseExample1.yaml @@ -1,11 +1,43 @@ summary: Default columns description: > - A successful response from `GET /_cat/thread_pool`. + A successful response from `GET /_cat/thread_pool?format=json`. # type: response # response_code: 200 value: |- - node-0 analyze 0 0 0 - node-0 fetch_shard_started 0 0 0 - node-0 fetch_shard_store 0 0 0 - node-0 flush 0 0 0 - node-0 write 0 0 0 + [ + { + "node_name": "node-0", + "name": "analyze", + "active": "0", + "queue": "0", + "rejected": "0" + }, + { + "node_name": "node-0", + "name": "fetch_shard_started", + "active": "0", + "queue": "0", + "rejected": "0" + }, + { + "node_name": "node-0", + "name": "fetch_shard_store", + "active": "0", + "queue": "0", + "rejected": "0" + }, + { + "node_name": "node-0", + "name": "flush", + "active": "0", + "queue": "0", + "rejected": "0" + }, + { + "node_name": "node-0", + "name": "write", + "active": "0", + "queue": "0", + "rejected": "0" + } + ] diff --git a/specification/cat/thread_pool/examples/200_response/CatThreadPoolResponseExample2.yaml b/specification/cat/thread_pool/examples/200_response/CatThreadPoolResponseExample2.yaml index 861ae9dc46..8c7b2cfa36 100644 --- a/specification/cat/thread_pool/examples/200_response/CatThreadPoolResponseExample2.yaml +++ b/specification/cat/thread_pool/examples/200_response/CatThreadPoolResponseExample2.yaml @@ -1,10 +1,17 @@ summary: Explicit columns description: > - A successful response from `GET /_cat/thread_pool/generic?v=true&h=id,name,active,rejected,completed`. + A successful response from `GET /_cat/thread_pool/generic?v=true&h=id,name,active,rejected,completed&format=json`. It returns the `id`, `name`, `active`, `rejected`, and `completed` columns. It also limits returned information to the generic thread pool. # type: response # response_code: 200 value: |- - id name active rejected completed - 0EWUhXeBQtaVGlexUeVwMg generic 0 0 70 + [ + { + "id": "0EWUhXeBQtaVGlexUeVwMg", + "name": "generic", + "active": "0", + "rejected": "0", + "completed": "70" + } + ]