diff --git a/docs/examples/languageExamples.json b/docs/examples/languageExamples.json index 52cdfb6409..3ea67cc3b5 100644 --- a/docs/examples/languageExamples.json +++ b/docs/examples/languageExamples.json @@ -1354,23 +1354,23 @@ "specification/cluster/put_component_template/examples/request/ClusterPutComponentTemplateRequestExample1.yaml": [ { "language": "Python", - "code": "resp = client.cluster.put_component_template(\n name=\"template_1\",\n template=None,\n settings={\n \"number_of_shards\": 1\n },\n mappings={\n \"_source\": {\n \"enabled\": False\n },\n \"properties\": {\n \"host_name\": {\n \"type\": \"keyword\"\n },\n \"created_at\": {\n \"type\": \"date\",\n \"format\": \"EEE MMM dd HH:mm:ss Z yyyy\"\n }\n }\n },\n)" + "code": "resp = client.cluster.put_component_template(\n name=\"template_1\",\n template={\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"mappings\": {\n \"_source\": {\n \"enabled\": False\n },\n \"properties\": {\n \"host_name\": {\n \"type\": \"keyword\"\n },\n \"created_at\": {\n \"type\": \"date\",\n \"format\": \"EEE MMM dd HH:mm:ss Z yyyy\"\n }\n }\n }\n },\n)" }, { "language": "JavaScript", - "code": "const response = await client.cluster.putComponentTemplate({\n name: \"template_1\",\n template: null,\n settings: {\n number_of_shards: 1,\n },\n mappings: {\n _source: {\n enabled: false,\n },\n properties: {\n host_name: {\n type: \"keyword\",\n },\n created_at: {\n type: \"date\",\n format: \"EEE MMM dd HH:mm:ss Z yyyy\",\n },\n },\n },\n});" + "code": "const response = await client.cluster.putComponentTemplate({\n name: \"template_1\",\n template: {\n settings: {\n number_of_shards: 1,\n },\n mappings: {\n _source: {\n enabled: false,\n },\n properties: {\n host_name: {\n type: \"keyword\",\n },\n created_at: {\n type: \"date\",\n format: \"EEE MMM dd HH:mm:ss Z yyyy\",\n },\n },\n },\n },\n});" }, { "language": "Ruby", - "code": "response = client.cluster.put_component_template(\n name: \"template_1\",\n body: {\n \"template\": nil,\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"mappings\": {\n \"_source\": {\n \"enabled\": false\n },\n \"properties\": {\n \"host_name\": {\n \"type\": \"keyword\"\n },\n \"created_at\": {\n \"type\": \"date\",\n \"format\": \"EEE MMM dd HH:mm:ss Z yyyy\"\n }\n }\n }\n }\n)" + "code": "response = client.cluster.put_component_template(\n name: \"template_1\",\n body: {\n \"template\": {\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"mappings\": {\n \"_source\": {\n \"enabled\": false\n },\n \"properties\": {\n \"host_name\": {\n \"type\": \"keyword\"\n },\n \"created_at\": {\n \"type\": \"date\",\n \"format\": \"EEE MMM dd HH:mm:ss Z yyyy\"\n }\n }\n }\n }\n }\n)" }, { "language": "PHP", - "code": "$resp = $client->cluster()->putComponentTemplate([\n \"name\" => \"template_1\",\n \"body\" => [\n \"template\" => null,\n \"settings\" => [\n \"number_of_shards\" => 1,\n ],\n \"mappings\" => [\n \"_source\" => [\n \"enabled\" => false,\n ],\n \"properties\" => [\n \"host_name\" => [\n \"type\" => \"keyword\",\n ],\n \"created_at\" => [\n \"type\" => \"date\",\n \"format\" => \"EEE MMM dd HH:mm:ss Z yyyy\",\n ],\n ],\n ],\n ],\n]);" + "code": "$resp = $client->cluster()->putComponentTemplate([\n \"name\" => \"template_1\",\n \"body\" => [\n \"template\" => [\n \"settings\" => [\n \"number_of_shards\" => 1,\n ],\n \"mappings\" => [\n \"_source\" => [\n \"enabled\" => false,\n ],\n \"properties\" => [\n \"host_name\" => [\n \"type\" => \"keyword\",\n ],\n \"created_at\" => [\n \"type\" => \"date\",\n \"format\" => \"EEE MMM dd HH:mm:ss Z yyyy\",\n ],\n ],\n ],\n ],\n ],\n]);" }, { "language": "curl", - "code": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"template\":null,\"settings\":{\"number_of_shards\":1},\"mappings\":{\"_source\":{\"enabled\":false},\"properties\":{\"host_name\":{\"type\":\"keyword\"},\"created_at\":{\"type\":\"date\",\"format\":\"EEE MMM dd HH:mm:ss Z yyyy\"}}}}' \"$ELASTICSEARCH_URL/_component_template/template_1\"" + "code": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"template\":{\"settings\":{\"number_of_shards\":1},\"mappings\":{\"_source\":{\"enabled\":false},\"properties\":{\"host_name\":{\"type\":\"keyword\"},\"created_at\":{\"type\":\"date\",\"format\":\"EEE MMM dd HH:mm:ss Z yyyy\"}}}}}' \"$ELASTICSEARCH_URL/_component_template/template_1\"" } ], "specification/cluster/put_component_template/examples/request/ClusterPutComponentTemplateRequestExample2.yaml": [ @@ -2032,23 +2032,23 @@ "specification/indices/put_template/examples/request/indicesPutTemplateRequestExample1.yaml": [ { "language": "Python", - "code": "resp = client.indices.put_template(\n name=\"template_1\",\n index_patterns=[\n \"te*\",\n \"bar*\"\n ],\n settings={\n \"number_of_shards\": 1\n },\n mappings={\n \"_source\": {\n \"enabled\": False\n }\n },\n properties={\n \"host_name\": {\n \"type\": \"keyword\"\n },\n \"created_at\": {\n \"type\": \"date\",\n \"format\": \"EEE MMM dd HH:mm:ss Z yyyy\"\n }\n },\n)" + "code": "resp = client.indices.put_template(\n name=\"template_1\",\n index_patterns=[\n \"te*\",\n \"bar*\"\n ],\n settings={\n \"number_of_shards\": 1\n },\n mappings={\n \"_source\": {\n \"enabled\": False\n },\n \"properties\": {\n \"host_name\": {\n \"type\": \"keyword\"\n },\n \"created_at\": {\n \"type\": \"date\",\n \"format\": \"EEE MMM dd HH:mm:ss Z yyyy\"\n }\n }\n },\n)" }, { "language": "JavaScript", - "code": "const response = await client.indices.putTemplate({\n name: \"template_1\",\n index_patterns: [\"te*\", \"bar*\"],\n settings: {\n number_of_shards: 1,\n },\n mappings: {\n _source: {\n enabled: false,\n },\n },\n properties: {\n host_name: {\n type: \"keyword\",\n },\n created_at: {\n type: \"date\",\n format: \"EEE MMM dd HH:mm:ss Z yyyy\",\n },\n },\n});" + "code": "const response = await client.indices.putTemplate({\n name: \"template_1\",\n index_patterns: [\"te*\", \"bar*\"],\n settings: {\n number_of_shards: 1,\n },\n mappings: {\n _source: {\n enabled: false,\n },\n properties: {\n host_name: {\n type: \"keyword\",\n },\n created_at: {\n type: \"date\",\n format: \"EEE MMM dd HH:mm:ss Z yyyy\",\n },\n },\n },\n});" }, { "language": "Ruby", - "code": "response = client.indices.put_template(\n name: \"template_1\",\n body: {\n \"index_patterns\": [\n \"te*\",\n \"bar*\"\n ],\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"mappings\": {\n \"_source\": {\n \"enabled\": false\n }\n },\n \"properties\": {\n \"host_name\": {\n \"type\": \"keyword\"\n },\n \"created_at\": {\n \"type\": \"date\",\n \"format\": \"EEE MMM dd HH:mm:ss Z yyyy\"\n }\n }\n }\n)" + "code": "response = client.indices.put_template(\n name: \"template_1\",\n body: {\n \"index_patterns\": [\n \"te*\",\n \"bar*\"\n ],\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"mappings\": {\n \"_source\": {\n \"enabled\": false\n },\n \"properties\": {\n \"host_name\": {\n \"type\": \"keyword\"\n },\n \"created_at\": {\n \"type\": \"date\",\n \"format\": \"EEE MMM dd HH:mm:ss Z yyyy\"\n }\n }\n }\n }\n)" }, { "language": "PHP", - "code": "$resp = $client->indices()->putTemplate([\n \"name\" => \"template_1\",\n \"body\" => [\n \"index_patterns\" => array(\n \"te*\",\n \"bar*\",\n ),\n \"settings\" => [\n \"number_of_shards\" => 1,\n ],\n \"mappings\" => [\n \"_source\" => [\n \"enabled\" => false,\n ],\n ],\n \"properties\" => [\n \"host_name\" => [\n \"type\" => \"keyword\",\n ],\n \"created_at\" => [\n \"type\" => \"date\",\n \"format\" => \"EEE MMM dd HH:mm:ss Z yyyy\",\n ],\n ],\n ],\n]);" + "code": "$resp = $client->indices()->putTemplate([\n \"name\" => \"template_1\",\n \"body\" => [\n \"index_patterns\" => array(\n \"te*\",\n \"bar*\",\n ),\n \"settings\" => [\n \"number_of_shards\" => 1,\n ],\n \"mappings\" => [\n \"_source\" => [\n \"enabled\" => false,\n ],\n \"properties\" => [\n \"host_name\" => [\n \"type\" => \"keyword\",\n ],\n \"created_at\" => [\n \"type\" => \"date\",\n \"format\" => \"EEE MMM dd HH:mm:ss Z yyyy\",\n ],\n ],\n ],\n ],\n]);" }, { "language": "curl", - "code": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"index_patterns\":[\"te*\",\"bar*\"],\"settings\":{\"number_of_shards\":1},\"mappings\":{\"_source\":{\"enabled\":false}},\"properties\":{\"host_name\":{\"type\":\"keyword\"},\"created_at\":{\"type\":\"date\",\"format\":\"EEE MMM dd HH:mm:ss Z yyyy\"}}}' \"$ELASTICSEARCH_URL/_template/template_1\"" + "code": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"index_patterns\":[\"te*\",\"bar*\"],\"settings\":{\"number_of_shards\":1},\"mappings\":{\"_source\":{\"enabled\":false},\"properties\":{\"host_name\":{\"type\":\"keyword\"},\"created_at\":{\"type\":\"date\",\"format\":\"EEE MMM dd HH:mm:ss Z yyyy\"}}}}' \"$ELASTICSEARCH_URL/_template/template_1\"" }, { "language": "Java", @@ -2492,15 +2492,15 @@ }, { "language": "Ruby", - "code": "response = client.indices.reload_search_analyzers(\n index: \"my-index-000001\",\n body: {\n \"_shards\": {\n \"total\": 2,\n \"successful\": 2,\n \"failed\": 0\n },\n \"reload_details\": [\n {\n \"index\": \"my-index-000001\",\n \"reloaded_analyzers\": [\n \"my_synonyms\"\n ],\n \"reloaded_node_ids\": [\n \"mfdqTXn_T7SGr2Ho2KT8uw\"\n ]\n }\n ]\n }\n)" + "code": "response = client.indices.reload_search_analyzers(\n index: \"my-index-000001\"\n)" }, { "language": "PHP", - "code": "$resp = $client->indices()->reloadSearchAnalyzers([\n \"index\" => \"my-index-000001\",\n \"body\" => [\n \"_shards\" => [\n \"total\" => 2,\n \"successful\" => 2,\n \"failed\" => 0,\n ],\n \"reload_details\" => array(\n [\n \"index\" => \"my-index-000001\",\n \"reloaded_analyzers\" => array(\n \"my_synonyms\",\n ),\n \"reloaded_node_ids\" => array(\n \"mfdqTXn_T7SGr2Ho2KT8uw\",\n ),\n ],\n ),\n ],\n]);" + "code": "$resp = $client->indices()->reloadSearchAnalyzers([\n \"index\" => \"my-index-000001\",\n]);" }, { "language": "curl", - "code": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"_shards\":{\"total\":2,\"successful\":2,\"failed\":0},\"reload_details\":[{\"index\":\"my-index-000001\",\"reloaded_analyzers\":[\"my_synonyms\"],\"reloaded_node_ids\":[\"mfdqTXn_T7SGr2Ho2KT8uw\"]}]}' \"$ELASTICSEARCH_URL/my-index-000001/_reload_search_analyzers\"" + "code": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/my-index-000001/_reload_search_analyzers\"" } ], "specification/indices/cancel_migrate_reindex/examples/request/IndicesCancelMigrateReindexExample1.yaml": [ @@ -13736,23 +13736,23 @@ "specification/inference/put/examples/request/InferencePutExample1.yaml": [ { "language": "Python", - "code": "resp = client.inference.put(\n task_type=\"rerank\",\n inference_id=\"my-rerank-model\",\n inference_config={\n \"service\": \"cohere\",\n \"service_settings\": {\n \"model_id\": \"rerank-english-v3.0\",\n \"api_key\": \"{{COHERE_API_KEY}}\"\n }\n },\n)" + "code": "resp = client.inference.put(\n task_type=\"rerank\",\n inference_id=\"my-rerank-model\",\n inference_config={\n \"service\": \"cohere\",\n \"service_settings\": {\n \"model_id\": \"rerank-english-v3.0\",\n \"api_key\": \"{{COHERE_API_KEY}}\"\n },\n \"chunking_settings\": {\n \"strategy\": \"recursive\",\n \"max_chunk_size\": 200,\n \"separator_group\": \"markdown\"\n }\n },\n)" }, { "language": "JavaScript", - "code": "const response = await client.inference.put({\n task_type: \"rerank\",\n inference_id: \"my-rerank-model\",\n inference_config: {\n service: \"cohere\",\n service_settings: {\n model_id: \"rerank-english-v3.0\",\n api_key: \"{{COHERE_API_KEY}}\",\n },\n },\n});" + "code": "const response = await client.inference.put({\n task_type: \"rerank\",\n inference_id: \"my-rerank-model\",\n inference_config: {\n service: \"cohere\",\n service_settings: {\n model_id: \"rerank-english-v3.0\",\n api_key: \"{{COHERE_API_KEY}}\",\n },\n chunking_settings: {\n strategy: \"recursive\",\n max_chunk_size: 200,\n separator_group: \"markdown\",\n },\n },\n});" }, { "language": "Ruby", - "code": "response = client.inference.put(\n task_type: \"rerank\",\n inference_id: \"my-rerank-model\",\n body: {\n \"service\": \"cohere\",\n \"service_settings\": {\n \"model_id\": \"rerank-english-v3.0\",\n \"api_key\": \"{{COHERE_API_KEY}}\"\n }\n }\n)" + "code": "response = client.inference.put(\n task_type: \"rerank\",\n inference_id: \"my-rerank-model\",\n body: {\n \"service\": \"cohere\",\n \"service_settings\": {\n \"model_id\": \"rerank-english-v3.0\",\n \"api_key\": \"{{COHERE_API_KEY}}\"\n },\n \"chunking_settings\": {\n \"strategy\": \"recursive\",\n \"max_chunk_size\": 200,\n \"separator_group\": \"markdown\"\n }\n }\n)" }, { "language": "PHP", - "code": "$resp = $client->inference()->put([\n \"task_type\" => \"rerank\",\n \"inference_id\" => \"my-rerank-model\",\n \"body\" => [\n \"service\" => \"cohere\",\n \"service_settings\" => [\n \"model_id\" => \"rerank-english-v3.0\",\n \"api_key\" => \"{{COHERE_API_KEY}}\",\n ],\n ],\n]);" + "code": "$resp = $client->inference()->put([\n \"task_type\" => \"rerank\",\n \"inference_id\" => \"my-rerank-model\",\n \"body\" => [\n \"service\" => \"cohere\",\n \"service_settings\" => [\n \"model_id\" => \"rerank-english-v3.0\",\n \"api_key\" => \"{{COHERE_API_KEY}}\",\n ],\n \"chunking_settings\" => [\n \"strategy\" => \"recursive\",\n \"max_chunk_size\" => 200,\n \"separator_group\" => \"markdown\",\n ],\n ],\n]);" }, { "language": "curl", - "code": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"service\":\"cohere\",\"service_settings\":{\"model_id\":\"rerank-english-v3.0\",\"api_key\":\"{{COHERE_API_KEY}}\"}}' \"$ELASTICSEARCH_URL/_inference/rerank/my-rerank-model\"" + "code": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"service\":\"cohere\",\"service_settings\":{\"model_id\":\"rerank-english-v3.0\",\"api_key\":\"{{COHERE_API_KEY}}\"},\"chunking_settings\":{\"strategy\":\"recursive\",\"max_chunk_size\":200,\"separator_group\":\"markdown\"}}' \"$ELASTICSEARCH_URL/_inference/rerank/my-rerank-model\"" }, { "language": "Java", @@ -17222,5 +17222,159 @@ "language": "curl", "code": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"service\":\"azureaistudio\",\"service_settings\":{\"api_key\":\"Azure-AI-Studio-API-key\",\"target\":\"Target-URI\",\"provider\":\"cohere\",\"endpoint_type\":\"token\"}}' \"$ELASTICSEARCH_URL/_inference/rerank/azure_ai_studio_rerank\"" } + ], + "specification/indices/disk_usage/examples/request/indicesDiskUsageRequestExample1.yaml": [ + { + "language": "Python", + "code": "resp = client.indices.disk_usage(\n index=\"my-index-000001\",\n run_expensive_tasks=True,\n)" + }, + { + "language": "JavaScript", + "code": "const response = await client.indices.diskUsage({\n index: \"my-index-000001\",\n run_expensive_tasks: \"true\",\n});" + }, + { + "language": "Ruby", + "code": "response = client.indices.disk_usage(\n index: \"my-index-000001\",\n run_expensive_tasks: \"true\"\n)" + }, + { + "language": "PHP", + "code": "$resp = $client->indices()->diskUsage([\n \"index\" => \"my-index-000001\",\n \"run_expensive_tasks\" => \"true\",\n]);" + }, + { + "language": "curl", + "code": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/my-index-000001/_disk_usage?run_expensive_tasks=true\"" + } + ], + "specification/indices/rollover/examples/request/indicesRolloverRequestExample2.yaml": [ + { + "language": "Python", + "code": "resp = client.indices.rollover(\n alias=\"my-data-stream\",\n)" + }, + { + "language": "JavaScript", + "code": "const response = await client.indices.rollover({\n alias: \"my-data-stream\",\n});" + }, + { + "language": "Ruby", + "code": "response = client.indices.rollover(\n alias: \"my-data-stream\",\n body: {}\n)" + }, + { + "language": "PHP", + "code": "$resp = $client->indices()->rollover([\n \"alias\" => \"my-data-stream\",\n \"body\" => new ArrayObject([]),\n]);" + }, + { + "language": "curl", + "code": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{}' \"$ELASTICSEARCH_URL/my-data-stream/_rollover\"" + } + ], + "specification/inference/put_llama/examples/request/PutLlamaRequestExample3.yaml": [ + { + "language": "Python", + "code": "resp = client.inference.put(\n task_type=\"chat-completion\",\n inference_id=\"llama-chat-completion\",\n inference_config={\n \"service\": \"llama\",\n \"service_settings\": {\n \"url\": \"http://localhost:8321/v1/openai/v1/chat/completions\",\n \"model_id\": \"llama3.2:3b\"\n }\n },\n)" + }, + { + "language": "JavaScript", + "code": "const response = await client.inference.put({\n task_type: \"chat-completion\",\n inference_id: \"llama-chat-completion\",\n inference_config: {\n service: \"llama\",\n service_settings: {\n url: \"http://localhost:8321/v1/openai/v1/chat/completions\",\n model_id: \"llama3.2:3b\",\n },\n },\n});" + }, + { + "language": "Ruby", + "code": "response = client.inference.put(\n task_type: \"chat-completion\",\n inference_id: \"llama-chat-completion\",\n body: {\n \"service\": \"llama\",\n \"service_settings\": {\n \"url\": \"http://localhost:8321/v1/openai/v1/chat/completions\",\n \"model_id\": \"llama3.2:3b\"\n }\n }\n)" + }, + { + "language": "PHP", + "code": "$resp = $client->inference()->put([\n \"task_type\" => \"chat-completion\",\n \"inference_id\" => \"llama-chat-completion\",\n \"body\" => [\n \"service\" => \"llama\",\n \"service_settings\" => [\n \"url\" => \"http://localhost:8321/v1/openai/v1/chat/completions\",\n \"model_id\" => \"llama3.2:3b\",\n ],\n ],\n]);" + }, + { + "language": "curl", + "code": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"service\":\"llama\",\"service_settings\":{\"url\":\"http://localhost:8321/v1/openai/v1/chat/completions\",\"model_id\":\"llama3.2:3b\"}}' \"$ELASTICSEARCH_URL/_inference/chat-completion/llama-chat-completion\"" + } + ], + "specification/inference/put_llama/examples/request/PutLlamaRequestExample2.yaml": [ + { + "language": "Python", + "code": "resp = client.inference.put(\n task_type=\"completion\",\n inference_id=\"llama-completion\",\n inference_config={\n \"service\": \"llama\",\n \"service_settings\": {\n \"url\": \"http://localhost:8321/v1/openai/v1/chat/completions\",\n \"model_id\": \"llama3.2:3b\"\n }\n },\n)" + }, + { + "language": "JavaScript", + "code": "const response = await client.inference.put({\n task_type: \"completion\",\n inference_id: \"llama-completion\",\n inference_config: {\n service: \"llama\",\n service_settings: {\n url: \"http://localhost:8321/v1/openai/v1/chat/completions\",\n model_id: \"llama3.2:3b\",\n },\n },\n});" + }, + { + "language": "Ruby", + "code": "response = client.inference.put(\n task_type: \"completion\",\n inference_id: \"llama-completion\",\n body: {\n \"service\": \"llama\",\n \"service_settings\": {\n \"url\": \"http://localhost:8321/v1/openai/v1/chat/completions\",\n \"model_id\": \"llama3.2:3b\"\n }\n }\n)" + }, + { + "language": "PHP", + "code": "$resp = $client->inference()->put([\n \"task_type\" => \"completion\",\n \"inference_id\" => \"llama-completion\",\n \"body\" => [\n \"service\" => \"llama\",\n \"service_settings\" => [\n \"url\" => \"http://localhost:8321/v1/openai/v1/chat/completions\",\n \"model_id\" => \"llama3.2:3b\",\n ],\n ],\n]);" + }, + { + "language": "curl", + "code": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"service\":\"llama\",\"service_settings\":{\"url\":\"http://localhost:8321/v1/openai/v1/chat/completions\",\"model_id\":\"llama3.2:3b\"}}' \"$ELASTICSEARCH_URL/_inference/completion/llama-completion\"" + } + ], + "specification/inference/put_llama/examples/request/PutLlamaRequestExample1.yaml": [ + { + "language": "Python", + "code": "resp = client.inference.put(\n task_type=\"text_embedding\",\n inference_id=\"llama-text-embedding\",\n inference_config={\n \"service\": \"llama\",\n \"service_settings\": {\n \"url\": \"http://localhost:8321/v1/inference/embeddings\",\n \"dimensions\": 384,\n \"model_id\": \"all-MiniLM-L6-v2\"\n }\n },\n)" + }, + { + "language": "JavaScript", + "code": "const response = await client.inference.put({\n task_type: \"text_embedding\",\n inference_id: \"llama-text-embedding\",\n inference_config: {\n service: \"llama\",\n service_settings: {\n url: \"http://localhost:8321/v1/inference/embeddings\",\n dimensions: 384,\n model_id: \"all-MiniLM-L6-v2\",\n },\n },\n});" + }, + { + "language": "Ruby", + "code": "response = client.inference.put(\n task_type: \"text_embedding\",\n inference_id: \"llama-text-embedding\",\n body: {\n \"service\": \"llama\",\n \"service_settings\": {\n \"url\": \"http://localhost:8321/v1/inference/embeddings\",\n \"dimensions\": 384,\n \"model_id\": \"all-MiniLM-L6-v2\"\n }\n }\n)" + }, + { + "language": "PHP", + "code": "$resp = $client->inference()->put([\n \"task_type\" => \"text_embedding\",\n \"inference_id\" => \"llama-text-embedding\",\n \"body\" => [\n \"service\" => \"llama\",\n \"service_settings\" => [\n \"url\" => \"http://localhost:8321/v1/inference/embeddings\",\n \"dimensions\" => 384,\n \"model_id\" => \"all-MiniLM-L6-v2\",\n ],\n ],\n]);" + }, + { + "language": "curl", + "code": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"service\":\"llama\",\"service_settings\":{\"url\":\"http://localhost:8321/v1/inference/embeddings\",\"dimensions\":384,\"model_id\":\"all-MiniLM-L6-v2\"}}' \"$ELASTICSEARCH_URL/_inference/text_embedding/llama-text-embedding\"" + } + ], + "specification/transform/set_upgrade_mode/examples/request/TransformSetUpgradeModeExample1.yaml": [ + { + "language": "Python", + "code": "resp = client.transform.set_upgrade_mode(\n enabled=True,\n)" + }, + { + "language": "JavaScript", + "code": "const response = await client.transform.setUpgradeMode({\n enabled: \"true\",\n});" + }, + { + "language": "Ruby", + "code": "response = client.transform.set_upgrade_mode(\n enabled: \"true\"\n)" + }, + { + "language": "PHP", + "code": "$resp = $client->transform()->setUpgradeMode([\n \"enabled\" => \"true\",\n]);" + }, + { + "language": "curl", + "code": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_transform/set_upgrade_mode?enabled=true\"" + } + ], + "specification/indices/disk_usage/examples/request/IndicesDiskUsageRequestExample1.yaml": [ + { + "language": "Python", + "code": "resp = client.indices.disk_usage(\n index=\"my-index-000001\",\n run_expensive_tasks=True,\n)" + }, + { + "language": "JavaScript", + "code": "const response = await client.indices.diskUsage({\n index: \"my-index-000001\",\n run_expensive_tasks: \"true\",\n});" + }, + { + "language": "Ruby", + "code": "response = client.indices.disk_usage(\n index: \"my-index-000001\",\n run_expensive_tasks: \"true\"\n)" + }, + { + "language": "PHP", + "code": "$resp = $client->indices()->diskUsage([\n \"index\" => \"my-index-000001\",\n \"run_expensive_tasks\" => \"true\",\n]);" + }, + { + "language": "curl", + "code": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/my-index-000001/_disk_usage?run_expensive_tasks=true\"" + } ] } \ No newline at end of file diff --git a/output/openapi/elasticsearch-openapi-docs.redirects.csv b/output/openapi/elasticsearch-openapi-docs.redirects.csv index a053b1593d..b8b4acad37 100644 --- a/output/openapi/elasticsearch-openapi-docs.redirects.csv +++ b/output/openapi/elasticsearch-openapi-docs.redirects.csv @@ -134,7 +134,6 @@ security-get-service-accounts-1,security-get-service-accounts security-get-service-accounts-2,security-get-service-accounts security-get-user-1,security-get-user security-has-privileges-1,security-has-privileges -shutdown-get-node-1,shutdown-get-node simulate-ingest-1,simulate-ingest slm-get-lifecycle-1,slm-get-lifecycle snapshot-get-repository-1,snapshot-get-repository diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index e4ea01c461..53459eb824 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -16633,7 +16633,11 @@ "indices" ], "summary": "Analyze the index disk usage", - "description": "Analyze the disk usage of each field of an index or data stream.\nThis API might not support indices created in previous Elasticsearch versions.\nThe result of a small index can be inaccurate as some parts of an index might not be analyzed by the API.\n\nNOTE: The total size of fields of the analyzed shards of the index in the response is usually smaller than the index `store_size` value because some small metadata files are ignored and some parts of data files might not be scanned by the API.\nSince stored fields are stored together in a compressed format, the sizes of stored fields are also estimates and can be inaccurate.\nThe stored size of the `_id` field is likely underestimated while the `_source` field is overestimated.", + "description": "Analyze the disk usage of each field of an index or data stream.\nThis API might not support indices created in previous Elasticsearch versions.\nThe result of a small index can be inaccurate as some parts of an index might not be analyzed by the API.\n\nNOTE: The total size of fields of the analyzed shards of the index in the response is usually smaller than the index `store_size` value because some small metadata files are ignored and some parts of data files might not be scanned by the API.\nSince stored fields are stored together in a compressed format, the sizes of stored fields are also estimates and can be inaccurate.\nThe stored size of the `_id` field is likely underestimated while the `_source` field is overestimated.\n\nFor usage examples see the External documentation or refer to [Analyze the index disk usage example](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/index-disk-usage) for an example.", + "externalDocs": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-disk-usage", + "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/indices-disk-usage.html" + }, "operationId": "indices-disk-usage", "parameters": [ { @@ -16705,6 +16709,12 @@ "application/json": { "schema": { "type": "object" + }, + "examples": { + "IndicesDiskUsageResponseExample1": { + "description": "An abbreviated response from `POST /my-index-000001/_disk_usage?run_expensive_tasks=true`.", + "value": "{\n \"_shards\": {\n \"total\": 1,\n \"successful\": 1,\n \"failed\": 0\n },\n \"my-index-000001\": {\n \"store_size\": \"929mb\",\n \"store_size_in_bytes\": 974192723,\n \"all_fields\": {\n \"total\": \"928.9mb\",\n \"total_in_bytes\": 973977084,\n \"inverted_index\": {\n \"total\": \"107.8mb\",\n \"total_in_bytes\": 113128526\n },\n \"stored_fields\": \"623.5mb\",\n \"stored_fields_in_bytes\": 653819143,\n \"doc_values\": \"125.7mb\",\n \"doc_values_in_bytes\": 131885142,\n \"points\": \"59.9mb\",\n \"points_in_bytes\": 62885773,\n \"norms\": \"2.3kb\",\n \"norms_in_bytes\": 2356,\n \"term_vectors\": \"2.2kb\",\n \"term_vectors_in_bytes\": 2310,\n \"knn_vectors\": \"0b\",\n \"knn_vectors_in_bytes\": 0\n },\n \"fields\": {\n \"_id\": {\n \"total\": \"49.3mb\",\n \"total_in_bytes\": 51709993,\n \"inverted_index\": {\n \"total\": \"29.7mb\",\n \"total_in_bytes\": 31172745\n },\n \"stored_fields\": \"19.5mb\",\n \"stored_fields_in_bytes\": 20537248,\n \"doc_values\": \"0b\",\n \"doc_values_in_bytes\": 0,\n \"points\": \"0b\",\n \"points_in_bytes\": 0,\n \"norms\": \"0b\",\n \"norms_in_bytes\": 0,\n \"term_vectors\": \"0b\",\n \"term_vectors_in_bytes\": 0,\n \"knn_vectors\": \"0b\",\n \"knn_vectors_in_bytes\": 0\n },\n \"_primary_term\": {},\n \"_seq_no\": {},\n \"_version\": {},\n \"_source\": {\n \"total\": \"603.9mb\",\n \"total_in_bytes\": 633281895,\n \"inverted_index\": {},\n \"stored_fields\": \"603.9mb\",\n \"stored_fields_in_bytes\": 633281895,\n \"doc_values\": \"0b\",\n \"doc_values_in_bytes\": 0,\n \"points\": \"0b\",\n \"points_in_bytes\": 0,\n \"norms\": \"0b\",\n \"norms_in_bytes\": 0,\n \"term_vectors\": \"0b\",\n \"term_vectors_in_bytes\": 0,\n \"knn_vectors\": \"0b\",\n \"knn_vectors_in_bytes\": 0\n },\n \"context\": {\n \"total\": \"28.6mb\",\n \"total_in_bytes\": 30060405,\n \"inverted_index\": {\n \"total\": \"22mb\",\n \"total_in_bytes\": 23090908\n },\n \"stored_fields\": \"0b\",\n \"stored_fields_in_bytes\": 0,\n \"doc_values\": \"0b\",\n \"doc_values_in_bytes\": 0,\n \"points\": \"0b\",\n \"points_in_bytes\": 0,\n \"norms\": \"2.3kb\",\n \"norms_in_bytes\": 2356,\n \"term_vectors\": \"2.2kb\",\n \"term_vectors_in_bytes\": 2310,\n \"knn_vectors\": \"0b\",\n \"knn_vectors_in_bytes\": 0\n },\n \"context.keyword\": {},\n \"message\": {},\n \"message.keyword\": {}\n }\n }\n}" + } } } } diff --git a/output/schema/schema.json b/output/schema/schema.json index 61e7b1c0db..4cef35072d 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -7309,9 +7309,11 @@ "stability": "experimental" } }, - "description": "Analyze the index disk usage.\nAnalyze the disk usage of each field of an index or data stream.\nThis API might not support indices created in previous Elasticsearch versions.\nThe result of a small index can be inaccurate as some parts of an index might not be analyzed by the API.\n\nNOTE: The total size of fields of the analyzed shards of the index in the response is usually smaller than the index `store_size` value because some small metadata files are ignored and some parts of data files might not be scanned by the API.\nSince stored fields are stored together in a compressed format, the sizes of stored fields are also estimates and can be inaccurate.\nThe stored size of the `_id` field is likely underestimated while the `_source` field is overestimated.", + "description": "Analyze the index disk usage.\nAnalyze the disk usage of each field of an index or data stream.\nThis API might not support indices created in previous Elasticsearch versions.\nThe result of a small index can be inaccurate as some parts of an index might not be analyzed by the API.\n\nNOTE: The total size of fields of the analyzed shards of the index in the response is usually smaller than the index `store_size` value because some small metadata files are ignored and some parts of data files might not be scanned by the API.\nSince stored fields are stored together in a compressed format, the sizes of stored fields are also estimates and can be inaccurate.\nThe stored size of the `_id` field is likely underestimated while the `_source` field is overestimated.\n\nFor usage examples see the External documentation or refer to [Analyze the index disk usage example](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/index-disk-usage) for an example.", "docId": "indices-disk-usage", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-disk-usage", + "extDocId": "indices-disk-usage", + "extDocUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-disk-usage", "extPreviousVersionDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/indices-disk-usage.html", "name": "indices.disk_usage", "request": { @@ -125927,23 +125929,23 @@ "ClusterPutComponentTemplateRequestExample1": { "alternatives": [ { - "code": "resp = client.cluster.put_component_template(\n name=\"template_1\",\n template=None,\n settings={\n \"number_of_shards\": 1\n },\n mappings={\n \"_source\": {\n \"enabled\": False\n },\n \"properties\": {\n \"host_name\": {\n \"type\": \"keyword\"\n },\n \"created_at\": {\n \"type\": \"date\",\n \"format\": \"EEE MMM dd HH:mm:ss Z yyyy\"\n }\n }\n },\n)", + "code": "resp = client.cluster.put_component_template(\n name=\"template_1\",\n template={\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"mappings\": {\n \"_source\": {\n \"enabled\": False\n },\n \"properties\": {\n \"host_name\": {\n \"type\": \"keyword\"\n },\n \"created_at\": {\n \"type\": \"date\",\n \"format\": \"EEE MMM dd HH:mm:ss Z yyyy\"\n }\n }\n }\n },\n)", "language": "Python" }, { - "code": "const response = await client.cluster.putComponentTemplate({\n name: \"template_1\",\n template: null,\n settings: {\n number_of_shards: 1,\n },\n mappings: {\n _source: {\n enabled: false,\n },\n properties: {\n host_name: {\n type: \"keyword\",\n },\n created_at: {\n type: \"date\",\n format: \"EEE MMM dd HH:mm:ss Z yyyy\",\n },\n },\n },\n});", + "code": "const response = await client.cluster.putComponentTemplate({\n name: \"template_1\",\n template: {\n settings: {\n number_of_shards: 1,\n },\n mappings: {\n _source: {\n enabled: false,\n },\n properties: {\n host_name: {\n type: \"keyword\",\n },\n created_at: {\n type: \"date\",\n format: \"EEE MMM dd HH:mm:ss Z yyyy\",\n },\n },\n },\n },\n});", "language": "JavaScript" }, { - "code": "response = client.cluster.put_component_template(\n name: \"template_1\",\n body: {\n \"template\": nil,\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"mappings\": {\n \"_source\": {\n \"enabled\": false\n },\n \"properties\": {\n \"host_name\": {\n \"type\": \"keyword\"\n },\n \"created_at\": {\n \"type\": \"date\",\n \"format\": \"EEE MMM dd HH:mm:ss Z yyyy\"\n }\n }\n }\n }\n)", + "code": "response = client.cluster.put_component_template(\n name: \"template_1\",\n body: {\n \"template\": {\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"mappings\": {\n \"_source\": {\n \"enabled\": false\n },\n \"properties\": {\n \"host_name\": {\n \"type\": \"keyword\"\n },\n \"created_at\": {\n \"type\": \"date\",\n \"format\": \"EEE MMM dd HH:mm:ss Z yyyy\"\n }\n }\n }\n }\n }\n)", "language": "Ruby" }, { - "code": "$resp = $client->cluster()->putComponentTemplate([\n \"name\" => \"template_1\",\n \"body\" => [\n \"template\" => null,\n \"settings\" => [\n \"number_of_shards\" => 1,\n ],\n \"mappings\" => [\n \"_source\" => [\n \"enabled\" => false,\n ],\n \"properties\" => [\n \"host_name\" => [\n \"type\" => \"keyword\",\n ],\n \"created_at\" => [\n \"type\" => \"date\",\n \"format\" => \"EEE MMM dd HH:mm:ss Z yyyy\",\n ],\n ],\n ],\n ],\n]);", + "code": "$resp = $client->cluster()->putComponentTemplate([\n \"name\" => \"template_1\",\n \"body\" => [\n \"template\" => [\n \"settings\" => [\n \"number_of_shards\" => 1,\n ],\n \"mappings\" => [\n \"_source\" => [\n \"enabled\" => false,\n ],\n \"properties\" => [\n \"host_name\" => [\n \"type\" => \"keyword\",\n ],\n \"created_at\" => [\n \"type\" => \"date\",\n \"format\" => \"EEE MMM dd HH:mm:ss Z yyyy\",\n ],\n ],\n ],\n ],\n ],\n]);", "language": "PHP" }, { - "code": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"template\":null,\"settings\":{\"number_of_shards\":1},\"mappings\":{\"_source\":{\"enabled\":false},\"properties\":{\"host_name\":{\"type\":\"keyword\"},\"created_at\":{\"type\":\"date\",\"format\":\"EEE MMM dd HH:mm:ss Z yyyy\"}}}}' \"$ELASTICSEARCH_URL/_component_template/template_1\"", + "code": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"template\":{\"settings\":{\"number_of_shards\":1},\"mappings\":{\"_source\":{\"enabled\":false},\"properties\":{\"host_name\":{\"type\":\"keyword\"},\"created_at\":{\"type\":\"date\",\"format\":\"EEE MMM dd HH:mm:ss Z yyyy\"}}}}}' \"$ELASTICSEARCH_URL/_component_template/template_1\"", "language": "curl" } ], @@ -155465,9 +155467,9 @@ "body": { "kind": "no_body" }, - "description": "Analyze the index disk usage.\nAnalyze the disk usage of each field of an index or data stream.\nThis API might not support indices created in previous Elasticsearch versions.\nThe result of a small index can be inaccurate as some parts of an index might not be analyzed by the API.\n\nNOTE: The total size of fields of the analyzed shards of the index in the response is usually smaller than the index `store_size` value because some small metadata files are ignored and some parts of data files might not be scanned by the API.\nSince stored fields are stored together in a compressed format, the sizes of stored fields are also estimates and can be inaccurate.\nThe stored size of the `_id` field is likely underestimated while the `_source` field is overestimated.", + "description": "Analyze the index disk usage.\nAnalyze the disk usage of each field of an index or data stream.\nThis API might not support indices created in previous Elasticsearch versions.\nThe result of a small index can be inaccurate as some parts of an index might not be analyzed by the API.\n\nNOTE: The total size of fields of the analyzed shards of the index in the response is usually smaller than the index `store_size` value because some small metadata files are ignored and some parts of data files might not be scanned by the API.\nSince stored fields are stored together in a compressed format, the sizes of stored fields are also estimates and can be inaccurate.\nThe stored size of the `_id` field is likely underestimated while the `_source` field is overestimated.\n\nFor usage examples see the External documentation or refer to [Analyze the index disk usage example](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/index-disk-usage) for an example.", "examples": { - "IndicesDiskUsageExample1": { + "IndicesDiskUsageRequestExample1": { "alternatives": [ { "code": "resp = client.indices.disk_usage(\n index=\"my-index-000001\",\n run_expensive_tasks=True,\n)", @@ -155488,10 +155490,6 @@ { "code": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/my-index-000001/_disk_usage?run_expensive_tasks=true\"", "language": "curl" - }, - { - "code": "client.indices().diskUsage(d -> d\n .index(\"my-index-000001\")\n .runExpensiveTasks(true)\n);\n", - "language": "Java" } ], "method_request": "POST /my-index-000001/_disk_usage?run_expensive_tasks=true" @@ -155588,7 +155586,7 @@ } } ], - "specLocation": "indices/disk_usage/IndicesDiskUsageRequest.ts#L23-L84" + "specLocation": "indices/disk_usage/IndicesDiskUsageRequest.ts#L23-L87" }, { "kind": "response", @@ -155599,6 +155597,12 @@ "kind": "user_defined_value" } }, + "examples": { + "IndicesDiskUsageResponseExample1": { + "description": "An abbreviated response from `POST /my-index-000001/_disk_usage?run_expensive_tasks=true`.", + "value": "{\n \"_shards\": {\n \"total\": 1,\n \"successful\": 1,\n \"failed\": 0\n },\n \"my-index-000001\": {\n \"store_size\": \"929mb\",\n \"store_size_in_bytes\": 974192723,\n \"all_fields\": {\n \"total\": \"928.9mb\",\n \"total_in_bytes\": 973977084,\n \"inverted_index\": {\n \"total\": \"107.8mb\",\n \"total_in_bytes\": 113128526\n },\n \"stored_fields\": \"623.5mb\",\n \"stored_fields_in_bytes\": 653819143,\n \"doc_values\": \"125.7mb\",\n \"doc_values_in_bytes\": 131885142,\n \"points\": \"59.9mb\",\n \"points_in_bytes\": 62885773,\n \"norms\": \"2.3kb\",\n \"norms_in_bytes\": 2356,\n \"term_vectors\": \"2.2kb\",\n \"term_vectors_in_bytes\": 2310,\n \"knn_vectors\": \"0b\",\n \"knn_vectors_in_bytes\": 0\n },\n \"fields\": {\n \"_id\": {\n \"total\": \"49.3mb\",\n \"total_in_bytes\": 51709993,\n \"inverted_index\": {\n \"total\": \"29.7mb\",\n \"total_in_bytes\": 31172745\n },\n \"stored_fields\": \"19.5mb\",\n \"stored_fields_in_bytes\": 20537248,\n \"doc_values\": \"0b\",\n \"doc_values_in_bytes\": 0,\n \"points\": \"0b\",\n \"points_in_bytes\": 0,\n \"norms\": \"0b\",\n \"norms_in_bytes\": 0,\n \"term_vectors\": \"0b\",\n \"term_vectors_in_bytes\": 0,\n \"knn_vectors\": \"0b\",\n \"knn_vectors_in_bytes\": 0\n },\n \"_primary_term\": {},\n \"_seq_no\": {},\n \"_version\": {},\n \"_source\": {\n \"total\": \"603.9mb\",\n \"total_in_bytes\": 633281895,\n \"inverted_index\": {},\n \"stored_fields\": \"603.9mb\",\n \"stored_fields_in_bytes\": 633281895,\n \"doc_values\": \"0b\",\n \"doc_values_in_bytes\": 0,\n \"points\": \"0b\",\n \"points_in_bytes\": 0,\n \"norms\": \"0b\",\n \"norms_in_bytes\": 0,\n \"term_vectors\": \"0b\",\n \"term_vectors_in_bytes\": 0,\n \"knn_vectors\": \"0b\",\n \"knn_vectors_in_bytes\": 0\n },\n \"context\": {\n \"total\": \"28.6mb\",\n \"total_in_bytes\": 30060405,\n \"inverted_index\": {\n \"total\": \"22mb\",\n \"total_in_bytes\": 23090908\n },\n \"stored_fields\": \"0b\",\n \"stored_fields_in_bytes\": 0,\n \"doc_values\": \"0b\",\n \"doc_values_in_bytes\": 0,\n \"points\": \"0b\",\n \"points_in_bytes\": 0,\n \"norms\": \"2.3kb\",\n \"norms_in_bytes\": 2356,\n \"term_vectors\": \"2.2kb\",\n \"term_vectors_in_bytes\": 2310,\n \"knn_vectors\": \"0b\",\n \"knn_vectors_in_bytes\": 0\n },\n \"context.keyword\": {},\n \"message\": {},\n \"message.keyword\": {}\n }\n }\n}" + } + }, "name": { "name": "Response", "namespace": "indices.disk_usage" @@ -162908,23 +162912,23 @@ "indicesPutTemplateRequestExample1": { "alternatives": [ { - "code": "resp = client.indices.put_template(\n name=\"template_1\",\n index_patterns=[\n \"te*\",\n \"bar*\"\n ],\n settings={\n \"number_of_shards\": 1\n },\n mappings={\n \"_source\": {\n \"enabled\": False\n }\n },\n properties={\n \"host_name\": {\n \"type\": \"keyword\"\n },\n \"created_at\": {\n \"type\": \"date\",\n \"format\": \"EEE MMM dd HH:mm:ss Z yyyy\"\n }\n },\n)", + "code": "resp = client.indices.put_template(\n name=\"template_1\",\n index_patterns=[\n \"te*\",\n \"bar*\"\n ],\n settings={\n \"number_of_shards\": 1\n },\n mappings={\n \"_source\": {\n \"enabled\": False\n },\n \"properties\": {\n \"host_name\": {\n \"type\": \"keyword\"\n },\n \"created_at\": {\n \"type\": \"date\",\n \"format\": \"EEE MMM dd HH:mm:ss Z yyyy\"\n }\n }\n },\n)", "language": "Python" }, { - "code": "const response = await client.indices.putTemplate({\n name: \"template_1\",\n index_patterns: [\"te*\", \"bar*\"],\n settings: {\n number_of_shards: 1,\n },\n mappings: {\n _source: {\n enabled: false,\n },\n },\n properties: {\n host_name: {\n type: \"keyword\",\n },\n created_at: {\n type: \"date\",\n format: \"EEE MMM dd HH:mm:ss Z yyyy\",\n },\n },\n});", + "code": "const response = await client.indices.putTemplate({\n name: \"template_1\",\n index_patterns: [\"te*\", \"bar*\"],\n settings: {\n number_of_shards: 1,\n },\n mappings: {\n _source: {\n enabled: false,\n },\n properties: {\n host_name: {\n type: \"keyword\",\n },\n created_at: {\n type: \"date\",\n format: \"EEE MMM dd HH:mm:ss Z yyyy\",\n },\n },\n },\n});", "language": "JavaScript" }, { - "code": "response = client.indices.put_template(\n name: \"template_1\",\n body: {\n \"index_patterns\": [\n \"te*\",\n \"bar*\"\n ],\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"mappings\": {\n \"_source\": {\n \"enabled\": false\n }\n },\n \"properties\": {\n \"host_name\": {\n \"type\": \"keyword\"\n },\n \"created_at\": {\n \"type\": \"date\",\n \"format\": \"EEE MMM dd HH:mm:ss Z yyyy\"\n }\n }\n }\n)", + "code": "response = client.indices.put_template(\n name: \"template_1\",\n body: {\n \"index_patterns\": [\n \"te*\",\n \"bar*\"\n ],\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"mappings\": {\n \"_source\": {\n \"enabled\": false\n },\n \"properties\": {\n \"host_name\": {\n \"type\": \"keyword\"\n },\n \"created_at\": {\n \"type\": \"date\",\n \"format\": \"EEE MMM dd HH:mm:ss Z yyyy\"\n }\n }\n }\n }\n)", "language": "Ruby" }, { - "code": "$resp = $client->indices()->putTemplate([\n \"name\" => \"template_1\",\n \"body\" => [\n \"index_patterns\" => array(\n \"te*\",\n \"bar*\",\n ),\n \"settings\" => [\n \"number_of_shards\" => 1,\n ],\n \"mappings\" => [\n \"_source\" => [\n \"enabled\" => false,\n ],\n ],\n \"properties\" => [\n \"host_name\" => [\n \"type\" => \"keyword\",\n ],\n \"created_at\" => [\n \"type\" => \"date\",\n \"format\" => \"EEE MMM dd HH:mm:ss Z yyyy\",\n ],\n ],\n ],\n]);", + "code": "$resp = $client->indices()->putTemplate([\n \"name\" => \"template_1\",\n \"body\" => [\n \"index_patterns\" => array(\n \"te*\",\n \"bar*\",\n ),\n \"settings\" => [\n \"number_of_shards\" => 1,\n ],\n \"mappings\" => [\n \"_source\" => [\n \"enabled\" => false,\n ],\n \"properties\" => [\n \"host_name\" => [\n \"type\" => \"keyword\",\n ],\n \"created_at\" => [\n \"type\" => \"date\",\n \"format\" => \"EEE MMM dd HH:mm:ss Z yyyy\",\n ],\n ],\n ],\n ],\n]);", "language": "PHP" }, { - "code": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"index_patterns\":[\"te*\",\"bar*\"],\"settings\":{\"number_of_shards\":1},\"mappings\":{\"_source\":{\"enabled\":false}},\"properties\":{\"host_name\":{\"type\":\"keyword\"},\"created_at\":{\"type\":\"date\",\"format\":\"EEE MMM dd HH:mm:ss Z yyyy\"}}}' \"$ELASTICSEARCH_URL/_template/template_1\"", + "code": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"index_patterns\":[\"te*\",\"bar*\"],\"settings\":{\"number_of_shards\":1},\"mappings\":{\"_source\":{\"enabled\":false},\"properties\":{\"host_name\":{\"type\":\"keyword\"},\"created_at\":{\"type\":\"date\",\"format\":\"EEE MMM dd HH:mm:ss Z yyyy\"}}}}' \"$ELASTICSEARCH_URL/_template/template_1\"", "language": "curl" }, { @@ -164436,15 +164440,15 @@ "language": "JavaScript" }, { - "code": "response = client.indices.reload_search_analyzers(\n index: \"my-index-000001\",\n body: {\n \"_shards\": {\n \"total\": 2,\n \"successful\": 2,\n \"failed\": 0\n },\n \"reload_details\": [\n {\n \"index\": \"my-index-000001\",\n \"reloaded_analyzers\": [\n \"my_synonyms\"\n ],\n \"reloaded_node_ids\": [\n \"mfdqTXn_T7SGr2Ho2KT8uw\"\n ]\n }\n ]\n }\n)", + "code": "response = client.indices.reload_search_analyzers(\n index: \"my-index-000001\"\n)", "language": "Ruby" }, { - "code": "$resp = $client->indices()->reloadSearchAnalyzers([\n \"index\" => \"my-index-000001\",\n \"body\" => [\n \"_shards\" => [\n \"total\" => 2,\n \"successful\" => 2,\n \"failed\" => 0,\n ],\n \"reload_details\" => array(\n [\n \"index\" => \"my-index-000001\",\n \"reloaded_analyzers\" => array(\n \"my_synonyms\",\n ),\n \"reloaded_node_ids\" => array(\n \"mfdqTXn_T7SGr2Ho2KT8uw\",\n ),\n ],\n ),\n ],\n]);", + "code": "$resp = $client->indices()->reloadSearchAnalyzers([\n \"index\" => \"my-index-000001\",\n]);", "language": "PHP" }, { - "code": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"_shards\":{\"total\":2,\"successful\":2,\"failed\":0},\"reload_details\":[{\"index\":\"my-index-000001\",\"reloaded_analyzers\":[\"my_synonyms\"],\"reloaded_node_ids\":[\"mfdqTXn_T7SGr2Ho2KT8uw\"]}]}' \"$ELASTICSEARCH_URL/my-index-000001/_reload_search_analyzers\"", + "code": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/my-index-000001/_reload_search_analyzers\"", "language": "curl" } ], @@ -165481,6 +165485,28 @@ "value": "{\n \"conditions\": {\n \"max_age\": \"7d\",\n \"max_docs\": 1000,\n \"max_primary_shard_size\": \"50gb\",\n \"max_primary_shard_docs\": \"2000\"\n }\n}" }, "indicesRolloverRequestExample2": { + "alternatives": [ + { + "code": "resp = client.indices.rollover(\n alias=\"my-data-stream\",\n)", + "language": "Python" + }, + { + "code": "const response = await client.indices.rollover({\n alias: \"my-data-stream\",\n});", + "language": "JavaScript" + }, + { + "code": "response = client.indices.rollover(\n alias: \"my-data-stream\",\n body: {}\n)", + "language": "Ruby" + }, + { + "code": "$resp = $client->indices()->rollover([\n \"alias\" => \"my-data-stream\",\n \"body\" => new ArrayObject([]),\n]);", + "language": "PHP" + }, + { + "code": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{}' \"$ELASTICSEARCH_URL/my-data-stream/_rollover\"", + "language": "curl" + } + ], "description": "Create a new index for a data stream", "method_request": "POST my-data-stream/_rollover", "summary": "Serverless request", @@ -176301,23 +176327,23 @@ "InferencePutExample1": { "alternatives": [ { - "code": "resp = client.inference.put(\n task_type=\"rerank\",\n inference_id=\"my-rerank-model\",\n inference_config={\n \"service\": \"cohere\",\n \"service_settings\": {\n \"model_id\": \"rerank-english-v3.0\",\n \"api_key\": \"{{COHERE_API_KEY}}\"\n }\n },\n)", + "code": "resp = client.inference.put(\n task_type=\"rerank\",\n inference_id=\"my-rerank-model\",\n inference_config={\n \"service\": \"cohere\",\n \"service_settings\": {\n \"model_id\": \"rerank-english-v3.0\",\n \"api_key\": \"{{COHERE_API_KEY}}\"\n },\n \"chunking_settings\": {\n \"strategy\": \"recursive\",\n \"max_chunk_size\": 200,\n \"separator_group\": \"markdown\"\n }\n },\n)", "language": "Python" }, { - "code": "const response = await client.inference.put({\n task_type: \"rerank\",\n inference_id: \"my-rerank-model\",\n inference_config: {\n service: \"cohere\",\n service_settings: {\n model_id: \"rerank-english-v3.0\",\n api_key: \"{{COHERE_API_KEY}}\",\n },\n },\n});", + "code": "const response = await client.inference.put({\n task_type: \"rerank\",\n inference_id: \"my-rerank-model\",\n inference_config: {\n service: \"cohere\",\n service_settings: {\n model_id: \"rerank-english-v3.0\",\n api_key: \"{{COHERE_API_KEY}}\",\n },\n chunking_settings: {\n strategy: \"recursive\",\n max_chunk_size: 200,\n separator_group: \"markdown\",\n },\n },\n});", "language": "JavaScript" }, { - "code": "response = client.inference.put(\n task_type: \"rerank\",\n inference_id: \"my-rerank-model\",\n body: {\n \"service\": \"cohere\",\n \"service_settings\": {\n \"model_id\": \"rerank-english-v3.0\",\n \"api_key\": \"{{COHERE_API_KEY}}\"\n }\n }\n)", + "code": "response = client.inference.put(\n task_type: \"rerank\",\n inference_id: \"my-rerank-model\",\n body: {\n \"service\": \"cohere\",\n \"service_settings\": {\n \"model_id\": \"rerank-english-v3.0\",\n \"api_key\": \"{{COHERE_API_KEY}}\"\n },\n \"chunking_settings\": {\n \"strategy\": \"recursive\",\n \"max_chunk_size\": 200,\n \"separator_group\": \"markdown\"\n }\n }\n)", "language": "Ruby" }, { - "code": "$resp = $client->inference()->put([\n \"task_type\" => \"rerank\",\n \"inference_id\" => \"my-rerank-model\",\n \"body\" => [\n \"service\" => \"cohere\",\n \"service_settings\" => [\n \"model_id\" => \"rerank-english-v3.0\",\n \"api_key\" => \"{{COHERE_API_KEY}}\",\n ],\n ],\n]);", + "code": "$resp = $client->inference()->put([\n \"task_type\" => \"rerank\",\n \"inference_id\" => \"my-rerank-model\",\n \"body\" => [\n \"service\" => \"cohere\",\n \"service_settings\" => [\n \"model_id\" => \"rerank-english-v3.0\",\n \"api_key\" => \"{{COHERE_API_KEY}}\",\n ],\n \"chunking_settings\" => [\n \"strategy\" => \"recursive\",\n \"max_chunk_size\" => 200,\n \"separator_group\" => \"markdown\",\n ],\n ],\n]);", "language": "PHP" }, { - "code": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"service\":\"cohere\",\"service_settings\":{\"model_id\":\"rerank-english-v3.0\",\"api_key\":\"{{COHERE_API_KEY}}\"}}' \"$ELASTICSEARCH_URL/_inference/rerank/my-rerank-model\"", + "code": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"service\":\"cohere\",\"service_settings\":{\"model_id\":\"rerank-english-v3.0\",\"api_key\":\"{{COHERE_API_KEY}}\"},\"chunking_settings\":{\"strategy\":\"recursive\",\"max_chunk_size\":200,\"separator_group\":\"markdown\"}}' \"$ELASTICSEARCH_URL/_inference/rerank/my-rerank-model\"", "language": "curl" }, { @@ -179836,16 +179862,82 @@ "description": "Create a Llama inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `llama` service.", "examples": { "PutLlamaRequestExample1": { + "alternatives": [ + { + "code": "resp = client.inference.put(\n task_type=\"text_embedding\",\n inference_id=\"llama-text-embedding\",\n inference_config={\n \"service\": \"llama\",\n \"service_settings\": {\n \"url\": \"http://localhost:8321/v1/inference/embeddings\",\n \"dimensions\": 384,\n \"model_id\": \"all-MiniLM-L6-v2\"\n }\n },\n)", + "language": "Python" + }, + { + "code": "const response = await client.inference.put({\n task_type: \"text_embedding\",\n inference_id: \"llama-text-embedding\",\n inference_config: {\n service: \"llama\",\n service_settings: {\n url: \"http://localhost:8321/v1/inference/embeddings\",\n dimensions: 384,\n model_id: \"all-MiniLM-L6-v2\",\n },\n },\n});", + "language": "JavaScript" + }, + { + "code": "response = client.inference.put(\n task_type: \"text_embedding\",\n inference_id: \"llama-text-embedding\",\n body: {\n \"service\": \"llama\",\n \"service_settings\": {\n \"url\": \"http://localhost:8321/v1/inference/embeddings\",\n \"dimensions\": 384,\n \"model_id\": \"all-MiniLM-L6-v2\"\n }\n }\n)", + "language": "Ruby" + }, + { + "code": "$resp = $client->inference()->put([\n \"task_type\" => \"text_embedding\",\n \"inference_id\" => \"llama-text-embedding\",\n \"body\" => [\n \"service\" => \"llama\",\n \"service_settings\" => [\n \"url\" => \"http://localhost:8321/v1/inference/embeddings\",\n \"dimensions\" => 384,\n \"model_id\" => \"all-MiniLM-L6-v2\",\n ],\n ],\n]);", + "language": "PHP" + }, + { + "code": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"service\":\"llama\",\"service_settings\":{\"url\":\"http://localhost:8321/v1/inference/embeddings\",\"dimensions\":384,\"model_id\":\"all-MiniLM-L6-v2\"}}' \"$ELASTICSEARCH_URL/_inference/text_embedding/llama-text-embedding\"", + "language": "curl" + } + ], "description": "Run `PUT _inference/text_embedding/llama-text-embedding` to create a Llama inference endpoint that performs a `text_embedding` task.", "method_request": "PUT _inference/text_embedding/llama-text-embedding", "value": "{\n \"service\": \"llama\",\n \"service_settings\": {\n \"url\": \"http://localhost:8321/v1/inference/embeddings\",\n \"dimensions\": 384,\n \"model_id\": \"all-MiniLM-L6-v2\" \n }\n}" }, "PutLlamaRequestExample2": { + "alternatives": [ + { + "code": "resp = client.inference.put(\n task_type=\"completion\",\n inference_id=\"llama-completion\",\n inference_config={\n \"service\": \"llama\",\n \"service_settings\": {\n \"url\": \"http://localhost:8321/v1/openai/v1/chat/completions\",\n \"model_id\": \"llama3.2:3b\"\n }\n },\n)", + "language": "Python" + }, + { + "code": "const response = await client.inference.put({\n task_type: \"completion\",\n inference_id: \"llama-completion\",\n inference_config: {\n service: \"llama\",\n service_settings: {\n url: \"http://localhost:8321/v1/openai/v1/chat/completions\",\n model_id: \"llama3.2:3b\",\n },\n },\n});", + "language": "JavaScript" + }, + { + "code": "response = client.inference.put(\n task_type: \"completion\",\n inference_id: \"llama-completion\",\n body: {\n \"service\": \"llama\",\n \"service_settings\": {\n \"url\": \"http://localhost:8321/v1/openai/v1/chat/completions\",\n \"model_id\": \"llama3.2:3b\"\n }\n }\n)", + "language": "Ruby" + }, + { + "code": "$resp = $client->inference()->put([\n \"task_type\" => \"completion\",\n \"inference_id\" => \"llama-completion\",\n \"body\" => [\n \"service\" => \"llama\",\n \"service_settings\" => [\n \"url\" => \"http://localhost:8321/v1/openai/v1/chat/completions\",\n \"model_id\" => \"llama3.2:3b\",\n ],\n ],\n]);", + "language": "PHP" + }, + { + "code": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"service\":\"llama\",\"service_settings\":{\"url\":\"http://localhost:8321/v1/openai/v1/chat/completions\",\"model_id\":\"llama3.2:3b\"}}' \"$ELASTICSEARCH_URL/_inference/completion/llama-completion\"", + "language": "curl" + } + ], "description": "Run `PUT _inference/completion/llama-completion` to create a Llama inference endpoint that performs a `completion` task.", "method_request": "PUT _inference/completion/llama-completion", "value": "{\n \"service\": \"llama\",\n \"service_settings\": {\n \"url\": \"http://localhost:8321/v1/openai/v1/chat/completions\",\n \"model_id\": \"llama3.2:3b\" \n }\n}" }, "PutLlamaRequestExample3": { + "alternatives": [ + { + "code": "resp = client.inference.put(\n task_type=\"chat-completion\",\n inference_id=\"llama-chat-completion\",\n inference_config={\n \"service\": \"llama\",\n \"service_settings\": {\n \"url\": \"http://localhost:8321/v1/openai/v1/chat/completions\",\n \"model_id\": \"llama3.2:3b\"\n }\n },\n)", + "language": "Python" + }, + { + "code": "const response = await client.inference.put({\n task_type: \"chat-completion\",\n inference_id: \"llama-chat-completion\",\n inference_config: {\n service: \"llama\",\n service_settings: {\n url: \"http://localhost:8321/v1/openai/v1/chat/completions\",\n model_id: \"llama3.2:3b\",\n },\n },\n});", + "language": "JavaScript" + }, + { + "code": "response = client.inference.put(\n task_type: \"chat-completion\",\n inference_id: \"llama-chat-completion\",\n body: {\n \"service\": \"llama\",\n \"service_settings\": {\n \"url\": \"http://localhost:8321/v1/openai/v1/chat/completions\",\n \"model_id\": \"llama3.2:3b\"\n }\n }\n)", + "language": "Ruby" + }, + { + "code": "$resp = $client->inference()->put([\n \"task_type\" => \"chat-completion\",\n \"inference_id\" => \"llama-chat-completion\",\n \"body\" => [\n \"service\" => \"llama\",\n \"service_settings\" => [\n \"url\" => \"http://localhost:8321/v1/openai/v1/chat/completions\",\n \"model_id\" => \"llama3.2:3b\",\n ],\n ],\n]);", + "language": "PHP" + }, + { + "code": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"service\":\"llama\",\"service_settings\":{\"url\":\"http://localhost:8321/v1/openai/v1/chat/completions\",\"model_id\":\"llama3.2:3b\"}}' \"$ELASTICSEARCH_URL/_inference/chat-completion/llama-chat-completion\"", + "language": "curl" + } + ], "description": "Run `PUT _inference/chat-completion/llama-chat-completion` to create a Llama inference endpoint that performs a `chat_completion` task.", "method_request": "PUT _inference/chat-completion/llama-chat-completion", "value": "{\n \"service\": \"llama\",\n \"service_settings\": {\n \"url\": \"http://localhost:8321/v1/openai/v1/chat/completions\",\n \"model_id\": \"llama3.2:3b\" \n }\n}" @@ -266650,6 +266742,28 @@ "description": "Set upgrade_mode for transform indices.\nSets a cluster wide upgrade_mode setting that prepares transform\nindices for an upgrade.\nWhen upgrading your cluster, in some circumstances you must restart your\nnodes and reindex your transform indices. In those circumstances,\nthere must be no transforms running. You can close the transforms,\ndo the upgrade, then open all the transforms again. Alternatively,\nyou can use this API to temporarily halt tasks associated with the transforms\nand prevent new transforms from opening. You can also use this API\nduring upgrades that do not require you to reindex your transform\nindices, though stopping transforms is not a requirement in that case.\nYou can see the current value for the upgrade_mode setting by using the get\ntransform info API.", "examples": { "TransformSetUpgradeModeExample1": { + "alternatives": [ + { + "code": "resp = client.transform.set_upgrade_mode(\n enabled=True,\n)", + "language": "Python" + }, + { + "code": "const response = await client.transform.setUpgradeMode({\n enabled: \"true\",\n});", + "language": "JavaScript" + }, + { + "code": "response = client.transform.set_upgrade_mode(\n enabled: \"true\"\n)", + "language": "Ruby" + }, + { + "code": "$resp = $client->transform()->setUpgradeMode([\n \"enabled\" => \"true\",\n]);", + "language": "PHP" + }, + { + "code": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_transform/set_upgrade_mode?enabled=true\"", + "language": "curl" + } + ], "method_request": "POST _transform/set_upgrade_mode?enabled=true" } }, diff --git a/specification/indices/disk_usage/IndicesDiskUsageRequest.ts b/specification/indices/disk_usage/IndicesDiskUsageRequest.ts index a4c457b201..3bce58ff15 100644 --- a/specification/indices/disk_usage/IndicesDiskUsageRequest.ts +++ b/specification/indices/disk_usage/IndicesDiskUsageRequest.ts @@ -29,6 +29,9 @@ import { ExpandWildcards, Indices } from '@_types/common' * NOTE: The total size of fields of the analyzed shards of the index in the response is usually smaller than the index `store_size` value because some small metadata files are ignored and some parts of data files might not be scanned by the API. * Since stored fields are stored together in a compressed format, the sizes of stored fields are also estimates and can be inaccurate. * The stored size of the `_id` field is likely underestimated while the `_source` field is overestimated. + * + * For usage examples see the External documentation or refer to [Analyze the index disk usage example](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/index-disk-usage) for an example. + * @ext_doc_id indices-disk-usage * @doc_id indices-disk-usage * @rest_spec_name indices.disk_usage * @availability stack since=7.15.0 stability=experimental diff --git a/specification/indices/disk_usage/request/200_response/indicesDiskUsageResponseExample1.yaml b/specification/indices/disk_usage/examples/200_response/IndicesDiskUsageResponseExample1.yaml similarity index 96% rename from specification/indices/disk_usage/request/200_response/indicesDiskUsageResponseExample1.yaml rename to specification/indices/disk_usage/examples/200_response/IndicesDiskUsageResponseExample1.yaml index f75f08217a..506be8b539 100644 --- a/specification/indices/disk_usage/request/200_response/indicesDiskUsageResponseExample1.yaml +++ b/specification/indices/disk_usage/examples/200_response/IndicesDiskUsageResponseExample1.yaml @@ -8,10 +8,10 @@ value: successful: 1 failed: 0 my-index-000001: - store_size: 929mb" + store_size: 929mb store_size_in_bytes: 974192723 all_fields: - total: 928.9mb" + total: 928.9mb total_in_bytes: 973977084 inverted_index: total: 107.8mb @@ -45,7 +45,7 @@ value: norms_in_bytes: 0 term_vectors: 0b term_vectors_in_bytes: 0 - knn_vectors": 0b + knn_vectors: 0b knn_vectors_in_bytes: 0 _primary_term: {} _seq_no: {} diff --git a/specification/indices/disk_usage/examples/request/IndicesDiskUsageExample1.yaml b/specification/indices/disk_usage/examples/request/IndicesDiskUsageRequestExample1.yaml similarity index 100% rename from specification/indices/disk_usage/examples/request/IndicesDiskUsageExample1.yaml rename to specification/indices/disk_usage/examples/request/IndicesDiskUsageRequestExample1.yaml diff --git a/specification/indices/disk_usage/request/request/indicesDiskUsageRequestExample1.yaml b/specification/indices/disk_usage/request/request/indicesDiskUsageRequestExample1.yaml deleted file mode 100644 index acfe6b7fc1..0000000000 --- a/specification/indices/disk_usage/request/request/indicesDiskUsageRequestExample1.yaml +++ /dev/null @@ -1 +0,0 @@ -method_request: POST /my-index-000001/_disk_usage?run_expensive_tasks=true