diff --git a/compiler-rs/clients_schema_to_openapi/src/paths.rs b/compiler-rs/clients_schema_to_openapi/src/paths.rs index debf17779f..6574aae06a 100644 --- a/compiler-rs/clients_schema_to_openapi/src/paths.rs +++ b/compiler-rs/clients_schema_to_openapi/src/paths.rs @@ -144,14 +144,16 @@ pub fn add_endpoint( // } }; - let openapi_example = Example { - value: example, - description: schema_example.description.clone(), - summary: schema_example.summary.clone(), - external_value: None, - extensions: Default::default(), - }; - openapi_examples.insert(name.clone(), ReferenceOr::Item(openapi_example)); + if example.is_some() { + let openapi_example = Example { + value: example, + description: schema_example.description.clone(), + summary: schema_example.summary.clone(), + external_value: None, + extensions: Default::default(), + }; + openapi_examples.insert(name.clone(), ReferenceOr::Item(openapi_example)); + } } openapi_examples } @@ -329,21 +331,6 @@ pub fn add_endpoint( } } } - if code_samples.is_empty() { - // if there are no example requests we look for example responses - // this can only happen for examples that do not have a request body - if let Some(examples) = response_def.examples.clone() { - if let Some((_, example)) = examples.first() { - let request_line = example.method_request.clone().unwrap_or(String::from("")); - if !request_line.is_empty() { - code_samples.push(serde_json::json!({ - "lang": "Console", - "source": request_line + "\n", - })); - } - } - } - } if !code_samples.is_empty() { extensions.insert("x-codeSamples".to_string(), serde_json::json!(code_samples)); } diff --git a/compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm b/compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm index b6d4882e11..9035a11451 100644 Binary files a/compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm and b/compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm differ diff --git a/docs/overlays/elasticsearch-shared-overlays.yaml b/docs/overlays/elasticsearch-shared-overlays.yaml index b821d46905..68af57169e 100644 --- a/docs/overlays/elasticsearch-shared-overlays.yaml +++ b/docs/overlays/elasticsearch-shared-overlays.yaml @@ -1077,17 +1077,6 @@ actions: # update: # aggregations: # x-model: true -# Examples -## xCodeSamples - - target: "$.paths['/{index}/_doc/{id}']['head']" - description: "Add xCodeSamples for check document operation" - update: - x-codeSamples: - - $ref: "../../specification/_global/exists/examples/xCodeSamples/DocumentExistsConsoleExample1.yaml" - - $ref: "../../specification/_global/exists/examples/xCodeSamples/DocumentExistsCurlExample1.yaml" - - $ref: "../../specification/_global/exists/examples/xCodeSamples/DocumentExistsJavaScriptExample1.yaml" - - $ref: "../../specification/_global/exists/examples/xCodeSamples/DocumentExistsPythonExample1.yaml" - - $ref: "../../specification/_global/exists/examples/xCodeSamples/DocumentExistsRubyExample1.yaml" # Remove long lists of enum values - target: "$.components['schemas']['cat._types.CatAnomalyDetectorColumn'].enum" description: Remove enum array diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index a7189ffb60..aea7aacf90 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -118,7 +118,13 @@ } } }, - "x-state": "Added in 7.7.0" + "x-state": "Added in 7.7.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE /_async_search/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\n" + } + ] } }, "/_async_search/status/{id}": { @@ -2215,7 +2221,7 @@ "x-codeSamples": [ { "lang": "Console", - "source": "GET /_cat/nodes?v=true&format=json\n" + "source": "GET /_cat/nodes?v=true&h=id,ip,port,v,m&format=json\n" } ] } @@ -4646,7 +4652,13 @@ "$ref": "#/components/responses/cluster.get_component_template-200" } }, - "x-state": "Added in 7.8.0" + "x-state": "Added in 7.8.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_component_template/template_1\n" + } + ] }, "put": { "tags": [ @@ -4768,7 +4780,13 @@ } } }, - "x-state": "Added in 7.8.0" + "x-state": "Added in 7.8.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _component_template/template_1\n" + } + ] }, "head": { "tags": [ @@ -4954,7 +4972,13 @@ "$ref": "#/components/responses/cluster.get_component_template-200" } }, - "x-state": "Added in 7.8.0" + "x-state": "Added in 7.8.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_component_template/template_1\n" + } + ] } }, "/_cluster/settings": { @@ -5048,7 +5072,13 @@ } } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_cluster/settings?filter_path=persistent.cluster.remote\n" + } + ] }, "put": { "tags": [ @@ -5345,7 +5375,13 @@ } } }, - "x-state": "Added in 8.9.0" + "x-state": "Added in 8.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_info/_all\n" + } + ] } }, "/_cluster/pending_tasks": { @@ -5400,7 +5436,13 @@ } } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_cluster/pending_tasks\n" + } + ] } }, "/_remote/info": { @@ -5429,7 +5471,13 @@ } } }, - "x-state": "Added in 6.1.0" + "x-state": "Added in 6.1.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_remote/info\n" + } + ] } }, "/_cluster/reroute": { @@ -5604,7 +5652,13 @@ "$ref": "#/components/responses/cluster.state-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_cluster/state?filter_path=metadata.cluster_coordination.last_committed_config\n" + } + ] } }, "/_cluster/state/{metric}": { @@ -5649,7 +5703,13 @@ "$ref": "#/components/responses/cluster.state-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_cluster/state?filter_path=metadata.cluster_coordination.last_committed_config\n" + } + ] } }, "/_cluster/state/{metric}/{index}": { @@ -5697,7 +5757,13 @@ "$ref": "#/components/responses/cluster.state-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_cluster/state?filter_path=metadata.cluster_coordination.last_committed_config\n" + } + ] } }, "/_cluster/stats": { @@ -5721,7 +5787,13 @@ "$ref": "#/components/responses/cluster.stats-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _cluster/stats?human&filter_path=indices.mappings.total_deduplicated_mapping_size*\n" + } + ] } }, "/_cluster/stats/nodes/{node_id}": { @@ -5748,7 +5820,13 @@ "$ref": "#/components/responses/cluster.stats-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _cluster/stats?human&filter_path=indices.mappings.total_deduplicated_mapping_size*\n" + } + ] } }, "/_connector/{connector_id}/_check_in": { @@ -5797,7 +5875,13 @@ } } }, - "x-state": "Technical preview" + "x-state": "Technical preview", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _connector/my-connector/_check_in\n" + } + ] } }, "/_connector/{connector_id}": { @@ -5843,7 +5927,13 @@ } } }, - "x-beta": true + "x-beta": true, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _connector/my-connector-id\n" + } + ] }, "put": { "tags": [ @@ -5929,7 +6019,13 @@ } } }, - "x-beta": true + "x-beta": true, + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _connector/my-connector-id&delete_sync_jobs=true\n" + } + ] } }, "/_connector": { @@ -6039,7 +6135,13 @@ } } }, - "x-beta": true + "x-beta": true, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _connector\n" + } + ] }, "put": { "tags": [ @@ -6167,7 +6269,13 @@ } } }, - "x-beta": true + "x-beta": true, + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _connector/_sync_job/my-connector-sync-job-id/_cancel\n" + } + ] } }, "/_connector/_sync_job/{connector_sync_job_id}/_check_in": { @@ -6203,7 +6311,13 @@ } } }, - "x-state": "Technical preview" + "x-state": "Technical preview", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _connector/_sync_job/my-connector-sync-job/_check_in\n" + } + ] } }, "/_connector/_sync_job/{connector_sync_job_id}/_claim": { @@ -6245,6 +6359,12 @@ "required": [ "worker_hostname" ] + }, + "examples": { + "ConnectorSyncJobClaimExample1": { + "description": "An example body for a `PUT _connector/_sync_job/my-connector-sync-job-id/_claim` request.", + "value": "{\n \"worker_hostname\": \"some-machine\"\n}" + } } } }, @@ -6262,7 +6382,13 @@ } } }, - "x-state": "Technical preview" + "x-state": "Technical preview", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _connector/_sync_job/my-connector-sync-job-id/_claim\n{\n \"worker_hostname\": \"some-machine\"\n}" + } + ] } }, "/_connector/_sync_job/{connector_sync_job_id}": { @@ -6297,7 +6423,13 @@ } } }, - "x-beta": true + "x-beta": true, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _connector/_sync_job/my-connector-sync-job\n" + } + ] }, "delete": { "tags": [ @@ -6336,7 +6468,13 @@ } } }, - "x-beta": true + "x-beta": true, + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _connector/_sync_job/my-connector-sync-job-id\n" + } + ] } }, "/_connector/_sync_job/{connector_sync_job_id}/_error": { @@ -6502,7 +6640,13 @@ } } }, - "x-beta": true + "x-beta": true, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _connector/_sync_job?connector_id=my-connector-id&size=1\n" + } + ] }, "post": { "tags": [ @@ -6624,6 +6768,12 @@ "indexed_document_count", "indexed_document_volume" ] + }, + "examples": { + "ConnectorSyncJobUpdateStatsExample1": { + "description": "An example body for a `PUT _connector/_sync_job/my-connector-sync-job/_stats` request.", + "value": "{\n \"deleted_document_count\": 10,\n \"indexed_document_count\": 20,\n \"indexed_document_volume\": 1000,\n \"total_document_count\": 2000,\n \"last_seen\": \"2023-01-02T10:00:00Z\"\n}" + } } } }, @@ -6641,7 +6791,13 @@ } } }, - "x-state": "Technical preview" + "x-state": "Technical preview", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _connector/_sync_job/my-connector-sync-job/_stats\n{\n \"deleted_document_count\": 10,\n \"indexed_document_count\": 20,\n \"indexed_document_volume\": 1000,\n \"total_document_count\": 2000,\n \"last_seen\": \"2023-01-02T10:00:00Z\"\n}" + } + ] } }, "/_connector/{connector_id}/_filtering/_activate": { @@ -8266,7 +8422,13 @@ } } }, - "x-state": "Added in 7.9.0" + "x-state": "Added in 7.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE /_dangling/?accept_data_loss=true\n" + } + ] } }, "/_dangling": { @@ -8305,7 +8467,13 @@ } } }, - "x-state": "Added in 7.9.0" + "x-state": "Added in 7.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_dangling\n" + } + ] } }, "/{index}/_doc/{id}": { @@ -8472,7 +8640,7 @@ "x-codeSamples": [ { "lang": "Console", - "source": "GET my-index-000001/_doc/0\n" + "source": "GET my-index-000001/_doc/1?stored_fields=tags,counter\n" } ] }, @@ -8888,7 +9056,13 @@ "application/json": {} } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "HEAD my-index-000001/_doc/0\n" + } + ] } }, "/{index}/_delete_by_query": { @@ -9383,7 +9557,13 @@ } } }, - "x-state": "Added in 6.5.0" + "x-state": "Added in 6.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _delete_by_query/r1A2WoRbTwKZ516z6NEs5A:36619/_rethrottle?requests_per_second=-1\n" + } + ] } }, "/_scripts/{id}": { @@ -9443,7 +9623,13 @@ } } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _scripts/my-search-template\n" + } + ] }, "put": { "tags": [ @@ -9574,7 +9760,13 @@ } } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _scripts/my-search-template\n" + } + ] } }, "/_enrich/policy/{name}": { @@ -9598,7 +9790,13 @@ "$ref": "#/components/responses/enrich.get_policy-200" } }, - "x-state": "Added in 7.5.0" + "x-state": "Added in 7.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_enrich/policy/my-policy\n" + } + ] }, "put": { "tags": [ @@ -9646,6 +9844,12 @@ "$ref": "#/components/schemas/enrich._types.Policy" } } + }, + "examples": { + "EnrichPutPolicyExample1": { + "description": "An example body for a `PUT /_enrich/policy/postal_policy` request.", + "value": "{\n \"geo_match\": {\n \"indices\": \"postal_codes\",\n \"match_field\": \"location\",\n \"enrich_fields\": [ \"location\", \"postal_code\" ]\n }\n}" + } } } }, @@ -9663,7 +9867,13 @@ } } }, - "x-state": "Added in 7.5.0" + "x-state": "Added in 7.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT /_enrich/policy/postal_policy\n{\n \"geo_match\": {\n \"indices\": \"postal_codes\",\n \"match_field\": \"location\",\n \"enrich_fields\": [ \"location\", \"postal_code\" ]\n }\n}" + } + ] }, "delete": { "tags": [ @@ -9707,7 +9917,13 @@ } } }, - "x-state": "Added in 7.5.0" + "x-state": "Added in 7.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE /_enrich/policy/my-policy\n" + } + ] } }, "/_enrich/policy/{name}/_execute": { @@ -9771,7 +9987,13 @@ } } }, - "x-state": "Added in 7.5.0" + "x-state": "Added in 7.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT /_enrich/policy/my-policy/_execute?wait_for_completion=false\n" + } + ] } }, "/_enrich/policy": { @@ -9792,7 +10014,13 @@ "$ref": "#/components/responses/enrich.get_policy-200" } }, - "x-state": "Added in 7.5.0" + "x-state": "Added in 7.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_enrich/policy/my-policy\n" + } + ] } }, "/_enrich/_stats": { @@ -9854,7 +10082,13 @@ } } }, - "x-state": "Added in 7.5.0" + "x-state": "Added in 7.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_enrich/_stats\n" + } + ] } }, "/_eql/search/{id}": { @@ -9910,7 +10144,13 @@ } } }, - "x-state": "Added in 7.9.0" + "x-state": "Added in 7.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_eql/search/FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=?wait_for_completion_timeout=2s\n" + } + ] }, "delete": { "tags": [ @@ -9944,7 +10184,13 @@ } } }, - "x-state": "Added in 7.9.0" + "x-state": "Added in 7.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE /_eql/search/FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=\n" + } + ] } }, "/_eql/search/status/{id}": { @@ -10014,7 +10260,13 @@ } } }, - "x-state": "Added in 7.9.0" + "x-state": "Added in 7.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_eql/search/status/FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=\n" + } + ] } }, "/{index}/_eql/search": { @@ -10351,7 +10603,13 @@ } } }, - "x-state": "Added in 8.13.0" + "x-state": "Added in 8.13.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_query/async/FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=?wait_for_completion_timeout=30s\n" + } + ] }, "delete": { "tags": [ @@ -10388,7 +10646,13 @@ } } }, - "x-state": "Added in 8.13.0" + "x-state": "Added in 8.13.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE /_query/async/FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=\n" + } + ] } }, "/_query/async/{id}/stop": { @@ -10437,7 +10701,13 @@ } } }, - "x-state": "Added in 8.18.0" + "x-state": "Added in 8.18.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST /_query/async/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=/stop\n" + } + ] } }, "/_query": { @@ -10709,7 +10979,13 @@ } } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET my-index-000001/_source/1\n" + } + ] }, "head": { "tags": [ @@ -10843,7 +11119,13 @@ } } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "HEAD my-index-000001/_source/1\n" + } + ] } }, "/{index}/_explain/{id}": { @@ -11032,7 +11314,13 @@ } } }, - "x-state": "Added in 7.12.0" + "x-state": "Added in 7.12.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _features\n" + } + ] } }, "/_features/_reset": { @@ -11084,7 +11372,13 @@ } } }, - "x-state": "Technical preview" + "x-state": "Technical preview", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST /_features/_reset\n" + } + ] } }, "/_field_caps": { @@ -11970,7 +12264,13 @@ } } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _script_context\n" + } + ] } }, "/_script_language": { @@ -12010,7 +12310,13 @@ } } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _script_language\n" + } + ] } }, "/{index}/_graph/explore": { @@ -12111,7 +12417,13 @@ "$ref": "#/components/responses/health_report-200" } }, - "x-state": "Added in 8.7.0" + "x-state": "Added in 8.7.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _health_report\n" + } + ] } }, "/_health_report/{feature}": { @@ -12141,7 +12453,13 @@ "$ref": "#/components/responses/health_report-200" } }, - "x-state": "Added in 8.7.0" + "x-state": "Added in 8.7.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _health_report\n" + } + ] } }, "/_ilm/policy/{policy}": { @@ -12167,7 +12485,13 @@ "$ref": "#/components/responses/ilm.get_lifecycle-200" } }, - "x-state": "Added in 6.6.0" + "x-state": "Added in 6.6.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ilm/policy/my_policy\n" + } + ] }, "put": { "tags": [ @@ -12316,7 +12640,13 @@ } } }, - "x-state": "Added in 6.6.0" + "x-state": "Added in 6.6.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _ilm/policy/my_policy\n" + } + ] } }, "/{index}/_ilm/explain": { @@ -12399,7 +12729,13 @@ } } }, - "x-state": "Added in 6.6.0" + "x-state": "Added in 6.6.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET .ds-timeseries-*/_ilm/explain\n" + } + ] } }, "/_ilm/policy": { @@ -12422,7 +12758,13 @@ "$ref": "#/components/responses/ilm.get_lifecycle-200" } }, - "x-state": "Added in 6.6.0" + "x-state": "Added in 6.6.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ilm/policy/my_policy\n" + } + ] } }, "/_ilm/status": { @@ -12459,7 +12801,13 @@ } } }, - "x-state": "Added in 6.6.0" + "x-state": "Added in 6.6.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ilm/status\n" + } + ] } }, "/_ilm/migrate_to_data_tiers": { @@ -12729,7 +13077,13 @@ } } }, - "x-state": "Added in 6.6.0" + "x-state": "Added in 6.6.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST logs-my_app-default/_ilm/remove\n" + } + ] } }, "/{index}/_ilm/retry": { @@ -12765,7 +13119,13 @@ } } }, - "x-state": "Added in 6.6.0" + "x-state": "Added in 6.6.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST /my-index-000001/_ilm/retry\n" + } + ] } }, "/_ilm/start": { @@ -12816,7 +13176,13 @@ } } }, - "x-state": "Added in 6.6.0" + "x-state": "Added in 6.6.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ilm/start\n" + } + ] } }, "/_ilm/stop": { @@ -12867,7 +13233,13 @@ } } }, - "x-state": "Added in 6.6.0" + "x-state": "Added in 6.6.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ilm/stop\n" + } + ] } }, "/{index}/_doc": { @@ -13229,7 +13601,13 @@ } } }, - "x-state": "Technical preview" + "x-state": "Technical preview", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST /_migration/reindex/my-data-stream/_cancel\n" + } + ] } }, "/_cache/clear": { @@ -13270,7 +13648,13 @@ "200": { "$ref": "#/components/responses/indices.clear_cache-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST /my-index-000001,my-index-000002/_cache/clear?request=true\n" + } + ] } }, "/{index}/_cache/clear": { @@ -13314,7 +13698,13 @@ "200": { "$ref": "#/components/responses/indices.clear_cache-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST /my-index-000001,my-index-000002/_cache/clear?request=true\n" + } + ] } }, "/{index}/_clone/{target}": { @@ -13516,7 +13906,13 @@ } } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST /my-index-00001/_close\n" + } + ] } }, "/{index}": { @@ -13634,7 +14030,13 @@ } } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /my-index-000001\n" + } + ] }, "put": { "tags": [ @@ -13843,7 +14245,13 @@ } } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE /books\n" + } + ] }, "head": { "tags": [ @@ -13932,7 +14340,13 @@ "application/json": {} } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "HEAD my-data-stream\n" + } + ] } }, "/_data_stream/{name}": { @@ -13965,7 +14379,13 @@ "$ref": "#/components/responses/indices.get_data_stream-200" } }, - "x-state": "Added in 7.9.0" + "x-state": "Added in 7.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _data_stream/my-data-stream\n" + } + ] }, "put": { "tags": [ @@ -14019,7 +14439,13 @@ } } }, - "x-state": "Added in 7.9.0" + "x-state": "Added in 7.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _data_stream/logs-foo-bar\n" + } + ] }, "delete": { "tags": [ @@ -14073,7 +14499,13 @@ } } }, - "x-state": "Added in 7.9.0" + "x-state": "Added in 7.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _data_stream/my-data-stream\n" + } + ] } }, "/_create_from/{source}/{dest}": { @@ -14100,7 +14532,13 @@ "$ref": "#/components/responses/indices.create_from-200" } }, - "x-state": "Technical preview" + "x-state": "Technical preview", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _create_from/my-index/my-new-index\n" + } + ] }, "post": { "tags": [ @@ -14125,7 +14563,13 @@ "$ref": "#/components/responses/indices.create_from-200" } }, - "x-state": "Technical preview" + "x-state": "Technical preview", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _create_from/my-index/my-new-index\n" + } + ] } }, "/_data_stream/_stats": { @@ -14146,7 +14590,13 @@ "$ref": "#/components/responses/indices.data_streams_stats-200" } }, - "x-state": "Added in 7.9.0" + "x-state": "Added in 7.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_data_stream/my-index-000001/_stats\n" + } + ] } }, "/_data_stream/{name}/_stats": { @@ -14170,7 +14620,13 @@ "$ref": "#/components/responses/indices.data_streams_stats-200" } }, - "x-state": "Added in 7.9.0" + "x-state": "Added in 7.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_data_stream/my-index-000001/_stats\n" + } + ] } }, "/{index}/_alias/{name}": { @@ -14205,7 +14661,13 @@ "200": { "$ref": "#/components/responses/indices.get_alias-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _alias\n" + } + ] }, "put": { "tags": [ @@ -14304,7 +14766,13 @@ "200": { "$ref": "#/components/responses/indices.delete_alias-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE my-data-stream/_alias/my-alias\n" + } + ] }, "head": { "tags": [ @@ -14337,7 +14805,13 @@ "200": { "$ref": "#/components/responses/indices.exists_alias-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "HEAD _alias/my-alias\n" + } + ] } }, "/{index}/_aliases/{name}": { @@ -14438,7 +14912,13 @@ "200": { "$ref": "#/components/responses/indices.delete_alias-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE my-data-stream/_alias/my-alias\n" + } + ] } }, "/_data_stream/{name}/_lifecycle": { @@ -14513,7 +14993,7 @@ }, "examples": { "IndicesGetDataLifecycleResponseExample1": { - "description": "A successful response from `GET _lifecycle/stats?human&pretty`.", + "description": "A successful response from `GET /_data_stream/{name}/_lifecycle?human&pretty`.", "value": "{\n \"data_streams\": [\n {\n \"name\": \"my-data-stream-1\",\n \"lifecycle\": {\n \"enabled\": true,\n \"data_retention\": \"7d\"\n }\n },\n {\n \"name\": \"my-data-stream-2\",\n \"lifecycle\": {\n \"enabled\": true,\n \"data_retention\": \"7d\"\n }\n }\n ]\n}" } } @@ -14525,7 +15005,7 @@ "x-codeSamples": [ { "lang": "Console", - "source": "GET _lifecycle/stats?human&pretty\n" + "source": "GET /_data_stream/{name}/_lifecycle?human&pretty\n" } ] }, @@ -14705,7 +15185,13 @@ } } }, - "x-state": "Added in 8.11.0" + "x-state": "Added in 8.11.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _data_stream/my-data-stream/_lifecycle\n" + } + ] } }, "/_index_template/{name}": { @@ -14738,7 +15224,13 @@ "$ref": "#/components/responses/indices.get_index_template-200" } }, - "x-state": "Added in 7.9.0" + "x-state": "Added in 7.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream\n" + } + ] }, "put": { "tags": [ @@ -14866,7 +15358,13 @@ } } }, - "x-state": "Added in 7.8.0" + "x-state": "Added in 7.8.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE /_index_template/my-index-template\n" + } + ] }, "head": { "tags": [ @@ -14958,7 +15456,13 @@ "$ref": "#/components/responses/indices.get_template-200" } }, - "deprecated": true + "deprecated": true, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_template/.monitoring-*\n" + } + ] }, "put": { "tags": [ @@ -15086,7 +15590,13 @@ } } }, - "deprecated": true + "deprecated": true, + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _template/.cloud-hot-warm-allocation-0\n" + } + ] }, "head": { "tags": [ @@ -15148,7 +15658,13 @@ "application/json": {} } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "HEAD /_template/template_1\n" + } + ] } }, "/{index}/_disk_usage": { @@ -15234,7 +15750,13 @@ } } }, - "x-state": "Technical preview" + "x-state": "Technical preview", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST /my-index-000001/_disk_usage?run_expensive_tasks=true\n" + } + ] } }, "/{index}/_downsample/{target_index}": { @@ -15334,7 +15856,13 @@ "200": { "$ref": "#/components/responses/indices.get_alias-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _alias\n" + } + ] }, "head": { "tags": [ @@ -15364,7 +15892,13 @@ "200": { "$ref": "#/components/responses/indices.exists_alias-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "HEAD _alias/my-alias\n" + } + ] } }, "/{index}/_lifecycle/explain": { @@ -15569,7 +16103,13 @@ "200": { "$ref": "#/components/responses/indices.flush-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST /_flush\n" + } + ] }, "post": { "tags": [ @@ -15599,7 +16139,13 @@ "200": { "$ref": "#/components/responses/indices.flush-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST /_flush\n" + } + ] } }, "/{index}/_flush": { @@ -15634,7 +16180,13 @@ "200": { "$ref": "#/components/responses/indices.flush-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST /_flush\n" + } + ] }, "post": { "tags": [ @@ -15667,7 +16219,13 @@ "200": { "$ref": "#/components/responses/indices.flush-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST /_flush\n" + } + ] } }, "/_forcemerge": { @@ -15709,7 +16267,13 @@ "$ref": "#/components/responses/indices.forcemerge-200" } }, - "x-state": "Added in 2.1.0" + "x-state": "Added in 2.1.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST my-index-000001/_forcemerge\n" + } + ] } }, "/{index}/_forcemerge": { @@ -15754,7 +16318,13 @@ "$ref": "#/components/responses/indices.forcemerge-200" } }, - "x-state": "Added in 2.1.0" + "x-state": "Added in 2.1.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST my-index-000001/_forcemerge\n" + } + ] } }, "/_alias": { @@ -15783,7 +16353,13 @@ "200": { "$ref": "#/components/responses/indices.get_alias-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _alias\n" + } + ] } }, "/{index}/_alias": { @@ -15815,7 +16391,13 @@ "200": { "$ref": "#/components/responses/indices.get_alias-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _alias\n" + } + ] } }, "/_lifecycle/stats": { @@ -15903,7 +16485,13 @@ "$ref": "#/components/responses/indices.get_data_stream-200" } }, - "x-state": "Added in 7.9.0" + "x-state": "Added in 7.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _data_stream/my-data-stream\n" + } + ] } }, "/_mapping/field/{fields}": { @@ -16018,7 +16606,13 @@ "$ref": "#/components/responses/indices.get_index_template-200" } }, - "x-state": "Added in 7.9.0" + "x-state": "Added in 7.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream\n" + } + ] } }, "/_mapping": { @@ -16050,7 +16644,13 @@ "200": { "$ref": "#/components/responses/indices.get_mapping-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /books/_mapping\n" + } + ] } }, "/{index}/_mapping": { @@ -16085,7 +16685,13 @@ "200": { "$ref": "#/components/responses/indices.get_mapping-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /books/_mapping\n" + } + ] }, "put": { "tags": [ @@ -16265,7 +16871,13 @@ } } }, - "x-state": "Technical preview" + "x-state": "Technical preview", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_migration/reindex/my-data-stream/_status\n" + } + ] } }, "/_settings": { @@ -16303,7 +16915,13 @@ "200": { "$ref": "#/components/responses/indices.get_settings-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _all/_settings?expand_wildcards=all&filter_path=*.settings.index.*.slowlog\n" + } + ] }, "put": { "tags": [ @@ -16395,7 +17013,13 @@ "200": { "$ref": "#/components/responses/indices.get_settings-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _all/_settings?expand_wildcards=all&filter_path=*.settings.index.*.slowlog\n" + } + ] }, "put": { "tags": [ @@ -16493,7 +17117,13 @@ "200": { "$ref": "#/components/responses/indices.get_settings-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _all/_settings?expand_wildcards=all&filter_path=*.settings.index.*.slowlog\n" + } + ] } }, "/_settings/{name}": { @@ -16534,7 +17164,13 @@ "200": { "$ref": "#/components/responses/indices.get_settings-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _all/_settings?expand_wildcards=all&filter_path=*.settings.index.*.slowlog\n" + } + ] } }, "/_template": { @@ -16564,7 +17200,13 @@ "$ref": "#/components/responses/indices.get_template-200" } }, - "deprecated": true + "deprecated": true, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_template/.monitoring-*\n" + } + ] } }, "/_migration/reindex": { @@ -16580,6 +17222,12 @@ "application/json": { "schema": { "$ref": "#/components/schemas/indices.migrate_reindex.MigrateReindex" + }, + "examples": { + "IndicesMigrateReindexExample1": { + "description": "An example body for a `POST _migration/reindex` request.", + "value": "{\n \"source\": {\n \"index\": \"my-data-stream\"\n },\n \"mode\": \"upgrade\"\n}" + } } } }, @@ -16597,7 +17245,13 @@ } } }, - "x-state": "Technical preview" + "x-state": "Technical preview", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _migration/reindex\n{\n \"source\": {\n \"index\": \"my-data-stream\"\n },\n \"mode\": \"upgrade\"\n}" + } + ] } }, "/_data_stream/_migrate/{name}": { @@ -16653,7 +17307,13 @@ } } }, - "x-state": "Added in 7.9.0" + "x-state": "Added in 7.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _data_stream/_migrate/my-time-series-data\n" + } + ] } }, "/_data_stream/_modify": { @@ -16681,6 +17341,12 @@ "required": [ "actions" ] + }, + "examples": { + "IndicesModifyDataStreamExample1": { + "description": "An example body for a `POST _data_stream/_modify` request.", + "value": "{\n \"actions\": [\n {\n \"remove_backing_index\": {\n \"data_stream\": \"my-data-stream\",\n \"index\": \".ds-my-data-stream-2023.07.26-000001\"\n }\n },\n {\n \"add_backing_index\": {\n \"data_stream\": \"my-data-stream\",\n \"index\": \".ds-my-data-stream-2023.07.26-000001-downsample\"\n }\n }\n ]\n}" + } } } }, @@ -16698,7 +17364,13 @@ } } }, - "x-state": "Added in 7.16.0" + "x-state": "Added in 7.16.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _data_stream/_modify\n{\n \"actions\": [\n {\n \"remove_backing_index\": {\n \"data_stream\": \"my-data-stream\",\n \"index\": \".ds-my-data-stream-2023.07.26-000001\"\n }\n },\n {\n \"add_backing_index\": {\n \"data_stream\": \"my-data-stream\",\n \"index\": \".ds-my-data-stream-2023.07.26-000001-downsample\"\n }\n }\n ]\n}" + } + ] } }, "/{index}/_open": { @@ -16811,7 +17483,13 @@ } } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST /.ds-my-data-stream-2099.03.07-000001/_open/\n" + } + ] } }, "/_data_stream/_promote/{name}": { @@ -16857,7 +17535,13 @@ } } }, - "x-state": "Added in 7.9.0" + "x-state": "Added in 7.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST /_data_stream/_promote/my-data-stream\n" + } + ] } }, "/_recovery": { @@ -16944,7 +17628,13 @@ "200": { "$ref": "#/components/responses/indices.refresh-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _refresh\n" + } + ] }, "post": { "tags": [ @@ -16968,7 +17658,13 @@ "200": { "$ref": "#/components/responses/indices.refresh-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _refresh\n" + } + ] } }, "/{index}/_refresh": { @@ -16997,7 +17693,13 @@ "200": { "$ref": "#/components/responses/indices.refresh-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _refresh\n" + } + ] }, "post": { "tags": [ @@ -17024,7 +17726,13 @@ "200": { "$ref": "#/components/responses/indices.refresh-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _refresh\n" + } + ] } }, "/{index}/_reload_search_analyzers": { @@ -17143,7 +17851,7 @@ "x-codeSamples": [ { "lang": "Console", - "source": "GET /_resolve/cluster/my-index*,clust*:my-index*\n" + "source": "GET /_resolve/cluster/not-present,clust*:my-index*,oldcluster:*?ignore_unavailable=false&timeout=5s\n" } ] } @@ -17185,7 +17893,7 @@ "x-codeSamples": [ { "lang": "Console", - "source": "GET /_resolve/cluster/my-index*,clust*:my-index*\n" + "source": "GET /_resolve/cluster/not-present,clust*:my-index*,oldcluster:*?ignore_unavailable=false&timeout=5s\n" } ] } @@ -17409,7 +18117,13 @@ "200": { "$ref": "#/components/responses/indices.segments-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /my-index-000001/_segments\n" + } + ] } }, "/{index}/_segments": { @@ -17438,7 +18152,13 @@ "200": { "$ref": "#/components/responses/indices.segments-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /my-index-000001/_segments\n" + } + ] } }, "/_shard_stores": { @@ -17901,7 +18621,13 @@ "$ref": "#/components/responses/indices.stats-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _stats/fielddata?human&fields=my_join_field#question\n" + } + ] } }, "/_stats/{metric}": { @@ -17949,7 +18675,13 @@ "$ref": "#/components/responses/indices.stats-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _stats/fielddata?human&fields=my_join_field#question\n" + } + ] } }, "/{index}/_stats": { @@ -17997,7 +18729,13 @@ "$ref": "#/components/responses/indices.stats-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _stats/fielddata?human&fields=my_join_field#question\n" + } + ] } }, "/{index}/_stats/{metric}": { @@ -18048,7 +18786,13 @@ "$ref": "#/components/responses/indices.stats-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _stats/fielddata?human&fields=my_join_field#question\n" + } + ] } }, "/_aliases": { @@ -18095,6 +18839,12 @@ } } } + }, + "examples": { + "IndicesUpdateAliasesExample1": { + "description": "An example body for a `POST _aliases` request.", + "value": "{\n \"actions\": [\n {\n \"add\": {\n \"index\": \"logs-nginx.access-prod\",\n \"alias\": \"logs\"\n }\n }\n ]\n}" + } } } }, @@ -18112,7 +18862,13 @@ } } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _aliases\n{\n \"actions\": [\n {\n \"add\": {\n \"index\": \"logs-nginx.access-prod\",\n \"alias\": \"logs\"\n }\n }\n ]\n}" + } + ] } }, "/_validate/query": { @@ -18169,7 +18925,13 @@ "$ref": "#/components/responses/indices.validate_query-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET my-index-000001/_validate/query?q=user.id:kimchy\n" + } + ] }, "post": { "tags": [ @@ -18224,7 +18986,13 @@ "$ref": "#/components/responses/indices.validate_query-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET my-index-000001/_validate/query?q=user.id:kimchy\n" + } + ] } }, "/{index}/_validate/query": { @@ -18284,7 +19052,13 @@ "$ref": "#/components/responses/indices.validate_query-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET my-index-000001/_validate/query?q=user.id:kimchy\n" + } + ] }, "post": { "tags": [ @@ -18342,7 +19116,13 @@ "$ref": "#/components/responses/indices.validate_query-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET my-index-000001/_validate/query?q=user.id:kimchy\n" + } + ] } }, "/_inference/chat_completion/{inference_id}/_stream": { @@ -18543,7 +19323,13 @@ "$ref": "#/components/responses/inference.get-200" } }, - "x-state": "Added in 8.11.0" + "x-state": "Added in 8.11.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _inference/sparse_embedding/my-elser-model\n" + } + ] }, "put": { "tags": [ @@ -18565,7 +19351,13 @@ "$ref": "#/components/responses/inference.put-200" } }, - "x-state": "Added in 8.11.0" + "x-state": "Added in 8.11.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _inference/rerank/my-rerank-model\n{\n \"service\": \"cohere\",\n \"service_settings\": {\n \"model_id\": \"rerank-english-v3.0\",\n \"api_key\": \"{{COHERE_API_KEY}}\"\n }\n}" + } + ] }, "post": { "tags": [ @@ -18614,7 +19406,13 @@ "$ref": "#/components/responses/inference.delete-200" } }, - "x-state": "Added in 8.11.0" + "x-state": "Added in 8.11.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE /_inference/sparse_embedding/my-elser-model\n" + } + ] } }, "/_inference/{task_type}/{inference_id}": { @@ -18637,7 +19435,13 @@ "$ref": "#/components/responses/inference.get-200" } }, - "x-state": "Added in 8.11.0" + "x-state": "Added in 8.11.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _inference/sparse_embedding/my-elser-model\n" + } + ] }, "put": { "tags": [ @@ -18662,7 +19466,13 @@ "$ref": "#/components/responses/inference.put-200" } }, - "x-state": "Added in 8.11.0" + "x-state": "Added in 8.11.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _inference/rerank/my-rerank-model\n{\n \"service\": \"cohere\",\n \"service_settings\": {\n \"model_id\": \"rerank-english-v3.0\",\n \"api_key\": \"{{COHERE_API_KEY}}\"\n }\n}" + } + ] }, "post": { "tags": [ @@ -18717,7 +19527,13 @@ "$ref": "#/components/responses/inference.delete-200" } }, - "x-state": "Added in 8.11.0" + "x-state": "Added in 8.11.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE /_inference/sparse_embedding/my-elser-model\n" + } + ] } }, "/_inference": { @@ -18732,7 +19548,13 @@ "$ref": "#/components/responses/inference.get-200" } }, - "x-state": "Added in 8.11.0" + "x-state": "Added in 8.11.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _inference/sparse_embedding/my-elser-model\n" + } + ] } }, "/_inference/{task_type}/{alibabacloud_inference_id}": { @@ -20598,7 +21420,13 @@ "$ref": "#/components/responses/inference.update-200" } }, - "x-state": "Added in 8.17.0" + "x-state": "Added in 8.17.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _inference/my-inference-endpoint/_update\n{\n \"service_settings\": {\n \"api_key\": \"\"\n }\n}" + } + ] } }, "/_inference/{task_type}/{inference_id}/_update": { @@ -20625,7 +21453,13 @@ "$ref": "#/components/responses/inference.update-200" } }, - "x-state": "Added in 8.17.0" + "x-state": "Added in 8.17.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _inference/my-inference-endpoint/_update\n{\n \"service_settings\": {\n \"api_key\": \"\"\n }\n}" + } + ] } }, "/": { @@ -20873,7 +21707,13 @@ "$ref": "#/components/responses/ingest.get_ip_location_database-200" } }, - "x-state": "Added in 8.15.0" + "x-state": "Added in 8.15.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_ingest/ip_location/database/my-database-id\n" + } + ] }, "put": { "tags": [ @@ -20919,6 +21759,12 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ingest._types.DatabaseConfiguration" + }, + "examples": { + "IngestPutIpLocationDatabaseExample1": { + "description": "An example body for a `PUT _ingest/ip_location/database/my-database-1` request.", + "value": "{\n \"name\": \"GeoIP2-Domain\",\n \"maxmind\": {\n \"account_id\": \"1234567\"\n }\n}" + } } } }, @@ -20936,7 +21782,13 @@ } } }, - "x-state": "Added in 8.15.0" + "x-state": "Added in 8.15.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _ingest/ip_location/database/my-database-1\n{\n \"name\": \"GeoIP2-Domain\",\n \"maxmind\": {\n \"account_id\": \"1234567\"\n }\n}" + } + ] }, "delete": { "tags": [ @@ -20989,7 +21841,13 @@ } } }, - "x-state": "Added in 8.15.0" + "x-state": "Added in 8.15.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE /_ingest/ip_location/database/my-database-id\n" + } + ] } }, "/_ingest/pipeline/{id}": { @@ -21019,7 +21877,13 @@ "$ref": "#/components/responses/ingest.get_pipeline-200" } }, - "x-state": "Added in 5.0.0" + "x-state": "Added in 5.0.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_ingest/pipeline/my-pipeline-id\n" + } + ] }, "put": { "tags": [ @@ -21200,7 +22064,13 @@ } } }, - "x-state": "Added in 5.0.0" + "x-state": "Added in 5.0.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE /_ingest/pipeline/my-pipeline-id\n" + } + ] } }, "/_ingest/geoip/stats": { @@ -21242,7 +22112,13 @@ } } }, - "x-state": "Added in 7.13.0" + "x-state": "Added in 7.13.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ingest/geoip/stats\n" + } + ] } }, "/_ingest/geoip/database": { @@ -21278,7 +22154,13 @@ "$ref": "#/components/responses/ingest.get_ip_location_database-200" } }, - "x-state": "Added in 8.15.0" + "x-state": "Added in 8.15.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_ingest/ip_location/database/my-database-id\n" + } + ] } }, "/_ingest/pipeline": { @@ -21305,7 +22187,13 @@ "$ref": "#/components/responses/ingest.get_pipeline-200" } }, - "x-state": "Added in 5.0.0" + "x-state": "Added in 5.0.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_ingest/pipeline/my-pipeline-id\n" + } + ] } }, "/_ingest/processor/grok": { @@ -21342,7 +22230,13 @@ } } }, - "x-state": "Added in 6.1.0" + "x-state": "Added in 6.1.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ingest/processor/grok\n" + } + ] } }, "/_ingest/pipeline/_simulate": { @@ -21639,7 +22533,13 @@ } } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE /_license\n" + } + ] } }, "/_license/basic_status": { @@ -22027,7 +22927,13 @@ } } }, - "x-state": "Added in 7.12.0" + "x-state": "Added in 7.12.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _logstash/pipeline/my_pipeline\n" + } + ] } }, "/_logstash/pipeline": { @@ -22455,7 +23361,13 @@ } } }, - "x-state": "Added in 8.5.0" + "x-state": "Added in 8.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/cache/_clear\n" + } + ] } }, "/_ml/anomaly_detectors/{job_id}/_close": { @@ -22557,7 +23469,13 @@ } } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/anomaly_detectors/low_request_rate/_close\n" + } + ] } }, "/_ml/calendars/{calendar_id}": { @@ -22586,7 +23504,13 @@ "$ref": "#/components/responses/ml.get_calendars-200" } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/calendars/planned-outages\n" + } + ] }, "put": { "tags": [ @@ -22657,7 +23581,13 @@ } } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _ml/calendars/planned-outages\n" + } + ] }, "post": { "tags": [ @@ -22684,7 +23614,13 @@ "$ref": "#/components/responses/ml.get_calendars-200" } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/calendars/planned-outages\n" + } + ] }, "delete": { "tags": [ @@ -22724,7 +23660,13 @@ } } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _ml/calendars/planned-outages\n" + } + ] } }, "/_ml/calendars/{calendar_id}/events/{event_id}": { @@ -22776,7 +23718,13 @@ } } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _ml/calendars/planned-outages/events/LS8LJGEBMTCMA-qz49st\n" + } + ] } }, "/_ml/calendars/{calendar_id}/jobs/{job_id}": { @@ -22838,7 +23786,13 @@ } } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _ml/calendars/planned-outages/jobs/total-requests\n" + } + ] }, "delete": { "tags": [ @@ -22904,7 +23858,13 @@ } } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _ml/calendars/planned-outages/jobs/total-requests\n" + } + ] } }, "/_ml/data_frame/analytics/{id}": { @@ -22937,7 +23897,13 @@ "$ref": "#/components/responses/ml.get_data_frame_analytics-200" } }, - "x-state": "Added in 7.3.0" + "x-state": "Added in 7.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/data_frame/analytics/loganalytics\n" + } + ] }, "put": { "tags": [ @@ -23008,6 +23974,12 @@ "dest", "source" ] + }, + "examples": { + "MlPutDataFrameAnalyticsExample1": { + "description": "An example body for a `PUT _ml/data_frame/analytics/model-flight-delays-pre` request.", + "value": "{\n \"source\": {\n \"index\": [\n \"kibana_sample_data_flights\"\n ],\n \"query\": {\n \"range\": {\n \"DistanceKilometers\": {\n \"gt\": 0\n }\n }\n },\n \"_source\": {\n \"includes\": [],\n \"excludes\": [\n \"FlightDelay\",\n \"FlightDelayType\"\n ]\n }\n },\n \"dest\": {\n \"index\": \"df-flight-delays\",\n \"results_field\": \"ml-results\"\n },\n \"analysis\": {\n \"regression\": {\n \"dependent_variable\": \"FlightDelayMin\",\n \"training_percent\": 90\n }\n },\n \"analyzed_fields\": {\n \"includes\": [],\n \"excludes\": [\n \"FlightNum\"\n ]\n },\n \"model_memory_limit\": \"100mb\"\n}" + } } } }, @@ -23077,7 +24049,13 @@ } } }, - "x-state": "Added in 7.3.0" + "x-state": "Added in 7.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _ml/data_frame/analytics/model-flight-delays-pre\n{\n \"source\": {\n \"index\": [\n \"kibana_sample_data_flights\"\n ],\n \"query\": {\n \"range\": {\n \"DistanceKilometers\": {\n \"gt\": 0\n }\n }\n },\n \"_source\": {\n \"includes\": [],\n \"excludes\": [\n \"FlightDelay\",\n \"FlightDelayType\"\n ]\n }\n },\n \"dest\": {\n \"index\": \"df-flight-delays\",\n \"results_field\": \"ml-results\"\n },\n \"analysis\": {\n \"regression\": {\n \"dependent_variable\": \"FlightDelayMin\",\n \"training_percent\": 90\n }\n },\n \"analyzed_fields\": {\n \"includes\": [],\n \"excludes\": [\n \"FlightNum\"\n ]\n },\n \"model_memory_limit\": \"100mb\"\n}" + } + ] }, "delete": { "tags": [ @@ -23136,7 +24114,13 @@ } } }, - "x-state": "Added in 7.3.0" + "x-state": "Added in 7.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _ml/data_frame/analytics/loganalytics\n" + } + ] } }, "/_ml/datafeeds/{datafeed_id}": { @@ -23163,7 +24147,13 @@ "$ref": "#/components/responses/ml.get_datafeeds-200" } }, - "x-state": "Added in 5.5.0" + "x-state": "Added in 5.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/datafeeds/datafeed-high_sum_total_sales\n" + } + ] }, "put": { "tags": [ @@ -23284,6 +24274,12 @@ "$ref": "#/components/schemas/_types.HttpHeaders" } } + }, + "examples": { + "MlPutDatafeedExample1": { + "description": "An example body for a `PUT _ml/datafeeds/datafeed-test-job?pretty` request.", + "value": "{\n \"indices\": [\n \"kibana_sample_data_logs\"\n ],\n \"query\": {\n \"bool\": {\n \"must\": [\n {\n \"match_all\": {}\n }\n ]\n }\n },\n \"job_id\": \"test-job\"\n}" + } } } }, @@ -23366,7 +24362,13 @@ } } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _ml/datafeeds/datafeed-test-job?pretty\n{\n \"indices\": [\n \"kibana_sample_data_logs\"\n ],\n \"query\": {\n \"bool\": {\n \"must\": [\n {\n \"match_all\": {}\n }\n ]\n }\n },\n \"job_id\": \"test-job\"\n}" + } + ] }, "delete": { "tags": [ @@ -23415,7 +24417,13 @@ } } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _ml/datafeeds/datafeed-total-requests\n" + } + ] } }, "/_ml/_delete_expired_data/{job_id}": { @@ -23445,7 +24453,13 @@ "$ref": "#/components/responses/ml.delete_expired_data-200" } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _ml/_delete_expired_data?timeout=1h\n" + } + ] } }, "/_ml/_delete_expired_data": { @@ -23472,7 +24486,13 @@ "$ref": "#/components/responses/ml.delete_expired_data-200" } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _ml/_delete_expired_data?timeout=1h\n" + } + ] } }, "/_ml/filters/{filter_id}": { @@ -23499,7 +24519,13 @@ "$ref": "#/components/responses/ml.get_filters-200" } }, - "x-state": "Added in 5.5.0" + "x-state": "Added in 5.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/filters/safe_domains\n" + } + ] }, "put": { "tags": [ @@ -23539,6 +24565,12 @@ } } } + }, + "examples": { + "MlPutFilterExample1": { + "description": "An example body for a `PUT _ml/filters/safe_domains` request.", + "value": "{\n \"description\": \"A list of safe domains\",\n \"items\": [\"*.google.com\", \"wikipedia.org\"]\n}" + } } } }, @@ -23575,7 +24607,13 @@ } } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _ml/filters/safe_domains\n{\n \"description\": \"A list of safe domains\",\n \"items\": [\"*.google.com\", \"wikipedia.org\"]\n}" + } + ] }, "delete": { "tags": [ @@ -23615,7 +24653,13 @@ } } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _ml/filters/safe_domains\n" + } + ] } }, "/_ml/anomaly_detectors/{job_id}/_forecast": { @@ -23686,6 +24730,12 @@ "type": "string" } } + }, + "examples": { + "MlForecastExample1": { + "description": "An example body for a `POST _ml/anomaly_detectors/low_request_rate/_forecast` request.", + "value": "{\n \"duration\": \"10d\"\n}" + } } } } @@ -23714,7 +24764,13 @@ } } }, - "x-state": "Added in 6.1.0" + "x-state": "Added in 6.1.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/anomaly_detectors/low_request_rate/_forecast\n{\n \"duration\": \"10d\"\n}" + } + ] }, "delete": { "tags": [ @@ -23739,7 +24795,13 @@ "$ref": "#/components/responses/ml.delete_forecast-200" } }, - "x-state": "Added in 6.5.0" + "x-state": "Added in 6.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _ml/anomaly_detectors/total-requests/_forecast/_all\n" + } + ] } }, "/_ml/anomaly_detectors/{job_id}/_forecast/{forecast_id}": { @@ -23769,7 +24831,13 @@ "$ref": "#/components/responses/ml.delete_forecast-200" } }, - "x-state": "Added in 6.5.0" + "x-state": "Added in 6.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _ml/anomaly_detectors/total-requests/_forecast/_all\n" + } + ] } }, "/_ml/anomaly_detectors/{job_id}": { @@ -23796,7 +24864,13 @@ "$ref": "#/components/responses/ml.get_jobs-200" } }, - "x-state": "Added in 5.5.0" + "x-state": "Added in 5.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/high_sum_total_sales\n" + } + ] }, "put": { "tags": [ @@ -24110,7 +25184,13 @@ } } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _ml/anomaly_detectors/total-requests\n" + } + ] } }, "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}": { @@ -24154,7 +25234,13 @@ "$ref": "#/components/responses/ml.get_model_snapshots-200" } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/high_sum_total_sales/model_snapshots\n{\n \"start\": \"1575402236000\"\n}" + } + ] }, "post": { "tags": [ @@ -24196,7 +25282,13 @@ "$ref": "#/components/responses/ml.get_model_snapshots-200" } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/high_sum_total_sales/model_snapshots\n{\n \"start\": \"1575402236000\"\n}" + } + ] }, "delete": { "tags": [ @@ -24247,7 +25339,13 @@ } } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _ml/anomaly_detectors/farequote/model_snapshots/1491948163\n" + } + ] } }, "/_ml/trained_models/{model_id}": { @@ -24288,7 +25386,13 @@ "$ref": "#/components/responses/ml.get_trained_models-200" } }, - "x-state": "Added in 7.10.0" + "x-state": "Added in 7.10.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/trained_models/\n" + } + ] }, "put": { "tags": [ @@ -24456,7 +25560,13 @@ } } }, - "x-state": "Added in 7.10.0" + "x-state": "Added in 7.10.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _ml/trained_models/regression-job-one-1574775307356\n" + } + ] } }, "/_ml/trained_models/{model_id}/model_aliases/{model_alias}": { @@ -24513,7 +25623,13 @@ } } }, - "x-state": "Added in 7.13.0" + "x-state": "Added in 7.13.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _ml/trained_models/flight-delay-prediction-1574775339910/model_aliases/flight_delay_model\n" + } + ] }, "delete": { "tags": [ @@ -24564,7 +25680,13 @@ } } }, - "x-state": "Added in 7.13.0" + "x-state": "Added in 7.13.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _ml/trained_models/flight-delay-prediction-1574775339910/model_aliases/flight_delay_model\n" + } + ] } }, "/_ml/anomaly_detectors/_estimate_model_memory": { @@ -24954,6 +26076,12 @@ "$ref": "#/components/schemas/_types.DateTime" } } + }, + "examples": { + "MlFlushJobExample1": { + "description": "An example body for a `POST _ml/anomaly_detectors/low_request_rate/_flush` request.", + "value": "{\n \"calc_interim\": true\n}" + } } } } @@ -24982,7 +26110,13 @@ } } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/anomaly_detectors/low_request_rate/_flush\n{\n \"calc_interim\": true\n}" + } + ] } }, "/_ml/anomaly_detectors/{job_id}/results/buckets/{timestamp}": { @@ -25036,7 +26170,13 @@ "$ref": "#/components/responses/ml.get_buckets-200" } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/low_request_rate/results/buckets\n{\n \"anomaly_score\": 80,\n \"start\": \"1454530200001\"\n}" + } + ] }, "post": { "tags": [ @@ -25088,7 +26228,13 @@ "$ref": "#/components/responses/ml.get_buckets-200" } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/low_request_rate/results/buckets\n{\n \"anomaly_score\": 80,\n \"start\": \"1454530200001\"\n}" + } + ] } }, "/_ml/anomaly_detectors/{job_id}/results/buckets": { @@ -25139,7 +26285,13 @@ "$ref": "#/components/responses/ml.get_buckets-200" } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/low_request_rate/results/buckets\n{\n \"anomaly_score\": 80,\n \"start\": \"1454530200001\"\n}" + } + ] }, "post": { "tags": [ @@ -25188,7 +26340,13 @@ "$ref": "#/components/responses/ml.get_buckets-200" } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/low_request_rate/results/buckets\n{\n \"anomaly_score\": 80,\n \"start\": \"1454530200001\"\n}" + } + ] } }, "/_ml/calendars/{calendar_id}/events": { @@ -25288,7 +26446,13 @@ } } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/calendars/planned-outages/events\n" + } + ] }, "post": { "tags": [ @@ -25326,6 +26490,12 @@ "required": [ "events" ] + }, + "examples": { + "MlPostCalendarEventsExample1": { + "description": "An example body for a `POST _ml/calendars/planned-outages/events` request.", + "value": "{\n \"events\" : [\n {\"description\": \"event 1\", \"start_time\": 1513641600000, \"end_time\": 1513728000000},\n {\"description\": \"event 2\", \"start_time\": 1513814400000, \"end_time\": 1513900800000},\n {\"description\": \"event 3\", \"start_time\": 1514160000000, \"end_time\": 1514246400000}\n ]\n}" + } } } }, @@ -25354,7 +26524,13 @@ } } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/calendars/planned-outages/events\n{\n \"events\" : [\n {\"description\": \"event 1\", \"start_time\": 1513641600000, \"end_time\": 1513728000000},\n {\"description\": \"event 2\", \"start_time\": 1513814400000, \"end_time\": 1513900800000},\n {\"description\": \"event 3\", \"start_time\": 1514160000000, \"end_time\": 1514246400000}\n ]\n}" + } + ] } }, "/_ml/calendars": { @@ -25380,7 +26556,13 @@ "$ref": "#/components/responses/ml.get_calendars-200" } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/calendars/planned-outages\n" + } + ] }, "post": { "tags": [ @@ -25404,7 +26586,13 @@ "$ref": "#/components/responses/ml.get_calendars-200" } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/calendars/planned-outages\n" + } + ] } }, "/_ml/anomaly_detectors/{job_id}/results/categories/{category_id}": { @@ -25439,7 +26627,13 @@ "$ref": "#/components/responses/ml.get_categories-200" } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/esxi_log/results/categories\n{\n \"page\":{\n \"size\": 1\n }\n}" + } + ] }, "post": { "tags": [ @@ -25472,7 +26666,13 @@ "$ref": "#/components/responses/ml.get_categories-200" } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/esxi_log/results/categories\n{\n \"page\":{\n \"size\": 1\n }\n}" + } + ] } }, "/_ml/anomaly_detectors/{job_id}/results/categories": { @@ -25504,7 +26704,13 @@ "$ref": "#/components/responses/ml.get_categories-200" } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/esxi_log/results/categories\n{\n \"page\":{\n \"size\": 1\n }\n}" + } + ] }, "post": { "tags": [ @@ -25534,7 +26740,13 @@ "$ref": "#/components/responses/ml.get_categories-200" } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/esxi_log/results/categories\n{\n \"page\":{\n \"size\": 1\n }\n}" + } + ] } }, "/_ml/data_frame/analytics": { @@ -25564,7 +26776,13 @@ "$ref": "#/components/responses/ml.get_data_frame_analytics-200" } }, - "x-state": "Added in 7.3.0" + "x-state": "Added in 7.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/data_frame/analytics/loganalytics\n" + } + ] } }, "/_ml/data_frame/analytics/_stats": { @@ -25593,7 +26811,13 @@ "$ref": "#/components/responses/ml.get_data_frame_analytics_stats-200" } }, - "x-state": "Added in 7.3.0" + "x-state": "Added in 7.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/data_frame/analytics/weblog-outliers/_stats\n" + } + ] } }, "/_ml/data_frame/analytics/{id}/_stats": { @@ -25625,7 +26849,13 @@ "$ref": "#/components/responses/ml.get_data_frame_analytics_stats-200" } }, - "x-state": "Added in 7.3.0" + "x-state": "Added in 7.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/data_frame/analytics/weblog-outliers/_stats\n" + } + ] } }, "/_ml/datafeeds/{datafeed_id}/_stats": { @@ -25649,7 +26879,13 @@ "$ref": "#/components/responses/ml.get_datafeed_stats-200" } }, - "x-state": "Added in 5.5.0" + "x-state": "Added in 5.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/datafeeds/datafeed-high_sum_total_sales/_stats\n" + } + ] } }, "/_ml/datafeeds/_stats": { @@ -25670,7 +26906,13 @@ "$ref": "#/components/responses/ml.get_datafeed_stats-200" } }, - "x-state": "Added in 5.5.0" + "x-state": "Added in 5.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/datafeeds/datafeed-high_sum_total_sales/_stats\n" + } + ] } }, "/_ml/datafeeds": { @@ -25694,7 +26936,13 @@ "$ref": "#/components/responses/ml.get_datafeeds-200" } }, - "x-state": "Added in 5.5.0" + "x-state": "Added in 5.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/datafeeds/datafeed-high_sum_total_sales\n" + } + ] } }, "/_ml/filters": { @@ -25718,7 +26966,13 @@ "$ref": "#/components/responses/ml.get_filters-200" } }, - "x-state": "Added in 5.5.0" + "x-state": "Added in 5.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/filters/safe_domains\n" + } + ] } }, "/_ml/anomaly_detectors/{job_id}/results/influencers": { @@ -25766,7 +27020,13 @@ "$ref": "#/components/responses/ml.get_influencers-200" } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/high_sum_total_sales/results/influencers\n{\n \"sort\": \"influencer_score\",\n \"desc\": true\n}" + } + ] }, "post": { "tags": [ @@ -25812,7 +27072,13 @@ "$ref": "#/components/responses/ml.get_influencers-200" } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/high_sum_total_sales/results/influencers\n{\n \"sort\": \"influencer_score\",\n \"desc\": true\n}" + } + ] } }, "/_ml/anomaly_detectors/_stats": { @@ -25832,7 +27098,13 @@ "$ref": "#/components/responses/ml.get_job_stats-200" } }, - "x-state": "Added in 5.5.0" + "x-state": "Added in 5.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/low_request_rate/_stats\n" + } + ] } }, "/_ml/anomaly_detectors/{job_id}/_stats": { @@ -25855,7 +27127,13 @@ "$ref": "#/components/responses/ml.get_job_stats-200" } }, - "x-state": "Added in 5.5.0" + "x-state": "Added in 5.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/low_request_rate/_stats\n" + } + ] } }, "/_ml/anomaly_detectors": { @@ -25879,7 +27157,13 @@ "$ref": "#/components/responses/ml.get_jobs-200" } }, - "x-state": "Added in 5.5.0" + "x-state": "Added in 5.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/high_sum_total_sales\n" + } + ] } }, "/_ml/memory/_stats": { @@ -25903,7 +27187,13 @@ "$ref": "#/components/responses/ml.get_memory_stats-200" } }, - "x-state": "Added in 8.2.0" + "x-state": "Added in 8.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/memory/_stats?human\n" + } + ] } }, "/_ml/memory/{node_id}/_stats": { @@ -25930,7 +27220,13 @@ "$ref": "#/components/responses/ml.get_memory_stats-200" } }, - "x-state": "Added in 8.2.0" + "x-state": "Added in 8.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/memory/_stats?human\n" + } + ] } }, "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade/_stats": { @@ -26001,7 +27297,13 @@ } } }, - "x-state": "Added in 7.16.0" + "x-state": "Added in 7.16.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/low_request_rate/model_snapshots/_all/_upgrade/_stats\n" + } + ] } }, "/_ml/anomaly_detectors/{job_id}/model_snapshots": { @@ -26042,7 +27344,13 @@ "$ref": "#/components/responses/ml.get_model_snapshots-200" } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/high_sum_total_sales/model_snapshots\n{\n \"start\": \"1575402236000\"\n}" + } + ] }, "post": { "tags": [ @@ -26081,7 +27389,13 @@ "$ref": "#/components/responses/ml.get_model_snapshots-200" } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/high_sum_total_sales/model_snapshots\n{\n \"start\": \"1575402236000\"\n}" + } + ] } }, "/_ml/anomaly_detectors/{job_id}/results/overall_buckets": { @@ -26126,7 +27440,13 @@ "$ref": "#/components/responses/ml.get_overall_buckets-200" } }, - "x-state": "Added in 6.1.0" + "x-state": "Added in 6.1.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/job-*/results/overall_buckets\n{\n \"overall_score\": 80,\n \"start\": \"1403532000000\"\n}" + } + ] }, "post": { "tags": [ @@ -26169,7 +27489,13 @@ "$ref": "#/components/responses/ml.get_overall_buckets-200" } }, - "x-state": "Added in 6.1.0" + "x-state": "Added in 6.1.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/job-*/results/overall_buckets\n{\n \"overall_score\": 80,\n \"start\": \"1403532000000\"\n}" + } + ] } }, "/_ml/anomaly_detectors/{job_id}/results/records": { @@ -26217,7 +27543,13 @@ "$ref": "#/components/responses/ml.get_records-200" } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/low_request_rate/results/records\n{\n \"sort\": \"record_score\",\n \"desc\": true,\n \"start\": \"1454944100000\"\n}" + } + ] }, "post": { "tags": [ @@ -26263,7 +27595,13 @@ "$ref": "#/components/responses/ml.get_records-200" } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/low_request_rate/results/records\n{\n \"sort\": \"record_score\",\n \"desc\": true,\n \"start\": \"1454944100000\"\n}" + } + ] } }, "/_ml/trained_models": { @@ -26301,7 +27639,13 @@ "$ref": "#/components/responses/ml.get_trained_models-200" } }, - "x-state": "Added in 7.10.0" + "x-state": "Added in 7.10.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/trained_models/\n" + } + ] } }, "/_ml/trained_models/{model_id}/_stats": { @@ -26331,7 +27675,13 @@ "$ref": "#/components/responses/ml.get_trained_models_stats-200" } }, - "x-state": "Added in 7.10.0" + "x-state": "Added in 7.10.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/trained_models/_stats\n" + } + ] } }, "/_ml/trained_models/_stats": { @@ -26358,7 +27708,13 @@ "$ref": "#/components/responses/ml.get_trained_models_stats-200" } }, - "x-state": "Added in 7.10.0" + "x-state": "Added in 7.10.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/trained_models/_stats\n" + } + ] } }, "/_ml/trained_models/{model_id}/_infer": { @@ -26414,6 +27770,12 @@ "required": [ "docs" ] + }, + "examples": { + "MlInferTrainedModelExample1": { + "description": "An example body for a `POST _ml/trained_models/lang_ident_model_1/_infer` request.", + "value": "{\n \"docs\":[{\"text\": \"The fool doth think he is wise, but the wise man knows himself to be a fool.\"}]\n}" + } } } }, @@ -26442,7 +27804,13 @@ } } }, - "x-state": "Added in 8.3.0" + "x-state": "Added in 8.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/trained_models/lang_ident_model_1/_infer\n{\n \"docs\":[{\"text\": \"The fool doth think he is wise, but the wise man knows himself to be a fool.\"}]\n}" + } + ] } }, "/_ml/info": { @@ -26485,7 +27853,13 @@ } } }, - "x-state": "Added in 6.3.0" + "x-state": "Added in 6.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/info\n" + } + ] } }, "/_ml/anomaly_detectors/{job_id}/_open": { @@ -26728,7 +28102,13 @@ "$ref": "#/components/responses/ml.preview_data_frame_analytics-200" } }, - "x-state": "Added in 7.13.0" + "x-state": "Added in 7.13.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/data_frame/analytics/_preview\n{\n \"config\": {\n \"source\": {\n \"index\": \"houses_sold_last_10_yrs\"\n },\n \"analysis\": {\n \"regression\": {\n \"dependent_variable\": \"price\"\n }\n }\n }\n}" + } + ] }, "post": { "tags": [ @@ -26745,7 +28125,13 @@ "$ref": "#/components/responses/ml.preview_data_frame_analytics-200" } }, - "x-state": "Added in 7.13.0" + "x-state": "Added in 7.13.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/data_frame/analytics/_preview\n{\n \"config\": {\n \"source\": {\n \"index\": \"houses_sold_last_10_yrs\"\n },\n \"analysis\": {\n \"regression\": {\n \"dependent_variable\": \"price\"\n }\n }\n }\n}" + } + ] } }, "/_ml/data_frame/analytics/{id}/_preview": { @@ -26769,7 +28155,13 @@ "$ref": "#/components/responses/ml.preview_data_frame_analytics-200" } }, - "x-state": "Added in 7.13.0" + "x-state": "Added in 7.13.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/data_frame/analytics/_preview\n{\n \"config\": {\n \"source\": {\n \"index\": \"houses_sold_last_10_yrs\"\n },\n \"analysis\": {\n \"regression\": {\n \"dependent_variable\": \"price\"\n }\n }\n }\n}" + } + ] }, "post": { "tags": [ @@ -26791,7 +28183,13 @@ "$ref": "#/components/responses/ml.preview_data_frame_analytics-200" } }, - "x-state": "Added in 7.13.0" + "x-state": "Added in 7.13.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/data_frame/analytics/_preview\n{\n \"config\": {\n \"source\": {\n \"index\": \"houses_sold_last_10_yrs\"\n },\n \"analysis\": {\n \"regression\": {\n \"dependent_variable\": \"price\"\n }\n }\n }\n}" + } + ] } }, "/_ml/datafeeds/{datafeed_id}/_preview": { @@ -26821,7 +28219,13 @@ "$ref": "#/components/responses/ml.preview_datafeed-200" } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/datafeeds/datafeed-high_sum_total_sales/_preview\n" + } + ] }, "post": { "tags": [ @@ -26849,7 +28253,13 @@ "$ref": "#/components/responses/ml.preview_datafeed-200" } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/datafeeds/datafeed-high_sum_total_sales/_preview\n" + } + ] } }, "/_ml/datafeeds/_preview": { @@ -26876,7 +28286,13 @@ "$ref": "#/components/responses/ml.preview_datafeed-200" } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/datafeeds/datafeed-high_sum_total_sales/_preview\n" + } + ] }, "post": { "tags": [ @@ -26901,7 +28317,13 @@ "$ref": "#/components/responses/ml.preview_datafeed-200" } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/datafeeds/datafeed-high_sum_total_sales/_preview\n" + } + ] } }, "/_ml/trained_models/{model_id}/definition/{part}": { @@ -26959,6 +28381,12 @@ "total_definition_length", "total_parts" ] + }, + "examples": { + "MlPutTrainedModelDefinitionPartExample1": { + "description": "An example body for a `PUT _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/definition/0` request.", + "value": "{\n \"definition\": \"...\",\n \"total_definition_length\": 265632637,\n \"total_parts\": 64\n}" + } } } }, @@ -26976,7 +28404,13 @@ } } }, - "x-state": "Added in 8.0.0" + "x-state": "Added in 8.0.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/definition/0\n{\n \"definition\": \"...\",\n \"total_definition_length\": 265632637,\n \"total_parts\": 64\n}" + } + ] } }, "/_ml/trained_models/{model_id}/vocabulary": { @@ -27031,6 +28465,12 @@ "required": [ "vocabulary" ] + }, + "examples": { + "MlPutTrainedModelVocabularyExample1": { + "description": "An example body for a `PUT _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/vocabulary` request.", + "value": "{\n \"vocabulary\": [\n \"[PAD]\",\n \"[unused0]\",\n ...\n ]\n}" + } } } }, @@ -27048,7 +28488,13 @@ } } }, - "x-state": "Added in 8.0.0" + "x-state": "Added in 8.0.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/vocabulary\n{\n \"vocabulary\": [\n \"[PAD]\",\n \"[unused0]\",\n ...\n ]\n}" + } + ] } }, "/_ml/anomaly_detectors/{job_id}/_reset": { @@ -27104,7 +28550,13 @@ } } }, - "x-state": "Added in 7.14.0" + "x-state": "Added in 7.14.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/anomaly_detectors/total-requests/_reset\n" + } + ] } }, "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_revert": { @@ -27160,6 +28612,12 @@ "type": "boolean" } } + }, + "examples": { + "MlRevertModelSnapshotExample1": { + "description": "An example body for a `POST _ml/anomaly_detectors/low_request_rate/model_snapshots/1637092688/_revert` request.", + "value": "{\n \"delete_intervening_results\": true\n}" + } } } } @@ -27184,7 +28642,13 @@ } } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/anomaly_detectors/low_request_rate/model_snapshots/1637092688/_revert\n{\n \"delete_intervening_results\": true\n}" + } + ] } }, "/_ml/set_upgrade_mode": { @@ -27229,7 +28693,13 @@ } } }, - "x-state": "Added in 6.7.0" + "x-state": "Added in 6.7.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/set_upgrade_mode?enabled=true\n" + } + ] } }, "/_ml/data_frame/analytics/{id}/_start": { @@ -27287,7 +28757,13 @@ } } }, - "x-state": "Added in 7.3.0" + "x-state": "Added in 7.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/data_frame/analytics/loganalytics/_start\n" + } + ] } }, "/_ml/datafeeds/{datafeed_id}/_start": { @@ -27357,6 +28833,12 @@ "$ref": "#/components/schemas/_types.Duration" } } + }, + "examples": { + "MlStartDatafeedExample1": { + "description": "An example body for a `POST _ml/datafeeds/datafeed-low_request_rate/_start` request.", + "value": "{\n \"start\": \"2019-04-07T18:22:16Z\"\n}" + } } } } @@ -27386,7 +28868,13 @@ } } }, - "x-state": "Added in 5.5.0" + "x-state": "Added in 5.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/datafeeds/datafeed-low_request_rate/_start\n{\n \"start\": \"2019-04-07T18:22:16Z\"\n}" + } + ] } }, "/_ml/trained_models/{model_id}/deployment/_start": { @@ -27524,7 +29012,13 @@ } } }, - "x-state": "Added in 8.0.0" + "x-state": "Added in 8.0.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/_start?wait_for=started&timeout=1m\n" + } + ] } }, "/_ml/data_frame/analytics/{id}/_stop": { @@ -27598,7 +29092,13 @@ } } }, - "x-state": "Added in 7.3.0" + "x-state": "Added in 7.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/data_frame/analytics/loganalytics/_stop\n" + } + ] } }, "/_ml/datafeeds/{datafeed_id}/_stop": { @@ -27670,6 +29170,12 @@ "$ref": "#/components/schemas/_types.Duration" } } + }, + "examples": { + "MlStopDatafeedExample1": { + "description": "An example body for a `POST _ml/datafeeds/datafeed-low_request_rate/_stop` request.", + "value": "{\n \"timeout\": \"30s\"\n}" + } } } } @@ -27694,7 +29200,13 @@ } } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/datafeeds/datafeed-low_request_rate/_stop\n{\n \"timeout\": \"30s\"\n}" + } + ] } }, "/_ml/trained_models/{model_id}/deployment/_stop": { @@ -27757,7 +29269,13 @@ } } }, - "x-state": "Added in 8.0.0" + "x-state": "Added in 8.0.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/trained_models/my_model_for_search/deployment/_stop\n" + } + ] } }, "/_ml/data_frame/analytics/{id}/_update": { @@ -27803,6 +29321,12 @@ "type": "boolean" } } + }, + "examples": { + "MlUpdateDataFrameAnalyticsExample1": { + "description": "An example body for a `POST _ml/data_frame/analytics/loganalytics/_update` request.", + "value": "{\n \"model_memory_limit\": \"200mb\"\n}" + } } } }, @@ -27869,7 +29393,13 @@ } } }, - "x-state": "Added in 7.3.0" + "x-state": "Added in 7.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/data_frame/analytics/loganalytics/_update\n{\n \"model_memory_limit\": \"200mb\"\n}" + } + ] } }, "/_ml/datafeeds/{datafeed_id}/_update": { @@ -27993,6 +29523,12 @@ "type": "number" } } + }, + "examples": { + "MlUpdateDatafeedExample1": { + "description": "An example body for a `POST _ml/datafeeds/datafeed-test-job/_update` request.", + "value": "{\n \"query\": {\n \"term\": {\n \"geo.src\": \"US\"\n }\n }\n}" + } } } }, @@ -28075,7 +29611,13 @@ } } }, - "x-state": "Added in 6.4.0" + "x-state": "Added in 6.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/datafeeds/datafeed-test-job/_update\n{\n \"query\": {\n \"term\": {\n \"geo.src\": \"US\"\n }\n }\n}" + } + ] } }, "/_ml/filters/{filter_id}/_update": { @@ -28124,6 +29666,12 @@ } } } + }, + "examples": { + "MlUpdateFilterExample1": { + "description": "An example body for a `POST _ml/filters/safe_domains/_update` request.", + "value": "{\n \"description\": \"Updated list of domains\",\n \"add_items\": [\"*.myorg.com\"],\n \"remove_items\": [\"wikipedia.org\"]\n}" + } } } }, @@ -28160,7 +29708,13 @@ } } }, - "x-state": "Added in 6.4.0" + "x-state": "Added in 6.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/filters/safe_domains/_update\n{\n \"description\": \"Updated list of domains\",\n \"add_items\": [\"*.myorg.com\"],\n \"remove_items\": [\"wikipedia.org\"]\n}" + } + ] } }, "/_ml/anomaly_detectors/{job_id}/_update": { @@ -28257,6 +29811,12 @@ "$ref": "#/components/schemas/ml._types.PerPartitionCategorization" } } + }, + "examples": { + "MlUpdateJobExample1": { + "description": "An example body for a `POST _ml/anomaly_detectors/low_request_rate/_update` request.", + "value": "{\n \"description\":\"An updated job\",\n \"detectors\": {\n \"detector_index\": 0,\n \"description\": \"An updated detector description\"\n },\n \"groups\": [\"kibana_sample_data\",\"kibana_sample_web_logs\"],\n \"model_plot_config\": {\n \"enabled\": true\n },\n \"renormalization_window_days\": 30,\n \"background_persist_interval\": \"2h\",\n \"model_snapshot_retention_days\": 7,\n \"results_retention_days\": 60\n}" + } } } }, @@ -28358,7 +29918,13 @@ } } }, - "x-state": "Added in 5.5.0" + "x-state": "Added in 5.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/anomaly_detectors/low_request_rate/_update\n{\n \"description\":\"An updated job\",\n \"detectors\": {\n \"detector_index\": 0,\n \"description\": \"An updated detector description\"\n },\n \"groups\": [\"kibana_sample_data\",\"kibana_sample_web_logs\"],\n \"model_plot_config\": {\n \"enabled\": true\n },\n \"renormalization_window_days\": 30,\n \"background_persist_interval\": \"2h\",\n \"model_snapshot_retention_days\": 7,\n \"results_retention_days\": 60\n}" + } + ] } }, "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_update": { @@ -28408,6 +29974,12 @@ "type": "boolean" } } + }, + "examples": { + "MlUpdateModelSnapshotExample1": { + "description": "An example body for a `POST` request.", + "value": "_ml/anomaly_detectors/it_ops_new_logs/model_snapshots/1491852978/_update\n{\n \"description\": \"Snapshot 1\",\n \"retain\": true\n}" + } } } }, @@ -28437,7 +30009,13 @@ } } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST\n_ml/anomaly_detectors/it_ops_new_logs/model_snapshots/1491852978/_update\n{\n \"description\": \"Snapshot 1\",\n \"retain\": true\n}" + } + ] } }, "/_ml/trained_models/{model_id}/deployment/_update": { @@ -28484,6 +30062,12 @@ "$ref": "#/components/schemas/ml._types.AdaptiveAllocationsSettings" } } + }, + "examples": { + "MlUpdateTrainedModelDeploymentExample1": { + "description": "An example body for a `POST _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/_update` request.", + "value": "{\n \"number_of_allocations\": 4\n}" + } } } } @@ -28509,7 +30093,13 @@ } }, "x-beta": true, - "x-state": "Added in 8.6.0" + "x-state": "Added in 8.6.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/_update\n{\n \"number_of_allocations\": 4\n}" + } + ] } }, "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade": { @@ -28589,7 +30179,13 @@ } } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/anomaly_detectors/low_request_rate/model_snapshots/1828371/_upgrade?timeout=45m&wait_for_completion=true\n" + } + ] } }, "/_msearch": { @@ -28649,7 +30245,13 @@ "$ref": "#/components/responses/msearch-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET my-index-000001/_msearch\n{ }\n{\"query\" : {\"match\" : { \"message\": \"this is a test\"}}}\n{\"index\": \"my-index-000002\"}\n{\"query\" : {\"match_all\" : {}}}" + } + ] }, "post": { "tags": [ @@ -28707,7 +30309,13 @@ "$ref": "#/components/responses/msearch-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET my-index-000001/_msearch\n{ }\n{\"query\" : {\"match\" : { \"message\": \"this is a test\"}}}\n{\"index\": \"my-index-000002\"}\n{\"query\" : {\"match_all\" : {}}}" + } + ] } }, "/{index}/_msearch": { @@ -28770,7 +30378,13 @@ "$ref": "#/components/responses/msearch-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET my-index-000001/_msearch\n{ }\n{\"query\" : {\"match\" : { \"message\": \"this is a test\"}}}\n{\"index\": \"my-index-000002\"}\n{\"query\" : {\"match_all\" : {}}}" + } + ] }, "post": { "tags": [ @@ -28831,7 +30445,13 @@ "$ref": "#/components/responses/msearch-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET my-index-000001/_msearch\n{ }\n{\"query\" : {\"match\" : { \"message\": \"this is a test\"}}}\n{\"index\": \"my-index-000002\"}\n{\"query\" : {\"match_all\" : {}}}" + } + ] } }, "/_msearch/template": { @@ -29384,7 +31004,13 @@ "200": { "$ref": "#/components/responses/nodes.hot_threads-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_nodes/hot_threads\n" + } + ] } }, "/_nodes/{node_id}/hot_threads": { @@ -29425,7 +31051,13 @@ "200": { "$ref": "#/components/responses/nodes.hot_threads-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_nodes/hot_threads\n" + } + ] } }, "/_nodes": { @@ -29449,7 +31081,13 @@ "$ref": "#/components/responses/nodes.info-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _nodes/_all/jvm\n" + } + ] } }, "/_nodes/{node_id}": { @@ -29476,7 +31114,13 @@ "$ref": "#/components/responses/nodes.info-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _nodes/_all/jvm\n" + } + ] } }, "/_nodes/{metric}": { @@ -29503,7 +31147,13 @@ "$ref": "#/components/responses/nodes.info-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _nodes/_all/jvm\n" + } + ] } }, "/_nodes/{node_id}/{metric}": { @@ -29533,7 +31183,13 @@ "$ref": "#/components/responses/nodes.info-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _nodes/_all/jvm\n" + } + ] } }, "/_nodes/reload_secure_settings": { @@ -29640,7 +31296,13 @@ "200": { "$ref": "#/components/responses/nodes.stats-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _nodes/stats/process?filter_path=**.max_file_descriptors\n" + } + ] } }, "/_nodes/{node_id}/stats": { @@ -29687,7 +31349,13 @@ "200": { "$ref": "#/components/responses/nodes.stats-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _nodes/stats/process?filter_path=**.max_file_descriptors\n" + } + ] } }, "/_nodes/stats/{metric}": { @@ -29734,7 +31402,13 @@ "200": { "$ref": "#/components/responses/nodes.stats-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _nodes/stats/process?filter_path=**.max_file_descriptors\n" + } + ] } }, "/_nodes/{node_id}/stats/{metric}": { @@ -29784,7 +31458,13 @@ "200": { "$ref": "#/components/responses/nodes.stats-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _nodes/stats/process?filter_path=**.max_file_descriptors\n" + } + ] } }, "/_nodes/stats/{metric}/{index_metric}": { @@ -29834,7 +31514,13 @@ "200": { "$ref": "#/components/responses/nodes.stats-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _nodes/stats/process?filter_path=**.max_file_descriptors\n" + } + ] } }, "/_nodes/{node_id}/stats/{metric}/{index_metric}": { @@ -29887,7 +31573,13 @@ "200": { "$ref": "#/components/responses/nodes.stats-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _nodes/stats/process?filter_path=**.max_file_descriptors\n" + } + ] } }, "/_nodes/usage": { @@ -29907,7 +31599,13 @@ "$ref": "#/components/responses/nodes.usage-200" } }, - "x-state": "Added in 6.0.0" + "x-state": "Added in 6.0.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _nodes/usage\n" + } + ] } }, "/_nodes/{node_id}/usage": { @@ -29930,7 +31628,13 @@ "$ref": "#/components/responses/nodes.usage-200" } }, - "x-state": "Added in 6.0.0" + "x-state": "Added in 6.0.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _nodes/usage\n" + } + ] } }, "/_nodes/usage/{metric}": { @@ -29953,7 +31657,13 @@ "$ref": "#/components/responses/nodes.usage-200" } }, - "x-state": "Added in 6.0.0" + "x-state": "Added in 6.0.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _nodes/usage\n" + } + ] } }, "/_nodes/{node_id}/usage/{metric}": { @@ -29979,7 +31689,13 @@ "$ref": "#/components/responses/nodes.usage-200" } }, - "x-state": "Added in 6.0.0" + "x-state": "Added in 6.0.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _nodes/usage\n" + } + ] } }, "/{index}/_pit": { @@ -30422,7 +32138,13 @@ } } }, - "x-state": "Added in 8.15.0" + "x-state": "Added in 8.15.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _query_rules/my-ruleset/_rule/my-rule1\n" + } + ] } }, "/_query_rules/{ruleset_id}": { @@ -30589,7 +32311,13 @@ } } }, - "x-state": "Added in 8.10.0" + "x-state": "Added in 8.10.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _query_rules/my-ruleset/\n" + } + ] } }, "/_query_rules": { @@ -30785,7 +32513,13 @@ "$ref": "#/components/responses/rank_eval-200" } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /my-index-000001/_rank_eval\n{\n \"requests\": [\n {\n \"id\": \"JFK query\",\n \"request\": { \"query\": { \"match_all\": {} } },\n \"ratings\": []\n } ],\n \"metric\": {\n \"precision\": {\n \"k\": 20,\n \"relevant_rating_threshold\": 1,\n \"ignore_unlabeled\": false\n }\n }\n}" + } + ] }, "post": { "tags": [ @@ -30816,7 +32550,13 @@ "$ref": "#/components/responses/rank_eval-200" } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /my-index-000001/_rank_eval\n{\n \"requests\": [\n {\n \"id\": \"JFK query\",\n \"request\": { \"query\": { \"match_all\": {} } },\n \"ratings\": []\n } ],\n \"metric\": {\n \"precision\": {\n \"k\": 20,\n \"relevant_rating_threshold\": 1,\n \"ignore_unlabeled\": false\n }\n }\n}" + } + ] } }, "/{index}/_rank_eval": { @@ -30852,7 +32592,13 @@ "$ref": "#/components/responses/rank_eval-200" } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /my-index-000001/_rank_eval\n{\n \"requests\": [\n {\n \"id\": \"JFK query\",\n \"request\": { \"query\": { \"match_all\": {} } },\n \"ratings\": []\n } ],\n \"metric\": {\n \"precision\": {\n \"k\": 20,\n \"relevant_rating_threshold\": 1,\n \"ignore_unlabeled\": false\n }\n }\n}" + } + ] }, "post": { "tags": [ @@ -30886,7 +32632,13 @@ "$ref": "#/components/responses/rank_eval-200" } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /my-index-000001/_rank_eval\n{\n \"requests\": [\n {\n \"id\": \"JFK query\",\n \"request\": { \"query\": { \"match_all\": {} } },\n \"ratings\": []\n } ],\n \"metric\": {\n \"precision\": {\n \"k\": 20,\n \"relevant_rating_threshold\": 1,\n \"ignore_unlabeled\": false\n }\n }\n}" + } + ] } }, "/_reindex": { @@ -31219,7 +32971,13 @@ } } }, - "x-state": "Added in 2.4.0" + "x-state": "Added in 2.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _reindex/r1A2WoRbTwKZ516z6NEs5A:36619/_rethrottle?requests_per_second=-1\n" + } + ] } }, "/_render/template": { @@ -31832,7 +33590,13 @@ } }, "deprecated": true, - "x-state": "Technical preview" + "x-state": "Technical preview", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _rollup/job/sensor/_stop?wait_for_completion=true&timeout=10s\n" + } + ] } }, "/_scripts/painless/_execute": { @@ -32668,7 +34432,13 @@ } } }, - "x-beta": true + "x-beta": true, + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _application/search_application/my-app/\n" + } + ] } }, "/_application/analytics/{name}": { @@ -32729,7 +34499,13 @@ } }, "deprecated": true, - "x-state": "Technical preview" + "x-state": "Technical preview", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _application/analytics/my_analytics_collection\n" + } + ] }, "delete": { "tags": [ @@ -32764,7 +34540,13 @@ } }, "deprecated": true, - "x-state": "Technical preview" + "x-state": "Technical preview", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _application/analytics/my_analytics_collection/\n" + } + ] } }, "/_application/analytics": { @@ -33771,7 +35553,13 @@ "$ref": "#/components/responses/searchable_snapshots.clear_cache-200" } }, - "x-state": "Technical preview" + "x-state": "Technical preview", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST /my-index/_searchable_snapshots/cache/clear\n" + } + ] } }, "/{index}/_searchable_snapshots/cache/clear": { @@ -33804,7 +35592,13 @@ "$ref": "#/components/responses/searchable_snapshots.clear_cache-200" } }, - "x-state": "Technical preview" + "x-state": "Technical preview", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST /my-index/_searchable_snapshots/cache/clear\n" + } + ] } }, "/_snapshot/{repository}/{snapshot}/_mount": { @@ -33956,7 +35750,13 @@ "$ref": "#/components/responses/searchable_snapshots.stats-200" } }, - "x-state": "Added in 7.10.0" + "x-state": "Added in 7.10.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /my-index/_searchable_snapshots/stats\n" + } + ] } }, "/{index}/_searchable_snapshots/stats": { @@ -33979,7 +35779,13 @@ "$ref": "#/components/responses/searchable_snapshots.stats-200" } }, - "x-state": "Added in 7.10.0" + "x-state": "Added in 7.10.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /my-index/_searchable_snapshots/stats\n" + } + ] } }, "/_security/profile/_activate": { @@ -34664,7 +36470,13 @@ } } }, - "x-state": "Added in 7.10.0" + "x-state": "Added in 7.10.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST /_security/api_key/yVGMr3QByxdh1MSaicYx/_clear_cache\n" + } + ] } }, "/_security/privilege/{application}/_clear_cache": { @@ -34719,7 +36531,13 @@ } } }, - "x-state": "Added in 7.9.0" + "x-state": "Added in 7.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST /_security/privilege/myapp/_clear_cache\n" + } + ] } }, "/_security/realm/{realms}/_clear_cache": { @@ -34789,7 +36607,13 @@ } } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST /_security/realm/default_file/_clear_cache\n" + } + ] } }, "/_security/role/{name}/_clear_cache": { @@ -34843,7 +36667,13 @@ } } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST /_security/role/my_admin_role/_clear_cache\n" + } + ] } }, "/_security/service/{namespace}/{service}/credential/token/{name}/_clear_cache": { @@ -34922,7 +36752,13 @@ } } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST /_security/service/elastic/fleet-server/credential/token/token1/_clear_cache\n" + } + ] } }, "/_security/api_key": { @@ -35054,7 +36890,7 @@ "x-codeSamples": [ { "lang": "Console", - "source": "GET /_security/api_key?id=VuaCfGcBCdbkQm-e5aOx&with_limited_by=true\n" + "source": "GET /_security/api_key?username=myuser&realm_name=native1\n" } ] }, @@ -36235,7 +38071,13 @@ "200": { "$ref": "#/components/responses/security.disable_user-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT /_security/user/jacknich/_disable\n" + } + ] }, "post": { "tags": [ @@ -36256,7 +38098,13 @@ "200": { "$ref": "#/components/responses/security.disable_user-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT /_security/user/jacknich/_disable\n" + } + ] } }, "/_security/profile/{uid}/_disable": { @@ -36280,7 +38128,13 @@ "$ref": "#/components/responses/security.disable_user_profile-200" } }, - "x-state": "Added in 8.2.0" + "x-state": "Added in 8.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0/_disable\n" + } + ] }, "post": { "tags": [ @@ -36302,7 +38156,13 @@ "$ref": "#/components/responses/security.disable_user_profile-200" } }, - "x-state": "Added in 8.2.0" + "x-state": "Added in 8.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0/_disable\n" + } + ] } }, "/_security/user/{username}/_enable": { @@ -36325,7 +38185,13 @@ "200": { "$ref": "#/components/responses/security.enable_user-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _security/user/logstash_system/_enable\n" + } + ] }, "post": { "tags": [ @@ -36346,7 +38212,13 @@ "200": { "$ref": "#/components/responses/security.enable_user-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _security/user/logstash_system/_enable\n" + } + ] } }, "/_security/profile/{uid}/_enable": { @@ -36370,7 +38242,13 @@ "$ref": "#/components/responses/security.enable_user_profile-200" } }, - "x-state": "Added in 8.2.0" + "x-state": "Added in 8.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0/_enable\n" + } + ] }, "post": { "tags": [ @@ -36392,7 +38270,13 @@ "$ref": "#/components/responses/security.enable_user_profile-200" } }, - "x-state": "Added in 8.2.0" + "x-state": "Added in 8.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0/_enable\n" + } + ] } }, "/_security/enroll/kibana": { @@ -36937,7 +38821,13 @@ } } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_security/settings\n" + } + ] }, "put": { "tags": [ @@ -39556,7 +41446,13 @@ } } }, - "x-state": "Added in 7.4.0" + "x-state": "Added in 7.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE /_slm/policy/daily-snapshots\n" + } + ] } }, "/_slm/policy/{policy_id}/_execute": { @@ -39677,7 +41573,13 @@ } } }, - "x-state": "Added in 7.5.0" + "x-state": "Added in 7.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _slm/_execute_retention\n" + } + ] } }, "/_slm/policy": { @@ -40685,7 +42587,13 @@ } } }, - "x-state": "Added in 0.0.0" + "x-state": "Added in 0.0.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE /_snapshot/my_repository\n" + } + ] } }, "/_snapshot": { @@ -40968,7 +42876,13 @@ } } }, - "x-state": "Added in 7.12.0" + "x-state": "Added in 7.12.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST /_snapshot/my_repository/_analyze?blob_count=10&max_blob_size=1mb&timeout=120s\n" + } + ] } }, "/_snapshot/{repository}/{snapshot}/_restore": { @@ -41295,7 +43209,13 @@ } } }, - "x-state": "Added in 0.0.0" + "x-state": "Added in 0.0.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _snapshot/my_unverified_backup/_verify\n" + } + ] } }, "/_sql/close": { @@ -41392,7 +43312,13 @@ } } }, - "x-state": "Added in 7.15.0" + "x-state": "Added in 7.15.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _sql/async/delete/FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=\n" + } + ] } }, "/_sql/async/{id}": { @@ -41505,7 +43431,13 @@ } } }, - "x-state": "Added in 7.15.0" + "x-state": "Added in 7.15.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _sql/async/FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=?wait_for_completion_timeout=2s&format=json\n" + } + ] } }, "/_sql/async/status/{id}": { @@ -41571,7 +43503,13 @@ } } }, - "x-state": "Added in 7.15.0" + "x-state": "Added in 7.15.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _sql/async/status/FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=\n" + } + ] } }, "/_sql": { @@ -41877,7 +43815,13 @@ } } }, - "x-state": "Added in 8.10.0" + "x-state": "Added in 8.10.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _synonyms/my-synonyms-set\n" + } + ] }, "delete": { "tags": [ @@ -41911,7 +43855,13 @@ } } }, - "x-state": "Added in 8.10.0" + "x-state": "Added in 8.10.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _synonyms/my-synonyms-set\n" + } + ] } }, "/_synonyms/{set_id}/{rule_id}": { @@ -42213,7 +44163,13 @@ "$ref": "#/components/responses/tasks.cancel-200" } }, - "x-state": "Technical preview" + "x-state": "Technical preview", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _tasks//_cancel\n" + } + ] } }, "/_tasks/{task_id}/_cancel": { @@ -42246,7 +44202,13 @@ "$ref": "#/components/responses/tasks.cancel-200" } }, - "x-state": "Technical preview" + "x-state": "Technical preview", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _tasks//_cancel\n" + } + ] } }, "/_tasks/{task_id}": { @@ -42336,7 +44298,7 @@ "x-codeSamples": [ { "lang": "Console", - "source": "GET _tasks?actions=cluster:*\n" + "source": "GET _tasks?detailed=true&actions=*/delete/byquery\n" } ] } @@ -43533,7 +45495,13 @@ "$ref": "#/components/responses/transform.get_transform-200" } }, - "x-state": "Added in 7.5.0" + "x-state": "Added in 7.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _transform?size=10\n" + } + ] }, "put": { "tags": [ @@ -43727,7 +45695,13 @@ } } }, - "x-state": "Added in 7.5.0" + "x-state": "Added in 7.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _transform/ecommerce_transform\n" + } + ] } }, "/_transform": { @@ -43757,7 +45731,13 @@ "$ref": "#/components/responses/transform.get_transform-200" } }, - "x-state": "Added in 7.5.0" + "x-state": "Added in 7.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _transform?size=10\n" + } + ] } }, "/_transform/{transform_id}/_stats": { @@ -43854,7 +45834,13 @@ } } }, - "x-state": "Added in 7.5.0" + "x-state": "Added in 7.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _transform/ecommerce-customer-transform/_stats\n" + } + ] } }, "/_transform/{transform_id}/_preview": { @@ -44038,7 +46024,13 @@ } } }, - "x-state": "Added in 8.1.0" + "x-state": "Added in 8.1.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _transform/ecommerce_transform/_reset\n" + } + ] } }, "/_transform/{transform_id}/_schedule_now": { @@ -44090,7 +46082,13 @@ } } }, - "x-state": "Added in 8.7.0" + "x-state": "Added in 8.7.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _transform/ecommerce_transform/_schedule_now\n" + } + ] } }, "/_transform/{transform_id}/_start": { @@ -44152,7 +46150,13 @@ } } }, - "x-state": "Added in 7.5.0" + "x-state": "Added in 7.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _transform/ecommerce-customer-transform/_start\n" + } + ] } }, "/_transform/{transform_id}/_stop": { @@ -44244,7 +46248,13 @@ } } }, - "x-state": "Added in 7.5.0" + "x-state": "Added in 7.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _transform/ecommerce_transform/_stop\n" + } + ] } }, "/_transform/{transform_id}/_update": { @@ -44487,7 +46497,13 @@ } } }, - "x-state": "Added in 7.16.0" + "x-state": "Added in 7.16.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _transform/_upgrade\n" + } + ] } }, "/{index}/_update/{id}": { @@ -45297,7 +47313,13 @@ } } }, - "x-state": "Added in 6.5.0" + "x-state": "Added in 6.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _update_by_query/r1A2WoRbTwKZ516z6NEs5A:36619/_rethrottle?requests_per_second=-1\n" + } + ] } }, "/_watcher/watch/{watch_id}/_ack": { @@ -45426,7 +47448,13 @@ "200": { "$ref": "#/components/responses/watcher.activate_watch-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _watcher/watch/my_watch/_activate\n" + } + ] }, "post": { "tags": [ @@ -45447,7 +47475,13 @@ "200": { "$ref": "#/components/responses/watcher.activate_watch-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _watcher/watch/my_watch/_activate\n" + } + ] } }, "/_watcher/watch/{watch_id}/_deactivate": { @@ -45470,7 +47504,13 @@ "200": { "$ref": "#/components/responses/watcher.deactivate_watch-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _watcher/watch/my_watch/_deactivate\n" + } + ] }, "post": { "tags": [ @@ -45491,7 +47531,13 @@ "200": { "$ref": "#/components/responses/watcher.deactivate_watch-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _watcher/watch/my_watch/_deactivate\n" + } + ] } }, "/_watcher/watch/{id}": { @@ -45870,7 +47916,13 @@ } } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_watcher/settings\n" + } + ] }, "put": { "tags": [ @@ -119765,6 +121817,12 @@ "application/json": { "schema": { "$ref": "#/components/schemas/inference._types.InferenceEndpoint" + }, + "examples": { + "InferencePutExample1": { + "description": "An example body for a `PUT _inference/rerank/my-rerank-model` request.", + "value": "{\n \"service\": \"cohere\",\n \"service_settings\": {\n \"model_id\": \"rerank-english-v3.0\",\n \"api_key\": \"{{COHERE_API_KEY}}\"\n }\n}" + } } } }, @@ -119775,6 +121833,12 @@ "application/json": { "schema": { "$ref": "#/components/schemas/inference._types.InferenceEndpoint" + }, + "examples": { + "InferenceUpdateExample1": { + "description": "An example body for a `PUT _inference/my-inference-endpoint/_update` request.", + "value": "{\n \"service_settings\": {\n \"api_key\": \"\"\n }\n}" + } } } }, @@ -119981,6 +122045,12 @@ "$ref": "#/components/schemas/_types.DateTime" } } + }, + "examples": { + "MlGetBucketsExample1": { + "description": "An example body for a `GET _ml/anomaly_detectors/low_request_rate/results/buckets` request.", + "value": "{\n \"anomaly_score\": 80,\n \"start\": \"1454530200001\"\n}" + } } } } @@ -120009,6 +122079,12 @@ "$ref": "#/components/schemas/ml._types.Page" } } + }, + "examples": { + "MlGetCategoriesExample1": { + "description": "An example body for a `GET _ml/anomaly_detectors/esxi_log/results/categories` request.", + "value": "{\n \"page\":{\n \"size\": 1\n }\n}" + } } } } @@ -120023,6 +122099,12 @@ "$ref": "#/components/schemas/ml._types.Page" } } + }, + "examples": { + "MlGetInfluencersExample1": { + "description": "An example body for a `GET _ml/anomaly_detectors/high_sum_total_sales/results/influencers` request.", + "value": "{\n \"sort\": \"influencer_score\",\n \"desc\": true\n}" + } } } } @@ -120050,6 +122132,12 @@ "$ref": "#/components/schemas/_types.DateTime" } } + }, + "examples": { + "MlGetModelSnapshotsExample1": { + "description": "An example body for a `GET _ml/anomaly_detectors/high_sum_total_sales/model_snapshots` request.", + "value": "{\n \"start\": \"1575402236000\"\n}" + } } } } @@ -120093,6 +122181,12 @@ "type": "number" } } + }, + "examples": { + "MlGetOverallBucketsExample1": { + "description": "An example body for a `GET _ml/anomaly_detectors/job-*/results/overall_buckets` request.", + "value": "{\n \"overall_score\": 80,\n \"start\": \"1403532000000\"\n}" + } } } } @@ -120128,6 +122222,12 @@ "$ref": "#/components/schemas/_types.DateTime" } } + }, + "examples": { + "MlGetRecordsExample1": { + "description": "An example body for a `GET _ml/anomaly_detectors/low_request_rate/results/records` request.", + "value": "{\n \"sort\": \"record_score\",\n \"desc\": true,\n \"start\": \"1454944100000\"\n}" + } } } } @@ -120142,6 +122242,12 @@ "$ref": "#/components/schemas/ml.preview_data_frame_analytics.DataframePreviewConfig" } } + }, + "examples": { + "MlPreviewDataFrameAnalyticsExample1": { + "description": "An example body for a `POST _ml/data_frame/analytics/_preview` request.", + "value": "{\n \"config\": {\n \"source\": {\n \"index\": \"houses_sold_last_10_yrs\"\n },\n \"analysis\": {\n \"regression\": {\n \"dependent_variable\": \"price\"\n }\n }\n }\n}" + } } } } @@ -120171,6 +122277,12 @@ "items": { "$ref": "#/components/schemas/_global.msearch.RequestItem" } + }, + "examples": { + "MsearchRequestExample1": { + "description": "An example body for a `GET my-index-000001/_msearch` request.", + "value": "{ }\n{\"query\" : {\"match\" : { \"message\": \"this is a test\"}}}\n{\"index\": \"my-index-000002\"}\n{\"query\" : {\"match_all\" : {}}}" + } } } }, @@ -120307,6 +122419,12 @@ "required": [ "requests" ] + }, + "examples": { + "RankEvalRequestExample1": { + "description": "An example body for a `GET /my-index-000001/_rank_eval` request.", + "value": "{\n \"requests\": [\n {\n \"id\": \"JFK query\",\n \"request\": { \"query\": { \"match_all\": {} } },\n \"ratings\": []\n } ],\n \"metric\": {\n \"precision\": {\n \"k\": 20,\n \"relevant_rating_threshold\": 1,\n \"ignore_unlabeled\": false\n }\n }\n}" + } } } }, diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 55d3eaba90..8db23920d8 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -118,7 +118,13 @@ } } }, - "x-state": "Added in 7.7.0" + "x-state": "Added in 7.7.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE /_async_search/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\n" + } + ] } }, "/_async_search/status/{id}": { @@ -1817,7 +1823,13 @@ "$ref": "#/components/responses/cluster.get_component_template-200" } }, - "x-state": "Added in 7.8.0" + "x-state": "Added in 7.8.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_component_template/template_1\n" + } + ] }, "put": { "tags": [ @@ -1939,7 +1951,13 @@ } } }, - "x-state": "Added in 7.8.0" + "x-state": "Added in 7.8.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _component_template/template_1\n" + } + ] }, "head": { "tags": [ @@ -2019,7 +2037,13 @@ "$ref": "#/components/responses/cluster.get_component_template-200" } }, - "x-state": "Added in 7.8.0" + "x-state": "Added in 7.8.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_component_template/template_1\n" + } + ] } }, "/_info/{target}": { @@ -2078,7 +2102,13 @@ } } }, - "x-state": "Added in 8.9.0" + "x-state": "Added in 8.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_info/_all\n" + } + ] } }, "/_connector/{connector_id}/_check_in": { @@ -2127,7 +2157,13 @@ } } }, - "x-state": "Technical preview" + "x-state": "Technical preview", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _connector/my-connector/_check_in\n" + } + ] } }, "/_connector/{connector_id}": { @@ -2173,7 +2209,13 @@ } } }, - "x-beta": true + "x-beta": true, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _connector/my-connector-id\n" + } + ] }, "put": { "tags": [ @@ -2259,7 +2301,13 @@ } } }, - "x-beta": true + "x-beta": true, + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _connector/my-connector-id&delete_sync_jobs=true\n" + } + ] } }, "/_connector": { @@ -2369,7 +2417,13 @@ } } }, - "x-beta": true + "x-beta": true, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _connector\n" + } + ] }, "put": { "tags": [ @@ -2497,7 +2551,13 @@ } } }, - "x-beta": true + "x-beta": true, + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _connector/_sync_job/my-connector-sync-job-id/_cancel\n" + } + ] } }, "/_connector/_sync_job/{connector_sync_job_id}": { @@ -2532,7 +2592,13 @@ } } }, - "x-beta": true + "x-beta": true, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _connector/_sync_job/my-connector-sync-job\n" + } + ] }, "delete": { "tags": [ @@ -2571,7 +2637,13 @@ } } }, - "x-beta": true + "x-beta": true, + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _connector/_sync_job/my-connector-sync-job-id\n" + } + ] } }, "/_connector/_sync_job": { @@ -2671,7 +2743,13 @@ } } }, - "x-beta": true + "x-beta": true, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _connector/_sync_job?connector_id=my-connector-id&size=1\n" + } + ] }, "post": { "tags": [ @@ -4302,7 +4380,7 @@ "x-codeSamples": [ { "lang": "Console", - "source": "GET my-index-000001/_doc/0\n" + "source": "GET my-index-000001/_doc/1?stored_fields=tags,counter\n" } ] }, @@ -4718,7 +4796,13 @@ "application/json": {} } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "HEAD my-index-000001/_doc/0\n" + } + ] } }, "/{index}/_delete_by_query": { @@ -5227,7 +5311,13 @@ } } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _scripts/my-search-template\n" + } + ] }, "put": { "tags": [ @@ -5358,7 +5448,13 @@ } } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _scripts/my-search-template\n" + } + ] } }, "/_enrich/policy/{name}": { @@ -5382,7 +5478,13 @@ "$ref": "#/components/responses/enrich.get_policy-200" } }, - "x-state": "Added in 7.5.0" + "x-state": "Added in 7.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_enrich/policy/my-policy\n" + } + ] }, "put": { "tags": [ @@ -5430,6 +5532,12 @@ "$ref": "#/components/schemas/enrich._types.Policy" } } + }, + "examples": { + "EnrichPutPolicyExample1": { + "description": "An example body for a `PUT /_enrich/policy/postal_policy` request.", + "value": "{\n \"geo_match\": {\n \"indices\": \"postal_codes\",\n \"match_field\": \"location\",\n \"enrich_fields\": [ \"location\", \"postal_code\" ]\n }\n}" + } } } }, @@ -5447,7 +5555,13 @@ } } }, - "x-state": "Added in 7.5.0" + "x-state": "Added in 7.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT /_enrich/policy/postal_policy\n{\n \"geo_match\": {\n \"indices\": \"postal_codes\",\n \"match_field\": \"location\",\n \"enrich_fields\": [ \"location\", \"postal_code\" ]\n }\n}" + } + ] }, "delete": { "tags": [ @@ -5491,7 +5605,13 @@ } } }, - "x-state": "Added in 7.5.0" + "x-state": "Added in 7.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE /_enrich/policy/my-policy\n" + } + ] } }, "/_enrich/policy/{name}/_execute": { @@ -5555,7 +5675,13 @@ } } }, - "x-state": "Added in 7.5.0" + "x-state": "Added in 7.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT /_enrich/policy/my-policy/_execute?wait_for_completion=false\n" + } + ] } }, "/_enrich/policy": { @@ -5576,7 +5702,13 @@ "$ref": "#/components/responses/enrich.get_policy-200" } }, - "x-state": "Added in 7.5.0" + "x-state": "Added in 7.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_enrich/policy/my-policy\n" + } + ] } }, "/_eql/search/{id}": { @@ -5632,7 +5764,13 @@ } } }, - "x-state": "Added in 7.9.0" + "x-state": "Added in 7.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_eql/search/FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=?wait_for_completion_timeout=2s\n" + } + ] }, "delete": { "tags": [ @@ -5666,7 +5804,13 @@ } } }, - "x-state": "Added in 7.9.0" + "x-state": "Added in 7.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE /_eql/search/FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=\n" + } + ] } }, "/_eql/search/status/{id}": { @@ -5736,7 +5880,13 @@ } } }, - "x-state": "Added in 7.9.0" + "x-state": "Added in 7.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_eql/search/status/FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=\n" + } + ] } }, "/{index}/_eql/search": { @@ -6120,7 +6270,13 @@ } } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET my-index-000001/_source/1\n" + } + ] }, "head": { "tags": [ @@ -6254,7 +6410,13 @@ } } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "HEAD my-index-000001/_source/1\n" + } + ] } }, "/{index}/_explain/{id}": { @@ -7112,7 +7274,13 @@ } } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /my-index-000001\n" + } + ] }, "put": { "tags": [ @@ -7321,7 +7489,13 @@ } } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE /books\n" + } + ] }, "head": { "tags": [ @@ -7410,7 +7584,13 @@ "application/json": {} } } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "HEAD my-data-stream\n" + } + ] } }, "/_data_stream/{name}": { @@ -7443,7 +7623,13 @@ "$ref": "#/components/responses/indices.get_data_stream-200" } }, - "x-state": "Added in 7.9.0" + "x-state": "Added in 7.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _data_stream/my-data-stream\n" + } + ] }, "put": { "tags": [ @@ -7497,7 +7683,13 @@ } } }, - "x-state": "Added in 7.9.0" + "x-state": "Added in 7.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _data_stream/logs-foo-bar\n" + } + ] }, "delete": { "tags": [ @@ -7551,7 +7743,13 @@ } } }, - "x-state": "Added in 7.9.0" + "x-state": "Added in 7.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _data_stream/my-data-stream\n" + } + ] } }, "/{index}/_alias/{name}": { @@ -7586,7 +7784,13 @@ "200": { "$ref": "#/components/responses/indices.get_alias-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _alias\n" + } + ] }, "put": { "tags": [ @@ -7685,7 +7889,13 @@ "200": { "$ref": "#/components/responses/indices.delete_alias-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE my-data-stream/_alias/my-alias\n" + } + ] }, "head": { "tags": [ @@ -7718,7 +7928,13 @@ "200": { "$ref": "#/components/responses/indices.exists_alias-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "HEAD _alias/my-alias\n" + } + ] } }, "/{index}/_aliases/{name}": { @@ -7819,7 +8035,13 @@ "200": { "$ref": "#/components/responses/indices.delete_alias-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE my-data-stream/_alias/my-alias\n" + } + ] } }, "/_index_template/{name}": { @@ -7852,7 +8074,13 @@ "$ref": "#/components/responses/indices.get_index_template-200" } }, - "x-state": "Added in 7.9.0" + "x-state": "Added in 7.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream\n" + } + ] }, "put": { "tags": [ @@ -7980,7 +8208,13 @@ } } }, - "x-state": "Added in 7.8.0" + "x-state": "Added in 7.8.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE /_index_template/my-index-template\n" + } + ] }, "head": { "tags": [ @@ -8071,7 +8305,13 @@ "200": { "$ref": "#/components/responses/indices.get_alias-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _alias\n" + } + ] }, "head": { "tags": [ @@ -8101,7 +8341,13 @@ "200": { "$ref": "#/components/responses/indices.exists_alias-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "HEAD _alias/my-alias\n" + } + ] } }, "/{index}/_lifecycle/explain": { @@ -8215,7 +8461,13 @@ "200": { "$ref": "#/components/responses/indices.get_alias-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _alias\n" + } + ] } }, "/{index}/_alias": { @@ -8247,7 +8499,13 @@ "200": { "$ref": "#/components/responses/indices.get_alias-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _alias\n" + } + ] } }, "/_data_stream/{name}/_lifecycle": { @@ -8322,7 +8580,7 @@ }, "examples": { "IndicesGetDataLifecycleResponseExample1": { - "description": "A successful response from `GET _lifecycle/stats?human&pretty`.", + "description": "A successful response from `GET /_data_stream/{name}/_lifecycle?human&pretty`.", "value": "{\n \"data_streams\": [\n {\n \"name\": \"my-data-stream-1\",\n \"lifecycle\": {\n \"enabled\": true,\n \"data_retention\": \"7d\"\n }\n },\n {\n \"name\": \"my-data-stream-2\",\n \"lifecycle\": {\n \"enabled\": true,\n \"data_retention\": \"7d\"\n }\n }\n ]\n}" } } @@ -8334,7 +8592,7 @@ "x-codeSamples": [ { "lang": "Console", - "source": "GET _lifecycle/stats?human&pretty\n" + "source": "GET /_data_stream/{name}/_lifecycle?human&pretty\n" } ] }, @@ -8474,7 +8732,13 @@ "$ref": "#/components/responses/indices.get_data_stream-200" } }, - "x-state": "Added in 7.9.0" + "x-state": "Added in 7.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _data_stream/my-data-stream\n" + } + ] } }, "/_index_template": { @@ -8504,7 +8768,13 @@ "$ref": "#/components/responses/indices.get_index_template-200" } }, - "x-state": "Added in 7.9.0" + "x-state": "Added in 7.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream\n" + } + ] } }, "/_mapping": { @@ -8536,7 +8806,13 @@ "200": { "$ref": "#/components/responses/indices.get_mapping-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /books/_mapping\n" + } + ] } }, "/{index}/_mapping": { @@ -8571,7 +8847,13 @@ "200": { "$ref": "#/components/responses/indices.get_mapping-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /books/_mapping\n" + } + ] }, "put": { "tags": [ @@ -8705,7 +8987,13 @@ "200": { "$ref": "#/components/responses/indices.get_settings-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _all/_settings?expand_wildcards=all&filter_path=*.settings.index.*.slowlog\n" + } + ] }, "put": { "tags": [ @@ -8797,7 +9085,13 @@ "200": { "$ref": "#/components/responses/indices.get_settings-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _all/_settings?expand_wildcards=all&filter_path=*.settings.index.*.slowlog\n" + } + ] }, "put": { "tags": [ @@ -8895,7 +9189,13 @@ "200": { "$ref": "#/components/responses/indices.get_settings-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _all/_settings?expand_wildcards=all&filter_path=*.settings.index.*.slowlog\n" + } + ] } }, "/_settings/{name}": { @@ -8936,7 +9236,13 @@ "200": { "$ref": "#/components/responses/indices.get_settings-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _all/_settings?expand_wildcards=all&filter_path=*.settings.index.*.slowlog\n" + } + ] } }, "/_data_stream/_migrate/{name}": { @@ -8992,7 +9298,13 @@ } } }, - "x-state": "Added in 7.9.0" + "x-state": "Added in 7.9.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _data_stream/_migrate/my-time-series-data\n" + } + ] } }, "/_data_stream/_modify": { @@ -9020,6 +9332,12 @@ "required": [ "actions" ] + }, + "examples": { + "IndicesModifyDataStreamExample1": { + "description": "An example body for a `POST _data_stream/_modify` request.", + "value": "{\n \"actions\": [\n {\n \"remove_backing_index\": {\n \"data_stream\": \"my-data-stream\",\n \"index\": \".ds-my-data-stream-2023.07.26-000001\"\n }\n },\n {\n \"add_backing_index\": {\n \"data_stream\": \"my-data-stream\",\n \"index\": \".ds-my-data-stream-2023.07.26-000001-downsample\"\n }\n }\n ]\n}" + } } } }, @@ -9037,7 +9355,13 @@ } } }, - "x-state": "Added in 7.16.0" + "x-state": "Added in 7.16.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _data_stream/_modify\n{\n \"actions\": [\n {\n \"remove_backing_index\": {\n \"data_stream\": \"my-data-stream\",\n \"index\": \".ds-my-data-stream-2023.07.26-000001\"\n }\n },\n {\n \"add_backing_index\": {\n \"data_stream\": \"my-data-stream\",\n \"index\": \".ds-my-data-stream-2023.07.26-000001-downsample\"\n }\n }\n ]\n}" + } + ] } }, "/_refresh": { @@ -9063,7 +9387,13 @@ "200": { "$ref": "#/components/responses/indices.refresh-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _refresh\n" + } + ] }, "post": { "tags": [ @@ -9087,7 +9417,13 @@ "200": { "$ref": "#/components/responses/indices.refresh-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _refresh\n" + } + ] } }, "/{index}/_refresh": { @@ -9116,7 +9452,13 @@ "200": { "$ref": "#/components/responses/indices.refresh-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _refresh\n" + } + ] }, "post": { "tags": [ @@ -9143,7 +9485,13 @@ "200": { "$ref": "#/components/responses/indices.refresh-200" } - } + }, + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _refresh\n" + } + ] } }, "/_resolve/index/{name}": { @@ -9567,6 +9915,12 @@ } } } + }, + "examples": { + "IndicesUpdateAliasesExample1": { + "description": "An example body for a `POST _aliases` request.", + "value": "{\n \"actions\": [\n {\n \"add\": {\n \"index\": \"logs-nginx.access-prod\",\n \"alias\": \"logs\"\n }\n }\n ]\n}" + } } } }, @@ -9584,7 +9938,13 @@ } } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _aliases\n{\n \"actions\": [\n {\n \"add\": {\n \"index\": \"logs-nginx.access-prod\",\n \"alias\": \"logs\"\n }\n }\n ]\n}" + } + ] } }, "/_validate/query": { @@ -9641,7 +10001,13 @@ "$ref": "#/components/responses/indices.validate_query-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET my-index-000001/_validate/query?q=user.id:kimchy\n" + } + ] }, "post": { "tags": [ @@ -9696,7 +10062,13 @@ "$ref": "#/components/responses/indices.validate_query-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET my-index-000001/_validate/query?q=user.id:kimchy\n" + } + ] } }, "/{index}/_validate/query": { @@ -9756,7 +10128,13 @@ "$ref": "#/components/responses/indices.validate_query-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET my-index-000001/_validate/query?q=user.id:kimchy\n" + } + ] }, "post": { "tags": [ @@ -9814,7 +10192,13 @@ "$ref": "#/components/responses/indices.validate_query-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET my-index-000001/_validate/query?q=user.id:kimchy\n" + } + ] } }, "/_inference/chat_completion/{inference_id}/_stream": { @@ -10015,7 +10399,13 @@ "$ref": "#/components/responses/inference.get-200" } }, - "x-state": "Added in 8.11.0" + "x-state": "Added in 8.11.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _inference/sparse_embedding/my-elser-model\n" + } + ] }, "put": { "tags": [ @@ -10037,7 +10427,13 @@ "$ref": "#/components/responses/inference.put-200" } }, - "x-state": "Added in 8.11.0" + "x-state": "Added in 8.11.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _inference/rerank/my-rerank-model\n{\n \"service\": \"cohere\",\n \"service_settings\": {\n \"model_id\": \"rerank-english-v3.0\",\n \"api_key\": \"{{COHERE_API_KEY}}\"\n }\n}" + } + ] }, "post": { "tags": [ @@ -10086,7 +10482,13 @@ "$ref": "#/components/responses/inference.delete-200" } }, - "x-state": "Added in 8.11.0" + "x-state": "Added in 8.11.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE /_inference/sparse_embedding/my-elser-model\n" + } + ] } }, "/_inference/{task_type}/{inference_id}": { @@ -10109,7 +10511,13 @@ "$ref": "#/components/responses/inference.get-200" } }, - "x-state": "Added in 8.11.0" + "x-state": "Added in 8.11.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _inference/sparse_embedding/my-elser-model\n" + } + ] }, "put": { "tags": [ @@ -10134,7 +10542,13 @@ "$ref": "#/components/responses/inference.put-200" } }, - "x-state": "Added in 8.11.0" + "x-state": "Added in 8.11.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _inference/rerank/my-rerank-model\n{\n \"service\": \"cohere\",\n \"service_settings\": {\n \"model_id\": \"rerank-english-v3.0\",\n \"api_key\": \"{{COHERE_API_KEY}}\"\n }\n}" + } + ] }, "post": { "tags": [ @@ -10189,7 +10603,13 @@ "$ref": "#/components/responses/inference.delete-200" } }, - "x-state": "Added in 8.11.0" + "x-state": "Added in 8.11.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE /_inference/sparse_embedding/my-elser-model\n" + } + ] } }, "/_inference": { @@ -10204,7 +10624,13 @@ "$ref": "#/components/responses/inference.get-200" } }, - "x-state": "Added in 8.11.0" + "x-state": "Added in 8.11.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _inference/sparse_embedding/my-elser-model\n" + } + ] } }, "/_inference/{task_type}/{alibabacloud_inference_id}": { @@ -12070,7 +12496,13 @@ "$ref": "#/components/responses/ingest.get_pipeline-200" } }, - "x-state": "Added in 5.0.0" + "x-state": "Added in 5.0.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_ingest/pipeline/my-pipeline-id\n" + } + ] }, "put": { "tags": [ @@ -12251,7 +12683,13 @@ } } }, - "x-state": "Added in 5.0.0" + "x-state": "Added in 5.0.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE /_ingest/pipeline/my-pipeline-id\n" + } + ] } }, "/_ingest/pipeline": { @@ -12278,7 +12716,13 @@ "$ref": "#/components/responses/ingest.get_pipeline-200" } }, - "x-state": "Added in 5.0.0" + "x-state": "Added in 5.0.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /_ingest/pipeline/my-pipeline-id\n" + } + ] } }, "/_ingest/processor/grok": { @@ -12315,7 +12759,13 @@ } } }, - "x-state": "Added in 6.1.0" + "x-state": "Added in 6.1.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ingest/processor/grok\n" + } + ] } }, "/_ingest/pipeline/_simulate": { @@ -12620,7 +13070,13 @@ } } }, - "x-state": "Added in 7.12.0" + "x-state": "Added in 7.12.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _logstash/pipeline/my_pipeline\n" + } + ] } }, "/_logstash/pipeline": { @@ -12953,7 +13409,13 @@ } } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/anomaly_detectors/low_request_rate/_close\n" + } + ] } }, "/_ml/calendars/{calendar_id}": { @@ -12982,7 +13444,13 @@ "$ref": "#/components/responses/ml.get_calendars-200" } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/calendars/planned-outages\n" + } + ] }, "put": { "tags": [ @@ -13053,7 +13521,13 @@ } } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _ml/calendars/planned-outages\n" + } + ] }, "post": { "tags": [ @@ -13080,7 +13554,13 @@ "$ref": "#/components/responses/ml.get_calendars-200" } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/calendars/planned-outages\n" + } + ] }, "delete": { "tags": [ @@ -13120,7 +13600,13 @@ } } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _ml/calendars/planned-outages\n" + } + ] } }, "/_ml/calendars/{calendar_id}/events/{event_id}": { @@ -13172,7 +13658,13 @@ } } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _ml/calendars/planned-outages/events/LS8LJGEBMTCMA-qz49st\n" + } + ] } }, "/_ml/calendars/{calendar_id}/jobs/{job_id}": { @@ -13234,7 +13726,13 @@ } } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _ml/calendars/planned-outages/jobs/total-requests\n" + } + ] }, "delete": { "tags": [ @@ -13300,7 +13798,13 @@ } } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _ml/calendars/planned-outages/jobs/total-requests\n" + } + ] } }, "/_ml/data_frame/analytics/{id}": { @@ -13333,7 +13837,13 @@ "$ref": "#/components/responses/ml.get_data_frame_analytics-200" } }, - "x-state": "Added in 7.3.0" + "x-state": "Added in 7.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/data_frame/analytics/loganalytics\n" + } + ] }, "put": { "tags": [ @@ -13404,6 +13914,12 @@ "dest", "source" ] + }, + "examples": { + "MlPutDataFrameAnalyticsExample1": { + "description": "An example body for a `PUT _ml/data_frame/analytics/model-flight-delays-pre` request.", + "value": "{\n \"source\": {\n \"index\": [\n \"kibana_sample_data_flights\"\n ],\n \"query\": {\n \"range\": {\n \"DistanceKilometers\": {\n \"gt\": 0\n }\n }\n },\n \"_source\": {\n \"includes\": [],\n \"excludes\": [\n \"FlightDelay\",\n \"FlightDelayType\"\n ]\n }\n },\n \"dest\": {\n \"index\": \"df-flight-delays\",\n \"results_field\": \"ml-results\"\n },\n \"analysis\": {\n \"regression\": {\n \"dependent_variable\": \"FlightDelayMin\",\n \"training_percent\": 90\n }\n },\n \"analyzed_fields\": {\n \"includes\": [],\n \"excludes\": [\n \"FlightNum\"\n ]\n },\n \"model_memory_limit\": \"100mb\"\n}" + } } } }, @@ -13473,7 +13989,13 @@ } } }, - "x-state": "Added in 7.3.0" + "x-state": "Added in 7.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _ml/data_frame/analytics/model-flight-delays-pre\n{\n \"source\": {\n \"index\": [\n \"kibana_sample_data_flights\"\n ],\n \"query\": {\n \"range\": {\n \"DistanceKilometers\": {\n \"gt\": 0\n }\n }\n },\n \"_source\": {\n \"includes\": [],\n \"excludes\": [\n \"FlightDelay\",\n \"FlightDelayType\"\n ]\n }\n },\n \"dest\": {\n \"index\": \"df-flight-delays\",\n \"results_field\": \"ml-results\"\n },\n \"analysis\": {\n \"regression\": {\n \"dependent_variable\": \"FlightDelayMin\",\n \"training_percent\": 90\n }\n },\n \"analyzed_fields\": {\n \"includes\": [],\n \"excludes\": [\n \"FlightNum\"\n ]\n },\n \"model_memory_limit\": \"100mb\"\n}" + } + ] }, "delete": { "tags": [ @@ -13532,7 +14054,13 @@ } } }, - "x-state": "Added in 7.3.0" + "x-state": "Added in 7.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _ml/data_frame/analytics/loganalytics\n" + } + ] } }, "/_ml/datafeeds/{datafeed_id}": { @@ -13559,7 +14087,13 @@ "$ref": "#/components/responses/ml.get_datafeeds-200" } }, - "x-state": "Added in 5.5.0" + "x-state": "Added in 5.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/datafeeds/datafeed-high_sum_total_sales\n" + } + ] }, "put": { "tags": [ @@ -13680,6 +14214,12 @@ "$ref": "#/components/schemas/_types.HttpHeaders" } } + }, + "examples": { + "MlPutDatafeedExample1": { + "description": "An example body for a `PUT _ml/datafeeds/datafeed-test-job?pretty` request.", + "value": "{\n \"indices\": [\n \"kibana_sample_data_logs\"\n ],\n \"query\": {\n \"bool\": {\n \"must\": [\n {\n \"match_all\": {}\n }\n ]\n }\n },\n \"job_id\": \"test-job\"\n}" + } } } }, @@ -13762,7 +14302,13 @@ } } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _ml/datafeeds/datafeed-test-job?pretty\n{\n \"indices\": [\n \"kibana_sample_data_logs\"\n ],\n \"query\": {\n \"bool\": {\n \"must\": [\n {\n \"match_all\": {}\n }\n ]\n }\n },\n \"job_id\": \"test-job\"\n}" + } + ] }, "delete": { "tags": [ @@ -13811,7 +14357,13 @@ } } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _ml/datafeeds/datafeed-total-requests\n" + } + ] } }, "/_ml/filters/{filter_id}": { @@ -13838,7 +14390,13 @@ "$ref": "#/components/responses/ml.get_filters-200" } }, - "x-state": "Added in 5.5.0" + "x-state": "Added in 5.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/filters/safe_domains\n" + } + ] }, "put": { "tags": [ @@ -13878,6 +14436,12 @@ } } } + }, + "examples": { + "MlPutFilterExample1": { + "description": "An example body for a `PUT _ml/filters/safe_domains` request.", + "value": "{\n \"description\": \"A list of safe domains\",\n \"items\": [\"*.google.com\", \"wikipedia.org\"]\n}" + } } } }, @@ -13914,7 +14478,13 @@ } } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _ml/filters/safe_domains\n{\n \"description\": \"A list of safe domains\",\n \"items\": [\"*.google.com\", \"wikipedia.org\"]\n}" + } + ] }, "delete": { "tags": [ @@ -13954,7 +14524,13 @@ } } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _ml/filters/safe_domains\n" + } + ] } }, "/_ml/anomaly_detectors/{job_id}": { @@ -13981,7 +14557,13 @@ "$ref": "#/components/responses/ml.get_jobs-200" } }, - "x-state": "Added in 5.5.0" + "x-state": "Added in 5.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/high_sum_total_sales\n" + } + ] }, "put": { "tags": [ @@ -14295,7 +14877,13 @@ } } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _ml/anomaly_detectors/total-requests\n" + } + ] } }, "/_ml/trained_models/{model_id}": { @@ -14336,7 +14924,13 @@ "$ref": "#/components/responses/ml.get_trained_models-200" } }, - "x-state": "Added in 7.10.0" + "x-state": "Added in 7.10.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/trained_models/\n" + } + ] }, "put": { "tags": [ @@ -14504,7 +15098,13 @@ } } }, - "x-state": "Added in 7.10.0" + "x-state": "Added in 7.10.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _ml/trained_models/regression-job-one-1574775307356\n" + } + ] } }, "/_ml/trained_models/{model_id}/model_aliases/{model_alias}": { @@ -14561,7 +15161,13 @@ } } }, - "x-state": "Added in 7.13.0" + "x-state": "Added in 7.13.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _ml/trained_models/flight-delay-prediction-1574775339910/model_aliases/flight_delay_model\n" + } + ] }, "delete": { "tags": [ @@ -14612,7 +15218,13 @@ } } }, - "x-state": "Added in 7.13.0" + "x-state": "Added in 7.13.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _ml/trained_models/flight-delay-prediction-1574775339910/model_aliases/flight_delay_model\n" + } + ] } }, "/_ml/anomaly_detectors/_estimate_model_memory": { @@ -14896,6 +15508,12 @@ "$ref": "#/components/schemas/_types.DateTime" } } + }, + "examples": { + "MlFlushJobExample1": { + "description": "An example body for a `POST _ml/anomaly_detectors/low_request_rate/_flush` request.", + "value": "{\n \"calc_interim\": true\n}" + } } } } @@ -14924,7 +15542,13 @@ } } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/anomaly_detectors/low_request_rate/_flush\n{\n \"calc_interim\": true\n}" + } + ] } }, "/_ml/calendars/{calendar_id}/events": { @@ -15024,7 +15648,13 @@ } } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/calendars/planned-outages/events\n" + } + ] }, "post": { "tags": [ @@ -15062,6 +15692,12 @@ "required": [ "events" ] + }, + "examples": { + "MlPostCalendarEventsExample1": { + "description": "An example body for a `POST _ml/calendars/planned-outages/events` request.", + "value": "{\n \"events\" : [\n {\"description\": \"event 1\", \"start_time\": 1513641600000, \"end_time\": 1513728000000},\n {\"description\": \"event 2\", \"start_time\": 1513814400000, \"end_time\": 1513900800000},\n {\"description\": \"event 3\", \"start_time\": 1514160000000, \"end_time\": 1514246400000}\n ]\n}" + } } } }, @@ -15090,7 +15726,13 @@ } } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/calendars/planned-outages/events\n{\n \"events\" : [\n {\"description\": \"event 1\", \"start_time\": 1513641600000, \"end_time\": 1513728000000},\n {\"description\": \"event 2\", \"start_time\": 1513814400000, \"end_time\": 1513900800000},\n {\"description\": \"event 3\", \"start_time\": 1514160000000, \"end_time\": 1514246400000}\n ]\n}" + } + ] } }, "/_ml/calendars": { @@ -15116,7 +15758,13 @@ "$ref": "#/components/responses/ml.get_calendars-200" } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/calendars/planned-outages\n" + } + ] }, "post": { "tags": [ @@ -15140,7 +15788,13 @@ "$ref": "#/components/responses/ml.get_calendars-200" } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/calendars/planned-outages\n" + } + ] } }, "/_ml/data_frame/analytics": { @@ -15170,7 +15824,13 @@ "$ref": "#/components/responses/ml.get_data_frame_analytics-200" } }, - "x-state": "Added in 7.3.0" + "x-state": "Added in 7.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/data_frame/analytics/loganalytics\n" + } + ] } }, "/_ml/data_frame/analytics/_stats": { @@ -15199,7 +15859,13 @@ "$ref": "#/components/responses/ml.get_data_frame_analytics_stats-200" } }, - "x-state": "Added in 7.3.0" + "x-state": "Added in 7.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/data_frame/analytics/weblog-outliers/_stats\n" + } + ] } }, "/_ml/data_frame/analytics/{id}/_stats": { @@ -15231,7 +15897,13 @@ "$ref": "#/components/responses/ml.get_data_frame_analytics_stats-200" } }, - "x-state": "Added in 7.3.0" + "x-state": "Added in 7.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/data_frame/analytics/weblog-outliers/_stats\n" + } + ] } }, "/_ml/datafeeds/{datafeed_id}/_stats": { @@ -15255,7 +15927,13 @@ "$ref": "#/components/responses/ml.get_datafeed_stats-200" } }, - "x-state": "Added in 5.5.0" + "x-state": "Added in 5.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/datafeeds/datafeed-high_sum_total_sales/_stats\n" + } + ] } }, "/_ml/datafeeds/_stats": { @@ -15276,7 +15954,13 @@ "$ref": "#/components/responses/ml.get_datafeed_stats-200" } }, - "x-state": "Added in 5.5.0" + "x-state": "Added in 5.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/datafeeds/datafeed-high_sum_total_sales/_stats\n" + } + ] } }, "/_ml/datafeeds": { @@ -15300,7 +15984,13 @@ "$ref": "#/components/responses/ml.get_datafeeds-200" } }, - "x-state": "Added in 5.5.0" + "x-state": "Added in 5.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/datafeeds/datafeed-high_sum_total_sales\n" + } + ] } }, "/_ml/filters": { @@ -15324,7 +16014,13 @@ "$ref": "#/components/responses/ml.get_filters-200" } }, - "x-state": "Added in 5.5.0" + "x-state": "Added in 5.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/filters/safe_domains\n" + } + ] } }, "/_ml/anomaly_detectors/_stats": { @@ -15344,7 +16040,13 @@ "$ref": "#/components/responses/ml.get_job_stats-200" } }, - "x-state": "Added in 5.5.0" + "x-state": "Added in 5.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/low_request_rate/_stats\n" + } + ] } }, "/_ml/anomaly_detectors/{job_id}/_stats": { @@ -15367,7 +16069,13 @@ "$ref": "#/components/responses/ml.get_job_stats-200" } }, - "x-state": "Added in 5.5.0" + "x-state": "Added in 5.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/low_request_rate/_stats\n" + } + ] } }, "/_ml/anomaly_detectors": { @@ -15391,7 +16099,13 @@ "$ref": "#/components/responses/ml.get_jobs-200" } }, - "x-state": "Added in 5.5.0" + "x-state": "Added in 5.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/high_sum_total_sales\n" + } + ] } }, "/_ml/anomaly_detectors/{job_id}/results/overall_buckets": { @@ -15436,7 +16150,13 @@ "$ref": "#/components/responses/ml.get_overall_buckets-200" } }, - "x-state": "Added in 6.1.0" + "x-state": "Added in 6.1.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/job-*/results/overall_buckets\n{\n \"overall_score\": 80,\n \"start\": \"1403532000000\"\n}" + } + ] }, "post": { "tags": [ @@ -15479,7 +16199,13 @@ "$ref": "#/components/responses/ml.get_overall_buckets-200" } }, - "x-state": "Added in 6.1.0" + "x-state": "Added in 6.1.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/anomaly_detectors/job-*/results/overall_buckets\n{\n \"overall_score\": 80,\n \"start\": \"1403532000000\"\n}" + } + ] } }, "/_ml/trained_models": { @@ -15517,7 +16243,13 @@ "$ref": "#/components/responses/ml.get_trained_models-200" } }, - "x-state": "Added in 7.10.0" + "x-state": "Added in 7.10.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/trained_models/\n" + } + ] } }, "/_ml/trained_models/{model_id}/_stats": { @@ -15547,7 +16279,13 @@ "$ref": "#/components/responses/ml.get_trained_models_stats-200" } }, - "x-state": "Added in 7.10.0" + "x-state": "Added in 7.10.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/trained_models/_stats\n" + } + ] } }, "/_ml/trained_models/_stats": { @@ -15574,7 +16312,13 @@ "$ref": "#/components/responses/ml.get_trained_models_stats-200" } }, - "x-state": "Added in 7.10.0" + "x-state": "Added in 7.10.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/trained_models/_stats\n" + } + ] } }, "/_ml/trained_models/{model_id}/_infer": { @@ -15630,6 +16374,12 @@ "required": [ "docs" ] + }, + "examples": { + "MlInferTrainedModelExample1": { + "description": "An example body for a `POST _ml/trained_models/lang_ident_model_1/_infer` request.", + "value": "{\n \"docs\":[{\"text\": \"The fool doth think he is wise, but the wise man knows himself to be a fool.\"}]\n}" + } } } }, @@ -15658,7 +16408,13 @@ } } }, - "x-state": "Added in 8.3.0" + "x-state": "Added in 8.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/trained_models/lang_ident_model_1/_infer\n{\n \"docs\":[{\"text\": \"The fool doth think he is wise, but the wise man knows himself to be a fool.\"}]\n}" + } + ] } }, "/_ml/anomaly_detectors/{job_id}/_open": { @@ -15761,7 +16517,13 @@ "$ref": "#/components/responses/ml.preview_data_frame_analytics-200" } }, - "x-state": "Added in 7.13.0" + "x-state": "Added in 7.13.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/data_frame/analytics/_preview\n{\n \"config\": {\n \"source\": {\n \"index\": \"houses_sold_last_10_yrs\"\n },\n \"analysis\": {\n \"regression\": {\n \"dependent_variable\": \"price\"\n }\n }\n }\n}" + } + ] }, "post": { "tags": [ @@ -15778,7 +16540,13 @@ "$ref": "#/components/responses/ml.preview_data_frame_analytics-200" } }, - "x-state": "Added in 7.13.0" + "x-state": "Added in 7.13.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/data_frame/analytics/_preview\n{\n \"config\": {\n \"source\": {\n \"index\": \"houses_sold_last_10_yrs\"\n },\n \"analysis\": {\n \"regression\": {\n \"dependent_variable\": \"price\"\n }\n }\n }\n}" + } + ] } }, "/_ml/data_frame/analytics/{id}/_preview": { @@ -15802,7 +16570,13 @@ "$ref": "#/components/responses/ml.preview_data_frame_analytics-200" } }, - "x-state": "Added in 7.13.0" + "x-state": "Added in 7.13.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/data_frame/analytics/_preview\n{\n \"config\": {\n \"source\": {\n \"index\": \"houses_sold_last_10_yrs\"\n },\n \"analysis\": {\n \"regression\": {\n \"dependent_variable\": \"price\"\n }\n }\n }\n}" + } + ] }, "post": { "tags": [ @@ -15824,7 +16598,13 @@ "$ref": "#/components/responses/ml.preview_data_frame_analytics-200" } }, - "x-state": "Added in 7.13.0" + "x-state": "Added in 7.13.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/data_frame/analytics/_preview\n{\n \"config\": {\n \"source\": {\n \"index\": \"houses_sold_last_10_yrs\"\n },\n \"analysis\": {\n \"regression\": {\n \"dependent_variable\": \"price\"\n }\n }\n }\n}" + } + ] } }, "/_ml/datafeeds/{datafeed_id}/_preview": { @@ -15854,7 +16634,13 @@ "$ref": "#/components/responses/ml.preview_datafeed-200" } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/datafeeds/datafeed-high_sum_total_sales/_preview\n" + } + ] }, "post": { "tags": [ @@ -15882,7 +16668,13 @@ "$ref": "#/components/responses/ml.preview_datafeed-200" } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/datafeeds/datafeed-high_sum_total_sales/_preview\n" + } + ] } }, "/_ml/datafeeds/_preview": { @@ -15909,7 +16701,13 @@ "$ref": "#/components/responses/ml.preview_datafeed-200" } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/datafeeds/datafeed-high_sum_total_sales/_preview\n" + } + ] }, "post": { "tags": [ @@ -15934,7 +16732,13 @@ "$ref": "#/components/responses/ml.preview_datafeed-200" } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _ml/datafeeds/datafeed-high_sum_total_sales/_preview\n" + } + ] } }, "/_ml/trained_models/{model_id}/definition/{part}": { @@ -15992,6 +16796,12 @@ "total_definition_length", "total_parts" ] + }, + "examples": { + "MlPutTrainedModelDefinitionPartExample1": { + "description": "An example body for a `PUT _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/definition/0` request.", + "value": "{\n \"definition\": \"...\",\n \"total_definition_length\": 265632637,\n \"total_parts\": 64\n}" + } } } }, @@ -16009,7 +16819,13 @@ } } }, - "x-state": "Added in 8.0.0" + "x-state": "Added in 8.0.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/definition/0\n{\n \"definition\": \"...\",\n \"total_definition_length\": 265632637,\n \"total_parts\": 64\n}" + } + ] } }, "/_ml/trained_models/{model_id}/vocabulary": { @@ -16064,6 +16880,12 @@ "required": [ "vocabulary" ] + }, + "examples": { + "MlPutTrainedModelVocabularyExample1": { + "description": "An example body for a `PUT _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/vocabulary` request.", + "value": "{\n \"vocabulary\": [\n \"[PAD]\",\n \"[unused0]\",\n ...\n ]\n}" + } } } }, @@ -16081,7 +16903,13 @@ } } }, - "x-state": "Added in 8.0.0" + "x-state": "Added in 8.0.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/vocabulary\n{\n \"vocabulary\": [\n \"[PAD]\",\n \"[unused0]\",\n ...\n ]\n}" + } + ] } }, "/_ml/anomaly_detectors/{job_id}/_reset": { @@ -16137,7 +16965,13 @@ } } }, - "x-state": "Added in 7.14.0" + "x-state": "Added in 7.14.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/anomaly_detectors/total-requests/_reset\n" + } + ] } }, "/_ml/data_frame/analytics/{id}/_start": { @@ -16195,7 +17029,13 @@ } } }, - "x-state": "Added in 7.3.0" + "x-state": "Added in 7.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/data_frame/analytics/loganalytics/_start\n" + } + ] } }, "/_ml/datafeeds/{datafeed_id}/_start": { @@ -16265,6 +17105,12 @@ "$ref": "#/components/schemas/_types.Duration" } } + }, + "examples": { + "MlStartDatafeedExample1": { + "description": "An example body for a `POST _ml/datafeeds/datafeed-low_request_rate/_start` request.", + "value": "{\n \"start\": \"2019-04-07T18:22:16Z\"\n}" + } } } } @@ -16294,7 +17140,13 @@ } } }, - "x-state": "Added in 5.5.0" + "x-state": "Added in 5.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/datafeeds/datafeed-low_request_rate/_start\n{\n \"start\": \"2019-04-07T18:22:16Z\"\n}" + } + ] } }, "/_ml/trained_models/{model_id}/deployment/_start": { @@ -16422,7 +17274,13 @@ } } }, - "x-state": "Added in 8.0.0" + "x-state": "Added in 8.0.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/_start?wait_for=started&timeout=1m\n" + } + ] } }, "/_ml/data_frame/analytics/{id}/_stop": { @@ -16496,7 +17354,13 @@ } } }, - "x-state": "Added in 7.3.0" + "x-state": "Added in 7.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/data_frame/analytics/loganalytics/_stop\n" + } + ] } }, "/_ml/datafeeds/{datafeed_id}/_stop": { @@ -16568,6 +17432,12 @@ "$ref": "#/components/schemas/_types.Duration" } } + }, + "examples": { + "MlStopDatafeedExample1": { + "description": "An example body for a `POST _ml/datafeeds/datafeed-low_request_rate/_stop` request.", + "value": "{\n \"timeout\": \"30s\"\n}" + } } } } @@ -16592,7 +17462,13 @@ } } }, - "x-state": "Added in 5.4.0" + "x-state": "Added in 5.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/datafeeds/datafeed-low_request_rate/_stop\n{\n \"timeout\": \"30s\"\n}" + } + ] } }, "/_ml/trained_models/{model_id}/deployment/_stop": { @@ -16655,7 +17531,13 @@ } } }, - "x-state": "Added in 8.0.0" + "x-state": "Added in 8.0.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/trained_models/my_model_for_search/deployment/_stop\n" + } + ] } }, "/_ml/data_frame/analytics/{id}/_update": { @@ -16701,6 +17583,12 @@ "type": "boolean" } } + }, + "examples": { + "MlUpdateDataFrameAnalyticsExample1": { + "description": "An example body for a `POST _ml/data_frame/analytics/loganalytics/_update` request.", + "value": "{\n \"model_memory_limit\": \"200mb\"\n}" + } } } }, @@ -16767,7 +17655,13 @@ } } }, - "x-state": "Added in 7.3.0" + "x-state": "Added in 7.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/data_frame/analytics/loganalytics/_update\n{\n \"model_memory_limit\": \"200mb\"\n}" + } + ] } }, "/_ml/datafeeds/{datafeed_id}/_update": { @@ -16891,6 +17785,12 @@ "type": "number" } } + }, + "examples": { + "MlUpdateDatafeedExample1": { + "description": "An example body for a `POST _ml/datafeeds/datafeed-test-job/_update` request.", + "value": "{\n \"query\": {\n \"term\": {\n \"geo.src\": \"US\"\n }\n }\n}" + } } } }, @@ -16973,7 +17873,13 @@ } } }, - "x-state": "Added in 6.4.0" + "x-state": "Added in 6.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/datafeeds/datafeed-test-job/_update\n{\n \"query\": {\n \"term\": {\n \"geo.src\": \"US\"\n }\n }\n}" + } + ] } }, "/_ml/filters/{filter_id}/_update": { @@ -17022,6 +17928,12 @@ } } } + }, + "examples": { + "MlUpdateFilterExample1": { + "description": "An example body for a `POST _ml/filters/safe_domains/_update` request.", + "value": "{\n \"description\": \"Updated list of domains\",\n \"add_items\": [\"*.myorg.com\"],\n \"remove_items\": [\"wikipedia.org\"]\n}" + } } } }, @@ -17058,7 +17970,13 @@ } } }, - "x-state": "Added in 6.4.0" + "x-state": "Added in 6.4.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/filters/safe_domains/_update\n{\n \"description\": \"Updated list of domains\",\n \"add_items\": [\"*.myorg.com\"],\n \"remove_items\": [\"wikipedia.org\"]\n}" + } + ] } }, "/_ml/anomaly_detectors/{job_id}/_update": { @@ -17155,6 +18073,12 @@ "$ref": "#/components/schemas/ml._types.PerPartitionCategorization" } } + }, + "examples": { + "MlUpdateJobExample1": { + "description": "An example body for a `POST _ml/anomaly_detectors/low_request_rate/_update` request.", + "value": "{\n \"description\":\"An updated job\",\n \"detectors\": {\n \"detector_index\": 0,\n \"description\": \"An updated detector description\"\n },\n \"groups\": [\"kibana_sample_data\",\"kibana_sample_web_logs\"],\n \"model_plot_config\": {\n \"enabled\": true\n },\n \"renormalization_window_days\": 30,\n \"background_persist_interval\": \"2h\",\n \"model_snapshot_retention_days\": 7,\n \"results_retention_days\": 60\n}" + } } } }, @@ -17256,7 +18180,13 @@ } } }, - "x-state": "Added in 5.5.0" + "x-state": "Added in 5.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/anomaly_detectors/low_request_rate/_update\n{\n \"description\":\"An updated job\",\n \"detectors\": {\n \"detector_index\": 0,\n \"description\": \"An updated detector description\"\n },\n \"groups\": [\"kibana_sample_data\",\"kibana_sample_web_logs\"],\n \"model_plot_config\": {\n \"enabled\": true\n },\n \"renormalization_window_days\": 30,\n \"background_persist_interval\": \"2h\",\n \"model_snapshot_retention_days\": 7,\n \"results_retention_days\": 60\n}" + } + ] } }, "/_ml/trained_models/{model_id}/deployment/_update": { @@ -17303,6 +18233,12 @@ "$ref": "#/components/schemas/ml._types.AdaptiveAllocationsSettings" } } + }, + "examples": { + "MlUpdateTrainedModelDeploymentExample1": { + "description": "An example body for a `POST _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/_update` request.", + "value": "{\n \"number_of_allocations\": 4\n}" + } } } } @@ -17328,7 +18264,13 @@ } }, "x-beta": true, - "x-state": "Added in 8.6.0" + "x-state": "Added in 8.6.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/_update\n{\n \"number_of_allocations\": 4\n}" + } + ] } }, "/_msearch": { @@ -17388,7 +18330,13 @@ "$ref": "#/components/responses/msearch-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET my-index-000001/_msearch\n{ }\n{\"query\" : {\"match\" : { \"message\": \"this is a test\"}}}\n{\"index\": \"my-index-000002\"}\n{\"query\" : {\"match_all\" : {}}}" + } + ] }, "post": { "tags": [ @@ -17446,7 +18394,13 @@ "$ref": "#/components/responses/msearch-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET my-index-000001/_msearch\n{ }\n{\"query\" : {\"match\" : { \"message\": \"this is a test\"}}}\n{\"index\": \"my-index-000002\"}\n{\"query\" : {\"match_all\" : {}}}" + } + ] } }, "/{index}/_msearch": { @@ -17509,7 +18463,13 @@ "$ref": "#/components/responses/msearch-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET my-index-000001/_msearch\n{ }\n{\"query\" : {\"match\" : { \"message\": \"this is a test\"}}}\n{\"index\": \"my-index-000002\"}\n{\"query\" : {\"match_all\" : {}}}" + } + ] }, "post": { "tags": [ @@ -17570,7 +18530,13 @@ "$ref": "#/components/responses/msearch-200" } }, - "x-state": "Added in 1.3.0" + "x-state": "Added in 1.3.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET my-index-000001/_msearch\n{ }\n{\"query\" : {\"match\" : { \"message\": \"this is a test\"}}}\n{\"index\": \"my-index-000002\"}\n{\"query\" : {\"match_all\" : {}}}" + } + ] } }, "/_msearch/template": { @@ -18445,7 +19411,13 @@ } } }, - "x-state": "Added in 8.15.0" + "x-state": "Added in 8.15.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _query_rules/my-ruleset/_rule/my-rule1\n" + } + ] } }, "/_query_rules/{ruleset_id}": { @@ -18612,7 +19584,13 @@ } } }, - "x-state": "Added in 8.10.0" + "x-state": "Added in 8.10.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _query_rules/my-ruleset/\n" + } + ] } }, "/_query_rules": { @@ -18808,7 +19786,13 @@ "$ref": "#/components/responses/rank_eval-200" } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /my-index-000001/_rank_eval\n{\n \"requests\": [\n {\n \"id\": \"JFK query\",\n \"request\": { \"query\": { \"match_all\": {} } },\n \"ratings\": []\n } ],\n \"metric\": {\n \"precision\": {\n \"k\": 20,\n \"relevant_rating_threshold\": 1,\n \"ignore_unlabeled\": false\n }\n }\n}" + } + ] }, "post": { "tags": [ @@ -18839,7 +19823,13 @@ "$ref": "#/components/responses/rank_eval-200" } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /my-index-000001/_rank_eval\n{\n \"requests\": [\n {\n \"id\": \"JFK query\",\n \"request\": { \"query\": { \"match_all\": {} } },\n \"ratings\": []\n } ],\n \"metric\": {\n \"precision\": {\n \"k\": 20,\n \"relevant_rating_threshold\": 1,\n \"ignore_unlabeled\": false\n }\n }\n}" + } + ] } }, "/{index}/_rank_eval": { @@ -18875,7 +19865,13 @@ "$ref": "#/components/responses/rank_eval-200" } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /my-index-000001/_rank_eval\n{\n \"requests\": [\n {\n \"id\": \"JFK query\",\n \"request\": { \"query\": { \"match_all\": {} } },\n \"ratings\": []\n } ],\n \"metric\": {\n \"precision\": {\n \"k\": 20,\n \"relevant_rating_threshold\": 1,\n \"ignore_unlabeled\": false\n }\n }\n}" + } + ] }, "post": { "tags": [ @@ -18909,7 +19905,13 @@ "$ref": "#/components/responses/rank_eval-200" } }, - "x-state": "Added in 6.2.0" + "x-state": "Added in 6.2.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET /my-index-000001/_rank_eval\n{\n \"requests\": [\n {\n \"id\": \"JFK query\",\n \"request\": { \"query\": { \"match_all\": {} } },\n \"ratings\": []\n } ],\n \"metric\": {\n \"precision\": {\n \"k\": 20,\n \"relevant_rating_threshold\": 1,\n \"ignore_unlabeled\": false\n }\n }\n}" + } + ] } }, "/_reindex": { @@ -20123,7 +21125,13 @@ } } }, - "x-beta": true + "x-beta": true, + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _application/search_application/my-app/\n" + } + ] } }, "/_application/analytics/{name}": { @@ -20184,7 +21192,13 @@ } }, "deprecated": true, - "x-state": "Technical preview" + "x-state": "Technical preview", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _application/analytics/my_analytics_collection\n" + } + ] }, "delete": { "tags": [ @@ -20219,7 +21233,13 @@ } }, "deprecated": true, - "x-state": "Technical preview" + "x-state": "Technical preview", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _application/analytics/my_analytics_collection/\n" + } + ] } }, "/_application/analytics": { @@ -21021,7 +22041,7 @@ "x-codeSamples": [ { "lang": "Console", - "source": "GET /_security/api_key?id=VuaCfGcBCdbkQm-e5aOx&with_limited_by=true\n" + "source": "GET /_security/api_key?username=myuser&realm_name=native1\n" } ] }, @@ -21880,7 +22900,13 @@ } } }, - "x-state": "Added in 7.15.0" + "x-state": "Added in 7.15.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _sql/async/delete/FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=\n" + } + ] } }, "/_sql/async/{id}": { @@ -21993,7 +23019,13 @@ } } }, - "x-state": "Added in 7.15.0" + "x-state": "Added in 7.15.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _sql/async/FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=?wait_for_completion_timeout=2s&format=json\n" + } + ] } }, "/_sql/async/status/{id}": { @@ -22059,7 +23091,13 @@ } } }, - "x-state": "Added in 7.15.0" + "x-state": "Added in 7.15.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _sql/async/status/FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=\n" + } + ] } }, "/_sql": { @@ -22324,7 +23362,13 @@ } } }, - "x-state": "Added in 8.10.0" + "x-state": "Added in 8.10.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "PUT _synonyms/my-synonyms-set\n" + } + ] }, "delete": { "tags": [ @@ -22358,7 +23402,13 @@ } } }, - "x-state": "Added in 8.10.0" + "x-state": "Added in 8.10.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _synonyms/my-synonyms-set\n" + } + ] } }, "/_synonyms/{set_id}/{rule_id}": { @@ -22720,7 +23770,7 @@ "x-codeSamples": [ { "lang": "Console", - "source": "GET _tasks?actions=cluster:*\n" + "source": "GET _tasks?detailed=true&actions=*/delete/byquery\n" } ] } @@ -23063,7 +24113,13 @@ "$ref": "#/components/responses/transform.get_transform-200" } }, - "x-state": "Added in 7.5.0" + "x-state": "Added in 7.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _transform?size=10\n" + } + ] }, "put": { "tags": [ @@ -23257,7 +24313,13 @@ } } }, - "x-state": "Added in 7.5.0" + "x-state": "Added in 7.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "DELETE _transform/ecommerce_transform\n" + } + ] } }, "/_transform": { @@ -23287,7 +24349,13 @@ "$ref": "#/components/responses/transform.get_transform-200" } }, - "x-state": "Added in 7.5.0" + "x-state": "Added in 7.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _transform?size=10\n" + } + ] } }, "/_transform/{transform_id}/_stats": { @@ -23384,7 +24452,13 @@ } } }, - "x-state": "Added in 7.5.0" + "x-state": "Added in 7.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "GET _transform/ecommerce-customer-transform/_stats\n" + } + ] } }, "/_transform/{transform_id}/_preview": { @@ -23568,7 +24642,13 @@ } } }, - "x-state": "Added in 8.1.0" + "x-state": "Added in 8.1.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _transform/ecommerce_transform/_reset\n" + } + ] } }, "/_transform/{transform_id}/_schedule_now": { @@ -23620,7 +24700,13 @@ } } }, - "x-state": "Added in 8.7.0" + "x-state": "Added in 8.7.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _transform/ecommerce_transform/_schedule_now\n" + } + ] } }, "/_transform/{transform_id}/_start": { @@ -23682,7 +24768,13 @@ } } }, - "x-state": "Added in 7.5.0" + "x-state": "Added in 7.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _transform/ecommerce-customer-transform/_start\n" + } + ] } }, "/_transform/{transform_id}/_stop": { @@ -23774,7 +24866,13 @@ } } }, - "x-state": "Added in 7.5.0" + "x-state": "Added in 7.5.0", + "x-codeSamples": [ + { + "lang": "Console", + "source": "POST _transform/ecommerce_transform/_stop\n" + } + ] } }, "/_transform/{transform_id}/_update": { @@ -71599,6 +72697,12 @@ "application/json": { "schema": { "$ref": "#/components/schemas/inference._types.InferenceEndpoint" + }, + "examples": { + "InferencePutExample1": { + "description": "An example body for a `PUT _inference/rerank/my-rerank-model` request.", + "value": "{\n \"service\": \"cohere\",\n \"service_settings\": {\n \"model_id\": \"rerank-english-v3.0\",\n \"api_key\": \"{{COHERE_API_KEY}}\"\n }\n}" + } } } }, @@ -71733,6 +72837,12 @@ "type": "number" } } + }, + "examples": { + "MlGetOverallBucketsExample1": { + "description": "An example body for a `GET _ml/anomaly_detectors/job-*/results/overall_buckets` request.", + "value": "{\n \"overall_score\": 80,\n \"start\": \"1403532000000\"\n}" + } } } } @@ -71747,6 +72857,12 @@ "$ref": "#/components/schemas/ml.preview_data_frame_analytics.DataframePreviewConfig" } } + }, + "examples": { + "MlPreviewDataFrameAnalyticsExample1": { + "description": "An example body for a `POST _ml/data_frame/analytics/_preview` request.", + "value": "{\n \"config\": {\n \"source\": {\n \"index\": \"houses_sold_last_10_yrs\"\n },\n \"analysis\": {\n \"regression\": {\n \"dependent_variable\": \"price\"\n }\n }\n }\n}" + } } } } @@ -71776,6 +72892,12 @@ "items": { "$ref": "#/components/schemas/_global.msearch.RequestItem" } + }, + "examples": { + "MsearchRequestExample1": { + "description": "An example body for a `GET my-index-000001/_msearch` request.", + "value": "{ }\n{\"query\" : {\"match\" : { \"message\": \"this is a test\"}}}\n{\"index\": \"my-index-000002\"}\n{\"query\" : {\"match_all\" : {}}}" + } } } }, @@ -71892,6 +73014,12 @@ "required": [ "requests" ] + }, + "examples": { + "RankEvalRequestExample1": { + "description": "An example body for a `GET /my-index-000001/_rank_eval` request.", + "value": "{\n \"requests\": [\n {\n \"id\": \"JFK query\",\n \"request\": { \"query\": { \"match_all\": {} } },\n \"ratings\": []\n } ],\n \"metric\": {\n \"precision\": {\n \"k\": 20,\n \"relevant_rating_threshold\": 1,\n \"ignore_unlabeled\": false\n }\n }\n}" + } } } }, diff --git a/output/schema/schema.json b/output/schema/schema.json index 90a069e944..0665777e39 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -23969,13 +23969,11 @@ }, "BulkResponseExample2": { "description": "If you run `POST /_bulk` with operations that update non-existent documents, the operations cannot complete successfully. The API returns a response with an `errors` property value `true`. The response also includes an error object for any failed operations. The error object contains additional information about the failure, such as the error type and reason.\n", - "method_request": "POST /_bulk", "summary": "Failed actions", "value": "{\n \"took\": 486,\n \"errors\": true,\n \"items\": [\n {\n \"update\": {\n \"_index\": \"index1\",\n \"_id\": \"5\",\n \"status\": 404,\n \"error\": {\n \"type\": \"document_missing_exception\",\n \"reason\": \"[5]: document missing\",\n \"index_uuid\": \"aAsFqTI0Tc2W0LCWgPNrOA\",\n \"shard\": \"0\",\n \"index\": \"index1\"\n }\n }\n },\n {\n \"update\": {\n \"_index\": \"index1\",\n \"_id\": \"6\",\n \"status\": 404,\n \"error\": {\n \"type\": \"document_missing_exception\",\n \"reason\": \"[6]: document missing\",\n \"index_uuid\": \"aAsFqTI0Tc2W0LCWgPNrOA\",\n \"shard\": \"0\",\n \"index\": \"index1\"\n }\n }\n },\n {\n \"create\": {\n \"_index\": \"index1\",\n \"_id\": \"7\",\n \"_version\": 1,\n \"result\": \"created\",\n \"_shards\": {\n \"total\": 2,\n \"successful\": 1,\n \"failed\": 0\n },\n \"_seq_no\": 0,\n \"_primary_term\": 1,\n \"status\": 201\n }\n }\n ]\n}" }, "BulkResponseExample3": { "description": "An example response from `POST /_bulk?filter_path=items.*.error`, which returns only information about failed operations.\n", - "method_request": "POST /_bulk?filter_path=items.*.error", "summary": "Filter for failed operations", "value": "{\n \"items\": [\n {\n \"update\": {\n \"error\": {\n \"type\": \"document_missing_exception\",\n \"reason\": \"[5]: document missing\",\n \"index_uuid\": \"aAsFqTI0Tc2W0LCWgPNrOA\",\n \"shard\": \"0\",\n \"index\": \"index1\"\n }\n }\n },\n {\n \"update\": {\n \"error\": {\n \"type\": \"document_missing_exception\",\n \"reason\": \"[6]: document missing\",\n \"index_uuid\": \"aAsFqTI0Tc2W0LCWgPNrOA\",\n \"shard\": \"0\",\n \"index\": \"index1\"\n }\n }\n }\n ]\n}" } @@ -24588,7 +24586,6 @@ "examples": { "ClosePointInTimeResponseExample1": { "description": "A successful response from `DELETE /_pit`.", - "method_request": "DELETE /_pit", "value": "{\n \"succeeded\": true, \n \"num_freed\": 3 \n}" } }, @@ -24901,7 +24898,6 @@ "examples": { "CountResponseExample1": { "description": "A successful response from `GET /my-index-000001/_count?q=user:kimchy`.", - "method_request": "GET /my-index-000001/_count?q=user:kimchy", "value": "{\n \"count\": 1,\n \"_shards\": {\n \"total\": 1,\n \"successful\": 1,\n \"skipped\": 0,\n \"failed\": 0\n }\n}" } }, @@ -25175,6 +25171,11 @@ "kind": "no_body" }, "description": "Delete a document.\n\nRemove a JSON document from the specified index.\n\nNOTE: You cannot send deletion requests directly to a data stream.\nTo delete a document in a data stream, you must target the backing index containing the document.\n\n**Optimistic concurrency control**\n\nDelete operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters.\nIf a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.\n\n**Versioning**\n\nEach document indexed is versioned.\nWhen deleting a document, the version can be specified to make sure the relevant document you are trying to delete is actually being deleted and it has not changed in the meantime.\nEvery write operation run on a document, deletes included, causes its version to be incremented.\nThe version number of a deleted document remains available for a short time after deletion to allow for control of concurrent operations.\nThe length of time for which a deleted document's version remains available is determined by the `index.gc_deletes` index setting.\n\n**Routing**\n\nIf routing is used during indexing, the routing value also needs to be specified to delete a document.\n\nIf the `_routing` mapping is set to `required` and no routing value is specified, the delete API throws a `RoutingMissingException` and rejects the request.\n\nFor example:\n\n```\nDELETE /my-index-000001/_doc/1?routing=shard-1\n```\n\nThis request deletes the document with ID 1, but it is routed based on the user.\nThe document is not deleted if the correct routing is not specified.\n\n**Distributed**\n\nThe delete operation gets hashed into a specific shard ID.\nIt then gets redirected into the primary shard within that ID group and replicated (if needed) to shard replicas within that ID group.", + "examples": { + "DeleteRequestExample1": { + "method_request": "DELETE /my-index-000001/_doc/1" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -25334,7 +25335,6 @@ "examples": { "DeleteResponseExample1": { "description": "A successful response from `DELETE /my-index-000001/_doc/1`, which deletes the JSON document 1 from the `my-index-000001` index.", - "method_request": "DELETE /my-index-000001/_doc/1", "value": "{\n \"_shards\": {\n \"total\": 2,\n \"failed\": 0,\n \"successful\": 2\n },\n \"_index\": \"my-index-000001\",\n \"_id\": \"1\",\n \"_version\": 2,\n \"_primary_term\": 1,\n \"_seq_no\": 5,\n \"result\": \"deleted\"\n}" } }, @@ -26074,7 +26074,6 @@ "examples": { "DeleteByQueryResponseExample1": { "description": "A successful response from `POST /my-index-000001/_delete_by_query`.", - "method_request": "POST /my-index-000001/_delete_by_query", "value": "{\n \"took\" : 147,\n \"timed_out\": false,\n \"total\": 119,\n \"deleted\": 119,\n \"batches\": 1,\n \"version_conflicts\": 0,\n \"noops\": 0,\n \"retries\": {\n \"bulk\": 0,\n \"search\": 0\n },\n \"throttled_millis\": 0,\n \"requests_per_second\": -1.0,\n \"throttled_until_millis\": 0,\n \"failures\" : [ ]\n}" } }, @@ -26093,6 +26092,11 @@ "kind": "no_body" }, "description": "Throttle a delete by query operation.\n\nChange the number of requests per second for a particular delete by query operation.\nRethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.", + "examples": { + "DeleteByQueryRethrottleRequestExample1": { + "method_request": "POST _delete_by_query/r1A2WoRbTwKZ516z6NEs5A:36619/_rethrottle?requests_per_second=-1" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -26161,6 +26165,11 @@ "kind": "no_body" }, "description": "Delete a script or search template.\nDeletes a stored script or search template.", + "examples": { + "DeleteScriptRequestExample1": { + "method_request": "DELETE _scripts/my-search-template" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -26243,6 +26252,11 @@ "kind": "no_body" }, "description": "Check a document.\n\nVerify that a document exists.\nFor example, check to see if a document with the `_id` 0 exists:\n\n```\nHEAD my-index-000001/_doc/0\n```\n\nIf the document exists, the API returns a status code of `200 - OK`.\nIf the document doesn’t exist, the API returns `404 - Not Found`.\n\n**Versioning support**\n\nYou can use the `version` parameter to check the document only if its current version is equal to the specified one.\n\nInternally, Elasticsearch has marked the old document as deleted and added an entirely new document.\nThe old version of the document doesn't disappear immediately, although you won't be able to access it.\nElasticsearch cleans up deleted documents in the background as you continue to index more data.", + "examples": { + "DocumentExistsRequestExample1": { + "method_request": "HEAD my-index-000001/_doc/0" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -26429,6 +26443,11 @@ "kind": "no_body" }, "description": "Check for a document source.\n\nCheck whether a document source exists in an index.\nFor example:\n\n```\nHEAD my-index-000001/_source/1\n```\n\nA document's source is not available if it is disabled in the mapping.", + "examples": { + "ExistsSourceRequestExample1": { + "method_request": "HEAD my-index-000001/_source/1" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -26977,7 +26996,6 @@ "examples": { "ExplainResponseExample1": { "description": "A successful response from `GET /my-index-000001/_explain/0`.", - "method_request": "GET /my-index-000001/_explain/0", "value": "{\n \"_index\":\"my-index-000001\",\n \"_id\":\"0\",\n \"matched\":true,\n \"explanation\":{\n \"value\":1.6943598,\n \"description\":\"weight(message:elasticsearch in 0) [PerFieldSimilarity], result of:\",\n \"details\":[\n {\n \"value\":1.6943598,\n \"description\":\"score(freq=1.0), computed as boost * idf * tf from:\",\n \"details\":[\n {\n \"value\":2.2,\n \"description\":\"boost\",\n \"details\":[]\n },\n {\n \"value\":1.3862944,\n \"description\":\"idf, computed as log(1 + (N - n + 0.5) / (n + 0.5)) from:\",\n \"details\":[\n {\n \"value\":1,\n \"description\":\"n, number of documents containing term\",\n \"details\":[]\n },\n {\n \"value\":5,\n \"description\":\"N, total number of documents with field\",\n \"details\":[]\n }\n ]\n },\n {\n \"value\":0.5555556,\n \"description\":\"tf, computed as freq / (freq + k1 * (1 - b + b * dl / avgdl)) from:\",\n \"details\":[\n {\n \"value\":1.0,\n \"description\":\"freq, occurrences of term within document\",\n \"details\":[]\n },\n {\n \"value\":1.2,\n \"description\":\"k1, term saturation parameter\",\n \"details\":[]\n },\n {\n \"value\":0.75,\n \"description\":\"b, length normalization parameter\",\n \"details\":[]\n },\n {\n \"value\":3.0,\n \"description\":\"dl, length of field\",\n \"details\":[]\n },\n {\n \"value\":5.4,\n \"description\":\"avgdl, average length of field\",\n \"details\":[]\n }\n ]\n }\n ]\n }\n ]\n }\n}" } }, @@ -27463,13 +27481,11 @@ "examples": { "FieldCapabilitiesResponseExample1": { "description": "A successful response from `GET _field_caps?fields=rating,title`. The field `rating` is defined as a long in `index1` and `index2` and as a `keyword` in `index3` and `index4`. The field `rating` is not aggregatable in `index1`. The field `rating` is not searchable in `index4`. The field `title` is defined as text in all indices.\n", - "method_request": "GET _field_caps?fields=rating,title", "summary": "Get two fields", "value": "{\n \"indices\": [ \"index1\", \"index2\", \"index3\", \"index4\", \"index5\" ],\n \"fields\": {\n \"rating\": { \n \"long\": {\n \"metadata_field\": false,\n \"searchable\": true,\n \"aggregatable\": false,\n \"indices\": [ \"index1\", \"index2\" ],\n \"non_aggregatable_indices\": [ \"index1\" ] \n },\n \"keyword\": {\n \"metadata_field\": false,\n \"searchable\": false,\n \"aggregatable\": true,\n \"indices\": [ \"index3\", \"index4\" ],\n \"non_searchable_indices\": [ \"index4\" ] \n }\n },\n \"title\": { \n \"text\": {\n \"metadata_field\": false,\n \"searchable\": true,\n \"aggregatable\": false\n }\n }\n }\n}" }, "FieldCapabilitiesResponseExample2": { "description": "A successful response from `GET _field_caps?fields=rating,title&include_unmapped`. The response contains an entry for each field that is present in some indices but not all. For example, the `rating` and `title` fields are unmapped in `index5`.\n", - "method_request": "GET _field_caps?fields=rating,title&include_unmapped", "summary": "Get unmapped fields", "value": "{\n \"indices\": [ \"index1\", \"index2\", \"index3\", \"index4\", \"index5\" ],\n \"fields\": {\n \"rating\": { \n \"long\": {\n \"metadata_field\": false,\n \"searchable\": true,\n \"aggregatable\": false,\n \"indices\": [ \"index1\", \"index2\" ],\n \"non_aggregatable_indices\": [ \"index1\" ] \n },\n \"keyword\": {\n \"metadata_field\": false,\n \"searchable\": false,\n \"aggregatable\": true,\n \"indices\": [ \"index3\", \"index4\" ],\n \"non_searchable_indices\": [ \"index4\" ] \n }\n },\n \"title\": { \n \"text\": {\n \"metadata_field\": false,\n \"searchable\": true,\n \"aggregatable\": false\n }\n }\n }\n}" } @@ -27636,6 +27652,11 @@ "kind": "no_body" }, "description": "Get a document by its ID.\n\nGet a document and its source or stored fields from an index.\n\nBy default, this API is realtime and is not affected by the refresh rate of the index (when data will become visible for search).\nIn the case where stored fields are requested with the `stored_fields` parameter and the document has been updated but is not yet refreshed, the API will have to parse and analyze the source to extract the stored fields.\nTo turn off realtime behavior, set the `realtime` parameter to false.\n\n**Source filtering**\n\nBy default, the API returns the contents of the `_source` field unless you have used the `stored_fields` parameter or the `_source` field is turned off.\nYou can turn off `_source` retrieval by using the `_source` parameter:\n\n```\nGET my-index-000001/_doc/0?_source=false\n```\n\nIf you only need one or two fields from the `_source`, use the `_source_includes` or `_source_excludes` parameters to include or filter out particular fields.\nThis can be helpful with large documents where partial retrieval can save on network overhead\nBoth parameters take a comma separated list of fields or wildcard expressions.\nFor example:\n\n```\nGET my-index-000001/_doc/0?_source_includes=*.id&_source_excludes=entities\n```\n\nIf you only want to specify includes, you can use a shorter notation:\n\n```\nGET my-index-000001/_doc/0?_source=*.id\n```\n\n**Routing**\n\nIf routing is used during indexing, the routing value also needs to be specified to retrieve a document.\nFor example:\n\n```\nGET my-index-000001/_doc/2?routing=user1\n```\n\nThis request gets the document with ID 2, but it is routed based on the user.\nThe document is not fetched if the correct routing is not specified.\n\n**Distributed**\n\nThe GET operation is hashed into a specific shard ID.\nIt is then redirected to one of the replicas within that shard ID and returns the result.\nThe replicas are the primary shard and its replicas within that shard ID group.\nThis means that the more replicas you have, the better your GET scaling will be.\n\n**Versioning support**\n\nYou can use the `version` parameter to retrieve the document only if its current version is equal to the specified one.\n\nInternally, Elasticsearch has marked the old document as deleted and added an entirely new document.\nThe old version of the document doesn't disappear immediately, although you won't be able to access it.\nElasticsearch cleans up deleted documents in the background as you continue to index more data.", + "examples": { + "GetRequestExample2": { + "method_request": "GET my-index-000001/_doc/1?stored_fields=tags,counter" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -27846,19 +27867,16 @@ "examples": { "GetResponseExample1": { "description": "A successful response from `GET my-index-000001/_doc/0`. It retrieves the JSON document with the `_id` 0 from the `my-index-000001` index.\n", - "method_request": "GET my-index-000001/_doc/0", "summary": "Get a document", "value": "{\n \"_index\": \"my-index-000001\",\n \"_id\": \"0\",\n \"_version\": 1,\n \"_seq_no\": 0,\n \"_primary_term\": 1,\n \"found\": true,\n \"_source\": {\n \"@timestamp\": \"2099-11-15T14:12:12\",\n \"http\": {\n \"request\": {\n \"method\": \"get\"\n },\n \"response\": {\n \"status_code\": 200,\n \"bytes\": 1070000\n },\n \"version\": \"1.1\"\n },\n \"source\": {\n \"ip\": \"127.0.0.1\"\n },\n \"message\": \"GET /search HTTP/1.1 200 1070000\",\n \"user\": {\n \"id\": \"kimchy\"\n }\n }\n}" }, "GetResponseExample2": { "description": "A successful response from `GET my-index-000001/_doc/1?stored_fields=tags,counter`, which retrieves a set of stored fields. Field values fetched from the document itself are always returned as an array. Any requested fields that are not stored (such as the counter field in this example) are ignored.\n", - "method_request": "GET my-index-000001/_doc/1?stored_fields=tags,counter", "summary": "Get stored fields", "value": "{\n \"_index\": \"my-index-000001\",\n \"_id\": \"1\",\n \"_version\": 1,\n \"_seq_no\" : 22,\n \"_primary_term\" : 1,\n \"found\": true,\n \"fields\": {\n \"tags\": [\n \"production\"\n ]\n }\n}" }, "GetResponseExample3": { "description": "A successful response from `GET my-index-000001/_doc/2?routing=user1&stored_fields=tags,counter`, which retrieves the `_routing` metadata field.\n", - "method_request": "GET my-index-000001/_doc/2?routing=user1&stored_fields=tags,counter", "summary": "Get metadata fields", "value": "{\n \"_index\": \"my-index-000001\",\n \"_id\": \"2\",\n \"_version\": 1,\n \"_seq_no\" : 13,\n \"_primary_term\" : 1,\n \"_routing\": \"user1\",\n \"found\": true,\n \"fields\": {\n \"tags\": [\n \"env2\"\n ]\n }\n}" } @@ -27922,6 +27940,11 @@ "kind": "no_body" }, "description": "Get a script or search template.\nRetrieves a stored script or search template.", + "examples": { + "GetScriptRequestExample1": { + "method_request": "GET _scripts/my-search-template" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -28131,6 +28154,11 @@ "kind": "no_body" }, "description": "Get script contexts.\n\nGet a list of supported script contexts and their methods.", + "examples": { + "GetScriptContextRequestExample1": { + "method_request": "GET _script_context" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -28216,6 +28244,11 @@ "kind": "no_body" }, "description": "Get script languages.\n\nGet a list of available script types, languages, and contexts.", + "examples": { + "GetScriptLanguagesRequestExample1": { + "method_request": "GET _script_language" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -28280,6 +28313,11 @@ "kind": "no_body" }, "description": "Get a document's source.\n\nGet the source of a document.\nFor example:\n\n```\nGET my-index-000001/_source/1\n```\n\nYou can use the source filtering parameters to control which parts of the `_source` are returned:\n\n```\nGET my-index-000001/_source/1/?_source_includes=*.id&_source_excludes=entities\n```", + "examples": { + "GetSourceRequestExample1": { + "method_request": "GET my-index-000001/_source/1" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -29482,6 +29520,11 @@ "kind": "no_body" }, "description": "Get the cluster health.\nGet a report with the health status of an Elasticsearch cluster.\nThe report contains a list of indicators that compose Elasticsearch functionality.\n\nEach indicator has a health status of: green, unknown, yellow or red.\nThe indicator will provide an explanation and metadata describing the reason for its current health status.\n\nThe cluster’s status is controlled by the worst indicator status.\n\nIn the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue.\nEach impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system.\n\nSome health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system.\nThe root cause and remediation steps are encapsulated in a diagnosis.\nA diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem.\n\nNOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently.\nWhen setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic.", + "examples": { + "HealthReportRequestExample1": { + "method_request": "GET _health_report" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -30252,13 +30295,11 @@ "examples": { "IndexResponseExample1": { "description": "A successful response from `POST my-index-000001/_doc/`, which contains an automated document ID.", - "method_request": "POST my-index-000001/_doc/", "summary": "Automate document IDs", "value": "{\n \"_shards\": {\n \"total\": 2,\n \"failed\": 0,\n \"successful\": 2\n },\n \"_index\": \"my-index-000001\",\n \"_id\": \"W0tpsmIBdwcYyG50zbta\",\n \"_version\": 1,\n \"_seq_no\": 0,\n \"_primary_term\": 1,\n \"result\": \"created\"\n}" }, "IndexResponseExample2": { "description": "A successful response from `PUT my-index-000001/_doc/1`.", - "method_request": "PUT my-index-000001/_doc/1", "summary": "Define document IDs", "value": "{\n \"_shards\": {\n \"total\": 2,\n \"failed\": 0,\n \"successful\": 2\n },\n \"_index\": \"my-index-000001\",\n \"_id\": \"1\",\n \"_version\": 1,\n \"_seq_no\": 0,\n \"_primary_term\": 1,\n \"result\": \"created\"\n}" } @@ -30278,6 +30319,11 @@ "kind": "no_body" }, "description": "Get cluster info.\nGet basic build, version, and cluster information.", + "examples": { + "RootNodeInfoRequestExample1": { + "method_request": "GET /" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -30360,7 +30406,6 @@ "examples": { "RootNodeInfoResponseExample1": { "description": "A successful response from `GET /`s.", - "method_request": "GET /", "value": "{\n \"name\": \"instance-0000000000\",\n \"cluster_name\": \"my_test_cluster\",\n \"cluster_uuid\": \"5QaxoN0pRZuOmWSxstBBwQ\",\n \"version\": {\n \"build_date\": \"2024-02-01T13:07:13.727175297Z\",\n \"minimum_wire_compatibility_version\": \"7.17.0\",\n \"build_hash\": \"6185ba65d27469afabc9bc951cded6c17c21e3f3\",\n \"number\": \"8.12.1\",\n \"lucene_version\": \"9.9.2\",\n \"minimum_index_compatibility_version\": \"7.0.0\",\n \"build_flavor\": \"default\",\n \"build_snapshot\": false,\n \"build_type\": \"docker\"\n },\n \"tagline\": \"You Know, for Search\"\n}" } }, @@ -31054,6 +31099,13 @@ } }, "description": "Run multiple searches.\n\nThe format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.\nThe structure is as follows:\n\n```\nheader\\n\nbody\\n\nheader\\n\nbody\\n\n```\n\nThis structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.\n\nIMPORTANT: The final line of data must end with a newline character `\\n`.\nEach newline character may be preceded by a carriage return `\\r`.\nWhen sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.", + "examples": { + "MsearchRequestExample1": { + "description": "An example body for a `GET my-index-000001/_msearch` request.", + "method_request": "GET my-index-000001/_msearch", + "value": "{ }\n{\"query\" : {\"match\" : { \"message\": \"this is a test\"}}}\n{\"index\": \"my-index-000002\"}\n{\"query\" : {\"match_all\" : {}}}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -32178,6 +32230,11 @@ ] }, "description": "Open a point in time.\n\nA search request by default runs against the most recent visible data of the target indices,\nwhich is called point in time. Elasticsearch pit (point in time) is a lightweight view into the\nstate of the data as it existed when initiated. In some cases, it’s preferred to perform multiple\nsearch requests using the same point in time. For example, if refreshes happen between\n`search_after` requests, then the results of those requests might not be consistent as changes happening\nbetween searches are only visible to the more recent point in time.\n\nA point in time must be opened explicitly before being used in search requests.\n\nA subsequent search request with the `pit` parameter must not specify `index`, `routing`, or `preference` values as these parameters are copied from the point in time.\n\nJust like regular searches, you can use `from` and `size` to page through point in time search results, up to the first 10,000 hits.\nIf you want to retrieve more hits, use PIT with `search_after`.\n\nIMPORTANT: The open point in time request and each subsequent search request can return different identifiers; always use the most recently received ID for the next search request.\n\nWhen a PIT that contains shard failures is used in a search request, the missing are always reported in the search response as a `NoShardAvailableActionException` exception.\nTo get rid of these exceptions, a new PIT needs to be created so that shards missing from the previous PIT can be handled, assuming they become available in the meantime.\n\n**Keeping point in time alive**\n\nThe `keep_alive` parameter, which is passed to a open point in time request and search request, extends the time to live of the corresponding point in time.\nThe value does not need to be long enough to process all data — it just needs to be long enough for the next request.\n\nNormally, the background merge process optimizes the index by merging together smaller segments to create new, bigger segments.\nOnce the smaller segments are no longer needed they are deleted.\nHowever, open point-in-times prevent the old segments from being deleted since they are still in use.\n\nTIP: Keeping older segments alive means that more disk space and file handles are needed.\nEnsure that you have configured your nodes to have ample free file handles.\n\nAdditionally, if a segment contains deleted or updated documents then the point in time must keep track of whether each document in the segment was live at the time of the initial search request.\nEnsure that your nodes have sufficient heap space if you have many open point-in-times on an index that is subject to ongoing deletes or updates.\nNote that a point-in-time doesn't prevent its associated indices from being deleted.\nYou can check how many point-in-times (that is, search contexts) are open with the nodes stats API.", + "examples": { + "OpenPointInTimeRequestExample1": { + "method_request": "POST /my-index-000001/_pit?keep_alive=1m&allow_partial_search_results=true" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -32327,7 +32384,6 @@ "examples": { "OpenPointInTimeResponseExample1": { "description": "A successful response from `POST /my-index-000001/_pit?keep_alive=1m&allow_partial_search_results=true`. It includes a summary of the total number of shards, as well as the number of successful shards when creating the PIT.\n", - "method_request": "POST /my-index-000001/_pit?keep_alive=1m&allow_partial_search_results=true", "value": "{\n \"id\": \"46ToAwMDaWR5BXV1aWQyKwZub2RlXzMAAAAAAAAAACoBYwADaWR4BXV1aWQxAgZub2RlXzEAAAAAAAAAAAEBYQADaWR5BXV1aWQyKgZub2RlXzIAAAAAAAAAAAwBYgACBXV1aWQyAAAFdXVpZDEAAQltYXRjaF9hbGw_gAAAAA=\",\n \"_shards\": {\n \"total\": 10,\n \"successful\": 10,\n \"skipped\": 0,\n \"failed\": 0\n }\n}" } }, @@ -33120,6 +33176,13 @@ ] }, "description": "Evaluate ranked search results.\n\nEvaluate the quality of ranked search results over a set of typical search queries.", + "examples": { + "RankEvalRequestExample1": { + "description": "An example body for a `GET /my-index-000001/_rank_eval` request.", + "method_request": "GET /my-index-000001/_rank_eval", + "value": "{\n \"requests\": [\n {\n \"id\": \"JFK query\",\n \"request\": { \"query\": { \"match_all\": {} } },\n \"ratings\": []\n } ],\n \"metric\": {\n \"precision\": {\n \"k\": 20,\n \"relevant_rating_threshold\": 1,\n \"ignore_unlabeled\": false\n }\n }\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -34458,6 +34521,11 @@ "kind": "no_body" }, "description": "Throttle a reindex operation.\n\nChange the number of requests per second for a particular reindex operation.\nFor example:\n\n```\nPOST _reindex/r1A2WoRbTwKZ516z6NEs5A:36619/_rethrottle?requests_per_second=-1\n```\n\nRethrottling that speeds up the query takes effect immediately.\nRethrottling that slows down the query will take effect after completing the current batch.\nThis behavior prevents scroll timeouts.", + "examples": { + "ReindexRethrottleRequestExample1": { + "method_request": "POST _reindex/r1A2WoRbTwKZ516z6NEs5A:36619/_rethrottle?requests_per_second=-1" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -34862,19 +34930,16 @@ "examples": { "ExecutePainlessScriptResponseExample1": { "description": "A successful response from `POST /_scripts/painless/_execute` with a `painless_test` context.", - "method_request": "POST /_scripts/painless/_execute", "summary": "Test context", "value": "{\n \"result\": \"0.1\"\n}" }, "ExecutePainlessScriptResponseExample2": { "description": "A successful response from `POST /_scripts/painless/_execute` with a `filter` context.", - "method_request": "POST /_scripts/painless/_execute", "summary": "Filter context", "value": "{\n \"result\": true\n}" }, "ExecutePainlessScriptResponseExample3": { "description": "A successful response from `POST /_scripts/painless/_execute` with a `score` context.", - "method_request": "POST /_scripts/painless/_execute", "summary": "Score context", "value": "{\n \"result\": 0.8\n}" } @@ -36271,7 +36336,6 @@ "examples": { "SearchResponseExample1": { "description": "An abbreviated response from `GET /my-index-000001/_search?from=40&size=20` with a simple term query.\n", - "method_request": "GET /my-index-000001/_search?from=40&size=20", "value": "{\n \"took\": 5,\n \"timed_out\": false,\n \"_shards\": {\n \"total\": 1,\n \"successful\": 1,\n \"skipped\": 0,\n \"failed\": 0\n },\n \"hits\": {\n \"total\": {\n \"value\": 20,\n \"relation\": \"eq\"\n },\n \"max_score\": 1.3862942,\n \"hits\": [\n {\n \"_index\": \"my-index-000001\",\n \"_id\": \"0\",\n \"_score\": 1.3862942,\n \"_source\": {\n \"@timestamp\": \"2099-11-15T14:12:12\",\n \"http\": {\n \"request\": {\n \"method\": \"get\"\n },\n \"response\": {\n \"status_code\": 200,\n \"bytes\": 1070000\n },\n \"version\": \"1.1\"\n },\n \"source\": {\n \"ip\": \"127.0.0.1\"\n },\n \"message\": \"GET /search HTTP/1.1 200 1070000\",\n \"user\": {\n \"id\": \"kimchy\"\n }\n }\n }\n ]\n }\n}" } }, @@ -43058,7 +43122,6 @@ "examples": { "SearchMvtResponseExample1": { "description": "A successful response from `GET museums/_mvt/location/13/4207/2692`. It returns results as a binary vector tile. When decoded into JSON, the tile contains the following data.\n", - "method_request": "GET museums/_mvt/location/13/4207/2692", "value": "{\n \"hits\": {\n \"extent\": 4096,\n \"version\": 2,\n \"features\": [\n {\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n 3208,\n 3864\n ]\n },\n \"properties\": {\n \"_id\": \"1\",\n \"_index\": \"museums\",\n \"name\": \"NEMO Science Museum\",\n \"price\": 1750\n },\n \"type\": 1\n },\n {\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n 3429,\n 3496\n ]\n },\n \"properties\": {\n \"_id\": \"3\",\n \"_index\": \"museums\",\n \"name\": \"Nederlands Scheepvaartmuseum\",\n \"price\": 1650\n },\n \"type\": 1\n },\n {\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n 3429,\n 3496\n ]\n },\n \"properties\": {\n \"_id\": \"4\",\n \"_index\": \"museums\",\n \"name\": \"Amsterdam Centre for Architecture\",\n \"price\": 0\n },\n \"type\": 1\n }\n ]\n },\n \"aggs\": {\n \"extent\": 4096,\n \"version\": 2,\n \"features\": [\n {\n \"geometry\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n 3072,\n 3072\n ],\n [\n 4096,\n 3072\n ],\n [\n 4096,\n 4096\n ],\n [\n 3072,\n 4096\n ],\n [\n 3072,\n 3072\n ]\n ]\n ]\n },\n \"properties\": {\n \"_count\": 3,\n \"max_price.value\": 1750.0,\n \"min_price.value\": 0.0,\n \"avg_price.value\": 1133.3333333333333\n },\n \"type\": 3\n }\n ]\n },\n \"meta\": {\n \"extent\": 4096,\n \"version\": 2,\n \"features\": [\n {\n \"geometry\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n 0,\n 0\n ],\n [\n 4096,\n 0\n ],\n [\n 4096,\n 4096\n ],\n [\n 0,\n 4096\n ],\n [\n 0,\n 0\n ]\n ]\n ]\n },\n \"properties\": {\n \"_shards.failed\": 0,\n \"_shards.skipped\": 0,\n \"_shards.successful\": 1,\n \"_shards.total\": 1,\n \"aggregations._count.avg\": 3.0,\n \"aggregations._count.count\": 1,\n \"aggregations._count.max\": 3.0,\n \"aggregations._count.min\": 3.0,\n \"aggregations._count.sum\": 3.0,\n \"aggregations.avg_price.avg\": 1133.3333333333333,\n \"aggregations.avg_price.count\": 1,\n \"aggregations.avg_price.max\": 1133.3333333333333,\n \"aggregations.avg_price.min\": 1133.3333333333333,\n \"aggregations.avg_price.sum\": 1133.3333333333333,\n \"aggregations.max_price.avg\": 1750.0,\n \"aggregations.max_price.count\": 1,\n \"aggregations.max_price.max\": 1750.0,\n \"aggregations.max_price.min\": 1750.0,\n \"aggregations.max_price.sum\": 1750.0,\n \"aggregations.min_price.avg\": 0.0,\n \"aggregations.min_price.count\": 1,\n \"aggregations.min_price.max\": 0.0,\n \"aggregations.min_price.min\": 0.0,\n \"aggregations.min_price.sum\": 0.0,\n \"hits.max_score\": 0.0,\n \"hits.total.relation\": \"eq\",\n \"hits.total.value\": 3,\n \"timed_out\": false,\n \"took\": 2\n },\n \"type\": 3\n }\n ]\n }\n}" } }, @@ -43148,6 +43211,11 @@ "kind": "no_body" }, "description": "Get the search shards.\n\nGet the indices and shards that a search request would be run against.\nThis information can be useful for working out issues or planning optimizations with routing and shard preferences.\nWhen filtered aliases are used, the filter is returned as part of the `indices` section.\n\nIf the Elasticsearch security features are enabled, you must have the `view_index_metadata` or `manage` index privilege for the target data stream, index, or alias.", + "examples": { + "SearchShardsRequestExample1": { + "method_request": "GET /my-index-000001/_search_shards" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -43336,7 +43404,6 @@ "examples": { "SearchShardsResponseExample1": { "description": "An abbreviated response from `GET /my-index-000001/_search_shards`.", - "method_request": "GET /my-index-000001/_search_shards", "value": "{\n \"nodes\": {},\n \"indices\": {\n \"my-index-000001\": { }\n },\n \"shards\": [\n [\n {\n \"index\": \"my-index-000001\",\n \"node\": \"JklnKbD7Tyqi9TP3_Q_tBg\",\n \"relocating_node\": null,\n \"primary\": true,\n \"shard\": 0,\n \"state\": \"STARTED\",\n \"allocation_id\": {\"id\":\"0TvkCyF7TAmM1wHP4a42-A\"},\n \"relocation_failure_info\" : {\n \"failed_attempts\" : 0\n }\n }\n ],\n [\n {\n \"index\": \"my-index-000001\",\n \"node\": \"JklnKbD7Tyqi9TP3_Q_tBg\",\n \"relocating_node\": null,\n \"primary\": true,\n \"shard\": 1,\n \"state\": \"STARTED\",\n \"allocation_id\": {\"id\":\"fMju3hd1QHWmWrIgFnI4Ww\"},\n \"relocation_failure_info\" : {\n \"failed_attempts\" : 0\n }\n }\n ],\n [\n {\n \"index\": \"my-index-000001\",\n \"node\": \"JklnKbD7Tyqi9TP3_Q_tBg\",\n \"relocating_node\": null,\n \"primary\": true,\n \"shard\": 2,\n \"state\": \"STARTED\",\n \"allocation_id\": {\"id\":\"Nwl0wbMBTHCWjEEbGYGapg\"},\n \"relocation_failure_info\" : {\n \"failed_attempts\" : 0\n }\n }\n ],\n [\n {\n \"index\": \"my-index-000001\",\n \"node\": \"JklnKbD7Tyqi9TP3_Q_tBg\",\n \"relocating_node\": null,\n \"primary\": true,\n \"shard\": 3,\n \"state\": \"STARTED\",\n \"allocation_id\": {\"id\":\"bU_KLGJISbW0RejwnwDPKw\"},\n \"relocation_failure_info\" : {\n \"failed_attempts\" : 0\n }\n }\n ],\n [\n {\n \"index\": \"my-index-000001\",\n \"node\": \"JklnKbD7Tyqi9TP3_Q_tBg\",\n \"relocating_node\": null,\n \"primary\": true,\n \"shard\": 4,\n \"state\": \"STARTED\",\n \"allocation_id\": {\"id\":\"DMs7_giNSwmdqVukF7UydA\"},\n \"relocation_failure_info\" : {\n \"failed_attempts\" : 0\n }\n }\n ]\n ]\n }" } }, @@ -44204,7 +44271,6 @@ "examples": { "TermsEnumResponseExample1": { "description": "A successful response from `POST stackoverflow/_terms_enum`.", - "method_request": "POST stackoverflow/_terms_enum", "value": "{\n \"_shards\": {\n \"total\": 1,\n \"successful\": 1,\n \"failed\": 0\n },\n \"terms\": [\n \"kibana\"\n ],\n \"complete\" : true\n}" } }, @@ -44834,19 +44900,16 @@ "examples": { "TermVectorsResponseExample1": { "description": "A successful response from `GET /my-index-000001/_termvectors/1`.", - "method_request": "GET /my-index-000001/_termvectors/1", "summary": "Return stored term vectors", "value": "{\n \"_index\": \"my-index-000001\",\n \"_id\": \"1\",\n \"_version\": 1,\n \"found\": true,\n \"took\": 6,\n \"term_vectors\": {\n \"text\": {\n \"field_statistics\": {\n \"sum_doc_freq\": 4,\n \"doc_count\": 2,\n \"sum_ttf\": 6\n },\n \"terms\": {\n \"test\": {\n \"doc_freq\": 2,\n \"ttf\": 4,\n \"term_freq\": 3,\n \"tokens\": [\n {\n \"position\": 0,\n \"start_offset\": 0,\n \"end_offset\": 4,\n \"payload\": \"d29yZA==\"\n },\n {\n \"position\": 1,\n \"start_offset\": 5,\n \"end_offset\": 9,\n \"payload\": \"d29yZA==\"\n },\n {\n \"position\": 2,\n \"start_offset\": 10,\n \"end_offset\": 14,\n \"payload\": \"d29yZA==\"\n }\n ]\n }\n }\n }\n }\n}" }, "TermVectorsResponseExample2": { "description": "A successful response from `GET /my-index-000001/_termvectors` with `per_field_analyzer` in the request body.", - "method_request": "GET /my-index-000001/_termvectors", "summary": "Per-field analyzer", "value": "{\n \"_index\": \"my-index-000001\",\n \"_version\": 0,\n \"found\": true,\n \"took\": 6,\n \"term_vectors\": {\n \"fullname\": {\n \"field_statistics\": {\n \"sum_doc_freq\": 2,\n \"doc_count\": 4,\n \"sum_ttf\": 4\n },\n \"terms\": {\n \"John Doe\": {\n \"term_freq\": 1,\n \"tokens\": [\n {\n \"position\": 0,\n \"start_offset\": 0,\n \"end_offset\": 8\n }\n ]\n }\n }\n }\n }\n}" }, "TermVectorsResponseExample3": { "description": "A successful response from `GET /my-index-000001/_termvectors` with a `filter` in the request body.", - "method_request": "GET /my-index-000001/_termvectors", "summary": "Terms filtering", "value": "{\n \"_index\": \"imdb\",\n \"_version\": 0,\n \"found\": true,\n \"term_vectors\": {\n \"plot\": {\n \"field_statistics\": {\n \"sum_doc_freq\": 3384269,\n \"doc_count\": 176214,\n \"sum_ttf\": 3753460\n },\n \"terms\": {\n \"armored\": {\n \"doc_freq\": 27,\n \"ttf\": 27,\n \"term_freq\": 1,\n \"score\": 9.74725\n },\n \"industrialist\": {\n \"doc_freq\": 88,\n \"ttf\": 88,\n \"term_freq\": 1,\n \"score\": 8.590818\n },\n \"stark\": {\n \"doc_freq\": 44,\n \"ttf\": 47,\n \"term_freq\": 1,\n \"score\": 9.272792\n }\n }\n }\n }\n}" } @@ -46251,6 +46314,11 @@ "kind": "no_body" }, "description": "Throttle an update by query operation.\n\nChange the number of requests per second for a particular update by query operation.\nRethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.", + "examples": { + "UpdateByQueryRethrottleRequestExample1": { + "method_request": "POST _update_by_query/r1A2WoRbTwKZ516z6NEs5A:36619/_rethrottle?requests_per_second=-1" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -92897,6 +92965,11 @@ "kind": "no_body" }, "description": "Delete an async search.\n\nIf the asynchronous search is still running, it is cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", + "examples": { + "AsyncSearchDeleteExample1": { + "method_request": "DELETE /_async_search/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -92952,6 +93025,11 @@ "kind": "no_body" }, "description": "Get async search results.\n\nRetrieve the results of a previously submitted asynchronous search request.\nIf the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", + "examples": { + "AsyncSearchGetRequestExample1": { + "method_request": "GET /_async_search/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -93041,7 +93119,6 @@ "examples": { "AsyncSearchGetResponseExample1": { "description": "A succesful response from `GET /_async_search/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=`.", - "method_request": "GET /_async_search/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=", "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_partial\" : false, \n \"is_running\" : false, \n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986, \n \"completion_time_in_millis\" : 1583945903130, \n \"response\" : {\n \"took\" : 12144,\n \"timed_out\" : false,\n \"num_reduce_phases\" : 46, \n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 188, \n \"skipped\" : 0,\n \"failed\" : 0\n },\n \"hits\" : {\n \"total\" : {\n \"value\" : 456433,\n \"relation\" : \"eq\"\n },\n \"max_score\" : null,\n \"hits\" : [ ]\n },\n \"aggregations\" : { \n \"sale_date\" : {\n \"buckets\" : []\n }\n }\n }\n}" } }, @@ -93066,6 +93143,11 @@ "kind": "no_body" }, "description": "Get the async search status.\n\nGet the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to:\n\n* The user or API key that submitted the original async search request.\n* Users that have the `monitor` cluster privilege or greater privileges.", + "examples": { + "AsyncSearchStatusRequestExample1": { + "method_request": "GET /_async_search/status/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -93123,19 +93205,16 @@ "examples": { "AsyncSearchStatusResponseExample1": { "description": "A succesful response from `GET /_async_search/status/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=`, which retrieves the status of a previously submitted async search without the results.", - "method_request": "GET /_async_search/status/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=", "summary": "An active async search", "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_running\" : true,\n \"is_partial\" : true,\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 188, \n \"skipped\" : 0,\n \"failed\" : 0\n }\n}" }, "AsyncSearchStatusResponseExample2": { "description": "A succesful response from `GET /_async_search/status/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=` for an async search that has completed. The status response has an additional `completion_status` field that shows the status code of the completed async search.\n", - "method_request": "GET /_async_search/status/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=", "summary": "A completed async search", "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_running\" : false,\n \"is_partial\" : false,\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 562,\n \"skipped\" : 0,\n \"failed\" : 0\n },\n\"completion_status\" : 200 \n}" }, "AsyncSearchStatusResponseExample3": { "description": "A response from `GET /_async_search/status/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=` for an async search that has completed with an error. The status response has an additional `completion_status` field that shows the status code of the completed async search.\n", - "method_request": "GET /_async_search/status/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=", "summary": "A failed async search", "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_running\" : false,\n \"is_partial\" : true,\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 450,\n \"skipped\" : 0,\n \"failed\" : 112\n },\n\"completion_status\" : 503 \n}" } @@ -94351,6 +94430,11 @@ "kind": "no_body" }, "description": "Delete an autoscaling policy.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", + "examples": { + "DeleteAutoscalingPolicyRequestExample1": { + "method_request": "DELETE /_autoscaling/policy/*" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -94421,7 +94505,6 @@ "examples": { "DeleteAutoscalingPolicyResponseExample1": { "description": "This may be a response to either `DELETE /_autoscaling/policy/my_autoscaling_policy` or `DELETE /_autoscaling/policy/*`.\n", - "method_request": "DELETE /_autoscaling/policy/*", "summary": "A successful response of deleting one or more autoscaling policy.", "value": "{\n \"acknowledged\": true\n}" } @@ -94633,6 +94716,11 @@ "kind": "no_body" }, "description": "Get the autoscaling capacity.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nThis API gets the current autoscaling capacity based on the configured autoscaling policy.\nIt will return information to size the cluster appropriately to the current workload.\n\nThe `required_capacity` is calculated as the maximum of the `required_capacity` result of all individual deciders that are enabled for the policy.\n\nThe operator should verify that the `current_nodes` match the operator’s knowledge of the cluster to avoid making autoscaling decisions based on stale or incomplete information.\n\nThe response contains decider-specific information you can use to diagnose how and why autoscaling determined a certain capacity was required.\nThis information is provided for diagnosis only.\nDo not use this information to make autoscaling decisions.", + "examples": { + "GetAutoscalingCapacityRequestExample1": { + "method_request": "GET /_autoscaling/capacity" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -94693,7 +94781,6 @@ "examples": { "GetAutoscalingCapacityResponseExample1": { "description": "This may be a response to `GET /_autoscaling/capacity`.", - "method_request": "GET /_autoscaling/capacity", "summary": "A successful response for retrieving the current autoscaling capacity.", "value": "{\n policies: {}\n}" } @@ -94713,6 +94800,11 @@ "kind": "no_body" }, "description": "Get an autoscaling policy.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", + "examples": { + "GetAutoscalingPolicyRequestExample1": { + "method_request": "GET /_autoscaling/policy/my_autoscaling_policy" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -94770,7 +94862,6 @@ "examples": { "GetAutoscalingPolicyResponseExample1": { "description": "This may be a response to `GET /_autoscaling/policy/my_autoscaling_policy`.", - "method_request": "GET /_autoscaling/policy/my_autoscaling_policy", "summary": "A successful response for retrieving an autoscaling policy.", "value": "{\n \"roles\": ,\n \"deciders\": \n}" } @@ -96990,6 +97081,11 @@ "kind": "no_body" }, "description": "Get aliases.\n\nGet the cluster's index aliases, including filter and routing information.\nThis API does not return data stream aliases.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.", + "examples": { + "CatAliasesRequestExample1": { + "method_request": "GET _cat/aliases?format=json&v=true" + } + }, "inherits": { "type": { "name": "CatRequestBase", @@ -97086,7 +97182,6 @@ "examples": { "CatAliasesResponseExample1": { "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", - "method_request": "GET _cat/aliases?format=json&v=true", "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]" } }, @@ -97455,6 +97550,11 @@ "kind": "no_body" }, "description": "Get shard allocation information.\n\nGet a snapshot of the number of shards allocated to each data node and their disk space.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", + "examples": { + "CatAllocationRequestExample1": { + "method_request": "GET /_cat/allocation?v=true&format=json" + } + }, "inherits": { "type": { "name": "CatRequestBase", @@ -97564,7 +97664,6 @@ "examples": { "CatAllocationResponseExample1": { "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", - "method_request": "GET /_cat/allocation?v=true&format=json", "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]" } }, @@ -97683,6 +97782,11 @@ "kind": "no_body" }, "description": "Get component templates.\n\nGet information about component templates in a cluster.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get component template API.", + "examples": { + "CatComponentTemplatesRequestExample1": { + "method_request": "GET _cat/component_templates/my-template-*?v=true&s=name&format=json" + } + }, "inherits": { "type": { "name": "CatRequestBase", @@ -97780,7 +97884,6 @@ "examples": { "CatComponentTemplatesResponseExample1": { "description": "A successful response from `GET _cat/component_templates/my-template-*?v=true&s=name&format=json`.\n", - "method_request": "GET _cat/component_templates/my-template-*?v=true&s=name&format=json", "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]" } }, @@ -97878,6 +97981,11 @@ "kind": "no_body" }, "description": "Get a document count.\n\nGet quick access to a document count for a data stream, an index, or an entire cluster.\nThe document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the count API.", + "examples": { + "CatCountRequestExample1": { + "method_request": "GET /_cat/count/my-index-000001?v=true&format=json" + } + }, "inherits": { "type": { "name": "CatRequestBase", @@ -97949,13 +98057,11 @@ "examples": { "CatCountResponseExample1": { "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", - "method_request": "GET /_cat/count/my-index-000001?v=true&format=json", "summary": "Single data stream or index count", "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&format=json`. It retrieves the document count for all data streams and indices in the cluster.\n", - "method_request": "GET /_cat/count?v=true&format=json", "summary": "All data streams and indices count", "value": "[\n {\n \"epoch\": \"1475868259\",\n \"timestamp\": \"15:24:20\",\n \"count\": \"121\"\n }\n]" } @@ -98067,6 +98173,11 @@ "kind": "no_body" }, "description": "Get field data cache information.\n\nGet the amount of heap memory currently used by the field data cache on every data node in the cluster.\n\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the nodes stats API.", + "examples": { + "CatFielddataRequestExample1": { + "method_request": "GET /_cat/fielddata?v=true&fields=body&format=json" + } + }, "inherits": { "type": { "name": "CatRequestBase", @@ -98162,13 +98273,11 @@ "examples": { "CatFielddataResponseExample1": { "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", - "method_request": "GET /_cat/fielddata?v=true&fields=body&format=json", "summary": "Single field data", "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&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", - "method_request": "GET /_cat/fielddata?v=true", "summary": "Multiple fields data", "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]" } @@ -98462,6 +98571,11 @@ "kind": "no_body" }, "description": "Get the cluster health status.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the cluster health API.\nThis API is often used to check malfunctioning clusters.\nTo help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats:\n`HH:MM:SS`, which is human-readable but includes no date information;\n`Unix epoch time`, which is machine-sortable and includes date information.\nThe latter format is useful for cluster recoveries that take multiple days.\nYou can use the cat health API to verify cluster health across multiple nodes.\nYou also can use the API to track the recovery of a large cluster over a longer period of time.", + "examples": { + "CatHealthRequestExample1": { + "method_request": "GET /_cat/health?v=true&format=json" + } + }, "inherits": { "type": { "name": "CatRequestBase", @@ -98545,7 +98659,6 @@ "examples": { "CatHealthResponseExample1": { "description": "A successful response from `GET /_cat/health?v=true&format=json`. By default, it returns `HH:MM:SS` and Unix epoch timestamps.\n", - "method_request": "GET /_cat/health?v=true&format=json", "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]" } }, @@ -100673,6 +100786,11 @@ "kind": "no_body" }, "description": "Get index information.\n\nGet high-level information about indices in a cluster, including backing indices for data streams.\n\nUse this request to get the following information for each index in a cluster:\n- shard count\n- document count\n- deleted document count\n- primary store size\n- total store size of all shards, including shard replicas\n\nThese metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents.\nTo get an accurate count of Elasticsearch documents, use the cat count or count APIs.\n\nCAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use an index endpoint.", + "examples": { + "CatIndicesRequestExample1": { + "method_request": "GET /_cat/indices/my-index-*?v=true&s=index&format=json" + } + }, "inherits": { "type": { "name": "CatRequestBase", @@ -100831,7 +100949,6 @@ "examples": { "CatIndicesResponseExample1": { "description": "A successful response from `GET /_cat/indices/my-index-*?v=true&s=index&format=json`.\n", - "method_request": "GET /_cat/indices/my-index-*?v=true&s=index&format=json", "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]" } }, @@ -100915,6 +101032,11 @@ "kind": "no_body" }, "description": "Get master node information.\n\nGet information about the master node, including the ID, bound IP address, and name.\n\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", + "examples": { + "CatMasterRequestExample1": { + "method_request": "GET /_cat/master?v=true&format=json" + } + }, "inherits": { "type": { "name": "CatRequestBase", @@ -100999,7 +101121,6 @@ "examples": { "CatMasterResponseExample1": { "description": "A successful response from `GET /_cat/master?v=true&format=json`.\n", - "method_request": "GET /_cat/master?v=true&format=json", "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]" } }, @@ -101276,6 +101397,11 @@ "kind": "no_body" }, "description": "Get data frame analytics jobs.\n\nGet configuration and usage information about data frame analytics jobs.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get data frame analytics jobs statistics API.", + "examples": { + "CatDataframeanalyticsRequestExample1": { + "method_request": "GET _cat/ml/data_frame/analytics?v=true&format=json" + } + }, "inherits": { "type": { "name": "CatRequestBase", @@ -101384,7 +101510,6 @@ "examples": { "CatDataframeanalyticsResponseExample1": { "description": "A successful response from `GET _cat/ml/data_frame/analytics?v=true&format=json`.", - "method_request": "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]" } }, @@ -101600,6 +101725,11 @@ "kind": "no_body" }, "description": "Get datafeeds.\n\nGet configuration and usage information about datafeeds.\nThis API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get datafeed statistics API.", + "examples": { + "CatDatafeedsRequestExample1": { + "method_request": "GET _cat/ml/datafeeds?v=true&format=json" + } + }, "inherits": { "type": { "name": "CatRequestBase", @@ -101697,7 +101827,6 @@ "examples": { "CatDatafeedsResponseExample1": { "description": "A successful response from `GET _cat/ml/datafeeds?v=true&format=json`.", - "method_request": "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]" } }, @@ -102679,6 +102808,11 @@ "kind": "no_body" }, "description": "Get anomaly detection jobs.\n\nGet configuration and usage information for anomaly detection jobs.\nThis API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get anomaly detection job statistics API.", + "examples": { + "CatJobsRequestExample1": { + "method_request": "GET _cat/ml/anomaly_detectors?h=id,s,dpr,mb&v=true&format=json" + } + }, "inherits": { "type": { "name": "CatRequestBase", @@ -102788,7 +102922,6 @@ "examples": { "CatJobsResponseExample1": { "description": "A successful response from `GET _cat/ml/anomaly_detectors?h=id,s,dpr,mb&v=true&format=json`.", - "method_request": "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]" } }, @@ -102808,6 +102941,11 @@ "kind": "no_body" }, "description": "Get trained models.\n\nGet configuration and usage information about inference trained models.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get trained models statistics API.", + "examples": { + "CatTrainedModelsRequestExample1": { + "method_request": "GET _cat/ml/trained_models?v=true&format=json" + } + }, "inherits": { "type": { "name": "CatRequestBase", @@ -102940,7 +103078,6 @@ "examples": { "CatTrainedModelsResponseExample1": { "description": "A successful response from `GET _cat/ml/trained_models?v=true&format=json`.", - "method_request": "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]" } }, @@ -103363,6 +103500,11 @@ "kind": "no_body" }, "description": "Get node attribute information.\n\nGet information about custom node attributes.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", + "examples": { + "CatNodeAttributesRequestExample1": { + "method_request": "GET /_cat/nodeattrs?v=true&format=json" + } + }, "inherits": { "type": { "name": "CatRequestBase", @@ -103447,13 +103589,11 @@ "examples": { "CatNodeAttributesResponseExample1": { "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", - "method_request": "GET /_cat/nodeattrs?v=true&format=json", "summary": "Default columns", "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", - "method_request": "GET /_cat/nodeattrs?v=true&h=name,pid,attr,value", "summary": "Explicit columns", "value": "[\n {\n \"name\": \"node-0\",\n \"pid\": \"19566\",\n \"attr\": \"testattr\",\n \"value\": \"test\"\n }\n]" } @@ -104989,6 +105129,11 @@ "kind": "no_body" }, "description": "Get node information.\n\nGet information about the nodes in a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", + "examples": { + "CatNodesRequestExample2": { + "method_request": "GET /_cat/nodes?v=true&h=id,ip,port,v,m&format=json" + } + }, "inherits": { "type": { "name": "CatRequestBase", @@ -105123,13 +105268,11 @@ "examples": { "CatNodesResponseExample1": { "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", - "method_request": "GET /_cat/nodes?v=true&format=json", "summary": "Default columns", "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&format=json`. It returns the `id`, `ip`, `port`, `v` (version), and `m` (master) columns.\n", - "method_request": "GET /_cat/nodes?v=true&h=id,ip,port,v,m&format=json", "summary": "Explicit columns", "value": "[\n {\n \"id\": \"veJR\",\n \"ip\": \"127.0.0.1\",\n \"port\": \"59938\",\n \"v\": \"9.0.0\",\n \"m\": \"*\"\n }\n]" } @@ -105220,6 +105363,11 @@ "kind": "no_body" }, "description": "Get pending task information.\n\nGet information about cluster-level changes that have not yet taken effect.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.", + "examples": { + "CatPendingTasksRequestExample1": { + "method_request": "GET /_cat/pending_tasks?v=trueh=insertOrder,timeInQueue,priority,source&format=json" + } + }, "inherits": { "type": { "name": "CatRequestBase", @@ -105316,7 +105464,6 @@ "examples": { "CatPendingTasksResponseExample1": { "description": "A successful response from `GET /_cat/pending_tasks?v=trueh=insertOrder,timeInQueue,priority,source&format=json`.\n", - "method_request": "GET /_cat/pending_tasks?v=trueh=insertOrder,timeInQueue,priority,source&format=json", "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]" } }, @@ -105433,6 +105580,11 @@ "kind": "no_body" }, "description": "Get plugin information.\n\nGet a list of plugins running on each node of a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", + "examples": { + "CatPluginsRequestExample1": { + "method_request": "GET /_cat/plugins?v=true&s=component&h=name,component,version,description&format=json" + } + }, "inherits": { "type": { "name": "CatRequestBase", @@ -105530,7 +105682,6 @@ "examples": { "CatPluginsResponseExample1": { "description": "A successful response from `GET /_cat/plugins?v=true&s=component&h=name,component,version,description&format=json`.\n", - "method_request": "GET /_cat/plugins?v=true&s=component&h=name,component,version,description&format=json", "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]" } }, @@ -105971,6 +106122,11 @@ "kind": "no_body" }, "description": "Get shard recovery information.\n\nGet information about ongoing and completed shard recoveries.\nShard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing.\nFor data streams, the API returns information about the stream’s backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.", + "examples": { + "CatRecoveryRequestExample1": { + "method_request": "GET _cat/recovery?v=true&format=json" + } + }, "inherits": { "type": { "name": "CatRequestBase", @@ -106104,19 +106260,16 @@ "examples": { "CatRecoveryResponseExample1": { "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", - "method_request": "GET _cat/recovery?v=true&format=json", "summary": "No ongoing recoveries", "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&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", - "method_request": "GET _cat/recovery?v=true&h=i,s,t,ty,st,shost,thost,f,fp,b,bp&format=json", "summary": "A live shard recovery", "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&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", - "method_request": "GET _cat/recovery?v=true&h=i,s,t,ty,st,rep,snap,f,fp,b,bp&format=json", "summary": "A snapshot recovery", "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]" } @@ -106177,6 +106330,11 @@ "kind": "no_body" }, "description": "Get snapshot repository information.\n\nGet a list of snapshot repositories for a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.", + "examples": { + "CatRepositoriesRequestExample1": { + "method_request": "GET /_cat/repositories?v=true&format=json" + } + }, "inherits": { "type": { "name": "CatRequestBase", @@ -106261,7 +106419,6 @@ "examples": { "CatRepositoriesResponseExample1": { "description": "A successful response from `GET /_cat/repositories?v=true&format=json`.\n", - "method_request": "GET /_cat/repositories?v=true&format=json", "value": "[\n {\n \"id\": \"repo1\",\n \"type\": \"fs\"\n },\n {\n \"id\": \"repo2\",\n \"type\": \"s3\"\n }\n]" } }, @@ -106281,6 +106438,11 @@ "kind": "no_body" }, "description": "Get segment information.\n\nGet low-level information about the Lucene segments in index shards.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.", + "examples": { + "CatSegmentsRequestExample1": { + "method_request": "GET /_cat/segments?v=true&format=json" + } + }, "inherits": { "type": { "name": "CatRequestBase", @@ -106390,7 +106552,6 @@ "examples": { "CatSegmentsResponseExample1": { "description": "A successful response from `GET /_cat/segments?v=true&format=json`.\n", - "method_request": "GET /_cat/segments?v=true&format=json", "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]" } }, @@ -106650,6 +106811,11 @@ "kind": "no_body" }, "description": "Get shard information.\n\nGet information about the shards in a cluster.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", + "examples": { + "CatShardsRequestExample1": { + "method_request": "GET _cat/shards?format=json" + } + }, "inherits": { "type": { "name": "CatRequestBase", @@ -106758,31 +106924,26 @@ "examples": { "CatShardsResponseExample1": { "description": "A successful response from `GET _cat/shards?format=json`.\n", - "method_request": "GET _cat/shards?format=json", "summary": "A single data stream or index", "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-*?format=json`. It returns information for any data streams or indices beginning with `my-index-`.\n", - "method_request": "GET _cat/shards/my-index-*?format=json", "summary": "A wildcard pattern", "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?format=json`. The `RELOCATING` value in the `state` column indicates the index shard is relocating.\n", - "method_request": "GET _cat/shards?format=json", "summary": "A relocating shard", "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?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", - "method_request": "GET _cat/shards?format=json", "summary": "Shard states", "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&format=json`. It includes the `unassigned.reason` column, which indicates why a shard is unassigned.\n", - "method_request": "GET _cat/shards?h=index,shard,prirep,state,unassigned.reason&format=json", "summary": "Reasons for unassigned shards", "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]" } @@ -108084,6 +108245,11 @@ "kind": "no_body" }, "description": "Get snapshot information.\n\nGet information about the snapshots stored in one or more repositories.\nA snapshot is a backup of an index or running Elasticsearch cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.", + "examples": { + "CatSnapshotsRequestExample1": { + "method_request": "GET /_cat/snapshots/repo1?v=true&s=id&format=json" + } + }, "inherits": { "type": { "name": "CatRequestBase", @@ -108193,7 +108359,6 @@ "examples": { "CatSnapshotsResponseExample1": { "description": "A successful response from `GET /_cat/snapshots/repo1?v=true&s=id&format=json`.\n", - "method_request": "GET /_cat/snapshots/repo1?v=true&s=id&format=json", "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]" } }, @@ -108459,6 +108624,11 @@ "kind": "no_body" }, "description": "Get task information.\n\nGet information about tasks currently running in the cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.", + "examples": { + "CatTasksRequestExample1": { + "method_request": "GET _cat/tasks?v=true&format=json" + } + }, "inherits": { "type": { "name": "CatRequestBase", @@ -108610,7 +108780,6 @@ "examples": { "CatTasksResponseExample1": { "description": "A successful response from `GET _cat/tasks?v=true&format=json`.", - "method_request": "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]" } }, @@ -108876,6 +109045,11 @@ "kind": "no_body" }, "description": "Get index template information.\n\nGet information about the index templates in a cluster.\nYou can use index templates to apply index settings and field mappings to new indices at creation.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.", + "examples": { + "CatTemplatesRequestExample1": { + "method_request": "GET _cat/templates/my-template-*?v=true&s=name&format=json" + } + }, "inherits": { "type": { "name": "CatRequestBase", @@ -108973,7 +109147,6 @@ "examples": { "CatTemplatesResponseExample1": { "description": "A successful response from `GET _cat/templates/my-template-*?v=true&s=name&format=json`.\n", - "method_request": "GET _cat/templates/my-template-*?v=true&s=name&format=json", "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]" } }, @@ -109091,6 +109264,11 @@ "kind": "no_body" }, "description": "Get thread pool statistics.\n\nGet thread pool statistics for each node in a cluster.\nReturned information includes all built-in thread pools and custom thread pools.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", + "examples": { + "CatThreadPoolRequestExample1": { + "method_request": "GET /_cat/thread_pool?format=json" + } + }, "inherits": { "type": { "name": "CatRequestBase", @@ -109200,13 +109378,11 @@ "examples": { "CatThreadPoolResponseExample1": { "description": "A successful response from `GET /_cat/thread_pool?format=json`.\n", - "method_request": "GET /_cat/thread_pool?format=json", "summary": "Default columns", "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&format=json`. It returns the `id`, `name`, `active`, `rejected`, and `completed` columns. It also limits returned information to the generic thread pool.\n", - "method_request": "GET /_cat/thread_pool/generic?v=true&h=id,name,active,rejected,completed&format=json", "summary": "Explicit columns", "value": "[\n {\n \"id\": \"0EWUhXeBQtaVGlexUeVwMg\",\n \"name\": \"generic\",\n \"active\": \"0\",\n \"rejected\": \"0\",\n \"completed\": \"70\"\n }\n]" } @@ -109585,6 +109761,11 @@ "kind": "no_body" }, "description": "Get transform information.\n\nGet configuration and usage information about transforms.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", + "examples": { + "CatTransformsRequestExample1": { + "method_request": "GET /_cat/transforms?v=true&format=json" + } + }, "inherits": { "type": { "name": "CatRequestBase", @@ -109708,7 +109889,6 @@ "examples": { "CatTransformsResponseExample1": { "description": "A successful response from `GET /_cat/transforms?v=true&format=json`.", - "method_request": "GET /_cat/transforms?v=true&format=json", "value": "[\n {\n \"id\" : \"ecommerce_transform\",\n \"state\" : \"started\",\n \"checkpoint\" : \"1\",\n \"documents_processed\" : \"705\",\n \"checkpoint_progress\" : \"100.00\",\n \"changes_last_detection_time\" : null\n }\n]" } }, @@ -110795,6 +110975,11 @@ "kind": "no_body" }, "description": "Delete auto-follow patterns.\n\nDelete a collection of cross-cluster replication auto-follow patterns.", + "examples": { + "DeleteAutoFollowPatternRequestExample1": { + "method_request": "DELETE /_ccr/auto_follow/my_auto_follow_pattern" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -110852,7 +111037,6 @@ "examples": { "DeleteAutoFollowPatternResponseExample1": { "description": "A successful response from `DELETE /_ccr/auto_follow/my_auto_follow_pattern`, which deletes an auto-follow pattern.", - "method_request": "DELETE /_ccr/auto_follow/my_auto_follow_pattern", "value": "{\n \"acknowledged\" : true\n}" } }, @@ -111144,7 +111328,6 @@ "examples": { "CreateFollowIndexResponseExample1": { "description": "A successful response from `PUT /follower_index/_ccr/follow?wait_for_active_shards=1`.", - "method_request": "PUT /follower_index/_ccr/follow?wait_for_active_shards=1", "value": "{\n \"follow_index_created\" : true,\n \"follow_index_shards_acked\" : true,\n \"index_following_started\" : true\n}" } }, @@ -111379,6 +111562,11 @@ "kind": "no_body" }, "description": "Get follower information.\n\nGet information about all cross-cluster replication follower indices.\nFor example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused.", + "examples": { + "FollowInfoRequestExample1": { + "method_request": "GET /follower_index/_ccr/info" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -111444,13 +111632,11 @@ "examples": { "FollowInfoResponseExample1": { "description": "A successful response from `GET /follower_index/_ccr/info` when the follower index is active.", - "method_request": "GET /follower_index/_ccr/info", "summary": "An active follower index", "value": "{\n \"follower_indices\": [\n {\n \"follower_index\": \"follower_index\",\n \"remote_cluster\": \"remote_cluster\",\n \"leader_index\": \"leader_index\",\n \"status\": \"active\",\n \"parameters\": {\n \"max_read_request_operation_count\": 5120,\n \"max_read_request_size\": \"32mb\",\n \"max_outstanding_read_requests\": 12,\n \"max_write_request_operation_count\": 5120,\n \"max_write_request_size\": \"9223372036854775807b\",\n \"max_outstanding_write_requests\": 9,\n \"max_write_buffer_count\": 2147483647,\n \"max_write_buffer_size\": \"512mb\",\n \"max_retry_delay\": \"500ms\",\n \"read_poll_timeout\": \"1m\"\n }\n }\n ]\n}" }, "FollowInfoResponseExample2": { "description": "A successful response from `GET /follower_index/_ccr/info` when the follower index is paused.", - "method_request": "GET /follower_index/_ccr/info", "summary": "A paused follower index", "value": "{\n \"follower_indices\": [\n {\n \"follower_index\": \"follower_index\",\n \"remote_cluster\": \"remote_cluster\",\n \"leader_index\": \"leader_index\",\n \"status\": \"paused\"\n }\n ]\n}" } @@ -111470,6 +111656,11 @@ "kind": "no_body" }, "description": "Get follower stats.\n\nGet cross-cluster replication follower stats.\nThe API returns shard-level stats about the \"following tasks\" associated with each shard for the specified indices.", + "examples": { + "FollowIndexStatsRequestExample1": { + "method_request": "GET /follower_index/_ccr/stats" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -111536,7 +111727,6 @@ "examples": { "FollowIndexStatsResponseExample1": { "description": "A successful response from `GET /follower_index/_ccr/stats`, which retrieves follower stats.", - "method_request": "GET /follower_index/_ccr/stats", "value": "{\n \"indices\" : [\n {\n \"index\" : \"follower_index\",\n \"total_global_checkpoint_lag\" : 256,\n \"shards\" : [\n {\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index\" : \"leader_index\",\n \"follower_index\" : \"follower_index\",\n \"shard_id\" : 0,\n \"leader_global_checkpoint\" : 1024,\n \"leader_max_seq_no\" : 1536,\n \"follower_global_checkpoint\" : 768,\n \"follower_max_seq_no\" : 896,\n \"last_requested_seq_no\" : 897,\n \"outstanding_read_requests\" : 8,\n \"outstanding_write_requests\" : 2,\n \"write_buffer_operation_count\" : 64,\n \"follower_mapping_version\" : 4,\n \"follower_settings_version\" : 2,\n \"follower_aliases_version\" : 8,\n \"total_read_time_millis\" : 32768,\n \"total_read_remote_exec_time_millis\" : 16384,\n \"successful_read_requests\" : 32,\n \"failed_read_requests\" : 0,\n \"operations_read\" : 896,\n \"bytes_read\" : 32768,\n \"total_write_time_millis\" : 16384,\n \"write_buffer_size_in_bytes\" : 1536,\n \"successful_write_requests\" : 16,\n \"failed_write_requests\" : 0,\n \"operations_written\" : 832,\n \"read_exceptions\" : [ ],\n \"time_since_last_read_millis\" : 8\n }\n ]\n }\n ]\n}" } }, @@ -111807,6 +111997,11 @@ "kind": "no_body" }, "description": "Get auto-follow patterns.\n\nGet cross-cluster replication auto-follow patterns.", + "examples": { + "GetAutoFollowPatternRequestExample1": { + "method_request": "GET /_ccr/auto_follow/my_auto_follow_pattern" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -111872,7 +112067,6 @@ "examples": { "GetAutoFollowPatternResponseExample1": { "description": "A successful response from `GET /_ccr/auto_follow/my_auto_follow_pattern`, which gets auto-follow patterns.", - "method_request": "GET /_ccr/auto_follow/my_auto_follow_pattern", "value": "{\n \"patterns\": [\n {\n \"name\": \"my_auto_follow_pattern\",\n \"pattern\": {\n \"active\": true,\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index_patterns\" :\n [\n \"leader_index*\"\n ],\n \"leader_index_exclusion_patterns\":\n [\n \"leader_index_001\"\n ],\n \"follow_index_pattern\" : \"{{leader_index}}-follower\"\n }\n }\n ]\n}" } }, @@ -111891,6 +112085,11 @@ "kind": "no_body" }, "description": "Pause an auto-follow pattern.\n\nPause a cross-cluster replication auto-follow pattern.\nWhen the API returns, the auto-follow pattern is inactive.\nNew indices that are created on the remote cluster and match the auto-follow patterns are ignored.\n\nYou can resume auto-following with the resume auto-follow pattern API.\nWhen it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns.\nRemote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim.", + "examples": { + "PauseAutoFollowPatternRequestExample1": { + "method_request": "POST /_ccr/auto_follow/my_auto_follow_pattern/pause" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -111948,7 +112147,6 @@ "examples": { "PauseAutoFollowPatternResponseExample1": { "description": "A successful response from `POST /_ccr/auto_follow/my_auto_follow_pattern/pause`, which pauses an auto-follow pattern.", - "method_request": "POST /_ccr/auto_follow/my_auto_follow_pattern/pause", "value": "{\n \"acknowledged\" : true\n}" } }, @@ -111967,6 +112165,11 @@ "kind": "no_body" }, "description": "Pause a follower.\n\nPause a cross-cluster replication follower index.\nThe follower index will not fetch any additional operations from the leader index.\nYou can resume following with the resume follower API.\nYou can pause and resume a follower index to change the configuration of the following task.", + "examples": { + "PauseFollowIndexRequestExample1": { + "method_request": "POST /follower_index/_ccr/pause_follow" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -112024,7 +112227,6 @@ "examples": { "PauseFollowIndexResponseExample1": { "description": "A successful response from `POST /follower_index/_ccr/pause_follow`, which pauses a follower index.", - "method_request": "POST /follower_index/_ccr/pause_follow", "value": "{\n \"acknowledged\" : true\n}" } }, @@ -112326,6 +112528,11 @@ "kind": "no_body" }, "description": "Resume an auto-follow pattern.\n\nResume a cross-cluster replication auto-follow pattern that was paused.\nThe auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster.\nRemote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim.", + "examples": { + "ResumeAutoFollowPatternRequestExample1": { + "method_request": "POST /_ccr/auto_follow/my_auto_follow_pattern/resume" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -112383,7 +112590,6 @@ "examples": { "ResumeAutoFollowPatternResponseExample1": { "description": "A successful response `POST /_ccr/auto_follow/my_auto_follow_pattern/resume`, which resumes an auto-follow pattern.\n", - "method_request": "POST /_ccr/auto_follow/my_auto_follow_pattern/resume", "value": "{\n \"acknowledged\" : true\n}" } }, @@ -112747,6 +112953,11 @@ "kind": "no_body" }, "description": "Get cross-cluster replication stats.\n\nThis API returns stats about auto-following and the same shard-level stats as the get follower stats API.", + "examples": { + "CcrStatsRequestExample1": { + "method_request": "GET /_ccr/stats" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -112822,7 +113033,6 @@ "examples": { "CcrStatsResponseExample1": { "description": "A successful response from `GET /_ccr/stats` that returns cross-cluster replication stats.", - "method_request": "GET /_ccr/stats", "value": "{\n \"auto_follow_stats\" : {\n \"number_of_failed_follow_indices\" : 0,\n \"number_of_failed_remote_cluster_state_requests\" : 0,\n \"number_of_successful_follow_indices\" : 1,\n \"recent_auto_follow_errors\" : [],\n \"auto_followed_clusters\" : []\n },\n \"follow_stats\" : {\n \"indices\" : [\n {\n \"index\" : \"follower_index\",\n \"total_global_checkpoint_lag\" : 256,\n \"shards\" : [\n {\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index\" : \"leader_index\",\n \"follower_index\" : \"follower_index\",\n \"shard_id\" : 0,\n \"leader_global_checkpoint\" : 1024,\n \"leader_max_seq_no\" : 1536,\n \"follower_global_checkpoint\" : 768,\n \"follower_max_seq_no\" : 896,\n \"last_requested_seq_no\" : 897,\n \"outstanding_read_requests\" : 8,\n \"outstanding_write_requests\" : 2,\n \"write_buffer_operation_count\" : 64,\n \"follower_mapping_version\" : 4,\n \"follower_settings_version\" : 2,\n \"follower_aliases_version\" : 8,\n \"total_read_time_millis\" : 32768,\n \"total_read_remote_exec_time_millis\" : 16384,\n \"successful_read_requests\" : 32,\n \"failed_read_requests\" : 0,\n \"operations_read\" : 896,\n \"bytes_read\" : 32768,\n \"total_write_time_millis\" : 16384,\n \"write_buffer_size_in_bytes\" : 1536,\n \"successful_write_requests\" : 16,\n \"failed_write_requests\" : 0,\n \"operations_written\" : 832,\n \"read_exceptions\" : [ ],\n \"time_since_last_read_millis\" : 8\n }\n ]\n }\n ]\n }\n}" } }, @@ -112841,6 +113051,11 @@ "kind": "no_body" }, "description": "Unfollow an index.\n\nConvert a cross-cluster replication follower index to a regular index.\nThe API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.\nThe follower index must be paused and closed before you call the unfollow API.\n\n> info\n> Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation.", + "examples": { + "UnfollowIndexRequestExample1": { + "method_request": "POST /follower_index/_ccr/unfollow" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -112898,7 +113113,6 @@ "examples": { "UnfollowIndexResponseExample1": { "description": "A successful response from `POST /follower_index/_ccr/unfollow`.", - "method_request": "POST /follower_index/_ccr/unfollow", "value": "{\n \"acknowledged\" : true\n}" } }, @@ -114405,6 +114619,11 @@ "kind": "no_body" }, "description": "Delete component templates.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.", + "examples": { + "ClusterDeleteComponentTemplateExample1": { + "method_request": "DELETE _component_template/template_1" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -114622,6 +114841,11 @@ "kind": "no_body" }, "description": "Get component templates.\nGet information about component templates.", + "examples": { + "ClusterGetComponentTemplateExample1": { + "method_request": "GET /_component_template/template_1" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -114747,6 +114971,11 @@ "kind": "no_body" }, "description": "Get cluster-wide settings.\nBy default, it returns only settings that have been explicitly defined.", + "examples": { + "ClusterGetSettingsExample1": { + "method_request": "GET /_cluster/settings?filter_path=persistent.cluster.remote" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -115280,6 +115509,11 @@ "kind": "no_body" }, "description": "Get the cluster health status.\n\nYou can also use the API to get the health status of only specified data streams and indices.\nFor data streams, the API retrieves the health status of the stream’s backing indices.\n\nThe cluster health status is: green, yellow or red.\nOn the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated.\nThe index level status is controlled by the worst shard status.\n\nOne of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level.\nThe cluster status is controlled by the worst index status.", + "examples": { + "ClusterHealthRequestExample1": { + "method_request": "GET _cluster/health" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -115463,7 +115697,6 @@ "examples": { "ClusterHealthResponseExample1": { "description": "A successful response from `GET _cluster/health`. It is the health status of a quiet single node cluster with a single index with one shard and one replica.\n", - "method_request": "GET _cluster/health", "value": "{\n \"cluster_name\" : \"testcluster\",\n \"status\" : \"yellow\",\n \"timed_out\" : false,\n \"number_of_nodes\" : 1,\n \"number_of_data_nodes\" : 1,\n \"active_primary_shards\" : 1,\n \"active_shards\" : 1,\n \"relocating_shards\" : 0,\n \"initializing_shards\" : 0,\n \"unassigned_shards\" : 1,\n \"delayed_unassigned_shards\": 0,\n \"number_of_pending_tasks\" : 0,\n \"number_of_in_flight_fetch\": 0,\n \"task_max_waiting_in_queue_millis\": 0,\n \"active_shards_percent_as_number\": 50.0\n}" } }, @@ -115613,6 +115846,11 @@ "kind": "no_body" }, "description": "Get cluster info.\nReturns basic information about the cluster.", + "examples": { + "ClusterInfoExample1": { + "method_request": "GET /_info/_all" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -115819,6 +116057,11 @@ "kind": "no_body" }, "description": "Get the pending cluster tasks.\nGet information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect.\n\nNOTE: This API returns a list of any pending updates to the cluster state.\nThese are distinct from the tasks reported by the task management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.\nHowever, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API.", + "examples": { + "ClusterPendingTasksExample1": { + "method_request": "GET /_cluster/pending_tasks" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -116543,6 +116786,11 @@ "kind": "no_body" }, "description": "Get remote cluster information.\n\nGet information about configured remote clusters.\nThe API returns connection and endpoint information keyed by the configured remote cluster alias.\n\n> info\n> This API returns information that reflects current state on the local cluster.\n> The `connected` field does not necessarily reflect whether a remote cluster is down or unavailable, only whether there is currently an open connection to it.\n> Elasticsearch does not spontaneously try to reconnect to a disconnected remote cluster.\n> To trigger a reconnection, attempt a cross-cluster search, ES|QL cross-cluster search, or try the [resolve cluster endpoint](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster).", + "examples": { + "ClusterRemoteInfoExample1": { + "method_request": "GET /_remote/info" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -117213,6 +117461,11 @@ "kind": "no_body" }, "description": "Get the cluster state.\nGet comprehensive information about the state of the cluster.\n\nThe cluster state is an internal data structure which keeps track of a variety of information needed by every node, including the identity and attributes of the other nodes in the cluster; cluster-wide settings; index metadata, including the mapping and settings for each index; the location and status of every shard copy in the cluster.\n\nThe elected master node ensures that every node in the cluster has a copy of the same cluster state.\nThis API lets you retrieve a representation of this internal state for debugging or diagnostic purposes.\nYou may need to consult the Elasticsearch source code to determine the precise meaning of the response.\n\nBy default the API will route requests to the elected master node since this node is the authoritative source of cluster states.\nYou can also retrieve the cluster state held on the node handling the API request by adding the `?local=true` query parameter.\n\nElasticsearch may need to expend significant effort to compute a response to this API in larger clusters, and the response may comprise a very large quantity of data.\nIf you use this API repeatedly, your cluster may become unstable.\n\nWARNING: The response is a representation of an internal data structure.\nIts format is not subject to the same compatibility guarantees as other more stable APIs and may change from version to version.\nDo not query this API using external monitoring tools.\nInstead, obtain the information you require using other more stable cluster APIs.", + "examples": { + "ClusterStateExample1": { + "method_request": "GET /_cluster/state?filter_path=metadata.cluster_coordination.last_committed_config" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -119975,6 +120228,11 @@ "kind": "no_body" }, "description": "Get cluster statistics.\nGet basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).", + "examples": { + "ClusterStatsExample1": { + "method_request": "GET _cluster/stats?human&filter_path=indices.mappings.total_deduplicated_mapping_size*" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -122419,6 +122677,11 @@ "kind": "no_body" }, "description": "Check in a connector.\n\nUpdate the `last_seen` field in the connector and set it to the current timestamp.", + "examples": { + "ConnectorCheckInExample1": { + "method_request": "PUT _connector/my-connector/_check_in" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -122484,6 +122747,11 @@ "kind": "no_body" }, "description": "Delete a connector.\n\nRemoves a connector and associated sync jobs.\nThis is a destructive action that is not recoverable.\nNOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector.\nThese need to be removed manually.", + "examples": { + "ConnectorDeleteExample1": { + "method_request": "DELETE _connector/my-connector-id&delete_sync_jobs=true" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -122570,6 +122838,11 @@ "kind": "no_body" }, "description": "Get a connector.\n\nGet the details about a connector.", + "examples": { + "ConnectorGetExample1": { + "method_request": "GET _connector/my-connector-id" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -122835,6 +123108,11 @@ "kind": "no_body" }, "description": "Get all connectors.\n\nGet information about all connectors.", + "examples": { + "ConnectorListExample1": { + "method_request": "GET _connector" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -123262,6 +123540,11 @@ "kind": "no_body" }, "description": "Cancel a connector sync job.\n\nCancel a connector sync job, which sets the status to cancelling and updates `cancellation_requested_at` to the current time.\nThe connector service is then responsible for setting the status of connector sync jobs to cancelled.", + "examples": { + "ConnectorSyncJobCancelExample1": { + "method_request": "PUT _connector/_sync_job/my-connector-sync-job-id/_cancel" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -123322,6 +123605,11 @@ "kind": "no_body" }, "description": "Check in a connector sync job.\nCheck in a connector sync job and set the `last_seen` field to the current time before updating it in the internal index.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.", + "examples": { + "ConnectorSyncJobCheckInExample1": { + "method_request": "PUT _connector/_sync_job/my-connector-sync-job/_check_in" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -123392,6 +123680,13 @@ ] }, "description": "Claim a connector sync job.\nThis action updates the job status to `in_progress` and sets the `last_seen` and `started_at` timestamps to the current time.\nAdditionally, it can set the `sync_cursor` property for the sync job.\n\nThis API is not intended for direct connector management by users.\nIt supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.", + "examples": { + "ConnectorSyncJobClaimExample1": { + "description": "An example body for a `PUT _connector/_sync_job/my-connector-sync-job-id/_claim` request.", + "method_request": "PUT _connector/_sync_job/my-connector-sync-job-id/_claim", + "value": "{\n \"worker_hostname\": \"some-machine\"\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -123440,6 +123735,11 @@ "kind": "no_body" }, "description": "Delete a connector sync job.\n\nRemove a connector sync job and its associated data.\nThis is a destructive action that is not recoverable.", + "examples": { + "ConnectorSyncJobDeleteExample1": { + "method_request": "DELETE _connector/_sync_job/my-connector-sync-job-id" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -123568,6 +123868,11 @@ "kind": "no_body" }, "description": "Get a connector sync job.", + "examples": { + "ConnectorSyncJobGetExample1": { + "method_request": "GET _connector/_sync_job/my-connector-sync-job" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -123623,6 +123928,11 @@ "kind": "no_body" }, "description": "Get all connector sync jobs.\n\nGet information about all stored connector sync jobs listed by their creation date in ascending order.", + "examples": { + "ConnectorSyncJobListExample1": { + "method_request": "GET _connector/_sync_job?connector_id=my-connector-id&size=1" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -123923,6 +124233,13 @@ ] }, "description": "Set the connector sync job stats.\nStats include: `deleted_document_count`, `indexed_document_count`, `indexed_document_volume`, and `total_document_count`.\nYou can also update `last_seen`.\nThis API is mainly used by the connector service for updating sync job information.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.", + "examples": { + "ConnectorSyncJobUpdateStatsExample1": { + "description": "An example body for a `PUT _connector/_sync_job/my-connector-sync-job/_stats` request.", + "method_request": "PUT _connector/_sync_job/my-connector-sync-job/_stats", + "value": "{\n \"deleted_document_count\": 10,\n \"indexed_document_count\": 20,\n \"indexed_document_volume\": 1000,\n \"total_document_count\": 2000,\n \"last_seen\": \"2023-01-02T10:00:00Z\"\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -125203,6 +125520,11 @@ "kind": "no_body" }, "description": "Delete a dangling index.\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.", + "examples": { + "DanglingIndicesDeleteDanglingIndexExample1": { + "method_request": "DELETE /_dangling/?accept_data_loss=true" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -125295,6 +125617,11 @@ "kind": "no_body" }, "description": "Import a dangling index.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.", + "examples": { + "ImportDanglingIndexRequestExample1": { + "method_request": "POST /_dangling/zmM4e0JtBkeUjiHD-MihPQ?accept_data_loss=true" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -125375,7 +125702,6 @@ "examples": { "ImportDanglingIndexResponseExample1": { "description": "A successful response from `POST /_dangling/zmM4e0JtBkeUjiHD-MihPQ?accept_data_loss=true`.\n", - "method_request": "POST /_dangling/zmM4e0JtBkeUjiHD-MihPQ?accept_data_loss=true", "value": "{\n \"acknowledged\": true\n}" } }, @@ -125457,6 +125783,11 @@ "kind": "no_body" }, "description": "Get the dangling indices.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.\n\nUse this API to list dangling indices, which you can then import or delete.", + "examples": { + "DanglingIndicesListDanglingIndicesExample1": { + "method_request": "GET /_dangling" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -125639,6 +125970,11 @@ "kind": "no_body" }, "description": "Delete an enrich policy.\nDeletes an existing enrich policy and its enrich index.", + "examples": { + "EnrichDeletePolicyExample1": { + "method_request": "DELETE /_enrich/policy/my-policy" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -125765,6 +126101,11 @@ "kind": "no_body" }, "description": "Run an enrich policy.\nCreate the enrich index for an existing enrich policy.", + "examples": { + "EnrichExecutePolicyExample1": { + "method_request": "PUT /_enrich/policy/my-policy/_execute?wait_for_completion=false" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -125863,6 +126204,11 @@ "kind": "no_body" }, "description": "Get an enrich policy.\nReturns information about an enrich policy.", + "examples": { + "EnrichGetPolicyExample1": { + "method_request": "GET /_enrich/policy/my-policy" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -125978,6 +126324,13 @@ ] }, "description": "Create an enrich policy.\nCreates an enrich policy.", + "examples": { + "EnrichPutPolicyExample1": { + "description": "An example body for a `PUT /_enrich/policy/postal_policy` request.", + "method_request": "PUT /_enrich/policy/postal_policy", + "value": "{\n \"geo_match\": {\n \"indices\": \"postal_codes\",\n \"match_field\": \"location\",\n \"enrich_fields\": [ \"location\", \"postal_code\" ]\n }\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -126260,6 +126613,11 @@ "kind": "no_body" }, "description": "Get enrich stats.\nReturns enrich coordinator statistics and information about enrich policies that are currently executing.", + "examples": { + "EnrichStatsExample1": { + "method_request": "GET /_enrich/_stats" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -126700,6 +127058,11 @@ "kind": "no_body" }, "description": "Delete an async EQL search.\nDelete an async EQL search or a stored synchronous EQL search.\nThe API also deletes results for the search.", + "examples": { + "EqlDeleteExample1": { + "method_request": "DELETE /_eql/search/FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -126755,6 +127118,11 @@ "kind": "no_body" }, "description": "Get async EQL search results.\nGet the current status and available results for an async EQL search or a stored synchronous EQL search.", + "examples": { + "EqlGetExample1": { + "method_request": "GET /_eql/search/FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=?wait_for_completion_timeout=2s" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -126850,6 +127218,11 @@ "kind": "no_body" }, "description": "Get the async EQL status.\nGet the current status for an async EQL search or a stored synchronous EQL search without returning results.", + "examples": { + "EqlGetStatusExample1": { + "method_request": "GET /_eql/search/status/FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -128424,6 +128797,11 @@ "kind": "no_body" }, "description": "Delete an async ES|QL query.\nIf the query is still running, it is cancelled.\nOtherwise, the stored results are deleted.\n\nIf the Elasticsearch security features are enabled, only the following users can use this API to delete a query:\n\n* The authenticated user that submitted the original query request\n* Users with the `cancel_task` cluster privilege", + "examples": { + "EsqlAsyncQueryDeleteExample1": { + "method_request": "DELETE /_query/async/FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -128479,6 +128857,11 @@ "kind": "no_body" }, "description": "Get async ES|QL query results.\nGet the current status and available results or stored results for an ES|QL asynchronous query.\nIf the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can retrieve the results using this API.", + "examples": { + "EsqlAsyncQueryGetExample1": { + "method_request": "GET /_query/async/FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=?wait_for_completion_timeout=30s" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -128572,6 +128955,11 @@ "kind": "no_body" }, "description": "Stop async ES|QL query.\n\nThis API interrupts the query execution and returns the results so far.\nIf the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can stop it.", + "examples": { + "EsqlAsyncQueryStopExample1": { + "method_request": "POST /_query/async/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=/stop" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -128885,6 +129273,11 @@ "kind": "no_body" }, "description": "Get the features.\nGet a list of features that can be included in snapshots using the `feature_states` field when creating a snapshot.\nYou can use this API to determine which feature states to include when taking a snapshot.\nBy default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not.\n\nA feature state includes one or more system indices necessary for a given feature to function.\nIn order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together.\n\nThe features listed by this API are a combination of built-in features and features defined by plugins.\nIn order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node.", + "examples": { + "FeaturesGetFeaturesExample1": { + "method_request": "GET _features" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -128955,6 +129348,11 @@ "kind": "no_body" }, "description": "Reset the features.\nClear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices.\n\nWARNING: Intended for development and testing use only. Do not reset features on a production cluster.\n\nReturn a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features.\nThis deletes all state information stored in system indices.\n\nThe response code is HTTP 200 if the state is successfully reset for all features.\nIt is HTTP 500 if the reset operation failed for any feature.\n\nNote that select features might provide a way to reset particular system indices.\nUsing this API resets all features, both those that are built-in and implemented as plugins.\n\nTo list the features that will be affected, use the get features API.\n\nIMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes.", + "examples": { + "FeaturesResetFeaturesExample1": { + "method_request": "POST /_features/_reset" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -131977,6 +132375,11 @@ "kind": "no_body" }, "description": "Delete a lifecycle policy.\nYou cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error.", + "examples": { + "IlmDeleteLifecycleExample1": { + "method_request": "DELETE _ilm/policy/my_policy" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -132552,6 +132955,11 @@ "kind": "no_body" }, "description": "Explain the lifecycle state.\nGet the current lifecycle status for one or more indices.\nFor data streams, the API retrieves the current lifecycle status for the stream's backing indices.\n\nThe response indicates when the index entered each lifecycle state, provides the definition of the running phase, and information about any failures.", + "examples": { + "IlmExplainLifecycleExample1": { + "method_request": "GET .ds-timeseries-*/_ilm/explain" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -132710,6 +133118,11 @@ "kind": "no_body" }, "description": "Get lifecycle policies.", + "examples": { + "IlmGetLifecycleExample1": { + "method_request": "GET _ilm/policy/my_policy" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -132810,6 +133223,11 @@ "kind": "no_body" }, "description": "Get the ILM status.\n\nGet the current index lifecycle management status.", + "examples": { + "IlmGetStatusExample1": { + "method_request": "GET _ilm/status" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -133313,6 +133731,11 @@ "kind": "no_body" }, "description": "Remove policies from an index.\nRemove the assigned lifecycle policies from an index or a data stream's backing indices.\nIt also stops managing the indices.", + "examples": { + "IlmRemovePolicyExample1": { + "method_request": "POST logs-my_app-default/_ilm/remove" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -133393,6 +133816,11 @@ "kind": "no_body" }, "description": "Retry a policy.\nRetry running the lifecycle policy for an index that is in the ERROR step.\nThe API sets the policy back to the step where the error occurred and runs the step.\nUse the explain lifecycle state API to determine whether an index is in the ERROR step.", + "examples": { + "IlmRetryExample1": { + "method_request": "POST /my-index-000001/_ilm/retry" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -133448,6 +133876,11 @@ "kind": "no_body" }, "description": "Start the ILM plugin.\nStart the index lifecycle management plugin if it is currently stopped.\nILM is started automatically when the cluster is formed.\nRestarting ILM is necessary only when it has been stopped using the stop ILM API.", + "examples": { + "IlmStartExample1": { + "method_request": "POST _ilm/start" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -133523,6 +133956,11 @@ "kind": "no_body" }, "description": "Stop the ILM plugin.\nHalt all lifecycle management operations and stop the index lifecycle management plugin.\nThis is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices.\n\nThe API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped.\nUse the get ILM status API to check whether ILM is running.", + "examples": { + "IlmStopExample1": { + "method_request": "POST _ilm/stop" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -138199,6 +138637,11 @@ "kind": "no_body" }, "description": "Add an index block.\n\nAdd an index block to an index.\nIndex blocks limit the operations allowed on an index by blocking specific operation types.", + "examples": { + "IndicesAddBlockRequestExample1": { + "method_request": "PUT /my-index-000001/_block/write" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -138350,7 +138793,6 @@ "examples": { "IndicesAddBlockResponseExample1": { "description": "A successful response from `PUT /my-index-000001/_block/write`, which adds an index block to an index.'", - "method_request": "PUT /my-index-000001/_block/write", "value": "{\n \"acknowledged\" : true,\n \"shards_acknowledged\" : true,\n \"indices\" : [ {\n \"name\" : \"my-index-000001\",\n \"blocked\" : true\n } ]\n}" } }, @@ -139058,6 +139500,11 @@ "kind": "no_body" }, "description": "Cancel a migration reindex operation.\n\nCancel a migration reindex attempt for a data stream or index.", + "examples": { + "IndicesCancelMigrateReindexExample1": { + "method_request": "POST /_migration/reindex/my-data-stream/_cancel" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -139113,6 +139560,11 @@ "kind": "no_body" }, "description": "Clear the cache.\nClear the cache of one or more indices.\nFor data streams, the API clears the caches of the stream's backing indices.\n\nBy default, the clear cache API clears all caches.\nTo clear only specific caches, use the `fielddata`, `query`, or `request` parameters.\nTo clear the cache only of specific fields, use the `fields` parameter.", + "examples": { + "IndicesClearCacheExample1": { + "method_request": "POST /my-index-000001,my-index-000002/_cache/clear?request=true" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -139525,6 +139977,11 @@ "kind": "no_body" }, "description": "Close an index.\nA closed index is blocked for read or write operations and does not allow all operations that opened indices allow.\nIt is not possible to index documents or to search for documents in a closed index.\nClosed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster.\n\nWhen opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index.\nThe shards will then go through the normal recovery process.\nThe data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times.\n\nYou can open and close multiple indices.\nAn error is thrown if the request explicitly refers to a missing index.\nThis behaviour can be turned off using the `ignore_unavailable=true` parameter.\n\nBy default, you must explicitly name the indices you are opening or closing.\nTo open or close indices with `_all`, `*`, or other wildcard expressions, change the` action.destructive_requires_name` setting to `false`. This setting can also be changed with the cluster update settings API.\n\nClosed indices consume a significant amount of disk-space which can cause problems in managed environments.\nClosing indices can be turned off with the cluster settings API by setting `cluster.indices.close.enable` to `false`.", + "examples": { + "CloseIndexRequestExample1": { + "method_request": "POST /my-index-00001/_close" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -139896,6 +140353,11 @@ "kind": "no_body" }, "description": "Create a data stream.\n\nYou must have a matching index template with data stream enabled.", + "examples": { + "IndicesCreateDataStreamExample1": { + "method_request": "PUT _data_stream/logs-foo-bar" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -140033,6 +140495,11 @@ } }, "description": "Create an index from a source index.\n\nCopy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values.", + "examples": { + "IndicesCreateFromExample1": { + "method_request": "POST _create_from/my-index/my-new-index" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -140206,6 +140673,11 @@ "kind": "no_body" }, "description": "Get data stream stats.\n\nGet statistics for one or more data streams.", + "examples": { + "indicesDataStreamStatsExampleRequest1": { + "method_request": "GET /_data_stream/my-index-000001/_stats" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -140350,6 +140822,11 @@ "kind": "no_body" }, "description": "Delete indices.\nDeleting an index deletes its documents, shards, and metadata.\nIt does not delete related Kibana components, such as data views, visualizations, or dashboards.\n\nYou cannot delete the current write index of a data stream.\nTo delete the index, you must roll over the data stream so a new write index is created.\nYou can then use the delete index API to delete the previous write index.", + "examples": { + "IndicesDeleteExample1": { + "method_request": "DELETE /books" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -140471,6 +140948,11 @@ "kind": "no_body" }, "description": "Delete an alias.\nRemoves a data stream or index from an alias.", + "examples": { + "IndicesDeleteAliasExample1": { + "method_request": "DELETE my-data-stream/_alias/my-alias" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -140565,6 +141047,11 @@ "kind": "no_body" }, "description": "Delete data stream lifecycles.\nRemoves the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.", + "examples": { + "IndicesDeleteDataLifecycleExample1": { + "method_request": "DELETE _data_stream/my-data-stream/_lifecycle" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -140663,6 +141150,11 @@ "kind": "no_body" }, "description": "Delete data streams.\nDeletes one or more data streams and their backing indices.", + "examples": { + "IndicesDeleteDataStreamExample1": { + "method_request": "DELETE _data_stream/my-data-stream" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -140745,6 +141237,11 @@ "kind": "no_body" }, "description": "Delete an index template.\nThe provided may contain multiple template names separated by a comma. If multiple template\nnames are specified then there is no wildcard support and the provided names should match completely with\nexisting templates.", + "examples": { + "IndicesDeleteIndexTemplateExample1": { + "method_request": "DELETE /_index_template/my-index-template" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -140831,6 +141328,11 @@ "version": "7.8.0" }, "description": "Delete a legacy index template.\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.", + "examples": { + "IndicesDeleteTemplateExample1": { + "method_request": "DELETE _template/.cloud-hot-warm-allocation-0" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -140913,6 +141415,11 @@ "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.", + "examples": { + "IndicesDiskUsageExample1": { + "method_request": "POST /my-index-000001/_disk_usage?run_expensive_tasks=true" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -141107,6 +141614,11 @@ "kind": "no_body" }, "description": "Check indices.\nCheck if one or more indices, index aliases, or data streams exist.", + "examples": { + "IndicesExistsExample1": { + "method_request": "HEAD my-data-stream" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -141233,6 +141745,11 @@ "kind": "no_body" }, "description": "Check aliases.\n\nCheck if one or more data stream or index aliases exist.", + "examples": { + "IndicesExistsAliasExample1": { + "method_request": "HEAD _alias/my-alias" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -141432,6 +141949,11 @@ "kind": "no_body" }, "description": "Check existence of index templates.\nGet information about whether index templates exist.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.", + "examples": { + "IndicesExistsTemplateExample1": { + "method_request": "HEAD /_template/template_1" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -141646,6 +142168,11 @@ "kind": "no_body" }, "description": "Get the status for a data stream lifecycle.\nGet information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.", + "examples": { + "IndicesExplainDataLifecycleRequestExample1": { + "method_request": "GET .ds-metrics-2023.03.22-000001/_lifecycle/explain" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -141730,7 +142257,6 @@ "examples": { "IndicesExplainDataLifecycleResponseExample1": { "description": "A successful response from `GET .ds-metrics-2023.03.22-000001/_lifecycle/explain`, which retrieves the lifecycle status for a data stream backing index. If the index is managed by a data stream lifecycle, the API will show the `managed_by_lifecycle` field set to `true` and the rest of the response will contain information about the lifecycle execution status for this index.\n", - "method_request": "GET .ds-metrics-2023.03.22-000001/_lifecycle/explain", "summary": "Successful response", "value": "{\n \"indices\": {\n \".ds-metrics-2023.03.22-000001\": {\n \"index\" : \".ds-metrics-2023.03.22-000001\",\n \"managed_by_lifecycle\" : true,\n \"index_creation_date_millis\" : 1679475563571,\n \"time_since_index_creation\" : \"843ms\",\n \"rollover_date_millis\" : 1679475564293,\n \"time_since_rollover\" : \"121ms\",\n \"lifecycle\" : { },\n \"generation_time\" : \"121ms\"\n }\n}" }, @@ -141992,6 +142518,11 @@ "kind": "no_body" }, "description": "Get field usage stats.\nGet field usage information for each shard and field of an index.\nField usage statistics are automatically captured when queries are running on a cluster.\nA shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use.\n\nThe response body reports the per-shard usage count of the data structures that back the fields in the index.\nA given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times.", + "examples": { + "indicesFieldUsageStatsRequestExample1": { + "method_request": "GET /my-index-000001/_field_usage_stats" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -142085,7 +142616,6 @@ "examples": { "indicesFieldUsageStatsResponseExample1": { "description": "An abbreviated response from `GET /my-index-000001/_field_usage_stats`. The `all_fields` object reports the sums of the usage counts for all fields in the index (on the listed shard).\n", - "method_request": "GET /my-index-000001/_field_usage_stats", "value": "{\n \"_shards\": {\n \"total\": 1,\n \"successful\": 1,\n \"failed\": 0\n },\n \"my-index-000001\": {\n \"shards\": [\n {\n \"tracking_id\": \"MpOl0QlTQ4SYYhEe6KgJoQ\",\n \"tracking_started_at_millis\": 1625558985010,\n \"routing\": {\n \"state\": \"STARTED\",\n \"primary\": true,\n \"node\": \"gA6KeeVzQkGURFCUyV-e8Q\",\n \"relocating_node\": null\n },\n \"stats\": {\n \"all_fields\": {\n \"any\": \"6\",\n \"inverted_index\": {\n \"terms\": 1,\n \"postings\": 1,\n \"proximity\": 1,\n \"positions\": 0,\n \"term_frequencies\": 1,\n \"offsets\": 0,\n \"payloads\": 0\n },\n \"stored_fields\": 2,\n \"doc_values\": 1,\n \"points\": 0,\n \"norms\": 1,\n \"term_vectors\": 0,\n \"knn_vectors\": 0\n },\n \"fields\": {\n \"_id\": {\n \"any\": 1,\n \"inverted_index\": {\n \"terms\": 1,\n \"postings\": 1,\n \"proximity\": 1,\n \"positions\": 0,\n \"term_frequencies\": 1,\n \"offsets\": 0,\n \"payloads\": 0\n },\n \"stored_fields\": 1,\n \"doc_values\": 0,\n \"points\": 0,\n \"norms\": 0,\n \"term_vectors\": 0,\n \"knn_vectors\": 0\n },\n \"_source\": {},\n \"context\": {},\n \"message.keyword\": {}\n }\n }\n }\n ]\n }\n}" } }, @@ -142234,6 +142764,11 @@ "kind": "no_body" }, "description": "Flush data streams or indices.\nFlushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index.\nWhen restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart.\nElasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush.\n\nAfter each operation has been flushed it is permanently stored in the Lucene index.\nThis may mean that there is no need to maintain an additional copy of it in the transaction log.\nThe transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space.\n\nIt is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly.\nIf you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called.", + "examples": { + "IndicesFlushExample1": { + "method_request": "POST /_flush" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -142355,6 +142890,11 @@ "kind": "no_body" }, "description": "Force a merge.\nPerform the force merge operation on the shards of one or more indices.\nFor data streams, the API forces a merge on the shards of the stream's backing indices.\n\nMerging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents.\nMerging normally happens automatically, but sometimes it is useful to trigger a merge manually.\n\nWARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes).\nWhen documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a \"tombstone\".\nThese soft-deleted documents are automatically cleaned up during regular segment merges.\nBut force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges.\nSo the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance.\nIf you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally.\n\n**Blocks during a force merge**\n\nCalls to this API block until the merge is complete (unless request contains `wait_for_completion=false`).\nIf the client connection is lost before completion then the force merge process will continue in the background.\nAny new requests to force merge the same indices will also block until the ongoing force merge is complete.\n\n**Running force merge asynchronously**\n\nIf the request contains `wait_for_completion=false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to get the status of the task.\nHowever, you can not cancel this task as the force merge task is not cancelable.\nElasticsearch creates a record of this task as a document at `_tasks/`.\nWhen you are done with a task, you should delete the task document so Elasticsearch can reclaim the space.\n\n**Force merging multiple indices**\n\nYou can force merge multiple indices with a single request by targeting:\n\n* One or more data streams that contain multiple backing indices\n* Multiple indices\n* One or more aliases\n* All data streams and indices in a cluster\n\nEach targeted shard is force-merged separately using the force_merge threadpool.\nBy default each node only has a single `force_merge` thread which means that the shards on that node are force-merged one at a time.\nIf you expand the `force_merge` threadpool on a node then it will force merge its shards in parallel\n\nForce merge makes the storage for the shard being merged temporarily increase, as it may require free space up to triple its size in case `max_num_segments parameter` is set to `1`, to rewrite all segments into a new one.\n\n**Data streams and time-based indices**\n\nForce-merging is useful for managing a data stream's older backing indices and other time-based indices, particularly after a rollover.\nIn these cases, each index only receives indexing traffic for a certain period of time.\nOnce an index receive no more writes, its shards can be force-merged to a single segment.\nThis can be a good idea because single-segment shards can sometimes use simpler and more efficient data structures to perform searches.\nFor example:\n\n```\nPOST /.ds-my-data-stream-2099.03.07-000001/_forcemerge?max_num_segments=1\n```", + "examples": { + "IndicesForcemergeExample1": { + "method_request": "POST my-index-000001/_forcemerge" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -142572,6 +143112,11 @@ "kind": "no_body" }, "description": "Get index information.\nGet information about one or more indices. For data streams, the API returns information about the\nstream’s backing indices.", + "examples": { + "IndicesGetExample1": { + "method_request": "GET /my-index-000001" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -142781,6 +143326,11 @@ "kind": "no_body" }, "description": "Get aliases.\nRetrieves information for one or more data stream or index aliases.", + "examples": { + "IndicesGetAliasExample1": { + "method_request": "GET _alias" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -142973,6 +143523,11 @@ "kind": "no_body" }, "description": "Get data stream lifecycles.\n\nGet the data stream lifecycle configuration of one or more data streams.", + "examples": { + "IndicesGetDataLifecycleRequestExample1": { + "method_request": "GET /_data_stream/{name}/_lifecycle?human&pretty" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -143063,8 +143618,7 @@ }, "examples": { "IndicesGetDataLifecycleResponseExample1": { - "description": "A successful response from `GET _lifecycle/stats?human&pretty`.", - "method_request": "GET _lifecycle/stats?human&pretty", + "description": "A successful response from `GET /_data_stream/{name}/_lifecycle?human&pretty`.", "value": "{\n \"data_streams\": [\n {\n \"name\": \"my-data-stream-1\",\n \"lifecycle\": {\n \"enabled\": true,\n \"data_retention\": \"7d\"\n }\n },\n {\n \"name\": \"my-data-stream-2\",\n \"lifecycle\": {\n \"enabled\": true,\n \"data_retention\": \"7d\"\n }\n }\n ]\n}" } }, @@ -143129,6 +143683,11 @@ "kind": "no_body" }, "description": "Get data stream lifecycle stats.\nGet statistics about the data streams that are managed by a data stream lifecycle.", + "examples": { + "IndicesGetDataLifecycleStatsRequestExample1": { + "method_request": "GET _lifecycle/stats?human&pretty" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -143222,7 +143781,6 @@ "examples": { "IndicesGetDataLifecycleStatsResponseExample1": { "description": "A successful response for `GET _lifecycle/stats?human&pretty`", - "method_request": "GET _lifecycle/stats?human&pretty", "value": "{\n \"last_run_duration_in_millis\": 2,\n \"last_run_duration\": \"2ms\",\n \"time_between_starts_in_millis\": 9998,\n \"time_between_starts\": \"9.99s\",\n \"data_streams_count\": 2,\n \"data_streams\": [\n {\n \"name\": \"my-data-stream\",\n \"backing_indices_in_total\": 2,\n \"backing_indices_in_error\": 0\n },\n {\n \"name\": \"my-other-stream\",\n \"backing_indices_in_total\": 2,\n \"backing_indices_in_error\": 1\n }\n ]\n}" } }, @@ -143241,6 +143799,11 @@ "kind": "no_body" }, "description": "Get data streams.\n\nGet information about one or more data streams.", + "examples": { + "IndicesGetDataStreamExample1": { + "method_request": "GET _data_stream/my-data-stream" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -143372,6 +143935,11 @@ "kind": "no_body" }, "description": "Get mapping definitions.\nRetrieves mapping definitions for one or more fields.\nFor data streams, the API retrieves field mappings for the stream’s backing indices.\n\nThis API is useful if you don't need a complete mapping or if an index mapping contains a large number of fields.", + "examples": { + "indicesGetFieldMappingRequestExample1": { + "method_request": "GET publications/_mapping/field/title" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -143504,19 +144072,16 @@ "examples": { "indicesGetFieldMappingResponseExample1": { "description": "A sucessful response from `GET publications/_mapping/field/title`, which returns the mapping of a field called `title`.\n", - "method_request": "GET publications/_mapping/field/title", "summary": "A single field mapping", "value": "{\n \"publications\": {\n \"mappings\": {\n \"title\": {\n \"full_name\": \"title\",\n \"mapping\": {\n \"title\": {\n \"type\": \"text\"\n }\n }\n }\n }\n }\n}" }, "indicesGetFieldMappingResponseExample2": { "description": "A successful response from `GET publications/_mapping/field/author.id,abstract,name`. The get field mapping API also supports wildcard notation.\n", - "method_request": "GET publications/_mapping/field/author.id,abstract,name", "summary": "Multiple field mappings", "value": "{\n \"publications\": {\n \"mappings\": {\n \"author.id\": {\n \"full_name\": \"author.id\",\n \"mapping\": {\n \"id\": {\n \"type\": \"text\"\n }\n }\n },\n \"abstract\": {\n \"full_name\": \"abstract\",\n \"mapping\": {\n \"abstract\": {\n \"type\": \"text\"\n }\n }\n }\n }\n }\n}" }, "indicesGetFieldMappingResponseExample3": { "description": "A successful response from `GET publications/_mapping/field/a*`.\n", - "method_request": "GET publications/_mapping/field/a*", "summary": "Wildcards", "value": "{\n \"publications\": {\n \"mappings\": {\n \"author.name\": {\n \"full_name\": \"author.name\",\n \"mapping\": {\n \"name\": {\n \"type\": \"text\"\n }\n }\n },\n \"abstract\": {\n \"full_name\": \"abstract\",\n \"mapping\": {\n \"abstract\": {\n \"type\": \"text\"\n }\n }\n },\n \"author.id\": {\n \"full_name\": \"author.id\",\n \"mapping\": {\n \"id\": {\n \"type\": \"text\"\n }\n }\n }\n }\n }\n}" } @@ -143600,6 +144165,11 @@ "kind": "no_body" }, "description": "Get index templates.\nGet information about one or more index templates.", + "examples": { + "IndicesGetIndexTemplateExample1": { + "method_request": "GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -143757,6 +144327,11 @@ "kind": "no_body" }, "description": "Get mapping definitions.\nFor data streams, the API retrieves mappings for the stream’s backing indices.", + "examples": { + "IndicesGetMappingExample1": { + "method_request": "GET /books/_mapping" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -143893,6 +144468,11 @@ "kind": "no_body" }, "description": "Get the migration reindexing status.\n\nGet the status of a migration reindex attempt for a data stream or index.", + "examples": { + "IndicesGetMigrateReindexStatusExample1": { + "method_request": "GET /_migration/reindex/my-data-stream/_status" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -144142,6 +144722,11 @@ "kind": "no_body" }, "description": "Get index settings.\nGet setting information for one or more indices.\nFor data streams, it returns setting information for the stream's backing indices.", + "examples": { + "IndicesGetSettingsExample1": { + "method_request": "GET _all/_settings?expand_wildcards=all&filter_path=*.settings.index.*.slowlog" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -144316,6 +144901,11 @@ "version": "7.8.0" }, "description": "Get legacy index templates.\nGet information about one or more index templates.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.", + "examples": { + "IndicesGetTemplateExample1": { + "method_request": "GET /_template/.monitoring-*" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -144477,6 +145067,13 @@ } }, "description": "Reindex legacy backing indices.\n\nReindex all legacy backing indices for a data stream.\nThis operation occurs in a persistent task.\nThe persistent task ID is returned immediately and the reindexing work is completed in that task.", + "examples": { + "IndicesMigrateReindexExample1": { + "description": "An example body for a `POST _migration/reindex` request.", + "method_request": "POST _migration/reindex", + "value": "{\n \"source\": {\n \"index\": \"my-data-stream\"\n },\n \"mode\": \"upgrade\"\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -144540,6 +145137,11 @@ "kind": "no_body" }, "description": "Convert an index alias to a data stream.\nConverts an index alias to a data stream.\nYou must have a matching index template that is data stream enabled.\nThe alias must meet the following criteria:\nThe alias must have a write index;\nAll indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;\nThe alias must not have any filters;\nThe alias must not use custom routing.\nIf successful, the request removes the alias and creates a data stream with the same name.\nThe indices for the alias become hidden backing indices for the stream.\nThe write index for the alias becomes the write index for the stream.", + "examples": { + "IndicesMigrateToDataStreamExample1": { + "method_request": "POST _data_stream/_migrate/my-time-series-data" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -144710,6 +145312,13 @@ ] }, "description": "Update data streams.\nPerforms one or more data stream modification actions in a single atomic operation.", + "examples": { + "IndicesModifyDataStreamExample1": { + "description": "An example body for a `POST _data_stream/_modify` request.", + "method_request": "POST _data_stream/_modify", + "value": "{\n \"actions\": [\n {\n \"remove_backing_index\": {\n \"data_stream\": \"my-data-stream\",\n \"index\": \".ds-my-data-stream-2023.07.26-000001\"\n }\n },\n {\n \"add_backing_index\": {\n \"data_stream\": \"my-data-stream\",\n \"index\": \".ds-my-data-stream-2023.07.26-000001-downsample\"\n }\n }\n ]\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -144752,6 +145361,11 @@ "kind": "no_body" }, "description": "Open a closed index.\nFor data streams, the API opens any closed backing indices.\n\nA closed index is blocked for read/write operations and does not allow all operations that opened indices allow.\nIt is not possible to index documents or to search for documents in a closed index.\nThis allows closed indices to not have to maintain internal data structures for indexing or searching documents, resulting in a smaller overhead on the cluster.\n\nWhen opening or closing an index, the master is responsible for restarting the index shards to reflect the new state of the index.\nThe shards will then go through the normal recovery process.\nThe data of opened or closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times.\n\nYou can open and close multiple indices.\nAn error is thrown if the request explicitly refers to a missing index.\nThis behavior can be turned off by using the `ignore_unavailable=true` parameter.\n\nBy default, you must explicitly name the indices you are opening or closing.\nTo open or close indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`.\nThis setting can also be changed with the cluster update settings API.\n\nClosed indices consume a significant amount of disk-space which can cause problems in managed environments.\nClosing indices can be turned off with the cluster settings API by setting `cluster.indices.close.enable` to `false`.\n\nBecause opening or closing an index allocates its shards, the `wait_for_active_shards` setting on index creation applies to the `_open` and `_close` index actions as well.", + "examples": { + "IndicesOpenExample1": { + "method_request": "POST /.ds-my-data-stream-2099.03.07-000001/_open/" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -144910,6 +145524,11 @@ "kind": "no_body" }, "description": "Promote a data stream.\nPromote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream.\n\nWith CCR auto following, a data stream from a remote cluster can be replicated to the local cluster.\nThese data streams can't be rolled over in the local cluster.\nThese replicated data streams roll over only if the upstream data stream rolls over.\nIn the event that the remote cluster is no longer available, the data stream in the local cluster can be promoted to a regular data stream, which allows these data streams to be rolled over in the local cluster.\n\nNOTE: When promoting a data stream, ensure the local cluster has a data stream enabled index template that matches the data stream.\nIf this is missing, the data stream will not be able to roll over until a matching index template is created.\nThis will affect the lifecycle management of the data stream and interfere with the data stream size and retention.", + "examples": { + "IndicesPromoteDataStreamExample1": { + "method_request": "POST /_data_stream/_promote/my-data-stream" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -146913,6 +147532,11 @@ "kind": "no_body" }, "description": "Get index recovery information.\nGet information about ongoing and completed shard recoveries for one or more indices.\nFor data streams, the API returns information for the stream's backing indices.\n\nAll recoveries, whether ongoing or complete, are kept in the cluster state and may be reported on at any time.\n\nShard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard.\nWhen a shard recovery completes, the recovered shard is available for search and indexing.\n\nRecovery automatically occurs during the following processes:\n\n* When creating an index for the first time.\n* When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path.\n* Creation of new replica shard copies from the primary.\n* Relocation of a shard copy to a different node in the same cluster.\n* A snapshot restore operation.\n* A clone, shrink, or split operation.\n\nYou can determine the cause of a shard recovery using the recovery or cat recovery APIs.\n\nThe index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster.\nIt only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist.\nThis means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API.", + "examples": { + "indicesRecoveryRequestExample1": { + "method_request": "GET /_recovery?human" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -146994,13 +147618,11 @@ "examples": { "indicesRecoveryResponseExample1": { "description": "A successful response from `GET /_recovery?human`, which gets information about ongoing and completed shard recoveries for all data streams and indices in a cluster. This example includes information about a single index recovering a single shard. The source of the recovery is a snapshot repository and the target of the recovery is the `my_es_node` node. The response also includes the number and percentage of files and bytes recovered.\n", - "method_request": "GET /_recovery?human", "summary": "Get segment information", "value": "{\n \"index1\" : {\n \"shards\" : [ {\n \"id\" : 0,\n \"type\" : \"SNAPSHOT\",\n \"stage\" : \"INDEX\",\n \"primary\" : true,\n \"start_time\" : \"2014-02-24T12:15:59.716\",\n \"start_time_in_millis\": 1393244159716,\n \"stop_time\" : \"0s\",\n \"stop_time_in_millis\" : 0,\n \"total_time\" : \"2.9m\",\n \"total_time_in_millis\" : 175576,\n \"source\" : {\n \"repository\" : \"my_repository\",\n \"snapshot\" : \"my_snapshot\",\n \"index\" : \"index1\",\n \"version\" : \"{version}\",\n \"restoreUUID\": \"PDh1ZAOaRbiGIVtCvZOMww\"\n },\n \"target\" : {\n \"id\" : \"ryqJ5lO5S4-lSFbGntkEkg\",\n \"host\" : \"my.fqdn\",\n \"transport_address\" : \"my.fqdn\",\n \"ip\" : \"10.0.1.7\",\n \"name\" : \"my_es_node\"\n },\n \"index\" : {\n \"size\" : {\n \"total\" : \"75.4mb\",\n \"total_in_bytes\" : 79063092,\n \"reused\" : \"0b\",\n \"reused_in_bytes\" : 0,\n \"recovered\" : \"65.7mb\",\n \"recovered_in_bytes\" : 68891939,\n \"recovered_from_snapshot\" : \"0b\",\n \"recovered_from_snapshot_in_bytes\" : 0,\n \"percent\" : \"87.1%\"\n },\n \"files\" : {\n \"total\" : 73,\n \"reused\" : 0,\n \"recovered\" : 69,\n \"percent\" : \"94.5%\"\n },\n \"total_time\" : \"0s\",\n \"total_time_in_millis\" : 0,\n \"source_throttle_time\" : \"0s\",\n \"source_throttle_time_in_millis\" : 0,\n \"target_throttle_time\" : \"0s\",\n \"target_throttle_time_in_millis\" : 0\n },\n \"translog\" : {\n \"recovered\" : 0,\n \"total\" : 0,\n \"percent\" : \"100.0%\",\n \"total_on_start\" : 0,\n \"total_time\" : \"0s\",\n \"total_time_in_millis\" : 0\n },\n \"verify_index\" : {\n \"check_index_time\" : \"0s\",\n \"check_index_time_in_millis\" : 0,\n \"total_time\" : \"0s\",\n \"total_time_in_millis\" : 0\n }\n } ]\n }\n}" }, "indicesRecoveryResponseExample2": { "description": "A successful response from `GET _recovery?human&detailed=true`. The response includes a listing of any physical files recovered and their sizes. The response also includes timings in milliseconds of the various stages of recovery: index retrieval, translog replay, and index start time. This response indicates the recovery is done.\n", - "method_request": "GET _recovery?human&detailed=true", "summary": "Get detailed recovery information", "value": "{\n \"index1\" : {\n \"shards\" : [ {\n \"id\" : 0,\n \"type\" : \"EXISTING_STORE\",\n \"stage\" : \"DONE\",\n \"primary\" : true,\n \"start_time\" : \"2014-02-24T12:38:06.349\",\n \"start_time_in_millis\" : \"1393245486349\",\n \"stop_time\" : \"2014-02-24T12:38:08.464\",\n \"stop_time_in_millis\" : \"1393245488464\",\n \"total_time\" : \"2.1s\",\n \"total_time_in_millis\" : 2115,\n \"source\" : {\n \"id\" : \"RGMdRc-yQWWKIBM4DGvwqQ\",\n \"host\" : \"my.fqdn\",\n \"transport_address\" : \"my.fqdn\",\n \"ip\" : \"10.0.1.7\",\n \"name\" : \"my_es_node\"\n },\n \"target\" : {\n \"id\" : \"RGMdRc-yQWWKIBM4DGvwqQ\",\n \"host\" : \"my.fqdn\",\n \"transport_address\" : \"my.fqdn\",\n \"ip\" : \"10.0.1.7\",\n \"name\" : \"my_es_node\"\n },\n \"index\" : {\n \"size\" : {\n \"total\" : \"24.7mb\",\n \"total_in_bytes\" : 26001617,\n \"reused\" : \"24.7mb\",\n \"reused_in_bytes\" : 26001617,\n \"recovered\" : \"0b\",\n \"recovered_in_bytes\" : 0,\n \"recovered_from_snapshot\" : \"0b\",\n \"recovered_from_snapshot_in_bytes\" : 0,\n \"percent\" : \"100.0%\"\n },\n \"files\" : {\n \"total\" : 26,\n \"reused\" : 26,\n \"recovered\" : 0,\n \"percent\" : \"100.0%\",\n \"details\" : [ {\n \"name\" : \"segments.gen\",\n \"length\" : 20,\n \"recovered\" : 20\n }, {\n \"name\" : \"_0.cfs\",\n \"length\" : 135306,\n \"recovered\" : 135306,\n \"recovered_from_snapshot\": 0\n }, {\n \"name\" : \"segments_2\",\n \"length\" : 251,\n \"recovered\" : 251,\n \"recovered_from_snapshot\": 0\n }\n ]\n },\n \"total_time\" : \"2ms\",\n \"total_time_in_millis\" : 2,\n \"source_throttle_time\" : \"0s\",\n \"source_throttle_time_in_millis\" : 0,\n \"target_throttle_time\" : \"0s\",\n \"target_throttle_time_in_millis\" : 0\n },\n \"translog\" : {\n \"recovered\" : 71,\n \"total\" : 0,\n \"percent\" : \"100.0%\",\n \"total_on_start\" : 0,\n \"total_time\" : \"2.0s\",\n \"total_time_in_millis\" : 2025\n },\n \"verify_index\" : {\n \"check_index_time\" : 0,\n \"check_index_time_in_millis\" : 0,\n \"total_time\" : \"88ms\",\n \"total_time_in_millis\" : 88\n }\n } ]\n }\n}" } @@ -147390,6 +148012,11 @@ "kind": "no_body" }, "description": "Refresh an index.\nA refresh makes recent operations performed on one or more indices available for search.\nFor data streams, the API runs the refresh operation on the stream’s backing indices.\n\nBy default, Elasticsearch periodically refreshes indices every second, but only on indices that have received one search request or more in the last 30 seconds.\nYou can change this default interval with the `index.refresh_interval` setting.\n\nRefresh requests are synchronous and do not return a response until the refresh operation completes.\n\nRefreshes are resource-intensive.\nTo ensure good cluster performance, it's recommended to wait for Elasticsearch's periodic refresh rather than performing an explicit refresh when possible.\n\nIf your application workflow indexes documents and then runs a search to retrieve the indexed document, it's recommended to use the index API's `refresh=wait_for` query parameter option.\nThis option ensures the indexing operation waits for a periodic refresh before running the search.", + "examples": { + "IndicesRefreshExample1": { + "method_request": "GET _refresh" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -147679,6 +148306,11 @@ "kind": "no_body" }, "description": "Resolve the cluster.\n\nResolve the specified index expressions to return information about each cluster, including the local \"querying\" cluster, if included.\nIf no index expression is provided, the API will return information about all the remote clusters that are configured on the querying cluster.\n\nThis endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search.\n\nYou use the same index expression with this endpoint as you would for cross-cluster search.\nIndex and cluster exclusions are also supported with this endpoint.\n\nFor each cluster in the index expression, information is returned about:\n\n* Whether the querying (\"local\") cluster is currently connected to each remote cluster specified in the index expression. Note that this endpoint actively attempts to contact the remote clusters, unlike the `remote/info` endpoint.\n* Whether each remote cluster is configured with `skip_unavailable` as `true` or `false`.\n* Whether there are any indices, aliases, or data streams on that cluster that match the index expression.\n* Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index).\n* Cluster version information, including the Elasticsearch server version.\n\nFor example, `GET /_resolve/cluster/my-index-*,cluster*:my-index-*` returns information about the local cluster and all remotely configured clusters that start with the alias `cluster*`.\nEach cluster returns information about whether it has any indices, aliases or data streams that match `my-index-*`.\n\n## Note on backwards compatibility\nThe ability to query without an index expression was added in version 8.18, so when\nquerying remote clusters older than that, the local cluster will send the index\nexpression `dummy*` to those remote clusters. Thus, if an errors occur, you may see a reference\nto that index expression even though you didn't request it. If it causes a problem, you can\ninstead include an index expression like `*:*` to bypass the issue.\n\n## Advantages of using this endpoint before a cross-cluster search\n\nYou may want to exclude a cluster or index from a search when:\n\n* A remote cluster is not currently connected and is configured with `skip_unavailable=false`. Running a cross-cluster search under those conditions will cause the entire search to fail.\n* A cluster has no matching indices, aliases or data streams for the index expression (or your user does not have permissions to search them). For example, suppose your index expression is `logs*,remote1:logs*` and the remote1 cluster has no indices, aliases or data streams that match `logs*`. In that case, that cluster will return no results from that cluster if you include it in a cross-cluster search.\n* The index expression (combined with any query parameters you specify) will likely cause an exception to be thrown when you do the search. In these cases, the \"error\" field in the `_resolve/cluster` response will be present. (This is also where security/permission errors will be shown.)\n* A remote cluster is an older version that does not support the feature you want to use in your search.\n\n## Test availability of remote clusters\n\nThe `remote/info` endpoint is commonly used to test whether the \"local\" cluster (the cluster being queried) is connected to its remote clusters, but it does not necessarily reflect whether the remote cluster is available or not.\nThe remote cluster may be available, while the local cluster is not currently connected to it.\n\nYou can use the `_resolve/cluster` API to attempt to reconnect to remote clusters.\nFor example with `GET _resolve/cluster` or `GET _resolve/cluster/*:*`.\nThe `connected` field in the response will indicate whether it was successful.\nIf a connection was (re-)established, this will also cause the `remote/info` endpoint to now indicate a connected status.", + "examples": { + "ResolveClusterRequestExample2": { + "method_request": "GET /_resolve/cluster/not-present,clust*:my-index*,oldcluster:*?ignore_unavailable=false&timeout=5s" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -147873,13 +148505,11 @@ "examples": { "ResolveClusterResponseExample1": { "description": "A successful response from `GET /_resolve/cluster/my-index*,clust*:my-index*`. Each cluster has its own response section. The cluster you sent the request to is labelled as \"(local)\".\n", - "method_request": "GET /_resolve/cluster/my-index*,clust*:my-index*", "summary": "Resolve with wildcards", "value": "{\n \"(local)\": {\n \"connected\": true,\n \"skip_unavailable\": false,\n \"matching_indices\": true,\n \"version\": {\n \"number\": \"8.13.0\",\n \"build_flavor\": \"default\",\n \"minimum_wire_compatibility_version\": \"7.17.0\",\n \"minimum_index_compatibility_version\": \"7.0.0\"\n }\n },\n \"cluster_one\": {\n \"connected\": true,\n \"skip_unavailable\": true,\n \"matching_indices\": true,\n \"version\": {\n \"number\": \"8.13.0\",\n \"build_flavor\": \"default\",\n \"minimum_wire_compatibility_version\": \"7.17.0\",\n \"minimum_index_compatibility_version\": \"7.0.0\"\n }\n },\n \"cluster_two\": {\n \"connected\": true,\n \"skip_unavailable\": false,\n \"matching_indices\": true,\n \"version\": {\n \"number\": \"8.13.0\",\n \"build_flavor\": \"default\",\n \"minimum_wire_compatibility_version\": \"7.17.0\",\n \"minimum_index_compatibility_version\": \"7.0.0\"\n }\n }\n}" }, "ResolveClusterResponseExample2": { "description": "A successful response from `GET /_resolve/cluster/not-present,clust*:my-index*,oldcluster:*?ignore_unavailable=false&timeout=5s`. This type of request can be used to identify potential problems with your cross-cluster search. Note also that a `timeout` of 5 seconds is sent, which sets the maximum time the query will wait for remote clusters to respond. The local cluster has no index called `not_present`. Searching with `ignore_unavailable=false` would return a \"no such index\" error. The `cluster_one` remote cluster has no indices that match the pattern `my-index*`. There may be no indices that match the pattern or the index could be closed. The `cluster_two` remote cluster is not connected (the attempt to connect failed). Since this cluster is marked as `skip_unavailable=false`, you should probably exclude this cluster from the search by adding `-cluster_two:*` to the search index expression. For `cluster_three`, the error message indicates that this remote cluster did not respond within the 5-second timeout window specified, so it is also marked as not connected. The `oldcluster` remote cluster shows that it has matching indices, but no version information is included. This indicates that the cluster version predates the introduction of the `_resolve/cluster` API, so you may want to exclude it from your cross-cluster search.\n", - "method_request": "GET /_resolve/cluster/not-present,clust*:my-index*,oldcluster:*?ignore_unavailable=false&timeout=5s", "summary": "Identify search problems", "value": "{\n \"(local)\": {\n \"connected\": true,\n \"skip_unavailable\": false,\n \"error\": \"no such index [not_present]\"\n },\n \"cluster_one\": {\n \"connected\": true,\n \"skip_unavailable\": true,\n \"matching_indices\": false,\n \"version\": {\n \"number\": \"8.13.0\",\n \"build_flavor\": \"default\",\n \"minimum_wire_compatibility_version\": \"7.17.0\",\n \"minimum_index_compatibility_version\": \"7.0.0\"\n }\n },\n \"cluster_two\": {\n \"connected\": false,\n \"skip_unavailable\": false\n },\n \"cluster_three\": {\n \"connected\": false,\n \"skip_unavailable\": false,\n \"error\": \"Request timed out before receiving a response from the remote cluster\"\n },\n \"oldcluster\": {\n \"connected\": true,\n \"skip_unavailable\": false,\n \"matching_indices\": true\n }\n}" } @@ -147899,6 +148529,11 @@ "kind": "no_body" }, "description": "Resolve indices.\nResolve the names and/or index patterns for indices, aliases, and data streams.\nMultiple patterns and remote clusters are supported.", + "examples": { + "ResolveIndexRequestExample1": { + "method_request": "GET /_resolve/index/f*,remoteCluster1:bar*?expand_wildcards=all" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -148153,7 +148788,6 @@ "examples": { "ResolveIndexResponseExample1": { "description": "A successful response from `GET /_resolve/index/f*,remoteCluster1:bar*?expand_wildcards=all`.", - "method_request": "GET /_resolve/index/f*,remoteCluster1:bar*?expand_wildcards=all", "value": "{\n \"indices\": [\n {\n \"name\": \"foo_closed\",\n \"attributes\": [\n \"closed\"\n ]\n },\n {\n \"name\": \"freeze-index\",\n \"aliases\": [\n \"f-alias\"\n ],\n \"attributes\": [\n \"open\"\n ]\n },\n {\n \"name\": \"remoteCluster1:bar-01\",\n \"attributes\": [\n \"open\"\n ]\n }\n ],\n \"aliases\": [\n {\n \"name\": \"f-alias\",\n \"indices\": [\n \"freeze-index\",\n \"my-index-000001\"\n ]\n }\n ],\n \"data_streams\": [\n {\n \"name\": \"foo\",\n \"backing_indices\": [\n \".ds-foo-2099.03.07-000001\"\n ],\n \"timestamp_field\": \"@timestamp\"\n }\n ]\n}" } }, @@ -148450,7 +149084,6 @@ "examples": { "indicesRolloverResponseExample1": { "description": "An abbreviated response from `GET /_segments`.\n", - "method_request": "GET /_segments", "value": "{\n \"_shards\": {},\n \"indices\": {\n \"test\": {\n \"shards\": {\n \"0\": [\n {\n \"routing\": {\n \"state\": \"STARTED\",\n \"primary\": true,\n \"node\": \"zDC_RorJQCao9xf9pg3Fvw\"\n },\n \"num_committed_segments\": 0,\n \"num_search_segments\": 1,\n \"segments\": {\n \"_0\": {\n \"generation\": 0,\n \"num_docs\": 1,\n \"deleted_docs\": 0,\n \"size_in_bytes\": 3800,\n \"committed\": false,\n \"search\": true,\n \"version\": \"7.0.0\",\n \"compound\": true,\n \"attributes\": {}\n }\n }\n }\n ]\n }\n }\n }\n}" } }, @@ -148700,6 +149333,11 @@ "kind": "no_body" }, "description": "Get index segments.\nGet low-level information about the Lucene segments in index shards.\nFor data streams, the API returns information about the stream's backing indices.", + "examples": { + "IndicesSegmentsExample1": { + "method_request": "GET /my-index-000001/_segments" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -149088,6 +149726,11 @@ "kind": "no_body" }, "description": "Get index shard stores.\nGet store information about replica shards in one or more indices.\nFor data streams, the API retrieves store information for the stream's backing indices.\n\nThe index shard stores API returns the following information:\n\n* The node on which each replica shard exists.\n* The allocation ID for each replica shard.\n* A unique ID for each replica shard.\n* Any errors encountered while opening the shard index or from an earlier failure.\n\nBy default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards.", + "examples": { + "indicesShardStoresRequestExample1": { + "method_request": "GET /_shard_stores?status=green" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -149213,7 +149856,6 @@ "examples": { "indicesShardStoresResponseExample1": { "description": "An abbreviated response from `GET /_shard_stores?status=green`.\n", - "method_request": "GET /_shard_stores?status=green", "value": "{\n \"indices\": {\n \"my-index-000001\": {\n \"shards\": {\n \"0\": {\n \"stores\": [\n {\n \"sPa3OgxLSYGvQ4oPs-Tajw\": {\n \"name\": \"node_t0\",\n \"ephemeral_id\": \"9NlXRFGCT1m8tkvYCMK-8A\",\n \"transport_address\": \"local[1]\",\n \"external_id\": \"node_t0\",\n \"attributes\": {},\n \"roles\": [],\n \"version\": \"8.10.0\",\n \"min_index_version\": 7000099,\n \"max_index_version\": 8100099\n },\n \"allocation_id\": \"2iNySv_OQVePRX-yaRH_lQ\",\n \"allocation\": \"primary\",\n \"store_exception\": {}\n }\n ]\n }\n }\n }\n }\n}" } }, @@ -149682,6 +150324,11 @@ "kind": "no_body" }, "description": "Simulate an index.\nGet the index configuration that would be applied to the specified index from an existing index template.", + "examples": { + "indicesSimulateIndexTemplateRequestExample1": { + "method_request": "POST /_index_template/_simulate_index/my-index-000001" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -149806,7 +150453,6 @@ "examples": { "indicesSimulateIndexTemplateResponseExample1": { "description": "A successful response from `POST /_index_template/_simulate_index/my-index-000001`.", - "method_request": "POST /_index_template/_simulate_index/my-index-000001", "value": "{\n \"template\" : {\n \"settings\" : {\n \"index\" : {\n \"number_of_shards\" : \"2\",\n \"number_of_replicas\" : \"0\",\n \"routing\" : {\n \"allocation\" : {\n \"include\" : {\n \"_tier_preference\" : \"data_content\"\n }\n }\n }\n }\n },\n \"mappings\" : {\n \"properties\" : {\n \"@timestamp\" : {\n \"type\" : \"date\"\n }\n }\n },\n \"aliases\" : { }\n },\n \"overlapping\" : [\n {\n \"name\" : \"template_1\",\n \"index_patterns\" : [\n \"my-index-*\"\n ]\n }\n ]\n}" } }, @@ -150122,7 +150768,6 @@ "examples": { "indicesSimulateTemplateResponseExample2": { "description": "A successful response from `POST /_index_template/_simulate` with a template configuration in the request body. The response shows any overlapping templates with a lower priority.\n", - "method_request": "POST /_index_template/_simulate", "value": "{\n \"template\" : {\n \"settings\" : {\n \"index\" : {\n \"number_of_replicas\" : \"1\",\n \"routing\" : {\n \"allocation\" : {\n \"include\" : {\n \"_tier_preference\" : \"data_content\"\n }\n }\n }\n }\n },\n \"mappings\" : {\n \"properties\" : {\n \"@timestamp\" : {\n \"type\" : \"date\"\n }\n }\n },\n \"aliases\" : { }\n },\n \"overlapping\" : [\n {\n \"name\" : \"final-template\",\n \"index_patterns\" : [\n \"my-index-*\"\n ]\n }\n ]\n}" } }, @@ -150783,6 +151428,11 @@ "kind": "no_body" }, "description": "Get index statistics.\nFor data streams, the API retrieves statistics for the stream's backing indices.\n\nBy default, the returned statistics are index-level with `primaries` and `total` aggregations.\n`primaries` are the values for only the primary shards.\n`total` are the accumulated values for both primary and replica shards.\n\nTo get shard-level statistics, set the `level` parameter to `shards`.\n\nNOTE: When moving to another node, the shard-level statistics for a shard are cleared.\nAlthough the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed.", + "examples": { + "IndicesStatsExample1": { + "method_request": "GET _stats/fielddata?human&fields=my_join_field#question" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -152205,6 +152855,13 @@ ] }, "description": "Create or update an alias.\nAdds a data stream or index to an alias.", + "examples": { + "IndicesUpdateAliasesExample1": { + "description": "An example body for a `POST _aliases` request.", + "method_request": "POST _aliases", + "value": "{\n \"actions\": [\n {\n \"add\": {\n \"index\": \"logs-nginx.access-prod\",\n \"alias\": \"logs\"\n }\n }\n ]\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -152342,6 +152999,11 @@ ] }, "description": "Validate a query.\nValidates a query without running it.", + "examples": { + "IndicesValidateQueryExample1": { + "method_request": "GET my-index-000001/_validate/query?q=user.id:kimchy" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -157109,7 +157771,6 @@ "examples": { "CompletionResponseExample1": { "description": "A successful response from `POST _inference/completion/openai_chat_completions`.\n", - "method_request": "POST _inference/completion/openai_chat_completions", "summary": "Completion task", "value": "{\n \"completion\": [\n {\n \"result\": \"Elastic is a company that provides a range of software solutions for search, logging, security, and analytics. Their flagship product is Elasticsearch, an open-source, distributed search engine that allows users to search, analyze, and visualize large volumes of data in real-time. Elastic also offers products such as Kibana, a data visualization tool, and Logstash, a log management and pipeline tool, as well as various other tools and solutions for data analysis and management.\"\n }\n ]\n}" } @@ -157129,6 +157790,11 @@ "kind": "no_body" }, "description": "Delete an inference endpoint", + "examples": { + "InferenceDeleteExample1": { + "method_request": "DELETE /_inference/sparse_embedding/my-elser-model" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -157223,6 +157889,11 @@ "kind": "no_body" }, "description": "Get an inference endpoint", + "examples": { + "InferenceGetExample1": { + "method_request": "GET _inference/sparse_embedding/my-elser-model" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -157440,6 +158111,13 @@ } }, "description": "Create an inference endpoint.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", + "examples": { + "InferencePutExample1": { + "description": "An example body for a `PUT _inference/rerank/my-rerank-model` request.", + "method_request": "PUT _inference/rerank/my-rerank-model", + "value": "{\n \"service\": \"cohere\",\n \"service_settings\": {\n \"model_id\": \"rerank-english-v3.0\",\n \"api_key\": \"{{COHERE_API_KEY}}\"\n }\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -158455,7 +159133,6 @@ "examples": { "PutElasticsearchResponseExample1": { "description": "A successful response from `PUT _inference/sparse_embedding/use_existing_deployment`. It contains the model ID and the threads and allocations settings from the model deployment.\n", - "method_request": "PUT _inference/sparse_embedding/use_existing_deployment", "value": "{\n \"inference_id\": \"use_existing_deployment\",\n \"task_type\": \"sparse_embedding\",\n \"service\": \"elasticsearch\",\n \"service_settings\": {\n \"num_allocations\": 2,\n \"num_threads\": 1,\n \"model_id\": \".elser_model_2\",\n \"deployment_id\": \".elser_model_2\"\n },\n \"chunking_settings\": {\n \"strategy\": \"sentence\",\n \"max_chunk_size\": 250,\n \"sentence_overlap\": 1\n }\n}" } }, @@ -159699,7 +160376,6 @@ "examples": { "RerankResponseExample1": { "description": "A successful response from `POST _inference/rerank/cohere_rerank`.\n", - "method_request": "POST _inference/rerank/cohere_rerank", "summary": "Rerank task", "value": "{\n \"rerank\": [\n {\n \"index\": \"2\",\n \"relevance_score\": \"0.011597361\",\n \"text\": \"leia\"\n },\n {\n \"index\": \"0\",\n \"relevance_score\": \"0.006338922\",\n \"text\": \"luke\"\n },\n {\n \"index\": \"5\",\n \"relevance_score\": \"0.0016166499\",\n \"text\": \"star\"\n },\n {\n \"index\": \"4\",\n \"relevance_score\": \"0.0011695103\",\n \"text\": \"r2d2\"\n },\n {\n \"index\": \"1\",\n \"relevance_score\": \"5.614787E-4\",\n \"text\": \"like\"\n },\n {\n \"index\": \"6\",\n \"relevance_score\": \"3.7850367E-4\",\n \"text\": \"wars\"\n },\n {\n \"index\": \"3\",\n \"relevance_score\": \"1.2508839E-5\",\n \"text\": \"chewy\"\n }\n ]\n}" } @@ -159825,7 +160501,6 @@ "examples": { "SparseEmbeddingResponseExample1": { "description": "An abbreviated response from `POST _inference/sparse_embedding/my-elser-model`.\n", - "method_request": "POST _inference/sparse_embedding/my-elser-model", "summary": "Sparse embedding task", "value": "{\n \"sparse_embedding\": [\n {\n \"port\": 2.1259406,\n \"sky\": 1.7073475,\n \"color\": 1.6922266,\n \"dead\": 1.6247464,\n \"television\": 1.3525393,\n \"above\": 1.2425821,\n \"tuned\": 1.1440028,\n \"colors\": 1.1218185,\n \"tv\": 1.0111054,\n \"ports\": 1.0067928,\n \"poem\": 1.0042328,\n \"channel\": 0.99471164,\n \"tune\": 0.96235967,\n \"scene\": 0.9020516\n }\n ]\n}" } @@ -160055,7 +160730,6 @@ "examples": { "TextEmbeddingResponseExample1": { "description": "An abbreviated response from `POST _inference/text_embedding/my-cohere-endpoint`.\n", - "method_request": "POST _inference/text_embedding/my-cohere-endpoint", "summary": "Text embedding task", "value": "{\n \"text_embedding\": [\n {\n \"embedding\": [\n {\n 0.018569946,\n -0.036895752,\n 0.01486969,\n -0.0045204163,\n -0.04385376,\n 0.0075950623,\n 0.04260254,\n -0.004005432,\n 0.007865906,\n 0.030792236,\n -0.050476074,\n 0.011795044,\n -0.011642456,\n -0.010070801\n }\n ]\n }\n ]\n}" } @@ -160083,6 +160757,13 @@ } }, "description": "Update an inference endpoint.\n\nModify `task_settings`, secrets (within `service_settings`), or `num_allocations` for an inference endpoint, depending on the specific endpoint service and `task_type`.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", + "examples": { + "InferenceUpdateExample1": { + "description": "An example body for a `PUT _inference/my-inference-endpoint/_update` request.", + "method_request": "PUT _inference/my-inference-endpoint/_update", + "value": "{\n \"service_settings\": {\n \"api_key\": \"\"\n }\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -165491,6 +166172,11 @@ "kind": "no_body" }, "description": "Delete IP geolocation database configurations.", + "examples": { + "IngestDeleteIpLocationDatabaseExample1": { + "method_request": "DELETE /_ingest/ip_location/database/my-database-id" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -165573,6 +166259,11 @@ "kind": "no_body" }, "description": "Delete pipelines.\nDelete one or more ingest pipelines.", + "examples": { + "IngestDeletePipelineExample1": { + "method_request": "DELETE /_ingest/pipeline/my-pipeline-id" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -165809,6 +166500,11 @@ "kind": "no_body" }, "description": "Get GeoIP statistics.\nGet download statistics for GeoIP2 databases that are used with the GeoIP processor.", + "examples": { + "IngestGeoIpStatsExample1": { + "method_request": "GET _ingest/geoip/stats" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -166089,6 +166785,11 @@ "kind": "no_body" }, "description": "Get IP geolocation database configurations.", + "examples": { + "IngestGetIpLocationDatabaseExample1": { + "method_request": "GET /_ingest/ip_location/database/my-database-id" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -166166,6 +166867,11 @@ "kind": "no_body" }, "description": "Get pipelines.\n\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", + "examples": { + "IngestGetPipelineExample1": { + "method_request": "GET /_ingest/pipeline/my-pipeline-id" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -166265,6 +166971,11 @@ "kind": "no_body" }, "description": "Run a grok processor.\nExtract structured fields out of a single text field within a document.\nYou must choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", + "examples": { + "IngestProcessorGrokExample1": { + "method_request": "GET _ingest/processor/grok" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -166439,6 +167150,13 @@ } }, "description": "Create or update an IP geolocation database configuration.", + "examples": { + "IngestPutIpLocationDatabaseExample1": { + "description": "An example body for a `PUT _ingest/ip_location/database/my-database-1` request.", + "method_request": "PUT _ingest/ip_location/database/my-database-1", + "value": "{\n \"name\": \"GeoIP2-Domain\",\n \"maxmind\": {\n \"account_id\": \"1234567\"\n }\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -167046,6 +167764,11 @@ "kind": "no_body" }, "description": "Delete the license.\n\nWhen the license expires, your subscription level reverts to Basic.\n\nIf the operator privileges feature is enabled, only operator users can use this API.", + "examples": { + "LicenseDeleteExample1": { + "method_request": "DELETE /_license" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -167308,6 +168031,11 @@ "kind": "no_body" }, "description": "Get license information.\n\nGet information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\n>info\n> If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\n> If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", + "examples": { + "GetLicenseRequestExample1": { + "method_request": "GET /_license" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -167374,7 +168102,6 @@ "examples": { "GetLicenseResponseExample1": { "description": "A successful response from `GET /_license`.", - "method_request": "GET /_license", "value": "{\n \"license\" : {\n \"status\" : \"active\",\n \"uid\" : \"cbff45e7-c553-41f7-ae4f-9205eabd80xx\",\n \"type\" : \"trial\",\n \"issue_date\" : \"2018-10-20T22:05:12.332Z\",\n \"issue_date_in_millis\" : 1540073112332,\n \"expiry_date\" : \"2018-11-19T22:05:12.332Z\",\n \"expiry_date_in_millis\" : 1542665112332,\n \"max_nodes\" : 1000,\n \"max_resource_units\" : null,\n \"issued_to\" : \"test\",\n \"issuer\" : \"elasticsearch\",\n \"start_date_in_millis\" : -1\n }\n}" } }, @@ -167393,6 +168120,11 @@ "kind": "no_body" }, "description": "Get the basic license status.", + "examples": { + "GetBasicLicenseStatusRequestExample1": { + "method_request": "GET /_license/basic_status" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -167428,7 +168160,6 @@ "examples": { "GetBasicLicenseStatusResponseExample1": { "description": "A successful response from `GET /_license/basic_status`.", - "method_request": "GET /_license/basic_status", "value": "{\n \"eligible_to_start_basic\": true\n}" } }, @@ -167447,6 +168178,11 @@ "kind": "no_body" }, "description": "Get the trial status.", + "examples": { + "GetTrialLicenseStatusRequestExample1": { + "method_request": "GET /_license/trial_status" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -167482,7 +168218,6 @@ "examples": { "GetTrialLicenseStatusResponseExample1": { "description": "A successful response from `GET /_license/trial_status`.", - "method_request": "GET /_license/trial_status", "value": "{\n \"eligible_to_start_trial\": true\n}" } }, @@ -167686,6 +168421,11 @@ "kind": "no_body" }, "description": "Start a basic license.\n\nStart an indefinite basic license, which gives access to all the basic features.\n\nNOTE: In order to start a basic license, you must not currently have a basic license.\n\nIf the basic license does not support all of the features that are available with your current license, however, you are notified in the response.\nYou must then re-submit the API request with the `acknowledge` parameter set to `true`.\n\nTo check the status of your basic license, use the get basic license API.", + "examples": { + "StartBasicLicenseRequestExample1": { + "method_request": "POST /_license/start_basic?acknowledge=true" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -167830,7 +168570,6 @@ "examples": { "StartBasicLicenseResponseExample1": { "description": "A successful response from `POST /_license/start_basic?acknowledge=true`. If you currently have a license with more features than a basic license and you start a basic license, you must pass the acknowledge parameter.", - "method_request": "POST /_license/start_basic?acknowledge=true", "value": "{\n \"basic_was_started\": true,\n \"acknowledged\": true\n}" } }, @@ -167849,6 +168588,11 @@ "kind": "no_body" }, "description": "Start a trial.\nStart a 30-day trial, which gives access to all subscription features.\n\nNOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version.\nFor example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension.\n\nTo check the status of your trial, use the get trial status API.", + "examples": { + "StartTrialLicenseRequestExample1": { + "method_request": "POST /_license/start_trial?acknowledge=true" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -167954,7 +168698,6 @@ "examples": { "StartTrialLicenseResponseExample1": { "description": "A successful response from `POST /_license/start_trial?acknowledge=true`.", - "method_request": "POST /_license/start_trial?acknowledge=true", "value": "{\n \"trial_was_started\": true,\n \"acknowledged\": true\n}" } }, @@ -168177,6 +168920,11 @@ "kind": "no_body" }, "description": "Delete a Logstash pipeline.\nDelete a pipeline that is used for Logstash Central Management.\nIf the request succeeds, you receive an empty response with an appropriate status code.", + "examples": { + "LogstashDeletePipelineExample1": { + "method_request": "DELETE _logstash/pipeline/my_pipeline" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -168224,6 +168972,11 @@ "kind": "no_body" }, "description": "Get Logstash pipelines.\nGet pipelines that are used for Logstash Central Management.", + "examples": { + "LogstashGetPipelineRequestExample1": { + "method_request": "GET _logstash/pipeline/my_pipeline" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -168278,7 +169031,6 @@ "examples": { "LogstashGetPipelineResponseExample1": { "description": "A successful response from `GET _logstash/pipeline/my_pipeline`.\n", - "method_request": "GET _logstash/pipeline/my_pipeline", "value": "{\n \"my_pipeline\": {\n \"description\": \"Sample pipeline for illustration purposes\",\n \"last_modified\": \"2021-01-02T02:50:51.250Z\",\n \"pipeline_metadata\": {\n \"type\": \"logstash_pipeline\",\n \"version\": \"1\"\n },\n \"username\": \"elastic\",\n \"pipeline\": \"input {}\\\\n filter { grok {} }\\\\n output {}\",\n \"pipeline_settings\": {\n \"pipeline.workers\": 1,\n \"pipeline.batch.size\": 125,\n \"pipeline.batch.delay\": 50,\n \"queue.type\": \"memory\",\n \"queue.max_bytes\": \"1gb\",\n \"queue.checkpoint.writes\": 1024\n }\n }\n}" } }, @@ -168471,6 +169223,11 @@ "kind": "no_body" }, "description": "Get deprecation information.\nGet information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.\n\nTIP: This APIs is designed for indirect use by the Upgrade Assistant.\nYou are strongly recommended to use the Upgrade Assistant.", + "examples": { + "DeprecationInfoRequestExample1": { + "method_request": "GET /_migration/deprecations" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -168656,7 +169413,6 @@ "examples": { "DeprecationInfoResponseExample1": { "description": "An abbreviated response from `GET /_migration/deprecations`.\n", - "method_request": "GET /_migration/deprecations", "value": "{\n \"cluster_settings\": [\n {\n \"level\": \"critical\",\n \"message\": \"Cluster name cannot contain ':'\",\n \"url\": \"https://www.elastic.co/guide/en/elasticsearch/reference/7.0/breaking-changes-7.0.html#_literal_literal_is_no_longer_allowed_in_cluster_name\",\n \"details\": \"This cluster is named [mycompany:logging], which contains the illegal character ':'.\"\n }\n ],\n \"node_settings\": [],\n \"index_settings\": {\n \"logs:apache\": [\n {\n \"level\": \"warning\",\n \"message\": \"Index name cannot contain ':'\",\n \"url\": \"https://www.elastic.co/guide/en/elasticsearch/reference/7.0/breaking-changes-7.0.html#_literal_literal_is_no_longer_allowed_in_index_name\",\n \"details\": \"This index is named [logs:apache], which contains the illegal character ':'.\"\n }\n ]\n },\n \"ml_settings\": []\n}" } }, @@ -168797,6 +169553,11 @@ "kind": "no_body" }, "description": "Get feature migration information.\nVersion upgrades sometimes require changes to how features store configuration information and data in system indices.\nCheck which features need to be migrated and the status of any migrations that are in progress.\n\nTIP: This API is designed for indirect use by the Upgrade Assistant.\nYou are strongly recommended to use the Upgrade Assistant.", + "examples": { + "GetFeatureUpgradeStatusRequestExample1": { + "method_request": "GET /_migration/system_features" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -168846,7 +169607,6 @@ "examples": { "GetFeatureUpgradeStatusResponseExample1": { "description": "A successful response from `GET /_migration/system_features`.", - "method_request": "GET /_migration/system_features", "value": "{\n \"features\" : [\n {\n \"feature_name\" : \"async_search\",\n \"minimum_index_version\" : \"8100099\",\n \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n },\n {\n \"feature_name\" : \"enrich\",\n \"minimum_index_version\" : \"8100099\",\n \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n },\n {\n \"feature_name\" : \"ent_search\",\n \"minimum_index_version\" : \"8100099\",\n \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n },\n {\n \"feature_name\" : \"fleet\",\n \"minimum_index_version\" : \"8100099\",\n \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n },\n {\n \"feature_name\" : \"geoip\",\n \"minimum_index_version\" : \"8100099\",\n \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n },\n {\n \"feature_name\" : \"kibana\",\n \"minimum_index_version\" : \"8100099\",\n \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n },\n {\n \"feature_name\" : \"logstash_management\",\n \"minimum_index_version\" : \"8100099\",\n \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n },\n {\n \"feature_name\" : \"machine_learning\",\n \"minimum_index_version\" : \"8100099\",\n \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n },\n {\n \"feature_name\" : \"searchable_snapshots\",\n \"minimum_index_version\" : \"8100099\",\n \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n },\n {\n \"feature_name\" : \"security\",\n \"minimum_index_version\" : \"8100099\",\n \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n },\n {\n \"feature_name\" : \"synonyms\",\n \"minimum_index_version\" : \"8100099\",\n \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n },\n {\n \"feature_name\" : \"tasks\",\n \"minimum_index_version\" : \"8100099\",\n \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n },\n {\n \"feature_name\" : \"transform\",\n \"minimum_index_version\" : \"8100099\",\n \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n },\n {\n \"feature_name\" : \"watcher\",\n \"minimum_index_version\" : \"8100099\",\n \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n }\n ],\n \"migration_status\" : \"NO_MIGRATION_NEEDED\"\n}" } }, @@ -168886,6 +169646,11 @@ "kind": "no_body" }, "description": "Start the feature migration.\nVersion upgrades sometimes require changes to how features store configuration information and data in system indices.\nThis API starts the automatic migration process.\n\nSome functionality might be temporarily unavailable during the migration process.\n\nTIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.", + "examples": { + "PostFeatureUpgradeRequestExample1": { + "method_request": "POST /_migration/system_features" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -168935,7 +169700,6 @@ "examples": { "PostFeatureUpgradeResponseExample1": { "description": "When you run `POST /_migration/system_features` to start the migration process, the response lists the features that will be migrated.\n", - "method_request": "POST /_migration/system_features", "value": "{\n \"accepted\" : true,\n \"features\" : [\n {\n \"feature_name\" : \"security\"\n }\n ]\n}" } }, @@ -181721,6 +182485,11 @@ "kind": "no_body" }, "description": "Clear trained model deployment cache.\n\nCache will be cleared on all nodes where the trained model is assigned.\nA trained model deployment may have an inference cache enabled.\nAs requests are handled by each allocated node, their responses may be cached on that individual node.\nCalling this API clears the caches without restarting the deployment.", + "examples": { + "MlClearTrainedModelDeploymentCacheExample1": { + "method_request": "POST _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/cache/_clear" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -181828,6 +182597,11 @@ ] }, "description": "Close anomaly detection jobs.\n\nA job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.\nWhen you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.\nIf you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.\nWhen a datafeed that has a specified end date stops, it automatically closes its associated job.", + "examples": { + "MlCloseJobExample1": { + "method_request": "POST _ml/anomaly_detectors/low_request_rate/_close" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -181934,6 +182708,11 @@ "kind": "no_body" }, "description": "Delete a calendar.\n\nRemove all scheduled events from a calendar, then delete it.", + "examples": { + "MlDeleteCalendarExample1": { + "method_request": "DELETE _ml/calendars/planned-outages" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -181995,6 +182774,11 @@ "kind": "no_body" }, "description": "Delete events from a calendar.", + "examples": { + "MlDeleteCalendarEventExample1": { + "method_request": "DELETE _ml/calendars/planned-outages/events/LS8LJGEBMTCMA-qz49st" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -182068,6 +182852,11 @@ "kind": "no_body" }, "description": "Delete anomaly jobs from a calendar.", + "examples": { + "MlDeleteCalendarJobExample1": { + "method_request": "DELETE _ml/calendars/planned-outages/jobs/total-requests" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -182171,6 +182960,11 @@ "kind": "no_body" }, "description": "Delete a data frame analytics job.", + "examples": { + "MlDeleteDataFrameAnalyticsExample1": { + "method_request": "DELETE _ml/data_frame/analytics/loganalytics" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -182259,6 +183053,11 @@ "kind": "no_body" }, "description": "Delete a datafeed.", + "examples": { + "MlDeleteDatafeedExample1": { + "method_request": "DELETE _ml/datafeeds/datafeed-total-requests" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -182360,6 +183159,11 @@ ] }, "description": "Delete expired ML data.\n\nDelete all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using `_all`, by specifying `*` as the ``, or by omitting the\n``.", + "examples": { + "MlDeleteExpiredDataExample1": { + "method_request": "DELETE _ml/_delete_expired_data?timeout=1h" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -182452,6 +183256,11 @@ "kind": "no_body" }, "description": "Delete a filter.\n\nIf an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.", + "examples": { + "MlDeleteFilterExample1": { + "method_request": "DELETE _ml/filters/safe_domains" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -182513,6 +183322,11 @@ "kind": "no_body" }, "description": "Delete forecasts from a job.\n\nBy default, forecasts are retained for 14 days. You can specify a\ndifferent retention period with the `expires_in` parameter in the forecast\njobs API. The delete forecast API enables you to delete one or more\nforecasts before they expire.", + "examples": { + "MlDeleteForecastExample1": { + "method_request": "DELETE _ml/anomaly_detectors/total-requests/_forecast/_all" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -182613,6 +183427,11 @@ "kind": "no_body" }, "description": "Delete an anomaly detection job.\n\nAll job configuration, model state and results are deleted.\nIt is not currently possible to delete multiple jobs using wildcards or a\ncomma separated list. If you delete a job that has a datafeed, the request\nfirst tries to delete the datafeed. This behavior is equivalent to calling\nthe delete datafeed API with the same timeout and force parameters as the\ndelete job request.", + "examples": { + "MlDeleteJobExample1": { + "method_request": "DELETE _ml/anomaly_detectors/total-requests" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -182719,6 +183538,11 @@ "kind": "no_body" }, "description": "Delete a model snapshot.\n\nYou cannot delete the active model snapshot. To delete that snapshot, first\nrevert to a different one. To identify the active model snapshot, refer to\nthe `model_snapshot_id` in the results from the get jobs API.", + "examples": { + "MlDeleteModelSnapshotExample1": { + "method_request": "DELETE _ml/anomaly_detectors/farequote/model_snapshots/1491948163" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -182792,6 +183616,11 @@ "kind": "no_body" }, "description": "Delete an unreferenced trained model.\n\nThe request deletes a trained inference model that is not referenced by an ingest pipeline.", + "examples": { + "MlDeleteTrainedModelExample1": { + "method_request": "DELETE _ml/trained_models/regression-job-one-1574775307356" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -182879,6 +183708,11 @@ "kind": "no_body" }, "description": "Delete a trained model alias.\n\nThis API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.", + "examples": { + "MlDeleteTrainedModelAliasExample1": { + "method_request": "DELETE _ml/trained_models/flight-delay-prediction-1574775339910/model_aliases/flight_delay_model" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -183054,7 +183888,6 @@ "examples": { "MlEstimateModelMemoryResponseExample1": { "description": "A successful response from `POST _ml/anomaly_detectors/_estimate_model_memory`.", - "method_request": "POST _ml/anomaly_detectors/_estimate_model_memory", "value": "{\n \"model_memory_estimate\": \"21mb\"\n}" } }, @@ -183837,19 +184670,16 @@ "examples": { "MlEvaluateDataFrameResponseExample1": { "description": "A succesful response from `POST _ml/data_frame/_evaluate` to evaluate a classification analysis job for an annotated index. The `actual_class` contains the name of the class the analysis tried to predict. The `actual_class_doc_count` is the number of documents in the index belonging to the `actual_class`. The `predicted_classes` object contains the list of the predicted classes and the number of predictions associated with the class.\n", - "method_request": "POST _ml/data_frame/_evaluate", "summary": "Classification example 1", "value": "{\n \"classification\": {\n \"multiclass_confusion_matrix\": {\n \"confusion_matrix\": [\n {\n \"actual_class\": \"cat\",\n \"actual_class_doc_count\": 12,\n \"predicted_classes\": [\n {\n \"predicted_class\": \"cat\",\n \"count\": 12\n },\n {\n \"predicted_class\": \"dog\",\n \"count\": 0\n }\n ],\n \"other_predicted_class_doc_count\": 0\n },\n {\n \"actual_class\": \"dog\",\n \"actual_class_doc_count\": 11,\n \"predicted_classes\": [\n {\n \"predicted_class\": \"dog\",\n \"count\": 7\n },\n {\n \"predicted_class\": \"cat\",\n \"count\": 4\n }\n ],\n \"other_predicted_class_doc_count\": 0\n }\n ],\n \"other_actual_class_count\": 0\n }\n }\n}" }, "MlEvaluateDataFrameResponseExample2": { "description": "A succesful response from `POST _ml/data_frame/_evaluate` to evaluate a classification analysis job with the AUC ROC metrics for an annotated index.\n", - "method_request": "POST _ml/data_frame/_evaluate", "summary": "Classification example 2", "value": "{\n \"classification\": {\n \"auc_roc\": {\n \"value\": 0.8941788639536681\n }\n }\n}" }, "MlEvaluateDataFrameResponseExample3": { "description": "A successful response from `POST _ml/data_frame/_evaluate` to evaluate an outlier detection job.", - "method_request": "POST _ml/data_frame/_evaluate", "summary": "Outlier detection", "value": "{\n \"outlier_detection\": {\n \"auc_roc\": {\n \"value\": 0.9258475774641445\n },\n \"confusion_matrix\": {\n \"0.25\": {\n \"tp\": 5,\n \"fp\": 9,\n \"tn\": 204,\n \"fn\": 5\n },\n \"0.5\": {\n \"tp\": 1,\n \"fp\": 5,\n \"tn\": 208,\n \"fn\": 9\n },\n \"0.75\": {\n \"tp\": 0,\n \"fp\": 4,\n \"tn\": 209,\n \"fn\": 10\n }\n },\n \"precision\": {\n \"0.25\": 0.35714285714285715,\n \"0.5\": 0.16666666666666666,\n \"0.75\": 0\n },\n \"recall\": {\n \"0.25\": 0.5,\n \"0.5\": 0.1,\n \"0.75\": 0\n }\n }\n}" } @@ -184125,6 +184955,13 @@ ] }, "description": "Force buffered data to be processed.\nThe flush jobs API is only applicable when sending data for analysis using\nthe post data API. Depending on the content of the buffer, then it might\nadditionally calculate new results. Both flush and close operations are\nsimilar, however the flush is more efficient if you are expecting to send\nmore data for analysis. When flushing, the job remains open and is available\nto continue analyzing data. A close operation additionally prunes and\npersists the model state to disk and the job must be opened again before\nanalyzing further data.", + "examples": { + "MlFlushJobExample1": { + "description": "An example body for a `POST _ml/anomaly_detectors/low_request_rate/_flush` request.", + "method_request": "POST _ml/anomaly_detectors/low_request_rate/_flush", + "value": "{\n \"calc_interim\": true\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -184299,6 +185136,13 @@ ] }, "description": "Predict future behavior of a time series.\n\nForecasts are not supported for jobs that perform population analysis; an\nerror occurs if you try to create a forecast for a job that has an\n`over_field_name` in its configuration. Forcasts predict future behavior\nbased on historical data.", + "examples": { + "MlForecastExample1": { + "description": "An example body for a `POST _ml/anomaly_detectors/low_request_rate/_forecast` request.", + "method_request": "POST _ml/anomaly_detectors/low_request_rate/_forecast", + "value": "{\n \"duration\": \"10d\"\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -184514,6 +185358,13 @@ ] }, "description": "Get anomaly detection job results for buckets.\nThe API presents a chronological view of the records, grouped by bucket.", + "examples": { + "MlGetBucketsExample1": { + "description": "An example body for a `GET _ml/anomaly_detectors/low_request_rate/results/buckets` request.", + "method_request": "GET _ml/anomaly_detectors/low_request_rate/results/buckets", + "value": "{\n \"anomaly_score\": 80,\n \"start\": \"1454530200001\"\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -184718,6 +185569,11 @@ "kind": "no_body" }, "description": "Get info about events in calendars.", + "examples": { + "MlGetCalendarEventsExample1": { + "method_request": "GET _ml/calendars/planned-outages/events" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -184918,6 +185774,11 @@ ] }, "description": "Get calendar configuration info.", + "examples": { + "MlGetCalendarsExample1": { + "method_request": "GET _ml/calendars/planned-outages" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -185033,6 +185894,13 @@ ] }, "description": "Get anomaly detection job results for categories.", + "examples": { + "MlGetCategoriesExample1": { + "description": "An example body for a `GET _ml/anomaly_detectors/esxi_log/results/categories` request.", + "method_request": "GET _ml/anomaly_detectors/esxi_log/results/categories", + "value": "{\n \"page\":{\n \"size\": 1\n }\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -185158,6 +186026,11 @@ "kind": "no_body" }, "description": "Get data frame analytics job configuration info.\nYou can get information for multiple data frame analytics jobs in a single\nAPI request by using a comma-separated list of data frame analytics jobs or a\nwildcard expression.", + "examples": { + "MlGetDataFrameAnalyticsExample1": { + "method_request": "GET _ml/data_frame/analytics/loganalytics" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -185286,6 +186159,11 @@ "kind": "no_body" }, "description": "Get data frame analytics job stats.", + "examples": { + "MlGetDataFrameAnalyticsStatsExample1": { + "method_request": "GET _ml/data_frame/analytics/weblog-outliers/_stats" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -185414,6 +186292,11 @@ "kind": "no_body" }, "description": "Get datafeed stats.\nYou can get statistics for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget statistics for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``. If the datafeed is stopped, the\nonly information you receive is the `datafeed_id` and the `state`.\nThis API returns a maximum of 10,000 datafeeds.", + "examples": { + "MlGetDatafeedStatsExample1": { + "method_request": "GET _ml/datafeeds/datafeed-high_sum_total_sales/_stats" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -185501,6 +186384,11 @@ "kind": "no_body" }, "description": "Get datafeeds configuration info.\nYou can get information for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget information for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``.\nThis API returns a maximum of 10,000 datafeeds.", + "examples": { + "MlGetDatafeedsExample1": { + "method_request": "GET _ml/datafeeds/datafeed-high_sum_total_sales" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -185601,6 +186489,11 @@ "kind": "no_body" }, "description": "Get filters.\nYou can get a single filter or all filters.", + "examples": { + "MlGetFiltersExample1": { + "method_request": "GET _ml/filters/safe_domains" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -185716,6 +186609,13 @@ ] }, "description": "Get anomaly detection job results for influencers.\nInfluencers are the entities that have contributed to, or are to blame for,\nthe anomalies. Influencer results are available only if an\n`influencer_field_name` is specified in the job configuration.", + "examples": { + "MlGetInfluencersExample1": { + "description": "An example body for a `GET _ml/anomaly_detectors/high_sum_total_sales/results/influencers` request.", + "method_request": "GET _ml/anomaly_detectors/high_sum_total_sales/results/influencers", + "value": "{\n \"sort\": \"influencer_score\",\n \"desc\": true\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -185895,6 +186795,11 @@ "kind": "no_body" }, "description": "Get anomaly detection job stats.", + "examples": { + "MlGetJobStatsExample1": { + "method_request": "GET _ml/anomaly_detectors/low_request_rate/_stats" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -185983,6 +186888,11 @@ "kind": "no_body" }, "description": "Get anomaly detection jobs configuration info.\nYou can get information for multiple anomaly detection jobs in a single API\nrequest by using a group name, a comma-separated list of jobs, or a wildcard\nexpression. You can get information for all anomaly detection jobs by using\n`_all`, by specifying `*` as the ``, or by omitting the ``.", + "examples": { + "MlGetJobsExample1": { + "method_request": "GET _ml/anomaly_detectors/high_sum_total_sales" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -186472,6 +187382,11 @@ "kind": "no_body" }, "description": "Get machine learning memory usage info.\nGet information about how machine learning jobs and trained models are using memory,\non each node, both within the JVM heap, and natively, outside of the JVM.", + "examples": { + "MlGetMemoryStatsExample1": { + "method_request": "GET _ml/memory/_stats?human" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -186592,6 +187507,11 @@ "kind": "no_body" }, "description": "Get anomaly detection job model snapshot upgrade usage info.", + "examples": { + "MlGetModelSnapshotUpgradeStatsExample1": { + "method_request": "GET _ml/anomaly_detectors/low_request_rate/model_snapshots/_all/_upgrade/_stats" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -186753,6 +187673,13 @@ ] }, "description": "Get model snapshots info.", + "examples": { + "MlGetModelSnapshotsExample1": { + "description": "An example body for a `GET _ml/anomaly_detectors/high_sum_total_sales/model_snapshots` request.", + "method_request": "GET _ml/anomaly_detectors/high_sum_total_sales/model_snapshots", + "value": "{\n \"start\": \"1575402236000\"\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -187016,6 +187943,13 @@ ] }, "description": "Get overall bucket results.\n\nRetrievs overall bucket results that summarize the bucket results of\nmultiple anomaly detection jobs.\n\nThe `overall_score` is calculated by combining the scores of all the\nbuckets within the overall bucket span. First, the maximum\n`anomaly_score` per anomaly detection job in the overall bucket is\ncalculated. Then the `top_n` of those scores are averaged to result in\nthe `overall_score`. This means that you can fine-tune the\n`overall_score` so that it is more or less sensitive to the number of\njobs that detect an anomaly at the same time. For example, if you set\n`top_n` to `1`, the `overall_score` is the maximum bucket score in the\noverall bucket. Alternatively, if you set `top_n` to the number of jobs,\nthe `overall_score` is high only when all jobs detect anomalies in that\noverall bucket. If you set the `bucket_span` parameter (to a value\ngreater than its default), the `overall_score` is the maximum\n`overall_score` of the overall buckets that have a span equal to the\njobs' largest bucket span.", + "examples": { + "MlGetOverallBucketsExample1": { + "description": "An example body for a `GET _ml/anomaly_detectors/job-*/results/overall_buckets` request.", + "method_request": "GET _ml/anomaly_detectors/job-*/results/overall_buckets", + "value": "{\n \"overall_score\": 80,\n \"start\": \"1403532000000\"\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -187282,6 +188216,13 @@ ] }, "description": "Get anomaly records for an anomaly detection job.\nRecords contain the detailed analytical results. They describe the anomalous\nactivity that has been identified in the input data based on the detector\nconfiguration.\nThere can be many anomaly records depending on the characteristics and size\nof the input data. In practice, there are often too many to be able to\nmanually process them. The machine learning features therefore perform a\nsophisticated aggregation of the anomaly records into buckets.\nThe number of record results depends on the number of anomalies found in each\nbucket, which relates to the number of time series being modeled and the\nnumber of detectors.", + "examples": { + "MlGetRecordsExample1": { + "description": "An example body for a `GET _ml/anomaly_detectors/low_request_rate/results/records` request.", + "method_request": "GET _ml/anomaly_detectors/low_request_rate/results/records", + "value": "{\n \"sort\": \"record_score\",\n \"desc\": true,\n \"start\": \"1454944100000\"\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -187461,6 +188402,11 @@ "kind": "no_body" }, "description": "Get trained model configuration info.", + "examples": { + "MlGetTrainedModelsExample1": { + "method_request": "GET _ml/trained_models/" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -187641,6 +188587,11 @@ "kind": "no_body" }, "description": "Get trained models usage info.\nYou can get usage information for multiple trained\nmodels in a single API request by using a comma-separated list of model IDs or a wildcard expression.", + "examples": { + "MlGetTrainedModelsStatsExample1": { + "method_request": "GET _ml/trained_models/_stats" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -187793,6 +188744,13 @@ ] }, "description": "Evaluate a trained model.", + "examples": { + "MlInferTrainedModelExample1": { + "description": "An example body for a `POST _ml/trained_models/lang_ident_model_1/_infer` request.", + "method_request": "POST _ml/trained_models/lang_ident_model_1/_infer", + "value": "{\n \"docs\":[{\"text\": \"The fool doth think he is wise, but the wise man knows himself to be a fool.\"}]\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -188085,6 +189043,11 @@ "kind": "no_body" }, "description": "Get machine learning information.\nGet defaults and limits used by machine learning.\nThis endpoint is designed to be used by a user interface that needs to fully\nunderstand machine learning configurations where some options are not\nspecified, meaning that the defaults should be used. This endpoint may be\nused to find out what those defaults are. It also provides information about\nthe maximum size of machine learning jobs that could run in the current\ncluster configuration.", + "examples": { + "MlInfoExample1": { + "method_request": "GET _ml/info" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -188295,6 +189258,13 @@ ] }, "description": "Add scheduled events to the calendar.", + "examples": { + "MlPostCalendarEventsExample1": { + "description": "An example body for a `POST _ml/calendars/planned-outages/events` request.", + "method_request": "POST _ml/calendars/planned-outages/events", + "value": "{\n \"events\" : [\n {\"description\": \"event 1\", \"start_time\": 1513641600000, \"end_time\": 1513728000000},\n {\"description\": \"event 2\", \"start_time\": 1513814400000, \"end_time\": 1513900800000},\n {\"description\": \"event 3\", \"start_time\": 1514160000000, \"end_time\": 1514246400000}\n ]\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -188786,6 +189756,13 @@ ] }, "description": "Preview features used by data frame analytics.\nPreview the extracted features used by a data frame analytics config.", + "examples": { + "MlPreviewDataFrameAnalyticsExample1": { + "description": "An example body for a `POST _ml/data_frame/analytics/_preview` request.", + "method_request": "POST _ml/data_frame/analytics/_preview", + "value": "{\n \"config\": {\n \"source\": {\n \"index\": \"houses_sold_last_10_yrs\"\n },\n \"analysis\": {\n \"regression\": {\n \"dependent_variable\": \"price\"\n }\n }\n }\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -188887,6 +189864,11 @@ ] }, "description": "Preview a datafeed.\nThis API returns the first \"page\" of search results from a datafeed.\nYou can preview an existing datafeed or provide configuration details for a datafeed\nand anomaly detection job in the API. The preview shows the structure of the data\nthat will be passed to the anomaly detection engine.\nIMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that\ncalled the API. However, when the datafeed starts it uses the roles of the last user that created or updated the\ndatafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials.\nYou can also use secondary authorization headers to supply the credentials.", + "examples": { + "MlPreviewDatafeedExample1": { + "method_request": "GET _ml/datafeeds/datafeed-high_sum_total_sales/_preview" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -189005,6 +189987,11 @@ ] }, "description": "Create a calendar.", + "examples": { + "MlPutCalendarExample1": { + "method_request": "PUT _ml/calendars/planned-outages" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -189090,6 +190077,11 @@ "kind": "no_body" }, "description": "Add anomaly detection job to calendar.", + "examples": { + "MlPutCalendarJobExample1": { + "method_request": "PUT _ml/calendars/planned-outages/jobs/total-requests" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -189335,6 +190327,13 @@ ] }, "description": "Create a data frame analytics job.\nThis API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.\nBy default, the query used in the source configuration is `{\"match_all\": {}}`.\n\nIf the destination index does not exist, it is created automatically when you start the job.\n\nIf you supply only a subset of the regression or classification parameters, hyperparameter optimization occurs. It determines a value for each of the undefined parameters.", + "examples": { + "MlPutDataFrameAnalyticsExample1": { + "description": "An example body for a `PUT _ml/data_frame/analytics/model-flight-delays-pre` request.", + "method_request": "PUT _ml/data_frame/analytics/model-flight-delays-pre", + "value": "{\n \"source\": {\n \"index\": [\n \"kibana_sample_data_flights\"\n ],\n \"query\": {\n \"range\": {\n \"DistanceKilometers\": {\n \"gt\": 0\n }\n }\n },\n \"_source\": {\n \"includes\": [],\n \"excludes\": [\n \"FlightDelay\",\n \"FlightDelayType\"\n ]\n }\n },\n \"dest\": {\n \"index\": \"df-flight-delays\",\n \"results_field\": \"ml-results\"\n },\n \"analysis\": {\n \"regression\": {\n \"dependent_variable\": \"FlightDelayMin\",\n \"training_percent\": 90\n }\n },\n \"analyzed_fields\": {\n \"includes\": [],\n \"excludes\": [\n \"FlightNum\"\n ]\n },\n \"model_memory_limit\": \"100mb\"\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -189741,6 +190740,13 @@ ] }, "description": "Create a datafeed.\nDatafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.\nYou can associate only one datafeed with each anomaly detection job.\nThe datafeed contains a query that runs at a defined interval (`frequency`).\nIf you are concerned about delayed data, you can add a delay (`query_delay') at each interval.\nBy default, the datafeed uses the following query: `{\"match_all\": {\"boost\": 1}}`.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had\nat the time of creation and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.\nYou must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed\ndirectly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index.", + "examples": { + "MlPutDatafeedExample1": { + "description": "An example body for a `PUT _ml/datafeeds/datafeed-test-job?pretty` request.", + "method_request": "PUT _ml/datafeeds/datafeed-test-job?pretty", + "value": "{\n \"indices\": [\n \"kibana_sample_data_logs\"\n ],\n \"query\": {\n \"bool\": {\n \"must\": [\n {\n \"match_all\": {}\n }\n ]\n }\n },\n \"job_id\": \"test-job\"\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -190066,6 +191072,13 @@ ] }, "description": "Create a filter.\nA filter contains a list of strings. It can be used by one or more anomaly detection jobs.\nSpecifically, filters are referenced in the `custom_rules` property of detector configuration objects.", + "examples": { + "MlPutFilterExample1": { + "description": "An example body for a `PUT _ml/filters/safe_domains` request.", + "method_request": "PUT _ml/filters/safe_domains", + "value": "{\n \"description\": \"A list of safe domains\",\n \"items\": [\"*.google.com\", \"wikipedia.org\"]\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -191558,6 +192571,11 @@ "kind": "no_body" }, "description": "Create or update a trained model alias.\nA trained model alias is a logical name used to reference a single trained\nmodel.\nYou can use aliases instead of trained model identifiers to make it easier to\nreference your models. For example, you can use aliases in inference\naggregations and processors.\nAn alias must be unique and refer to only a single trained model. However,\nyou can have multiple aliases for each trained model.\nIf you use this API to update an alias such that it references a different\ntrained model ID and the model uses a different type of data frame analytics,\nan error occurs. For example, this situation occurs if you have a trained\nmodel for regression analysis and a trained model for classification\nanalysis; you cannot reassign an alias from one type of trained model to\nanother.\nIf you use this API to update an alias and there are very few input fields in\ncommon between the old and new trained models for the model alias, the API\nreturns a warning.", + "examples": { + "MlPutTrainedModelAliasExample1": { + "method_request": "PUT _ml/trained_models/flight-delay-prediction-1574775339910/model_aliases/flight_delay_model" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -191677,6 +192695,13 @@ ] }, "description": "Create part of a trained model definition.", + "examples": { + "MlPutTrainedModelDefinitionPartExample1": { + "description": "An example body for a `PUT _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/definition/0` request.", + "method_request": "PUT _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/definition/0", + "value": "{\n \"definition\": \"...\",\n \"total_definition_length\": 265632637,\n \"total_parts\": 64\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -191803,6 +192828,13 @@ ] }, "description": "Create a trained model vocabulary.\nThis API is supported only for natural language processing (NLP) models.\nThe vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition.", + "examples": { + "MlPutTrainedModelVocabularyExample1": { + "description": "An example body for a `PUT _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/vocabulary` request.", + "method_request": "PUT _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/vocabulary", + "value": "{\n \"vocabulary\": [\n \"[PAD]\",\n \"[unused0]\",\n ...\n ]\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -191858,6 +192890,11 @@ "kind": "no_body" }, "description": "Reset an anomaly detection job.\nAll model state and results are deleted. The job is ready to start over as if\nit had just been created.\nIt is not currently possible to reset multiple jobs using wildcards or a\ncomma separated list.", + "examples": { + "MlResetJobExample1": { + "method_request": "POST _ml/anomaly_detectors/total-requests/_reset" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -191955,6 +192992,13 @@ ] }, "description": "Revert to a snapshot.\nThe machine learning features react quickly to anomalous input, learning new\nbehaviors in data. Highly anomalous input increases the variance in the\nmodels whilst the system learns whether this is a new step-change in behavior\nor a one-off event. In the case where this anomalous input is known to be a\none-off, then it might be appropriate to reset the model state to a time\nbefore this event. For example, you might consider reverting to a saved\nsnapshot after Black Friday or a critical system failure.", + "examples": { + "MlRevertModelSnapshotExample1": { + "description": "An example body for a `POST _ml/anomaly_detectors/low_request_rate/model_snapshots/1637092688/_revert` request.", + "method_request": "POST _ml/anomaly_detectors/low_request_rate/model_snapshots/1637092688/_revert", + "value": "{\n \"delete_intervening_results\": true\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -192041,6 +193085,11 @@ "kind": "no_body" }, "description": "Set upgrade_mode for ML indices.\nSets a cluster wide upgrade_mode setting that prepares machine learning\nindices for an upgrade.\nWhen upgrading your cluster, in some circumstances you must restart your\nnodes and reindex your machine learning indices. In those circumstances,\nthere must be no machine learning jobs running. You can close the machine\nlearning jobs, do the upgrade, then open all the jobs again. Alternatively,\nyou can use this API to temporarily halt tasks associated with the jobs and\ndatafeeds and prevent new jobs from opening. You can also use this API\nduring upgrades that do not require you to reindex your machine learning\nindices, though stopping jobs is not a requirement in that case.\nYou can see the current value for the upgrade_mode setting by using the get\nmachine learning info API.", + "examples": { + "MlSetUpgradeModeExample1": { + "method_request": "POST _ml/set_upgrade_mode?enabled=true" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -192110,6 +193159,11 @@ "kind": "no_body" }, "description": "Start a data frame analytics job.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.\nIf the destination index does not exist, it is created automatically the\nfirst time you start the data frame analytics job. The\n`index.number_of_shards` and `index.number_of_replicas` settings for the\ndestination index are copied from the source index. If there are multiple\nsource indices, the destination index copies the highest setting values. The\nmappings for the destination index are also copied from the source indices.\nIf there are any mapping conflicts, the job fails to start.\nIf the destination index exists, it is used as is. You can therefore set up\nthe destination index in advance with custom settings and mappings.", + "examples": { + "MlStartDataFrameAnalyticsExample1": { + "method_request": "POST _ml/data_frame/analytics/loganalytics/_start" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -192235,6 +193289,13 @@ ] }, "description": "Start datafeeds.\n\nA datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.\n\nBefore you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.\n\nIf you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.\nIf new data was indexed for that exact millisecond between stopping and starting, it will be ignored.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or\nupdate it had at the time of creation or update and runs the query using those same roles. If you provided secondary\nauthorization headers when you created or updated the datafeed, those credentials are used instead.", + "examples": { + "MlStartDatafeedExample1": { + "description": "An example body for a `POST _ml/datafeeds/datafeed-low_request_rate/_start` request.", + "method_request": "POST _ml/datafeeds/datafeed-low_request_rate/_start", + "value": "{\n \"start\": \"2019-04-07T18:22:16Z\"\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -192360,6 +193421,11 @@ ] }, "description": "Start a trained model deployment.\nIt allocates the model to every machine learning node.", + "examples": { + "MlStartTrainedModelDeploymentExample1": { + "method_request": "POST _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/_start?wait_for=started&timeout=1m" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -192527,6 +193593,11 @@ "kind": "no_body" }, "description": "Stop data frame analytics jobs.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.", + "examples": { + "MlStopDataFrameAnalyticsExample1": { + "method_request": "POST _ml/data_frame/analytics/loganalytics/_stop" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -192668,6 +193739,13 @@ ] }, "description": "Stop datafeeds.\nA datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.", + "examples": { + "MlStopDatafeedExample1": { + "description": "An example body for a `POST _ml/datafeeds/datafeed-low_request_rate/_stop` request.", + "method_request": "POST _ml/datafeeds/datafeed-low_request_rate/_stop", + "value": "{\n \"timeout\": \"30s\"\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -192768,6 +193846,11 @@ "kind": "no_body" }, "description": "Stop a trained model deployment.", + "examples": { + "MlStopTrainedModelDeploymentExample1": { + "method_request": "POST _ml/trained_models/my_model_for_search/deployment/_stop" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -192912,6 +193995,13 @@ ] }, "description": "Update a data frame analytics job.", + "examples": { + "MlUpdateDataFrameAnalyticsExample1": { + "description": "An example body for a `POST _ml/data_frame/analytics/loganalytics/_update` request.", + "method_request": "POST _ml/data_frame/analytics/loganalytics/_update", + "value": "{\n \"model_memory_limit\": \"200mb\"\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -193280,6 +194370,13 @@ ] }, "description": "Update a datafeed.\nYou must stop and start the datafeed for the changes to be applied.\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at\nthe time of the update and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.", + "examples": { + "MlUpdateDatafeedExample1": { + "description": "An example body for a `POST _ml/datafeeds/datafeed-test-job/_update` request.", + "method_request": "POST _ml/datafeeds/datafeed-test-job/_update", + "value": "{\n \"query\": {\n \"term\": {\n \"geo.src\": \"US\"\n }\n }\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -193620,6 +194717,13 @@ ] }, "description": "Update a filter.\nUpdates the description of a filter, adds items, or removes items from the list.", + "examples": { + "MlUpdateFilterExample1": { + "description": "An example body for a `POST _ml/filters/safe_domains/_update` request.", + "method_request": "POST _ml/filters/safe_domains/_update", + "value": "{\n \"description\": \"Updated list of domains\",\n \"add_items\": [\"*.myorg.com\"],\n \"remove_items\": [\"wikipedia.org\"]\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -193909,6 +195013,13 @@ ] }, "description": "Update an anomaly detection job.\nUpdates certain properties of an anomaly detection job.", + "examples": { + "MlUpdateJobExample1": { + "description": "An example body for a `POST _ml/anomaly_detectors/low_request_rate/_update` request.", + "method_request": "POST _ml/anomaly_detectors/low_request_rate/_update", + "value": "{\n \"description\":\"An updated job\",\n \"detectors\": {\n \"detector_index\": 0,\n \"description\": \"An updated detector description\"\n },\n \"groups\": [\"kibana_sample_data\",\"kibana_sample_web_logs\"],\n \"model_plot_config\": {\n \"enabled\": true\n },\n \"renormalization_window_days\": 30,\n \"background_persist_interval\": \"2h\",\n \"model_snapshot_retention_days\": 7,\n \"results_retention_days\": 60\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -194248,6 +195359,13 @@ ] }, "description": "Update a snapshot.\nUpdates certain properties of a snapshot.", + "examples": { + "MlUpdateModelSnapshotExample1": { + "description": "An example body for a `POST` request.", + "method_request": "POST", + "value": "_ml/anomaly_detectors/it_ops_new_logs/model_snapshots/1491852978/_update\n{\n \"description\": \"Snapshot 1\",\n \"retain\": true\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -194358,6 +195476,13 @@ ] }, "description": "Update a trained model deployment.", + "examples": { + "MlUpdateTrainedModelDeploymentExample1": { + "description": "An example body for a `POST _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/_update` request.", + "method_request": "POST _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/_update", + "value": "{\n \"number_of_allocations\": 4\n}" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -194432,6 +195557,11 @@ "kind": "no_body" }, "description": "Upgrade a snapshot.\nUpgrade an anomaly detection model snapshot to the latest major version.\nOver time, older snapshot formats are deprecated and removed. Anomaly\ndetection jobs support only snapshots that are from the current or previous\nmajor version.\nThis API provides a means to upgrade a snapshot to the current major version.\nThis aids in preparing the cluster for an upgrade to the next major version.\nOnly one snapshot per anomaly detection job can be upgraded at a time and the\nupgraded snapshot cannot be the current snapshot of the anomaly detection\njob.", + "examples": { + "MlUpgradeJobSnapshotExample1": { + "method_request": "POST _ml/anomaly_detectors/low_request_rate/model_snapshots/1828371/_upgrade?timeout=45m&wait_for_completion=true" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -199820,6 +200950,11 @@ "kind": "no_body" }, "description": "Get the hot threads for nodes.\nGet a breakdown of the hot threads on each selected node in the cluster.\nThe output is plain text with a breakdown of the top hot threads for each node.", + "examples": { + "NodesHotThreadsExample1": { + "method_request": "GET /_nodes/hot_threads" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -202930,6 +204065,11 @@ "kind": "no_body" }, "description": "Get node information.\n\nBy default, the API returns all attributes and core settings for cluster nodes.", + "examples": { + "NodesInfoExample1": { + "method_request": "GET _nodes/_all/jvm" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -203224,6 +204364,11 @@ "kind": "no_body" }, "description": "Get node statistics.\nGet statistics for nodes in a cluster.\nBy default, all stats are returned. You can limit the returned information by using metrics.", + "examples": { + "NodesStatsExample1": { + "method_request": "GET _nodes/stats/process?filter_path=**.max_file_descriptors" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -203557,6 +204702,11 @@ "kind": "no_body" }, "description": "Get feature usage information.", + "examples": { + "NodesUsageExample1": { + "method_request": "GET _nodes/usage" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -203955,6 +205105,11 @@ "kind": "no_body" }, "description": "Delete a query rule.\nDelete a query rule within a query ruleset.\nThis is a destructive action that is only recoverable by re-adding the same rule with the create or update query rule API.", + "examples": { + "QueryRulesDeleteRuleExample1": { + "method_request": "DELETE _query_rules/my-ruleset/_rule/my-rule1" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -204022,6 +205177,11 @@ "kind": "no_body" }, "description": "Delete a query ruleset.\nRemove a query ruleset and its associated data.\nThis is a destructive action that is not recoverable.", + "examples": { + "QueryRulesDeleteRulesetExample1": { + "method_request": "DELETE _query_rules/my-ruleset/" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -204077,6 +205237,11 @@ "kind": "no_body" }, "description": "Get a query rule.\nGet details about a query rule within a query ruleset.", + "examples": { + "QueryRuleGetRequestExample1": { + "method_request": "GET _query_rules/my-ruleset/_rule/my-rule1" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -204132,7 +205297,6 @@ "examples": { "QueryRuleGetResponseExample1": { "description": "A successful response from `GET _query_rules/my-ruleset/_rule/my-rule1`.", - "method_request": "GET _query_rules/my-ruleset/_rule/my-rule1", "value": "{\n \"rule_id\": \"my-rule1\",\n \"type\": \"pinned\",\n \"criteria\": [\n {\n \"type\": \"contains\",\n \"metadata\": \"query_string\",\n \"values\": [\n \"pugs\",\n \"puggles\"\n ]\n }\n ],\n \"actions\": {\n \"ids\": [\n \"id1\",\n \"id2\"\n ]\n }\n}" } }, @@ -204151,6 +205315,11 @@ "kind": "no_body" }, "description": "Get a query ruleset.\nGet details about a query ruleset.", + "examples": { + "QueryRulesetGetRequestExample1": { + "method_request": "GET _query_rules/my-ruleset/" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -204194,7 +205363,6 @@ "examples": { "QueryRulesetGetResponseExample1": { "description": "A successful response from `GET _query_rules/my-ruleset/`.", - "method_request": "GET _query_rules/my-ruleset/", "value": "{\n \"ruleset_id\": \"my-ruleset\",\n \"rules\": [\n {\n \"rule_id\": \"my-rule1\",\n \"type\": \"pinned\",\n \"criteria\": [\n {\n \"type\": \"contains\",\n \"metadata\": \"query_string\",\n \"values\": [ \"pugs\", \"puggles\" ]\n }\n ],\n \"actions\": {\n \"ids\": [\n \"id1\",\n \"id2\"\n ]\n }\n },\n {\n \"rule_id\": \"my-rule2\",\n \"type\": \"pinned\",\n \"criteria\": [\n {\n \"type\": \"fuzzy\",\n \"metadata\": \"query_string\",\n \"values\": [ \"rescue dogs\" ]\n }\n ],\n \"actions\": {\n \"docs\": [\n {\n \"_index\": \"index1\",\n \"_id\": \"id3\"\n },\n {\n \"_index\": \"index2\",\n \"_id\": \"id4\"\n }\n ]\n }\n }\n ]\n}" } }, @@ -204293,6 +205461,11 @@ "kind": "no_body" }, "description": "Get all query rulesets.\nGet summarized information about the query rulesets.", + "examples": { + "QueryRulesetListRequestExample1": { + "method_request": "GET _query_rules/?from=0&size=3" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -204368,7 +205541,6 @@ "examples": { "QueryRulesetListResponseExample1": { "description": "A successful response from `GET _query_rules/?from=0&size=3`.", - "method_request": "GET _query_rules/?from=0&size=3", "value": "{\n \"count\": 3,\n \"results\": [\n {\n \"ruleset_id\": \"ruleset-1\",\n \"rule_total_count\": 1,\n \"rule_criteria_types_counts\": {\n \"exact\": 1\n }\n },\n {\n \"ruleset_id\": \"ruleset-2\",\n \"rule_total_count\": 2,\n \"rule_criteria_types_counts\": {\n \"exact\": 1,\n \"fuzzy\": 1\n }\n },\n {\n \"ruleset_id\": \"ruleset-3\",\n \"rule_total_count\": 3,\n \"rule_criteria_types_counts\": {\n \"exact\": 1,\n \"fuzzy\": 2\n }\n }\n ]\n}" } }, @@ -204749,7 +205921,6 @@ "examples": { "QueryRulesetTestResponseExample1": { "description": "A successful response from `POST _query_rules/my-ruleset/_test`.", - "method_request": "POST _query_rules/my-ruleset/_test", "value": "{\n \"total_matched_rules\": 1,\n \"matched_rules\": [\n {\n \"ruleset_id\": \"my-ruleset\",\n \"rule_id\": \"my-rule1\"\n }\n ]\n}" } }, @@ -205032,6 +206203,11 @@ "version": "8.11.0" }, "description": "Delete a rollup job.\n\nA job must be stopped before it can be deleted.\nIf you attempt to delete a started job, an error occurs.\nSimilarly, if you attempt to delete a nonexistent job, an exception occurs.\n\nIMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data.\nThe API does not delete any previously rolled up data.\nThis is by design; a user may wish to roll up a static data set.\nBecause the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data).\nThus the job can be deleted, leaving behind the rolled up data for analysis.\nIf you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index.\nIf the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example:\n\n```\nPOST my_rollup_index/_delete_by_query\n{\n \"query\": {\n \"term\": {\n \"_rollup.id\": \"the_rollup_job_id\"\n }\n }\n}\n```", + "examples": { + "DeleteRollupJobRequestExample1": { + "method_request": "DELETE _rollup/job/sensor" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -205094,7 +206270,6 @@ "examples": { "DeleteRollupJobResponseExample1": { "description": "A successful response from `DELETE _rollup/job/sensor`.", - "method_request": "DELETE _rollup/job/sensor", "value": "{\n \"acknowledged\": true\n}" } }, @@ -205142,6 +206317,11 @@ "version": "8.11.0" }, "description": "Get rollup job information.\nGet the configuration, stats, and status of rollup jobs.\n\nNOTE: This API returns only active (both `STARTED` and `STOPPED`) jobs.\nIf a job was created, ran for a while, then was deleted, the API does not return any details about it.\nFor details about a historical rollup job, the rollup capabilities API may be more useful.", + "examples": { + "GetRollupJobRequestExample1": { + "method_request": "GET _rollup/job/sensor" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -205193,7 +206373,6 @@ "examples": { "GetRollupJobResponseExample1": { "description": "A successful response from `GET _rollup/job/sensor`.", - "method_request": "GET _rollup/job/sensor", "value": "{\n \"jobs\": [\n {\n \"config\": {\n \"id\": \"sensor\",\n \"index_pattern\": \"sensor-*\",\n \"rollup_index\": \"sensor_rollup\",\n \"cron\": \"*/30 * * * * ?\",\n \"groups\": {\n \"date_histogram\": {\n \"fixed_interval\": \"1h\",\n \"delay\": \"7d\",\n \"field\": \"timestamp\",\n \"time_zone\": \"UTC\"\n },\n \"terms\": {\n \"fields\": [\n \"node\"\n ]\n }\n },\n \"metrics\": [\n {\n \"field\": \"temperature\",\n \"metrics\": [\n \"min\",\n \"max\",\n \"sum\"\n ]\n },\n {\n \"field\": \"voltage\",\n \"metrics\": [\n \"avg\"\n ]\n }\n ],\n \"timeout\": \"20s\",\n \"page_size\": 1000\n },\n \"status\": {\n \"job_state\": \"stopped\"\n },\n \"stats\": {\n \"pages_processed\": 0,\n \"documents_processed\": 0,\n \"rollups_indexed\": 0,\n \"trigger_count\": 0,\n \"index_failures\": 0,\n \"index_time_in_ms\": 0,\n \"index_total\": 0,\n \"search_failures\": 0,\n \"search_time_in_ms\": 0,\n \"search_total\": 0,\n \"processing_time_in_ms\": 0,\n \"processing_total\": 0\n }\n }\n ]\n}" } }, @@ -205582,6 +206761,11 @@ "version": "8.11.0" }, "description": "Get the rollup job capabilities.\nGet the capabilities of any rollup jobs that have been configured for a specific index or index pattern.\n\nThis API is useful because a rollup job is often configured to rollup only a subset of fields from the source index.\nFurthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration.\nThis API enables you to inspect an index and determine:\n\n1. Does this index have associated rollup data somewhere in the cluster?\n2. If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live?", + "examples": { + "GetRollupCapabilitiesRequestExample1": { + "method_request": "GET _rollup/data/sensor-*" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -205636,7 +206820,6 @@ "examples": { "GetRollupCapabilitiesResponseExample1": { "description": "A successful response from `GET _rollup/data/sensor-*` for a rollup job that targets the index pattern `sensor-*`. The response contains the rollup job ID, the index that holds the rolled data, and the index pattern that the job was targeting. It also shows a list of fields that contain data eligible for rollup searches. For example, you can use a `min`, `max`, or `sum` aggregation on the `temperature` field, but only a `date_histogram` on `timestamp`.\n", - "method_request": "GET _rollup/data/sensor-*", "value": "{\n \"sensor-*\" : {\n \"rollup_jobs\" : [\n {\n \"job_id\" : \"sensor\",\n \"rollup_index\" : \"sensor_rollup\",\n \"index_pattern\" : \"sensor-*\",\n \"fields\" : {\n \"node\" : [\n {\n \"agg\" : \"terms\"\n }\n ],\n \"temperature\" : [\n {\n \"agg\" : \"min\"\n },\n {\n \"agg\" : \"max\"\n },\n {\n \"agg\" : \"sum\"\n }\n ],\n \"timestamp\" : [\n {\n \"agg\" : \"date_histogram\",\n \"time_zone\" : \"UTC\",\n \"fixed_interval\" : \"1h\",\n \"delay\": \"7d\"\n }\n ],\n \"voltage\" : [\n {\n \"agg\" : \"avg\"\n }\n ]\n }\n }\n ]\n }\n}" } }, @@ -205819,6 +207002,11 @@ "version": "8.11.0" }, "description": "Get the rollup index capabilities.\nGet the rollup capabilities of all jobs inside of a rollup index.\nA single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine:\n\n* What jobs are stored in an index (or indices specified via a pattern)?\n* What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job?", + "examples": { + "GetRollupIndexCapabilitiesRequestExample1": { + "method_request": "GET /sensor_rollup/_rollup/data" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -205873,7 +207061,6 @@ "examples": { "GetRollupIndexCapabilitiesResponseExample1": { "description": "A successful response from `GET /sensor_rollup/_rollup/data`. The response contains the rollup job ID, the index that holds the rolled data, and the index pattern that the job was targeting. It also shows a list of fields that contain data eligible for rollup searches. For example, you can use a `min`, `max`, or `sum` aggregation on the `temperature` field, but only a `date_histogram` on `timestamp`.\n", - "method_request": "GET /sensor_rollup/_rollup/data", "value": "{\n \"sensor_rollup\" : {\n \"rollup_jobs\" : [\n {\n \"job_id\" : \"sensor\",\n \"rollup_index\" : \"sensor_rollup\",\n \"index_pattern\" : \"sensor-*\",\n \"fields\" : {\n \"node\" : [\n {\n \"agg\" : \"terms\"\n }\n ],\n \"temperature\" : [\n {\n \"agg\" : \"min\"\n },\n {\n \"agg\" : \"max\"\n },\n {\n \"agg\" : \"sum\"\n }\n ],\n \"timestamp\" : [\n {\n \"agg\" : \"date_histogram\",\n \"time_zone\" : \"UTC\",\n \"fixed_interval\" : \"1h\",\n \"delay\": \"7d\"\n }\n ],\n \"voltage\" : [\n {\n \"agg\" : \"avg\"\n }\n ]\n }\n }\n ]\n }\n}" } }, @@ -206390,7 +207577,6 @@ "examples": { "RollupSearchResponseExample1": { "description": "An abbreviated response from `GET /sensor_rollup/_rollup_search` with a `max` aggregation on a `temperature` field. The response provides some metadata about the request (`took`, `_shards`), the search hits (which is always empty for rollup searches), and the aggregation response.\n", - "method_request": "GET /sensor_rollup/_rollup_search", "value": "{\n \"took\" : 102,\n \"timed_out\" : false,\n \"terminated_early\" : false,\n \"_shards\" : {} ,\n \"hits\" : {\n \"total\" : {\n \"value\": 0,\n \"relation\": \"eq\"\n },\n \"max_score\" : 0.0,\n \"hits\" : [ ]\n },\n \"aggregations\" : {\n \"max_temperature\" : {\n \"value\" : 202.0\n }\n }\n}" } }, @@ -206419,6 +207605,11 @@ "version": "8.11.0" }, "description": "Start rollup jobs.\nIf you try to start a job that does not exist, an exception occurs.\nIf you try to start a job that is already started, nothing happens.", + "examples": { + "StartRollupJobRequestExample1": { + "method_request": "POST _rollup/job/sensor/_start" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -206467,7 +207658,6 @@ "examples": { "StartRollupJobResponseExample1": { "description": "A successful response from `POST _rollup/job/sensor/_start`.", - "method_request": "POST _rollup/job/sensor/_start", "value": "{\n \"started\": true\n}" } }, @@ -206490,6 +207680,11 @@ "version": "8.11.0" }, "description": "Stop rollup jobs.\nIf you try to stop a job that does not exist, an exception occurs.\nIf you try to stop a job that is already stopped, nothing happens.\n\nSince only a stopped job can be deleted, it can be useful to block the API until the indexer has fully stopped.\nThis is accomplished with the `wait_for_completion` query parameter, and optionally a timeout. For example:\n\n```\nPOST _rollup/job/sensor/_stop?wait_for_completion=true&timeout=10s\n```\nThe parameter blocks the API call from returning until either the job has moved to STOPPED or the specified time has elapsed.\nIf the specified time elapses without the job moving to STOPPED, a timeout exception occurs.", + "examples": { + "RollupStopJobExample1": { + "method_request": "POST _rollup/job/sensor/_stop?wait_for_completion=true&timeout=10s" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -206762,6 +207957,11 @@ "kind": "no_body" }, "description": "Delete a search application.\n\nRemove a search application and its associated alias. Indices attached to the search application are not removed.", + "examples": { + "SearchApplicationDeleteExample1": { + "method_request": "DELETE _application/search_application/my-app/" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -206821,6 +208021,11 @@ "version": "9.0.0" }, "description": "Delete a behavioral analytics collection.\nThe associated data stream is also deleted.", + "examples": { + "SearchApplicationDeleteBehavioralAnalyticsExample1": { + "method_request": "DELETE _application/analytics/my_analytics_collection/" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -206876,6 +208081,11 @@ "kind": "no_body" }, "description": "Get search application details.", + "examples": { + "SearchApplicationGetRequestExample1": { + "method_request": "GET _application/search_application/my-app/" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -206919,7 +208129,6 @@ "examples": { "SearchApplicationGetResponseExample1": { "description": "A sucessful response from `GET _application/search_application/my-app/`.", - "method_request": "GET _application/search_application/my-app/", "value": "{\n \"name\": \"my-app\",\n \"indices\": [ \"index1\", \"index2\" ],\n \"updated_at_millis\": 1682105622204,\n \"template\": {\n \"script\": {\n \"source\": {\n \"query\": {\n \"query_string\": {\n \"query\": \"{{query_string}}\",\n \"default_field\": \"{{default_field}}\"\n }\n }\n },\n \"lang\": \"mustache\",\n \"options\": {\n \"content_type\": \"application/json;charset=utf-8\"\n },\n \"params\": {\n \"query_string\": \"*\",\n \"default_field\": \"*\"\n }\n }\n }\n}" } }, @@ -206942,6 +208151,11 @@ "version": "9.0.0" }, "description": "Get behavioral analytics collections.", + "examples": { + "BehavioralAnalyticsGetRequestExample1": { + "method_request": "GET _application/analytics/my*" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -206999,7 +208213,6 @@ "examples": { "BehavioralAnalyticsGetResponseExample1": { "description": "A successful response from `GET _application/analytics/my*`", - "method_request": "GET _application/analytics/my*", "value": "{\n \"my_analytics_collection\": {\n \"event_data_stream\": {\n \"name\": \"behavioral_analytics-events-my_analytics_collection\"\n }\n },\n \"my_analytics_collection2\": {\n \"event_data_stream\": {\n \"name\": \"behavioral_analytics-events-my_analytics_collection2\"\n }\n }\n}" } }, @@ -207018,6 +208231,11 @@ "kind": "no_body" }, "description": "Get search applications.\nGet information about search applications.", + "examples": { + "SearchApplicationsListRequestExample1": { + "method_request": "GET _application/search_application?from=0&size=3&q=app*" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -207105,7 +208323,6 @@ "examples": { "SearchApplicationsListResponseExample1": { "description": "A succesful response from `GET _application/search_application?from=0&size=3&q=app*` returns the first three search applications whose names start with `app`.", - "method_request": "GET _application/search_application?from=0&size=3&q=app*", "value": "{\n \"count\": 2,\n \"results\": [\n {\n \"name\": \"app-1\",\n \"updated_at_millis\": 1690981129366\n },\n {\n \"name\": \"app-2\",\n \"updated_at_millis\": 1691501823939\n }\n ]\n}" } }, @@ -207381,6 +208598,11 @@ "version": "9.0.0" }, "description": "Create a behavioral analytics collection.", + "examples": { + "SearchApplicationPutBehavioralAnalyticsExample1": { + "method_request": "PUT _application/analytics/my_analytics_collection" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -207675,6 +208897,11 @@ "kind": "no_body" }, "description": "Get cache statistics.\nGet statistics about the shared cache for partially mounted indices.", + "examples": { + "CacheStatsRequestExample1": { + "method_request": "GET /_searchable_snapshots/cache/stats" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -207746,7 +208973,6 @@ "examples": { "CacheStatsResponseExample1": { "description": "A successful response from `GET /_searchable_snapshots/cache/stats`.", - "method_request": "GET /_searchable_snapshots/cache/stats", "value": "{\n \"nodes\" : {\n \"eerrtBMtQEisohZzxBLUSw\" : {\n \"shared_cache\" : {\n \"reads\" : 6051,\n \"bytes_read_in_bytes\" : 5448829,\n \"writes\" : 37,\n \"bytes_written_in_bytes\" : 1208320,\n \"evictions\" : 5,\n \"num_regions\" : 65536,\n \"size_in_bytes\" : 1099511627776,\n \"region_size_in_bytes\" : 16777216\n }\n }\n }\n}" } }, @@ -207863,6 +209089,11 @@ "kind": "no_body" }, "description": "Clear the cache.\nClear indices and data streams from the shared cache for partially mounted indices.", + "examples": { + "SearchableSnapshotsClearCacheExample1": { + "method_request": "POST /my-index/_searchable_snapshots/cache/clear" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -208174,6 +209405,11 @@ "kind": "no_body" }, "description": "Get searchable snapshot statistics.", + "examples": { + "SearchableSnapshotsStatsExample1": { + "method_request": "GET /my-index/_searchable_snapshots/stats" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -211209,7 +212445,6 @@ "examples": { "ActivateUserProfileResponseExample1": { "description": "A successful response from `POST /_security/profile/_activate`.", - "method_request": "POST /_security/profile/_activate", "value": "{\n \"uid\": \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\",\n \"enabled\": true,\n \"last_synchronized\": 1642650651037,\n \"user\": {\n \"username\": \"jacknich\",\n \"roles\": [\n \"admin\", \"other_role1\"\n ],\n \"realm_name\": \"native\",\n \"full_name\": \"Jack Nicholson\",\n \"email\": \"jacknich@example.com\"\n },\n \"labels\": {},\n \"data\": {},\n \"_doc\": {\n \"_primary_term\": 88,\n \"_seq_no\": 66\n }\n}" } }, @@ -211260,6 +212495,11 @@ "kind": "no_body" }, "description": "Authenticate a user.\n\nAuthenticates a user and returns information about the authenticated user.\nInclude the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication).\nA successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user.\nIf the user cannot be authenticated, this API returns a 401 status code.", + "examples": { + "SecurityAuthenticateRequestExample1": { + "method_request": "GET /_security/_authenticate" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -211438,7 +212678,6 @@ "examples": { "SecurityAuthenticateResponseExample1": { "description": "A successful response from `GET /_security/_authenticate`.", - "method_request": "GET /_security/_authenticate", "value": "{\n \"username\": \"rdeniro\",\n \"roles\": [\n \"admin\"\n ],\n \"full_name\": null,\n \"email\": null,\n \"metadata\": { },\n \"enabled\": true,\n \"authentication_realm\": {\n \"name\" : \"file\",\n \"type\" : \"file\"\n },\n \"lookup_realm\": {\n \"name\" : \"file\",\n \"type\" : \"file\"\n },\n \"authentication_type\": \"realm\"\n}" } }, @@ -211599,19 +212838,16 @@ "examples": { "SecurityBulkDeleteRoleResponseExample1": { "description": "A successful response from `DELETE /_security/role`.", - "method_request": "DELETE /_security/role", "summary": "A successful response", "value": "{\n \"deleted\": [\n \"my_admin_role\",\n \"my_user_role\"\n ]\n}" }, "SecurityBulkDeleteRoleResponseExample2": { "description": "A partially successful response from `DELETE /_security/role`. If a role cannot be found, it appears in the `not_found` list in the response.\n", - "method_request": "DELETE /_security/role", "summary": "A response with not_found roles", "value": "{\n \"deleted\": [\n \"my_admin_role\"\n ],\n \"not_found\": [\n \"not_an_existing_role\"\n ]\n}" }, "SecurityBulkDeleteRoleResponseExample3": { "description": "A partially successful response from `DELETE /_security/role`. If part of a request fails or is invalid, the response includes `errors`.\n", - "method_request": "DELETE /_security/role", "summary": "A response with errors", "value": "{\n \"deleted\": [\n \"my_admin_role\"\n ],\n \"errors\": {\n \"count\": 1,\n \"details\": {\n \"superuser\": {\n \"type\": \"illegal_argument_exception\",\n \"reason\": \"role [superuser] is reserved and cannot be deleted\"\n }\n }\n }\n}" } @@ -211770,13 +213006,11 @@ "examples": { "SecurityBulkPutRoleResponseExample1": { "description": "A successful response from `POST /_security/role/my_admin_role` returns a JSON structure that shows whether the role has been created, updated, or had no changes made.\n", - "method_request": "POST /_security/role/my_admin_role", "summary": "A successful response", "value": "{\n \"created\": [ \n \"my_admin_role\", \n \"my_user_role\"\n ]\n}" }, "SecurityBulkPutRoleResponseExample2": { "description": "A partially successful response from `POST /_security/role`. Errors are handled individually for each role create or update, thus the API allows partial success. In this example, the creation of the `my_user_role` role succeeds and the `my_admin_role` role fails.\n", - "method_request": "POST /_security/role", "summary": "A partially successful response", "value": "{\n \"created\": [\n \"my_user_role\" \n ],\n \"errors\": { \n \"count\": 1, \n \"details\": {\n \"my_admin_role\": { \n \"type\": \"action_request_validation_exception\",\n \"reason\": \"Validation Failed: 1: unknown cluster privilege [bad_cluster_privilege]. a privilege must be either one of the predefined cluster privilege names [manage_own_api_key,manage_data_stream_global_retention,monitor_data_stream_global_retention,none,cancel_task,cross_cluster_replication,cross_cluster_search,delegate_pki,grant_api_key,manage_autoscaling,manage_index_templates,manage_logstash_pipelines,manage_oidc,manage_saml,manage_search_application,manage_search_query_rules,manage_search_synonyms,manage_service_account,manage_token,manage_user_profile,monitor_connector,monitor_enrich,monitor_inference,monitor_ml,monitor_rollup,monitor_snapshot,monitor_stats,monitor_text_structure,monitor_watcher,post_behavioral_analytics_event,read_ccr,read_connector_secrets,read_fleet_secrets,read_ilm,read_pipeline,read_security,read_slm,transport_client,write_connector_secrets,write_fleet_secrets,create_snapshot,manage_behavioral_analytics,manage_ccr,manage_connector,manage_enrich,manage_ilm,manage_inference,manage_ml,manage_rollup,manage_slm,manage_watcher,monitor_data_frame_transforms,monitor_transform,manage_api_key,manage_ingest_pipelines,manage_pipeline,manage_data_frame_transforms,manage_transform,manage_security,monitor,manage,all] or a pattern over one of the available cluster actions;\"\n }\n }\n }\n}" } @@ -212057,6 +213291,11 @@ "kind": "no_body" }, "description": "Clear the API key cache.\n\nEvict a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index.", + "examples": { + "SecurityClearApiKeyCacheExample1": { + "method_request": "POST /_security/api_key/yVGMr3QByxdh1MSaicYx/_clear_cache" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -212151,6 +213390,11 @@ "kind": "no_body" }, "description": "Clear the privileges cache.\n\nEvict privileges from the native application privilege cache.\nThe cache is also automatically cleared for applications that have their privileges updated.", + "examples": { + "SecurityClearCachedPrivilegesExample1": { + "method_request": "POST /_security/privilege/myapp/_clear_cache" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -212245,6 +213489,11 @@ "kind": "no_body" }, "description": "Clear the user cache.\n\nEvict users from the user cache.\nYou can completely clear the cache or evict specific users.\n\nUser credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request.\nThere are realm settings that you can use to configure the user cache.\nFor more information, refer to the documentation about controlling the user cache.", + "examples": { + "SecurityClearCachedRealmsExample1": { + "method_request": "POST /_security/realm/default_file/_clear_cache" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -212355,6 +213604,11 @@ "kind": "no_body" }, "description": "Clear the roles cache.\n\nEvict roles from the native role cache.", + "examples": { + "SecurityClearCachedRolesExample1": { + "method_request": "POST /_security/role/my_admin_role/_clear_cache" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -212449,6 +213703,11 @@ "kind": "no_body" }, "description": "Clear service account token caches.\n\nEvict a subset of all entries from the service account token caches.\nTwo separate caches exist for service account tokens: one cache for tokens backed by the `service_tokens` file, and another for tokens backed by the `.security` index.\nThis API clears matching entries from both caches.\n\nThe cache for service account tokens backed by the `.security` index is cleared automatically on state changes of the security index.\nThe cache for tokens backed by the `service_tokens` file is cleared automatically on file changes.", + "examples": { + "SecurityClearCachedServiceTokensExample1": { + "method_request": "POST /_security/service/elastic/fleet-server/credential/token/token1/_clear_cache" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -212746,7 +214005,6 @@ "examples": { "SecurityCreateApiKeyResponseExample1": { "description": "A successful response from `POST /_security/api_key`.", - "method_request": "POST /_security/api_key", "value": "{\n \"id\": \"VuaCfGcBCdbkQm-e5aOx\", \n \"name\": \"my-api-key\",\n \"expiration\": 1544068612110, \n \"api_key\": \"ui2lp2axTNmsyakw9tvNnw\", \n \"encoded\": \"VnVhQ2ZHY0JDZGJrUW0tZTVhT3g6dWkybHAyYXhUTm1zeWFrdzl0dk5udw==\" \n}" } }, @@ -212915,7 +214173,6 @@ "examples": { "CreateCrossClusterApiKeyResponseExample1": { "description": "A successful response from `POST /_security/service/elastic/fleet-server/credential/token`.\n", - "method_request": "POST /_security/service/elastic/fleet-server/credential/token", "value": "{\n \"created\": true,\n \"token\": {\n \"name\": \"Jk5J1HgBuyBK5TpDrdo4\",\n \"value\": \"AAEAAWVsYXN0aWM...vZmxlZXQtc2VydmVyL3Rva2VuMTo3TFdaSDZ\"\n }\n}" } }, @@ -212934,6 +214191,11 @@ "kind": "no_body" }, "description": "Create a service account token.\n\nCreate a service accounts token for access without requiring basic authentication.\n\nNOTE: Service account tokens never expire.\nYou must actively delete them if they are no longer needed.", + "examples": { + "CreateServiceTokenRequestExample1": { + "method_request": "POST /_security/service/elastic/fleet-server/credential/token/token1" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -213030,7 +214292,6 @@ "examples": { "CreateServiceTokenRequestExample1": { "description": "A successful response from `POST /_security/service/elastic/fleet-server/credential/token/token1`. The response includes the service account token, its name, and its secret value as a bearer token.\n", - "method_request": "POST /_security/service/elastic/fleet-server/credential/token/token1", "value": "{\n \"created\": true,\n \"token\": {\n \"name\": \"token1\",\n \"value\": \"AAEAAWVsYXN0aWM...vZmxlZXQtc2VydmVyL3Rva2VuMTo3TFdaSDZ\" \n }\n}" } }, @@ -213437,6 +214698,11 @@ "kind": "no_body" }, "description": "Delete application privileges.\n\nTo use this API, you must have one of the following privileges:\n\n* The `manage_security` cluster privilege (or a greater privilege such as `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request.", + "examples": { + "SecurityDeletePrivilegesRequestExample1": { + "method_request": "DELETE /_security/privilege/myapp/read" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -213527,7 +214793,6 @@ "examples": { "SecurityDeletePrivilegesResponseExample1": { "description": "A successful response from `DELETE /_security/privilege/myapp/read`. If the privilege is successfully deleted, `found` is set to `true`.\n", - "method_request": "DELETE /_security/privilege/myapp/read", "value": "{\n \"myapp\": {\n \"read\": {\n \"found\" : true\n }\n }\n}" } }, @@ -213546,6 +214811,11 @@ "kind": "no_body" }, "description": "Delete roles.\n\nDelete roles in the native realm.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe delete roles API cannot remove roles that are defined in roles files.", + "examples": { + "SecurityDeleteRoleRequestExample1": { + "method_request": "DELETE /_security/role/my_admin_role" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -213608,7 +214878,6 @@ "examples": { "SecurityDeleteRoleResponseExample1": { "description": "A successful response from `DELETE /_security/role/my_admin_role`. If the role is successfully deleted, `found` is set to `true`.\n", - "method_request": "DELETE /_security/role/my_admin_role", "value": "{\n \"found\" : true\n}" } }, @@ -213627,6 +214896,11 @@ "kind": "no_body" }, "description": "Delete role mappings.\n\nRole mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe delete role mappings API cannot remove role mappings that are defined in role mapping files.", + "examples": { + "SecurityDeleteRoleMappingRequestExample1": { + "method_request": "DELETE /_security/role_mapping/mapping1" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -213689,7 +214963,6 @@ "examples": { "SecurityDeleteRoleMappingResponseExample1": { "description": "A successful response from `DELETE /_security/role_mapping/mapping1`. If the mapping is successfully deleted, `found` is `true`.\n", - "method_request": "DELETE /_security/role_mapping/mapping1", "value": "{\n \"found\" : true\n}" } }, @@ -213708,6 +214981,11 @@ "kind": "no_body" }, "description": "Delete service account tokens.\n\nDelete service account tokens for a service in a specified namespace.", + "examples": { + "DeleteServiceTokenRequestExample1": { + "method_request": "DELETE /_security/service/elastic/fleet-server/credential/token/token42" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -213794,7 +215072,6 @@ "examples": { "DeleteServiceTokenResponseExample1": { "description": "A successful response from `DELETE /_security/service/elastic/fleet-server/credential/token/token42`.\n", - "method_request": "DELETE /_security/service/elastic/fleet-server/credential/token/token42", "value": "{\n \"found\" : true\n}" } }, @@ -213813,6 +215090,11 @@ "kind": "no_body" }, "description": "Delete users.\n\nDelete users from the native realm.", + "examples": { + "SecurityDeleteUserRequestExample1": { + "method_request": "DELETE /_security/user/jacknich" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -213875,7 +215157,6 @@ "examples": { "SecurityDeleteUserResponseExample1": { "description": "A successful response from `DELETE /_security/user/jacknich`.\n", - "method_request": "DELETE /_security/user/jacknich", "value": "{\n \"found\" : true\n}" } }, @@ -213894,6 +215175,11 @@ "kind": "no_body" }, "description": "Disable users.\n\nDisable users in the native realm.\nBy default, when you create users, they are enabled.\nYou can use this API to revoke a user's access to Elasticsearch.", + "examples": { + "SecurityDisableUserExample1": { + "method_request": "PUT /_security/user/jacknich/_disable" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -213955,6 +215241,11 @@ "kind": "no_body" }, "description": "Disable a user profile.\n\nDisable user profiles so that they are not visible in user profile searches.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nWhen you activate a user profile, its automatically enabled and visible in user profile searches. You can use the disable user profile API to disable a user profile so it’s not visible in these searches.\nTo re-enable a disabled user profile, use the enable user profile API .", + "examples": { + "SecurityDisableUserProfileExample1": { + "method_request": "POST /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0/_disable" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -214024,6 +215315,11 @@ "kind": "no_body" }, "description": "Enable users.\n\nEnable users in the native realm.\nBy default, when you create users, they are enabled.", + "examples": { + "SecurityEnableUserExample1": { + "method_request": "PUT _security/user/logstash_system/_enable" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -214085,6 +215381,11 @@ "kind": "no_body" }, "description": "Enable a user profile.\n\nEnable user profiles to make them visible in user profile searches.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nWhen you activate a user profile, it's automatically enabled and visible in user profile searches.\nIf you later disable the user profile, you can use the enable user profile API to make the profile visible in these searches again.", + "examples": { + "SecurityEnableUserProfileExample1": { + "method_request": "POST /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0/_enable" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -214154,6 +215455,11 @@ "kind": "no_body" }, "description": "Enroll Kibana.\n\nEnable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.\n\nNOTE: This API is currently intended for internal use only by Kibana.\nKibana uses this API internally to configure itself for communications with an Elasticsearch cluster that already has security features enabled.", + "examples": { + "EnrollKibanaRequestExample1": { + "method_request": "GET /_security/enroll/kibana" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -214201,7 +215507,6 @@ "examples": { "EnrollKibanaResponseExample1": { "description": "A successful response from `GET /_security/enroll/kibana`.", - "method_request": "GET /_security/enroll/kibana", "value": "{\n \"token\" : {\n \"name\" : \"enroll-process-token-1629123923000\", \n \"value\": \"AAEAAWVsYXN0aWM...vZmxlZXQtc2VydmVyL3Rva2VuMTo3TFdaSDZ\" \n },\n \"http_ca\" : \"MIIJlAIBAzVoGCSqGSIb3...vsDfsA3UZBAjEPfhubpQysAICAA=\", \n}" } }, @@ -214371,6 +215676,11 @@ "kind": "no_body" }, "description": "Get API key information.\n\nRetrieves information for one or more API keys.\nNOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.\nIf you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.", + "examples": { + "SecurityGetApiKeyRequestExample2": { + "method_request": "GET /_security/api_key?username=myuser&realm_name=native1" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -214528,13 +215838,11 @@ "examples": { "SecurityGetApiKeyResponseExample1": { "description": "A successful response from `GET /_security/api_key?id=VuaCfGcBCdbkQm-e5aOx&with_limited_by=true`.", - "method_request": "GET /_security/api_key?id=VuaCfGcBCdbkQm-e5aOx&with_limited_by=true", "summary": "Get a key by ID", "value": "{\n \"api_keys\": [ \n {\n \"id\": \"VuaCfGcBCdbkQm-e5aOx\", \n \"name\": \"my-api-key\", \n \"creation\": 1548550550158, \n \"expiration\": 1548551550158, \n \"invalidated\": false, \n \"username\": \"myuser\", \n \"realm\": \"native1\", \n \"realm_type\": \"native\",\n \"metadata\": { \n \"application\": \"myapp\"\n },\n \"role_descriptors\": { }, \n \"limited_by\": [ \n {\n \"role-power-user\": {\n \"cluster\": [\n \"monitor\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"*\"\n ],\n \"privileges\": [\n \"read\"\n ],\n \"allow_restricted_indices\": false\n }\n ],\n \"applications\": [ ],\n \"run_as\": [ ],\n \"metadata\": { },\n \"transient_metadata\": {\n \"enabled\": true\n }\n }\n }\n ]\n }\n ]\n}" }, "SecurityGetApiKeyResponseExample2": { "description": "A successful response from `GET /_security/api_key?username=myuser&realm_name=native1`. The response contains all API keys for the user `myuser` in the `native1` realm.\n", - "method_request": "GET /_security/api_key?username=myuser&realm_name=native1", "summary": "Get all keys for a user", "value": "{\n \"api_keys\": [\n {\n \"id\": \"0GF5GXsBCXxz2eDxWwFN\",\n \"name\": \"hadoop_myuser_key\",\n \"creation\": 1548550550158,\n \"expiration\": 1548551550158,\n \"invalidated\": false,\n \"username\": \"myuser\",\n \"realm\": \"native1\",\n \"realm_type\": \"native\",\n \"metadata\": {\n \"application\": \"myapp\"\n },\n \"role_descriptors\": {\n \"role-a\": {\n \"cluster\": [\n \"monitor\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index-a\"\n ],\n \"privileges\": [\n \"read\"\n ],\n \"allow_restricted_indices\": false\n }\n ],\n \"applications\": [ ],\n \"run_as\": [ ],\n \"metadata\": { },\n \"transient_metadata\": {\n \"enabled\": true\n }\n }\n }\n },\n {\n \"id\": \"6wHJmcQpReKBa42EHV5SBw\",\n \"name\": \"api-key-name-2\",\n \"creation\": 1548550550158,\n \"invalidated\": false,\n \"username\": \"user-y\",\n \"realm\": \"realm-2\",\n \"metadata\": {},\n \"role_descriptors\": { }\n }\n ]\n}" } @@ -214554,6 +215862,11 @@ "kind": "no_body" }, "description": "Get builtin privileges.\n\nGet the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "examples": { + "SecurityGetBuiltinPrivilegesRequestExample1": { + "method_request": "GET /_security/privilege/_builtin" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -214628,7 +215941,6 @@ "examples": { "SecurityGetBuiltinPrivilegesResponseExample1": { "description": "A successful response from `GET /_security/privilege/_builtin`.", - "method_request": "GET /_security/privilege/_builtin", "value": "{\n \"cluster\" : [\n \"all\",\n \"cancel_task\",\n \"create_snapshot\",\n \"cross_cluster_replication\",\n \"cross_cluster_search\",\n \"delegate_pki\",\n \"grant_api_key\",\n \"manage\",\n \"manage_api_key\",\n \"manage_autoscaling\",\n \"manage_behavioral_analytics\",\n \"manage_ccr\",\n \"manage_connector\",\n \"manage_data_frame_transforms\",\n \"manage_data_stream_global_retention\",\n \"manage_enrich\",\n \"manage_ilm\",\n \"manage_index_templates\",\n \"manage_inference\",\n \"manage_ingest_pipelines\",\n \"manage_logstash_pipelines\",\n \"manage_ml\",\n \"manage_oidc\",\n \"manage_own_api_key\",\n \"manage_pipeline\",\n \"manage_rollup\",\n \"manage_saml\",\n \"manage_search_application\",\n \"manage_search_query_rules\",\n \"manage_search_synonyms\",\n \"manage_security\",\n \"manage_service_account\",\n \"manage_slm\",\n \"manage_token\",\n \"manage_transform\",\n \"manage_user_profile\",\n \"manage_watcher\",\n \"monitor\",\n \"monitor_connector\",\n \"monitor_data_frame_transforms\",\n \"monitor_data_stream_global_retention\",\n \"monitor_enrich\",\n \"monitor_inference\",\n \"monitor_ml\",\n \"monitor_rollup\",\n \"monitor_snapshot\",\n \"monitor_stats\",\n \"monitor_text_structure\",\n \"monitor_transform\",\n \"monitor_watcher\",\n \"none\",\n \"post_behavioral_analytics_event\",\n \"read_ccr\",\n \"read_connector_secrets\",\n \"read_fleet_secrets\",\n \"read_ilm\",\n \"read_pipeline\",\n \"read_security\",\n \"read_slm\",\n \"transport_client\",\n \"write_connector_secrets\",\n \"write_fleet_secrets\"\n ],\n \"index\" : [\n \"all\",\n \"auto_configure\",\n \"create\",\n \"create_doc\",\n \"create_index\",\n \"cross_cluster_replication\",\n \"cross_cluster_replication_internal\",\n \"delete\",\n \"delete_index\",\n \"index\",\n \"maintenance\",\n \"manage\",\n \"manage_data_stream_lifecycle\",\n \"manage_follow_index\",\n \"manage_ilm\",\n \"manage_leader_index\",\n \"monitor\",\n \"none\",\n \"read\",\n \"read_cross_cluster\",\n \"view_index_metadata\",\n \"write\"\n ],\n \"remote_cluster\" : [\n \"monitor_enrich\",\n \"monitor_stats\"\n ]\n}" } }, @@ -214647,6 +215959,11 @@ "kind": "no_body" }, "description": "Get application privileges.\n\nTo use this API, you must have one of the following privileges:\n\n* The `read_security` cluster privilege (or a greater privilege such as `manage_security` or `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request.", + "examples": { + "SecurityGetPrivilegesRequestExample1": { + "method_request": "GET /_security/privilege/myapp/read" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -214724,7 +216041,6 @@ "examples": { "SecurityGetPrivilegesResponseExample1": { "description": "A successful response from `GET /_security/privilege/myapp/read`. The response contains information about the `read` privilege for the `app01` application.\n", - "method_request": "GET /_security/privilege/myapp/read", "value": "{\n \"myapp\": {\n \"read\": {\n \"application\": \"myapp\",\n \"name\": \"read\",\n \"actions\": [\n \"data:read/*\",\n \"action:login\"\n ],\n \"metadata\": {\n \"description\": \"Read access to myapp\"\n }\n }\n }\n}" } }, @@ -214743,6 +216059,11 @@ "kind": "no_body" }, "description": "Get roles.\n\nGet roles in the native realm.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe get roles API cannot retrieve roles that are defined in roles files.", + "examples": { + "SecurityGetRoleRequestExample1": { + "method_request": "GET /_security/role/my_admin_role" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -214797,7 +216118,6 @@ "examples": { "SecurityGetRoleResponseExample1": { "description": "A successful response from `GET /_security/role/my_admin_role`. The response contains information about the `my_admin_role` role in the native realm.\n", - "method_request": "GET /_security/role/my_admin_role", "value": "{\n \"my_admin_role\": {\n \"description\": \"Grants full access to all management features within the cluster.\",\n \"cluster\" : [ \"all\" ],\n \"indices\" : [\n {\n \"names\" : [ \"index1\", \"index2\" ],\n \"privileges\" : [ \"all\" ],\n \"allow_restricted_indices\" : false,\n \"field_security\" : {\n \"grant\" : [ \"title\", \"body\" ]}\n }\n ],\n \"applications\" : [ ],\n \"run_as\" : [ \"other_user\" ],\n \"metadata\" : {\n \"version\" : 1\n },\n \"transient_metadata\": {\n \"enabled\": true\n }\n }\n}" } }, @@ -215027,6 +216347,11 @@ "kind": "no_body" }, "description": "Get role mappings.\n\nRole mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe get role mappings API cannot retrieve role mappings that are defined in role mapping files.", + "examples": { + "SecurityGetRoleMappingRequestExample1": { + "method_request": "GET /_security/role_mapping/mapping1" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -215081,7 +216406,6 @@ "examples": { "SecurityGetRoleMappingResponseExample1": { "description": "A successful response from `GET /_security/role_mapping/mapping1`.", - "method_request": "GET /_security/role_mapping/mapping1", "value": "{\n \"mapping1\": {\n \"enabled\": true,\n \"roles\": [\n \"user\"\n ],\n \"rules\": {\n \"field\": {\n \"username\": \"*\"\n }\n },\n \"metadata\": {}\n }\n}" } }, @@ -215100,6 +216424,11 @@ "kind": "no_body" }, "description": "Get service accounts.\n\nGet a list of service accounts that match the provided path parameters.\n\nNOTE: Currently, only the `elastic/fleet-server` service account is available.", + "examples": { + "GetServiceAccountsRequestExample1": { + "method_request": "GET /_security/service/elastic/fleet-server" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -215166,7 +216495,6 @@ "examples": { "GetServiceAccountsResponseExample1": { "description": "A successful response from `GET /_security/service/elastic/fleet-server`. The response contains information about the `elastic/fleet-server` service account.\n", - "method_request": "GET /_security/service/elastic/fleet-server", "value": "{\n \"elastic/fleet-server\": {\n \"role_descriptor\": {\n \"cluster\": [\n \"monitor\",\n \"manage_own_api_key\",\n \"read_fleet_secrets\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"logs-*\",\n \"metrics-*\",\n \"traces-*\",\n \".logs-endpoint.diagnostic.collection-*\",\n \".logs-endpoint.action.responses-*\",\n \".logs-endpoint.heartbeat-*\"\n ],\n \"privileges\": [\n \"write\",\n \"create_index\",\n \"auto_configure\"\n ],\n \"allow_restricted_indices\": false\n },\n {\n \"names\": [\n \"profiling-*\"\n ],\n \"privileges\": [\n \"read\",\n \"write\"\n ],\n \"allow_restricted_indices\": false\n },\n {\n \"names\": [\n \"traces-apm.sampled-*\"\n ],\n \"privileges\": [\n \"read\",\n \"monitor\",\n \"maintenance\"\n ],\n \"allow_restricted_indices\": false\n },\n {\n \"names\": [\n \".fleet-secrets*\"\n ],\n \"privileges\": [\n \"read\"\n ],\n \"allow_restricted_indices\": true\n },\n {\n \"names\": [\n \".fleet-actions*\"\n ],\n \"privileges\": [\n \"read\",\n \"write\",\n \"monitor\",\n \"create_index\",\n \"auto_configure\",\n \"maintenance\"\n ],\n \"allow_restricted_indices\": true\n },\n {\n \"names\": [\n \".fleet-agents*\"\n ],\n \"privileges\": [\n \"read\",\n \"write\",\n \"monitor\",\n \"create_index\",\n \"auto_configure\",\n \"maintenance\"\n ],\n \"allow_restricted_indices\": true\n },\n {\n \"names\": [\n \".fleet-artifacts*\"\n ],\n \"privileges\": [\n \"read\",\n \"write\",\n \"monitor\",\n \"create_index\",\n \"auto_configure\",\n \"maintenance\"\n ],\n \"allow_restricted_indices\": true\n },\n {\n \"names\": [\n \".fleet-enrollment-api-keys*\"\n ],\n \"privileges\": [\n \"read\",\n \"write\",\n \"monitor\",\n \"create_index\",\n \"auto_configure\",\n \"maintenance\"\n ],\n \"allow_restricted_indices\": true\n },\n {\n \"names\": [\n \".fleet-policies*\"\n ],\n \"privileges\": [\n \"read\",\n \"write\",\n \"monitor\",\n \"create_index\",\n \"auto_configure\",\n \"maintenance\"\n ],\n \"allow_restricted_indices\": true\n },\n {\n \"names\": [\n \".fleet-policies-leader*\"\n ],\n \"privileges\": [\n \"read\",\n \"write\",\n \"monitor\",\n \"create_index\",\n \"auto_configure\",\n \"maintenance\"\n ],\n \"allow_restricted_indices\": true\n },\n {\n \"names\": [\n \".fleet-servers*\"\n ],\n \"privileges\": [\n \"read\",\n \"write\",\n \"monitor\",\n \"create_index\",\n \"auto_configure\",\n \"maintenance\"\n ],\n \"allow_restricted_indices\": true\n },\n {\n \"names\": [\n \".fleet-fileds*\"\n ],\n \"privileges\": [\n \"read\",\n \"write\",\n \"monitor\",\n \"create_index\",\n \"auto_configure\",\n \"maintenance\"\n ],\n \"allow_restricted_indices\": true\n },\n {\n \"names\": [\n \"synthetics-*\"\n ],\n \"privileges\": [\n \"read\",\n \"write\",\n \"create_index\",\n \"auto_configure\"\n ],\n \"allow_restricted_indices\": false\n }\n ],\n \"applications\": [\n {\n \"application\": \"kibana-*\",\n \"privileges\": [\n \"reserved_fleet-setup\"\n ],\n \"resources\": [\n \"*\"\n ]\n }\n ],\n \"run_as\": [],\n \"metadata\": {},\n \"transient_metadata\": {\n \"enabled\": true\n }\n }\n }\n}" } }, @@ -215275,6 +216603,11 @@ "kind": "no_body" }, "description": "Get service account credentials.\n\nTo use this API, you must have at least the `read_security` cluster privilege (or a greater privilege such as `manage_service_account` or `manage_security`).\n\nThe response includes service account tokens that were created with the create service account tokens API as well as file-backed tokens from all nodes of the cluster.\n\nNOTE: For tokens backed by the `service_tokens` file, the API collects them from all nodes of the cluster.\nTokens with the same name from different nodes are assumed to be the same token and are only counted once towards the total number of service tokens.", + "examples": { + "GetServiceCredentialsRequestExample1": { + "method_request": "GET /_security/service/elastic/fleet-server/credential" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -215380,7 +216713,6 @@ "examples": { "GetServiceCredentialsResponseExample1": { "description": "A successful response from `GET /_security/service/elastic/fleet-server/credential`. The response contains all credentials for the `elastic/fleet-server` service account.\n", - "method_request": "GET /_security/service/elastic/fleet-server/credential", "value": "{\n \"service_account\": \"elastic/fleet-server\",\n \"count\": 3,\n \"tokens\": {\n \"token1\": {}, \n \"token42\": {} \n },\n \"nodes_credentials\": { \n \"_nodes\": { \n \"total\": 3,\n \"successful\": 3,\n \"failed\": 0\n },\n \"file_tokens\": { \n \"my-token\": {\n \"nodes\": [ \"node0\", \"node1\" ] \n }\n }\n }\n}" } }, @@ -215399,6 +216731,11 @@ "kind": "no_body" }, "description": "Get security index settings.\n\nGet the user-configurable settings for the security internal index (`.security` and associated indices).\nOnly a subset of the index settings — those that are user-configurable—will be shown.\nThis includes:\n\n* `index.auto_expand_replicas`\n* `index.number_of_replicas`", + "examples": { + "SecurityGetSettingsExample1": { + "method_request": "GET /_security/settings" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -215791,13 +217128,11 @@ "examples": { "GetUserAccessTokenResponseExample1": { "description": "A successful response from `POST /_security/oauth2/token`.", - "method_request": "POST /_security/oauth2/token", "summary": "A client_credentials grant type example", "value": "{\n \"access_token\" : \"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\",\n \"type\" : \"Bearer\",\n \"expires_in\" : 1200,\n \"authentication\" : {\n \"username\" : \"test_admin\",\n \"roles\" : [\n \"superuser\"\n ],\n \"full_name\" : null,\n \"email\" : null,\n \"metadata\" : { },\n \"enabled\" : true,\n \"authentication_realm\" : {\n \"name\" : \"file\",\n \"type\" : \"file\"\n },\n \"lookup_realm\" : {\n \"name\" : \"file\",\n \"type\" : \"file\"\n },\n \"authentication_type\" : \"realm\"\n }\n}" }, "GetUserAccessTokenResponseExample2": { "description": "A successful response from `POST /_security/oauth2/token`.", - "method_request": "POST /_security/oauth2/token", "summary": "A password grant type example", "value": "{\n \"access_token\" : \"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\",\n \"type\" : \"Bearer\",\n \"expires_in\" : 1200,\n \"authentication\" : {\n \"username\" : \"test_admin\",\n \"roles\" : [\n \"superuser\"\n ],\n \"full_name\" : null,\n \"email\" : null,\n \"metadata\" : { },\n \"enabled\" : true,\n \"authentication_realm\" : {\n \"name\" : \"file\",\n \"type\" : \"file\"\n },\n \"lookup_realm\" : {\n \"name\" : \"file\",\n \"type\" : \"file\"\n },\n \"authentication_type\" : \"realm\"\n }\n}" } @@ -215849,6 +217184,11 @@ "kind": "no_body" }, "description": "Get users.\n\nGet information about users in the native realm and built-in users.", + "examples": { + "SecurityGetUserRequestExample1": { + "method_request": "GET /_security/user/jacknich?with_profile_uid=true" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -215938,7 +217278,6 @@ "examples": { "SecurityGetUserResponseExample1": { "description": "A successful response from `GET /_security/user/jacknich?with_profile_uid=true`. It includes the user `profile_uid` as part of the response.\n", - "method_request": "GET /_security/user/jacknich?with_profile_uid=true", "value": "{\n \"jacknich\": {\n \"username\": \"jacknich\",\n \"roles\": [\n \"admin\", \"other_role1\"\n ],\n \"full_name\": \"Jack Nicholson\",\n \"email\": \"jacknich@example.com\",\n \"metadata\": { \"intelligence\" : 7 },\n \"enabled\": true,\n \"profile_uid\": \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\"\n }\n}" } }, @@ -215957,6 +217296,11 @@ "kind": "no_body" }, "description": "Get user privileges.\n\nGet the security privileges for the logged in user.\nAll users can use this API, but only to determine their own privileges.\nTo check the privileges of other users, you must use the run as feature.\nTo check whether a user has a specific list of privileges, use the has privileges API.", + "examples": { + "SecurityGetUserPrivilegesRequestExample1": { + "method_request": "GET /_security/user/_privileges" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -216127,7 +217471,6 @@ "examples": { "SecurityGetUserPrivilegesResponseExample1": { "description": "A successful response from `GET /_security/user/_privileges`.", - "method_request": "GET /_security/user/_privileges", "value": "{\n \"cluster\" : [\n \"all\"\n ],\n \"global\" : [ ],\n \"indices\" : [\n {\n \"names\" : [\n \"*\"\n ],\n \"privileges\" : [\n \"all\"\n ],\n \"allow_restricted_indices\" : true\n }\n ],\n \"applications\" : [\n {\n \"application\" : \"*\",\n \"privileges\" : [\n \"*\"\n ],\n \"resources\" : [\n \"*\"\n ]\n }\n ],\n \"run_as\" : [\n \"*\"\n ]\n}" } }, @@ -216189,6 +217532,11 @@ "kind": "no_body" }, "description": "Get a user profile.\n\nGet a user's profile using the unique profile ID.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.", + "examples": { + "GetUserProfileRequestExample1": { + "method_request": "GET /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -216295,13 +217643,11 @@ "examples": { "GetUserProfileResponseExample1": { "description": "A successful response from `GET /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0`. By default, no content is returned in the `data` field.\n", - "method_request": "GET /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0", "summary": "Profile details for a UUID", "value": "{\n \"profiles\": [\n {\n \"uid\": \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\",\n \"enabled\": true,\n \"last_synchronized\": 1642650651037,\n \"user\": {\n \"username\": \"jacknich\",\n \"roles\": [\n \"admin\", \"other_role1\"\n ],\n \"realm_name\": \"native\",\n \"full_name\": \"Jack Nicholson\",\n \"email\": \"jacknich@example.com\"\n },\n \"labels\": {\n \"direction\": \"north\"\n },\n \"data\": {}, \n \"_doc\": {\n \"_primary_term\": 88,\n \"_seq_no\": 66\n }\n }\n ]\n}" }, "GetUserProfileResponseExample2": { "description": "A successful response from `GET /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0?data=app1.key1`.\n", - "method_request": "GET /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0?data=app1.key1", "summary": "Profile details for a UUID and data key", "value": "{\n \"profiles\": [\n {\n \"uid\": \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\",\n \"enabled\": true,\n \"last_synchronized\": 1642650651037,\n \"user\": {\n \"username\": \"jacknich\",\n \"roles\": [\n \"admin\", \"other_role1\"\n ],\n \"realm_name\": \"native\",\n \"full_name\": \"Jack Nicholson\",\n \"email\": \"jacknich@example.com\"\n },\n \"labels\": {\n \"direction\": \"north\"\n },\n \"data\": {\n \"app1\": {\n \"key1\": \"value1\"\n }\n },\n \"_doc\": {\n \"_primary_term\": 88,\n \"_seq_no\": 66\n }\n }\n ]\n}" }, @@ -216969,7 +218315,6 @@ "examples": { "SecurityHasPrivilegesResponseExample1": { "description": "A successful response from `GET /_security/user/_has_privileges`, which lists the privileges for the `rdeniro` user.", - "method_request": "GET /_security/user/_has_privileges", "value": "{\n \"username\": \"rdeniro\",\n \"has_all_requested\" : false,\n \"cluster\" : {\n \"monitor\" : true,\n \"manage\" : false\n },\n \"index\" : {\n \"suppliers\" : {\n \"read\" : true\n },\n \"products\" : {\n \"read\" : true\n },\n \"inventory\" : {\n \"read\" : true,\n \"write\" : false\n }\n },\n \"application\" : {\n \"inventory_manager\" : {\n \"product/1852563\" : {\n \"read\": false,\n \"data:write/inventory\": false\n }\n }\n }\n}" } }, @@ -217171,7 +218516,6 @@ "examples": { "HasPrivilegesUserProfileResponseExample1": { "description": "A response from `POST /_security/profile/_has_privileges` that indicates only one of the three users has all the privileges and one of them is not found.\n", - "method_request": "POST /_security/profile/_has_privileges", "value": "{\n \"has_privilege_uids\": [\"u_rzRnxDgEHIH0GOUoFkZr5Y27YUwSk19Joiq=g4OCxxB_1\"],\n \"errors\": {\n \"count\": 1,\n \"details\": {\n \"u_does-not-exist_0\": {\n \"type\": \"resource_not_found_exception\",\n \"reason\": \"profile document not found\"\n }\n }\n }\n}" } }, @@ -217386,7 +218730,6 @@ "examples": { "SecurityInvalidateApiKeyResponseExample1": { "description": "A successful response from `DELETE /_security/api_key`.\n", - "method_request": "DELETE /_security/api_key", "value": "{\n \"invalidated_api_keys\": [ \n \"api-key-id-1\"\n ],\n \"previously_invalidated_api_keys\": [ \n \"api-key-id-2\",\n \"api-key-id-3\"\n ],\n \"error_count\": 2, \n \"error_details\": [ \n {\n \"type\": \"exception\",\n \"reason\": \"error occurred while invalidating api keys\",\n \"caused_by\": {\n \"type\": \"illegal_argument_exception\",\n \"reason\": \"invalid api key id\"\n }\n },\n {\n \"type\": \"exception\",\n \"reason\": \"error occurred while invalidating api keys\",\n \"caused_by\": {\n \"type\": \"illegal_argument_exception\",\n \"reason\": \"invalid api key id\"\n }\n }\n ]\n}" } }, @@ -217562,7 +218905,6 @@ "examples": { "SecurityInvalidateTokenResponseExample1": { "description": "A partially successful response from `DELETE /_security/oauth2/token`. The response includes the number of the tokens that were invalidated, the number of errors that were encountered when invalidating the tokens, and details about these errors.\n", - "method_request": "DELETE /_security/oauth2/token", "value": "{\n \"invalidated_tokens\":9, \n \"previously_invalidated_tokens\":15, \n \"error_count\":2, \n \"error_details\":[ \n {\n \"type\":\"exception\",\n \"reason\":\"Elasticsearch exception [type=exception, reason=foo]\",\n \"caused_by\":{\n \"type\":\"exception\",\n \"reason\":\"Elasticsearch exception [type=illegal_argument_exception, reason=bar]\"\n }\n },\n {\n \"type\":\"exception\",\n \"reason\":\"Elasticsearch exception [type=exception, reason=boo]\",\n \"caused_by\":{\n \"type\":\"exception\",\n \"reason\":\"Elasticsearch exception [type=illegal_argument_exception, reason=far]\"\n }\n }\n ]\n}" } }, @@ -217710,7 +219052,6 @@ "examples": { "OidcAuthenticateResponseExample1": { "description": "A successful response from `POST /_security/oidc/authenticate`. It contains the access and refresh tokens that were generated, the token duration (in seconds), and the type.\n", - "method_request": "POST /_security/oidc/authenticate", "value": "{\n \"access_token\" : \"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\",\n \"type\" : \"Bearer\",\n \"expires_in\" : 1200,\n \"refresh_token\": \"vLBPvmAB6KvwvJZr27cS\"\n}" } }, @@ -217798,7 +219139,6 @@ "examples": { "OidcLogoutResponseExample1": { "description": "A successful response from `POST /_security/oidc/logout`, which contains the URI pointing to the End Session Endpoint of the OpenID Connect Provider with all the parameters of the Logout Request as HTTP GET parameters.", - "method_request": "POST /_security/oidc/logout", "value": "{\n \"redirect\" : \"https://op-provider.org/logout?id_token_hint=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c&post_logout_redirect_uri=http%3A%2F%2Foidc-kibana.elastic.co%2Floggedout&state=lGYK0EcSLjqH6pkT5EVZjC6eIW5YCGgywj2sxROO\"\n}" } }, @@ -217968,7 +219308,6 @@ "examples": { "OidcPrepareAuthenticationResponseExample1": { "description": "A successful response from `POST /_security/oidc/prepare`. It contains the URI pointing to the Authorization Endpoint of the OpenID Connect Provider with all the parameters of the Authentication Request as HTTP GET parameters.\n", - "method_request": "POST /_security/oidc/prepare", "value": "{\n \"redirect\" : \"http://127.0.0.1:8080/c2id-login?scope=openid&response_type=id_token&redirect_uri=https%3A%2F%2Fmy.fantastic.rp%2Fcb&state=4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I&nonce=WaBPH0KqPVdG5HHdSxPRjfoZbXMCicm5v1OiAj0DUFM&client_id=elasticsearch-rp\",\n \"state\" : \"4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I\",\n \"nonce\" : \"WaBPH0KqPVdG5HHdSxPRjfoZbXMCicm5v1OiAj0DUFM\",\n \"realm\" : \"oidc1\"\n}" } }, @@ -218153,12 +219492,10 @@ "examples": { "SecurityPutPrivilegesResponseExample1": { "description": "A successful response from `PUT /_security/privilege`.", - "method_request": "PUT /_security/privilege", "value": "{\n \"myapp\": {\n \"read\": {\n \"created\": true \n }\n }\n}" }, "SecurityPutPrivilegesResponseExample2": { "description": "A successful response from `PUT /_security/privilege`. The `created` property indicates whether the privileges have been created or updated.\n", - "method_request": "PUT /_security/privilege", "value": "{\n \"app02\": {\n \"all\": {\n \"created\": true\n }\n },\n \"app01\": {\n \"read\": {\n \"created\": true\n },\n \"write\": {\n \"created\": true\n }\n }\n}" } }, @@ -218428,7 +219765,6 @@ "examples": { "SecurityPutRoleResponseExample1": { "description": "A successful response from `POST /_security/role/my_admin_role`.", - "method_request": "POST /_security/role/my_admin_role", "value": "{\n \"role\": {\n \"created\": true \n }\n}" } }, @@ -218657,7 +219993,6 @@ "examples": { "SecurityPutRoleMappingResponseExample1": { "description": "A successful response from `POST /_security/role_mapping/mapping1`.", - "method_request": "POST /_security/role_mapping/mapping1", "value": "{\n \"role_mapping\" : {\n \"created\" : true \n }\n}" } }, @@ -218873,7 +220208,6 @@ "examples": { "SecurityPutUserResponseExample1": { "description": "A successful response from `POST /_security/user/jacknich`. When an existing user is updated, `created` is set to `false`.\n", - "method_request": "POST /_security/user/jacknich", "value": "{\n \"created\": true \n}" } }, @@ -219729,19 +221063,16 @@ "examples": { "QueryApiKeysResponseExample1": { "description": "A successful response from `GET /_security/_query/api_key?with_limited_by=true`. The `limited_by` details are the owner user's permissions associated with the API key. It is a point-in-time snapshot captured at creation and subsequent updates. An API key's effective permissions are an intersection of its assigned privileges and the owner user's permissions.\n", - "method_request": "GET /_security/_query/api_key?with_limited_by=true", "summary": "Query API keys by ID", "value": "{\n \"api_keys\": [\n {\n \"id\": \"VuaCfGcBCdbkQm-e5aOx\",\n \"name\": \"application-key-1\",\n \"creation\": 1548550550158,\n \"expiration\": 1548551550158,\n \"invalidated\": false,\n \"username\": \"myuser\",\n \"realm\": \"native1\",\n \"realm_type\": \"native\",\n \"metadata\": {\n \"application\": \"my-application\"\n },\n \"role_descriptors\": { },\n \"limited_by\": [ \n {\n \"role-power-user\": {\n \"cluster\": [\n \"monitor\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"*\"\n ],\n \"privileges\": [\n \"read\"\n ],\n \"allow_restricted_indices\": false\n }\n ],\n \"applications\": [ ],\n \"run_as\": [ ],\n \"metadata\": { },\n \"transient_metadata\": {\n \"enabled\": true\n }\n }\n }\n ]\n }\n ]\n}" }, "QueryApiKeysResponseExample2": { "description": "An abbreviated response from `GET /_security/_query/api_key` that contains a list of matched API keys along with their sort values. The first sort value is creation time, which is displayed in `date_time` format. The second sort value is the API key name.\n", - "method_request": "GET /_security/_query/api_key", "summary": "Query API keys with pagination", "value": "{\n \"total\": 100,\n \"count\": 10,\n \"api_keys\": [\n {\n \"id\": \"CLXgVnsBOGkf8IyjcXU7\",\n \"name\": \"app1-key-79\",\n \"creation\": 1629250154811,\n \"invalidated\": false,\n \"username\": \"org-admin-user\",\n \"realm\": \"native1\",\n \"metadata\": {\n \"environment\": \"production\"\n },\n \"role_descriptors\": { },\n \"_sort\": [\n \"2021-08-18T01:29:14.811Z\", \n \"app1-key-79\" \n ]\n },\n {\n \"id\": \"BrXgVnsBOGkf8IyjbXVB\",\n \"name\": \"app1-key-78\",\n \"creation\": 1629250153794,\n \"invalidated\": false,\n \"username\": \"org-admin-user\",\n \"realm\": \"native1\",\n \"metadata\": {\n \"environment\": \"production\"\n },\n \"role_descriptors\": { },\n \"_sort\": [\n \"2021-08-18T01:29:13.794Z\",\n \"app1-key-78\"\n ]\n }\n ]\n}" }, "QueryApiKeysResponseExample3": { "description": "A successful response from `GET /_security/_query/api_key`. It includes the role descriptors that are assigned to each API key when it was created or last updated. Note that an API key's effective permissions are an intersection of its assigned privileges and the point-in-time snapshot of the owner user's permissions. An empty role descriptors object means the API key inherits the owner user's permissions.\n", - "method_request": "GET /_security/_query/api_key", "summary": "Query all API keys", "value": "{\n \"total\": 3,\n \"count\": 3,\n \"api_keys\": [ \n {\n \"id\": \"nkvrGXsB8w290t56q3Rg\",\n \"name\": \"my-api-key-1\",\n \"creation\": 1628227480421,\n \"expiration\": 1629091480421,\n \"invalidated\": false,\n \"username\": \"elastic\",\n \"realm\": \"reserved\",\n \"realm_type\": \"reserved\",\n \"metadata\": {\n \"letter\": \"a\"\n },\n \"role_descriptors\": { \n \"role-a\": {\n \"cluster\": [\n \"monitor\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index-a\"\n ],\n \"privileges\": [\n \"read\"\n ],\n \"allow_restricted_indices\": false\n }\n ],\n \"applications\": [ ],\n \"run_as\": [ ],\n \"metadata\": { },\n \"transient_metadata\": {\n \"enabled\": true\n }\n }\n }\n },\n {\n \"id\": \"oEvrGXsB8w290t5683TI\",\n \"name\": \"my-api-key-2\",\n \"creation\": 1628227498953,\n \"expiration\": 1628313898953,\n \"invalidated\": false,\n \"username\": \"elastic\",\n \"realm\": \"reserved\",\n \"metadata\": {\n \"letter\": \"b\"\n },\n \"role_descriptors\": { } \n }\n ]\n}" } @@ -219945,13 +221276,11 @@ "examples": { "QueryRolesResponseExample1": { "description": "A successful response from `POST /_security/_query/role`. It returns a JSON structure that contains the information retrieved for one or more roles.\n", - "method_request": "POST /_security/_query/role", "summary": "Query roles by name", "value": "{\n \"total\": 2,\n \"count\": 2,\n \"roles\": [ \n {\n \"name\" : \"my_admin_role\",\n \"cluster\" : [\n \"all\"\n ],\n \"indices\" : [\n {\n \"names\" : [\n \"index1\",\n \"index2\"\n ],\n \"privileges\" : [\n \"all\"\n ],\n \"field_security\" : {\n \"grant\" : [\n \"title\",\n \"body\"\n ]\n },\n \"allow_restricted_indices\" : false\n }\n ],\n \"applications\" : [ ],\n \"run_as\" : [\n \"other_user\"\n ],\n \"metadata\" : {\n \"version\" : 1\n },\n \"transient_metadata\" : {\n \"enabled\" : true\n },\n \"description\" : \"Grants full access to all management features within the cluster.\",\n \"_sort\" : [\n \"my_admin_role\"\n ]\n },\n {\n \"name\" : \"my_user_role\",\n \"cluster\" : [ ],\n \"indices\" : [\n {\n \"names\" : [\n \"index1\",\n \"index2\"\n ],\n \"privileges\" : [\n \"all\"\n ],\n \"field_security\" : {\n \"grant\" : [\n \"title\",\n \"body\"\n ]\n },\n \"allow_restricted_indices\" : false\n }\n ],\n \"applications\" : [ ],\n \"run_as\" : [ ],\n \"metadata\" : {\n \"version\" : 1\n },\n \"transient_metadata\" : {\n \"enabled\" : true\n },\n \"description\" : \"Grants user access to some indicies.\",\n \"_sort\" : [\n \"my_user_role\"\n ]\n }\n ]\n}" }, "QueryRolesResponseExample2": { "description": "A successful response from `POST /_security/_query/role`.\n", - "method_request": "POST /_security/_query/role", "summary": "Query roles by description", "value": "{\n \"total\": 2,\n \"count\": 1,\n \"roles\": [\n {\n \"name\" : \"my_user_role\",\n \"cluster\" : [ ],\n \"indices\" : [\n {\n \"names\" : [\n \"index1\",\n \"index2\"\n ],\n \"privileges\" : [\n \"all\"\n ],\n \"field_security\" : {\n \"grant\" : [\n \"title\",\n \"body\"\n ]\n },\n \"allow_restricted_indices\" : false\n }\n ],\n \"applications\" : [ ],\n \"run_as\" : [ ],\n \"metadata\" : {\n \"version\" : 1\n },\n \"transient_metadata\" : {\n \"enabled\" : true\n },\n \"description\" : \"Grants user access to some indicies.\"\n }\n ]\n}" } @@ -220380,19 +221709,16 @@ "examples": { "SecurityQueryUserResponseExample1": { "description": "A successful response from `POST /_security/_query/user?with_profile_uid=true` that contains users that have roles that are prefixed with `other`. It also includes the user `profile_uid` in the response.\n", - "method_request": "POST /_security/_query/user?with_profile_uid=true", "summary": "Query users by role prefix", "value": "{\n \"total\": 1,\n \"count\": 1,\n \"users\": [\n {\n \"username\": \"jacknich\",\n \"roles\": [\n \"admin\",\n \"other_role1\"\n ],\n \"full_name\": \"Jack Nicholson\",\n \"email\": \"jacknich@example.com\",\n \"metadata\": {\n \"intelligence\": 7\n },\n \"enabled\": true,\n \"profile_uid\": \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\"\n }\n ]\n}" }, "SecurityQueryUserResponseExample2": { "description": "A successful response from `POST /_security/_query/user` that uses a `bool` query to issue complex logical conditions and uses `from`, `size`, and `sort` to help paginate the result. The sort value is `username`.\n", - "method_request": "POST /_security/_query/user", "summary": "Query users with multiple conditions", "value": "{\n \"total\": 5,\n \"count\": 2,\n \"users\": [\n {\n \"username\": \"ray\",\n \"roles\": [\n \"other_role3\"\n ],\n \"full_name\": \"Ray Nicholson\",\n \"email\": \"rayn@example.com\",\n \"metadata\": {\n \"intelligence\": 7\n },\n \"enabled\": true,\n \"_sort\": [\n \"ray\" \n ]\n },\n {\n \"username\": \"lorraine\",\n \"roles\": [\n \"other_role3\"\n ],\n \"full_name\": \"Lorraine Nicholson\",\n \"email\": \"lorraine@example.com\",\n \"metadata\": {\n \"intelligence\": 7\n },\n \"enabled\": true,\n \"_sort\": [\n \"lorraine\"\n ]\n }\n ]\n}" }, "SecurityQueryUserResponseExample3": { "description": "A successful response from `GET /_security/_query/user`, which lists all users. It returns a JSON structure that contains the information retrieved from one or more users.\n", - "method_request": "GET /_security/_query/user", "summary": "Query all users", "value": "{\n \"total\": 2,\n \"count\": 2,\n \"users\": [ \n {\n \"username\": \"jacknich\",\n \"roles\": [\n \"admin\",\n \"other_role1\"\n ],\n \"full_name\": \"Jack Nicholson\",\n \"email\": \"jacknich@example.com\",\n \"metadata\": {\n \"intelligence\": 7\n },\n \"enabled\": true\n },\n {\n \"username\": \"sandrakn\",\n \"roles\": [\n \"admin\",\n \"other_role1\"\n ],\n \"full_name\": \"Sandra Knight\",\n \"email\": \"sandrakn@example.com\",\n \"metadata\": {\n \"intelligence\": 7\n },\n \"enabled\": true\n }\n ]\n}" } @@ -220764,7 +222090,6 @@ "examples": { "SamlAuthenticateResponseExample1": { "description": "A successful response from `POST /_security/saml/authenticate`.", - "method_request": "POST /_security/saml/authenticate", "value": "{\n \"access_token\" : \"46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3\",\n \"username\" : \"Bearer\",\n \"expires_in\" : 1200,\n \"refresh_token\": \"mJdXLtmvTUSpoLwMvdBt_w\",\n \"realm\": \"saml1\"\n}" } }, @@ -220986,7 +222311,6 @@ "examples": { "SamlInvalidateResponseExample1": { "description": "A successful response from `POST /_security/saml/invalidate`.", - "method_request": "POST /_security/saml/invalidate", "value": "{\n \"redirect\" : \"https://my-idp.org/logout/SAMLResponse=....\",\n \"invalidated\" : 2,\n \"realm\" : \"saml1\"\n}" } }, @@ -221074,7 +222398,6 @@ "examples": { "SamlLogoutResponseExample1": { "description": "A successful response from `POST /_security/saml/logout`.", - "method_request": "POST /_security/saml/logout", "value": "{\n \"redirect\" : \"https://my-idp.org/logout/SAMLRequest=....\"\n}" } }, @@ -221205,7 +222528,6 @@ "examples": { "SAmlPrepareAuthenticationResponseExample1": { "description": "A successful response from `POST /_security/saml/prepare`.", - "method_request": "POST /_security/saml/prepare", "value": "{\n \"redirect\": \"https://my-idp.org/login?SAMLRequest=fVJdc6IwFP0rmbwDgUKLGbFDtc462%2B06FX3Yl50rBJsKCZsbrPbXL6J22hdfk%2FNx7zl3eL%2BvK7ITBqVWCfVdRolQuS6k2iR0mU2dmN6Phgh1FTQ8be2rehH%2FWoGWdESF%2FPST0NYorgElcgW1QG5zvkh%2FPfHAZbwx2upcV5SkiMLYzmqsFba1MAthdjIXy5enhL5a23DPOyo6W7kGBa7cwhZ2gO7G8OiW%2BR400kORt0bag7fzezAlk24eqcD2OxxlsNN5O3MdsW9c6CZnbq7rntF4d3s0D7BaHTZhIWN52P%2BcjiuGRbDU6cdj%2BEjJbJLQv4N4ADdhxBiEZbQuWclY4Q8iABbCXczCdSiKMAC%2FgyO2YqbQgrIJDZg%2FcFjsMD%2Fzb3gUcBa5sR%2F9oWR%2BzuJBqlPG14Jbn0DIf2TZ3Jn%2FXmSUrC5ddQB6bob37uZrJdeF4dIDHV3iuhb70Ptq83kOz53ubDLXlcwPJK0q%2FT42AqxIaAkVCkqm2tRgr49yfJGFU%2FZQ3hy3QyuUpd7obPv97kb%2FAQ%3D%3D\"}\",\n \"realm\": \"saml1\",\n \"id\": \"_989a34500a4f5bf0f00d195aa04a7804b4ed42a1\"\n}" } }, @@ -221224,6 +222546,11 @@ "kind": "no_body" }, "description": "Create SAML service provider metadata.\n\nGenerate SAML metadata for a SAML 2.0 Service Provider.\n\nThe SAML 2.0 specification provides a mechanism for Service Providers to describe their capabilities and configuration using a metadata file.\nThis API generates Service Provider metadata based on the configuration of a SAML realm in Elasticsearch.", + "examples": { + "SamlServiceProviderMetadataRequestExample1": { + "method_request": "POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -221273,7 +222600,6 @@ "examples": { "SamlServiceProviderMetadataResponseExample1": { "description": "A successful response from `POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data`, which indicates that the request is acknowledged.\n", - "method_request": "POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data", "value": "{\n \"acknowledged\": true\n}" } }, @@ -221519,7 +222845,6 @@ "examples": { "SuggestUserProfilesResponseExample1": { "description": "A successful response from `GET /_security/saml/metadata/saml1`. It contains the SAML metadata that was generated for the SAML realm as an XML string.\n", - "method_request": "GET /_security/saml/metadata/saml1", "value": "{\n \"metadata\" : \"\"\n}" } }, @@ -221682,7 +223007,6 @@ "examples": { "UpdateApiKeyResponseExample1": { "description": "A successful response from `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx`. The API key's effective permissions after the update will be the intersection of the supplied role descriptors and the owner user's permissions.\n", - "method_request": "PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx", "summary": "Update role and metadata", "value": "{\n \"updated\": true\n}" } @@ -221796,7 +223120,6 @@ "examples": { "UpdateCrossClusterApiKeyResponseExample1": { "description": "A successful response from `PUT /_security/cross_cluster/api_key/VuaCfGcBCdbkQm-e5aOx` that indicates that the API key was updated.\n", - "method_request": "PUT /_security/cross_cluster/api_key/VuaCfGcBCdbkQm-e5aOx", "value": "{\n \"updated\": true\n}" } }, @@ -222060,7 +223383,6 @@ "examples": { "UpdateUserProfileDataResponseExample1": { "description": "A successful response from `POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data`, which indicates that the request is acknowledged.\n", - "method_request": "POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data", "value": "{\n \"acknowledged\": true\n}" } }, @@ -222098,6 +223420,11 @@ "kind": "no_body" }, "description": "Cancel node shutdown preparations.\nRemove a node from the shutdown list so it can resume normal operations.\nYou must explicitly clear the shutdown request when a node rejoins the cluster or when a node has permanently left the cluster.\nShutdown requests are never removed automatically by Elasticsearch.\n\nNOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes.\nDirect use is not supported.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.", + "examples": { + "ShutdownDeleteNodeRequestExample1": { + "method_request": "DELETE /_nodes/USpTGYaBSIKbgSUJR2Z9lg/shutdown" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -222168,7 +223495,6 @@ "examples": { "ShutdownDeleteNodeResponseExample1": { "description": "A successful response from `DELETE /_nodes/USpTGYaBSIKbgSUJR2Z9lg/shutdown`.", - "method_request": "DELETE /_nodes/USpTGYaBSIKbgSUJR2Z9lg/shutdown", "value": "{\n \"acknowledged\": true\n}" } }, @@ -222336,6 +223662,11 @@ "kind": "no_body" }, "description": "Get the shutdown status.\n\nGet information about nodes that are ready to be shut down, have shut down preparations still in progress, or have stalled.\nThe API returns status information for each part of the shut down process.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.", + "examples": { + "ShutdownGetNodeRequestExample1": { + "method_request": "GET /_nodes/USpTGYaBSIKbgSUJR2Z9lg/shutdown" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -222401,7 +223732,6 @@ "examples": { "ShutdownGetNodeResponseExample1": { "description": "Get the status of shutdown preparations with `GET /_nodes/USpTGYaBSIKbgSUJR2Z9lg/shutdown`. The response shows information about the shutdown preparations, including the status of shard migration, task migration, and plugin cleanup\n", - "method_request": "GET /_nodes/USpTGYaBSIKbgSUJR2Z9lg/shutdown", "value": "{\n \"nodes\": [\n {\n \"node_id\": \"USpTGYaBSIKbgSUJR2Z9lg\",\n \"type\": \"RESTART\",\n \"reason\": \"Demonstrating how the node shutdown API works\",\n \"shutdown_startedmillis\": 1624406108685,\n \"allocation_delay\": \"10m\",\n \"status\": \"COMPLETE\",\n \"shard_migration\": {\n \"status\": \"COMPLETE\",\n \"shard_migrations_remaining\": 0,\n \"explanation\": \"no shard relocation is necessary for a node restart\"\n },\n \"persistent_tasks\": {\n \"status\": \"COMPLETE\"\n },\n \"plugins\": {\n \"status\": \"COMPLETE\"\n }\n }\n ]\n}" } }, @@ -223655,6 +224985,11 @@ "kind": "no_body" }, "description": "Delete a policy.\nDelete a snapshot lifecycle policy definition.\nThis operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots.", + "examples": { + "SlmDeleteLifecycleExample1": { + "method_request": "DELETE /_slm/policy/daily-snapshots" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -223737,6 +225072,11 @@ "kind": "no_body" }, "description": "Run a policy.\nImmediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time.\nThe snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance.", + "examples": { + "ExecuteSnapshotLifecycleRequestExample1": { + "method_request": "POST /_slm/policy/daily-snapshots/_execute" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -223812,7 +225152,6 @@ "examples": { "ExecuteSnapshotLifecycleResponseExample1": { "description": "Run `POST /_slm/policy/daily-snapshots/_execute` to take an immediate snapshot according to the `daily-snapshots` policy.\n", - "method_request": "POST /_slm/policy/daily-snapshots/_execute", "value": "{\n \"snapshot_name\": \"daily-snap-2019.04.24-gwrqoo2xtea3q57vvg0uea\"\n}" } }, @@ -223831,6 +225170,11 @@ "kind": "no_body" }, "description": "Run a retention policy.\nManually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules.\nThe retention policy is normally applied according to its schedule.", + "examples": { + "SlmExecuteRetentionExample1": { + "method_request": "POST _slm/_execute_retention" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -223900,6 +225244,11 @@ "kind": "no_body" }, "description": "Get policy information.\nGet snapshot lifecycle policy definitions and information about the latest snapshot attempts.", + "examples": { + "GetSnapshotLifecycleRequestExample1": { + "method_request": "GET _slm/policy/daily-snapshots?human" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -223981,7 +225330,6 @@ "examples": { "GetSnapshotLifecycleResponseExample1": { "description": "A successful response from `GET _slm/policy/daily-snapshots?human`.", - "method_request": "GET _slm/policy/daily-snapshots?human", "summary": null, "value": "{\n \"daily-snapshots\": {\n \"version\": 1,\n \"modified_date\": \"2099-05-06T01:30:00.000Z\",\n \"modified_date_millis\": 4081757400000,\n \"policy\" : {\n \"schedule\": \"0 30 1 * * ?\",\n \"name\": \"\",\n \"repository\": \"my_repository\",\n \"config\": {\n \"indices\": [\"data-*\", \"important\"],\n \"ignore_unavailable\": false,\n \"include_global_state\": false\n },\n \"retention\": {\n \"expire_after\": \"30d\",\n \"min_count\": 5,\n \"max_count\": 50\n }\n },\n \"stats\": {\n \"policy\": \"daily-snapshots\",\n \"snapshots_taken\": 0,\n \"snapshots_failed\": 0,\n \"snapshots_deleted\": 0,\n \"snapshot_deletion_failures\": 0\n },\n \"next_execution\": \"2099-05-07T01:30:00.000Z\",\n \"next_execution_millis\": 4081843800000\n }\n}" } @@ -224001,6 +225349,11 @@ "kind": "no_body" }, "description": "Get snapshot lifecycle management statistics.\nGet global and policy-level statistics about actions taken by snapshot lifecycle management.", + "examples": { + "GetSnapshotLifecycleManagementStatsRequestExample1": { + "method_request": "GET /_slm/stats" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -224174,7 +225527,6 @@ "examples": { "GetSnapshotLifecycleManagementStatsResponseExample1": { "description": "A successful response from `GET /_slm/stats`.", - "method_request": "GET /_slm/stats", "value": "{\n \"retention_runs\": 13,\n \"retention_failed\": 0,\n \"retention_timed_out\": 0,\n \"retention_deletion_time\": \"1.4s\",\n \"retention_deletion_time_millis\": 1404,\n \"policy_stats\": [ ],\n \"total_snapshots_taken\": 1,\n \"total_snapshots_failed\": 1,\n \"total_snapshots_deleted\": 0,\n \"total_snapshot_deletion_failures\": 0\n}" } }, @@ -224193,6 +225545,11 @@ "kind": "no_body" }, "description": "Get the snapshot lifecycle management status.", + "examples": { + "GetSnapshotLifecycleManagementStatusRequestExample1": { + "method_request": "GET _slm/status" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -224255,7 +225612,6 @@ "examples": { "GetSnapshotLifecycleManagementStatusResponseExample1": { "description": "A successful response from `GET _slm/status`.", - "method_request": "GET _slm/status", "value": "{\n \"operation_mode\": \"RUNNING\"\n}" } }, @@ -224432,6 +225788,11 @@ "kind": "no_body" }, "description": "Start snapshot lifecycle management.\nSnapshot lifecycle management (SLM) starts automatically when a cluster is formed.\nManually starting SLM is necessary only if it has been stopped using the stop SLM API.", + "examples": { + "StartSnapshotLifecycleManagementRequestExample1": { + "method_request": "POST _slm/start" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -224489,7 +225850,6 @@ "examples": { "StartSnapshotLifecycleManagementResponseExample1": { "description": "A successful response from `POST _slm/start`.", - "method_request": "POST _slm/start", "value": "{\n \"acknowledged\": true\n}" } }, @@ -226630,6 +227990,11 @@ "kind": "no_body" }, "description": "Clean up the snapshot repository.\nTrigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots.", + "examples": { + "SnapshotCleanupRepositoryRequestExample1": { + "method_request": "POST /_snapshot/my_repository/_cleanup" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -226707,7 +228072,6 @@ "examples": { "SnapshotCleanupRepositoryResponseExample1": { "description": "A successful response from `POST /_snapshot/my_repository/_cleanup`.", - "method_request": "POST /_snapshot/my_repository/_cleanup", "value": "{\n \"results\": {\n \"deleted_bytes\": 20,\n \"deleted_blobs\": 5\n }\n}" } }, @@ -227048,7 +228412,6 @@ "examples": { "SnapshotCreateResponseExample1": { "description": "A successful response from `PUT /_snapshot/my_repository/snapshot_2?wait_for_completion=true`.", - "method_request": "PUT /_snapshot/my_repository/snapshot_2?wait_for_completion=true", "value": "{\n \"snapshot\": {\n \"snapshot\": \"snapshot_2\",\n \"uuid\": \"vdRctLCxSketdKb54xw67g\",\n \"repository\": \"my_repository\",\n \"version_id\": ,\n \"version\": ,\n \"indices\": [],\n \"data_streams\": [],\n \"feature_states\": [],\n \"include_global_state\": false,\n \"metadata\": {\n \"taken_by\": \"user123\",\n \"taken_because\": \"backup before upgrading\"\n },\n \"state\": \"SUCCESS\",\n \"start_time\": \"2020-06-25T14:00:28.850Z\",\n \"start_time_in_millis\": 1593093628850,\n \"end_time\": \"2020-06-25T14:00:28.850Z\",\n \"end_time_in_millis\": 1593094752018,\n \"duration_in_millis\": 0,\n \"failures\": [],\n \"shards\": {\n \"total\": 0,\n \"failed\": 0,\n \"successful\": 0\n }\n }\n}" } }, @@ -227209,6 +228572,11 @@ "kind": "no_body" }, "description": "Delete snapshots.", + "examples": { + "SnapshotDeleteRequestExample1": { + "method_request": "DELETE /_snapshot/my_repository/snapshot_2,snapshot_3" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -227278,7 +228646,6 @@ "examples": { "SnapshotDeleteResponseExample1": { "description": "A successful response from `DELETE /_snapshot/my_repository/snapshot_2,snapshot_3`. The request deletes `snapshot_2` and `snapshot_3` from the repository named `my_repository`.\n", - "method_request": "DELETE /_snapshot/my_repository/snapshot_2,snapshot_3", "value": "{\n \"acknowledged\" : true\n}" } }, @@ -227297,6 +228664,11 @@ "kind": "no_body" }, "description": "Delete snapshot repositories.\nWhen a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots.\nThe snapshots themselves are left untouched and in place.", + "examples": { + "SnapshotDeleteRepositoryExample1": { + "method_request": "DELETE /_snapshot/my_repository" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -227380,6 +228752,11 @@ "kind": "no_body" }, "description": "Get snapshot information.\n\nNOTE: The `after` parameter and `next` field enable you to iterate through snapshots with some consistency guarantees regarding concurrent creation or deletion of snapshots.\nIt is guaranteed that any snapshot that exists at the beginning of the iteration and is not concurrently deleted will be seen during the iteration.\nSnapshots concurrently created may be seen during an iteration.", + "examples": { + "SnapshotGetRequestExample1": { + "method_request": "GET /_snapshot/my_repository/snapshot_*?sort=start_time&from_sort_value=1577833200000" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -227726,7 +229103,6 @@ "examples": { "SnapshotGetResponseExample1": { "description": "A successful response from `GET /_snapshot/my_repository/snapshot_*?sort=start_time&from_sort_value=1577833200000`. The response contains information for all snapshots with names starting with `snapshot_` and that started on or after timestamp `1577833200000` (Jan 1st 2020) when sorted by snapshot start time in the default ascending order.\n", - "method_request": "GET /_snapshot/my_repository/snapshot_*?sort=start_time&from_sort_value=1577833200000", "value": "{\n \"snapshots\": [\n {\n \"snapshot\": \"snapshot_1\",\n \"uuid\": \"dKb54xw67gvdRctLCxSket\",\n \"repository\": \"my_repository\",\n \"version_id\": ,\n \"version\": ,\n \"indices\": [],\n \"data_streams\": [],\n \"feature_states\": [],\n \"include_global_state\": true,\n \"state\": \"SUCCESS\",\n \"start_time\": \"2020-07-06T21:55:18.128Z\",\n \"start_time_in_millis\": 1593093628849,\n \"end_time\": \"2020-07-06T21:55:18.129Z\",\n \"end_time_in_millis\": 1593093628850,\n \"duration_in_millis\": 1,\n \"failures\": [],\n \"shards\": {\n \"total\": 0,\n \"failed\": 0,\n \"successful\": 0\n }\n },\n {\n \"snapshot\": \"snapshot_2\",\n \"uuid\": \"vdRctLCxSketdKb54xw67g\",\n \"repository\": \"my_repository\",\n \"version_id\": ,\n \"version\": ,\n \"indices\": [],\n \"data_streams\": [],\n \"feature_states\": [],\n \"include_global_state\": true,\n \"state\": \"SUCCESS\",\n \"start_time\": \"2020-07-06T21:55:18.130Z\",\n \"start_time_in_millis\": 1593093628851,\n \"end_time\": \"2020-07-06T21:55:18.130Z\",\n \"end_time_in_millis\": 1593093628851,\n \"duration_in_millis\": 0,\n \"failures\": [],\n \"shards\": {\n \"total\": 0,\n \"failed\": 0,\n \"successful\": 0\n }\n },\n {\n \"snapshot\": \"snapshot_3\",\n \"uuid\": \"dRctdKb54xw67gvLCxSket\",\n \"repository\": \"my_repository\",\n \"version_id\": ,\n \"version\": ,\n \"indices\": [],\n \"data_streams\": [],\n \"feature_states\": [],\n \"include_global_state\": true,\n \"state\": \"SUCCESS\",\n \"start_time\": \"2020-07-06T21:55:18.131Z\",\n \"start_time_in_millis\": 1593093628852,\n \"end_time\": \"2020-07-06T21:55:18.135Z\",\n \"end_time_in_millis\": 1593093628856,\n \"duration_in_millis\": 4,\n \"failures\": [],\n \"shards\": {\n \"total\": 0,\n \"failed\": 0,\n \"successful\": 0\n }\n }\n ],\n \"total\": 3,\n \"remaining\": 0\n}" } }, @@ -227791,6 +229167,11 @@ "kind": "no_body" }, "description": "Get snapshot repository information.", + "examples": { + "SnapshotGetRepositoryRequestExample1": { + "method_request": "GET /_snapshot/my_repository" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -227873,7 +229254,6 @@ "examples": { "SnapshotGetRepositoryResponseExample1": { "description": "A successful response from `GET /_snapshot/my_repository`.", - "method_request": "GET /_snapshot/my_repository", "value": "{\n \"my_repository\" : {\n \"type\" : \"fs\",\n \"uuid\" : \"0JLknrXbSUiVPuLakHjBrQ\",\n \"settings\" : {\n \"location\" : \"my_backup_location\"\n }\n }\n}" } }, @@ -228453,6 +229833,14 @@ "kind": "no_body" }, "description": "Analyze a snapshot repository.\nAnalyze the performance characteristics and any incorrect behaviour found in a repository.\n\nThe response exposes implementation details of the analysis which may change from version to version.\nThe response body format is therefore not considered stable and may be different in newer versions.\n\nThere are a large number of third-party storage systems available, not all of which are suitable for use as a snapshot repository by Elasticsearch.\nSome storage systems behave incorrectly, or perform poorly, especially when accessed concurrently by multiple clients as the nodes of an Elasticsearch cluster do. This API performs a collection of read and write operations on your repository which are designed to detect incorrect behaviour and to measure the performance characteristics of your storage system.\n\nThe default values for the parameters are deliberately low to reduce the impact of running an analysis inadvertently and to provide a sensible starting point for your investigations.\nRun your first analysis with the default parameter values to check for simple problems.\nIf successful, run a sequence of increasingly large analyses until you encounter a failure or you reach a `blob_count` of at least `2000`, a `max_blob_size` of at least `2gb`, a `max_total_data_size` of at least `1tb`, and a `register_operation_count` of at least `100`.\nAlways specify a generous timeout, possibly `1h` or longer, to allow time for each analysis to run to completion.\nPerform the analyses using a multi-node cluster of a similar size to your production cluster so that it can detect any problems that only arise when the repository is accessed by many nodes at once.\n\nIf the analysis fails, Elasticsearch detected that your repository behaved unexpectedly.\nThis usually means you are using a third-party storage system with an incorrect or incompatible implementation of the API it claims to support.\nIf so, this storage system is not suitable for use as a snapshot repository.\nYou will need to work with the supplier of your storage system to address the incompatibilities that Elasticsearch detects.\n\nIf the analysis is successful, the API returns details of the testing process, optionally including how long each operation took.\nYou can use this information to determine the performance of your storage system.\nIf any operation fails or returns an incorrect result, the API returns an error.\nIf the API returns an error, it may not have removed all the data it wrote to the repository.\nThe error will indicate the location of any leftover data and this path is also recorded in the Elasticsearch logs.\nYou should verify that this location has been cleaned up correctly.\nIf there is still leftover data at the specified location, you should manually remove it.\n\nIf the connection from your client to Elasticsearch is closed while the client is waiting for the result of the analysis, the test is cancelled.\nSome clients are configured to close their connection if no response is received within a certain timeout.\nAn analysis takes a long time to complete so you might need to relax any such client-side timeouts.\nOn cancellation the analysis attempts to clean up the data it was writing, but it may not be able to remove it all.\nThe path to the leftover data is recorded in the Elasticsearch logs.\nYou should verify that this location has been cleaned up correctly.\nIf there is still leftover data at the specified location, you should manually remove it.\n\nIf the analysis is successful then it detected no incorrect behaviour, but this does not mean that correct behaviour is guaranteed.\nThe analysis attempts to detect common bugs but it does not offer 100% coverage.\nAdditionally, it does not test the following:\n\n* Your repository must perform durable writes. Once a blob has been written it must remain in place until it is deleted, even after a power loss or similar disaster.\n* Your repository must not suffer from silent data corruption. Once a blob has been written, its contents must remain unchanged until it is deliberately modified or deleted.\n* Your repository must behave correctly even if connectivity from the cluster is disrupted. Reads and writes may fail in this case, but they must not return incorrect results.\n\nIMPORTANT: An analysis writes a substantial amount of data to your repository and then reads it back again.\nThis consumes bandwidth on the network between the cluster and the repository, and storage space and I/O bandwidth on the repository itself.\nYou must ensure this load does not affect other users of these systems.\nAnalyses respect the repository settings `max_snapshot_bytes_per_sec` and `max_restore_bytes_per_sec` if available and the cluster setting `indices.recovery.max_bytes_per_sec` which you can use to limit the bandwidth they consume.\n\nNOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions.\n\nNOTE: Different versions of Elasticsearch may perform different checks for repository compatibility, with newer versions typically being stricter than older ones.\nA storage system that passes repository analysis with one version of Elasticsearch may fail with a different version.\nThis indicates it behaves incorrectly in ways that the former version did not detect.\nYou must work with the supplier of your storage system to address the incompatibilities detected by the repository analysis API in any version of Elasticsearch.\n\nNOTE: This API may not work correctly in a mixed-version cluster.\n\n*Implementation details*\n\nNOTE: This section of documentation describes how the repository analysis API works in this version of Elasticsearch, but you should expect the implementation to vary between versions. The request parameters and response format depend on details of the implementation so may also be different in newer versions.\n\nThe analysis comprises a number of blob-level tasks, as set by the `blob_count` parameter and a number of compare-and-exchange operations on linearizable registers, as set by the `register_operation_count` parameter.\nThese tasks are distributed over the data and master-eligible nodes in the cluster for execution.\n\nFor most blob-level tasks, the executing node first writes a blob to the repository and then instructs some of the other nodes in the cluster to attempt to read the data it just wrote.\nThe size of the blob is chosen randomly, according to the `max_blob_size` and `max_total_data_size` parameters.\nIf any of these reads fails then the repository does not implement the necessary read-after-write semantics that Elasticsearch requires.\n\nFor some blob-level tasks, the executing node will instruct some of its peers to attempt to read the data before the writing process completes.\nThese reads are permitted to fail, but must not return partial data.\nIf any read returns partial data then the repository does not implement the necessary atomicity semantics that Elasticsearch requires.\n\nFor some blob-level tasks, the executing node will overwrite the blob while its peers are reading it.\nIn this case the data read may come from either the original or the overwritten blob, but the read operation must not return partial data or a mix of data from the two blobs.\nIf any of these reads returns partial data or a mix of the two blobs then the repository does not implement the necessary atomicity semantics that Elasticsearch requires for overwrites.\n\nThe executing node will use a variety of different methods to write the blob.\nFor instance, where applicable, it will use both single-part and multi-part uploads.\nSimilarly, the reading nodes will use a variety of different methods to read the data back again.\nFor instance they may read the entire blob from start to end or may read only a subset of the data.\n\nFor some blob-level tasks, the executing node will cancel the write before it is complete.\nIn this case, it still instructs some of the other nodes in the cluster to attempt to read the blob but all of these reads must fail to find the blob.\n\nLinearizable registers are special blobs that Elasticsearch manipulates using an atomic compare-and-exchange operation.\nThis operation ensures correct and strongly-consistent behavior even when the blob is accessed by multiple nodes at the same time.\nThe detailed implementation of the compare-and-exchange operation on linearizable registers varies by repository type.\nRepository analysis verifies that that uncontended compare-and-exchange operations on a linearizable register blob always succeed.\nRepository analysis also verifies that contended operations either succeed or report the contention but do not return incorrect results.\nIf an operation fails due to contention, Elasticsearch retries the operation until it succeeds.\nMost of the compare-and-exchange operations performed by repository analysis atomically increment a counter which is represented as an 8-byte blob.\nSome operations also verify the behavior on small blobs with sizes other than 8 bytes.", + "examples": { + "SnapshotRepositoryAnalyzeRequestExample1": { + "description": "Analyze `my_repository` by writing 10 blobs of 1mb max. Cancel the test after 2 minutes.", + "method_request": "POST /_snapshot/my_repository/_analyze?blob_count=10&max_blob_size=1mb&timeout=120s", + "summary": "Analyze a repository", + "type": "request" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -229089,6 +230477,11 @@ "kind": "no_body" }, "description": "Verify the repository integrity.\nVerify the integrity of the contents of a snapshot repository.\n\nThis API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail.\n\nIf you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its `read_only` option to `true`, and use this API to verify its integrity.\nUntil you do so:\n\n* It may not be possible to restore some snapshots from this repository.\n* Searchable snapshots may report errors when searched or may have unassigned shards.\n* Taking snapshots into this repository may fail or may appear to succeed but have created a snapshot which cannot be restored.\n* Deleting snapshots from this repository may fail or may appear to succeed but leave the underlying data on disk.\n* Continuing to write to the repository while it is in an invalid state may causing additional damage to its contents.\n\nIf the API finds any problems with the integrity of the contents of your repository, Elasticsearch will not be able to repair the damage.\nThe only way to bring the repository back into a fully working state after its contents have been damaged is by restoring its contents from a repository backup which was taken before the damage occurred.\nYou must also identify what caused the damage and take action to prevent it from happening again.\n\nIf you cannot restore a repository backup, register a new repository and use this for all future snapshot operations.\nIn some cases it may be possible to recover some of the contents of a damaged repository, either by restoring as many of its snapshots as needed and taking new snapshots of the restored data, or by using the reindex API to copy data from any searchable snapshots mounted from the damaged repository.\n\nAvoid all operations which write to the repository while the verify repository integrity API is running.\nIf something changes the repository contents while an integrity verification is running then Elasticsearch may incorrectly report having detected some anomalies in its contents due to the concurrent writes.\nIt may also incorrectly fail to report some anomalies that the concurrent writes prevented it from detecting.\n\nNOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions.\n\nNOTE: This API may not work correctly in a mixed-version cluster.\n\nThe default values for the parameters of this API are designed to limit the impact of the integrity verification on other activities in your cluster.\nFor instance, by default it will only use at most half of the `snapshot_meta` threads to verify the integrity of each snapshot, allowing other snapshot operations to use the other half of this thread pool.\nIf you modify these parameters to speed up the verification process, you risk disrupting other snapshot-related operations in your cluster.\nFor large repositories, consider setting up a separate single-node Elasticsearch cluster just for running the integrity verification API.\n\nThe response exposes implementation details of the analysis which may change from version to version.\nThe response body format is therefore not considered stable and may be different in newer versions.", + "examples": { + "SnapshotRepositoryVerifyIntegrityExample1": { + "method_request": "POST /_snapshot/my_repository/_verify_integrity" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -229552,6 +230945,11 @@ "kind": "no_body" }, "description": "Get the snapshot status.\nGet a detailed description of the current state for each shard participating in the snapshot.\n\nNote that this API should be used only to obtain detailed shard-level information for ongoing snapshots.\nIf this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API.\n\nIf you omit the `` request path parameter, the request retrieves information only for currently running snapshots.\nThis usage is preferred.\nIf needed, you can specify `` and `` to retrieve information for specific snapshots, even if they're not currently running.\n\nWARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive.\nThe API requires a read from the repository for each shard in each snapshot.\nFor example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards).\n\nDepending on the latency of your storage, such requests can take an extremely long time to return results.\nThese requests can also tax machine resources and, when using cloud storage, incur high processing costs.", + "examples": { + "SnapshotStatusRequestExample1": { + "method_request": "GET _snapshot/my_repository/snapshot_2/_status" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -229642,7 +231040,6 @@ "examples": { "SnapshotStatusResponseExample1": { "description": "A successful response from `GET _snapshot/my_repository/snapshot_2/_status`. The response contains detailed status information for `snapshot_2` in the `my_repository` repository.\n", - "method_request": "GET _snapshot/my_repository/snapshot_2/_status", "value": "{\n \"snapshots\" : [\n {\n \"snapshot\" : \"snapshot_2\",\n \"repository\" : \"my_repository\",\n \"uuid\" : \"lNeQD1SvTQCqqJUMQSwmGg\",\n \"state\" : \"SUCCESS\",\n \"include_global_state\" : false,\n \"shards_stats\" : {\n \"initializing\" : 0,\n \"started\" : 0,\n \"finalizing\" : 0,\n \"done\" : 1,\n \"failed\" : 0,\n \"total\" : 1\n },\n \"stats\" : {\n \"incremental\" : {\n \"file_count\" : 3,\n \"size_in_bytes\" : 5969\n },\n \"total\" : {\n \"file_count\" : 4,\n \"size_in_bytes\" : 6024\n },\n \"start_time_in_millis\" : 1594829326691,\n \"time_in_millis\" : 205\n },\n \"indices\" : {\n \"index_1\" : {\n \"shards_stats\" : {\n \"initializing\" : 0,\n \"started\" : 0,\n \"finalizing\" : 0,\n \"done\" : 1,\n \"failed\" : 0,\n \"total\" : 1\n },\n \"stats\" : {\n \"incremental\" : {\n \"file_count\" : 3,\n \"size_in_bytes\" : 5969\n },\n \"total\" : {\n \"file_count\" : 4,\n \"size_in_bytes\" : 6024\n },\n \"start_time_in_millis\" : 1594829326896,\n \"time_in_millis\" : 0\n },\n \"shards\" : {\n \"0\" : {\n \"stage\" : \"DONE\",\n \"stats\" : {\n \"incremental\" : {\n \"file_count\" : 3,\n \"size_in_bytes\" : 5969\n },\n \"total\" : {\n \"file_count\" : 4,\n \"size_in_bytes\" : 6024\n },\n \"start_time_in_millis\" : 1594829326896,\n \"time_in_millis\" : 0\n }\n }\n }\n }\n }\n }\n ]\n}" } }, @@ -229683,6 +231080,11 @@ "kind": "no_body" }, "description": "Verify a snapshot repository.\nCheck for common misconfigurations in a snapshot repository.", + "examples": { + "SnapshotVerifyRepositoryExample1": { + "method_request": "POST _snapshot/my_unverified_backup/_verify" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -229897,6 +231299,11 @@ "kind": "no_body" }, "description": "Delete an async SQL search.\nDelete an async SQL search or a stored synchronous SQL search.\nIf the search is still running, the API cancels it.\n\nIf the Elasticsearch security features are enabled, only the following users can use this API to delete a search:\n\n* Users with the `cancel_task` cluster privilege.\n* The user who first submitted the search.", + "examples": { + "SqlDeleteAsyncExample1": { + "method_request": "DELETE _sql/async/delete/FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -229952,6 +231359,11 @@ "kind": "no_body" }, "description": "Get async SQL search results.\nGet the current status and available results for an async SQL search or stored synchronous SQL search.\n\nIf the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API.", + "examples": { + "SqlGetAsyncExample1": { + "method_request": "GET _sql/async/FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=?wait_for_completion_timeout=2s&format=json" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -230129,6 +231541,11 @@ "kind": "no_body" }, "description": "Get the async SQL search status.\nGet the current status of an async SQL search or a stored synchronous SQL search.", + "examples": { + "SqlGetAsyncStatusExample1": { + "method_request": "GET _sql/async/status/FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -230967,6 +232384,11 @@ "kind": "no_body" }, "description": "Get SSL certificates.\n\nGet information about the X.509 certificates that are used to encrypt communications in the cluster.\nThe API returns a list that includes certificates from all TLS contexts including:\n\n- Settings for transport and HTTP interfaces\n- TLS settings that are used within authentication realms\n- TLS settings for remote monitoring exporters\n\nThe list includes certificates that are used for configuring trust, such as those configured in the `xpack.security.transport.ssl.truststore` and `xpack.security.transport.ssl.certificate_authorities` settings.\nIt also includes certificates that are used for configuring server identity, such as `xpack.security.http.ssl.keystore` and `xpack.security.http.ssl.certificate settings`.\n\nThe list does not include certificates that are sourced from the default SSL context of the Java Runtime Environment (JRE), even if those certificates are in use within Elasticsearch.\n\nNOTE: When a PKCS#11 token is configured as the truststore of the JRE, the API returns all the certificates that are included in the PKCS#11 token irrespective of whether these are used in the Elasticsearch TLS configuration.\n\nIf Elasticsearch is configured to use a keystore or truststore, the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster.", + "examples": { + "GetCertificatesRequestExample1": { + "method_request": "GET /_ssl/certificates" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -231000,7 +232422,6 @@ "examples": { "GetCertificatesResponseExample1": { "description": "A successful response from `GET /_ssl/certificates`, which provides information about the certificates on a single node of Elasticsearch.\n", - "method_request": "GET /_ssl/certificates", "value": "[\n {\n \"path\": \"certs/elastic-certificates.p12\",\n \"format\": \"PKCS12\",\n \"alias\": \"instance\",\n \"subject_dn\": \"CN=Elastic Certificate Tool Autogenerated CA\",\n \"serial_number\": \"a20f0ee901e8f69dc633ff633e5cd5437cdb4137\",\n \"has_private_key\": false,\n \"expiry\": \"2021-01-15T20:42:49.000Z\"\n },\n {\n \"path\": \"certs/elastic-certificates.p12\",\n \"format\": \"PKCS12\",\n \"alias\": \"ca\",\n \"subject_dn\": \"CN=Elastic Certificate Tool Autogenerated CA\",\n \"serial_number\": \"a20f0ee901e8f69dc633ff633e5cd5437cdb4137\",\n \"has_private_key\": false,\n \"expiry\": \"2021-01-15T20:42:49.000Z\"\n },\n {\n \"path\": \"certs/elastic-certificates.p12\",\n \"format\": \"PKCS12\",\n \"alias\": \"instance\",\n \"subject_dn\": \"CN=instance\",\n \"serial_number\": \"fc1905e1494dc5230218d079c47a617088f84ce0\",\n \"has_private_key\": true,\n \"expiry\": \"2021-01-15T20:44:32.000Z\"\n }\n]" } }, @@ -231160,6 +232581,11 @@ "kind": "no_body" }, "description": "Delete a synonym set.\n\nYou can only delete a synonyms set that is not in use by any index analyzer.\n\nSynonyms sets can be used in synonym graph token filters and synonym token filters.\nThese synonym filters can be used as part of search analyzers.\n\nAnalyzers need to be loaded when an index is restored (such as when a node starts, or the index becomes open).\nEven if the analyzer is not used on any field mapping, it still needs to be loaded on the index recovery phase.\n\nIf any analyzers cannot be loaded, the index becomes unavailable and the cluster status becomes red or yellow as index shards are not available.\nTo prevent that, synonyms sets that are used in analyzers can't be deleted.\nA delete request in this case will return a 400 response code.\n\nTo remove a synonyms set, you must first remove all indices that contain analyzers using it.\nYou can migrate an index by creating a new index that does not contain the token filter with the synonyms set, and use the reindex API in order to copy over the index data.\nOnce finished, you can delete the index.\nWhen the synonyms set is not used in analyzers, you will be able to delete it.", + "examples": { + "SynonymsDeleteSynonymExample1": { + "method_request": "DELETE _synonyms/my-synonyms-set" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -231215,6 +232641,11 @@ "kind": "no_body" }, "description": "Delete a synonym rule.\nDelete a synonym rule from a synonym set.", + "examples": { + "SynonymRuleDeleteRequestExample1": { + "method_request": "DELETE _synonyms/my-synonyms-set/test-1" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -231270,7 +232701,6 @@ "examples": { "SynonymRuleDeleteResponseExample1": { "description": "A successful response from `DELETE _synonyms/my-synonyms-set/test-1`. All analyzers using this synonyms set will be reloaded automatically to reflect the rule being deleted.\n", - "method_request": "DELETE _synonyms/my-synonyms-set/test-1", "value": "{\n \"result\": \"deleted\",\n \"reload_analyzers_details\": {\n \"_shards\": {\n \"total\": 2,\n \"successful\": 1,\n \"failed\": 0\n },\n \"reload_details\": [\n {\n \"index\": \"test-index\",\n \"reloaded_analyzers\": [\n \"my_search_analyzer\"\n ],\n \"reloaded_node_ids\": [\n \"1wYFZzq8Sxeu_Jvt9mlbkg\"\n ]\n }\n ]\n }\n}" } }, @@ -231289,6 +232719,11 @@ "kind": "no_body" }, "description": "Get a synonym set.", + "examples": { + "SynonymsGetRequestExample1": { + "method_request": "GET _synonyms/my-synonyms-set" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -231380,7 +232815,6 @@ "examples": { "SynonymsGetResponseExample1": { "description": "A successful response from `GET _synonyms/my-synonyms-set`.", - "method_request": "GET _synonyms/my-synonyms-set", "value": "{\n \"count\": 3,\n \"synonyms_set\": [\n {\n \"id\": \"test-1\",\n \"synonyms\": \"hello, hi\"\n },\n {\n \"id\": \"test-2\",\n \"synonyms\": \"bye, goodbye\"\n },\n {\n \"id\": \"test-3\",\n \"synonyms\": \"test => check\"\n }\n ]\n}" } }, @@ -231399,6 +232833,11 @@ "kind": "no_body" }, "description": "Get a synonym rule.\nGet a synonym rule from a synonym set.", + "examples": { + "SynonymRuleGetRequestExample1": { + "method_request": "GET _synonyms/my-synonyms-set/test-1" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -231454,7 +232893,6 @@ "examples": { "SynonymRuleGetResponseExample1": { "description": "A successful response from `GET _synonyms/my-synonyms-set/test-1`.", - "method_request": "GET _synonyms/my-synonyms-set/test-1", "value": "{\n \"id\": \"test-1\",\n \"synonyms\": \"hello, hi\"\n}" } }, @@ -231473,6 +232911,11 @@ "kind": "no_body" }, "description": "Get all synonym sets.\nGet a summary of all defined synonym sets.", + "examples": { + "SynonymsSetsGetRequestExample1": { + "method_request": "GET _synonyms" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -231551,7 +232994,6 @@ "examples": { "SynonymsSetsGetResponseExample1": { "description": "A successful response from `GET _synonyms`.", - "method_request": "GET _synonyms", "value": "{\n \"count\": 3,\n \"results\": [\n {\n \"synonyms_set\": \"ecommerce-synonyms\",\n \"count\": 2\n },\n {\n \"synonyms_set\": \"my-synonyms-set\",\n \"count\": 3\n },\n {\n \"synonyms_set\": \"new-ecommerce-synonyms\",\n \"count\": 1\n }\n ]\n}" } }, @@ -231633,6 +233075,11 @@ ] }, "description": "Create or update a synonym set.\nSynonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.", + "examples": { + "SynonymsPutRequestExample1": { + "method_request": "PUT _synonyms/my-synonyms-set" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -231784,7 +233231,6 @@ "examples": { "SynonymRuleResponseExample1": { "description": "A successful response from `PUT _synonyms/my-synonyms-set/test-1`.\n", - "method_request": "PUT _synonyms/my-synonyms-set/test-1", "value": "{\n \"result\": \"updated\",\n \"reload_analyzers_details\": {\n \"_shards\": {\n \"total\": 2,\n \"successful\": 1,\n \"failed\": 0\n },\n \"reload_details\": [\n {\n \"index\": \"test-index\",\n \"reloaded_analyzers\": [\n \"my_search_analyzer\"\n ],\n \"reloaded_node_ids\": [\n \"1wYFZzq8Sxeu_Jvt9mlbkg\"\n ]\n }\n ]\n }\n}" } }, @@ -232265,6 +233711,11 @@ "kind": "no_body" }, "description": "Cancel a task.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nA task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away.\nIt is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation.\nThe get task information API will continue to list these cancelled tasks until they complete.\nThe cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible.\n\nTo troubleshoot why a cancelled task does not complete promptly, use the get task information API with the `?detailed` parameter to identify the other tasks the system is running.\nYou can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task.", + "examples": { + "TasksCancelExample1": { + "method_request": "POST _tasks//_cancel" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -232388,6 +233839,11 @@ "kind": "no_body" }, "description": "Get task information.\nGet information about a task currently running in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nIf the task identifier is not found, a 404 response code indicates that there are no resources that match the request.", + "examples": { + "GetTaskRequestExample2": { + "method_request": "GET _tasks?detailed=true&actions=*/delete/byquery" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -232492,13 +233948,11 @@ "examples": { "GetTaskResponseExample1": { "description": "A successful response from `GET _tasks?actions=cluster:*`, which retrieves all cluster-related tasks.\n", - "method_request": "GET _tasks?actions=cluster:*", "summary": "Get cluster actions", "value": "{\n \"nodes\" : {\n \"oTUltX4IQMOUUVeiohTt8A\" : {\n \"name\" : \"H5dfFeA\",\n \"transport_address\" : \"127.0.0.1:9300\",\n \"host\" : \"127.0.0.1\",\n \"ip\" : \"127.0.0.1:9300\",\n \"tasks\" : {\n \"oTUltX4IQMOUUVeiohTt8A:124\" : {\n \"node\" : \"oTUltX4IQMOUUVeiohTt8A\",\n \"id\" : 124,\n \"type\" : \"direct\",\n \"action\" : \"cluster:monitor/tasks/lists[n]\",\n \"start_time_in_millis\" : 1458585884904,\n \"running_time_in_nanos\" : 47402,\n \"cancellable\" : false,\n \"parent_task_id\" : \"oTUltX4IQMOUUVeiohTt8A:123\"\n },\n \"oTUltX4IQMOUUVeiohTt8A:123\" : {\n \"node\" : \"oTUltX4IQMOUUVeiohTt8A\",\n \"id\" : 123,\n \"type\" : \"transport\",\n \"action\" : \"cluster:monitor/tasks/lists\",\n \"start_time_in_millis\" : 1458585884904,\n \"running_time_in_nanos\" : 236042,\n \"cancellable\" : false\n }\n }\n }\n }\n}" }, "GetTaskResponseExample2": { "description": "A successful response from `GET _tasks?detailed=true&actions=*/delete/byquery`, which gets the status of a delete by query operation. The `status` object contains the actual status. `total` is the total number of operations that the reindex expects to perform. You can estimate the progress by adding the `updated`, `created`, and `deleted` fields. The request will finish when their sum is equal to the `total` field.\n", - "method_request": "GET _tasks?detailed=true&actions=*/delete/byquery", "summary": "Get details about a delete by query", "value": "{\n \"nodes\" : {\n \"r1A2WoRbTwKZ516z6NEs5A\" : {\n \"name\" : \"r1A2WoR\",\n \"transport_address\" : \"127.0.0.1:9300\",\n \"host\" : \"127.0.0.1\",\n \"ip\" : \"127.0.0.1:9300\",\n \"attributes\" : {\n \"testattr\" : \"test\",\n \"portsfile\" : \"true\"\n },\n \"tasks\" : {\n \"r1A2WoRbTwKZ516z6NEs5A:36619\" : {\n \"node\" : \"r1A2WoRbTwKZ516z6NEs5A\",\n \"id\" : 36619,\n \"type\" : \"transport\",\n \"action\" : \"indices:data/write/delete/byquery\",\n \"status\" : { \n \"total\" : 6154,\n \"updated\" : 0,\n \"created\" : 0,\n \"deleted\" : 3500,\n \"batches\" : 36,\n \"version_conflicts\" : 0,\n \"noops\" : 0,\n \"retries\": 0,\n \"throttled_millis\": 0\n },\n \"description\" : \"\"\n }\n }\n }\n }\n}" } @@ -232518,6 +233972,11 @@ "kind": "no_body" }, "description": "Get all tasks.\nGet information about the tasks currently running on one or more nodes in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\n**Identifying running tasks**\n\nThe `X-Opaque-Id header`, when provided on the HTTP request header, is going to be returned as a header in the response as well as in the headers field for in the task information.\nThis enables you to track certain calls or associate certain tasks with the client that started them.\nFor example:\n\n```\ncurl -i -H \"X-Opaque-Id: 123456\" \"http://localhost:9200/_tasks?group_by=parents\"\n```\n\nThe API returns the following result:\n\n```\nHTTP/1.1 200 OK\nX-Opaque-Id: 123456\ncontent-type: application/json; charset=UTF-8\ncontent-length: 831\n\n{\n \"tasks\" : {\n \"u5lcZHqcQhu-rUoFaqDphA:45\" : {\n \"node\" : \"u5lcZHqcQhu-rUoFaqDphA\",\n \"id\" : 45,\n \"type\" : \"transport\",\n \"action\" : \"cluster:monitor/tasks/lists\",\n \"start_time_in_millis\" : 1513823752749,\n \"running_time_in_nanos\" : 293139,\n \"cancellable\" : false,\n \"headers\" : {\n \"X-Opaque-Id\" : \"123456\"\n },\n \"children\" : [\n {\n \"node\" : \"u5lcZHqcQhu-rUoFaqDphA\",\n \"id\" : 46,\n \"type\" : \"direct\",\n \"action\" : \"cluster:monitor/tasks/lists[n]\",\n \"start_time_in_millis\" : 1513823752750,\n \"running_time_in_nanos\" : 92133,\n \"cancellable\" : false,\n \"parent_task_id\" : \"u5lcZHqcQhu-rUoFaqDphA:45\",\n \"headers\" : {\n \"X-Opaque-Id\" : \"123456\"\n }\n }\n ]\n }\n }\n }\n```\nIn this example, `X-Opaque-Id: 123456` is the ID as a part of the response header.\nThe `X-Opaque-Id` in the task `headers` is the ID for the task that was initiated by the REST request.\nThe `X-Opaque-Id` in the children `headers` is the child task of the task that was initiated by the REST request.", + "examples": { + "ListTasksRequestExample1": { + "method_request": "GET _tasks?actions=*search&detailed" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -232651,7 +234110,6 @@ "examples": { "ListTasksResponseExample1": { "description": "A successful response from `GET _tasks?actions=*search&detailed` The `detailed` parameter affects the `description` field, which contains human readable text that identifies the particular request that the task is performing. For example, it helps identify the search request being performed by a search task.\n", - "method_request": "GET _tasks?actions=*search&detailed", "value": "{\n \"nodes\" : {\n \"oTUltX4IQMOUUVeiohTt8A\" : {\n \"name\" : \"H5dfFeA\",\n \"transport_address\" : \"127.0.0.1:9300\",\n \"host\" : \"127.0.0.1\",\n \"ip\" : \"127.0.0.1:9300\",\n \"tasks\" : {\n \"oTUltX4IQMOUUVeiohTt8A:464\" : {\n \"node\" : \"oTUltX4IQMOUUVeiohTt8A\",\n \"id\" : 464,\n \"type\" : \"transport\",\n \"action\" : \"indices:data/read/search\",\n \"description\" : \"indices[test], types[test], search_type[QUERY_THEN_FETCH], source[{\\\"query\\\":...}]\",\n \"start_time_in_millis\" : 1483478610008,\n \"running_time_in_nanos\" : 13991383,\n \"cancellable\" : true,\n \"cancelled\" : false\n }\n }\n }\n }\n}" } }, @@ -232848,6 +234306,11 @@ "kind": "no_body" }, "description": "Find the structure of a text field.\nFind the structure of a text field in an Elasticsearch index.\n\nThis API provides a starting point for extracting further information from log messages already ingested into Elasticsearch.\nFor example, if you have ingested data into a very simple index that has just `@timestamp` and message fields, you can use this API to see what common structure exists in the message field.\n\nThe response from the API contains:\n\n* Sample messages.\n* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.\n* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.\n* Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.\n\nAll this information can be calculated by the structure finder with no guidance.\nHowever, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.\n\nIf the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response.\nIt helps determine why the returned structure was chosen.", + "examples": { + "FindFieldStructureRequestExample1": { + "method_request": "GET _text_structure/find_field_structure?index=test-logs&field=message" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -233227,7 +234690,6 @@ "examples": { "FindFieldStructureResponseExample1": { "description": "A successful response from `GET _text_structure/find_field_structure?index=test-logs&field=message`.", - "method_request": "GET _text_structure/find_field_structure?index=test-logs&field=message", "value": "{\n \"num_lines_analyzed\" : 22,\n \"num_messages_analyzed\" : 22,\n \"sample_start\" : \"[2024-03-05T10:52:36,256][INFO ][o.a.l.u.VectorUtilPanamaProvider] [laptop] Java vector incubator API enabled; uses preferredBitSize=128\\n[2024-03-05T10:52:41,038][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-url]\\n\",\n \"charset\" : \"UTF-8\",\n \"format\" : \"semi_structured_text\",\n \"multiline_start_pattern\" : \"^\\\\[\\\\b\\\\d{4}-\\\\d{2}-\\\\d{2}[T ]\\\\d{2}:\\\\d{2}\",\n \"grok_pattern\" : \"\\\\[%{TIMESTAMP_ISO8601:timestamp}\\\\]\\\\[%{LOGLEVEL:loglevel} \\\\]\\\\[.*\",\n \"ecs_compatibility\" : \"disabled\",\n \"timestamp_field\" : \"timestamp\",\n \"joda_timestamp_formats\" : [\n \"ISO8601\"\n ],\n \"java_timestamp_formats\" : [\n \"ISO8601\"\n ],\n \"need_client_timezone\" : true,\n \"mappings\" : {\n \"properties\" : {\n \"@timestamp\" : {\n \"type\" : \"date\"\n },\n \"loglevel\" : {\n \"type\" : \"keyword\"\n },\n \"message\" : {\n \"type\" : \"text\"\n }\n }\n },\n \"ingest_pipeline\" : {\n \"description\" : \"Ingest pipeline created by text structure finder\",\n \"processors\" : [\n {\n \"grok\" : {\n \"field\" : \"message\",\n \"patterns\" : [\n \"\\\\[%{TIMESTAMP_ISO8601:timestamp}\\\\]\\\\[%{LOGLEVEL:loglevel} \\\\]\\\\[.*\"\n ],\n \"ecs_compatibility\" : \"disabled\"\n }\n },\n {\n \"date\" : {\n \"field\" : \"timestamp\",\n \"timezone\" : \"{{ event.timezone }}\",\n \"formats\" : [\n \"ISO8601\"\n ]\n }\n },\n {\n \"remove\" : {\n \"field\" : \"timestamp\"\n }\n }\n ]\n },\n \"field_stats\" : {\n \"loglevel\" : {\n \"count\" : 22,\n \"cardinality\" : 1,\n \"top_hits\" : [\n {\n \"value\" : \"INFO\",\n \"count\" : 22\n }\n ]\n },\n \"message\" : {\n \"count\" : 22,\n \"cardinality\" : 22,\n \"top_hits\" : [\n {\n \"value\" : \"[2024-03-05T10:52:36,256][INFO ][o.a.l.u.VectorUtilPanamaProvider] [laptop] Java vector incubator API enabled; uses preferredBitSize=128\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,038][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-url]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,042][INFO ][o.e.p.PluginsService ] [laptop] loaded module [rest-root]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [ingest-user-agent]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-core]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-redact]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [lang-painless]]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-s3]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-analytics]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-autoscaling]\",\n \"count\" : 1\n }\n ]\n },\n \"timestamp\" : {\n \"count\" : 22,\n \"cardinality\" : 14,\n \"earliest\" : \"2024-03-05T10:52:36,256\",\n \"latest\" : \"2024-03-05T10:52:49,199\",\n \"top_hits\" : [\n {\n \"value\" : \"2024-03-05T10:52:41,044\",\n \"count\" : 6\n },\n {\n \"value\" : \"2024-03-05T10:52:41,043\",\n \"count\" : 3\n },\n {\n \"value\" : \"2024-03-05T10:52:41,059\",\n \"count\" : 2\n },\n {\n \"value\" : \"2024-03-05T10:52:36,256\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:41,038\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:41,042\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:43,291\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:46,098\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:47,227\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:47,259\",\n \"count\" : 1\n }\n ]\n }\n }\n}" } }, @@ -233612,7 +235074,6 @@ "examples": { "FindMessageStructureResponseExample1": { "description": "A successful response from `POST _text_structure/find_message_structure`.", - "method_request": "POST _text_structure/find_message_structure", "value": "{\n \"num_lines_analyzed\" : 22,\n \"num_messages_analyzed\" : 22,\n \"sample_start\" : \"[2024-03-05T10:52:36,256][INFO ][o.a.l.u.VectorUtilPanamaProvider] [laptop] Java vector incubator API enabled; uses preferredBitSize=128\\n[2024-03-05T10:52:41,038][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-url]\\n\",\n \"charset\" : \"UTF-8\",\n \"format\" : \"semi_structured_text\",\n \"multiline_start_pattern\" : \"^\\\\[\\\\b\\\\d{4}-\\\\d{2}-\\\\d{2}[T ]\\\\d{2}:\\\\d{2}\",\n \"grok_pattern\" : \"\\\\[%{TIMESTAMP_ISO8601:timestamp}\\\\]\\\\[%{LOGLEVEL:loglevel} \\\\]\\\\[.*\",\n \"ecs_compatibility\" : \"disabled\",\n \"timestamp_field\" : \"timestamp\",\n \"joda_timestamp_formats\" : [\n \"ISO8601\"\n ],\n \"java_timestamp_formats\" : [\n \"ISO8601\"\n ],\n \"need_client_timezone\" : true,\n \"mappings\" : {\n \"properties\" : {\n \"@timestamp\" : {\n \"type\" : \"date\"\n },\n \"loglevel\" : {\n \"type\" : \"keyword\"\n },\n \"message\" : {\n \"type\" : \"text\"\n }\n }\n },\n \"ingest_pipeline\" : {\n \"description\" : \"Ingest pipeline created by text structure finder\",\n \"processors\" : [\n {\n \"grok\" : {\n \"field\" : \"message\",\n \"patterns\" : [\n \"\\\\[%{TIMESTAMP_ISO8601:timestamp}\\\\]\\\\[%{LOGLEVEL:loglevel} \\\\]\\\\[.*\"\n ],\n \"ecs_compatibility\" : \"disabled\"\n }\n },\n {\n \"date\" : {\n \"field\" : \"timestamp\",\n \"timezone\" : \"{{ event.timezone }}\",\n \"formats\" : [\n \"ISO8601\"\n ]\n }\n },\n {\n \"remove\" : {\n \"field\" : \"timestamp\"\n }\n }\n ]\n },\n \"field_stats\" : {\n \"loglevel\" : {\n \"count\" : 22,\n \"cardinality\" : 1,\n \"top_hits\" : [\n {\n \"value\" : \"INFO\",\n \"count\" : 22\n }\n ]\n },\n \"message\" : {\n \"count\" : 22,\n \"cardinality\" : 22,\n \"top_hits\" : [\n {\n \"value\" : \"[2024-03-05T10:52:36,256][INFO ][o.a.l.u.VectorUtilPanamaProvider] [laptop] Java vector incubator API enabled; uses preferredBitSize=128\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,038][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-url]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,042][INFO ][o.e.p.PluginsService ] [laptop] loaded module [rest-root]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [ingest-user-agent]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-core]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-redact]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [lang-painless]]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-s3]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-analytics]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-autoscaling]\",\n \"count\" : 1\n }\n ]\n },\n \"timestamp\" : {\n \"count\" : 22,\n \"cardinality\" : 14,\n \"earliest\" : \"2024-03-05T10:52:36,256\",\n \"latest\" : \"2024-03-05T10:52:49,199\",\n \"top_hits\" : [\n {\n \"value\" : \"2024-03-05T10:52:41,044\",\n \"count\" : 6\n },\n {\n \"value\" : \"2024-03-05T10:52:41,043\",\n \"count\" : 3\n },\n {\n \"value\" : \"2024-03-05T10:52:41,059\",\n \"count\" : 2\n },\n {\n \"value\" : \"2024-03-05T10:52:36,256\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:41,038\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:41,042\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:43,291\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:46,098\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:47,227\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:47,259\",\n \"count\" : 1\n }\n ]\n }\n }\n}" } }, @@ -234134,7 +235595,6 @@ "examples": { "FindStructureResponseExample1": { "description": "A successful response from `POST _text_structure/find_structure`.", - "method_request": "POST _text_structure/find_structure", "value": "{\n \"num_lines_analyzed\" : 24,\n \"num_messages_analyzed\" : 24,\n \"sample_start\" : \"{\\\"name\\\": \\\"Leviathan Wakes\\\", \\\"author\\\": \\\"James S.A. Corey\\\", \\\"release_date\\\": \\\"2011-06-02\\\", \\\"page_count\\\": 561}\\n{\\\"name\\\": \\\"Hyperion\\\", \\\"author\\\": \\\"Dan Simmons\\\", \\\"release_date\\\": \\\"1989-05-26\\\", \\\"page_count\\\": 482}\\n\",\n \"charset\" : \"UTF-8\",\n \"has_byte_order_marker\" : false,\n \"format\" : \"ndjson\",\n \"ecs_compatibility\" : \"disabled\",\n \"timestamp_field\" : \"release_date\",\n \"joda_timestamp_formats\" : [\n \"ISO8601\"\n ],\n \"java_timestamp_formats\" : [\n \"ISO8601\"\n ],\n \"need_client_timezone\" : true,\n \"mappings\" : {\n \"properties\" : {\n \"@timestamp\" : {\n \"type\" : \"date\"\n },\n \"author\" : {\n \"type\" : \"keyword\"\n },\n \"name\" : {\n \"type\" : \"keyword\"\n },\n \"page_count\" : {\n \"type\" : \"long\"\n },\n \"release_date\" : {\n \"type\" : \"date\",\n \"format\" : \"iso8601\"\n }\n }\n },\n \"ingest_pipeline\" : {\n \"description\" : \"Ingest pipeline created by text structure finder\",\n \"processors\" : [\n {\n \"date\" : {\n \"field\" : \"release_date\",\n \"timezone\" : \"{{ event.timezone }}\",\n \"formats\" : [\n \"ISO8601\"\n ]\n }\n }\n ]\n },\n \"field_stats\" : {\n \"author\" : {\n \"count\" : 24,\n \"cardinality\" : 20,\n \"top_hits\" : [\n {\n \"value\" : \"Frank Herbert\",\n \"count\" : 4\n },\n {\n \"value\" : \"Robert A. Heinlein\",\n \"count\" : 2\n },\n {\n \"value\" : \"Alastair Reynolds\",\n \"count\" : 1\n },\n {\n \"value\" : \"Aldous Huxley\",\n \"count\" : 1\n },\n {\n \"value\" : \"Dan Simmons\",\n \"count\" : 1\n },\n {\n \"value\" : \"Douglas Adams\",\n \"count\" : 1\n },\n {\n \"value\" : \"George Orwell\",\n \"count\" : 1\n },\n {\n \"value\" : \"Iain M. Banks\",\n \"count\" : 1\n },\n {\n \"value\" : \"Isaac Asimov\",\n \"count\" : 1\n },\n {\n \"value\" : \"James S.A. Corey\",\n \"count\" : 1\n }\n ]\n },\n \"name\" : {\n \"count\" : 24,\n \"cardinality\" : 24,\n \"top_hits\" : [\n {\n \"value\" : \"1984\",\n \"count\" : 1\n },\n {\n \"value\" : \"A Fire Upon the Deep\",\n \"count\" : 1\n },\n {\n \"value\" : \"Brave New World\",\n \"count\" : 1\n },\n {\n \"value\" : \"Children of Dune\",\n \"count\" : 1\n },\n {\n \"value\" : \"Consider Phlebas\",\n \"count\" : 1\n },\n {\n \"value\" : \"Dune\",\n \"count\" : 1\n },\n {\n \"value\" : \"Dune Messiah\",\n \"count\" : 1\n },\n {\n \"value\" : \"Ender's Game\",\n \"count\" : 1\n },\n {\n \"value\" : \"Fahrenheit 451\",\n \"count\" : 1\n },\n {\n \"value\" : \"Foundation\",\n \"count\" : 1\n }\n ]\n },\n \"page_count\" : {\n \"count\" : 24,\n \"cardinality\" : 24,\n \"min_value\" : 180,\n \"max_value\" : 768,\n \"mean_value\" : 387.0833333333333,\n \"median_value\" : 329.5,\n \"top_hits\" : [\n {\n \"value\" : 180,\n \"count\" : 1\n },\n {\n \"value\" : 208,\n \"count\" : 1\n },\n {\n \"value\" : 224,\n \"count\" : 1\n },\n {\n \"value\" : 227,\n \"count\" : 1\n },\n {\n \"value\" : 268,\n \"count\" : 1\n },\n {\n \"value\" : 271,\n \"count\" : 1\n },\n {\n \"value\" : 275,\n \"count\" : 1\n },\n {\n \"value\" : 288,\n \"count\" : 1\n },\n {\n \"value\" : 304,\n \"count\" : 1\n },\n {\n \"value\" : 311,\n \"count\" : 1\n }\n ]\n },\n \"release_date\" : {\n \"count\" : 24,\n \"cardinality\" : 20,\n \"earliest\" : \"1932-06-01\",\n \"latest\" : \"2011-06-02\",\n \"top_hits\" : [\n {\n \"value\" : \"1985-06-01\",\n \"count\" : 3\n },\n {\n \"value\" : \"1969-06-01\",\n \"count\" : 2\n },\n {\n \"value\" : \"1992-06-01\",\n \"count\" : 2\n },\n {\n \"value\" : \"1932-06-01\",\n \"count\" : 1\n },\n {\n \"value\" : \"1951-06-01\",\n \"count\" : 1\n },\n {\n \"value\" : \"1953-10-15\",\n \"count\" : 1\n },\n {\n \"value\" : \"1959-12-01\",\n \"count\" : 1\n },\n {\n \"value\" : \"1965-06-01\",\n \"count\" : 1\n },\n {\n \"value\" : \"1966-04-01\",\n \"count\" : 1\n },\n {\n \"value\" : \"1969-10-15\",\n \"count\" : 1\n }\n ]\n }\n }\n}" } }, @@ -234330,7 +235790,6 @@ "examples": { "TestGrokPatternResponseExample1": { "description": "A successful response from `GET _text_structure/test_grok_pattern`.", - "method_request": "GET _text_structure/test_grok_pattern", "value": "{\n \"matches\": [\n {\n \"matched\": true,\n \"fields\": {\n \"first_name\": [\n {\n \"match\": \"John\",\n \"offset\": 6,\n \"length\": 4\n }\n ],\n \"last_name\": [\n {\n \"match\": \"Doe\",\n \"offset\": 11,\n \"length\": 3\n }\n ]\n }\n },\n {\n \"matched\": false\n }\n ]\n}" } }, @@ -234801,6 +236260,11 @@ "kind": "no_body" }, "description": "Delete a transform.", + "examples": { + "TransformDeleteTransformExample1": { + "method_request": "DELETE _transform/ecommerce_transform" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -234902,6 +236366,11 @@ "kind": "no_body" }, "description": "Get transforms.\nGet configuration information for transforms.", + "examples": { + "TransformGetTransformExample1": { + "method_request": "GET _transform?size=10" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -235410,6 +236879,11 @@ "kind": "no_body" }, "description": "Get transform stats.\n\nGet usage information for transforms.", + "examples": { + "TransformGetTransformStatsExample1": { + "method_request": "GET _transform/ecommerce-customer-transform/_stats" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -236259,7 +237733,6 @@ "examples": { "PreviewTransformResponseExample1": { "description": "An abbreviated response from `POST _transform/_preview` that contains a preview a transform that uses the pivot method.", - "method_request": "POST _transform/_preview", "value": "{\n \"preview\": [\n {\n \"max_price\": 171,\n \"customer_id\": \"10\"\n },\n {\n \"max_price\": 233,\n \"customer_id\": \"11\"\n },\n {\n \"max_price\": 200,\n \"customer_id\": \"12\"\n },\n {\n \"max_price\": 301,\n \"customer_id\": \"13\"\n },\n {\n \"max_price\": 176,\n \"customer_id\": \"14\"\n },\n {\n \"max_price\": 2250,\n \"customer_id\": \"15\"\n },\n {\n \"max_price\": 170,\n \"customer_id\": \"16\"\n },\n {\n \"max_price\": 243,\n \"customer_id\": \"17\"\n },\n {\n \"max_price\": 154,\n \"customer_id\": \"18\"\n },\n {\n \"max_price\": 393,\n \"customer_id\": \"19\"\n },\n {\n \"max_price\": 165,\n \"customer_id\": \"20\"\n },\n {\n \"max_price\": 115,\n \"customer_id\": \"21\"\n },\n {\n \"max_price\": 192,\n \"customer_id\": \"22\"\n },\n {\n \"max_price\": 169,\n \"customer_id\": \"23\"\n },\n {\n \"max_price\": 230,\n \"customer_id\": \"24\"\n },\n {\n \"max_price\": 278,\n \"customer_id\": \"25\"\n },\n {\n \"max_price\": 200,\n \"customer_id\": \"26\"\n },\n {\n \"max_price\": 344,\n \"customer_id\": \"27\"\n },\n {\n \"max_price\": 175,\n \"customer_id\": \"28\"\n },\n {\n \"max_price\": 177,\n \"customer_id\": \"29\"\n },\n {\n \"max_price\": 190,\n \"customer_id\": \"30\"\n },\n {\n \"max_price\": 190,\n \"customer_id\": \"31\"\n },\n {\n \"max_price\": 205,\n \"customer_id\": \"32\"\n },\n {\n \"max_price\": 215,\n \"customer_id\": \"33\"\n },\n {\n \"max_price\": 270,\n \"customer_id\": \"34\"\n },\n {\n \"max_price\": 184,\n \"customer_id\": \"36\"\n },\n {\n \"max_price\": 222,\n \"customer_id\": \"37\"\n },\n {\n \"max_price\": 370,\n \"customer_id\": \"38\"\n },\n {\n \"max_price\": 240,\n \"customer_id\": \"39\"\n },\n {\n \"max_price\": 230,\n \"customer_id\": \"4\"\n },\n {\n \"max_price\": 229,\n \"customer_id\": \"41\"\n },\n {\n \"max_price\": 190,\n \"customer_id\": \"42\"\n },\n {\n \"max_price\": 150,\n \"customer_id\": \"43\"\n },\n {\n \"max_price\": 175,\n \"customer_id\": \"44\"\n },\n {\n \"max_price\": 190,\n \"customer_id\": \"45\"\n },\n {\n \"max_price\": 150,\n \"customer_id\": \"46\"\n },\n {\n \"max_price\": 310,\n \"customer_id\": \"48\"\n },\n {\n \"max_price\": 223,\n \"customer_id\": \"49\"\n },\n {\n \"max_price\": 283,\n \"customer_id\": \"5\"\n },\n {\n \"max_price\": 185,\n \"customer_id\": \"50\"\n },\n {\n \"max_price\": 190,\n \"customer_id\": \"51\"\n },\n {\n \"max_price\": 333,\n \"customer_id\": \"52\"\n },\n {\n \"max_price\": 165,\n \"customer_id\": \"6\"\n },\n {\n \"max_price\": 144,\n \"customer_id\": \"7\"\n },\n {\n \"max_price\": 198,\n \"customer_id\": \"8\"\n },\n {\n \"max_price\": 210,\n \"customer_id\": \"9\"\n }\n ],\n \"generated_dest_index\": {\n \"mappings\": {\n \"_meta\": {\n \"_transform\": {\n \"transform\": \"transform-preview\",\n \"version\": {\n \"created\": \"10.0.0\"\n },\n \"creation_date_in_millis\": 1712948905889\n },\n \"created_by\": \"transform\"\n },\n \"properties\": {\n \"max_price\": {\n \"type\": \"half_float\"\n },\n \"customer_id\": {\n \"type\": \"keyword\"\n }\n }\n },\n \"settings\": {\n \"index\": {\n \"number_of_shards\": \"1\",\n \"auto_expand_replicas\": \"0-1\"\n }\n },\n \"aliases\": {}\n }\n}" } }, @@ -236509,6 +237982,11 @@ "kind": "no_body" }, "description": "Reset a transform.\n\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", + "examples": { + "TransformResetTransformExample1": { + "method_request": "POST _transform/ecommerce_transform/_reset" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -236597,6 +238075,11 @@ "kind": "no_body" }, "description": "Schedule a transform to start now.\n\nInstantly run a transform to process data.\nIf you run this API, the transform will process the new data instantly,\nwithout waiting for the configured frequency interval. After the API is called,\nthe transform will be processed again at `now + frequency` unless the API\nis called again in the meantime.", + "examples": { + "TransformScheduleNowTransformExample1": { + "method_request": "POST _transform/ecommerce_transform/_schedule_now" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -236672,6 +238155,11 @@ "kind": "no_body" }, "description": "Start a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", + "examples": { + "TransformStartTransformExample1": { + "method_request": "POST _transform/ecommerce-customer-transform/_start" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -236759,6 +238247,11 @@ "kind": "no_body" }, "description": "Stop transforms.\nStops one or more transforms.", + "examples": { + "TransformStopTransformExample1": { + "method_request": "POST _transform/ecommerce_transform/_stop" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -237239,6 +238732,11 @@ "kind": "no_body" }, "description": "Upgrade all transforms.\n\nTransforms are compatible across minor versions and between supported major versions.\nHowever, over time, the format of transform configuration information may change.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version.\nIt also cleans up the internal data structures that store the transform state and checkpoints.\nThe upgrade does not affect the source and destination indices.\nThe upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged.\n\nIf a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue.\nResolve the issue then re-run the process again.\nA summary is returned when the upgrade is finished.\n\nTo ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster.\nYou may want to perform a recent cluster backup prior to the upgrade.", + "examples": { + "TransformUpgradeTransformsExample1": { + "method_request": "POST _transform/_upgrade" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -241798,6 +243296,11 @@ "kind": "no_body" }, "description": "Acknowledge a watch.\nAcknowledging a watch enables you to manually throttle the execution of the watch's actions.\n\nThe acknowledgement state of an action is stored in the `status.actions..ack.state` structure.\n\nIMPORTANT: If the specified watch is currently being executed, this API will return an error\nThe reason for this behavior is to prevent overwriting the watch status from a watch execution.\n\nAcknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`.\nThis happens when the condition of the watch is not met (the condition evaluates to false).", + "examples": { + "WatcherAckWatchRequestExample1": { + "method_request": "POST _watcher/watch/my_watch/_ack" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -241858,7 +243361,6 @@ "examples": { "WatcherAckWatchResponseExample1": { "description": "A successful response from `POST _watcher/watch/my_watch/_ack`.", - "method_request": "POST _watcher/watch/my_watch/_ack", "value": "{\n \"status\": {\n \"state\": {\n \"active\": true,\n \"timestamp\": \"2015-05-26T18:04:27.723Z\"\n },\n \"last_checked\": \"2015-05-26T18:04:27.753Z\",\n \"last_met_condition\": \"2015-05-26T18:04:27.763Z\",\n \"actions\": {\n \"test_index\": {\n \"ack\" : {\n \"timestamp\": \"2015-05-26T18:04:27.713Z\",\n \"state\": \"acked\"\n },\n \"last_execution\" : {\n \"timestamp\": \"2015-05-25T18:04:27.733Z\",\n \"successful\": true\n },\n \"last_successful_execution\" : {\n \"timestamp\": \"2015-05-25T18:04:27.773Z\",\n \"successful\": true\n }\n }\n },\n \"execution_state\": \"executed\",\n \"version\": 2\n }\n}" } }, @@ -241877,6 +243379,11 @@ "kind": "no_body" }, "description": "Activate a watch.\nA watch can be either active or inactive.", + "examples": { + "WatcherActivateWatchExample1": { + "method_request": "PUT _watcher/watch/my_watch/_activate" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -241937,6 +243444,11 @@ "kind": "no_body" }, "description": "Deactivate a watch.\nA watch can be either active or inactive.", + "examples": { + "WatcherDeactivateWatchExample1": { + "method_request": "PUT _watcher/watch/my_watch/_deactivate" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -241997,6 +243509,11 @@ "kind": "no_body" }, "description": "Delete a watch.\nWhen the watch is removed, the document representing the watch in the `.watches` index is gone and it will never be run again.\n\nDeleting a watch does not delete any watch execution records related to this watch from the watch history.\n\nIMPORTANT: Deleting a watch must be done by using only this API.\nDo not delete the watch directly from the `.watches` index using the Elasticsearch delete document API\nWhen Elasticsearch security features are enabled, make sure no write privileges are granted to anyone for the `.watches` index.", + "examples": { + "DeleteWatchRequestExample1": { + "method_request": "DELETE _watcher/watch/my_watch" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -242067,7 +243584,6 @@ "examples": { "DeleteWatchResponseExample1": { "description": "A successful response from `DELETE _watcher/watch/my_watch`.", - "method_request": "DELETE _watcher/watch/my_watch", "value": "{\n \"found\": true,\n \"_id\": \"my_watch\",\n \"_version\": 2\n}" } }, @@ -242287,7 +243803,6 @@ "examples": { "WatcherExecuteWatchResponseExample1": { "description": "A successful response from `POST _watcher/watch/my_watch/_execute`.\n", - "method_request": "POST _watcher/watch/my_watch/_execute", "value": "{\n \"_id\": \"my_watch_0-2015-06-02T23:17:55.124Z\", \n \"watch_record\": { \n \"@timestamp\": \"2015-06-02T23:17:55.124Z\",\n \"watch_id\": \"my_watch\",\n \"node\": \"my_node\",\n \"messages\": [],\n \"trigger_event\": {\n \"type\": \"manual\",\n \"triggered_time\": \"2015-06-02T23:17:55.124Z\",\n \"manual\": {\n \"schedule\": {\n \"scheduled_time\": \"2015-06-02T23:17:55.124Z\"\n }\n }\n },\n \"state\": \"executed\",\n \"status\": {\n \"version\": 1,\n \"execution_state\": \"executed\",\n \"state\": {\n \"active\": true,\n \"timestamp\": \"2015-06-02T23:17:55.111Z\"\n },\n \"last_checked\": \"2015-06-02T23:17:55.124Z\",\n \"last_met_condition\": \"2015-06-02T23:17:55.124Z\",\n \"actions\": {\n \"test_index\": {\n \"ack\": {\n \"timestamp\": \"2015-06-02T23:17:55.124Z\",\n \"state\": \"ackable\"\n },\n \"last_execution\": {\n \"timestamp\": \"2015-06-02T23:17:55.124Z\",\n \"successful\": true\n },\n \"last_successful_execution\": {\n \"timestamp\": \"2015-06-02T23:17:55.124Z\",\n \"successful\": true\n }\n }\n }\n },\n \"input\": {\n \"simple\": {\n \"payload\": {\n \"send\": \"yes\"\n }\n }\n },\n \"condition\": {\n \"always\": {}\n },\n \"result\": { \n \"execution_time\": \"2015-06-02T23:17:55.124Z\",\n \"execution_duration\": 12608,\n \"input\": {\n \"type\": \"simple\",\n \"payload\": {\n \"foo\": \"bar\"\n },\n \"status\": \"success\"\n },\n \"condition\": {\n \"type\": \"always\",\n \"met\": true,\n \"status\": \"success\"\n },\n \"actions\": [\n {\n \"id\": \"test_index\",\n \"index\": {\n \"response\": {\n \"index\": \"test\",\n \"version\": 1,\n \"created\": true,\n \"result\": \"created\",\n \"id\": \"AVSHKzPa9zx62AzUzFXY\"\n }\n },\n \"status\": \"success\",\n \"type\": \"index\"\n }\n ]\n },\n \"user\": \"test_admin\" \n }\n}" } }, @@ -242440,6 +243955,11 @@ "kind": "no_body" }, "description": "Get Watcher index settings.\nGet settings for the Watcher internal index (`.watches`).\nOnly a subset of settings are shown, for example `index.auto_expand_replicas` and `index.number_of_replicas`.", + "examples": { + "WatcherGetSettingsExample1": { + "method_request": "GET /_watcher/settings" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -242506,6 +244026,11 @@ "kind": "no_body" }, "description": "Get a watch.", + "examples": { + "GetWatchRequestExample1": { + "method_request": "GET _watcher/watch/my_watch" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -242620,7 +244145,6 @@ "examples": { "GetWatchResponseExample1": { "description": "A successful response from `GET _watcher/watch/my_watch`.", - "method_request": "GET _watcher/watch/my_watch", "value": "{\n \"found\": true,\n \"_id\": \"my_watch\",\n \"_seq_no\": 0,\n \"_primary_term\": 1,\n \"_version\": 1,\n \"status\": { \n \"version\": 1,\n \"state\": {\n \"active\": true,\n \"timestamp\": \"2015-05-26T18:21:08.630Z\"\n },\n \"actions\": {\n \"test_index\": {\n \"ack\": {\n \"timestamp\": \"2015-05-26T18:21:08.630Z\",\n \"state\": \"awaits_successful_execution\"\n }\n }\n }\n },\n \"watch\": {\n \"input\": {\n \"simple\": {\n \"payload\": {\n \"send\": \"yes\"\n }\n }\n },\n \"condition\": {\n \"always\": {}\n },\n \"trigger\": {\n \"schedule\": {\n \"hourly\": {\n \"minute\": [0, 5]\n }\n }\n },\n \"actions\": {\n \"test_index\": {\n \"index\": {\n \"index\": \"test\"\n }\n }\n }\n }\n}" } }, @@ -242986,6 +244510,11 @@ ] }, "description": "Query watches.\nGet all registered watches in a paginated manner and optionally filter watches by a query.\n\nNote that only the `_id` and `metadata.*` fields are queryable or sortable.", + "examples": { + "WatcherQueryWatchesRequestExample1": { + "method_request": "GET /_watcher/_query/watches" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -243037,7 +244566,6 @@ "examples": { "WatcherQueryWatchesResponseExample1": { "description": "A successful response from `GET /_watcher/_query/watches`.", - "method_request": "GET /_watcher/_query/watches", "value": "{\n \"count\": 1,\n \"watches\": [\n {\n \"_id\": \"my_watch\",\n \"watch\": {\n \"trigger\": {\n \"schedule\": {\n \"hourly\": {\n \"minute\": [\n 0,\n 5\n ]\n }\n }\n },\n \"input\": {\n \"simple\": {\n \"payload\": {\n \"send\": \"yes\"\n }\n }\n },\n \"condition\": {\n \"always\": {}\n },\n \"actions\": {\n \"test_index\": {\n \"index\": {\n \"index\": \"test\"\n }\n }\n }\n },\n \"status\": {\n \"state\": {\n \"active\": true,\n \"timestamp\": \"2015-05-26T18:21:08.630Z\"\n },\n \"actions\": {\n \"test_index\": {\n \"ack\": {\n \"timestamp\": \"2015-05-26T18:21:08.630Z\",\n \"state\": \"awaits_successful_execution\"\n }\n }\n },\n \"version\": -1\n },\n \"_seq_no\": 0,\n \"_primary_term\": 1\n }\n ]\n}" } }, @@ -243056,6 +244584,11 @@ "kind": "no_body" }, "description": "Start the watch service.\nStart the Watcher service if it is not already running.", + "examples": { + "WatcherStartRequestExample1": { + "method_request": "POST _watcher/_start" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -243100,7 +244633,6 @@ "examples": { "WatcherStartResponseExample1": { "description": "A successful response from `POST _watcher/_start`.", - "method_request": "POST _watcher/_start", "value": "{\n \"acknowledged\": true\n}" } }, @@ -243119,6 +244651,11 @@ "kind": "no_body" }, "description": "Get Watcher statistics.\nThis API always returns basic metrics.\nYou retrieve more metrics by using the metric parameter.", + "examples": { + "WatcherStatsRequestExample1": { + "method_request": "GET _watcher/stats" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -243260,19 +244797,16 @@ "examples": { "WatcherStatsResponseExample1": { "description": "A successful response from `GET _watcher/stats`.", - "method_request": "GET _watcher/stats", "summary": "Basic metrics", "value": "{\n \"watcher_state\": \"started\", \n \"watch_count\": 1, \n \"execution_thread_pool\": {\n \"size\": 1000, \n \"max_size\": 1 \n }\n}" }, "WatcherStatsResponseExample2": { "description": "A successful response from `GET _watcher/stats?metric=current_watches`.", - "method_request": "GET _watcher/stats?metric=current_watches", "summary": "Current watch metrics", "value": "{\n \"watcher_state\": \"started\",\n \"watch_count\": 2,\n \"execution_thread_pool\": {\n \"queue_size\": 1000,\n \"max_size\": 20\n },\n \"current_watches\": [ \n {\n \"watch_id\": \"slow_condition\", \n \"watch_record_id\": \"slow_condition_3-2015-05-13T07:42:32.179Z\", \n \"triggered_time\": \"2015-05-12T11:53:51.800Z\", \n \"execution_time\": \"2015-05-13T07:42:32.179Z\", \n \"execution_phase\": \"condition\" \n }\n ]\n}" }, "WatcherStatsResponseExample3": { "description": "An abbreviated response from `GET _watcher/stats/queued_watches`.", - "method_request": "GET _watcher/stats/queued_watches", "summary": "Queued watch metrics", "value": "{\n \"watcher_state\": \"started\",\n \"watch_count\": 10,\n \"execution_thread_pool\": {\n \"queue_size\": 1000,\n \"max_size\": 20\n },\n \"queued_watches\": [ \n {\n \"watch_id\": \"slow_condition4\", \n \"watch_record_id\": \"slow_condition4_223-2015-05-21T11:59:59.811Z\", \n \"triggered_time\": \"2015-05-21T11:59:59.811Z\", \n \"execution_time\": \"2015-05-21T11:59:59.811Z\" \n }\n ]\n}" } @@ -243524,6 +245058,11 @@ "kind": "no_body" }, "description": "Stop the watch service.\nStop the Watcher service if it is running.", + "examples": { + "WatcherStopRequestExample1": { + "method_request": "POST _watcher/_stop" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -243568,7 +245107,6 @@ "examples": { "WatcherStopResponseExample1": { "description": "A successful response from `POST _watcher/_stop`.", - "method_request": "POST _watcher/_stop", "value": "{\n \"acknowledged\": true\n}" } }, @@ -244208,6 +245746,11 @@ "kind": "no_body" }, "description": "Get information.\nThe information provided by the API includes:\n\n* Build information including the build number and timestamp.\n* License information about the currently installed license.\n* Feature information for the features that are currently enabled and available under the current license.", + "examples": { + "XPackInfoRequestExample1": { + "method_request": "GET /_xpack" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -244317,7 +245860,6 @@ "examples": { "XPackInfoResponseExample1": { "description": "A successful response from `GET /_xpack`.", - "method_request": "GET /_xpack", "value": "{\n \"build\" : {\n \"hash\" : \"2798b1a3ce779b3611bb53a0082d4d741e4d3168\",\n \"date\" : \"2015-04-07T13:34:42Z\"\n },\n \"license\" : {\n \"uid\" : \"893361dc-9749-4997-93cb-xxx\",\n \"type\" : \"trial\",\n \"mode\" : \"trial\",\n \"status\" : \"active\",\n \"expiry_date_in_millis\" : 1542665112332\n },\n \"features\" : {\n \"ccr\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"aggregate_metric\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"analytics\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"archive\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"enrich\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"graph\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"ilm\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"logstash\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"ml\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"esql\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"monitoring\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"rollup\": {\n \"available\": true,\n \"enabled\": true\n },\n \"searchable_snapshots\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"security\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"slm\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"spatial\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"eql\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"sql\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"transform\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"voting_only\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"watcher\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"data_streams\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"data_tiers\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"enterprise_search\": {\n \"available\": true,\n \"enabled\": true\n },\n \"universal_profiling\": {\n \"available\": true,\n \"enabled\": true\n },\n \"logsdb\": {\n \"available\": true,\n \"enabled\": false\n }\n },\n \"tagline\" : \"You know, for X\"\n}" } }, @@ -246599,6 +248141,11 @@ "kind": "no_body" }, "description": "Get usage information.\nGet information about the features that are currently enabled and available under the current license.\nThe API also provides some usage statistics.", + "examples": { + "XPackUsageRequestExample1": { + "method_request": "GET /_xpack/usage" + } + }, "inherits": { "type": { "name": "RequestBase", @@ -246951,7 +248498,6 @@ "examples": { "XPackUsageResponseExample1": { "description": "An abbreviated response from `GET /_xpack/usage`.", - "method_request": "GET /_xpack/usage", "value": "{\n \"security\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"monitoring\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"collection_enabled\" : false,\n \"enabled_exporters\" : {\n \"local\" : 1\n }\n },\n \"watcher\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"execution\" : {\n \"actions\" : {\n \"_all\" : {\n \"total\" : 0,\n \"total_time_in_ms\" : 0\n }\n }\n },\n \"watch\" : {\n \"input\" : {\n \"_all\" : {\n \"total\" : 0,\n \"active\" : 0\n }\n },\n \"trigger\" : {\n \"_all\" : {\n \"total\" : 0,\n \"active\" : 0\n }\n }\n },\n \"count\" : {\n \"total\" : 0,\n \"active\" : 0\n }\n },\n \"graph\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"ml\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"jobs\" : {\n \"_all\" : {\n \"count\" : 0,\n \"detectors\" : { },\n \"created_by\" : { },\n \"model_size\" : { },\n \"forecasts\" : {\n \"total\" : 0,\n \"forecasted_jobs\" : 0\n }\n }\n },\n \"datafeeds\" : {\n \"_all\" : {\n \"count\" : 0\n }\n },\n \"data_frame_analytics_jobs\" : {\n \"_all\" : {\n \"count\" : 0\n },\n \"analysis_counts\": { },\n \"memory_usage\": {\n \"peak_usage_bytes\": {\n \"min\": 0.0,\n \"max\": 0.0,\n \"avg\": 0.0,\n \"total\": 0.0\n }\n }\n },\n \"inference\" : {\n \"ingest_processors\" : {\n \"_all\" : {\n \"num_docs_processed\" : {\n \"max\" : 0,\n \"sum\" : 0,\n \"min\" : 0\n },\n \"pipelines\" : {\n \"count\" : 0\n },\n \"num_failures\" : {\n \"max\" : 0,\n \"sum\" : 0,\n \"min\" : 0\n },\n \"time_ms\" : {\n \"max\" : 0,\n \"sum\" : 0,\n \"min\" : 0\n }\n }\n },\n \"trained_models\" : {\n \"_all\" : {\n \"count\": 1\n },\n \"count\": {\n \"total\": 1,\n \"prepackaged\": 1,\n \"other\": 0\n },\n \"model_size_bytes\": {\n \"min\": 0.0,\n \"max\": 0.0,\n \"avg\": 0.0,\n \"total\": 0.0\n },\n \"estimated_operations\": {\n \"min\": 0.0,\n \"max\": 0.0,\n \"avg\": 0.0,\n \"total\": 0.0\n }\n },\n \"deployments\": {\n \"count\": 0,\n \"inference_counts\": {\n \"total\": 0.0,\n \"min\": 0.0,\n \"avg\": 0.0,\n \"max\": 0.0\n },\n \"stats_by_model\": [],\n \"model_sizes_bytes\": {\n \"total\": 0.0,\n \"min\": 0.0,\n \"avg\": 0.0,\n \"max\": 0.0\n },\n \"time_ms\": {\n \"avg\": 0.0\n }\n }\n },\n \"node_count\" : 1,\n \"memory\": {\n anomaly_detectors_memory_bytes: 0,\n data_frame_analytics_memory_bytes: 0,\n pytorch_inference_memory_bytes: 0,\n total_used_memory_bytes: 0\n }\n },\n \"inference\": {\n \"available\" : true,\n \"enabled\" : true,\n \"models\" : [ ]\n },\n \"logstash\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"eql\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"esql\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"features\" : {\n \"eval\" : 0,\n \"stats\" : 0,\n \"dissect\": 0,\n \"grok\" : 0,\n \"limit\" : 0,\n \"where\" : 0,\n \"sort\" : 0,\n \"drop\" : 0,\n \"show\" : 0,\n \"rename\" : 0,\n \"mv_expand\" : 0,\n \"keep\" : 0,\n \"enrich\" : 0,\n \"from\" : 0,\n \"row\" : 0\n },\n \"queries\" : {\n \"rest\" : {\n \"total\" : 0,\n \"failed\" : 0\n },\n \"kibana\" : {\n \"total\" : 0,\n \"failed\" : 0\n },\n \"_all\" : {\n \"total\" : 0,\n \"failed\" : 0\n }\n }\n },\n \"sql\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"features\" : {\n \"having\" : 0,\n \"subselect\" : 0,\n \"limit\" : 0,\n \"orderby\" : 0,\n \"where\" : 0,\n \"join\" : 0,\n \"groupby\" : 0,\n \"command\" : 0,\n \"local\" : 0\n },\n \"queries\" : {\n \"rest\" : {\n \"total\" : 0,\n \"paging\" : 0,\n \"failed\" : 0\n },\n \"cli\" : {\n \"total\" : 0,\n \"paging\" : 0,\n \"failed\" : 0\n },\n \"canvas\" : {\n \"total\" : 0,\n \"paging\" : 0,\n \"failed\" : 0\n },\n \"odbc\" : {\n \"total\" : 0,\n \"paging\" : 0,\n \"failed\" : 0\n },\n \"jdbc\" : {\n \"total\" : 0,\n \"paging\" : 0,\n \"failed\" : 0\n },\n \"odbc32\" : {\n \"total\" : 0,\n \"paging\" : 0,\n \"failed\" : 0\n },\n \"odbc64\" : {\n \"total\" : 0,\n \"paging\" : 0,\n \"failed\" : 0\n },\n \"_all\" : {\n \"total\" : 0,\n \"paging\" : 0,\n \"failed\" : 0\n },\n \"translate\" : {\n \"count\" : 0\n }\n }\n },\n \"rollup\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"ilm\" : {\n \"policy_count\" : 3,\n \"policy_stats\" : [ ]\n },\n \"slm\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"ccr\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"follower_indices_count\" : 0,\n \"auto_follow_patterns_count\" : 0\n },\n \"transform\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"voting_only\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"searchable_snapshots\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"indices_count\" : 0,\n \"full_copy_indices_count\" : 0,\n \"shared_cache_indices_count\" : 0\n },\n \"spatial\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"analytics\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"stats\": {\n \"boxplot_usage\" : 0,\n \"top_metrics_usage\" : 0,\n \"normalize_usage\" : 0,\n \"cumulative_cardinality_usage\" : 0,\n \"t_test_usage\" : 0,\n \"rate_usage\" : 0,\n \"string_stats_usage\" : 0,\n \"moving_percentiles_usage\" : 0,\n \"multi_terms_usage\" : 0\n }\n },\n \"data_streams\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"data_streams\" : 0,\n \"indices_count\" : 0\n },\n \"data_lifecycle\" : {\n \"available\": true,\n \"enabled\": true,\n \"count\": 0,\n \"default_rollover_used\": true,\n \"data_retention\": {\n \"configured_data_streams\": 0\n },\n \"effective_retention\": {\n \"retained_data_streams\": 0\n },\n \"global_retention\": {\n \"default\": {\n \"defined\": false\n },\n \"max\": {\n \"defined\": false\n }\n }\n },\n \"data_tiers\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"data_warm\" : {\n \"node_count\" : 0,\n \"index_count\" : 0,\n \"total_shard_count\" : 0,\n \"primary_shard_count\" : 0,\n \"doc_count\" : 0,\n \"total_size_bytes\" : 0,\n \"primary_size_bytes\" : 0,\n \"primary_shard_size_avg_bytes\" : 0,\n \"primary_shard_size_median_bytes\" : 0,\n \"primary_shard_size_mad_bytes\" : 0\n },\n \"data_frozen\" : {\n \"node_count\" : 1,\n \"index_count\" : 0,\n \"total_shard_count\" : 0,\n \"primary_shard_count\" : 0,\n \"doc_count\" : 0,\n \"total_size_bytes\" : 0,\n \"primary_size_bytes\" : 0,\n \"primary_shard_size_avg_bytes\" : 0,\n \"primary_shard_size_median_bytes\" : 0,\n \"primary_shard_size_mad_bytes\" : 0\n },\n \"data_cold\" : {\n \"node_count\" : 0,\n \"index_count\" : 0,\n \"total_shard_count\" : 0,\n \"primary_shard_count\" : 0,\n \"doc_count\" : 0,\n \"total_size_bytes\" : 0,\n \"primary_size_bytes\" : 0,\n \"primary_shard_size_avg_bytes\" : 0,\n \"primary_shard_size_median_bytes\" : 0,\n \"primary_shard_size_mad_bytes\" : 0\n },\n \"data_content\" : {\n \"node_count\" : 0,\n \"index_count\" : 0,\n \"total_shard_count\" : 0,\n \"primary_shard_count\" : 0,\n \"doc_count\" : 0,\n \"total_size_bytes\" : 0,\n \"primary_size_bytes\" : 0,\n \"primary_shard_size_avg_bytes\" : 0,\n \"primary_shard_size_median_bytes\" : 0,\n \"primary_shard_size_mad_bytes\" : 0\n },\n \"data_hot\" : {\n \"node_count\" : 0,\n \"index_count\" : 0,\n \"total_shard_count\" : 0,\n \"primary_shard_count\" : 0,\n \"doc_count\" : 0,\n \"total_size_bytes\" : 0,\n \"primary_size_bytes\" : 0,\n \"primary_shard_size_avg_bytes\" : 0,\n \"primary_shard_size_median_bytes\" : 0,\n \"primary_shard_size_mad_bytes\" : 0\n }\n },\n \"aggregate_metric\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"archive\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"indices_count\" : 0\n },\n \"health_api\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"invocations\": {\n \"total\": 0\n }\n },\n \"remote_clusters\": {\n \"size\": 0,\n \"mode\": {\n \"proxy\": 0,\n \"sniff\": 0\n },\n \"security\": {\n \"cert\": 0,\n \"api_key\": 0\n }\n },\n \"enterprise_search\" : {\n \"available\": true,\n \"enabled\": true,\n \"search_applications\" : {\n \"count\": 0\n },\n \"analytics_collections\": {\n \"count\": 0\n },\n \"query_rulesets\": {\n \"total_rule_count\": 0,\n \"total_count\": 0,\n \"min_rule_count\": 0,\n \"max_rule_count\": 0\n }\n },\n \"universal_profiling\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"logsdb\": {\n \"available\": true,\n \"enabled\": false,\n \"indices_count\": 0,\n \"indices_with_synthetic_source\": 0,\n \"num_docs\": 0,\n \"size_in_bytes\": 0,\n \"has_custom_cutoff_date\": false\n }\n}" } }, diff --git a/specification/_global/bulk/examples/response/BulkResponseExample2.yaml b/specification/_global/bulk/examples/response/BulkResponseExample2.yaml index b37227b201..08c231547a 100644 --- a/specification/_global/bulk/examples/response/BulkResponseExample2.yaml +++ b/specification/_global/bulk/examples/response/BulkResponseExample2.yaml @@ -1,5 +1,4 @@ summary: Failed actions -method_request: POST /_bulk description: > If you run `POST /_bulk` with operations that update non-existent documents, the operations cannot complete successfully. The API returns a response with an `errors` property value `true`. diff --git a/specification/_global/bulk/examples/response/BulkResponseExample3.yaml b/specification/_global/bulk/examples/response/BulkResponseExample3.yaml index d29fd3db75..34a86b5839 100644 --- a/specification/_global/bulk/examples/response/BulkResponseExample3.yaml +++ b/specification/_global/bulk/examples/response/BulkResponseExample3.yaml @@ -1,5 +1,4 @@ summary: Filter for failed operations -method_request: POST /_bulk?filter_path=items.*.error description: > An example response from `POST /_bulk?filter_path=items.*.error`, which returns only information about failed operations. # type: response diff --git a/specification/_global/close_point_in_time/examples/200_response/ClosePointInTimeResponseExample1.yaml b/specification/_global/close_point_in_time/examples/200_response/ClosePointInTimeResponseExample1.yaml index 05775d7767..934f1fe814 100644 --- a/specification/_global/close_point_in_time/examples/200_response/ClosePointInTimeResponseExample1.yaml +++ b/specification/_global/close_point_in_time/examples/200_response/ClosePointInTimeResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: DELETE /_pit description: A successful response from `DELETE /_pit`. # type: response # response_code: 200 diff --git a/specification/_global/count/examples/200_response/CountResponseExample1.yaml b/specification/_global/count/examples/200_response/CountResponseExample1.yaml index be3306e157..05f9999dbf 100644 --- a/specification/_global/count/examples/200_response/CountResponseExample1.yaml +++ b/specification/_global/count/examples/200_response/CountResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /my-index-000001/_count?q=user:kimchy description: A successful response from `GET /my-index-000001/_count?q=user:kimchy`. # type: response # response_code: 200 diff --git a/specification/_global/delete/examples/request/DeleteRequestExample1.yaml b/specification/_global/delete/examples/request/DeleteRequestExample1.yaml new file mode 100644 index 0000000000..2b4da466ae --- /dev/null +++ b/specification/_global/delete/examples/request/DeleteRequestExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE /my-index-000001/_doc/1 diff --git a/specification/_global/delete/examples/response/DeleteResponseExample1.yaml b/specification/_global/delete/examples/response/DeleteResponseExample1.yaml index e974daed7e..4a258a25c7 100644 --- a/specification/_global/delete/examples/response/DeleteResponseExample1.yaml +++ b/specification/_global/delete/examples/response/DeleteResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: DELETE /my-index-000001/_doc/1 description: A successful response from `DELETE /my-index-000001/_doc/1`, which deletes the JSON document 1 from the `my-index-000001` index. # type: response # response_code: '' diff --git a/specification/_global/delete_by_query/examples/response/DeleteByQueryResponseExample1.yaml b/specification/_global/delete_by_query/examples/response/DeleteByQueryResponseExample1.yaml index 0cb3f0c47d..1418234813 100644 --- a/specification/_global/delete_by_query/examples/response/DeleteByQueryResponseExample1.yaml +++ b/specification/_global/delete_by_query/examples/response/DeleteByQueryResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /my-index-000001/_delete_by_query description: A successful response from `POST /my-index-000001/_delete_by_query`. # type: response # response_code: diff --git a/specification/_global/delete_by_query_rethrottle/examples/request/DeleteByQueryRethrottleRequestExample1.yaml b/specification/_global/delete_by_query_rethrottle/examples/request/DeleteByQueryRethrottleRequestExample1.yaml new file mode 100644 index 0000000000..8de0dd841e --- /dev/null +++ b/specification/_global/delete_by_query_rethrottle/examples/request/DeleteByQueryRethrottleRequestExample1.yaml @@ -0,0 +1 @@ +method_request: POST _delete_by_query/r1A2WoRbTwKZ516z6NEs5A:36619/_rethrottle?requests_per_second=-1 diff --git a/specification/_global/delete_script/examples/request/DeleteScriptRequestExample1.yaml b/specification/_global/delete_script/examples/request/DeleteScriptRequestExample1.yaml new file mode 100644 index 0000000000..ac34bada0e --- /dev/null +++ b/specification/_global/delete_script/examples/request/DeleteScriptRequestExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _scripts/my-search-template diff --git a/specification/_global/exists/examples/request/DocumentExistsRequestExample1.yaml b/specification/_global/exists/examples/request/DocumentExistsRequestExample1.yaml new file mode 100644 index 0000000000..78295be42a --- /dev/null +++ b/specification/_global/exists/examples/request/DocumentExistsRequestExample1.yaml @@ -0,0 +1 @@ +method_request: HEAD my-index-000001/_doc/0 diff --git a/specification/_global/exists/examples/xCodeSamples/DocumentExistsConsoleExample1.yaml b/specification/_global/exists/examples/xCodeSamples/DocumentExistsConsoleExample1.yaml deleted file mode 100644 index 86d515fe09..0000000000 --- a/specification/_global/exists/examples/xCodeSamples/DocumentExistsConsoleExample1.yaml +++ /dev/null @@ -1,4 +0,0 @@ -lang: Console -# label: -source: | - HEAD my-index-000001/_doc/0 diff --git a/specification/_global/exists/examples/xCodeSamples/DocumentExistsCurlExample1.yaml b/specification/_global/exists/examples/xCodeSamples/DocumentExistsCurlExample1.yaml deleted file mode 100644 index 0f711687ce..0000000000 --- a/specification/_global/exists/examples/xCodeSamples/DocumentExistsCurlExample1.yaml +++ /dev/null @@ -1,4 +0,0 @@ -lang: Curl -# label: -source: | - curl -I "localhost:9200/my-index-000001/_doc/0?pretty" diff --git a/specification/_global/exists/examples/xCodeSamples/DocumentExistsJavaScriptExample1.yaml b/specification/_global/exists/examples/xCodeSamples/DocumentExistsJavaScriptExample1.yaml deleted file mode 100644 index c1dd8b311f..0000000000 --- a/specification/_global/exists/examples/xCodeSamples/DocumentExistsJavaScriptExample1.yaml +++ /dev/null @@ -1,8 +0,0 @@ -lang: JavaScript -# label: -source: | - const response = await client.exists({ - index: "my-index-000001", - id: 0, - }); - console.log(response); diff --git a/specification/_global/exists/examples/xCodeSamples/DocumentExistsPythonExample1.yaml b/specification/_global/exists/examples/xCodeSamples/DocumentExistsPythonExample1.yaml deleted file mode 100644 index e8447fe2a3..0000000000 --- a/specification/_global/exists/examples/xCodeSamples/DocumentExistsPythonExample1.yaml +++ /dev/null @@ -1,8 +0,0 @@ -lang: Python -# label: -source: | - resp = client.exists( - index="my-index-000001", - id="0", - ) - print(resp) diff --git a/specification/_global/exists/examples/xCodeSamples/DocumentExistsRubyExample1.yaml b/specification/_global/exists/examples/xCodeSamples/DocumentExistsRubyExample1.yaml deleted file mode 100644 index d6a9adc51e..0000000000 --- a/specification/_global/exists/examples/xCodeSamples/DocumentExistsRubyExample1.yaml +++ /dev/null @@ -1,8 +0,0 @@ -lang: Ruby -# label: -source: | - response = client.exists( - index: 'my-index-000001', - id: 0 - ) - puts response diff --git a/specification/_global/exists_source/examples/request/ExistsSourceRequestExample1.yaml b/specification/_global/exists_source/examples/request/ExistsSourceRequestExample1.yaml new file mode 100644 index 0000000000..3a5a843b8c --- /dev/null +++ b/specification/_global/exists_source/examples/request/ExistsSourceRequestExample1.yaml @@ -0,0 +1 @@ +method_request: HEAD my-index-000001/_source/1 diff --git a/specification/_global/explain/examples/response/ExplainResponseExample1.yaml b/specification/_global/explain/examples/response/ExplainResponseExample1.yaml index 6ce2f8431c..ac5f3ae694 100644 --- a/specification/_global/explain/examples/response/ExplainResponseExample1.yaml +++ b/specification/_global/explain/examples/response/ExplainResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /my-index-000001/_explain/0 description: A successful response from `GET /my-index-000001/_explain/0`. # type: response # response_code: 200 diff --git a/specification/_global/field_caps/examples/response/FieldCapabilitiesResponseExample1.yaml b/specification/_global/field_caps/examples/response/FieldCapabilitiesResponseExample1.yaml index 158a214fac..117cdd09a5 100644 --- a/specification/_global/field_caps/examples/response/FieldCapabilitiesResponseExample1.yaml +++ b/specification/_global/field_caps/examples/response/FieldCapabilitiesResponseExample1.yaml @@ -1,6 +1,5 @@ summary: Get two fields # type: "response" -method_request: GET _field_caps?fields=rating,title description: > A successful response from `GET _field_caps?fields=rating,title`. The field `rating` is defined as a long in `index1` and `index2` and as a `keyword` in `index3` and `index4`. diff --git a/specification/_global/field_caps/examples/response/FieldCapabilitiesResponseExample2.yaml b/specification/_global/field_caps/examples/response/FieldCapabilitiesResponseExample2.yaml index 52d84c21f7..fcbd78aeef 100644 --- a/specification/_global/field_caps/examples/response/FieldCapabilitiesResponseExample2.yaml +++ b/specification/_global/field_caps/examples/response/FieldCapabilitiesResponseExample2.yaml @@ -1,6 +1,5 @@ summary: Get unmapped fields # type: "response" -method_request: GET _field_caps?fields=rating,title&include_unmapped description: > A successful response from `GET _field_caps?fields=rating,title&include_unmapped`. The response contains an entry for each field that is present in some indices but not all. diff --git a/specification/_global/get/examples/request/GetRequestExample2.yaml b/specification/_global/get/examples/request/GetRequestExample2.yaml new file mode 100644 index 0000000000..22ed571367 --- /dev/null +++ b/specification/_global/get/examples/request/GetRequestExample2.yaml @@ -0,0 +1 @@ +method_request: GET my-index-000001/_doc/1?stored_fields=tags,counter diff --git a/specification/_global/get/examples/response/GetResponseExample1.yaml b/specification/_global/get/examples/response/GetResponseExample1.yaml index ed670fde6a..5e848d59ba 100644 --- a/specification/_global/get/examples/response/GetResponseExample1.yaml +++ b/specification/_global/get/examples/response/GetResponseExample1.yaml @@ -1,5 +1,4 @@ summary: Get a document -method_request: GET my-index-000001/_doc/0 description: > A successful response from `GET my-index-000001/_doc/0`. It retrieves the JSON document with the `_id` 0 from the `my-index-000001` index. diff --git a/specification/_global/get/examples/response/GetResponseExample2.yaml b/specification/_global/get/examples/response/GetResponseExample2.yaml index 004ee21ced..89d788a873 100644 --- a/specification/_global/get/examples/response/GetResponseExample2.yaml +++ b/specification/_global/get/examples/response/GetResponseExample2.yaml @@ -1,5 +1,4 @@ summary: Get stored fields -method_request: GET my-index-000001/_doc/1?stored_fields=tags,counter description: > A successful response from `GET my-index-000001/_doc/1?stored_fields=tags,counter`, which retrieves a set of stored fields. Field values fetched from the document itself are always returned as an array. diff --git a/specification/_global/get/examples/response/GetResponseExample3.yaml b/specification/_global/get/examples/response/GetResponseExample3.yaml index c15cd0a001..0736884b2d 100644 --- a/specification/_global/get/examples/response/GetResponseExample3.yaml +++ b/specification/_global/get/examples/response/GetResponseExample3.yaml @@ -1,5 +1,4 @@ summary: Get metadata fields -method_request: GET my-index-000001/_doc/2?routing=user1&stored_fields=tags,counter description: > A successful response from `GET my-index-000001/_doc/2?routing=user1&stored_fields=tags,counter`, which retrieves the `_routing` metadata field. # type: response diff --git a/specification/_global/get_script/examples/request/GetScriptRequestExample1.yaml b/specification/_global/get_script/examples/request/GetScriptRequestExample1.yaml new file mode 100644 index 0000000000..60d3bb295d --- /dev/null +++ b/specification/_global/get_script/examples/request/GetScriptRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _scripts/my-search-template diff --git a/specification/_global/get_script_context/examples/request/GetScriptContextRequestExample1.yaml b/specification/_global/get_script_context/examples/request/GetScriptContextRequestExample1.yaml new file mode 100644 index 0000000000..a0715429dd --- /dev/null +++ b/specification/_global/get_script_context/examples/request/GetScriptContextRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _script_context diff --git a/specification/_global/get_script_languages/examples/request/GetScriptLanguagesRequestExample1.yaml b/specification/_global/get_script_languages/examples/request/GetScriptLanguagesRequestExample1.yaml new file mode 100644 index 0000000000..3db7b33d30 --- /dev/null +++ b/specification/_global/get_script_languages/examples/request/GetScriptLanguagesRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _script_language diff --git a/specification/_global/get_source/examples/request/GetSourceRequestExample1.yaml b/specification/_global/get_source/examples/request/GetSourceRequestExample1.yaml new file mode 100644 index 0000000000..dca7123365 --- /dev/null +++ b/specification/_global/get_source/examples/request/GetSourceRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET my-index-000001/_source/1 diff --git a/specification/_global/health_report/examples/request/HealthReportRequestExample1.yaml b/specification/_global/health_report/examples/request/HealthReportRequestExample1.yaml new file mode 100644 index 0000000000..a64e53a03b --- /dev/null +++ b/specification/_global/health_report/examples/request/HealthReportRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _health_report diff --git a/specification/_global/index/examples/response/IndexResponseExample1.yaml b/specification/_global/index/examples/response/IndexResponseExample1.yaml index ba507949ed..c1e63ecf03 100644 --- a/specification/_global/index/examples/response/IndexResponseExample1.yaml +++ b/specification/_global/index/examples/response/IndexResponseExample1.yaml @@ -1,5 +1,4 @@ summary: Automate document IDs -method_request: POST my-index-000001/_doc/ description: A successful response from `POST my-index-000001/_doc/`, which contains an automated document ID. # type: response # response_code: 200 diff --git a/specification/_global/index/examples/response/IndexResponseExample2.yaml b/specification/_global/index/examples/response/IndexResponseExample2.yaml index 1ab555c4fe..6fc1fc0b16 100644 --- a/specification/_global/index/examples/response/IndexResponseExample2.yaml +++ b/specification/_global/index/examples/response/IndexResponseExample2.yaml @@ -1,5 +1,4 @@ summary: Define document IDs -method_request: PUT my-index-000001/_doc/1 description: A successful response from `PUT my-index-000001/_doc/1`. # type: response # response_code: 200 diff --git a/specification/_global/info/examples/request/RootNodeInfoRequestExample1.yaml b/specification/_global/info/examples/request/RootNodeInfoRequestExample1.yaml new file mode 100644 index 0000000000..54a75d703d --- /dev/null +++ b/specification/_global/info/examples/request/RootNodeInfoRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET / diff --git a/specification/_global/info/examples/response/RootNodeInfoResponseExample1.yaml b/specification/_global/info/examples/response/RootNodeInfoResponseExample1.yaml index bbb4218801..f3fa2ba844 100644 --- a/specification/_global/info/examples/response/RootNodeInfoResponseExample1.yaml +++ b/specification/_global/info/examples/response/RootNodeInfoResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: '' -method_request: GET / description: A successful response from `GET /`s. # type: response # response_code: 200 diff --git a/specification/_global/msearch/examples/request/MsearchRequestExample1.yaml b/specification/_global/msearch/examples/request/MsearchRequestExample1.yaml new file mode 100644 index 0000000000..076400983b --- /dev/null +++ b/specification/_global/msearch/examples/request/MsearchRequestExample1.yaml @@ -0,0 +1,7 @@ +method_request: GET my-index-000001/_msearch +description: An example body for a `GET my-index-000001/_msearch` request. +value: |- + { } + {"query" : {"match" : { "message": "this is a test"}}} + {"index": "my-index-000002"} + {"query" : {"match_all" : {}}} diff --git a/specification/_global/open_point_in_time/examples/request/OpenPointInTimeRequestExample1.yaml b/specification/_global/open_point_in_time/examples/request/OpenPointInTimeRequestExample1.yaml new file mode 100644 index 0000000000..63fef57765 --- /dev/null +++ b/specification/_global/open_point_in_time/examples/request/OpenPointInTimeRequestExample1.yaml @@ -0,0 +1 @@ +method_request: POST /my-index-000001/_pit?keep_alive=1m&allow_partial_search_results=true diff --git a/specification/_global/open_point_in_time/examples/response/OpenPointInTimeResponseExample1.yaml b/specification/_global/open_point_in_time/examples/response/OpenPointInTimeResponseExample1.yaml index 323200ffff..2baad1e813 100644 --- a/specification/_global/open_point_in_time/examples/response/OpenPointInTimeResponseExample1.yaml +++ b/specification/_global/open_point_in_time/examples/response/OpenPointInTimeResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /my-index-000001/_pit?keep_alive=1m&allow_partial_search_results=true description: > A successful response from `POST /my-index-000001/_pit?keep_alive=1m&allow_partial_search_results=true`. It includes a summary of the total number of shards, as well as the number of successful shards when creating the PIT. diff --git a/specification/_global/rank_eval/examples/request/RankEvalRequestExample1.yaml b/specification/_global/rank_eval/examples/request/RankEvalRequestExample1.yaml new file mode 100644 index 0000000000..cf30d4a6fa --- /dev/null +++ b/specification/_global/rank_eval/examples/request/RankEvalRequestExample1.yaml @@ -0,0 +1,18 @@ +method_request: GET /my-index-000001/_rank_eval +description: An example body for a `GET /my-index-000001/_rank_eval` request. +value: |- + { + "requests": [ + { + "id": "JFK query", + "request": { "query": { "match_all": {} } }, + "ratings": [] + } ], + "metric": { + "precision": { + "k": 20, + "relevant_rating_threshold": 1, + "ignore_unlabeled": false + } + } + } diff --git a/specification/_global/reindex_rethrottle/examples/request/ReindexRethrottleRequestExample1.yaml b/specification/_global/reindex_rethrottle/examples/request/ReindexRethrottleRequestExample1.yaml new file mode 100644 index 0000000000..c4361e9be7 --- /dev/null +++ b/specification/_global/reindex_rethrottle/examples/request/ReindexRethrottleRequestExample1.yaml @@ -0,0 +1 @@ +method_request: POST _reindex/r1A2WoRbTwKZ516z6NEs5A:36619/_rethrottle?requests_per_second=-1 diff --git a/specification/_global/scripts_painless_execute/examples/response/ExecutePainlessScriptResponseExample1.yaml b/specification/_global/scripts_painless_execute/examples/response/ExecutePainlessScriptResponseExample1.yaml index 2b77cea22e..a6f56a374b 100644 --- a/specification/_global/scripts_painless_execute/examples/response/ExecutePainlessScriptResponseExample1.yaml +++ b/specification/_global/scripts_painless_execute/examples/response/ExecutePainlessScriptResponseExample1.yaml @@ -1,5 +1,4 @@ summary: Test context -method_request: POST /_scripts/painless/_execute description: A successful response from `POST /_scripts/painless/_execute` with a `painless_test` context. # type: response # response_code: '' diff --git a/specification/_global/scripts_painless_execute/examples/response/ExecutePainlessScriptResponseExample2.yaml b/specification/_global/scripts_painless_execute/examples/response/ExecutePainlessScriptResponseExample2.yaml index 618a7d2102..963705b06f 100644 --- a/specification/_global/scripts_painless_execute/examples/response/ExecutePainlessScriptResponseExample2.yaml +++ b/specification/_global/scripts_painless_execute/examples/response/ExecutePainlessScriptResponseExample2.yaml @@ -1,5 +1,4 @@ summary: Filter context -method_request: POST /_scripts/painless/_execute description: A successful response from `POST /_scripts/painless/_execute` with a `filter` context. # type: response # response_code: '' diff --git a/specification/_global/scripts_painless_execute/examples/response/ExecutePainlessScriptResponseExample3.yaml b/specification/_global/scripts_painless_execute/examples/response/ExecutePainlessScriptResponseExample3.yaml index f486fef9d1..3dacb2d6cc 100644 --- a/specification/_global/scripts_painless_execute/examples/response/ExecutePainlessScriptResponseExample3.yaml +++ b/specification/_global/scripts_painless_execute/examples/response/ExecutePainlessScriptResponseExample3.yaml @@ -1,5 +1,4 @@ summary: Score context -method_request: POST /_scripts/painless/_execute description: A successful response from `POST /_scripts/painless/_execute` with a `score` context. # type: response # response_code: '' diff --git a/specification/_global/search/examples/200_response/SearchResponseExample1.yaml b/specification/_global/search/examples/200_response/SearchResponseExample1.yaml index 4f0ca0f4bc..f4d14616ce 100644 --- a/specification/_global/search/examples/200_response/SearchResponseExample1.yaml +++ b/specification/_global/search/examples/200_response/SearchResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /my-index-000001/_search?from=40&size=20 description: > An abbreviated response from `GET /my-index-000001/_search?from=40&size=20` with a simple term query. # type: response diff --git a/specification/_global/search_mvt/examples/response/SearchMvtResponseExample1.yaml b/specification/_global/search_mvt/examples/response/SearchMvtResponseExample1.yaml index d04302d03b..8fbf08ded2 100644 --- a/specification/_global/search_mvt/examples/response/SearchMvtResponseExample1.yaml +++ b/specification/_global/search_mvt/examples/response/SearchMvtResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET museums/_mvt/location/13/4207/2692 description: > A successful response from `GET museums/_mvt/location/13/4207/2692`. It returns results as a binary vector tile. diff --git a/specification/_global/search_shards/examples/request/SearchShardsRequestExample1.yaml b/specification/_global/search_shards/examples/request/SearchShardsRequestExample1.yaml new file mode 100644 index 0000000000..efa6600543 --- /dev/null +++ b/specification/_global/search_shards/examples/request/SearchShardsRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /my-index-000001/_search_shards diff --git a/specification/_global/search_shards/examples/response/SearchShardsResponseExample1.yaml b/specification/_global/search_shards/examples/response/SearchShardsResponseExample1.yaml index 74d4b3e6a7..8092e515ec 100644 --- a/specification/_global/search_shards/examples/response/SearchShardsResponseExample1.yaml +++ b/specification/_global/search_shards/examples/response/SearchShardsResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /my-index-000001/_search_shards description: An abbreviated response from `GET /my-index-000001/_search_shards`. # type: response # response_code: 200 diff --git a/specification/_global/terms_enum/examples/response/TermsEnumResponseExample1.yaml b/specification/_global/terms_enum/examples/response/TermsEnumResponseExample1.yaml index 2a52c3ec90..7f12af5e41 100644 --- a/specification/_global/terms_enum/examples/response/TermsEnumResponseExample1.yaml +++ b/specification/_global/terms_enum/examples/response/TermsEnumResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST stackoverflow/_terms_enum description: A successful response from `POST stackoverflow/_terms_enum`. # type: "response", # response_code: 200, diff --git a/specification/_global/termvectors/examples/response/TermVectorsResponseExample1.yaml b/specification/_global/termvectors/examples/response/TermVectorsResponseExample1.yaml index b6cb33b853..fd31109ca8 100644 --- a/specification/_global/termvectors/examples/response/TermVectorsResponseExample1.yaml +++ b/specification/_global/termvectors/examples/response/TermVectorsResponseExample1.yaml @@ -1,5 +1,4 @@ summary: Return stored term vectors -method_request: GET /my-index-000001/_termvectors/1 description: A successful response from `GET /my-index-000001/_termvectors/1`. # type: response # response_code: '' diff --git a/specification/_global/termvectors/examples/response/TermVectorsResponseExample2.yaml b/specification/_global/termvectors/examples/response/TermVectorsResponseExample2.yaml index a0041c45b3..d635a40266 100644 --- a/specification/_global/termvectors/examples/response/TermVectorsResponseExample2.yaml +++ b/specification/_global/termvectors/examples/response/TermVectorsResponseExample2.yaml @@ -1,5 +1,4 @@ summary: Per-field analyzer -method_request: GET /my-index-000001/_termvectors description: A successful response from `GET /my-index-000001/_termvectors` with `per_field_analyzer` in the request body. # type: response # response_code: '' diff --git a/specification/_global/termvectors/examples/response/TermVectorsResponseExample3.yaml b/specification/_global/termvectors/examples/response/TermVectorsResponseExample3.yaml index 29e6d3ba95..3d319fcbad 100644 --- a/specification/_global/termvectors/examples/response/TermVectorsResponseExample3.yaml +++ b/specification/_global/termvectors/examples/response/TermVectorsResponseExample3.yaml @@ -1,5 +1,4 @@ summary: Terms filtering -method_request: GET /my-index-000001/_termvectors description: A successful response from `GET /my-index-000001/_termvectors` with a `filter` in the request body. # type: response # response_code: '' diff --git a/specification/_global/update_by_query_rethrottle/examples/request/UpdateByQueryRethrottleRequestExample1.yaml b/specification/_global/update_by_query_rethrottle/examples/request/UpdateByQueryRethrottleRequestExample1.yaml new file mode 100644 index 0000000000..aaddc459f9 --- /dev/null +++ b/specification/_global/update_by_query_rethrottle/examples/request/UpdateByQueryRethrottleRequestExample1.yaml @@ -0,0 +1 @@ +method_request: POST _update_by_query/r1A2WoRbTwKZ516z6NEs5A:36619/_rethrottle?requests_per_second=-1 diff --git a/specification/async_search/delete/examples/request/AsyncSearchDeleteExample1.yaml b/specification/async_search/delete/examples/request/AsyncSearchDeleteExample1.yaml new file mode 100644 index 0000000000..3ff283d560 --- /dev/null +++ b/specification/async_search/delete/examples/request/AsyncSearchDeleteExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE /_async_search/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc= diff --git a/specification/async_search/get/examples/request/AsyncSearchGetRequestExample1.yaml b/specification/async_search/get/examples/request/AsyncSearchGetRequestExample1.yaml new file mode 100644 index 0000000000..89b9287b68 --- /dev/null +++ b/specification/async_search/get/examples/request/AsyncSearchGetRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_async_search/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc= diff --git a/specification/async_search/get/examples/response/AsyncSearchGetResponseExample1.yaml b/specification/async_search/get/examples/response/AsyncSearchGetResponseExample1.yaml index 1df543187f..32e9074e2e 100644 --- a/specification/async_search/get/examples/response/AsyncSearchGetResponseExample1.yaml +++ b/specification/async_search/get/examples/response/AsyncSearchGetResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_async_search/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc= description: A succesful response from `GET /_async_search/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=`. # type: response # response_code: 200 diff --git a/specification/async_search/status/examples/request/AsyncSearchStatusRequestExample1.yaml b/specification/async_search/status/examples/request/AsyncSearchStatusRequestExample1.yaml new file mode 100644 index 0000000000..d62c737ab6 --- /dev/null +++ b/specification/async_search/status/examples/request/AsyncSearchStatusRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_async_search/status/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc= diff --git a/specification/async_search/status/examples/response/AsyncSearchStatusResponseExample1.yaml b/specification/async_search/status/examples/response/AsyncSearchStatusResponseExample1.yaml index 6a58fdcf19..1e7d61e2ad 100644 --- a/specification/async_search/status/examples/response/AsyncSearchStatusResponseExample1.yaml +++ b/specification/async_search/status/examples/response/AsyncSearchStatusResponseExample1.yaml @@ -1,5 +1,4 @@ summary: An active async search -method_request: GET /_async_search/status/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc= description: A succesful response from `GET /_async_search/status/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=`, which retrieves the status of a previously submitted async search without the results. # type: response # response_code: 200 diff --git a/specification/async_search/status/examples/response/AsyncSearchStatusResponseExample2.yaml b/specification/async_search/status/examples/response/AsyncSearchStatusResponseExample2.yaml index 6163248931..bbb0a4ac50 100644 --- a/specification/async_search/status/examples/response/AsyncSearchStatusResponseExample2.yaml +++ b/specification/async_search/status/examples/response/AsyncSearchStatusResponseExample2.yaml @@ -1,5 +1,4 @@ summary: A completed async search -method_request: GET /_async_search/status/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc= description: > A succesful response from `GET /_async_search/status/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=` for an async search that has completed. The status response has an additional `completion_status` field that shows the status code of the completed async search. diff --git a/specification/async_search/status/examples/response/AsyncSearchStatusResponseExample3.yaml b/specification/async_search/status/examples/response/AsyncSearchStatusResponseExample3.yaml index 5d0d1eeb91..dc36319158 100644 --- a/specification/async_search/status/examples/response/AsyncSearchStatusResponseExample3.yaml +++ b/specification/async_search/status/examples/response/AsyncSearchStatusResponseExample3.yaml @@ -1,5 +1,4 @@ summary: A failed async search -method_request: GET /_async_search/status/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc= description: > A response from `GET /_async_search/status/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=` for an async search that has completed with an error. The status response has an additional `completion_status` field that shows the status code of the completed async search. diff --git a/specification/autoscaling/delete_autoscaling_policy/examples/request/DeleteAutoscalingPolicyRequestExample1.yaml b/specification/autoscaling/delete_autoscaling_policy/examples/request/DeleteAutoscalingPolicyRequestExample1.yaml new file mode 100644 index 0000000000..ad73243750 --- /dev/null +++ b/specification/autoscaling/delete_autoscaling_policy/examples/request/DeleteAutoscalingPolicyRequestExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE /_autoscaling/policy/* diff --git a/specification/autoscaling/delete_autoscaling_policy/examples/response/DeleteAutoscalingPolicyResponseExample1.yaml b/specification/autoscaling/delete_autoscaling_policy/examples/response/DeleteAutoscalingPolicyResponseExample1.yaml index 5c881f22b1..7ee291eec5 100644 --- a/specification/autoscaling/delete_autoscaling_policy/examples/response/DeleteAutoscalingPolicyResponseExample1.yaml +++ b/specification/autoscaling/delete_autoscaling_policy/examples/response/DeleteAutoscalingPolicyResponseExample1.yaml @@ -1,5 +1,4 @@ summary: A successful response of deleting one or more autoscaling policy. -method_request: DELETE /_autoscaling/policy/* description: > This may be a response to either `DELETE /_autoscaling/policy/my_autoscaling_policy` or `DELETE /_autoscaling/policy/*`. # type: "response" diff --git a/specification/autoscaling/get_autoscaling_capacity/examples/200_response/GetAutoscalingCapacityResponseExample1.yaml b/specification/autoscaling/get_autoscaling_capacity/examples/200_response/GetAutoscalingCapacityResponseExample1.yaml index 627948a760..62cfb5d82c 100644 --- a/specification/autoscaling/get_autoscaling_capacity/examples/200_response/GetAutoscalingCapacityResponseExample1.yaml +++ b/specification/autoscaling/get_autoscaling_capacity/examples/200_response/GetAutoscalingCapacityResponseExample1.yaml @@ -1,5 +1,4 @@ summary: 'A successful response for retrieving the current autoscaling capacity.' -method_request: GET /_autoscaling/capacity description: 'This may be a response to `GET /_autoscaling/capacity`.' # type: "response" # response_code: 200 diff --git a/specification/autoscaling/get_autoscaling_capacity/examples/request/GetAutoscalingCapacityRequestExample1.yaml b/specification/autoscaling/get_autoscaling_capacity/examples/request/GetAutoscalingCapacityRequestExample1.yaml new file mode 100644 index 0000000000..3abcc14ffe --- /dev/null +++ b/specification/autoscaling/get_autoscaling_capacity/examples/request/GetAutoscalingCapacityRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_autoscaling/capacity diff --git a/specification/autoscaling/get_autoscaling_policy/examples/200_response/GetAutoscalingPolicyResponseExample1.yaml b/specification/autoscaling/get_autoscaling_policy/examples/200_response/GetAutoscalingPolicyResponseExample1.yaml index e30c38b525..4e435653c2 100644 --- a/specification/autoscaling/get_autoscaling_policy/examples/200_response/GetAutoscalingPolicyResponseExample1.yaml +++ b/specification/autoscaling/get_autoscaling_policy/examples/200_response/GetAutoscalingPolicyResponseExample1.yaml @@ -1,5 +1,4 @@ summary: 'A successful response for retrieving an autoscaling policy.' -method_request: GET /_autoscaling/policy/my_autoscaling_policy description: 'This may be a response to `GET /_autoscaling/policy/my_autoscaling_policy`.' # type: "response" # response_code: 200 diff --git a/specification/autoscaling/get_autoscaling_policy/examples/request/GetAutoscalingPolicyRequestExample1.yaml b/specification/autoscaling/get_autoscaling_policy/examples/request/GetAutoscalingPolicyRequestExample1.yaml new file mode 100644 index 0000000000..83b137b46d --- /dev/null +++ b/specification/autoscaling/get_autoscaling_policy/examples/request/GetAutoscalingPolicyRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_autoscaling/policy/my_autoscaling_policy diff --git a/specification/cat/aliases/examples/200_response/CatAliasesResponseExample1.yaml b/specification/cat/aliases/examples/200_response/CatAliasesResponseExample1.yaml index bd42a8f2a1..d142b5c588 100644 --- a/specification/cat/aliases/examples/200_response/CatAliasesResponseExample1.yaml +++ b/specification/cat/aliases/examples/200_response/CatAliasesResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET _cat/aliases?format=json&v=true 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. diff --git a/specification/cat/aliases/examples/request/CatAliasesRequestExample1.yaml b/specification/cat/aliases/examples/request/CatAliasesRequestExample1.yaml new file mode 100644 index 0000000000..e74bd1e9f8 --- /dev/null +++ b/specification/cat/aliases/examples/request/CatAliasesRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _cat/aliases?format=json&v=true diff --git a/specification/cat/allocation/examples/200_response/CatAllocationResponseExample1.yaml b/specification/cat/allocation/examples/200_response/CatAllocationResponseExample1.yaml index 1c04ab63ad..4eebf24649 100644 --- a/specification/cat/allocation/examples/200_response/CatAllocationResponseExample1.yaml +++ b/specification/cat/allocation/examples/200_response/CatAllocationResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_cat/allocation?v=true&format=json description: > A successful response from `GET /_cat/allocation?v=true&format=json`. It shows a single shard is allocated to the one node available. diff --git a/specification/cat/allocation/examples/request/CatAllocationRequestExample1.yaml b/specification/cat/allocation/examples/request/CatAllocationRequestExample1.yaml new file mode 100644 index 0000000000..aaa367a7da --- /dev/null +++ b/specification/cat/allocation/examples/request/CatAllocationRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_cat/allocation?v=true&format=json diff --git a/specification/cat/component_templates/examples/200_response/CatComponentTemplatesResponseExample1.yaml b/specification/cat/component_templates/examples/200_response/CatComponentTemplatesResponseExample1.yaml index d47cf32cc9..8a98ba2332 100644 --- a/specification/cat/component_templates/examples/200_response/CatComponentTemplatesResponseExample1.yaml +++ b/specification/cat/component_templates/examples/200_response/CatComponentTemplatesResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET _cat/component_templates/my-template-*?v=true&s=name&format=json description: > A successful response from `GET _cat/component_templates/my-template-*?v=true&s=name&format=json`. # type: response diff --git a/specification/cat/component_templates/examples/request/CatComponentTemplatesRequestExample1.yaml b/specification/cat/component_templates/examples/request/CatComponentTemplatesRequestExample1.yaml new file mode 100644 index 0000000000..495d410df0 --- /dev/null +++ b/specification/cat/component_templates/examples/request/CatComponentTemplatesRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _cat/component_templates/my-template-*?v=true&s=name&format=json diff --git a/specification/cat/count/examples/200_response/CatCountResponseExample1.yaml b/specification/cat/count/examples/200_response/CatCountResponseExample1.yaml index d21e8cb15d..2dfb440e12 100644 --- a/specification/cat/count/examples/200_response/CatCountResponseExample1.yaml +++ b/specification/cat/count/examples/200_response/CatCountResponseExample1.yaml @@ -1,5 +1,4 @@ summary: Single data stream or index count -method_request: GET /_cat/count/my-index-000001?v=true&format=json 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. diff --git a/specification/cat/count/examples/200_response/CatCountResponseExample2.yaml b/specification/cat/count/examples/200_response/CatCountResponseExample2.yaml index 67015dd452..d59ccfda12 100644 --- a/specification/cat/count/examples/200_response/CatCountResponseExample2.yaml +++ b/specification/cat/count/examples/200_response/CatCountResponseExample2.yaml @@ -1,5 +1,4 @@ summary: All data streams and indices count -method_request: GET /_cat/count?v=true&format=json 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. diff --git a/specification/cat/count/examples/request/CatCountRequestExample1.yaml b/specification/cat/count/examples/request/CatCountRequestExample1.yaml new file mode 100644 index 0000000000..60f5075a99 --- /dev/null +++ b/specification/cat/count/examples/request/CatCountRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_cat/count/my-index-000001?v=true&format=json diff --git a/specification/cat/fielddata/examples/200_response/CatFielddataResponseExample1.yaml b/specification/cat/fielddata/examples/200_response/CatFielddataResponseExample1.yaml index 6a4a6a4243..96f7655540 100644 --- a/specification/cat/fielddata/examples/200_response/CatFielddataResponseExample1.yaml +++ b/specification/cat/fielddata/examples/200_response/CatFielddataResponseExample1.yaml @@ -1,5 +1,4 @@ summary: Single field data -method_request: GET /_cat/fielddata?v=true&fields=body&format=json 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. diff --git a/specification/cat/fielddata/examples/200_response/CatFielddataResponseExample2.yaml b/specification/cat/fielddata/examples/200_response/CatFielddataResponseExample2.yaml index 9fe9d919bd..51053614cb 100644 --- a/specification/cat/fielddata/examples/200_response/CatFielddataResponseExample2.yaml +++ b/specification/cat/fielddata/examples/200_response/CatFielddataResponseExample2.yaml @@ -1,5 +1,4 @@ summary: Multiple fields data -method_request: GET /_cat/fielddata?v=true 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. diff --git a/specification/cat/fielddata/examples/request/CatFielddataRequestExample1.yaml b/specification/cat/fielddata/examples/request/CatFielddataRequestExample1.yaml new file mode 100644 index 0000000000..5394203473 --- /dev/null +++ b/specification/cat/fielddata/examples/request/CatFielddataRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_cat/fielddata?v=true&fields=body&format=json diff --git a/specification/cat/health/examples/200_response/CatHealthResponseExample1.yaml b/specification/cat/health/examples/200_response/CatHealthResponseExample1.yaml index bb58af2306..e9b3690f66 100644 --- a/specification/cat/health/examples/200_response/CatHealthResponseExample1.yaml +++ b/specification/cat/health/examples/200_response/CatHealthResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_cat/health?v=true&format=json description: > A successful response from `GET /_cat/health?v=true&format=json`. By default, it returns `HH:MM:SS` and Unix epoch timestamps. diff --git a/specification/cat/health/examples/request/CatHealthRequestExample1.yaml b/specification/cat/health/examples/request/CatHealthRequestExample1.yaml new file mode 100644 index 0000000000..2c6c0610a6 --- /dev/null +++ b/specification/cat/health/examples/request/CatHealthRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_cat/health?v=true&format=json diff --git a/specification/cat/indices/examples/200_response/CatIndicesResponseExample1.yaml b/specification/cat/indices/examples/200_response/CatIndicesResponseExample1.yaml index 69c5d15f1f..26f1f85633 100644 --- a/specification/cat/indices/examples/200_response/CatIndicesResponseExample1.yaml +++ b/specification/cat/indices/examples/200_response/CatIndicesResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_cat/indices/my-index-*?v=true&s=index&format=json description: > A successful response from `GET /_cat/indices/my-index-*?v=true&s=index&format=json`. # type: response diff --git a/specification/cat/indices/examples/request/CatIndicesRequestExample1.yaml b/specification/cat/indices/examples/request/CatIndicesRequestExample1.yaml new file mode 100644 index 0000000000..523656aac9 --- /dev/null +++ b/specification/cat/indices/examples/request/CatIndicesRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_cat/indices/my-index-*?v=true&s=index&format=json diff --git a/specification/cat/master/examples/200_response/CatMasterResponseExample1.yaml b/specification/cat/master/examples/200_response/CatMasterResponseExample1.yaml index 5732b1696e..ac516509ca 100644 --- a/specification/cat/master/examples/200_response/CatMasterResponseExample1.yaml +++ b/specification/cat/master/examples/200_response/CatMasterResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_cat/master?v=true&format=json description: > A successful response from `GET /_cat/master?v=true&format=json`. # type: response diff --git a/specification/cat/master/examples/request/CatMasterRequestExample1.yaml b/specification/cat/master/examples/request/CatMasterRequestExample1.yaml new file mode 100644 index 0000000000..acbdcbf9b2 --- /dev/null +++ b/specification/cat/master/examples/request/CatMasterRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_cat/master?v=true&format=json 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 fdb4fb74b9..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,5 +1,4 @@ # summary: -method_request: GET _cat/ml/data_frame/analytics?v=true&format=json description: A successful response from `GET _cat/ml/data_frame/analytics?v=true&format=json`. # type: response # response_code: 200 diff --git a/specification/cat/ml_data_frame_analytics/examples/request/CatDataframeanalyticsRequestExample1.yaml b/specification/cat/ml_data_frame_analytics/examples/request/CatDataframeanalyticsRequestExample1.yaml new file mode 100644 index 0000000000..9ea5e61f8b --- /dev/null +++ b/specification/cat/ml_data_frame_analytics/examples/request/CatDataframeanalyticsRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _cat/ml/data_frame/analytics?v=true&format=json diff --git a/specification/cat/ml_datafeeds/examples/200_response/CatDatafeedsResponseExample1.yaml b/specification/cat/ml_datafeeds/examples/200_response/CatDatafeedsResponseExample1.yaml index a5043ce56e..8d0aa11e5e 100644 --- a/specification/cat/ml_datafeeds/examples/200_response/CatDatafeedsResponseExample1.yaml +++ b/specification/cat/ml_datafeeds/examples/200_response/CatDatafeedsResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET _cat/ml/datafeeds?v=true&format=json description: A successful response from `GET _cat/ml/datafeeds?v=true&format=json`. # type: response # response_code: diff --git a/specification/cat/ml_datafeeds/examples/request/CatDatafeedsRequestExample1.yaml b/specification/cat/ml_datafeeds/examples/request/CatDatafeedsRequestExample1.yaml new file mode 100644 index 0000000000..33cc34fb9f --- /dev/null +++ b/specification/cat/ml_datafeeds/examples/request/CatDatafeedsRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _cat/ml/datafeeds?v=true&format=json diff --git a/specification/cat/ml_jobs/examples/200_response/CatJobsResponseExample1.yaml b/specification/cat/ml_jobs/examples/200_response/CatJobsResponseExample1.yaml index c36742e669..28010cc26f 100644 --- a/specification/cat/ml_jobs/examples/200_response/CatJobsResponseExample1.yaml +++ b/specification/cat/ml_jobs/examples/200_response/CatJobsResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET _cat/ml/anomaly_detectors?h=id,s,dpr,mb&v=true&format=json description: A successful response from `GET _cat/ml/anomaly_detectors?h=id,s,dpr,mb&v=true&format=json`. # type: response # response_code: '' diff --git a/specification/cat/ml_jobs/examples/request/CatJobsRequestExample1.yaml b/specification/cat/ml_jobs/examples/request/CatJobsRequestExample1.yaml new file mode 100644 index 0000000000..3b72c00db8 --- /dev/null +++ b/specification/cat/ml_jobs/examples/request/CatJobsRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _cat/ml/anomaly_detectors?h=id,s,dpr,mb&v=true&format=json 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 544eb3356b..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,5 +1,4 @@ # summary: -method_request: GET _cat/ml/trained_models?v=true&format=json description: A successful response from `GET _cat/ml/trained_models?v=true&format=json`. # type: response # response_code: '' diff --git a/specification/cat/ml_trained_models/examples/request/CatTrainedModelsRequestExample1.yaml b/specification/cat/ml_trained_models/examples/request/CatTrainedModelsRequestExample1.yaml new file mode 100644 index 0000000000..8c8e3cd670 --- /dev/null +++ b/specification/cat/ml_trained_models/examples/request/CatTrainedModelsRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _cat/ml/trained_models?v=true&format=json diff --git a/specification/cat/nodeattrs/examples/200_response/CatNodeAttributesResponseExample1.yaml b/specification/cat/nodeattrs/examples/200_response/CatNodeAttributesResponseExample1.yaml index 57495ecdf0..dc5eafd1b3 100644 --- a/specification/cat/nodeattrs/examples/200_response/CatNodeAttributesResponseExample1.yaml +++ b/specification/cat/nodeattrs/examples/200_response/CatNodeAttributesResponseExample1.yaml @@ -1,5 +1,4 @@ summary: Default columns -method_request: GET /_cat/nodeattrs?v=true&format=json description: > A successful response from `GET /_cat/nodeattrs?v=true&format=json`. The `node`, `host`, and `ip` columns provide basic information about each node. diff --git a/specification/cat/nodeattrs/examples/200_response/CatNodeAttributesResponseExample2.yaml b/specification/cat/nodeattrs/examples/200_response/CatNodeAttributesResponseExample2.yaml index 8cb41b46e9..1a77198435 100644 --- a/specification/cat/nodeattrs/examples/200_response/CatNodeAttributesResponseExample2.yaml +++ b/specification/cat/nodeattrs/examples/200_response/CatNodeAttributesResponseExample2.yaml @@ -1,5 +1,4 @@ summary: Explicit columns -method_request: GET /_cat/nodeattrs?v=true&h=name,pid,attr,value description: > A successful response from `GET /_cat/nodeattrs?v=true&h=name,pid,attr,value`. It returns the `name`, `pid`, `attr`, and `value` columns. diff --git a/specification/cat/nodeattrs/examples/request/CatNodeAttributesRequestExample1.yaml b/specification/cat/nodeattrs/examples/request/CatNodeAttributesRequestExample1.yaml new file mode 100644 index 0000000000..2b5cf70c7a --- /dev/null +++ b/specification/cat/nodeattrs/examples/request/CatNodeAttributesRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_cat/nodeattrs?v=true&format=json diff --git a/specification/cat/nodes/examples/200_response/CatNodesResponseExample1.yaml b/specification/cat/nodes/examples/200_response/CatNodesResponseExample1.yaml index 42d0d16b03..904b13bb31 100644 --- a/specification/cat/nodes/examples/200_response/CatNodesResponseExample1.yaml +++ b/specification/cat/nodes/examples/200_response/CatNodesResponseExample1.yaml @@ -1,5 +1,4 @@ summary: Default columns -method_request: GET /_cat/nodes?v=true&format=json 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. diff --git a/specification/cat/nodes/examples/200_response/CatNodesResponseExample2.yaml b/specification/cat/nodes/examples/200_response/CatNodesResponseExample2.yaml index 48c46c9762..71bc08096d 100644 --- a/specification/cat/nodes/examples/200_response/CatNodesResponseExample2.yaml +++ b/specification/cat/nodes/examples/200_response/CatNodesResponseExample2.yaml @@ -1,5 +1,4 @@ summary: Explicit columns -method_request: GET /_cat/nodes?v=true&h=id,ip,port,v,m&format=json 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. diff --git a/specification/cat/nodes/examples/request/CatNodesRequestExample2.yaml b/specification/cat/nodes/examples/request/CatNodesRequestExample2.yaml new file mode 100644 index 0000000000..d3f9a54521 --- /dev/null +++ b/specification/cat/nodes/examples/request/CatNodesRequestExample2.yaml @@ -0,0 +1 @@ +method_request: GET /_cat/nodes?v=true&h=id,ip,port,v,m&format=json diff --git a/specification/cat/pending_tasks/examples/200_response/CatPendingTasksResponseExample1.yaml b/specification/cat/pending_tasks/examples/200_response/CatPendingTasksResponseExample1.yaml index ebd853a96b..e45a92b23f 100644 --- a/specification/cat/pending_tasks/examples/200_response/CatPendingTasksResponseExample1.yaml +++ b/specification/cat/pending_tasks/examples/200_response/CatPendingTasksResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_cat/pending_tasks?v=trueh=insertOrder,timeInQueue,priority,source&format=json description: > A successful response from `GET /_cat/pending_tasks?v=trueh=insertOrder,timeInQueue,priority,source&format=json`. # type: response diff --git a/specification/cat/pending_tasks/examples/request/CatPendingTasksRequestExample1.yaml b/specification/cat/pending_tasks/examples/request/CatPendingTasksRequestExample1.yaml new file mode 100644 index 0000000000..74c11769eb --- /dev/null +++ b/specification/cat/pending_tasks/examples/request/CatPendingTasksRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_cat/pending_tasks?v=trueh=insertOrder,timeInQueue,priority,source&format=json diff --git a/specification/cat/plugins/examples/200_response/CatPluginsResponseExample1.yaml b/specification/cat/plugins/examples/200_response/CatPluginsResponseExample1.yaml index 0b29745b4e..1183e39563 100644 --- a/specification/cat/plugins/examples/200_response/CatPluginsResponseExample1.yaml +++ b/specification/cat/plugins/examples/200_response/CatPluginsResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_cat/plugins?v=true&s=component&h=name,component,version,description&format=json description: > A successful response from `GET /_cat/plugins?v=true&s=component&h=name,component,version,description&format=json`. # type: response diff --git a/specification/cat/plugins/examples/request/CatPluginsRequestExample1.yaml b/specification/cat/plugins/examples/request/CatPluginsRequestExample1.yaml new file mode 100644 index 0000000000..92f220096b --- /dev/null +++ b/specification/cat/plugins/examples/request/CatPluginsRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_cat/plugins?v=true&s=component&h=name,component,version,description&format=json diff --git a/specification/cat/recovery/examples/200_response/CatRecoveryResponseExample1.yaml b/specification/cat/recovery/examples/200_response/CatRecoveryResponseExample1.yaml index 4c4b990de7..9af7adbebb 100644 --- a/specification/cat/recovery/examples/200_response/CatRecoveryResponseExample1.yaml +++ b/specification/cat/recovery/examples/200_response/CatRecoveryResponseExample1.yaml @@ -1,5 +1,4 @@ summary: No ongoing recoveries -method_request: GET _cat/recovery?v=true&format=json 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. diff --git a/specification/cat/recovery/examples/200_response/CatRecoveryResponseExample2.yaml b/specification/cat/recovery/examples/200_response/CatRecoveryResponseExample2.yaml index bf1157af3c..814047a0d2 100644 --- a/specification/cat/recovery/examples/200_response/CatRecoveryResponseExample2.yaml +++ b/specification/cat/recovery/examples/200_response/CatRecoveryResponseExample2.yaml @@ -1,5 +1,4 @@ summary: A live shard recovery -method_request: GET _cat/recovery?v=true&h=i,s,t,ty,st,shost,thost,f,fp,b,bp&format=json 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. diff --git a/specification/cat/recovery/examples/200_response/CatRecoveryResponseExample3.yaml b/specification/cat/recovery/examples/200_response/CatRecoveryResponseExample3.yaml index 74161b8bf4..5e5b7a04f7 100644 --- a/specification/cat/recovery/examples/200_response/CatRecoveryResponseExample3.yaml +++ b/specification/cat/recovery/examples/200_response/CatRecoveryResponseExample3.yaml @@ -1,5 +1,4 @@ summary: A snapshot recovery -method_request: GET _cat/recovery?v=true&h=i,s,t,ty,st,rep,snap,f,fp,b,bp&format=json 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. diff --git a/specification/cat/recovery/examples/request/CatRecoveryRequestExample1.yaml b/specification/cat/recovery/examples/request/CatRecoveryRequestExample1.yaml new file mode 100644 index 0000000000..f2294cb1bd --- /dev/null +++ b/specification/cat/recovery/examples/request/CatRecoveryRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _cat/recovery?v=true&format=json diff --git a/specification/cat/repositories/examples/200_response/CatRepositoriesResponseExample1.yaml b/specification/cat/repositories/examples/200_response/CatRepositoriesResponseExample1.yaml index b4926e3765..e2d6e3c23f 100644 --- a/specification/cat/repositories/examples/200_response/CatRepositoriesResponseExample1.yaml +++ b/specification/cat/repositories/examples/200_response/CatRepositoriesResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_cat/repositories?v=true&format=json description: > A successful response from `GET /_cat/repositories?v=true&format=json`. # type: response diff --git a/specification/cat/repositories/examples/request/CatRepositoriesRequestExample1.yaml b/specification/cat/repositories/examples/request/CatRepositoriesRequestExample1.yaml new file mode 100644 index 0000000000..7ed353b671 --- /dev/null +++ b/specification/cat/repositories/examples/request/CatRepositoriesRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_cat/repositories?v=true&format=json diff --git a/specification/cat/segments/examples/200_response/CatSegmentsResponseExample1.yaml b/specification/cat/segments/examples/200_response/CatSegmentsResponseExample1.yaml index defacfae94..842cc08021 100644 --- a/specification/cat/segments/examples/200_response/CatSegmentsResponseExample1.yaml +++ b/specification/cat/segments/examples/200_response/CatSegmentsResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_cat/segments?v=true&format=json description: > A successful response from `GET /_cat/segments?v=true&format=json`. # type: response diff --git a/specification/cat/segments/examples/request/CatSegmentsRequestExample1.yaml b/specification/cat/segments/examples/request/CatSegmentsRequestExample1.yaml new file mode 100644 index 0000000000..36610bf7fe --- /dev/null +++ b/specification/cat/segments/examples/request/CatSegmentsRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_cat/segments?v=true&format=json diff --git a/specification/cat/shards/examples/200_response/CatShardsResponseExample1.yaml b/specification/cat/shards/examples/200_response/CatShardsResponseExample1.yaml index f25eb82025..5382e345a1 100644 --- a/specification/cat/shards/examples/200_response/CatShardsResponseExample1.yaml +++ b/specification/cat/shards/examples/200_response/CatShardsResponseExample1.yaml @@ -1,5 +1,4 @@ summary: A single data stream or index -method_request: GET _cat/shards?format=json description: > A successful response from `GET _cat/shards?format=json`. # type: response diff --git a/specification/cat/shards/examples/200_response/CatShardsResponseExample2.yaml b/specification/cat/shards/examples/200_response/CatShardsResponseExample2.yaml index 9e81ab7ffe..623ab69962 100644 --- a/specification/cat/shards/examples/200_response/CatShardsResponseExample2.yaml +++ b/specification/cat/shards/examples/200_response/CatShardsResponseExample2.yaml @@ -1,5 +1,4 @@ summary: A wildcard pattern -method_request: GET _cat/shards/my-index-*?format=json 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-`. diff --git a/specification/cat/shards/examples/200_response/CatShardsResponseExample3.yaml b/specification/cat/shards/examples/200_response/CatShardsResponseExample3.yaml index 9c80033749..3e57c66b71 100644 --- a/specification/cat/shards/examples/200_response/CatShardsResponseExample3.yaml +++ b/specification/cat/shards/examples/200_response/CatShardsResponseExample3.yaml @@ -1,5 +1,4 @@ summary: A relocating shard -method_request: GET _cat/shards?format=json description: > A successful response from `GET _cat/shards?format=json`. The `RELOCATING` value in the `state` column indicates the index shard is relocating. diff --git a/specification/cat/shards/examples/200_response/CatShardsResponseExample4.yaml b/specification/cat/shards/examples/200_response/CatShardsResponseExample4.yaml index 451c6ef7c2..193ff6bd3b 100644 --- a/specification/cat/shards/examples/200_response/CatShardsResponseExample4.yaml +++ b/specification/cat/shards/examples/200_response/CatShardsResponseExample4.yaml @@ -1,5 +1,4 @@ summary: Shard states -method_request: GET _cat/shards?format=json description: > A successful response from `GET _cat/shards?format=json`. Before a shard is available for use, it goes through an `INITIALIZING` state. diff --git a/specification/cat/shards/examples/200_response/CatShardsResponseExample5.yaml b/specification/cat/shards/examples/200_response/CatShardsResponseExample5.yaml index 86e5c51f4e..b7b09dbb49 100644 --- a/specification/cat/shards/examples/200_response/CatShardsResponseExample5.yaml +++ b/specification/cat/shards/examples/200_response/CatShardsResponseExample5.yaml @@ -1,5 +1,4 @@ summary: Reasons for unassigned shards -method_request: GET _cat/shards?h=index,shard,prirep,state,unassigned.reason&format=json 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. diff --git a/specification/cat/shards/examples/request/CatShardsRequestExample1.yaml b/specification/cat/shards/examples/request/CatShardsRequestExample1.yaml new file mode 100644 index 0000000000..a4c20ed991 --- /dev/null +++ b/specification/cat/shards/examples/request/CatShardsRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _cat/shards?format=json diff --git a/specification/cat/snapshots/examples/200_response/CatSnapshotsResponseExample1.yaml b/specification/cat/snapshots/examples/200_response/CatSnapshotsResponseExample1.yaml index b26edc6043..87e6bc4ed6 100644 --- a/specification/cat/snapshots/examples/200_response/CatSnapshotsResponseExample1.yaml +++ b/specification/cat/snapshots/examples/200_response/CatSnapshotsResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_cat/snapshots/repo1?v=true&s=id&format=json description: > A successful response from `GET /_cat/snapshots/repo1?v=true&s=id&format=json`. # type: response diff --git a/specification/cat/snapshots/examples/request/CatSnapshotsRequestExample1.yaml b/specification/cat/snapshots/examples/request/CatSnapshotsRequestExample1.yaml new file mode 100644 index 0000000000..94228f6cc8 --- /dev/null +++ b/specification/cat/snapshots/examples/request/CatSnapshotsRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_cat/snapshots/repo1?v=true&s=id&format=json diff --git a/specification/cat/tasks/examples/200_response/CatTasksResponseExample1.yaml b/specification/cat/tasks/examples/200_response/CatTasksResponseExample1.yaml index e845f2359c..acfea87edd 100644 --- a/specification/cat/tasks/examples/200_response/CatTasksResponseExample1.yaml +++ b/specification/cat/tasks/examples/200_response/CatTasksResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET _cat/tasks?v=true&format=json description: A successful response from `GET _cat/tasks?v=true&format=json`. # type: response # response_code: 200 diff --git a/specification/cat/tasks/examples/request/CatTasksRequestExample1.yaml b/specification/cat/tasks/examples/request/CatTasksRequestExample1.yaml new file mode 100644 index 0000000000..83f20212f5 --- /dev/null +++ b/specification/cat/tasks/examples/request/CatTasksRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _cat/tasks?v=true&format=json diff --git a/specification/cat/templates/examples/200_response/CatTemplatesResponseExample1.yaml b/specification/cat/templates/examples/200_response/CatTemplatesResponseExample1.yaml index d096fabb70..3d08e3bd60 100644 --- a/specification/cat/templates/examples/200_response/CatTemplatesResponseExample1.yaml +++ b/specification/cat/templates/examples/200_response/CatTemplatesResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET _cat/templates/my-template-*?v=true&s=name&format=json description: > A successful response from `GET _cat/templates/my-template-*?v=true&s=name&format=json`. # type: response diff --git a/specification/cat/templates/examples/request/CatTemplatesRequestExample1.yaml b/specification/cat/templates/examples/request/CatTemplatesRequestExample1.yaml new file mode 100644 index 0000000000..3a7fdc9a20 --- /dev/null +++ b/specification/cat/templates/examples/request/CatTemplatesRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _cat/templates/my-template-*?v=true&s=name&format=json diff --git a/specification/cat/thread_pool/examples/200_response/CatThreadPoolResponseExample1.yaml b/specification/cat/thread_pool/examples/200_response/CatThreadPoolResponseExample1.yaml index e3544f6a9b..b3e025acd7 100644 --- a/specification/cat/thread_pool/examples/200_response/CatThreadPoolResponseExample1.yaml +++ b/specification/cat/thread_pool/examples/200_response/CatThreadPoolResponseExample1.yaml @@ -1,5 +1,4 @@ summary: Default columns -method_request: GET /_cat/thread_pool?format=json description: > A successful response from `GET /_cat/thread_pool?format=json`. # type: response diff --git a/specification/cat/thread_pool/examples/200_response/CatThreadPoolResponseExample2.yaml b/specification/cat/thread_pool/examples/200_response/CatThreadPoolResponseExample2.yaml index 77c95412fc..8c7b2cfa36 100644 --- a/specification/cat/thread_pool/examples/200_response/CatThreadPoolResponseExample2.yaml +++ b/specification/cat/thread_pool/examples/200_response/CatThreadPoolResponseExample2.yaml @@ -1,5 +1,4 @@ summary: Explicit columns -method_request: GET /_cat/thread_pool/generic?v=true&h=id,name,active,rejected,completed&format=json 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. diff --git a/specification/cat/thread_pool/examples/request/CatThreadPoolRequestExample1.yaml b/specification/cat/thread_pool/examples/request/CatThreadPoolRequestExample1.yaml new file mode 100644 index 0000000000..385f4f68ac --- /dev/null +++ b/specification/cat/thread_pool/examples/request/CatThreadPoolRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_cat/thread_pool?format=json diff --git a/specification/cat/transforms/examples/200_response/CatTransformsResponseExample1.yaml b/specification/cat/transforms/examples/200_response/CatTransformsResponseExample1.yaml index 6ef91cc245..d5ad7f2c82 100644 --- a/specification/cat/transforms/examples/200_response/CatTransformsResponseExample1.yaml +++ b/specification/cat/transforms/examples/200_response/CatTransformsResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_cat/transforms?v=true&format=json description: A successful response from `GET /_cat/transforms?v=true&format=json`. # type: response # response_code: 200 diff --git a/specification/cat/transforms/examples/request/CatTransformsRequestExample1.yaml b/specification/cat/transforms/examples/request/CatTransformsRequestExample1.yaml new file mode 100644 index 0000000000..f71dc917dd --- /dev/null +++ b/specification/cat/transforms/examples/request/CatTransformsRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_cat/transforms?v=true&format=json diff --git a/specification/ccr/delete_auto_follow_pattern/examples/request/DeleteAutoFollowPatternRequestExample1.yaml b/specification/ccr/delete_auto_follow_pattern/examples/request/DeleteAutoFollowPatternRequestExample1.yaml new file mode 100644 index 0000000000..186e1b5ebb --- /dev/null +++ b/specification/ccr/delete_auto_follow_pattern/examples/request/DeleteAutoFollowPatternRequestExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE /_ccr/auto_follow/my_auto_follow_pattern diff --git a/specification/ccr/delete_auto_follow_pattern/examples/response/DeleteAutoFollowPatternResponseExample1.yaml b/specification/ccr/delete_auto_follow_pattern/examples/response/DeleteAutoFollowPatternResponseExample1.yaml index 45e4b92848..f31e399d46 100644 --- a/specification/ccr/delete_auto_follow_pattern/examples/response/DeleteAutoFollowPatternResponseExample1.yaml +++ b/specification/ccr/delete_auto_follow_pattern/examples/response/DeleteAutoFollowPatternResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: DELETE /_ccr/auto_follow/my_auto_follow_pattern description: A successful response from `DELETE /_ccr/auto_follow/my_auto_follow_pattern`, which deletes an auto-follow pattern. # type: response # response_code: 200 diff --git a/specification/ccr/follow/examples/response/CreateFollowIndexResponseExample1.yaml b/specification/ccr/follow/examples/response/CreateFollowIndexResponseExample1.yaml index 9fcc82c809..757d424edd 100644 --- a/specification/ccr/follow/examples/response/CreateFollowIndexResponseExample1.yaml +++ b/specification/ccr/follow/examples/response/CreateFollowIndexResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: PUT /follower_index/_ccr/follow?wait_for_active_shards=1 description: A successful response from `PUT /follower_index/_ccr/follow?wait_for_active_shards=1`. # type: 'response', # response_code: 200, diff --git a/specification/ccr/follow_info/examples/request/FollowInfoRequestExample1.yaml b/specification/ccr/follow_info/examples/request/FollowInfoRequestExample1.yaml new file mode 100644 index 0000000000..6df3adb0f3 --- /dev/null +++ b/specification/ccr/follow_info/examples/request/FollowInfoRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /follower_index/_ccr/info diff --git a/specification/ccr/follow_info/examples/response/FollowInfoResponseExample1.yaml b/specification/ccr/follow_info/examples/response/FollowInfoResponseExample1.yaml index 0b698f4317..8527f61c52 100644 --- a/specification/ccr/follow_info/examples/response/FollowInfoResponseExample1.yaml +++ b/specification/ccr/follow_info/examples/response/FollowInfoResponseExample1.yaml @@ -1,5 +1,4 @@ summary: An active follower index -method_request: GET /follower_index/_ccr/info description: A successful response from `GET /follower_index/_ccr/info` when the follower index is active. # type: response # response_code: 200 diff --git a/specification/ccr/follow_info/examples/response/FollowInfoResponseExample2.yaml b/specification/ccr/follow_info/examples/response/FollowInfoResponseExample2.yaml index 300f2ea5f7..62345e2039 100644 --- a/specification/ccr/follow_info/examples/response/FollowInfoResponseExample2.yaml +++ b/specification/ccr/follow_info/examples/response/FollowInfoResponseExample2.yaml @@ -1,5 +1,4 @@ summary: A paused follower index -method_request: GET /follower_index/_ccr/info description: A successful response from `GET /follower_index/_ccr/info` when the follower index is paused. # type: response # response_code: '200' diff --git a/specification/ccr/follow_stats/examples/request/FollowIndexStatsRequestExample1.yaml b/specification/ccr/follow_stats/examples/request/FollowIndexStatsRequestExample1.yaml new file mode 100644 index 0000000000..adb3832fb4 --- /dev/null +++ b/specification/ccr/follow_stats/examples/request/FollowIndexStatsRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /follower_index/_ccr/stats diff --git a/specification/ccr/follow_stats/examples/response/FollowIndexStatsResponseExample1.yaml b/specification/ccr/follow_stats/examples/response/FollowIndexStatsResponseExample1.yaml index 92aaa1eecc..4079daa8a7 100644 --- a/specification/ccr/follow_stats/examples/response/FollowIndexStatsResponseExample1.yaml +++ b/specification/ccr/follow_stats/examples/response/FollowIndexStatsResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /follower_index/_ccr/stats description: A successful response from `GET /follower_index/_ccr/stats`, which retrieves follower stats. # type: response # response_code: 200 diff --git a/specification/ccr/get_auto_follow_pattern/examples/request/GetAutoFollowPatternRequestExample1.yaml b/specification/ccr/get_auto_follow_pattern/examples/request/GetAutoFollowPatternRequestExample1.yaml new file mode 100644 index 0000000000..caaaa7c13d --- /dev/null +++ b/specification/ccr/get_auto_follow_pattern/examples/request/GetAutoFollowPatternRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_ccr/auto_follow/my_auto_follow_pattern diff --git a/specification/ccr/get_auto_follow_pattern/examples/response/GetAutoFollowPatternResponseExample1.yaml b/specification/ccr/get_auto_follow_pattern/examples/response/GetAutoFollowPatternResponseExample1.yaml index c3d1eb73d9..63b4b66f95 100644 --- a/specification/ccr/get_auto_follow_pattern/examples/response/GetAutoFollowPatternResponseExample1.yaml +++ b/specification/ccr/get_auto_follow_pattern/examples/response/GetAutoFollowPatternResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_ccr/auto_follow/my_auto_follow_pattern description: A successful response from `GET /_ccr/auto_follow/my_auto_follow_pattern`, which gets auto-follow patterns. # type: response # response_code: 200 diff --git a/specification/ccr/pause_auto_follow_pattern/examples/request/PauseAutoFollowPatternRequestExample1.yaml b/specification/ccr/pause_auto_follow_pattern/examples/request/PauseAutoFollowPatternRequestExample1.yaml new file mode 100644 index 0000000000..b820410932 --- /dev/null +++ b/specification/ccr/pause_auto_follow_pattern/examples/request/PauseAutoFollowPatternRequestExample1.yaml @@ -0,0 +1 @@ +method_request: POST /_ccr/auto_follow/my_auto_follow_pattern/pause diff --git a/specification/ccr/pause_auto_follow_pattern/examples/response/PauseAutoFollowPatternResponseExample1.yaml b/specification/ccr/pause_auto_follow_pattern/examples/response/PauseAutoFollowPatternResponseExample1.yaml index 0efc6497fb..b0bb0f358d 100644 --- a/specification/ccr/pause_auto_follow_pattern/examples/response/PauseAutoFollowPatternResponseExample1.yaml +++ b/specification/ccr/pause_auto_follow_pattern/examples/response/PauseAutoFollowPatternResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /_ccr/auto_follow/my_auto_follow_pattern/pause description: A successful response from `POST /_ccr/auto_follow/my_auto_follow_pattern/pause`, which pauses an auto-follow pattern. # type: response # response_code: 200 diff --git a/specification/ccr/pause_follow/examples/request/PauseFollowIndexRequestExample1.yaml b/specification/ccr/pause_follow/examples/request/PauseFollowIndexRequestExample1.yaml new file mode 100644 index 0000000000..b072e5ee6a --- /dev/null +++ b/specification/ccr/pause_follow/examples/request/PauseFollowIndexRequestExample1.yaml @@ -0,0 +1 @@ +method_request: POST /follower_index/_ccr/pause_follow diff --git a/specification/ccr/pause_follow/examples/response/PauseFollowIndexResponseExample1.yaml b/specification/ccr/pause_follow/examples/response/PauseFollowIndexResponseExample1.yaml index 098e90875b..df592307a8 100644 --- a/specification/ccr/pause_follow/examples/response/PauseFollowIndexResponseExample1.yaml +++ b/specification/ccr/pause_follow/examples/response/PauseFollowIndexResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /follower_index/_ccr/pause_follow description: A successful response from `POST /follower_index/_ccr/pause_follow`, which pauses a follower index. # type: response # response_code: 200 diff --git a/specification/ccr/resume_auto_follow_pattern/examples/request/ResumeAutoFollowPatternRequestExample1.yaml b/specification/ccr/resume_auto_follow_pattern/examples/request/ResumeAutoFollowPatternRequestExample1.yaml new file mode 100644 index 0000000000..9a06b480ab --- /dev/null +++ b/specification/ccr/resume_auto_follow_pattern/examples/request/ResumeAutoFollowPatternRequestExample1.yaml @@ -0,0 +1 @@ +method_request: POST /_ccr/auto_follow/my_auto_follow_pattern/resume diff --git a/specification/ccr/resume_auto_follow_pattern/examples/response/ResumeAutoFollowPatternResponseExample1.yaml b/specification/ccr/resume_auto_follow_pattern/examples/response/ResumeAutoFollowPatternResponseExample1.yaml index 65e0f8e294..e2ab7bb500 100644 --- a/specification/ccr/resume_auto_follow_pattern/examples/response/ResumeAutoFollowPatternResponseExample1.yaml +++ b/specification/ccr/resume_auto_follow_pattern/examples/response/ResumeAutoFollowPatternResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /_ccr/auto_follow/my_auto_follow_pattern/resume description: > A successful response `POST /_ccr/auto_follow/my_auto_follow_pattern/resume`, which resumes an auto-follow pattern. # type: response diff --git a/specification/ccr/stats/examples/request/CcrStatsRequestExample1.yaml b/specification/ccr/stats/examples/request/CcrStatsRequestExample1.yaml new file mode 100644 index 0000000000..b046eaf51b --- /dev/null +++ b/specification/ccr/stats/examples/request/CcrStatsRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_ccr/stats diff --git a/specification/ccr/stats/examples/response/CcrStatsResponseExample1.yaml b/specification/ccr/stats/examples/response/CcrStatsResponseExample1.yaml index 515239543e..1f0ab038c5 100644 --- a/specification/ccr/stats/examples/response/CcrStatsResponseExample1.yaml +++ b/specification/ccr/stats/examples/response/CcrStatsResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_ccr/stats description: A successful response from `GET /_ccr/stats` that returns cross-cluster replication stats. # type: response # response_code: 200 diff --git a/specification/ccr/unfollow/examples/request/UnfollowIndexRequestExample1.yaml b/specification/ccr/unfollow/examples/request/UnfollowIndexRequestExample1.yaml new file mode 100644 index 0000000000..6258df4485 --- /dev/null +++ b/specification/ccr/unfollow/examples/request/UnfollowIndexRequestExample1.yaml @@ -0,0 +1 @@ +method_request: POST /follower_index/_ccr/unfollow diff --git a/specification/ccr/unfollow/examples/response/UnfollowIndexResponseExample1.yaml b/specification/ccr/unfollow/examples/response/UnfollowIndexResponseExample1.yaml index 4bd686b3f7..81e3b6a1fd 100644 --- a/specification/ccr/unfollow/examples/response/UnfollowIndexResponseExample1.yaml +++ b/specification/ccr/unfollow/examples/response/UnfollowIndexResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /follower_index/_ccr/unfollow description: A successful response from `POST /follower_index/_ccr/unfollow`. # type: response # response_code: 200 diff --git a/specification/cluster/delete_component_template/examples/request/ClusterDeleteComponentTemplateExample1.yaml b/specification/cluster/delete_component_template/examples/request/ClusterDeleteComponentTemplateExample1.yaml new file mode 100644 index 0000000000..c8910cf9f2 --- /dev/null +++ b/specification/cluster/delete_component_template/examples/request/ClusterDeleteComponentTemplateExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _component_template/template_1 diff --git a/specification/cluster/get_component_template/examples/request/ClusterGetComponentTemplateExample1.yaml b/specification/cluster/get_component_template/examples/request/ClusterGetComponentTemplateExample1.yaml new file mode 100644 index 0000000000..e02a3625a8 --- /dev/null +++ b/specification/cluster/get_component_template/examples/request/ClusterGetComponentTemplateExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_component_template/template_1 diff --git a/specification/cluster/get_settings/examples/request/ClusterGetSettingsExample1.yaml b/specification/cluster/get_settings/examples/request/ClusterGetSettingsExample1.yaml new file mode 100644 index 0000000000..8b8cd59ecc --- /dev/null +++ b/specification/cluster/get_settings/examples/request/ClusterGetSettingsExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_cluster/settings?filter_path=persistent.cluster.remote diff --git a/specification/cluster/health/examples/request/ClusterHealthRequestExample1.yaml b/specification/cluster/health/examples/request/ClusterHealthRequestExample1.yaml new file mode 100644 index 0000000000..4852a044ab --- /dev/null +++ b/specification/cluster/health/examples/request/ClusterHealthRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _cluster/health diff --git a/specification/cluster/health/examples/response/ClusterHealthResponseExample1.yaml b/specification/cluster/health/examples/response/ClusterHealthResponseExample1.yaml index 00eae3741d..7f7e8bb02c 100644 --- a/specification/cluster/health/examples/response/ClusterHealthResponseExample1.yaml +++ b/specification/cluster/health/examples/response/ClusterHealthResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET _cluster/health description: > A successful response from `GET _cluster/health`. It is the health status of a quiet single node cluster with a single index with one shard and one replica. diff --git a/specification/cluster/info/examples/request/ClusterInfoExample1.yaml b/specification/cluster/info/examples/request/ClusterInfoExample1.yaml new file mode 100644 index 0000000000..c2742b05e4 --- /dev/null +++ b/specification/cluster/info/examples/request/ClusterInfoExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_info/_all diff --git a/specification/cluster/pending_tasks/examples/request/ClusterPendingTasksExample1.yaml b/specification/cluster/pending_tasks/examples/request/ClusterPendingTasksExample1.yaml new file mode 100644 index 0000000000..1217dc2640 --- /dev/null +++ b/specification/cluster/pending_tasks/examples/request/ClusterPendingTasksExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_cluster/pending_tasks diff --git a/specification/cluster/remote_info/examples/request/ClusterRemoteInfoExample1.yaml b/specification/cluster/remote_info/examples/request/ClusterRemoteInfoExample1.yaml new file mode 100644 index 0000000000..989596ba8f --- /dev/null +++ b/specification/cluster/remote_info/examples/request/ClusterRemoteInfoExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_remote/info diff --git a/specification/cluster/state/examples/request/ClusterStateExample1.yaml b/specification/cluster/state/examples/request/ClusterStateExample1.yaml new file mode 100644 index 0000000000..51c4ecac5f --- /dev/null +++ b/specification/cluster/state/examples/request/ClusterStateExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_cluster/state?filter_path=metadata.cluster_coordination.last_committed_config diff --git a/specification/cluster/stats/examples/request/ClusterStatsExample1.yaml b/specification/cluster/stats/examples/request/ClusterStatsExample1.yaml new file mode 100644 index 0000000000..94af04f32c --- /dev/null +++ b/specification/cluster/stats/examples/request/ClusterStatsExample1.yaml @@ -0,0 +1 @@ +method_request: GET _cluster/stats?human&filter_path=indices.mappings.total_deduplicated_mapping_size* diff --git a/specification/connector/check_in/examples/request/ConnectorCheckInExample1.yaml b/specification/connector/check_in/examples/request/ConnectorCheckInExample1.yaml new file mode 100644 index 0000000000..2f97b859fb --- /dev/null +++ b/specification/connector/check_in/examples/request/ConnectorCheckInExample1.yaml @@ -0,0 +1 @@ +method_request: PUT _connector/my-connector/_check_in diff --git a/specification/connector/delete/examples/request/ConnectorDeleteExample1.yaml b/specification/connector/delete/examples/request/ConnectorDeleteExample1.yaml new file mode 100644 index 0000000000..bc8099b358 --- /dev/null +++ b/specification/connector/delete/examples/request/ConnectorDeleteExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _connector/my-connector-id&delete_sync_jobs=true diff --git a/specification/connector/get/examples/request/ConnectorGetExample1.yaml b/specification/connector/get/examples/request/ConnectorGetExample1.yaml new file mode 100644 index 0000000000..74c3c41c26 --- /dev/null +++ b/specification/connector/get/examples/request/ConnectorGetExample1.yaml @@ -0,0 +1 @@ +method_request: GET _connector/my-connector-id diff --git a/specification/connector/list/examples/request/ConnectorListExample1.yaml b/specification/connector/list/examples/request/ConnectorListExample1.yaml new file mode 100644 index 0000000000..322ca96846 --- /dev/null +++ b/specification/connector/list/examples/request/ConnectorListExample1.yaml @@ -0,0 +1 @@ +method_request: GET _connector diff --git a/specification/connector/sync_job_cancel/examples/request/ConnectorSyncJobCancelExample1.yaml b/specification/connector/sync_job_cancel/examples/request/ConnectorSyncJobCancelExample1.yaml new file mode 100644 index 0000000000..37099d856b --- /dev/null +++ b/specification/connector/sync_job_cancel/examples/request/ConnectorSyncJobCancelExample1.yaml @@ -0,0 +1 @@ +method_request: PUT _connector/_sync_job/my-connector-sync-job-id/_cancel diff --git a/specification/connector/sync_job_check_in/examples/request/ConnectorSyncJobCheckInExample1.yaml b/specification/connector/sync_job_check_in/examples/request/ConnectorSyncJobCheckInExample1.yaml new file mode 100644 index 0000000000..7400453c39 --- /dev/null +++ b/specification/connector/sync_job_check_in/examples/request/ConnectorSyncJobCheckInExample1.yaml @@ -0,0 +1 @@ +method_request: PUT _connector/_sync_job/my-connector-sync-job/_check_in diff --git a/specification/connector/sync_job_claim/examples/request/ConnectorSyncJobClaimExample1.yaml b/specification/connector/sync_job_claim/examples/request/ConnectorSyncJobClaimExample1.yaml new file mode 100644 index 0000000000..f5d51efb6d --- /dev/null +++ b/specification/connector/sync_job_claim/examples/request/ConnectorSyncJobClaimExample1.yaml @@ -0,0 +1,6 @@ +method_request: PUT _connector/_sync_job/my-connector-sync-job-id/_claim +description: An example body for a `PUT _connector/_sync_job/my-connector-sync-job-id/_claim` request. +value: |- + { + "worker_hostname": "some-machine" + } diff --git a/specification/connector/sync_job_delete/examples/request/ConnectorSyncJobDeleteExample1.yaml b/specification/connector/sync_job_delete/examples/request/ConnectorSyncJobDeleteExample1.yaml new file mode 100644 index 0000000000..f4e670b918 --- /dev/null +++ b/specification/connector/sync_job_delete/examples/request/ConnectorSyncJobDeleteExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _connector/_sync_job/my-connector-sync-job-id diff --git a/specification/connector/sync_job_get/examples/request/ConnectorSyncJobGetExample1.yaml b/specification/connector/sync_job_get/examples/request/ConnectorSyncJobGetExample1.yaml new file mode 100644 index 0000000000..f6a2b86568 --- /dev/null +++ b/specification/connector/sync_job_get/examples/request/ConnectorSyncJobGetExample1.yaml @@ -0,0 +1 @@ +method_request: GET _connector/_sync_job/my-connector-sync-job diff --git a/specification/connector/sync_job_list/examples/request/ConnectorSyncJobListExample1.yaml b/specification/connector/sync_job_list/examples/request/ConnectorSyncJobListExample1.yaml new file mode 100644 index 0000000000..6be6de9fff --- /dev/null +++ b/specification/connector/sync_job_list/examples/request/ConnectorSyncJobListExample1.yaml @@ -0,0 +1 @@ +method_request: GET _connector/_sync_job?connector_id=my-connector-id&size=1 diff --git a/specification/connector/sync_job_update_stats/examples/request/ConnectorSyncJobUpdateStatsExample1.yaml b/specification/connector/sync_job_update_stats/examples/request/ConnectorSyncJobUpdateStatsExample1.yaml new file mode 100644 index 0000000000..f7b467b6fc --- /dev/null +++ b/specification/connector/sync_job_update_stats/examples/request/ConnectorSyncJobUpdateStatsExample1.yaml @@ -0,0 +1,10 @@ +method_request: PUT _connector/_sync_job/my-connector-sync-job/_stats +description: An example body for a `PUT _connector/_sync_job/my-connector-sync-job/_stats` request. +value: |- + { + "deleted_document_count": 10, + "indexed_document_count": 20, + "indexed_document_volume": 1000, + "total_document_count": 2000, + "last_seen": "2023-01-02T10:00:00Z" + } diff --git a/specification/dangling_indices/delete_dangling_index/examples/request/DanglingIndicesDeleteDanglingIndexExample1.yaml b/specification/dangling_indices/delete_dangling_index/examples/request/DanglingIndicesDeleteDanglingIndexExample1.yaml new file mode 100644 index 0000000000..5458a595a5 --- /dev/null +++ b/specification/dangling_indices/delete_dangling_index/examples/request/DanglingIndicesDeleteDanglingIndexExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE /_dangling/?accept_data_loss=true diff --git a/specification/dangling_indices/import_dangling_index/examples/request/ImportDanglingIndexRequestExample1.yaml b/specification/dangling_indices/import_dangling_index/examples/request/ImportDanglingIndexRequestExample1.yaml new file mode 100644 index 0000000000..51333864c2 --- /dev/null +++ b/specification/dangling_indices/import_dangling_index/examples/request/ImportDanglingIndexRequestExample1.yaml @@ -0,0 +1 @@ +method_request: POST /_dangling/zmM4e0JtBkeUjiHD-MihPQ?accept_data_loss=true diff --git a/specification/dangling_indices/import_dangling_index/examples/response/ImportDanglingIndexResponseExample1.yaml b/specification/dangling_indices/import_dangling_index/examples/response/ImportDanglingIndexResponseExample1.yaml index fced954ee6..0ccafb09f0 100644 --- a/specification/dangling_indices/import_dangling_index/examples/response/ImportDanglingIndexResponseExample1.yaml +++ b/specification/dangling_indices/import_dangling_index/examples/response/ImportDanglingIndexResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: '' -method_request: POST /_dangling/zmM4e0JtBkeUjiHD-MihPQ?accept_data_loss=true description: > A successful response from `POST /_dangling/zmM4e0JtBkeUjiHD-MihPQ?accept_data_loss=true`. # type: response diff --git a/specification/dangling_indices/list_dangling_indices/examples/request/DanglingIndicesListDanglingIndicesExample1.yaml b/specification/dangling_indices/list_dangling_indices/examples/request/DanglingIndicesListDanglingIndicesExample1.yaml new file mode 100644 index 0000000000..ec6b553ed9 --- /dev/null +++ b/specification/dangling_indices/list_dangling_indices/examples/request/DanglingIndicesListDanglingIndicesExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_dangling diff --git a/specification/enrich/delete_policy/examples/request/EnrichDeletePolicyExample1.yaml b/specification/enrich/delete_policy/examples/request/EnrichDeletePolicyExample1.yaml new file mode 100644 index 0000000000..f34d633b31 --- /dev/null +++ b/specification/enrich/delete_policy/examples/request/EnrichDeletePolicyExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE /_enrich/policy/my-policy diff --git a/specification/enrich/execute_policy/examples/request/EnrichExecutePolicyExample1.yaml b/specification/enrich/execute_policy/examples/request/EnrichExecutePolicyExample1.yaml new file mode 100644 index 0000000000..f811b235f4 --- /dev/null +++ b/specification/enrich/execute_policy/examples/request/EnrichExecutePolicyExample1.yaml @@ -0,0 +1 @@ +method_request: PUT /_enrich/policy/my-policy/_execute?wait_for_completion=false diff --git a/specification/enrich/get_policy/examples/request/EnrichGetPolicyExample1.yaml b/specification/enrich/get_policy/examples/request/EnrichGetPolicyExample1.yaml new file mode 100644 index 0000000000..7ecb3d3281 --- /dev/null +++ b/specification/enrich/get_policy/examples/request/EnrichGetPolicyExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_enrich/policy/my-policy diff --git a/specification/enrich/put_policy/examples/request/EnrichPutPolicyExample1.yaml b/specification/enrich/put_policy/examples/request/EnrichPutPolicyExample1.yaml new file mode 100644 index 0000000000..fc117616b3 --- /dev/null +++ b/specification/enrich/put_policy/examples/request/EnrichPutPolicyExample1.yaml @@ -0,0 +1,10 @@ +method_request: PUT /_enrich/policy/postal_policy +description: An example body for a `PUT /_enrich/policy/postal_policy` request. +value: |- + { + "geo_match": { + "indices": "postal_codes", + "match_field": "location", + "enrich_fields": [ "location", "postal_code" ] + } + } diff --git a/specification/enrich/stats/examples/request/EnrichStatsExample1.yaml b/specification/enrich/stats/examples/request/EnrichStatsExample1.yaml new file mode 100644 index 0000000000..a6b11becca --- /dev/null +++ b/specification/enrich/stats/examples/request/EnrichStatsExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_enrich/_stats diff --git a/specification/eql/delete/examples/request/EqlDeleteExample1.yaml b/specification/eql/delete/examples/request/EqlDeleteExample1.yaml new file mode 100644 index 0000000000..6e3e4941c1 --- /dev/null +++ b/specification/eql/delete/examples/request/EqlDeleteExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE /_eql/search/FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE= diff --git a/specification/eql/get/examples/request/EqlGetExample1.yaml b/specification/eql/get/examples/request/EqlGetExample1.yaml new file mode 100644 index 0000000000..64c2684d90 --- /dev/null +++ b/specification/eql/get/examples/request/EqlGetExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_eql/search/FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=?wait_for_completion_timeout=2s diff --git a/specification/eql/get_status/examples/request/EqlGetStatusExample1.yaml b/specification/eql/get_status/examples/request/EqlGetStatusExample1.yaml new file mode 100644 index 0000000000..05d571aa8c --- /dev/null +++ b/specification/eql/get_status/examples/request/EqlGetStatusExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_eql/search/status/FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE= diff --git a/specification/esql/async_query_delete/examples/request/EsqlAsyncQueryDeleteExample1.yaml b/specification/esql/async_query_delete/examples/request/EsqlAsyncQueryDeleteExample1.yaml new file mode 100644 index 0000000000..0c630eee05 --- /dev/null +++ b/specification/esql/async_query_delete/examples/request/EsqlAsyncQueryDeleteExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE /_query/async/FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI= diff --git a/specification/esql/async_query_get/examples/request/EsqlAsyncQueryGetExample1.yaml b/specification/esql/async_query_get/examples/request/EsqlAsyncQueryGetExample1.yaml new file mode 100644 index 0000000000..7a69a2399a --- /dev/null +++ b/specification/esql/async_query_get/examples/request/EsqlAsyncQueryGetExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_query/async/FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=?wait_for_completion_timeout=30s diff --git a/specification/esql/async_query_stop/examples/request/EsqlAsyncQueryStopExample1.yaml b/specification/esql/async_query_stop/examples/request/EsqlAsyncQueryStopExample1.yaml new file mode 100644 index 0000000000..775da781ae --- /dev/null +++ b/specification/esql/async_query_stop/examples/request/EsqlAsyncQueryStopExample1.yaml @@ -0,0 +1 @@ +method_request: POST /_query/async/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=/stop diff --git a/specification/features/get_features/examples/request/FeaturesGetFeaturesExample1.yaml b/specification/features/get_features/examples/request/FeaturesGetFeaturesExample1.yaml new file mode 100644 index 0000000000..509f354389 --- /dev/null +++ b/specification/features/get_features/examples/request/FeaturesGetFeaturesExample1.yaml @@ -0,0 +1 @@ +method_request: GET _features diff --git a/specification/features/reset_features/examples/request/FeaturesResetFeaturesExample1.yaml b/specification/features/reset_features/examples/request/FeaturesResetFeaturesExample1.yaml new file mode 100644 index 0000000000..0d7baa04ab --- /dev/null +++ b/specification/features/reset_features/examples/request/FeaturesResetFeaturesExample1.yaml @@ -0,0 +1 @@ +method_request: POST /_features/_reset diff --git a/specification/ilm/delete_lifecycle/examples/request/IlmDeleteLifecycleExample1.yaml b/specification/ilm/delete_lifecycle/examples/request/IlmDeleteLifecycleExample1.yaml new file mode 100644 index 0000000000..2e2a308346 --- /dev/null +++ b/specification/ilm/delete_lifecycle/examples/request/IlmDeleteLifecycleExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _ilm/policy/my_policy diff --git a/specification/ilm/explain_lifecycle/examples/request/IlmExplainLifecycleExample1.yaml b/specification/ilm/explain_lifecycle/examples/request/IlmExplainLifecycleExample1.yaml new file mode 100644 index 0000000000..e695acaecd --- /dev/null +++ b/specification/ilm/explain_lifecycle/examples/request/IlmExplainLifecycleExample1.yaml @@ -0,0 +1 @@ +method_request: GET .ds-timeseries-*/_ilm/explain diff --git a/specification/ilm/get_lifecycle/examples/request/IlmGetLifecycleExample1.yaml b/specification/ilm/get_lifecycle/examples/request/IlmGetLifecycleExample1.yaml new file mode 100644 index 0000000000..cebf89a7ab --- /dev/null +++ b/specification/ilm/get_lifecycle/examples/request/IlmGetLifecycleExample1.yaml @@ -0,0 +1 @@ +method_request: GET _ilm/policy/my_policy diff --git a/specification/ilm/get_status/examples/request/IlmGetStatusExample1.yaml b/specification/ilm/get_status/examples/request/IlmGetStatusExample1.yaml new file mode 100644 index 0000000000..04047c6804 --- /dev/null +++ b/specification/ilm/get_status/examples/request/IlmGetStatusExample1.yaml @@ -0,0 +1 @@ +method_request: GET _ilm/status diff --git a/specification/ilm/remove_policy/examples/request/IlmRemovePolicyExample1.yaml b/specification/ilm/remove_policy/examples/request/IlmRemovePolicyExample1.yaml new file mode 100644 index 0000000000..360fb2c26e --- /dev/null +++ b/specification/ilm/remove_policy/examples/request/IlmRemovePolicyExample1.yaml @@ -0,0 +1 @@ +method_request: POST logs-my_app-default/_ilm/remove diff --git a/specification/ilm/retry/examples/request/IlmRetryExample1.yaml b/specification/ilm/retry/examples/request/IlmRetryExample1.yaml new file mode 100644 index 0000000000..103ab9f387 --- /dev/null +++ b/specification/ilm/retry/examples/request/IlmRetryExample1.yaml @@ -0,0 +1 @@ +method_request: POST /my-index-000001/_ilm/retry diff --git a/specification/ilm/start/examples/request/IlmStartExample1.yaml b/specification/ilm/start/examples/request/IlmStartExample1.yaml new file mode 100644 index 0000000000..2a48463c8a --- /dev/null +++ b/specification/ilm/start/examples/request/IlmStartExample1.yaml @@ -0,0 +1 @@ +method_request: POST _ilm/start diff --git a/specification/ilm/stop/examples/request/IlmStopExample1.yaml b/specification/ilm/stop/examples/request/IlmStopExample1.yaml new file mode 100644 index 0000000000..b3476798bb --- /dev/null +++ b/specification/ilm/stop/examples/request/IlmStopExample1.yaml @@ -0,0 +1 @@ +method_request: POST _ilm/stop diff --git a/specification/indices/add_block/examples/request/IndicesAddBlockRequestExample1.yaml b/specification/indices/add_block/examples/request/IndicesAddBlockRequestExample1.yaml new file mode 100644 index 0000000000..7cda8f1073 --- /dev/null +++ b/specification/indices/add_block/examples/request/IndicesAddBlockRequestExample1.yaml @@ -0,0 +1 @@ +method_request: PUT /my-index-000001/_block/write diff --git a/specification/indices/add_block/examples/response/IndicesAddBlockResponseExample1.yaml b/specification/indices/add_block/examples/response/IndicesAddBlockResponseExample1.yaml index a0e7cb72e0..8480375421 100644 --- a/specification/indices/add_block/examples/response/IndicesAddBlockResponseExample1.yaml +++ b/specification/indices/add_block/examples/response/IndicesAddBlockResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: '' -method_request: PUT /my-index-000001/_block/write description: A successful response from `PUT /my-index-000001/_block/write`, which adds an index block to an index.' # type: response # response_code: 200 diff --git a/specification/indices/cancel_migrate_reindex/examples/request/IndicesCancelMigrateReindexExample1.yaml b/specification/indices/cancel_migrate_reindex/examples/request/IndicesCancelMigrateReindexExample1.yaml new file mode 100644 index 0000000000..fa90c32d41 --- /dev/null +++ b/specification/indices/cancel_migrate_reindex/examples/request/IndicesCancelMigrateReindexExample1.yaml @@ -0,0 +1 @@ +method_request: POST /_migration/reindex/my-data-stream/_cancel diff --git a/specification/indices/clear_cache/examples/request/IndicesClearCacheExample1.yaml b/specification/indices/clear_cache/examples/request/IndicesClearCacheExample1.yaml new file mode 100644 index 0000000000..6248e9eaea --- /dev/null +++ b/specification/indices/clear_cache/examples/request/IndicesClearCacheExample1.yaml @@ -0,0 +1 @@ +method_request: POST /my-index-000001,my-index-000002/_cache/clear?request=true diff --git a/specification/indices/close/examples/request/CloseIndexRequestExample1.yaml b/specification/indices/close/examples/request/CloseIndexRequestExample1.yaml new file mode 100644 index 0000000000..aad5f50445 --- /dev/null +++ b/specification/indices/close/examples/request/CloseIndexRequestExample1.yaml @@ -0,0 +1 @@ +method_request: POST /my-index-00001/_close diff --git a/specification/indices/create_data_stream/examples/request/IndicesCreateDataStreamExample1.yaml b/specification/indices/create_data_stream/examples/request/IndicesCreateDataStreamExample1.yaml new file mode 100644 index 0000000000..581ceabf98 --- /dev/null +++ b/specification/indices/create_data_stream/examples/request/IndicesCreateDataStreamExample1.yaml @@ -0,0 +1 @@ +method_request: PUT _data_stream/logs-foo-bar diff --git a/specification/indices/create_from/examples/request/IndicesCreateFromExample1.yaml b/specification/indices/create_from/examples/request/IndicesCreateFromExample1.yaml new file mode 100644 index 0000000000..b8785032b0 --- /dev/null +++ b/specification/indices/create_from/examples/request/IndicesCreateFromExample1.yaml @@ -0,0 +1 @@ +method_request: POST _create_from/my-index/my-new-index diff --git a/specification/indices/data_streams_stats/examples/request/indicesDataStreamStatsExampleRequest1.yaml b/specification/indices/data_streams_stats/examples/request/indicesDataStreamStatsExampleRequest1.yaml new file mode 100644 index 0000000000..70600dc850 --- /dev/null +++ b/specification/indices/data_streams_stats/examples/request/indicesDataStreamStatsExampleRequest1.yaml @@ -0,0 +1 @@ +method_request: GET /_data_stream/my-index-000001/_stats diff --git a/specification/indices/delete/examples/request/IndicesDeleteExample1.yaml b/specification/indices/delete/examples/request/IndicesDeleteExample1.yaml new file mode 100644 index 0000000000..10949f3df6 --- /dev/null +++ b/specification/indices/delete/examples/request/IndicesDeleteExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE /books diff --git a/specification/indices/delete_alias/examples/request/IndicesDeleteAliasExample1.yaml b/specification/indices/delete_alias/examples/request/IndicesDeleteAliasExample1.yaml new file mode 100644 index 0000000000..09bcefe59f --- /dev/null +++ b/specification/indices/delete_alias/examples/request/IndicesDeleteAliasExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE my-data-stream/_alias/my-alias diff --git a/specification/indices/delete_data_lifecycle/examples/request/IndicesDeleteDataLifecycleExample1.yaml b/specification/indices/delete_data_lifecycle/examples/request/IndicesDeleteDataLifecycleExample1.yaml new file mode 100644 index 0000000000..8674ec5b56 --- /dev/null +++ b/specification/indices/delete_data_lifecycle/examples/request/IndicesDeleteDataLifecycleExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _data_stream/my-data-stream/_lifecycle diff --git a/specification/indices/delete_data_stream/examples/request/IndicesDeleteDataStreamExample1.yaml b/specification/indices/delete_data_stream/examples/request/IndicesDeleteDataStreamExample1.yaml new file mode 100644 index 0000000000..67ee24ecc2 --- /dev/null +++ b/specification/indices/delete_data_stream/examples/request/IndicesDeleteDataStreamExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _data_stream/my-data-stream diff --git a/specification/indices/delete_index_template/examples/request/IndicesDeleteIndexTemplateExample1.yaml b/specification/indices/delete_index_template/examples/request/IndicesDeleteIndexTemplateExample1.yaml new file mode 100644 index 0000000000..06c8075f21 --- /dev/null +++ b/specification/indices/delete_index_template/examples/request/IndicesDeleteIndexTemplateExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE /_index_template/my-index-template diff --git a/specification/indices/delete_template/examples/request/IndicesDeleteTemplateExample1.yaml b/specification/indices/delete_template/examples/request/IndicesDeleteTemplateExample1.yaml new file mode 100644 index 0000000000..70d02b2038 --- /dev/null +++ b/specification/indices/delete_template/examples/request/IndicesDeleteTemplateExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _template/.cloud-hot-warm-allocation-0 diff --git a/specification/indices/disk_usage/examples/request/IndicesDiskUsageExample1.yaml b/specification/indices/disk_usage/examples/request/IndicesDiskUsageExample1.yaml new file mode 100644 index 0000000000..acfe6b7fc1 --- /dev/null +++ b/specification/indices/disk_usage/examples/request/IndicesDiskUsageExample1.yaml @@ -0,0 +1 @@ +method_request: POST /my-index-000001/_disk_usage?run_expensive_tasks=true diff --git a/specification/indices/disk_usage/request/200_response/indicesDiskUsageResponseExample1.yaml b/specification/indices/disk_usage/request/200_response/indicesDiskUsageResponseExample1.yaml index 878c3b65ba..f75f08217a 100644 --- a/specification/indices/disk_usage/request/200_response/indicesDiskUsageResponseExample1.yaml +++ b/specification/indices/disk_usage/request/200_response/indicesDiskUsageResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: '' -method_request: POST /my-index-000001/_disk_usage?run_expensive_tasks=true description: An abbreviated response from `POST /my-index-000001/_disk_usage?run_expensive_tasks=true`. # type: response # response_code: 200 diff --git a/specification/indices/disk_usage/request/request/indicesDiskUsageRequestExample1.yaml b/specification/indices/disk_usage/request/request/indicesDiskUsageRequestExample1.yaml new file mode 100644 index 0000000000..acfe6b7fc1 --- /dev/null +++ b/specification/indices/disk_usage/request/request/indicesDiskUsageRequestExample1.yaml @@ -0,0 +1 @@ +method_request: POST /my-index-000001/_disk_usage?run_expensive_tasks=true diff --git a/specification/indices/exists/examples/request/IndicesExistsExample1.yaml b/specification/indices/exists/examples/request/IndicesExistsExample1.yaml new file mode 100644 index 0000000000..9e86eecb0d --- /dev/null +++ b/specification/indices/exists/examples/request/IndicesExistsExample1.yaml @@ -0,0 +1 @@ +method_request: HEAD my-data-stream diff --git a/specification/indices/exists_alias/examples/request/IndicesExistsAliasExample1.yaml b/specification/indices/exists_alias/examples/request/IndicesExistsAliasExample1.yaml new file mode 100644 index 0000000000..f12774b2bc --- /dev/null +++ b/specification/indices/exists_alias/examples/request/IndicesExistsAliasExample1.yaml @@ -0,0 +1 @@ +method_request: HEAD _alias/my-alias diff --git a/specification/indices/exists_template/examples/request/IndicesExistsTemplateExample1.yaml b/specification/indices/exists_template/examples/request/IndicesExistsTemplateExample1.yaml new file mode 100644 index 0000000000..43c13cd1f2 --- /dev/null +++ b/specification/indices/exists_template/examples/request/IndicesExistsTemplateExample1.yaml @@ -0,0 +1 @@ +method_request: HEAD /_template/template_1 diff --git a/specification/indices/explain_data_lifecycle/examples/request/IndicesExplainDataLifecycleRequestExample1.yaml b/specification/indices/explain_data_lifecycle/examples/request/IndicesExplainDataLifecycleRequestExample1.yaml new file mode 100644 index 0000000000..06607d1df9 --- /dev/null +++ b/specification/indices/explain_data_lifecycle/examples/request/IndicesExplainDataLifecycleRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET .ds-metrics-2023.03.22-000001/_lifecycle/explain diff --git a/specification/indices/explain_data_lifecycle/examples/response/IndicesExplainDataLifecycleResponseExample1.yaml b/specification/indices/explain_data_lifecycle/examples/response/IndicesExplainDataLifecycleResponseExample1.yaml index a0cc54845a..44ca833647 100644 --- a/specification/indices/explain_data_lifecycle/examples/response/IndicesExplainDataLifecycleResponseExample1.yaml +++ b/specification/indices/explain_data_lifecycle/examples/response/IndicesExplainDataLifecycleResponseExample1.yaml @@ -1,5 +1,4 @@ summary: Successful response -method_request: GET .ds-metrics-2023.03.22-000001/_lifecycle/explain description: > A successful response from `GET .ds-metrics-2023.03.22-000001/_lifecycle/explain`, which retrieves the lifecycle status for a data stream backing index. If the index is managed by a data stream lifecycle, the API will show the `managed_by_lifecycle` field set to `true` and the rest of the response will contain information about the lifecycle execution status for this index. # type: response diff --git a/specification/indices/field_usage_stats/examples/200_response/indicesFieldUsageStatsResponseExample1.yaml b/specification/indices/field_usage_stats/examples/200_response/indicesFieldUsageStatsResponseExample1.yaml index e4fc84c0b3..f4f837541f 100644 --- a/specification/indices/field_usage_stats/examples/200_response/indicesFieldUsageStatsResponseExample1.yaml +++ b/specification/indices/field_usage_stats/examples/200_response/indicesFieldUsageStatsResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: '' -method_request: GET /my-index-000001/_field_usage_stats description: > An abbreviated response from `GET /my-index-000001/_field_usage_stats`. The `all_fields` object reports the sums of the usage counts for all fields in the index (on the listed shard). diff --git a/specification/indices/field_usage_stats/examples/request/indicesFieldUsageStatsRequestExample1.yaml b/specification/indices/field_usage_stats/examples/request/indicesFieldUsageStatsRequestExample1.yaml new file mode 100644 index 0000000000..d12dd51252 --- /dev/null +++ b/specification/indices/field_usage_stats/examples/request/indicesFieldUsageStatsRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /my-index-000001/_field_usage_stats diff --git a/specification/indices/flush/examples/request/IndicesFlushExample1.yaml b/specification/indices/flush/examples/request/IndicesFlushExample1.yaml new file mode 100644 index 0000000000..b468f6de6a --- /dev/null +++ b/specification/indices/flush/examples/request/IndicesFlushExample1.yaml @@ -0,0 +1 @@ +method_request: POST /_flush diff --git a/specification/indices/forcemerge/examples/request/IndicesForcemergeExample1.yaml b/specification/indices/forcemerge/examples/request/IndicesForcemergeExample1.yaml new file mode 100644 index 0000000000..e98db0f9f9 --- /dev/null +++ b/specification/indices/forcemerge/examples/request/IndicesForcemergeExample1.yaml @@ -0,0 +1 @@ +method_request: POST my-index-000001/_forcemerge diff --git a/specification/indices/get/examples/request/IndicesGetExample1.yaml b/specification/indices/get/examples/request/IndicesGetExample1.yaml new file mode 100644 index 0000000000..c39e42ebae --- /dev/null +++ b/specification/indices/get/examples/request/IndicesGetExample1.yaml @@ -0,0 +1 @@ +method_request: GET /my-index-000001 diff --git a/specification/indices/get_alias/examples/request/IndicesGetAliasExample1.yaml b/specification/indices/get_alias/examples/request/IndicesGetAliasExample1.yaml new file mode 100644 index 0000000000..b66ab2688d --- /dev/null +++ b/specification/indices/get_alias/examples/request/IndicesGetAliasExample1.yaml @@ -0,0 +1 @@ +method_request: GET _alias diff --git a/specification/indices/get_data_lifecycle/examples/request/IndicesGetDataLifecycleRequestExample1.yaml b/specification/indices/get_data_lifecycle/examples/request/IndicesGetDataLifecycleRequestExample1.yaml new file mode 100644 index 0000000000..042401e844 --- /dev/null +++ b/specification/indices/get_data_lifecycle/examples/request/IndicesGetDataLifecycleRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_data_stream/{name}/_lifecycle?human&pretty diff --git a/specification/indices/get_data_lifecycle/examples/response/IndicesGetDataLifecycleResponseExample1.yaml b/specification/indices/get_data_lifecycle/examples/response/IndicesGetDataLifecycleResponseExample1.yaml index a3bcc33b3d..91f15d2d16 100644 --- a/specification/indices/get_data_lifecycle/examples/response/IndicesGetDataLifecycleResponseExample1.yaml +++ b/specification/indices/get_data_lifecycle/examples/response/IndicesGetDataLifecycleResponseExample1.yaml @@ -1,6 +1,5 @@ # summary: -method_request: GET _lifecycle/stats?human&pretty -description: A successful response from `GET _lifecycle/stats?human&pretty`. +description: A successful response from `GET /_data_stream/{name}/_lifecycle?human&pretty`. # type: response # response_code: 200 value: diff --git a/specification/indices/get_data_lifecycle_stats/examples/request/IndicesGetDataLifecycleStatsRequestExample1.yaml b/specification/indices/get_data_lifecycle_stats/examples/request/IndicesGetDataLifecycleStatsRequestExample1.yaml new file mode 100644 index 0000000000..b88c7221f5 --- /dev/null +++ b/specification/indices/get_data_lifecycle_stats/examples/request/IndicesGetDataLifecycleStatsRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _lifecycle/stats?human&pretty diff --git a/specification/indices/get_data_lifecycle_stats/examples/response/IndicesGetDataLifecycleStatsResponseExample1.yaml b/specification/indices/get_data_lifecycle_stats/examples/response/IndicesGetDataLifecycleStatsResponseExample1.yaml index ea78dc1784..04a9ff05ee 100644 --- a/specification/indices/get_data_lifecycle_stats/examples/response/IndicesGetDataLifecycleStatsResponseExample1.yaml +++ b/specification/indices/get_data_lifecycle_stats/examples/response/IndicesGetDataLifecycleStatsResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET _lifecycle/stats?human&pretty description: A successful response for `GET _lifecycle/stats?human&pretty` # type: response # response_code: 200 diff --git a/specification/indices/get_data_stream/examples/request/IndicesGetDataStreamExample1.yaml b/specification/indices/get_data_stream/examples/request/IndicesGetDataStreamExample1.yaml new file mode 100644 index 0000000000..495dc0a360 --- /dev/null +++ b/specification/indices/get_data_stream/examples/request/IndicesGetDataStreamExample1.yaml @@ -0,0 +1 @@ +method_request: GET _data_stream/my-data-stream diff --git a/specification/indices/get_field_mapping/examples/request/indicesGetFieldMappingRequestExample1.yaml b/specification/indices/get_field_mapping/examples/request/indicesGetFieldMappingRequestExample1.yaml new file mode 100644 index 0000000000..0b53a8f71e --- /dev/null +++ b/specification/indices/get_field_mapping/examples/request/indicesGetFieldMappingRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET publications/_mapping/field/title diff --git a/specification/indices/get_field_mapping/examples/response/indicesGetFieldMappingResponseExample1.yaml b/specification/indices/get_field_mapping/examples/response/indicesGetFieldMappingResponseExample1.yaml index f030c14be8..06294947ba 100644 --- a/specification/indices/get_field_mapping/examples/response/indicesGetFieldMappingResponseExample1.yaml +++ b/specification/indices/get_field_mapping/examples/response/indicesGetFieldMappingResponseExample1.yaml @@ -1,6 +1,5 @@ summary: A single field mapping # indices/get-field-mapping.asciidoc:104 -method_request: GET publications/_mapping/field/title description: > A sucessful response from `GET publications/_mapping/field/title`, which returns the mapping of a field called `title`. # type: response diff --git a/specification/indices/get_field_mapping/examples/response/indicesGetFieldMappingResponseExample2.yaml b/specification/indices/get_field_mapping/examples/response/indicesGetFieldMappingResponseExample2.yaml index 002e79297b..66de147282 100644 --- a/specification/indices/get_field_mapping/examples/response/indicesGetFieldMappingResponseExample2.yaml +++ b/specification/indices/get_field_mapping/examples/response/indicesGetFieldMappingResponseExample2.yaml @@ -1,6 +1,5 @@ summary: Multiple field mappings # indices/get-field-mapping.asciidoc:137 -method_request: GET publications/_mapping/field/author.id,abstract,name description: > A successful response from `GET publications/_mapping/field/author.id,abstract,name`. The get field mapping API also supports wildcard notation. diff --git a/specification/indices/get_field_mapping/examples/response/indicesGetFieldMappingResponseExample3.yaml b/specification/indices/get_field_mapping/examples/response/indicesGetFieldMappingResponseExample3.yaml index 9242562f53..2230e6b4ff 100644 --- a/specification/indices/get_field_mapping/examples/response/indicesGetFieldMappingResponseExample3.yaml +++ b/specification/indices/get_field_mapping/examples/response/indicesGetFieldMappingResponseExample3.yaml @@ -1,6 +1,5 @@ summary: Wildcards # indices/get-field-mapping.asciidoc:173 -method_request: GET publications/_mapping/field/a* description: > A successful response from `GET publications/_mapping/field/a*`. # type: response diff --git a/specification/indices/get_index_template/examples/request/IndicesGetIndexTemplateExample1.yaml b/specification/indices/get_index_template/examples/request/IndicesGetIndexTemplateExample1.yaml new file mode 100644 index 0000000000..14d0b3a1e7 --- /dev/null +++ b/specification/indices/get_index_template/examples/request/IndicesGetIndexTemplateExample1.yaml @@ -0,0 +1 @@ +method_request: GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream diff --git a/specification/indices/get_mapping/examples/request/IndicesGetMappingExample1.yaml b/specification/indices/get_mapping/examples/request/IndicesGetMappingExample1.yaml new file mode 100644 index 0000000000..11e3f68060 --- /dev/null +++ b/specification/indices/get_mapping/examples/request/IndicesGetMappingExample1.yaml @@ -0,0 +1 @@ +method_request: GET /books/_mapping diff --git a/specification/indices/get_migrate_reindex_status/examples/request/IndicesGetMigrateReindexStatusExample1.yaml b/specification/indices/get_migrate_reindex_status/examples/request/IndicesGetMigrateReindexStatusExample1.yaml new file mode 100644 index 0000000000..49dec01b92 --- /dev/null +++ b/specification/indices/get_migrate_reindex_status/examples/request/IndicesGetMigrateReindexStatusExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_migration/reindex/my-data-stream/_status diff --git a/specification/indices/get_settings/examples/request/IndicesGetSettingsExample1.yaml b/specification/indices/get_settings/examples/request/IndicesGetSettingsExample1.yaml new file mode 100644 index 0000000000..758c778a74 --- /dev/null +++ b/specification/indices/get_settings/examples/request/IndicesGetSettingsExample1.yaml @@ -0,0 +1 @@ +method_request: GET _all/_settings?expand_wildcards=all&filter_path=*.settings.index.*.slowlog diff --git a/specification/indices/get_template/examples/request/IndicesGetTemplateExample1.yaml b/specification/indices/get_template/examples/request/IndicesGetTemplateExample1.yaml new file mode 100644 index 0000000000..56ea37d583 --- /dev/null +++ b/specification/indices/get_template/examples/request/IndicesGetTemplateExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_template/.monitoring-* diff --git a/specification/indices/migrate_reindex/examples/request/IndicesMigrateReindexExample1.yaml b/specification/indices/migrate_reindex/examples/request/IndicesMigrateReindexExample1.yaml new file mode 100644 index 0000000000..348eb287e2 --- /dev/null +++ b/specification/indices/migrate_reindex/examples/request/IndicesMigrateReindexExample1.yaml @@ -0,0 +1,9 @@ +method_request: POST _migration/reindex +description: An example body for a `POST _migration/reindex` request. +value: |- + { + "source": { + "index": "my-data-stream" + }, + "mode": "upgrade" + } diff --git a/specification/indices/migrate_to_data_stream/examples/request/IndicesMigrateToDataStreamExample1.yaml b/specification/indices/migrate_to_data_stream/examples/request/IndicesMigrateToDataStreamExample1.yaml new file mode 100644 index 0000000000..27260c12a3 --- /dev/null +++ b/specification/indices/migrate_to_data_stream/examples/request/IndicesMigrateToDataStreamExample1.yaml @@ -0,0 +1 @@ +method_request: POST _data_stream/_migrate/my-time-series-data diff --git a/specification/indices/modify_data_stream/examples/request/IndicesModifyDataStreamExample1.yaml b/specification/indices/modify_data_stream/examples/request/IndicesModifyDataStreamExample1.yaml new file mode 100644 index 0000000000..d8778d8f14 --- /dev/null +++ b/specification/indices/modify_data_stream/examples/request/IndicesModifyDataStreamExample1.yaml @@ -0,0 +1,19 @@ +method_request: POST _data_stream/_modify +description: An example body for a `POST _data_stream/_modify` request. +value: |- + { + "actions": [ + { + "remove_backing_index": { + "data_stream": "my-data-stream", + "index": ".ds-my-data-stream-2023.07.26-000001" + } + }, + { + "add_backing_index": { + "data_stream": "my-data-stream", + "index": ".ds-my-data-stream-2023.07.26-000001-downsample" + } + } + ] + } diff --git a/specification/indices/open/examples/request/IndicesOpenExample1.yaml b/specification/indices/open/examples/request/IndicesOpenExample1.yaml new file mode 100644 index 0000000000..d201e97a27 --- /dev/null +++ b/specification/indices/open/examples/request/IndicesOpenExample1.yaml @@ -0,0 +1 @@ +method_request: POST /.ds-my-data-stream-2099.03.07-000001/_open/ diff --git a/specification/indices/promote_data_stream/examples/request/IndicesPromoteDataStreamExample1.yaml b/specification/indices/promote_data_stream/examples/request/IndicesPromoteDataStreamExample1.yaml new file mode 100644 index 0000000000..dc8d38ea6c --- /dev/null +++ b/specification/indices/promote_data_stream/examples/request/IndicesPromoteDataStreamExample1.yaml @@ -0,0 +1 @@ +method_request: POST /_data_stream/_promote/my-data-stream diff --git a/specification/indices/recovery/examples/200_response/indicesRecoveryResponseExample1.yaml b/specification/indices/recovery/examples/200_response/indicesRecoveryResponseExample1.yaml index b85f2db109..5804f8c909 100644 --- a/specification/indices/recovery/examples/200_response/indicesRecoveryResponseExample1.yaml +++ b/specification/indices/recovery/examples/200_response/indicesRecoveryResponseExample1.yaml @@ -1,5 +1,4 @@ summary: Get segment information -method_request: GET /_recovery?human description: > A successful response from `GET /_recovery?human`, which gets information about ongoing and completed shard recoveries for all data streams and indices in a cluster. This example includes information about a single index recovering a single shard. diff --git a/specification/indices/recovery/examples/200_response/indicesRecoveryResponseExample2.yaml b/specification/indices/recovery/examples/200_response/indicesRecoveryResponseExample2.yaml index 96a334cd8c..c92389d4b4 100644 --- a/specification/indices/recovery/examples/200_response/indicesRecoveryResponseExample2.yaml +++ b/specification/indices/recovery/examples/200_response/indicesRecoveryResponseExample2.yaml @@ -1,6 +1,5 @@ summary: Get detailed recovery information # indices/recovery.asciidoc:358 -method_request: GET _recovery?human&detailed=true description: > A successful response from `GET _recovery?human&detailed=true`. The response includes a listing of any physical files recovered and their sizes. diff --git a/specification/indices/recovery/examples/request/indicesRecoveryRequestExample1.yaml b/specification/indices/recovery/examples/request/indicesRecoveryRequestExample1.yaml new file mode 100644 index 0000000000..f615441005 --- /dev/null +++ b/specification/indices/recovery/examples/request/indicesRecoveryRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_recovery?human diff --git a/specification/indices/refresh/examples/request/IndicesRefreshExample1.yaml b/specification/indices/refresh/examples/request/IndicesRefreshExample1.yaml new file mode 100644 index 0000000000..6a13bc240a --- /dev/null +++ b/specification/indices/refresh/examples/request/IndicesRefreshExample1.yaml @@ -0,0 +1 @@ +method_request: GET _refresh diff --git a/specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample1.yaml b/specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample1.yaml index e7020418a1..3f4c0fcd62 100644 --- a/specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample1.yaml +++ b/specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample1.yaml @@ -1,5 +1,4 @@ summary: Resolve with wildcards -method_request: GET /_resolve/cluster/my-index*,clust*:my-index* description: > A successful response from `GET /_resolve/cluster/my-index*,clust*:my-index*`. Each cluster has its own response section. The cluster you sent the request to is labelled as "(local)". diff --git a/specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample2.yaml b/specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample2.yaml index 34fc8cf02e..3ed5da8424 100644 --- a/specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample2.yaml +++ b/specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample2.yaml @@ -1,6 +1,5 @@ summary: Identify search problems # indices/resolve-cluster.asciidoc:213 -method_request: GET /_resolve/cluster/not-present,clust*:my-index*,oldcluster:*?ignore_unavailable=false&timeout=5s description: > A successful response from `GET /_resolve/cluster/not-present,clust*:my-index*,oldcluster:*?ignore_unavailable=false&timeout=5s`. This type of request can be used to identify potential problems with your cross-cluster search. diff --git a/specification/indices/resolve_cluster/examples/request/ResolveClusterRequestExample2.yaml b/specification/indices/resolve_cluster/examples/request/ResolveClusterRequestExample2.yaml new file mode 100644 index 0000000000..510c17feda --- /dev/null +++ b/specification/indices/resolve_cluster/examples/request/ResolveClusterRequestExample2.yaml @@ -0,0 +1 @@ +method_request: GET /_resolve/cluster/not-present,clust*:my-index*,oldcluster:*?ignore_unavailable=false&timeout=5s diff --git a/specification/indices/resolve_index/examples/request/ResolveIndexRequestExample1.yaml b/specification/indices/resolve_index/examples/request/ResolveIndexRequestExample1.yaml new file mode 100644 index 0000000000..1e0f7249b7 --- /dev/null +++ b/specification/indices/resolve_index/examples/request/ResolveIndexRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_resolve/index/f*,remoteCluster1:bar*?expand_wildcards=all diff --git a/specification/indices/resolve_index/examples/response/ResolveIndexResponseExample1.yaml b/specification/indices/resolve_index/examples/response/ResolveIndexResponseExample1.yaml index 556a45d86a..da130d5826 100644 --- a/specification/indices/resolve_index/examples/response/ResolveIndexResponseExample1.yaml +++ b/specification/indices/resolve_index/examples/response/ResolveIndexResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_resolve/index/f*,remoteCluster1:bar*?expand_wildcards=all description: A successful response from `GET /_resolve/index/f*,remoteCluster1:bar*?expand_wildcards=all`. # type: response # response_code: 200 diff --git a/specification/indices/rollover/examples/200_response/indicesRolloverResponseExample1.yaml b/specification/indices/rollover/examples/200_response/indicesRolloverResponseExample1.yaml index cb5bf59652..83e69dea80 100644 --- a/specification/indices/rollover/examples/200_response/indicesRolloverResponseExample1.yaml +++ b/specification/indices/rollover/examples/200_response/indicesRolloverResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_segments description: > An abbreviated response from `GET /_segments`. # type: response diff --git a/specification/indices/segments/examples/request/IndicesSegmentsExample1.yaml b/specification/indices/segments/examples/request/IndicesSegmentsExample1.yaml new file mode 100644 index 0000000000..9e791d430d --- /dev/null +++ b/specification/indices/segments/examples/request/IndicesSegmentsExample1.yaml @@ -0,0 +1 @@ +method_request: GET /my-index-000001/_segments diff --git a/specification/indices/shard_stores/examples/200_response/indicesShardStoresResponseExample1.yaml b/specification/indices/shard_stores/examples/200_response/indicesShardStoresResponseExample1.yaml index 7b607edc47..f914a2f1a8 100644 --- a/specification/indices/shard_stores/examples/200_response/indicesShardStoresResponseExample1.yaml +++ b/specification/indices/shard_stores/examples/200_response/indicesShardStoresResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_shard_stores?status=green description: > An abbreviated response from `GET /_shard_stores?status=green`. # type: response diff --git a/specification/indices/shard_stores/examples/request/indicesShardStoresRequestExample1.yaml b/specification/indices/shard_stores/examples/request/indicesShardStoresRequestExample1.yaml new file mode 100644 index 0000000000..7a44a1977f --- /dev/null +++ b/specification/indices/shard_stores/examples/request/indicesShardStoresRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_shard_stores?status=green diff --git a/specification/indices/simulate_index_template/examples/200_response/indicesSimulateIndexTemplateResponseExample1.yaml b/specification/indices/simulate_index_template/examples/200_response/indicesSimulateIndexTemplateResponseExample1.yaml index 9a4c93b549..4734f60669 100644 --- a/specification/indices/simulate_index_template/examples/200_response/indicesSimulateIndexTemplateResponseExample1.yaml +++ b/specification/indices/simulate_index_template/examples/200_response/indicesSimulateIndexTemplateResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: indices/simulate-index.asciidoc:188 -method_request: POST /_index_template/_simulate_index/my-index-000001 description: A successful response from `POST /_index_template/_simulate_index/my-index-000001`. # type: response # response_code: 200 diff --git a/specification/indices/simulate_index_template/examples/request/indicesSimulateIndexTemplateRequestExample1.yaml b/specification/indices/simulate_index_template/examples/request/indicesSimulateIndexTemplateRequestExample1.yaml new file mode 100644 index 0000000000..4f244ee05b --- /dev/null +++ b/specification/indices/simulate_index_template/examples/request/indicesSimulateIndexTemplateRequestExample1.yaml @@ -0,0 +1 @@ +method_request: POST /_index_template/_simulate_index/my-index-000001 diff --git a/specification/indices/simulate_template/examples/200_response/indicesSimulateTemplateResponseExample2.yaml b/specification/indices/simulate_template/examples/200_response/indicesSimulateTemplateResponseExample2.yaml index 26188117c2..13302c0ba9 100644 --- a/specification/indices/simulate_template/examples/200_response/indicesSimulateTemplateResponseExample2.yaml +++ b/specification/indices/simulate_template/examples/200_response/indicesSimulateTemplateResponseExample2.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /_index_template/_simulate description: > A successful response from `POST /_index_template/_simulate` with a template configuration in the request body. The response shows any overlapping templates with a lower priority. diff --git a/specification/indices/stats/examples/request/IndicesStatsExample1.yaml b/specification/indices/stats/examples/request/IndicesStatsExample1.yaml new file mode 100644 index 0000000000..da2206189b --- /dev/null +++ b/specification/indices/stats/examples/request/IndicesStatsExample1.yaml @@ -0,0 +1 @@ +method_request: GET _stats/fielddata?human&fields=my_join_field#question diff --git a/specification/indices/update_aliases/examples/request/IndicesUpdateAliasesExample1.yaml b/specification/indices/update_aliases/examples/request/IndicesUpdateAliasesExample1.yaml new file mode 100644 index 0000000000..05f25dd467 --- /dev/null +++ b/specification/indices/update_aliases/examples/request/IndicesUpdateAliasesExample1.yaml @@ -0,0 +1,13 @@ +method_request: POST _aliases +description: An example body for a `POST _aliases` request. +value: |- + { + "actions": [ + { + "add": { + "index": "logs-nginx.access-prod", + "alias": "logs" + } + } + ] + } diff --git a/specification/indices/validate_query/examples/request/IndicesValidateQueryExample1.yaml b/specification/indices/validate_query/examples/request/IndicesValidateQueryExample1.yaml new file mode 100644 index 0000000000..54accf2b70 --- /dev/null +++ b/specification/indices/validate_query/examples/request/IndicesValidateQueryExample1.yaml @@ -0,0 +1 @@ +method_request: GET my-index-000001/_validate/query?q=user.id:kimchy diff --git a/specification/inference/completion/examples/response/CompletionResponseExample1.yaml b/specification/inference/completion/examples/response/CompletionResponseExample1.yaml index 99b07deec1..0f2b454856 100644 --- a/specification/inference/completion/examples/response/CompletionResponseExample1.yaml +++ b/specification/inference/completion/examples/response/CompletionResponseExample1.yaml @@ -1,5 +1,4 @@ summary: Completion task -method_request: POST _inference/completion/openai_chat_completions description: > A successful response from `POST _inference/completion/openai_chat_completions`. # type: "response" diff --git a/specification/inference/delete/examples/request/InferenceDeleteExample1.yaml b/specification/inference/delete/examples/request/InferenceDeleteExample1.yaml new file mode 100644 index 0000000000..862899b533 --- /dev/null +++ b/specification/inference/delete/examples/request/InferenceDeleteExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE /_inference/sparse_embedding/my-elser-model diff --git a/specification/inference/get/examples/request/InferenceGetExample1.yaml b/specification/inference/get/examples/request/InferenceGetExample1.yaml new file mode 100644 index 0000000000..de31182d50 --- /dev/null +++ b/specification/inference/get/examples/request/InferenceGetExample1.yaml @@ -0,0 +1 @@ +method_request: GET _inference/sparse_embedding/my-elser-model diff --git a/specification/inference/put/examples/request/InferencePutExample1.yaml b/specification/inference/put/examples/request/InferencePutExample1.yaml new file mode 100644 index 0000000000..c83f09194e --- /dev/null +++ b/specification/inference/put/examples/request/InferencePutExample1.yaml @@ -0,0 +1,10 @@ +method_request: PUT _inference/rerank/my-rerank-model +description: An example body for a `PUT _inference/rerank/my-rerank-model` request. +value: |- + { + "service": "cohere", + "service_settings": { + "model_id": "rerank-english-v3.0", + "api_key": "{{COHERE_API_KEY}}" + } + } diff --git a/specification/inference/put_elasticsearch/examples/response/PutElasticsearchResponseExample1.yaml b/specification/inference/put_elasticsearch/examples/response/PutElasticsearchResponseExample1.yaml index 4852cb81f9..2a9c7f6033 100644 --- a/specification/inference/put_elasticsearch/examples/response/PutElasticsearchResponseExample1.yaml +++ b/specification/inference/put_elasticsearch/examples/response/PutElasticsearchResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: PUT _inference/sparse_embedding/use_existing_deployment description: > A successful response from `PUT _inference/sparse_embedding/use_existing_deployment`. It contains the model ID and the threads and allocations settings from the model deployment. # type: "response" diff --git a/specification/inference/rerank/examples/response/RerankResponseExample1.yaml b/specification/inference/rerank/examples/response/RerankResponseExample1.yaml index a1f5a3c6e5..db18547f6d 100644 --- a/specification/inference/rerank/examples/response/RerankResponseExample1.yaml +++ b/specification/inference/rerank/examples/response/RerankResponseExample1.yaml @@ -1,5 +1,4 @@ summary: Rerank task -method_request: POST _inference/rerank/cohere_rerank description: > A successful response from `POST _inference/rerank/cohere_rerank`. # type: "response" diff --git a/specification/inference/sparse_embedding/examples/response/SparseEmbeddingResponseExample1.yaml b/specification/inference/sparse_embedding/examples/response/SparseEmbeddingResponseExample1.yaml index af8411b628..f3ec16545a 100644 --- a/specification/inference/sparse_embedding/examples/response/SparseEmbeddingResponseExample1.yaml +++ b/specification/inference/sparse_embedding/examples/response/SparseEmbeddingResponseExample1.yaml @@ -1,5 +1,4 @@ summary: Sparse embedding task -method_request: POST _inference/sparse_embedding/my-elser-model description: > An abbreviated response from `POST _inference/sparse_embedding/my-elser-model`. # type: "response" diff --git a/specification/inference/text_embedding/examples/response/TextEmbeddingResponseExample1.yaml b/specification/inference/text_embedding/examples/response/TextEmbeddingResponseExample1.yaml index 953c76d044..45c449746f 100644 --- a/specification/inference/text_embedding/examples/response/TextEmbeddingResponseExample1.yaml +++ b/specification/inference/text_embedding/examples/response/TextEmbeddingResponseExample1.yaml @@ -1,5 +1,4 @@ summary: Text embedding task -method_request: POST _inference/text_embedding/my-cohere-endpoint description: > An abbreviated response from `POST _inference/text_embedding/my-cohere-endpoint`. # type: "response" diff --git a/specification/inference/update/examples/request/InferenceUpdateExample1.yaml b/specification/inference/update/examples/request/InferenceUpdateExample1.yaml new file mode 100644 index 0000000000..f986bcb01d --- /dev/null +++ b/specification/inference/update/examples/request/InferenceUpdateExample1.yaml @@ -0,0 +1,8 @@ +method_request: PUT _inference/my-inference-endpoint/_update +description: An example body for a `PUT _inference/my-inference-endpoint/_update` request. +value: |- + { + "service_settings": { + "api_key": "" + } + } diff --git a/specification/ingest/delete_ip_location_database/examples/request/IngestDeleteIpLocationDatabaseExample1.yaml b/specification/ingest/delete_ip_location_database/examples/request/IngestDeleteIpLocationDatabaseExample1.yaml new file mode 100644 index 0000000000..fcf2258725 --- /dev/null +++ b/specification/ingest/delete_ip_location_database/examples/request/IngestDeleteIpLocationDatabaseExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE /_ingest/ip_location/database/my-database-id diff --git a/specification/ingest/delete_pipeline/examples/request/IngestDeletePipelineExample1.yaml b/specification/ingest/delete_pipeline/examples/request/IngestDeletePipelineExample1.yaml new file mode 100644 index 0000000000..6474f66e49 --- /dev/null +++ b/specification/ingest/delete_pipeline/examples/request/IngestDeletePipelineExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE /_ingest/pipeline/my-pipeline-id diff --git a/specification/ingest/geo_ip_stats/examples/request/IngestGeoIpStatsExample1.yaml b/specification/ingest/geo_ip_stats/examples/request/IngestGeoIpStatsExample1.yaml new file mode 100644 index 0000000000..00e03c8138 --- /dev/null +++ b/specification/ingest/geo_ip_stats/examples/request/IngestGeoIpStatsExample1.yaml @@ -0,0 +1 @@ +method_request: GET _ingest/geoip/stats diff --git a/specification/ingest/get_ip_location_database/examples/request/IngestGetIpLocationDatabaseExample1.yaml b/specification/ingest/get_ip_location_database/examples/request/IngestGetIpLocationDatabaseExample1.yaml new file mode 100644 index 0000000000..f266e00c60 --- /dev/null +++ b/specification/ingest/get_ip_location_database/examples/request/IngestGetIpLocationDatabaseExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_ingest/ip_location/database/my-database-id diff --git a/specification/ingest/get_pipeline/examples/request/IngestGetPipelineExample1.yaml b/specification/ingest/get_pipeline/examples/request/IngestGetPipelineExample1.yaml new file mode 100644 index 0000000000..34a3eaeb9e --- /dev/null +++ b/specification/ingest/get_pipeline/examples/request/IngestGetPipelineExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_ingest/pipeline/my-pipeline-id diff --git a/specification/ingest/processor_grok/examples/request/IngestProcessorGrokExample1.yaml b/specification/ingest/processor_grok/examples/request/IngestProcessorGrokExample1.yaml new file mode 100644 index 0000000000..2ca8dd7a47 --- /dev/null +++ b/specification/ingest/processor_grok/examples/request/IngestProcessorGrokExample1.yaml @@ -0,0 +1 @@ +method_request: GET _ingest/processor/grok diff --git a/specification/ingest/put_ip_location_database/examples/request/IngestPutIpLocationDatabaseExample1.yaml b/specification/ingest/put_ip_location_database/examples/request/IngestPutIpLocationDatabaseExample1.yaml new file mode 100644 index 0000000000..6656b88411 --- /dev/null +++ b/specification/ingest/put_ip_location_database/examples/request/IngestPutIpLocationDatabaseExample1.yaml @@ -0,0 +1,9 @@ +method_request: PUT _ingest/ip_location/database/my-database-1 +description: An example body for a `PUT _ingest/ip_location/database/my-database-1` request. +value: |- + { + "name": "GeoIP2-Domain", + "maxmind": { + "account_id": "1234567" + } + } diff --git a/specification/license/delete/examples/request/LicenseDeleteExample1.yaml b/specification/license/delete/examples/request/LicenseDeleteExample1.yaml new file mode 100644 index 0000000000..9051d299cd --- /dev/null +++ b/specification/license/delete/examples/request/LicenseDeleteExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE /_license diff --git a/specification/license/get/examples/request/GetLicenseRequestExample1.yaml b/specification/license/get/examples/request/GetLicenseRequestExample1.yaml new file mode 100644 index 0000000000..a05a5fbabe --- /dev/null +++ b/specification/license/get/examples/request/GetLicenseRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_license diff --git a/specification/license/get/examples/response/GetLicenseResponseExample1.yaml b/specification/license/get/examples/response/GetLicenseResponseExample1.yaml index ca5229a6a2..937d67fc6e 100644 --- a/specification/license/get/examples/response/GetLicenseResponseExample1.yaml +++ b/specification/license/get/examples/response/GetLicenseResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: licensing/get-license.asciidoc:61 -method_request: GET /_license description: A successful response from `GET /_license`. # type: response # response_code: '' diff --git a/specification/license/get_basic_status/examples/200_response/GetBasicLicenseStatusResponseExample1.yaml b/specification/license/get_basic_status/examples/200_response/GetBasicLicenseStatusResponseExample1.yaml index 6b79e5ba59..e6ed67a9d9 100644 --- a/specification/license/get_basic_status/examples/200_response/GetBasicLicenseStatusResponseExample1.yaml +++ b/specification/license/get_basic_status/examples/200_response/GetBasicLicenseStatusResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: licensing/get-basic-status.asciidoc:42 -method_request: GET /_license/basic_status description: A successful response from `GET /_license/basic_status`. # type: response # response_code: 200 diff --git a/specification/license/get_basic_status/examples/request/GetBasicLicenseStatusRequestExample1.yaml b/specification/license/get_basic_status/examples/request/GetBasicLicenseStatusRequestExample1.yaml new file mode 100644 index 0000000000..5b13e6709d --- /dev/null +++ b/specification/license/get_basic_status/examples/request/GetBasicLicenseStatusRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_license/basic_status diff --git a/specification/license/get_trial_status/examples/200_response/GetTrialLicenseStatusResponseExample1.yaml b/specification/license/get_trial_status/examples/200_response/GetTrialLicenseStatusResponseExample1.yaml index 968cb85548..ce0ad02ed5 100644 --- a/specification/license/get_trial_status/examples/200_response/GetTrialLicenseStatusResponseExample1.yaml +++ b/specification/license/get_trial_status/examples/200_response/GetTrialLicenseStatusResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: licensing/get-trial-status.asciidoc:47 -method_request: GET /_license/trial_status description: A successful response from `GET /_license/trial_status`. # type: response # response_code: 200 diff --git a/specification/license/get_trial_status/examples/request/GetTrialLicenseStatusRequestExample1.yaml b/specification/license/get_trial_status/examples/request/GetTrialLicenseStatusRequestExample1.yaml new file mode 100644 index 0000000000..b43a0b4c02 --- /dev/null +++ b/specification/license/get_trial_status/examples/request/GetTrialLicenseStatusRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_license/trial_status diff --git a/specification/license/post_start_basic/examples/200_response/StartBasicLicenseResponseExample1.yaml b/specification/license/post_start_basic/examples/200_response/StartBasicLicenseResponseExample1.yaml index 1c6ea50208..805a87b14c 100644 --- a/specification/license/post_start_basic/examples/200_response/StartBasicLicenseResponseExample1.yaml +++ b/specification/license/post_start_basic/examples/200_response/StartBasicLicenseResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /_license/start_basic?acknowledge=true description: A successful response from `POST /_license/start_basic?acknowledge=true`. If you currently have a license with more features than a basic license and you start a basic license, you must pass the acknowledge parameter. # type: response # response_code: 200 diff --git a/specification/license/post_start_basic/examples/request/StartBasicLicenseRequestExample1.yaml b/specification/license/post_start_basic/examples/request/StartBasicLicenseRequestExample1.yaml new file mode 100644 index 0000000000..1da320bc31 --- /dev/null +++ b/specification/license/post_start_basic/examples/request/StartBasicLicenseRequestExample1.yaml @@ -0,0 +1 @@ +method_request: POST /_license/start_basic?acknowledge=true diff --git a/specification/license/post_start_trial/examples/200_response/StartTrialLicenseResponseExample1.yaml b/specification/license/post_start_trial/examples/200_response/StartTrialLicenseResponseExample1.yaml index a4c7eae0b9..105dcc1ae5 100644 --- a/specification/license/post_start_trial/examples/200_response/StartTrialLicenseResponseExample1.yaml +++ b/specification/license/post_start_trial/examples/200_response/StartTrialLicenseResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /_license/start_trial?acknowledge=true description: A successful response from `POST /_license/start_trial?acknowledge=true`. # type: response # response_code: 200 diff --git a/specification/license/post_start_trial/examples/request/StartTrialLicenseRequestExample1.yaml b/specification/license/post_start_trial/examples/request/StartTrialLicenseRequestExample1.yaml new file mode 100644 index 0000000000..684e3ce68a --- /dev/null +++ b/specification/license/post_start_trial/examples/request/StartTrialLicenseRequestExample1.yaml @@ -0,0 +1 @@ +method_request: POST /_license/start_trial?acknowledge=true diff --git a/specification/logstash/delete_pipeline/examples/request/LogstashDeletePipelineExample1.yaml b/specification/logstash/delete_pipeline/examples/request/LogstashDeletePipelineExample1.yaml new file mode 100644 index 0000000000..f3bd2e9aa7 --- /dev/null +++ b/specification/logstash/delete_pipeline/examples/request/LogstashDeletePipelineExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _logstash/pipeline/my_pipeline diff --git a/specification/logstash/get_pipeline/examples/200_response/LogstashGetPipelineResponseExample1.yaml b/specification/logstash/get_pipeline/examples/200_response/LogstashGetPipelineResponseExample1.yaml index 1b09da9563..17a0d29bfc 100644 --- a/specification/logstash/get_pipeline/examples/200_response/LogstashGetPipelineResponseExample1.yaml +++ b/specification/logstash/get_pipeline/examples/200_response/LogstashGetPipelineResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET _logstash/pipeline/my_pipeline description: > A successful response from `GET _logstash/pipeline/my_pipeline`. # type: "response" diff --git a/specification/logstash/get_pipeline/examples/request/LogstashGetPipelineRequestExample1.yaml b/specification/logstash/get_pipeline/examples/request/LogstashGetPipelineRequestExample1.yaml new file mode 100644 index 0000000000..6e566ef39d --- /dev/null +++ b/specification/logstash/get_pipeline/examples/request/LogstashGetPipelineRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _logstash/pipeline/my_pipeline diff --git a/specification/migration/deprecations/examples/200_response/DeprecationInfoResponseExample1.yaml b/specification/migration/deprecations/examples/200_response/DeprecationInfoResponseExample1.yaml index 8ac89d3dbd..3c71c91c27 100644 --- a/specification/migration/deprecations/examples/200_response/DeprecationInfoResponseExample1.yaml +++ b/specification/migration/deprecations/examples/200_response/DeprecationInfoResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_migration/deprecations description: > An abbreviated response from `GET /_migration/deprecations`. # type: "response" diff --git a/specification/migration/deprecations/examples/request/DeprecationInfoRequestExample1.yaml b/specification/migration/deprecations/examples/request/DeprecationInfoRequestExample1.yaml new file mode 100644 index 0000000000..e096e74803 --- /dev/null +++ b/specification/migration/deprecations/examples/request/DeprecationInfoRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_migration/deprecations diff --git a/specification/migration/get_feature_upgrade_status/examples/request/GetFeatureUpgradeStatusRequestExample1.yaml b/specification/migration/get_feature_upgrade_status/examples/request/GetFeatureUpgradeStatusRequestExample1.yaml new file mode 100644 index 0000000000..2bd680e656 --- /dev/null +++ b/specification/migration/get_feature_upgrade_status/examples/request/GetFeatureUpgradeStatusRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_migration/system_features diff --git a/specification/migration/get_feature_upgrade_status/examples/response/GetFeatureUpgradeStatusResponseExample1.yaml b/specification/migration/get_feature_upgrade_status/examples/response/GetFeatureUpgradeStatusResponseExample1.yaml index dde0baa032..8e2bc93fde 100644 --- a/specification/migration/get_feature_upgrade_status/examples/response/GetFeatureUpgradeStatusResponseExample1.yaml +++ b/specification/migration/get_feature_upgrade_status/examples/response/GetFeatureUpgradeStatusResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_migration/system_features description: A successful response from `GET /_migration/system_features`. # type: response # response_code: '' diff --git a/specification/migration/post_feature_upgrade/examples/request/PostFeatureUpgradeRequestExample1.yaml b/specification/migration/post_feature_upgrade/examples/request/PostFeatureUpgradeRequestExample1.yaml new file mode 100644 index 0000000000..c77bc6e0ff --- /dev/null +++ b/specification/migration/post_feature_upgrade/examples/request/PostFeatureUpgradeRequestExample1.yaml @@ -0,0 +1 @@ +method_request: POST /_migration/system_features diff --git a/specification/migration/post_feature_upgrade/examples/response/PostFeatureUpgradeResponseExample1.yaml b/specification/migration/post_feature_upgrade/examples/response/PostFeatureUpgradeResponseExample1.yaml index 237da7229d..fe0975bb42 100644 --- a/specification/migration/post_feature_upgrade/examples/response/PostFeatureUpgradeResponseExample1.yaml +++ b/specification/migration/post_feature_upgrade/examples/response/PostFeatureUpgradeResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /_migration/system_features description: > When you run `POST /_migration/system_features` to start the migration process, the response lists the features that will be migrated. # type: response diff --git a/specification/ml/clear_trained_model_deployment_cache/examples/request/MlClearTrainedModelDeploymentCacheExample1.yaml b/specification/ml/clear_trained_model_deployment_cache/examples/request/MlClearTrainedModelDeploymentCacheExample1.yaml new file mode 100644 index 0000000000..0417377ba9 --- /dev/null +++ b/specification/ml/clear_trained_model_deployment_cache/examples/request/MlClearTrainedModelDeploymentCacheExample1.yaml @@ -0,0 +1 @@ +method_request: POST _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/cache/_clear diff --git a/specification/ml/close_job/examples/request/MlCloseJobExample1.yaml b/specification/ml/close_job/examples/request/MlCloseJobExample1.yaml new file mode 100644 index 0000000000..ff006ad930 --- /dev/null +++ b/specification/ml/close_job/examples/request/MlCloseJobExample1.yaml @@ -0,0 +1 @@ +method_request: POST _ml/anomaly_detectors/low_request_rate/_close diff --git a/specification/ml/delete_calendar/examples/request/MlDeleteCalendarExample1.yaml b/specification/ml/delete_calendar/examples/request/MlDeleteCalendarExample1.yaml new file mode 100644 index 0000000000..cdd6642c4d --- /dev/null +++ b/specification/ml/delete_calendar/examples/request/MlDeleteCalendarExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _ml/calendars/planned-outages diff --git a/specification/ml/delete_calendar_event/examples/request/MlDeleteCalendarEventExample1.yaml b/specification/ml/delete_calendar_event/examples/request/MlDeleteCalendarEventExample1.yaml new file mode 100644 index 0000000000..03e0bc1377 --- /dev/null +++ b/specification/ml/delete_calendar_event/examples/request/MlDeleteCalendarEventExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _ml/calendars/planned-outages/events/LS8LJGEBMTCMA-qz49st diff --git a/specification/ml/delete_calendar_job/examples/request/MlDeleteCalendarJobExample1.yaml b/specification/ml/delete_calendar_job/examples/request/MlDeleteCalendarJobExample1.yaml new file mode 100644 index 0000000000..f42515b459 --- /dev/null +++ b/specification/ml/delete_calendar_job/examples/request/MlDeleteCalendarJobExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _ml/calendars/planned-outages/jobs/total-requests diff --git a/specification/ml/delete_data_frame_analytics/examples/request/MlDeleteDataFrameAnalyticsExample1.yaml b/specification/ml/delete_data_frame_analytics/examples/request/MlDeleteDataFrameAnalyticsExample1.yaml new file mode 100644 index 0000000000..1e7f8c41fb --- /dev/null +++ b/specification/ml/delete_data_frame_analytics/examples/request/MlDeleteDataFrameAnalyticsExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _ml/data_frame/analytics/loganalytics diff --git a/specification/ml/delete_datafeed/examples/request/MlDeleteDatafeedExample1.yaml b/specification/ml/delete_datafeed/examples/request/MlDeleteDatafeedExample1.yaml new file mode 100644 index 0000000000..86cb00fa59 --- /dev/null +++ b/specification/ml/delete_datafeed/examples/request/MlDeleteDatafeedExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _ml/datafeeds/datafeed-total-requests diff --git a/specification/ml/delete_expired_data/examples/request/MlDeleteExpiredDataExample1.yaml b/specification/ml/delete_expired_data/examples/request/MlDeleteExpiredDataExample1.yaml new file mode 100644 index 0000000000..2effc4042c --- /dev/null +++ b/specification/ml/delete_expired_data/examples/request/MlDeleteExpiredDataExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _ml/_delete_expired_data?timeout=1h diff --git a/specification/ml/delete_filter/examples/request/MlDeleteFilterExample1.yaml b/specification/ml/delete_filter/examples/request/MlDeleteFilterExample1.yaml new file mode 100644 index 0000000000..8a61ae8bdd --- /dev/null +++ b/specification/ml/delete_filter/examples/request/MlDeleteFilterExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _ml/filters/safe_domains diff --git a/specification/ml/delete_forecast/examples/request/MlDeleteForecastExample1.yaml b/specification/ml/delete_forecast/examples/request/MlDeleteForecastExample1.yaml new file mode 100644 index 0000000000..b8069fc90f --- /dev/null +++ b/specification/ml/delete_forecast/examples/request/MlDeleteForecastExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _ml/anomaly_detectors/total-requests/_forecast/_all diff --git a/specification/ml/delete_job/examples/request/MlDeleteJobExample1.yaml b/specification/ml/delete_job/examples/request/MlDeleteJobExample1.yaml new file mode 100644 index 0000000000..a996042090 --- /dev/null +++ b/specification/ml/delete_job/examples/request/MlDeleteJobExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _ml/anomaly_detectors/total-requests diff --git a/specification/ml/delete_model_snapshot/examples/request/MlDeleteModelSnapshotExample1.yaml b/specification/ml/delete_model_snapshot/examples/request/MlDeleteModelSnapshotExample1.yaml new file mode 100644 index 0000000000..36617a5bc6 --- /dev/null +++ b/specification/ml/delete_model_snapshot/examples/request/MlDeleteModelSnapshotExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _ml/anomaly_detectors/farequote/model_snapshots/1491948163 diff --git a/specification/ml/delete_trained_model/examples/request/MlDeleteTrainedModelExample1.yaml b/specification/ml/delete_trained_model/examples/request/MlDeleteTrainedModelExample1.yaml new file mode 100644 index 0000000000..36f643b4da --- /dev/null +++ b/specification/ml/delete_trained_model/examples/request/MlDeleteTrainedModelExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _ml/trained_models/regression-job-one-1574775307356 diff --git a/specification/ml/delete_trained_model_alias/examples/request/MlDeleteTrainedModelAliasExample1.yaml b/specification/ml/delete_trained_model_alias/examples/request/MlDeleteTrainedModelAliasExample1.yaml new file mode 100644 index 0000000000..cfba1b00b5 --- /dev/null +++ b/specification/ml/delete_trained_model_alias/examples/request/MlDeleteTrainedModelAliasExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _ml/trained_models/flight-delay-prediction-1574775339910/model_aliases/flight_delay_model diff --git a/specification/ml/estimate_model_memory/examples/response/MlEstimateModelMemoryResponseExample1.yaml b/specification/ml/estimate_model_memory/examples/response/MlEstimateModelMemoryResponseExample1.yaml index fbd1661597..fcdde1e7f7 100644 --- a/specification/ml/estimate_model_memory/examples/response/MlEstimateModelMemoryResponseExample1.yaml +++ b/specification/ml/estimate_model_memory/examples/response/MlEstimateModelMemoryResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST _ml/anomaly_detectors/_estimate_model_memory description: A successful response from `POST _ml/anomaly_detectors/_estimate_model_memory`. # type: response # response_code: 200 diff --git a/specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseExample1.yaml b/specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseExample1.yaml index 43cf9a304f..f6a8617597 100644 --- a/specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseExample1.yaml +++ b/specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseExample1.yaml @@ -1,5 +1,4 @@ summary: Classification example 1 -method_request: POST _ml/data_frame/_evaluate description: > A succesful response from `POST _ml/data_frame/_evaluate` to evaluate a classification analysis job for an annotated index. The `actual_class` contains the name of the class the analysis tried to predict. diff --git a/specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseExample2.yaml b/specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseExample2.yaml index 3390eb6976..9099b3f9d0 100644 --- a/specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseExample2.yaml +++ b/specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseExample2.yaml @@ -1,5 +1,4 @@ summary: Classification example 2 -method_request: POST _ml/data_frame/_evaluate description: > A succesful response from `POST _ml/data_frame/_evaluate` to evaluate a classification analysis job with the AUC ROC metrics for an annotated index. # type: response diff --git a/specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseExample3.yaml b/specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseExample3.yaml index f37e3f5cce..7f1d54cfd9 100644 --- a/specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseExample3.yaml +++ b/specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseExample3.yaml @@ -1,5 +1,4 @@ summary: Outlier detection -method_request: POST _ml/data_frame/_evaluate description: A successful response from `POST _ml/data_frame/_evaluate` to evaluate an outlier detection job. # type: response # response_code: 200 diff --git a/specification/ml/flush_job/examples/request/MlFlushJobExample1.yaml b/specification/ml/flush_job/examples/request/MlFlushJobExample1.yaml new file mode 100644 index 0000000000..21e1dbd2b6 --- /dev/null +++ b/specification/ml/flush_job/examples/request/MlFlushJobExample1.yaml @@ -0,0 +1,6 @@ +method_request: POST _ml/anomaly_detectors/low_request_rate/_flush +description: An example body for a `POST _ml/anomaly_detectors/low_request_rate/_flush` request. +value: |- + { + "calc_interim": true + } diff --git a/specification/ml/forecast/examples/request/MlForecastExample1.yaml b/specification/ml/forecast/examples/request/MlForecastExample1.yaml new file mode 100644 index 0000000000..2e2dc3dc63 --- /dev/null +++ b/specification/ml/forecast/examples/request/MlForecastExample1.yaml @@ -0,0 +1,6 @@ +method_request: POST _ml/anomaly_detectors/low_request_rate/_forecast +description: An example body for a `POST _ml/anomaly_detectors/low_request_rate/_forecast` request. +value: |- + { + "duration": "10d" + } diff --git a/specification/ml/get_buckets/examples/request/MlGetBucketsExample1.yaml b/specification/ml/get_buckets/examples/request/MlGetBucketsExample1.yaml new file mode 100644 index 0000000000..85002c44c3 --- /dev/null +++ b/specification/ml/get_buckets/examples/request/MlGetBucketsExample1.yaml @@ -0,0 +1,7 @@ +method_request: GET _ml/anomaly_detectors/low_request_rate/results/buckets +description: An example body for a `GET _ml/anomaly_detectors/low_request_rate/results/buckets` request. +value: |- + { + "anomaly_score": 80, + "start": "1454530200001" + } diff --git a/specification/ml/get_calendar_events/examples/request/MlGetCalendarEventsExample1.yaml b/specification/ml/get_calendar_events/examples/request/MlGetCalendarEventsExample1.yaml new file mode 100644 index 0000000000..2271588bc5 --- /dev/null +++ b/specification/ml/get_calendar_events/examples/request/MlGetCalendarEventsExample1.yaml @@ -0,0 +1 @@ +method_request: GET _ml/calendars/planned-outages/events diff --git a/specification/ml/get_calendars/examples/request/MlGetCalendarsExample1.yaml b/specification/ml/get_calendars/examples/request/MlGetCalendarsExample1.yaml new file mode 100644 index 0000000000..7964e0844d --- /dev/null +++ b/specification/ml/get_calendars/examples/request/MlGetCalendarsExample1.yaml @@ -0,0 +1 @@ +method_request: GET _ml/calendars/planned-outages diff --git a/specification/ml/get_categories/examples/request/MlGetCategoriesExample1.yaml b/specification/ml/get_categories/examples/request/MlGetCategoriesExample1.yaml new file mode 100644 index 0000000000..31dd82d9fa --- /dev/null +++ b/specification/ml/get_categories/examples/request/MlGetCategoriesExample1.yaml @@ -0,0 +1,8 @@ +method_request: GET _ml/anomaly_detectors/esxi_log/results/categories +description: An example body for a `GET _ml/anomaly_detectors/esxi_log/results/categories` request. +value: |- + { + "page":{ + "size": 1 + } + } diff --git a/specification/ml/get_data_frame_analytics/examples/request/MlGetDataFrameAnalyticsExample1.yaml b/specification/ml/get_data_frame_analytics/examples/request/MlGetDataFrameAnalyticsExample1.yaml new file mode 100644 index 0000000000..d87c068be6 --- /dev/null +++ b/specification/ml/get_data_frame_analytics/examples/request/MlGetDataFrameAnalyticsExample1.yaml @@ -0,0 +1 @@ +method_request: GET _ml/data_frame/analytics/loganalytics diff --git a/specification/ml/get_data_frame_analytics_stats/examples/request/MlGetDataFrameAnalyticsStatsExample1.yaml b/specification/ml/get_data_frame_analytics_stats/examples/request/MlGetDataFrameAnalyticsStatsExample1.yaml new file mode 100644 index 0000000000..bfab4a796b --- /dev/null +++ b/specification/ml/get_data_frame_analytics_stats/examples/request/MlGetDataFrameAnalyticsStatsExample1.yaml @@ -0,0 +1 @@ +method_request: GET _ml/data_frame/analytics/weblog-outliers/_stats diff --git a/specification/ml/get_datafeed_stats/examples/request/MlGetDatafeedStatsExample1.yaml b/specification/ml/get_datafeed_stats/examples/request/MlGetDatafeedStatsExample1.yaml new file mode 100644 index 0000000000..4022e01353 --- /dev/null +++ b/specification/ml/get_datafeed_stats/examples/request/MlGetDatafeedStatsExample1.yaml @@ -0,0 +1 @@ +method_request: GET _ml/datafeeds/datafeed-high_sum_total_sales/_stats diff --git a/specification/ml/get_datafeeds/examples/request/MlGetDatafeedsExample1.yaml b/specification/ml/get_datafeeds/examples/request/MlGetDatafeedsExample1.yaml new file mode 100644 index 0000000000..bd31d72579 --- /dev/null +++ b/specification/ml/get_datafeeds/examples/request/MlGetDatafeedsExample1.yaml @@ -0,0 +1 @@ +method_request: GET _ml/datafeeds/datafeed-high_sum_total_sales diff --git a/specification/ml/get_filters/examples/request/MlGetFiltersExample1.yaml b/specification/ml/get_filters/examples/request/MlGetFiltersExample1.yaml new file mode 100644 index 0000000000..41c8454cc2 --- /dev/null +++ b/specification/ml/get_filters/examples/request/MlGetFiltersExample1.yaml @@ -0,0 +1 @@ +method_request: GET _ml/filters/safe_domains diff --git a/specification/ml/get_influencers/examples/request/MlGetInfluencersExample1.yaml b/specification/ml/get_influencers/examples/request/MlGetInfluencersExample1.yaml new file mode 100644 index 0000000000..0bb4c9f2b1 --- /dev/null +++ b/specification/ml/get_influencers/examples/request/MlGetInfluencersExample1.yaml @@ -0,0 +1,7 @@ +method_request: GET _ml/anomaly_detectors/high_sum_total_sales/results/influencers +description: An example body for a `GET _ml/anomaly_detectors/high_sum_total_sales/results/influencers` request. +value: |- + { + "sort": "influencer_score", + "desc": true + } diff --git a/specification/ml/get_job_stats/examples/request/MlGetJobStatsExample1.yaml b/specification/ml/get_job_stats/examples/request/MlGetJobStatsExample1.yaml new file mode 100644 index 0000000000..992d5eb383 --- /dev/null +++ b/specification/ml/get_job_stats/examples/request/MlGetJobStatsExample1.yaml @@ -0,0 +1 @@ +method_request: GET _ml/anomaly_detectors/low_request_rate/_stats diff --git a/specification/ml/get_jobs/examples/request/MlGetJobsExample1.yaml b/specification/ml/get_jobs/examples/request/MlGetJobsExample1.yaml new file mode 100644 index 0000000000..5edb88e3ff --- /dev/null +++ b/specification/ml/get_jobs/examples/request/MlGetJobsExample1.yaml @@ -0,0 +1 @@ +method_request: GET _ml/anomaly_detectors/high_sum_total_sales diff --git a/specification/ml/get_memory_stats/examples/request/MlGetMemoryStatsExample1.yaml b/specification/ml/get_memory_stats/examples/request/MlGetMemoryStatsExample1.yaml new file mode 100644 index 0000000000..d96eea698e --- /dev/null +++ b/specification/ml/get_memory_stats/examples/request/MlGetMemoryStatsExample1.yaml @@ -0,0 +1 @@ +method_request: GET _ml/memory/_stats?human diff --git a/specification/ml/get_model_snapshot_upgrade_stats/examples/request/MlGetModelSnapshotUpgradeStatsExample1.yaml b/specification/ml/get_model_snapshot_upgrade_stats/examples/request/MlGetModelSnapshotUpgradeStatsExample1.yaml new file mode 100644 index 0000000000..42473e9e83 --- /dev/null +++ b/specification/ml/get_model_snapshot_upgrade_stats/examples/request/MlGetModelSnapshotUpgradeStatsExample1.yaml @@ -0,0 +1 @@ +method_request: GET _ml/anomaly_detectors/low_request_rate/model_snapshots/_all/_upgrade/_stats diff --git a/specification/ml/get_model_snapshots/examples/request/MlGetModelSnapshotsExample1.yaml b/specification/ml/get_model_snapshots/examples/request/MlGetModelSnapshotsExample1.yaml new file mode 100644 index 0000000000..5d9f0959b4 --- /dev/null +++ b/specification/ml/get_model_snapshots/examples/request/MlGetModelSnapshotsExample1.yaml @@ -0,0 +1,6 @@ +method_request: GET _ml/anomaly_detectors/high_sum_total_sales/model_snapshots +description: An example body for a `GET _ml/anomaly_detectors/high_sum_total_sales/model_snapshots` request. +value: |- + { + "start": "1575402236000" + } diff --git a/specification/ml/get_overall_buckets/examples/request/MlGetOverallBucketsExample1.yaml b/specification/ml/get_overall_buckets/examples/request/MlGetOverallBucketsExample1.yaml new file mode 100644 index 0000000000..3fd53f76b4 --- /dev/null +++ b/specification/ml/get_overall_buckets/examples/request/MlGetOverallBucketsExample1.yaml @@ -0,0 +1,7 @@ +method_request: GET _ml/anomaly_detectors/job-*/results/overall_buckets +description: An example body for a `GET _ml/anomaly_detectors/job-*/results/overall_buckets` request. +value: |- + { + "overall_score": 80, + "start": "1403532000000" + } diff --git a/specification/ml/get_records/examples/request/MlGetRecordsExample1.yaml b/specification/ml/get_records/examples/request/MlGetRecordsExample1.yaml new file mode 100644 index 0000000000..78968584d7 --- /dev/null +++ b/specification/ml/get_records/examples/request/MlGetRecordsExample1.yaml @@ -0,0 +1,8 @@ +method_request: GET _ml/anomaly_detectors/low_request_rate/results/records +description: An example body for a `GET _ml/anomaly_detectors/low_request_rate/results/records` request. +value: |- + { + "sort": "record_score", + "desc": true, + "start": "1454944100000" + } diff --git a/specification/ml/get_trained_models/examples/request/MlGetTrainedModelsExample1.yaml b/specification/ml/get_trained_models/examples/request/MlGetTrainedModelsExample1.yaml new file mode 100644 index 0000000000..6de7522ab6 --- /dev/null +++ b/specification/ml/get_trained_models/examples/request/MlGetTrainedModelsExample1.yaml @@ -0,0 +1 @@ +method_request: GET _ml/trained_models/ diff --git a/specification/ml/get_trained_models_stats/examples/request/MlGetTrainedModelsStatsExample1.yaml b/specification/ml/get_trained_models_stats/examples/request/MlGetTrainedModelsStatsExample1.yaml new file mode 100644 index 0000000000..f0367abf92 --- /dev/null +++ b/specification/ml/get_trained_models_stats/examples/request/MlGetTrainedModelsStatsExample1.yaml @@ -0,0 +1 @@ +method_request: GET _ml/trained_models/_stats diff --git a/specification/ml/infer_trained_model/examples/request/MlInferTrainedModelExample1.yaml b/specification/ml/infer_trained_model/examples/request/MlInferTrainedModelExample1.yaml new file mode 100644 index 0000000000..1688659f03 --- /dev/null +++ b/specification/ml/infer_trained_model/examples/request/MlInferTrainedModelExample1.yaml @@ -0,0 +1,6 @@ +method_request: POST _ml/trained_models/lang_ident_model_1/_infer +description: An example body for a `POST _ml/trained_models/lang_ident_model_1/_infer` request. +value: |- + { + "docs":[{"text": "The fool doth think he is wise, but the wise man knows himself to be a fool."}] + } diff --git a/specification/ml/info/examples/request/MlInfoExample1.yaml b/specification/ml/info/examples/request/MlInfoExample1.yaml new file mode 100644 index 0000000000..a32dec1f8d --- /dev/null +++ b/specification/ml/info/examples/request/MlInfoExample1.yaml @@ -0,0 +1 @@ +method_request: GET _ml/info diff --git a/specification/ml/post_calendar_events/examples/request/MlPostCalendarEventsExample1.yaml b/specification/ml/post_calendar_events/examples/request/MlPostCalendarEventsExample1.yaml new file mode 100644 index 0000000000..9235c4c7d8 --- /dev/null +++ b/specification/ml/post_calendar_events/examples/request/MlPostCalendarEventsExample1.yaml @@ -0,0 +1,10 @@ +method_request: POST _ml/calendars/planned-outages/events +description: An example body for a `POST _ml/calendars/planned-outages/events` request. +value: |- + { + "events" : [ + {"description": "event 1", "start_time": 1513641600000, "end_time": 1513728000000}, + {"description": "event 2", "start_time": 1513814400000, "end_time": 1513900800000}, + {"description": "event 3", "start_time": 1514160000000, "end_time": 1514246400000} + ] + } diff --git a/specification/ml/preview_data_frame_analytics/examples/request/MlPreviewDataFrameAnalyticsExample1.yaml b/specification/ml/preview_data_frame_analytics/examples/request/MlPreviewDataFrameAnalyticsExample1.yaml new file mode 100644 index 0000000000..cd481962f9 --- /dev/null +++ b/specification/ml/preview_data_frame_analytics/examples/request/MlPreviewDataFrameAnalyticsExample1.yaml @@ -0,0 +1,15 @@ +method_request: POST _ml/data_frame/analytics/_preview +description: An example body for a `POST _ml/data_frame/analytics/_preview` request. +value: |- + { + "config": { + "source": { + "index": "houses_sold_last_10_yrs" + }, + "analysis": { + "regression": { + "dependent_variable": "price" + } + } + } + } diff --git a/specification/ml/preview_datafeed/examples/request/MlPreviewDatafeedExample1.yaml b/specification/ml/preview_datafeed/examples/request/MlPreviewDatafeedExample1.yaml new file mode 100644 index 0000000000..59b54791fa --- /dev/null +++ b/specification/ml/preview_datafeed/examples/request/MlPreviewDatafeedExample1.yaml @@ -0,0 +1 @@ +method_request: GET _ml/datafeeds/datafeed-high_sum_total_sales/_preview diff --git a/specification/ml/put_calendar/examples/request/MlPutCalendarExample1.yaml b/specification/ml/put_calendar/examples/request/MlPutCalendarExample1.yaml new file mode 100644 index 0000000000..a566a5aaca --- /dev/null +++ b/specification/ml/put_calendar/examples/request/MlPutCalendarExample1.yaml @@ -0,0 +1 @@ +method_request: PUT _ml/calendars/planned-outages diff --git a/specification/ml/put_calendar_job/examples/request/MlPutCalendarJobExample1.yaml b/specification/ml/put_calendar_job/examples/request/MlPutCalendarJobExample1.yaml new file mode 100644 index 0000000000..d380156208 --- /dev/null +++ b/specification/ml/put_calendar_job/examples/request/MlPutCalendarJobExample1.yaml @@ -0,0 +1 @@ +method_request: PUT _ml/calendars/planned-outages/jobs/total-requests diff --git a/specification/ml/put_data_frame_analytics/examples/request/MlPutDataFrameAnalyticsExample1.yaml b/specification/ml/put_data_frame_analytics/examples/request/MlPutDataFrameAnalyticsExample1.yaml new file mode 100644 index 0000000000..266d059d4c --- /dev/null +++ b/specification/ml/put_data_frame_analytics/examples/request/MlPutDataFrameAnalyticsExample1.yaml @@ -0,0 +1,41 @@ +method_request: PUT _ml/data_frame/analytics/model-flight-delays-pre +description: An example body for a `PUT _ml/data_frame/analytics/model-flight-delays-pre` request. +value: |- + { + "source": { + "index": [ + "kibana_sample_data_flights" + ], + "query": { + "range": { + "DistanceKilometers": { + "gt": 0 + } + } + }, + "_source": { + "includes": [], + "excludes": [ + "FlightDelay", + "FlightDelayType" + ] + } + }, + "dest": { + "index": "df-flight-delays", + "results_field": "ml-results" + }, + "analysis": { + "regression": { + "dependent_variable": "FlightDelayMin", + "training_percent": 90 + } + }, + "analyzed_fields": { + "includes": [], + "excludes": [ + "FlightNum" + ] + }, + "model_memory_limit": "100mb" + } diff --git a/specification/ml/put_datafeed/examples/request/MlPutDatafeedExample1.yaml b/specification/ml/put_datafeed/examples/request/MlPutDatafeedExample1.yaml new file mode 100644 index 0000000000..8dcb37a8b2 --- /dev/null +++ b/specification/ml/put_datafeed/examples/request/MlPutDatafeedExample1.yaml @@ -0,0 +1,18 @@ +method_request: PUT _ml/datafeeds/datafeed-test-job?pretty +description: An example body for a `PUT _ml/datafeeds/datafeed-test-job?pretty` request. +value: |- + { + "indices": [ + "kibana_sample_data_logs" + ], + "query": { + "bool": { + "must": [ + { + "match_all": {} + } + ] + } + }, + "job_id": "test-job" + } diff --git a/specification/ml/put_filter/examples/request/MlPutFilterExample1.yaml b/specification/ml/put_filter/examples/request/MlPutFilterExample1.yaml new file mode 100644 index 0000000000..36a56f9989 --- /dev/null +++ b/specification/ml/put_filter/examples/request/MlPutFilterExample1.yaml @@ -0,0 +1,7 @@ +method_request: PUT _ml/filters/safe_domains +description: An example body for a `PUT _ml/filters/safe_domains` request. +value: |- + { + "description": "A list of safe domains", + "items": ["*.google.com", "wikipedia.org"] + } diff --git a/specification/ml/put_trained_model_alias/examples/request/MlPutTrainedModelAliasExample1.yaml b/specification/ml/put_trained_model_alias/examples/request/MlPutTrainedModelAliasExample1.yaml new file mode 100644 index 0000000000..50b8336929 --- /dev/null +++ b/specification/ml/put_trained_model_alias/examples/request/MlPutTrainedModelAliasExample1.yaml @@ -0,0 +1 @@ +method_request: PUT _ml/trained_models/flight-delay-prediction-1574775339910/model_aliases/flight_delay_model diff --git a/specification/ml/put_trained_model_definition_part/examples/request/MlPutTrainedModelDefinitionPartExample1.yaml b/specification/ml/put_trained_model_definition_part/examples/request/MlPutTrainedModelDefinitionPartExample1.yaml new file mode 100644 index 0000000000..e3ee1da7db --- /dev/null +++ b/specification/ml/put_trained_model_definition_part/examples/request/MlPutTrainedModelDefinitionPartExample1.yaml @@ -0,0 +1,8 @@ +method_request: PUT _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/definition/0 +description: An example body for a `PUT _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/definition/0` request. +value: |- + { + "definition": "...", + "total_definition_length": 265632637, + "total_parts": 64 + } diff --git a/specification/ml/put_trained_model_vocabulary/examples/request/MlPutTrainedModelVocabularyExample1.yaml b/specification/ml/put_trained_model_vocabulary/examples/request/MlPutTrainedModelVocabularyExample1.yaml new file mode 100644 index 0000000000..c1fd6ac8a6 --- /dev/null +++ b/specification/ml/put_trained_model_vocabulary/examples/request/MlPutTrainedModelVocabularyExample1.yaml @@ -0,0 +1,10 @@ +method_request: PUT _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/vocabulary +description: An example body for a `PUT _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/vocabulary` request. +value: |- + { + "vocabulary": [ + "[PAD]", + "[unused0]", + ... + ] + } diff --git a/specification/ml/reset_job/examples/request/MlResetJobExample1.yaml b/specification/ml/reset_job/examples/request/MlResetJobExample1.yaml new file mode 100644 index 0000000000..60909463d9 --- /dev/null +++ b/specification/ml/reset_job/examples/request/MlResetJobExample1.yaml @@ -0,0 +1 @@ +method_request: POST _ml/anomaly_detectors/total-requests/_reset diff --git a/specification/ml/revert_model_snapshot/examples/request/MlRevertModelSnapshotExample1.yaml b/specification/ml/revert_model_snapshot/examples/request/MlRevertModelSnapshotExample1.yaml new file mode 100644 index 0000000000..be5b441ba5 --- /dev/null +++ b/specification/ml/revert_model_snapshot/examples/request/MlRevertModelSnapshotExample1.yaml @@ -0,0 +1,6 @@ +method_request: POST _ml/anomaly_detectors/low_request_rate/model_snapshots/1637092688/_revert +description: An example body for a `POST _ml/anomaly_detectors/low_request_rate/model_snapshots/1637092688/_revert` request. +value: |- + { + "delete_intervening_results": true + } diff --git a/specification/ml/set_upgrade_mode/examples/request/MlSetUpgradeModeExample1.yaml b/specification/ml/set_upgrade_mode/examples/request/MlSetUpgradeModeExample1.yaml new file mode 100644 index 0000000000..e17ca2f2a5 --- /dev/null +++ b/specification/ml/set_upgrade_mode/examples/request/MlSetUpgradeModeExample1.yaml @@ -0,0 +1 @@ +method_request: POST _ml/set_upgrade_mode?enabled=true diff --git a/specification/ml/start_data_frame_analytics/examples/request/MlStartDataFrameAnalyticsExample1.yaml b/specification/ml/start_data_frame_analytics/examples/request/MlStartDataFrameAnalyticsExample1.yaml new file mode 100644 index 0000000000..74653e7a8b --- /dev/null +++ b/specification/ml/start_data_frame_analytics/examples/request/MlStartDataFrameAnalyticsExample1.yaml @@ -0,0 +1 @@ +method_request: POST _ml/data_frame/analytics/loganalytics/_start diff --git a/specification/ml/start_datafeed/examples/request/MlStartDatafeedExample1.yaml b/specification/ml/start_datafeed/examples/request/MlStartDatafeedExample1.yaml new file mode 100644 index 0000000000..561f5e64cc --- /dev/null +++ b/specification/ml/start_datafeed/examples/request/MlStartDatafeedExample1.yaml @@ -0,0 +1,6 @@ +method_request: POST _ml/datafeeds/datafeed-low_request_rate/_start +description: An example body for a `POST _ml/datafeeds/datafeed-low_request_rate/_start` request. +value: |- + { + "start": "2019-04-07T18:22:16Z" + } diff --git a/specification/ml/start_trained_model_deployment/examples/request/MlStartTrainedModelDeploymentExample1.yaml b/specification/ml/start_trained_model_deployment/examples/request/MlStartTrainedModelDeploymentExample1.yaml new file mode 100644 index 0000000000..bde8ed0c79 --- /dev/null +++ b/specification/ml/start_trained_model_deployment/examples/request/MlStartTrainedModelDeploymentExample1.yaml @@ -0,0 +1 @@ +method_request: POST _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/_start?wait_for=started&timeout=1m diff --git a/specification/ml/stop_data_frame_analytics/examples/request/MlStopDataFrameAnalyticsExample1.yaml b/specification/ml/stop_data_frame_analytics/examples/request/MlStopDataFrameAnalyticsExample1.yaml new file mode 100644 index 0000000000..819d809f82 --- /dev/null +++ b/specification/ml/stop_data_frame_analytics/examples/request/MlStopDataFrameAnalyticsExample1.yaml @@ -0,0 +1 @@ +method_request: POST _ml/data_frame/analytics/loganalytics/_stop diff --git a/specification/ml/stop_datafeed/examples/request/MlStopDatafeedExample1.yaml b/specification/ml/stop_datafeed/examples/request/MlStopDatafeedExample1.yaml new file mode 100644 index 0000000000..e13b090a8a --- /dev/null +++ b/specification/ml/stop_datafeed/examples/request/MlStopDatafeedExample1.yaml @@ -0,0 +1,6 @@ +method_request: POST _ml/datafeeds/datafeed-low_request_rate/_stop +description: An example body for a `POST _ml/datafeeds/datafeed-low_request_rate/_stop` request. +value: |- + { + "timeout": "30s" + } diff --git a/specification/ml/stop_trained_model_deployment/examples/request/MlStopTrainedModelDeploymentExample1.yaml b/specification/ml/stop_trained_model_deployment/examples/request/MlStopTrainedModelDeploymentExample1.yaml new file mode 100644 index 0000000000..74d933d369 --- /dev/null +++ b/specification/ml/stop_trained_model_deployment/examples/request/MlStopTrainedModelDeploymentExample1.yaml @@ -0,0 +1 @@ +method_request: POST _ml/trained_models/my_model_for_search/deployment/_stop diff --git a/specification/ml/update_data_frame_analytics/examples/request/MlUpdateDataFrameAnalyticsExample1.yaml b/specification/ml/update_data_frame_analytics/examples/request/MlUpdateDataFrameAnalyticsExample1.yaml new file mode 100644 index 0000000000..9820aa0787 --- /dev/null +++ b/specification/ml/update_data_frame_analytics/examples/request/MlUpdateDataFrameAnalyticsExample1.yaml @@ -0,0 +1,6 @@ +method_request: POST _ml/data_frame/analytics/loganalytics/_update +description: An example body for a `POST _ml/data_frame/analytics/loganalytics/_update` request. +value: |- + { + "model_memory_limit": "200mb" + } diff --git a/specification/ml/update_datafeed/examples/request/MlUpdateDatafeedExample1.yaml b/specification/ml/update_datafeed/examples/request/MlUpdateDatafeedExample1.yaml new file mode 100644 index 0000000000..5d50e3fdba --- /dev/null +++ b/specification/ml/update_datafeed/examples/request/MlUpdateDatafeedExample1.yaml @@ -0,0 +1,10 @@ +method_request: POST _ml/datafeeds/datafeed-test-job/_update +description: An example body for a `POST _ml/datafeeds/datafeed-test-job/_update` request. +value: |- + { + "query": { + "term": { + "geo.src": "US" + } + } + } diff --git a/specification/ml/update_filter/examples/request/MlUpdateFilterExample1.yaml b/specification/ml/update_filter/examples/request/MlUpdateFilterExample1.yaml new file mode 100644 index 0000000000..1bb685211b --- /dev/null +++ b/specification/ml/update_filter/examples/request/MlUpdateFilterExample1.yaml @@ -0,0 +1,8 @@ +method_request: POST _ml/filters/safe_domains/_update +description: An example body for a `POST _ml/filters/safe_domains/_update` request. +value: |- + { + "description": "Updated list of domains", + "add_items": ["*.myorg.com"], + "remove_items": ["wikipedia.org"] + } diff --git a/specification/ml/update_job/examples/request/MlUpdateJobExample1.yaml b/specification/ml/update_job/examples/request/MlUpdateJobExample1.yaml new file mode 100644 index 0000000000..8d8a616b0a --- /dev/null +++ b/specification/ml/update_job/examples/request/MlUpdateJobExample1.yaml @@ -0,0 +1,18 @@ +method_request: POST _ml/anomaly_detectors/low_request_rate/_update +description: An example body for a `POST _ml/anomaly_detectors/low_request_rate/_update` request. +value: |- + { + "description":"An updated job", + "detectors": { + "detector_index": 0, + "description": "An updated detector description" + }, + "groups": ["kibana_sample_data","kibana_sample_web_logs"], + "model_plot_config": { + "enabled": true + }, + "renormalization_window_days": 30, + "background_persist_interval": "2h", + "model_snapshot_retention_days": 7, + "results_retention_days": 60 + } diff --git a/specification/ml/update_model_snapshot/examples/request/MlUpdateModelSnapshotExample1.yaml b/specification/ml/update_model_snapshot/examples/request/MlUpdateModelSnapshotExample1.yaml new file mode 100644 index 0000000000..2659e93d4b --- /dev/null +++ b/specification/ml/update_model_snapshot/examples/request/MlUpdateModelSnapshotExample1.yaml @@ -0,0 +1,8 @@ +method_request: POST +description: An example body for a `POST` request. +value: |- + _ml/anomaly_detectors/it_ops_new_logs/model_snapshots/1491852978/_update + { + "description": "Snapshot 1", + "retain": true + } diff --git a/specification/ml/update_trained_model_deployment/examples/request/MlUpdateTrainedModelDeploymentExample1.yaml b/specification/ml/update_trained_model_deployment/examples/request/MlUpdateTrainedModelDeploymentExample1.yaml new file mode 100644 index 0000000000..814bdba109 --- /dev/null +++ b/specification/ml/update_trained_model_deployment/examples/request/MlUpdateTrainedModelDeploymentExample1.yaml @@ -0,0 +1,6 @@ +method_request: POST _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/_update +description: An example body for a `POST _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/_update` request. +value: |- + { + "number_of_allocations": 4 + } diff --git a/specification/ml/upgrade_job_snapshot/examples/request/MlUpgradeJobSnapshotExample1.yaml b/specification/ml/upgrade_job_snapshot/examples/request/MlUpgradeJobSnapshotExample1.yaml new file mode 100644 index 0000000000..e7d136c0c7 --- /dev/null +++ b/specification/ml/upgrade_job_snapshot/examples/request/MlUpgradeJobSnapshotExample1.yaml @@ -0,0 +1 @@ +method_request: POST _ml/anomaly_detectors/low_request_rate/model_snapshots/1828371/_upgrade?timeout=45m&wait_for_completion=true diff --git a/specification/nodes/hot_threads/examples/request/NodesHotThreadsExample1.yaml b/specification/nodes/hot_threads/examples/request/NodesHotThreadsExample1.yaml new file mode 100644 index 0000000000..376e42d32d --- /dev/null +++ b/specification/nodes/hot_threads/examples/request/NodesHotThreadsExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_nodes/hot_threads diff --git a/specification/nodes/info/examples/request/NodesInfoExample1.yaml b/specification/nodes/info/examples/request/NodesInfoExample1.yaml new file mode 100644 index 0000000000..9f78ea319c --- /dev/null +++ b/specification/nodes/info/examples/request/NodesInfoExample1.yaml @@ -0,0 +1 @@ +method_request: GET _nodes/_all/jvm diff --git a/specification/nodes/stats/examples/request/NodesStatsExample1.yaml b/specification/nodes/stats/examples/request/NodesStatsExample1.yaml new file mode 100644 index 0000000000..530ddd65ef --- /dev/null +++ b/specification/nodes/stats/examples/request/NodesStatsExample1.yaml @@ -0,0 +1 @@ +method_request: GET _nodes/stats/process?filter_path=**.max_file_descriptors diff --git a/specification/nodes/usage/examples/request/NodesUsageExample1.yaml b/specification/nodes/usage/examples/request/NodesUsageExample1.yaml new file mode 100644 index 0000000000..6c9b6fc2bc --- /dev/null +++ b/specification/nodes/usage/examples/request/NodesUsageExample1.yaml @@ -0,0 +1 @@ +method_request: GET _nodes/usage diff --git a/specification/query_rules/delete_rule/examples/request/QueryRulesDeleteRuleExample1.yaml b/specification/query_rules/delete_rule/examples/request/QueryRulesDeleteRuleExample1.yaml new file mode 100644 index 0000000000..65711f5067 --- /dev/null +++ b/specification/query_rules/delete_rule/examples/request/QueryRulesDeleteRuleExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _query_rules/my-ruleset/_rule/my-rule1 diff --git a/specification/query_rules/delete_ruleset/examples/request/QueryRulesDeleteRulesetExample1.yaml b/specification/query_rules/delete_ruleset/examples/request/QueryRulesDeleteRulesetExample1.yaml new file mode 100644 index 0000000000..60b70ddf05 --- /dev/null +++ b/specification/query_rules/delete_ruleset/examples/request/QueryRulesDeleteRulesetExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _query_rules/my-ruleset/ diff --git a/specification/query_rules/get_rule/examples/request/QueryRuleGetRequestExample1.yaml b/specification/query_rules/get_rule/examples/request/QueryRuleGetRequestExample1.yaml new file mode 100644 index 0000000000..3cf7b6f67a --- /dev/null +++ b/specification/query_rules/get_rule/examples/request/QueryRuleGetRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _query_rules/my-ruleset/_rule/my-rule1 diff --git a/specification/query_rules/get_rule/examples/response/QueryRuleGetResponseExample1.yaml b/specification/query_rules/get_rule/examples/response/QueryRuleGetResponseExample1.yaml index 140bf0be59..aea10dc43d 100644 --- a/specification/query_rules/get_rule/examples/response/QueryRuleGetResponseExample1.yaml +++ b/specification/query_rules/get_rule/examples/response/QueryRuleGetResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET _query_rules/my-ruleset/_rule/my-rule1 description: A successful response from `GET _query_rules/my-ruleset/_rule/my-rule1`. # type: response # response_code: '' diff --git a/specification/query_rules/get_ruleset/examples/request/QueryRulesetGetRequestExample1.yaml b/specification/query_rules/get_ruleset/examples/request/QueryRulesetGetRequestExample1.yaml new file mode 100644 index 0000000000..f22fa12d34 --- /dev/null +++ b/specification/query_rules/get_ruleset/examples/request/QueryRulesetGetRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _query_rules/my-ruleset/ diff --git a/specification/query_rules/get_ruleset/examples/response/QueryRulesetGetResponseExample1.yaml b/specification/query_rules/get_ruleset/examples/response/QueryRulesetGetResponseExample1.yaml index 5b41f9ac8f..dbb772266e 100644 --- a/specification/query_rules/get_ruleset/examples/response/QueryRulesetGetResponseExample1.yaml +++ b/specification/query_rules/get_ruleset/examples/response/QueryRulesetGetResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET _query_rules/my-ruleset/ description: A successful response from `GET _query_rules/my-ruleset/`. # type: response # response_code: '' diff --git a/specification/query_rules/list_rulesets/examples/request/QueryRulesetListRequestExample1.yaml b/specification/query_rules/list_rulesets/examples/request/QueryRulesetListRequestExample1.yaml new file mode 100644 index 0000000000..46e42c3046 --- /dev/null +++ b/specification/query_rules/list_rulesets/examples/request/QueryRulesetListRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _query_rules/?from=0&size=3 diff --git a/specification/query_rules/list_rulesets/examples/response/QueryRulesetListResponseExample1.yaml b/specification/query_rules/list_rulesets/examples/response/QueryRulesetListResponseExample1.yaml index fcf61f78e3..1162cea1d8 100644 --- a/specification/query_rules/list_rulesets/examples/response/QueryRulesetListResponseExample1.yaml +++ b/specification/query_rules/list_rulesets/examples/response/QueryRulesetListResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET _query_rules/?from=0&size=3 description: A successful response from `GET _query_rules/?from=0&size=3`. # type: response # response_code: '' diff --git a/specification/query_rules/test/examples/response/QueryRulesetTestResponseExample1.yaml b/specification/query_rules/test/examples/response/QueryRulesetTestResponseExample1.yaml index 902717c7b8..4a6f26543f 100644 --- a/specification/query_rules/test/examples/response/QueryRulesetTestResponseExample1.yaml +++ b/specification/query_rules/test/examples/response/QueryRulesetTestResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST _query_rules/my-ruleset/_test description: A successful response from `POST _query_rules/my-ruleset/_test`. # type: response # response_code: '' diff --git a/specification/rollup/delete_job/examples/request/DeleteRollupJobRequestExample1.yaml b/specification/rollup/delete_job/examples/request/DeleteRollupJobRequestExample1.yaml new file mode 100644 index 0000000000..4e29cf1351 --- /dev/null +++ b/specification/rollup/delete_job/examples/request/DeleteRollupJobRequestExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _rollup/job/sensor diff --git a/specification/rollup/delete_job/examples/response/DeleteRollupJobResponseExample1.yaml b/specification/rollup/delete_job/examples/response/DeleteRollupJobResponseExample1.yaml index 0987bb30c9..9f0f6242f6 100644 --- a/specification/rollup/delete_job/examples/response/DeleteRollupJobResponseExample1.yaml +++ b/specification/rollup/delete_job/examples/response/DeleteRollupJobResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: DELETE _rollup/job/sensor description: A successful response from `DELETE _rollup/job/sensor`. # type: response # response_code: '' diff --git a/specification/rollup/get_jobs/examples/request/GetRollupJobRequestExample1.yaml b/specification/rollup/get_jobs/examples/request/GetRollupJobRequestExample1.yaml new file mode 100644 index 0000000000..fc03b7a60e --- /dev/null +++ b/specification/rollup/get_jobs/examples/request/GetRollupJobRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _rollup/job/sensor diff --git a/specification/rollup/get_jobs/examples/response/GetRollupJobResponseExample1.yaml b/specification/rollup/get_jobs/examples/response/GetRollupJobResponseExample1.yaml index e76add8400..fc41b704f4 100644 --- a/specification/rollup/get_jobs/examples/response/GetRollupJobResponseExample1.yaml +++ b/specification/rollup/get_jobs/examples/response/GetRollupJobResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET _rollup/job/sensor description: A successful response from `GET _rollup/job/sensor`. # type: response # response_code: '' diff --git a/specification/rollup/get_rollup_caps/examples/request/GetRollupCapabilitiesRequestExample1.yaml b/specification/rollup/get_rollup_caps/examples/request/GetRollupCapabilitiesRequestExample1.yaml new file mode 100644 index 0000000000..2ddfc8ee9c --- /dev/null +++ b/specification/rollup/get_rollup_caps/examples/request/GetRollupCapabilitiesRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _rollup/data/sensor-* diff --git a/specification/rollup/get_rollup_caps/examples/response/GetRollupCapabilitiesResponseExample1.yaml b/specification/rollup/get_rollup_caps/examples/response/GetRollupCapabilitiesResponseExample1.yaml index 4ce6edf20c..b9d56cf47c 100644 --- a/specification/rollup/get_rollup_caps/examples/response/GetRollupCapabilitiesResponseExample1.yaml +++ b/specification/rollup/get_rollup_caps/examples/response/GetRollupCapabilitiesResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET _rollup/data/sensor-* description: > A successful response from `GET _rollup/data/sensor-*` for a rollup job that targets the index pattern `sensor-*`. The response contains the rollup job ID, the index that holds the rolled data, and the index pattern that the job was targeting. diff --git a/specification/rollup/get_rollup_index_caps/examples/request/GetRollupIndexCapabilitiesRequestExample1.yaml b/specification/rollup/get_rollup_index_caps/examples/request/GetRollupIndexCapabilitiesRequestExample1.yaml new file mode 100644 index 0000000000..01b9d8fe31 --- /dev/null +++ b/specification/rollup/get_rollup_index_caps/examples/request/GetRollupIndexCapabilitiesRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /sensor_rollup/_rollup/data diff --git a/specification/rollup/get_rollup_index_caps/examples/response/GetRollupIndexCapabilitiesResponseExample1.yaml b/specification/rollup/get_rollup_index_caps/examples/response/GetRollupIndexCapabilitiesResponseExample1.yaml index 6c496327bc..485eb10400 100644 --- a/specification/rollup/get_rollup_index_caps/examples/response/GetRollupIndexCapabilitiesResponseExample1.yaml +++ b/specification/rollup/get_rollup_index_caps/examples/response/GetRollupIndexCapabilitiesResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /sensor_rollup/_rollup/data description: > A successful response from `GET /sensor_rollup/_rollup/data`. The response contains the rollup job ID, the index that holds the rolled data, and the index pattern that the job was targeting. diff --git a/specification/rollup/rollup_search/examples/response/RollupSearchResponseExample1.yaml b/specification/rollup/rollup_search/examples/response/RollupSearchResponseExample1.yaml index 78f38ce10d..cc8717ada1 100644 --- a/specification/rollup/rollup_search/examples/response/RollupSearchResponseExample1.yaml +++ b/specification/rollup/rollup_search/examples/response/RollupSearchResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /sensor_rollup/_rollup_search description: > An abbreviated response from `GET /sensor_rollup/_rollup_search` with a `max` aggregation on a `temperature` field. The response provides some metadata about the request (`took`, `_shards`), the search hits (which is always empty for rollup searches), and the aggregation response. diff --git a/specification/rollup/start_job/examples/request/StartRollupJobRequestExample1.yaml b/specification/rollup/start_job/examples/request/StartRollupJobRequestExample1.yaml new file mode 100644 index 0000000000..8ddfdb7299 --- /dev/null +++ b/specification/rollup/start_job/examples/request/StartRollupJobRequestExample1.yaml @@ -0,0 +1 @@ +method_request: POST _rollup/job/sensor/_start diff --git a/specification/rollup/start_job/examples/response/StartRollupJobResponseExample1.yaml b/specification/rollup/start_job/examples/response/StartRollupJobResponseExample1.yaml index 4510676e00..0c48123d6f 100644 --- a/specification/rollup/start_job/examples/response/StartRollupJobResponseExample1.yaml +++ b/specification/rollup/start_job/examples/response/StartRollupJobResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST _rollup/job/sensor/_start description: A successful response from `POST _rollup/job/sensor/_start`. # type: response # response_code: '' diff --git a/specification/rollup/stop_job/examples/request/RollupStopJobExample1.yaml b/specification/rollup/stop_job/examples/request/RollupStopJobExample1.yaml new file mode 100644 index 0000000000..40619f2064 --- /dev/null +++ b/specification/rollup/stop_job/examples/request/RollupStopJobExample1.yaml @@ -0,0 +1 @@ +method_request: POST _rollup/job/sensor/_stop?wait_for_completion=true&timeout=10s diff --git a/specification/search_application/delete/examples/request/SearchApplicationDeleteExample1.yaml b/specification/search_application/delete/examples/request/SearchApplicationDeleteExample1.yaml new file mode 100644 index 0000000000..7798b430d6 --- /dev/null +++ b/specification/search_application/delete/examples/request/SearchApplicationDeleteExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _application/search_application/my-app/ diff --git a/specification/search_application/delete_behavioral_analytics/examples/request/SearchApplicationDeleteBehavioralAnalyticsExample1.yaml b/specification/search_application/delete_behavioral_analytics/examples/request/SearchApplicationDeleteBehavioralAnalyticsExample1.yaml new file mode 100644 index 0000000000..4e5eda09a5 --- /dev/null +++ b/specification/search_application/delete_behavioral_analytics/examples/request/SearchApplicationDeleteBehavioralAnalyticsExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _application/analytics/my_analytics_collection/ diff --git a/specification/search_application/get/examples/200_response/SearchApplicationGetResponseExample1.yaml b/specification/search_application/get/examples/200_response/SearchApplicationGetResponseExample1.yaml index b2baa15c7a..da6b1463ce 100644 --- a/specification/search_application/get/examples/200_response/SearchApplicationGetResponseExample1.yaml +++ b/specification/search_application/get/examples/200_response/SearchApplicationGetResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: search-application/apis/get-search-application.asciidoc:95 -method_request: GET _application/search_application/my-app/ description: A sucessful response from `GET _application/search_application/my-app/`. # type: response # response_code: 200 diff --git a/specification/search_application/get/examples/request/SearchApplicationGetRequestExample1.yaml b/specification/search_application/get/examples/request/SearchApplicationGetRequestExample1.yaml new file mode 100644 index 0000000000..3e3bbd8ce3 --- /dev/null +++ b/specification/search_application/get/examples/request/SearchApplicationGetRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _application/search_application/my-app/ diff --git a/specification/search_application/get_behavioral_analytics/examples/200_response/BehavioralAnalyticsGetResponseExample1.yaml b/specification/search_application/get_behavioral_analytics/examples/200_response/BehavioralAnalyticsGetResponseExample1.yaml index 5058033043..824701b1ab 100644 --- a/specification/search_application/get_behavioral_analytics/examples/200_response/BehavioralAnalyticsGetResponseExample1.yaml +++ b/specification/search_application/get_behavioral_analytics/examples/200_response/BehavioralAnalyticsGetResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: behavioral-analytics/apis/list-analytics-collection.asciidoc:112 -method_request: GET _application/analytics/my* description: A successful response from `GET _application/analytics/my*` # type: response # response_code: 200 diff --git a/specification/search_application/get_behavioral_analytics/examples/request/BehavioralAnalyticsGetRequestExample1.yaml b/specification/search_application/get_behavioral_analytics/examples/request/BehavioralAnalyticsGetRequestExample1.yaml new file mode 100644 index 0000000000..072e6eb801 --- /dev/null +++ b/specification/search_application/get_behavioral_analytics/examples/request/BehavioralAnalyticsGetRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _application/analytics/my* diff --git a/specification/search_application/list/examples/200_response/SearchApplicationsListResponseExample1.yaml b/specification/search_application/list/examples/200_response/SearchApplicationsListResponseExample1.yaml index bc0c1fcc2b..f9d79d87fe 100644 --- a/specification/search_application/list/examples/200_response/SearchApplicationsListResponseExample1.yaml +++ b/specification/search_application/list/examples/200_response/SearchApplicationsListResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: search-application/apis/list-search-applications.asciidoc:108 -method_request: GET _application/search_application?from=0&size=3&q=app* description: A succesful response from `GET _application/search_application?from=0&size=3&q=app*` returns the first three search applications whose names start with `app`. # type: response # response_code: 200 diff --git a/specification/search_application/list/examples/request/SearchApplicationsListRequestExample1.yaml b/specification/search_application/list/examples/request/SearchApplicationsListRequestExample1.yaml new file mode 100644 index 0000000000..16096a75a2 --- /dev/null +++ b/specification/search_application/list/examples/request/SearchApplicationsListRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _application/search_application?from=0&size=3&q=app* diff --git a/specification/search_application/put_behavioral_analytics/examples/request/SearchApplicationPutBehavioralAnalyticsExample1.yaml b/specification/search_application/put_behavioral_analytics/examples/request/SearchApplicationPutBehavioralAnalyticsExample1.yaml new file mode 100644 index 0000000000..4aaf67d23a --- /dev/null +++ b/specification/search_application/put_behavioral_analytics/examples/request/SearchApplicationPutBehavioralAnalyticsExample1.yaml @@ -0,0 +1 @@ +method_request: PUT _application/analytics/my_analytics_collection diff --git a/specification/searchable_snapshots/cache_stats/examples/request/CacheStatsRequestExample1.yaml b/specification/searchable_snapshots/cache_stats/examples/request/CacheStatsRequestExample1.yaml new file mode 100644 index 0000000000..f42d35458a --- /dev/null +++ b/specification/searchable_snapshots/cache_stats/examples/request/CacheStatsRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_searchable_snapshots/cache/stats diff --git a/specification/searchable_snapshots/cache_stats/examples/response/CacheStatsResponseExample1.yaml b/specification/searchable_snapshots/cache_stats/examples/response/CacheStatsResponseExample1.yaml index dc68c43af2..fac5613207 100644 --- a/specification/searchable_snapshots/cache_stats/examples/response/CacheStatsResponseExample1.yaml +++ b/specification/searchable_snapshots/cache_stats/examples/response/CacheStatsResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_searchable_snapshots/cache/stats description: A successful response from `GET /_searchable_snapshots/cache/stats`. # type: response # response_code: 200 diff --git a/specification/searchable_snapshots/clear_cache/examples/request/SearchableSnapshotsClearCacheExample1.yaml b/specification/searchable_snapshots/clear_cache/examples/request/SearchableSnapshotsClearCacheExample1.yaml new file mode 100644 index 0000000000..39b7c88abf --- /dev/null +++ b/specification/searchable_snapshots/clear_cache/examples/request/SearchableSnapshotsClearCacheExample1.yaml @@ -0,0 +1 @@ +method_request: POST /my-index/_searchable_snapshots/cache/clear diff --git a/specification/searchable_snapshots/stats/examples/request/SearchableSnapshotsStatsExample1.yaml b/specification/searchable_snapshots/stats/examples/request/SearchableSnapshotsStatsExample1.yaml new file mode 100644 index 0000000000..b87278903e --- /dev/null +++ b/specification/searchable_snapshots/stats/examples/request/SearchableSnapshotsStatsExample1.yaml @@ -0,0 +1 @@ +method_request: GET /my-index/_searchable_snapshots/stats diff --git a/specification/security/activate_user_profile/examples/response/ActivateUserProfileResponseExample1.yaml b/specification/security/activate_user_profile/examples/response/ActivateUserProfileResponseExample1.yaml index cd82cb536d..f2d0e5b456 100644 --- a/specification/security/activate_user_profile/examples/response/ActivateUserProfileResponseExample1.yaml +++ b/specification/security/activate_user_profile/examples/response/ActivateUserProfileResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /_security/profile/_activate description: A successful response from `POST /_security/profile/_activate`. # type: response # response_code: diff --git a/specification/security/authenticate/examples/request/SecurityAuthenticateRequestExample1.yaml b/specification/security/authenticate/examples/request/SecurityAuthenticateRequestExample1.yaml new file mode 100644 index 0000000000..ac8802f5a3 --- /dev/null +++ b/specification/security/authenticate/examples/request/SecurityAuthenticateRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_security/_authenticate diff --git a/specification/security/authenticate/examples/response/SecurityAuthenticateResponseExample1.yaml b/specification/security/authenticate/examples/response/SecurityAuthenticateResponseExample1.yaml index 33b9ae9ba8..fba200c641 100644 --- a/specification/security/authenticate/examples/response/SecurityAuthenticateResponseExample1.yaml +++ b/specification/security/authenticate/examples/response/SecurityAuthenticateResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_security/_authenticate description: A successful response from `GET /_security/_authenticate`. # type: response # response_code: 200 diff --git a/specification/security/bulk_delete_role/examples/response/SecurityBulkDeleteRoleResponseExample1.yaml b/specification/security/bulk_delete_role/examples/response/SecurityBulkDeleteRoleResponseExample1.yaml index 6f44a800b3..549defa88a 100644 --- a/specification/security/bulk_delete_role/examples/response/SecurityBulkDeleteRoleResponseExample1.yaml +++ b/specification/security/bulk_delete_role/examples/response/SecurityBulkDeleteRoleResponseExample1.yaml @@ -1,5 +1,4 @@ summary: A successful response -method_request: DELETE /_security/role description: A successful response from `DELETE /_security/role`. # type: response # response_code: diff --git a/specification/security/bulk_delete_role/examples/response/SecurityBulkDeleteRoleResponseExample2.yaml b/specification/security/bulk_delete_role/examples/response/SecurityBulkDeleteRoleResponseExample2.yaml index 0faa70c348..d4085d2896 100644 --- a/specification/security/bulk_delete_role/examples/response/SecurityBulkDeleteRoleResponseExample2.yaml +++ b/specification/security/bulk_delete_role/examples/response/SecurityBulkDeleteRoleResponseExample2.yaml @@ -1,5 +1,4 @@ summary: A response with not_found roles -method_request: DELETE /_security/role description: > A partially successful response from `DELETE /_security/role`. If a role cannot be found, it appears in the `not_found` list in the response. diff --git a/specification/security/bulk_delete_role/examples/response/SecurityBulkDeleteRoleResponseExample3.yaml b/specification/security/bulk_delete_role/examples/response/SecurityBulkDeleteRoleResponseExample3.yaml index 744be21553..802e9acfd7 100644 --- a/specification/security/bulk_delete_role/examples/response/SecurityBulkDeleteRoleResponseExample3.yaml +++ b/specification/security/bulk_delete_role/examples/response/SecurityBulkDeleteRoleResponseExample3.yaml @@ -1,5 +1,4 @@ summary: A response with errors -method_request: DELETE /_security/role description: > A partially successful response from `DELETE /_security/role`. If part of a request fails or is invalid, the response includes `errors`. diff --git a/specification/security/bulk_put_role/examples/response/SecurityBulkPutRoleResponseExample1.yaml b/specification/security/bulk_put_role/examples/response/SecurityBulkPutRoleResponseExample1.yaml index 994a60e21a..57cad901da 100644 --- a/specification/security/bulk_put_role/examples/response/SecurityBulkPutRoleResponseExample1.yaml +++ b/specification/security/bulk_put_role/examples/response/SecurityBulkPutRoleResponseExample1.yaml @@ -1,5 +1,4 @@ summary: A successful response -method_request: POST /_security/role/my_admin_role description: > A successful response from `POST /_security/role/my_admin_role` returns a JSON structure that shows whether the role has been created, updated, or had no changes made. # type: response diff --git a/specification/security/bulk_put_role/examples/response/SecurityBulkPutRoleResponseExample2.yaml b/specification/security/bulk_put_role/examples/response/SecurityBulkPutRoleResponseExample2.yaml index 8e3ac3a4e1..3a8acd2f74 100644 --- a/specification/security/bulk_put_role/examples/response/SecurityBulkPutRoleResponseExample2.yaml +++ b/specification/security/bulk_put_role/examples/response/SecurityBulkPutRoleResponseExample2.yaml @@ -1,5 +1,4 @@ summary: A partially successful response -method_request: POST /_security/role description: > A partially successful response from `POST /_security/role`. Errors are handled individually for each role create or update, thus the API allows partial success. diff --git a/specification/security/clear_api_key_cache/examples/request/SecurityClearApiKeyCacheExample1.yaml b/specification/security/clear_api_key_cache/examples/request/SecurityClearApiKeyCacheExample1.yaml new file mode 100644 index 0000000000..19ca296a6b --- /dev/null +++ b/specification/security/clear_api_key_cache/examples/request/SecurityClearApiKeyCacheExample1.yaml @@ -0,0 +1 @@ +method_request: POST /_security/api_key/yVGMr3QByxdh1MSaicYx/_clear_cache diff --git a/specification/security/clear_cached_privileges/examples/request/SecurityClearCachedPrivilegesExample1.yaml b/specification/security/clear_cached_privileges/examples/request/SecurityClearCachedPrivilegesExample1.yaml new file mode 100644 index 0000000000..b824f2eb42 --- /dev/null +++ b/specification/security/clear_cached_privileges/examples/request/SecurityClearCachedPrivilegesExample1.yaml @@ -0,0 +1 @@ +method_request: POST /_security/privilege/myapp/_clear_cache diff --git a/specification/security/clear_cached_realms/examples/request/SecurityClearCachedRealmsExample1.yaml b/specification/security/clear_cached_realms/examples/request/SecurityClearCachedRealmsExample1.yaml new file mode 100644 index 0000000000..d47612457f --- /dev/null +++ b/specification/security/clear_cached_realms/examples/request/SecurityClearCachedRealmsExample1.yaml @@ -0,0 +1 @@ +method_request: POST /_security/realm/default_file/_clear_cache diff --git a/specification/security/clear_cached_roles/examples/request/SecurityClearCachedRolesExample1.yaml b/specification/security/clear_cached_roles/examples/request/SecurityClearCachedRolesExample1.yaml new file mode 100644 index 0000000000..d98c3ab756 --- /dev/null +++ b/specification/security/clear_cached_roles/examples/request/SecurityClearCachedRolesExample1.yaml @@ -0,0 +1 @@ +method_request: POST /_security/role/my_admin_role/_clear_cache diff --git a/specification/security/clear_cached_service_tokens/examples/request/SecurityClearCachedServiceTokensExample1.yaml b/specification/security/clear_cached_service_tokens/examples/request/SecurityClearCachedServiceTokensExample1.yaml new file mode 100644 index 0000000000..717478f44a --- /dev/null +++ b/specification/security/clear_cached_service_tokens/examples/request/SecurityClearCachedServiceTokensExample1.yaml @@ -0,0 +1 @@ +method_request: POST /_security/service/elastic/fleet-server/credential/token/token1/_clear_cache diff --git a/specification/security/create_api_key/examples/response/SecurityCreateApiKeyResponseExample1.yaml b/specification/security/create_api_key/examples/response/SecurityCreateApiKeyResponseExample1.yaml index eb7039935f..000184e2ff 100644 --- a/specification/security/create_api_key/examples/response/SecurityCreateApiKeyResponseExample1.yaml +++ b/specification/security/create_api_key/examples/response/SecurityCreateApiKeyResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /_security/api_key description: A successful response from `POST /_security/api_key`. # type: response # response_code: 200 diff --git a/specification/security/create_cross_cluster_api_key/examples/response/CreateCrossClusterApiKeyResponseExample1.yaml b/specification/security/create_cross_cluster_api_key/examples/response/CreateCrossClusterApiKeyResponseExample1.yaml index 775a4a8ef1..63a86c2cf3 100644 --- a/specification/security/create_cross_cluster_api_key/examples/response/CreateCrossClusterApiKeyResponseExample1.yaml +++ b/specification/security/create_cross_cluster_api_key/examples/response/CreateCrossClusterApiKeyResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /_security/service/elastic/fleet-server/credential/token description: > A successful response from `POST /_security/service/elastic/fleet-server/credential/token`. # type: response diff --git a/specification/security/create_service_token/examples/request/CreateServiceTokenRequestExample1.yaml b/specification/security/create_service_token/examples/request/CreateServiceTokenRequestExample1.yaml new file mode 100644 index 0000000000..a7e9b60c85 --- /dev/null +++ b/specification/security/create_service_token/examples/request/CreateServiceTokenRequestExample1.yaml @@ -0,0 +1 @@ +method_request: POST /_security/service/elastic/fleet-server/credential/token/token1 diff --git a/specification/security/create_service_token/examples/response/CreateServiceTokenRequestExample1.yaml b/specification/security/create_service_token/examples/response/CreateServiceTokenRequestExample1.yaml index 37068f3701..4931e3f95d 100644 --- a/specification/security/create_service_token/examples/response/CreateServiceTokenRequestExample1.yaml +++ b/specification/security/create_service_token/examples/response/CreateServiceTokenRequestExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /_security/service/elastic/fleet-server/credential/token/token1 description: > A successful response from `POST /_security/service/elastic/fleet-server/credential/token/token1`. The response includes the service account token, its name, and its secret value as a bearer token. diff --git a/specification/security/delete_privileges/examples/request/SecurityDeletePrivilegesRequestExample1.yaml b/specification/security/delete_privileges/examples/request/SecurityDeletePrivilegesRequestExample1.yaml new file mode 100644 index 0000000000..82493c1cf2 --- /dev/null +++ b/specification/security/delete_privileges/examples/request/SecurityDeletePrivilegesRequestExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE /_security/privilege/myapp/read diff --git a/specification/security/delete_privileges/examples/response/SecurityDeletePrivilegesResponseExample1.yaml b/specification/security/delete_privileges/examples/response/SecurityDeletePrivilegesResponseExample1.yaml index 1a08b0d0f5..0df3f3433d 100644 --- a/specification/security/delete_privileges/examples/response/SecurityDeletePrivilegesResponseExample1.yaml +++ b/specification/security/delete_privileges/examples/response/SecurityDeletePrivilegesResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: DELETE /_security/privilege/myapp/read description: > A successful response from `DELETE /_security/privilege/myapp/read`. If the privilege is successfully deleted, `found` is set to `true`. diff --git a/specification/security/delete_role/examples/request/SecurityDeleteRoleRequestExample1.yaml b/specification/security/delete_role/examples/request/SecurityDeleteRoleRequestExample1.yaml new file mode 100644 index 0000000000..2d33c5033a --- /dev/null +++ b/specification/security/delete_role/examples/request/SecurityDeleteRoleRequestExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE /_security/role/my_admin_role diff --git a/specification/security/delete_role/examples/response/SecurityDeleteRoleResponseExample1.yaml b/specification/security/delete_role/examples/response/SecurityDeleteRoleResponseExample1.yaml index 8588f119ae..2fec9e3f06 100644 --- a/specification/security/delete_role/examples/response/SecurityDeleteRoleResponseExample1.yaml +++ b/specification/security/delete_role/examples/response/SecurityDeleteRoleResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: DELETE /_security/role/my_admin_role description: > A successful response from `DELETE /_security/role/my_admin_role`. If the role is successfully deleted, `found` is set to `true`. diff --git a/specification/security/delete_role_mapping/examples/request/SecurityDeleteRoleMappingRequestExample1.yaml b/specification/security/delete_role_mapping/examples/request/SecurityDeleteRoleMappingRequestExample1.yaml new file mode 100644 index 0000000000..0844e2ce99 --- /dev/null +++ b/specification/security/delete_role_mapping/examples/request/SecurityDeleteRoleMappingRequestExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE /_security/role_mapping/mapping1 diff --git a/specification/security/delete_role_mapping/examples/response/SecurityDeleteRoleMappingResponseExample1.yaml b/specification/security/delete_role_mapping/examples/response/SecurityDeleteRoleMappingResponseExample1.yaml index d03193ac28..6156aa5aee 100644 --- a/specification/security/delete_role_mapping/examples/response/SecurityDeleteRoleMappingResponseExample1.yaml +++ b/specification/security/delete_role_mapping/examples/response/SecurityDeleteRoleMappingResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: DELETE /_security/role_mapping/mapping1 description: > A successful response from `DELETE /_security/role_mapping/mapping1`. If the mapping is successfully deleted, `found` is `true`. diff --git a/specification/security/delete_service_token/examples/request/DeleteServiceTokenRequestExample1.yaml b/specification/security/delete_service_token/examples/request/DeleteServiceTokenRequestExample1.yaml new file mode 100644 index 0000000000..e072e81aa8 --- /dev/null +++ b/specification/security/delete_service_token/examples/request/DeleteServiceTokenRequestExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE /_security/service/elastic/fleet-server/credential/token/token42 diff --git a/specification/security/delete_service_token/examples/response/DeleteServiceTokenResponseExample1.yaml b/specification/security/delete_service_token/examples/response/DeleteServiceTokenResponseExample1.yaml index ef0f3c1547..29e099621f 100644 --- a/specification/security/delete_service_token/examples/response/DeleteServiceTokenResponseExample1.yaml +++ b/specification/security/delete_service_token/examples/response/DeleteServiceTokenResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: DELETE /_security/service/elastic/fleet-server/credential/token/token42 description: > A successful response from `DELETE /_security/service/elastic/fleet-server/credential/token/token42`. # type: response diff --git a/specification/security/delete_user/examples/request/SecurityDeleteUserRequestExample1.yaml b/specification/security/delete_user/examples/request/SecurityDeleteUserRequestExample1.yaml new file mode 100644 index 0000000000..51f768bda3 --- /dev/null +++ b/specification/security/delete_user/examples/request/SecurityDeleteUserRequestExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE /_security/user/jacknich diff --git a/specification/security/delete_user/examples/response/SecurityDeleteUserResponseExample1.yaml b/specification/security/delete_user/examples/response/SecurityDeleteUserResponseExample1.yaml index c1d8b4fd78..55bf5cccb6 100644 --- a/specification/security/delete_user/examples/response/SecurityDeleteUserResponseExample1.yaml +++ b/specification/security/delete_user/examples/response/SecurityDeleteUserResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: DELETE /_security/user/jacknich description: > A successful response from `DELETE /_security/user/jacknich`. # type: response diff --git a/specification/security/disable_user/examples/request/SecurityDisableUserExample1.yaml b/specification/security/disable_user/examples/request/SecurityDisableUserExample1.yaml new file mode 100644 index 0000000000..9b277ada09 --- /dev/null +++ b/specification/security/disable_user/examples/request/SecurityDisableUserExample1.yaml @@ -0,0 +1 @@ +method_request: PUT /_security/user/jacknich/_disable diff --git a/specification/security/disable_user_profile/examples/request/SecurityDisableUserProfileExample1.yaml b/specification/security/disable_user_profile/examples/request/SecurityDisableUserProfileExample1.yaml new file mode 100644 index 0000000000..5a913badc6 --- /dev/null +++ b/specification/security/disable_user_profile/examples/request/SecurityDisableUserProfileExample1.yaml @@ -0,0 +1 @@ +method_request: POST /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0/_disable diff --git a/specification/security/enable_user/examples/request/SecurityEnableUserExample1.yaml b/specification/security/enable_user/examples/request/SecurityEnableUserExample1.yaml new file mode 100644 index 0000000000..4e9a5b5a4b --- /dev/null +++ b/specification/security/enable_user/examples/request/SecurityEnableUserExample1.yaml @@ -0,0 +1 @@ +method_request: PUT _security/user/logstash_system/_enable diff --git a/specification/security/enable_user_profile/examples/request/SecurityEnableUserProfileExample1.yaml b/specification/security/enable_user_profile/examples/request/SecurityEnableUserProfileExample1.yaml new file mode 100644 index 0000000000..0eb63f53b1 --- /dev/null +++ b/specification/security/enable_user_profile/examples/request/SecurityEnableUserProfileExample1.yaml @@ -0,0 +1 @@ +method_request: POST /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0/_enable diff --git a/specification/security/enroll_kibana/examples/request/EnrollKibanaRequestExample1.yaml b/specification/security/enroll_kibana/examples/request/EnrollKibanaRequestExample1.yaml new file mode 100644 index 0000000000..f9d13d8221 --- /dev/null +++ b/specification/security/enroll_kibana/examples/request/EnrollKibanaRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_security/enroll/kibana diff --git a/specification/security/enroll_kibana/examples/response/EnrollKibanaResponseExample1.yaml b/specification/security/enroll_kibana/examples/response/EnrollKibanaResponseExample1.yaml index ce7f0814fe..db74d609c4 100644 --- a/specification/security/enroll_kibana/examples/response/EnrollKibanaResponseExample1.yaml +++ b/specification/security/enroll_kibana/examples/response/EnrollKibanaResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_security/enroll/kibana description: A successful response from `GET /_security/enroll/kibana`. # type: response # response_code: diff --git a/specification/security/get_api_key/examples/request/SecurityGetApiKeyRequestExample2.yaml b/specification/security/get_api_key/examples/request/SecurityGetApiKeyRequestExample2.yaml new file mode 100644 index 0000000000..d01a5d4562 --- /dev/null +++ b/specification/security/get_api_key/examples/request/SecurityGetApiKeyRequestExample2.yaml @@ -0,0 +1 @@ +method_request: GET /_security/api_key?username=myuser&realm_name=native1 diff --git a/specification/security/get_api_key/examples/response/SecurityGetApiKeyResponseExample1.yaml b/specification/security/get_api_key/examples/response/SecurityGetApiKeyResponseExample1.yaml index f4a5a9846d..b3a7a08630 100644 --- a/specification/security/get_api_key/examples/response/SecurityGetApiKeyResponseExample1.yaml +++ b/specification/security/get_api_key/examples/response/SecurityGetApiKeyResponseExample1.yaml @@ -1,5 +1,4 @@ summary: Get a key by ID -method_request: GET /_security/api_key?id=VuaCfGcBCdbkQm-e5aOx&with_limited_by=true description: A successful response from `GET /_security/api_key?id=VuaCfGcBCdbkQm-e5aOx&with_limited_by=true`. # type: response # response_code: diff --git a/specification/security/get_api_key/examples/response/SecurityGetApiKeyResponseExample2.yaml b/specification/security/get_api_key/examples/response/SecurityGetApiKeyResponseExample2.yaml index 647fa74092..fd5234d570 100644 --- a/specification/security/get_api_key/examples/response/SecurityGetApiKeyResponseExample2.yaml +++ b/specification/security/get_api_key/examples/response/SecurityGetApiKeyResponseExample2.yaml @@ -1,5 +1,4 @@ summary: Get all keys for a user -method_request: GET /_security/api_key?username=myuser&realm_name=native1 description: > A successful response from `GET /_security/api_key?username=myuser&realm_name=native1`. The response contains all API keys for the user `myuser` in the `native1` realm. diff --git a/specification/security/get_builtin_privileges/examples/request/SecurityGetBuiltinPrivilegesRequestExample1.yaml b/specification/security/get_builtin_privileges/examples/request/SecurityGetBuiltinPrivilegesRequestExample1.yaml new file mode 100644 index 0000000000..f2787c15c6 --- /dev/null +++ b/specification/security/get_builtin_privileges/examples/request/SecurityGetBuiltinPrivilegesRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_security/privilege/_builtin diff --git a/specification/security/get_builtin_privileges/examples/response/SecurityGetBuiltinPrivilegesResponseExample1.yaml b/specification/security/get_builtin_privileges/examples/response/SecurityGetBuiltinPrivilegesResponseExample1.yaml index db4c53da65..90a9d86e91 100644 --- a/specification/security/get_builtin_privileges/examples/response/SecurityGetBuiltinPrivilegesResponseExample1.yaml +++ b/specification/security/get_builtin_privileges/examples/response/SecurityGetBuiltinPrivilegesResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_security/privilege/_builtin description: A successful response from `GET /_security/privilege/_builtin`. # type: response # response_code: diff --git a/specification/security/get_privileges/examples/request/SecurityGetPrivilegesRequestExample1.yaml b/specification/security/get_privileges/examples/request/SecurityGetPrivilegesRequestExample1.yaml new file mode 100644 index 0000000000..e88cd1e08d --- /dev/null +++ b/specification/security/get_privileges/examples/request/SecurityGetPrivilegesRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_security/privilege/myapp/read diff --git a/specification/security/get_privileges/examples/response/SecurityGetPrivilegesResponseExample1.yaml b/specification/security/get_privileges/examples/response/SecurityGetPrivilegesResponseExample1.yaml index d3fe56bc0f..f7decac520 100644 --- a/specification/security/get_privileges/examples/response/SecurityGetPrivilegesResponseExample1.yaml +++ b/specification/security/get_privileges/examples/response/SecurityGetPrivilegesResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_security/privilege/myapp/read description: > A successful response from `GET /_security/privilege/myapp/read`. The response contains information about the `read` privilege for the `app01` application. diff --git a/specification/security/get_role/examples/request/SecurityGetRoleRequestExample1.yaml b/specification/security/get_role/examples/request/SecurityGetRoleRequestExample1.yaml new file mode 100644 index 0000000000..49df6d76a6 --- /dev/null +++ b/specification/security/get_role/examples/request/SecurityGetRoleRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_security/role/my_admin_role diff --git a/specification/security/get_role/examples/response/SecurityGetRoleResponseExample1.yaml b/specification/security/get_role/examples/response/SecurityGetRoleResponseExample1.yaml index 4b3c157e27..ee4a9165f4 100644 --- a/specification/security/get_role/examples/response/SecurityGetRoleResponseExample1.yaml +++ b/specification/security/get_role/examples/response/SecurityGetRoleResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_security/role/my_admin_role description: > A successful response from `GET /_security/role/my_admin_role`. The response contains information about the `my_admin_role` role in the native realm. diff --git a/specification/security/get_role_mapping/examples/request/SecurityGetRoleMappingRequestExample1.yaml b/specification/security/get_role_mapping/examples/request/SecurityGetRoleMappingRequestExample1.yaml new file mode 100644 index 0000000000..49a6a976b2 --- /dev/null +++ b/specification/security/get_role_mapping/examples/request/SecurityGetRoleMappingRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_security/role_mapping/mapping1 diff --git a/specification/security/get_role_mapping/examples/response/SecurityGetRoleMappingResponseExample1.yaml b/specification/security/get_role_mapping/examples/response/SecurityGetRoleMappingResponseExample1.yaml index d8d3a73faf..30af7af5d2 100644 --- a/specification/security/get_role_mapping/examples/response/SecurityGetRoleMappingResponseExample1.yaml +++ b/specification/security/get_role_mapping/examples/response/SecurityGetRoleMappingResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_security/role_mapping/mapping1 description: A successful response from `GET /_security/role_mapping/mapping1`. # type: response # response_code: diff --git a/specification/security/get_service_accounts/examples/request/GetServiceAccountsRequestExample1.yaml b/specification/security/get_service_accounts/examples/request/GetServiceAccountsRequestExample1.yaml new file mode 100644 index 0000000000..93531186a5 --- /dev/null +++ b/specification/security/get_service_accounts/examples/request/GetServiceAccountsRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_security/service/elastic/fleet-server diff --git a/specification/security/get_service_accounts/examples/response/GetServiceAccountsResponseExample1.yaml b/specification/security/get_service_accounts/examples/response/GetServiceAccountsResponseExample1.yaml index eff26ba682..4ada7e2d8f 100644 --- a/specification/security/get_service_accounts/examples/response/GetServiceAccountsResponseExample1.yaml +++ b/specification/security/get_service_accounts/examples/response/GetServiceAccountsResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_security/service/elastic/fleet-server description: > A successful response from `GET /_security/service/elastic/fleet-server`. The response contains information about the `elastic/fleet-server` service account. diff --git a/specification/security/get_service_credentials/examples/request/GetServiceCredentialsRequestExample1.yaml b/specification/security/get_service_credentials/examples/request/GetServiceCredentialsRequestExample1.yaml new file mode 100644 index 0000000000..40c009c1a9 --- /dev/null +++ b/specification/security/get_service_credentials/examples/request/GetServiceCredentialsRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_security/service/elastic/fleet-server/credential diff --git a/specification/security/get_service_credentials/examples/response/GetServiceCredentialsResponseExample1.yaml b/specification/security/get_service_credentials/examples/response/GetServiceCredentialsResponseExample1.yaml index 166b0a8463..c975605583 100644 --- a/specification/security/get_service_credentials/examples/response/GetServiceCredentialsResponseExample1.yaml +++ b/specification/security/get_service_credentials/examples/response/GetServiceCredentialsResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_security/service/elastic/fleet-server/credential description: > A successful response from `GET /_security/service/elastic/fleet-server/credential`. The response contains all credentials for the `elastic/fleet-server` service account. diff --git a/specification/security/get_settings/examples/request/SecurityGetSettingsExample1.yaml b/specification/security/get_settings/examples/request/SecurityGetSettingsExample1.yaml new file mode 100644 index 0000000000..db30177b6a --- /dev/null +++ b/specification/security/get_settings/examples/request/SecurityGetSettingsExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_security/settings diff --git a/specification/security/get_token/examples/response/GetUserAccessTokenResponseExample1.yaml b/specification/security/get_token/examples/response/GetUserAccessTokenResponseExample1.yaml index 8f10ad5591..aeee326642 100644 --- a/specification/security/get_token/examples/response/GetUserAccessTokenResponseExample1.yaml +++ b/specification/security/get_token/examples/response/GetUserAccessTokenResponseExample1.yaml @@ -1,5 +1,4 @@ summary: A client_credentials grant type example -method_request: POST /_security/oauth2/token description: A successful response from `POST /_security/oauth2/token`. # type: response # response_code: diff --git a/specification/security/get_token/examples/response/GetUserAccessTokenResponseExample2.yaml b/specification/security/get_token/examples/response/GetUserAccessTokenResponseExample2.yaml index 86cf930a4b..fca5a225cb 100644 --- a/specification/security/get_token/examples/response/GetUserAccessTokenResponseExample2.yaml +++ b/specification/security/get_token/examples/response/GetUserAccessTokenResponseExample2.yaml @@ -1,5 +1,4 @@ summary: A password grant type example -method_request: POST /_security/oauth2/token description: A successful response from `POST /_security/oauth2/token`. # type: response # response_code: diff --git a/specification/security/get_user/examples/request/SecurityGetUserRequestExample1.yaml b/specification/security/get_user/examples/request/SecurityGetUserRequestExample1.yaml new file mode 100644 index 0000000000..71eb4c9b92 --- /dev/null +++ b/specification/security/get_user/examples/request/SecurityGetUserRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_security/user/jacknich?with_profile_uid=true diff --git a/specification/security/get_user/examples/response/SecurityGetUserResponseExample1.yaml b/specification/security/get_user/examples/response/SecurityGetUserResponseExample1.yaml index 243670b430..41a782b13b 100644 --- a/specification/security/get_user/examples/response/SecurityGetUserResponseExample1.yaml +++ b/specification/security/get_user/examples/response/SecurityGetUserResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_security/user/jacknich?with_profile_uid=true description: > A successful response from `GET /_security/user/jacknich?with_profile_uid=true`. It includes the user `profile_uid` as part of the response. diff --git a/specification/security/get_user_privileges/examples/request/SecurityGetUserPrivilegesRequestExample1.yaml b/specification/security/get_user_privileges/examples/request/SecurityGetUserPrivilegesRequestExample1.yaml new file mode 100644 index 0000000000..d5b5273802 --- /dev/null +++ b/specification/security/get_user_privileges/examples/request/SecurityGetUserPrivilegesRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_security/user/_privileges diff --git a/specification/security/get_user_privileges/examples/response/SecurityGetUserPrivilegesResponseExample1.yaml b/specification/security/get_user_privileges/examples/response/SecurityGetUserPrivilegesResponseExample1.yaml index 4f2daca5c2..ea92a83dde 100644 --- a/specification/security/get_user_privileges/examples/response/SecurityGetUserPrivilegesResponseExample1.yaml +++ b/specification/security/get_user_privileges/examples/response/SecurityGetUserPrivilegesResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_security/user/_privileges description: A successful response from `GET /_security/user/_privileges`. # type: response # response_code: diff --git a/specification/security/get_user_profile/examples/request/GetUserProfileRequestExample1.yaml b/specification/security/get_user_profile/examples/request/GetUserProfileRequestExample1.yaml new file mode 100644 index 0000000000..2c54c0f69d --- /dev/null +++ b/specification/security/get_user_profile/examples/request/GetUserProfileRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0 diff --git a/specification/security/get_user_profile/examples/response/GetUserProfileResponseExample1.yaml b/specification/security/get_user_profile/examples/response/GetUserProfileResponseExample1.yaml index 69fe40ad18..842575afb4 100644 --- a/specification/security/get_user_profile/examples/response/GetUserProfileResponseExample1.yaml +++ b/specification/security/get_user_profile/examples/response/GetUserProfileResponseExample1.yaml @@ -1,5 +1,4 @@ summary: Profile details for a UUID -method_request: GET /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0 description: > A successful response from `GET /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0`. By default, no content is returned in the `data` field. diff --git a/specification/security/get_user_profile/examples/response/GetUserProfileResponseExample2.yaml b/specification/security/get_user_profile/examples/response/GetUserProfileResponseExample2.yaml index 8fa0e93761..55c31797c4 100644 --- a/specification/security/get_user_profile/examples/response/GetUserProfileResponseExample2.yaml +++ b/specification/security/get_user_profile/examples/response/GetUserProfileResponseExample2.yaml @@ -1,5 +1,4 @@ summary: Profile details for a UUID and data key -method_request: GET /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0?data=app1.key1 description: > A successful response from `GET /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0?data=app1.key1`. # type: response diff --git a/specification/security/has_privileges/examples/response/SecurityHasPrivilegesResponseExample1.yaml b/specification/security/has_privileges/examples/response/SecurityHasPrivilegesResponseExample1.yaml index bd77e7b573..d107488f85 100644 --- a/specification/security/has_privileges/examples/response/SecurityHasPrivilegesResponseExample1.yaml +++ b/specification/security/has_privileges/examples/response/SecurityHasPrivilegesResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_security/user/_has_privileges description: A successful response from `GET /_security/user/_has_privileges`, which lists the privileges for the `rdeniro` user. # type: response # response_code: diff --git a/specification/security/has_privileges_user_profile/examples/response/HasPrivilegesUserProfileResponseExample1.yaml b/specification/security/has_privileges_user_profile/examples/response/HasPrivilegesUserProfileResponseExample1.yaml index 2dd12a30c4..1d8a647fbd 100644 --- a/specification/security/has_privileges_user_profile/examples/response/HasPrivilegesUserProfileResponseExample1.yaml +++ b/specification/security/has_privileges_user_profile/examples/response/HasPrivilegesUserProfileResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /_security/profile/_has_privileges description: > A response from `POST /_security/profile/_has_privileges` that indicates only one of the three users has all the privileges and one of them is not found. # type: response diff --git a/specification/security/invalidate_api_key/examples/response/SecurityInvalidateApiKeyResponseExample1.yaml b/specification/security/invalidate_api_key/examples/response/SecurityInvalidateApiKeyResponseExample1.yaml index 40a8117dac..963258e965 100644 --- a/specification/security/invalidate_api_key/examples/response/SecurityInvalidateApiKeyResponseExample1.yaml +++ b/specification/security/invalidate_api_key/examples/response/SecurityInvalidateApiKeyResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: DELETE /_security/api_key description: > A successful response from `DELETE /_security/api_key`. # type: response diff --git a/specification/security/invalidate_token/examples/response/SecurityInvalidateTokenResponseExample1.yaml b/specification/security/invalidate_token/examples/response/SecurityInvalidateTokenResponseExample1.yaml index 3267429592..d368a0ced9 100644 --- a/specification/security/invalidate_token/examples/response/SecurityInvalidateTokenResponseExample1.yaml +++ b/specification/security/invalidate_token/examples/response/SecurityInvalidateTokenResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: DELETE /_security/oauth2/token description: > A partially successful response from `DELETE /_security/oauth2/token`. The response includes the number of the tokens that were invalidated, the number of errors that were encountered when invalidating the tokens, and details about these errors. diff --git a/specification/security/oidc_authenticate/examples/response/OidcAuthenticateResponseExample1.yaml b/specification/security/oidc_authenticate/examples/response/OidcAuthenticateResponseExample1.yaml index 93f1ee7cab..03f05a48e6 100644 --- a/specification/security/oidc_authenticate/examples/response/OidcAuthenticateResponseExample1.yaml +++ b/specification/security/oidc_authenticate/examples/response/OidcAuthenticateResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /_security/oidc/authenticate description: > A successful response from `POST /_security/oidc/authenticate`. It contains the access and refresh tokens that were generated, the token duration (in seconds), and the type. diff --git a/specification/security/oidc_logout/examples/response/OidcLogoutResponseExample1.yaml b/specification/security/oidc_logout/examples/response/OidcLogoutResponseExample1.yaml index 4192eba966..763a5d32b0 100644 --- a/specification/security/oidc_logout/examples/response/OidcLogoutResponseExample1.yaml +++ b/specification/security/oidc_logout/examples/response/OidcLogoutResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /_security/oidc/logout description: A successful response from `POST /_security/oidc/logout`, which contains the URI pointing to the End Session Endpoint of the OpenID Connect Provider with all the parameters of the Logout Request as HTTP GET parameters. # type: response # response_code: diff --git a/specification/security/oidc_prepare_authentication/examples/response/OidcPrepareAuthenticationResponseExample1.yaml b/specification/security/oidc_prepare_authentication/examples/response/OidcPrepareAuthenticationResponseExample1.yaml index 51db2cd828..d45d2faba5 100644 --- a/specification/security/oidc_prepare_authentication/examples/response/OidcPrepareAuthenticationResponseExample1.yaml +++ b/specification/security/oidc_prepare_authentication/examples/response/OidcPrepareAuthenticationResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /_security/oidc/prepare description: > A successful response from `POST /_security/oidc/prepare`. It contains the URI pointing to the Authorization Endpoint of the OpenID Connect Provider with all the parameters of the Authentication Request as HTTP GET parameters. diff --git a/specification/security/put_privileges/examples/response/SecurityPutPrivilegesResponseExample1.yaml b/specification/security/put_privileges/examples/response/SecurityPutPrivilegesResponseExample1.yaml index 35f678a2e8..0003b8dcb1 100644 --- a/specification/security/put_privileges/examples/response/SecurityPutPrivilegesResponseExample1.yaml +++ b/specification/security/put_privileges/examples/response/SecurityPutPrivilegesResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: PUT /_security/privilege description: A successful response from `PUT /_security/privilege`. # type: response # response_code: diff --git a/specification/security/put_privileges/examples/response/SecurityPutPrivilegesResponseExample2.yaml b/specification/security/put_privileges/examples/response/SecurityPutPrivilegesResponseExample2.yaml index 441121b72e..ef4c2200de 100644 --- a/specification/security/put_privileges/examples/response/SecurityPutPrivilegesResponseExample2.yaml +++ b/specification/security/put_privileges/examples/response/SecurityPutPrivilegesResponseExample2.yaml @@ -1,5 +1,4 @@ # summary: -method_request: PUT /_security/privilege description: > A successful response from `PUT /_security/privilege`. The `created` property indicates whether the privileges have been created or updated. diff --git a/specification/security/put_role/examples/response/SecurityPutRoleResponseExample1.yaml b/specification/security/put_role/examples/response/SecurityPutRoleResponseExample1.yaml index a46804eba4..23dbc4980d 100644 --- a/specification/security/put_role/examples/response/SecurityPutRoleResponseExample1.yaml +++ b/specification/security/put_role/examples/response/SecurityPutRoleResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /_security/role/my_admin_role description: A successful response from `POST /_security/role/my_admin_role`. # type: response # response_code: diff --git a/specification/security/put_role_mapping/examples/response/SecurityPutRoleMappingResponseExample1.yaml b/specification/security/put_role_mapping/examples/response/SecurityPutRoleMappingResponseExample1.yaml index 6fe7a467bc..e46872a51a 100644 --- a/specification/security/put_role_mapping/examples/response/SecurityPutRoleMappingResponseExample1.yaml +++ b/specification/security/put_role_mapping/examples/response/SecurityPutRoleMappingResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /_security/role_mapping/mapping1 description: A successful response from `POST /_security/role_mapping/mapping1`. # type: response # response_code: diff --git a/specification/security/put_user/examples/response/SecurityPutUserResponseExample1.yaml b/specification/security/put_user/examples/response/SecurityPutUserResponseExample1.yaml index 1241c3e4fb..6874681d7d 100644 --- a/specification/security/put_user/examples/response/SecurityPutUserResponseExample1.yaml +++ b/specification/security/put_user/examples/response/SecurityPutUserResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /_security/user/jacknich description: > A successful response from `POST /_security/user/jacknich`. When an existing user is updated, `created` is set to `false`. diff --git a/specification/security/query_api_keys/examples/response/QueryApiKeysResponseExample1.yaml b/specification/security/query_api_keys/examples/response/QueryApiKeysResponseExample1.yaml index 63bcaaaa72..8bc50ab61c 100644 --- a/specification/security/query_api_keys/examples/response/QueryApiKeysResponseExample1.yaml +++ b/specification/security/query_api_keys/examples/response/QueryApiKeysResponseExample1.yaml @@ -1,5 +1,4 @@ summary: Query API keys by ID -method_request: GET /_security/_query/api_key?with_limited_by=true description: > A successful response from `GET /_security/_query/api_key?with_limited_by=true`. The `limited_by` details are the owner user's permissions associated with the API key. diff --git a/specification/security/query_api_keys/examples/response/QueryApiKeysResponseExample2.yaml b/specification/security/query_api_keys/examples/response/QueryApiKeysResponseExample2.yaml index fa5cdabbce..c932dd950f 100644 --- a/specification/security/query_api_keys/examples/response/QueryApiKeysResponseExample2.yaml +++ b/specification/security/query_api_keys/examples/response/QueryApiKeysResponseExample2.yaml @@ -1,5 +1,4 @@ summary: Query API keys with pagination -method_request: GET /_security/_query/api_key description: > An abbreviated response from `GET /_security/_query/api_key` that contains a list of matched API keys along with their sort values. The first sort value is creation time, which is displayed in `date_time` format. diff --git a/specification/security/query_api_keys/examples/response/QueryApiKeysResponseExample3.yaml b/specification/security/query_api_keys/examples/response/QueryApiKeysResponseExample3.yaml index 7c7bc04bd3..5108837276 100644 --- a/specification/security/query_api_keys/examples/response/QueryApiKeysResponseExample3.yaml +++ b/specification/security/query_api_keys/examples/response/QueryApiKeysResponseExample3.yaml @@ -1,5 +1,4 @@ summary: Query all API keys -method_request: GET /_security/_query/api_key description: > A successful response from `GET /_security/_query/api_key`. It includes the role descriptors that are assigned to each API key when it was created or last updated. diff --git a/specification/security/query_role/examples/response/QueryRolesResponseExample1.yaml b/specification/security/query_role/examples/response/QueryRolesResponseExample1.yaml index 565e287506..fc9372a03c 100644 --- a/specification/security/query_role/examples/response/QueryRolesResponseExample1.yaml +++ b/specification/security/query_role/examples/response/QueryRolesResponseExample1.yaml @@ -1,5 +1,4 @@ summary: Query roles by name -method_request: POST /_security/_query/role description: > A successful response from `POST /_security/_query/role`. It returns a JSON structure that contains the information retrieved for one or more roles. diff --git a/specification/security/query_role/examples/response/QueryRolesResponseExample2.yaml b/specification/security/query_role/examples/response/QueryRolesResponseExample2.yaml index fdc7f3c750..9a8496c367 100644 --- a/specification/security/query_role/examples/response/QueryRolesResponseExample2.yaml +++ b/specification/security/query_role/examples/response/QueryRolesResponseExample2.yaml @@ -1,5 +1,4 @@ summary: Query roles by description -method_request: POST /_security/_query/role description: > A successful response from `POST /_security/_query/role`. # type: response diff --git a/specification/security/query_user/examples/response/SecurityQueryUserResponseExample1.yaml b/specification/security/query_user/examples/response/SecurityQueryUserResponseExample1.yaml index 0873065dd3..b4d11f3bee 100644 --- a/specification/security/query_user/examples/response/SecurityQueryUserResponseExample1.yaml +++ b/specification/security/query_user/examples/response/SecurityQueryUserResponseExample1.yaml @@ -1,5 +1,4 @@ summary: Query users by role prefix -method_request: POST /_security/_query/user?with_profile_uid=true description: > A successful response from `POST /_security/_query/user?with_profile_uid=true` that contains users that have roles that are prefixed with `other`. It also includes the user `profile_uid` in the response. diff --git a/specification/security/query_user/examples/response/SecurityQueryUserResponseExample2.yaml b/specification/security/query_user/examples/response/SecurityQueryUserResponseExample2.yaml index ad7c8907de..15b53c9f79 100644 --- a/specification/security/query_user/examples/response/SecurityQueryUserResponseExample2.yaml +++ b/specification/security/query_user/examples/response/SecurityQueryUserResponseExample2.yaml @@ -1,5 +1,4 @@ summary: Query users with multiple conditions -method_request: POST /_security/_query/user description: > A successful response from `POST /_security/_query/user` that uses a `bool` query to issue complex logical conditions and uses `from`, `size`, and `sort` to help paginate the result. The sort value is `username`. diff --git a/specification/security/query_user/examples/response/SecurityQueryUserResponseExample3.yaml b/specification/security/query_user/examples/response/SecurityQueryUserResponseExample3.yaml index bd0658b983..706ac5b42f 100644 --- a/specification/security/query_user/examples/response/SecurityQueryUserResponseExample3.yaml +++ b/specification/security/query_user/examples/response/SecurityQueryUserResponseExample3.yaml @@ -1,5 +1,4 @@ summary: Query all users -method_request: GET /_security/_query/user description: > A successful response from `GET /_security/_query/user`, which lists all users. It returns a JSON structure that contains the information retrieved from one or more users. diff --git a/specification/security/saml_authenticate/examples/response/SamlAuthenticateResponseExample1.yaml b/specification/security/saml_authenticate/examples/response/SamlAuthenticateResponseExample1.yaml index 36f3b6d034..3ae3fd4e7b 100644 --- a/specification/security/saml_authenticate/examples/response/SamlAuthenticateResponseExample1.yaml +++ b/specification/security/saml_authenticate/examples/response/SamlAuthenticateResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /_security/saml/authenticate description: A successful response from `POST /_security/saml/authenticate`. # type: response # response_code: diff --git a/specification/security/saml_invalidate/examples/response/SamlInvalidateResponseExample1.yaml b/specification/security/saml_invalidate/examples/response/SamlInvalidateResponseExample1.yaml index 80967eba73..2899590d6d 100644 --- a/specification/security/saml_invalidate/examples/response/SamlInvalidateResponseExample1.yaml +++ b/specification/security/saml_invalidate/examples/response/SamlInvalidateResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /_security/saml/invalidate description: A successful response from `POST /_security/saml/invalidate`. # type: response # response_code: diff --git a/specification/security/saml_logout/examples/response/SamlLogoutResponseExample1.yaml b/specification/security/saml_logout/examples/response/SamlLogoutResponseExample1.yaml index cfac03b927..aeb66c7ff5 100644 --- a/specification/security/saml_logout/examples/response/SamlLogoutResponseExample1.yaml +++ b/specification/security/saml_logout/examples/response/SamlLogoutResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /_security/saml/logout description: A successful response from `POST /_security/saml/logout`. # type: response # response_code: diff --git a/specification/security/saml_prepare_authentication/examples/response/SAmlPrepareAuthenticationResponseExample1.yaml b/specification/security/saml_prepare_authentication/examples/response/SAmlPrepareAuthenticationResponseExample1.yaml index df974677a3..9350f0da91 100644 --- a/specification/security/saml_prepare_authentication/examples/response/SAmlPrepareAuthenticationResponseExample1.yaml +++ b/specification/security/saml_prepare_authentication/examples/response/SAmlPrepareAuthenticationResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /_security/saml/prepare description: A successful response from `POST /_security/saml/prepare`. # type: response # response_code: diff --git a/specification/security/saml_service_provider_metadata/examples/request/SamlServiceProviderMetadataRequestExample1.yaml b/specification/security/saml_service_provider_metadata/examples/request/SamlServiceProviderMetadataRequestExample1.yaml new file mode 100644 index 0000000000..d19fa7f868 --- /dev/null +++ b/specification/security/saml_service_provider_metadata/examples/request/SamlServiceProviderMetadataRequestExample1.yaml @@ -0,0 +1 @@ +method_request: POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data diff --git a/specification/security/saml_service_provider_metadata/examples/response/SamlServiceProviderMetadataResponseExample1.yaml b/specification/security/saml_service_provider_metadata/examples/response/SamlServiceProviderMetadataResponseExample1.yaml index f949088e90..d95c6487f9 100644 --- a/specification/security/saml_service_provider_metadata/examples/response/SamlServiceProviderMetadataResponseExample1.yaml +++ b/specification/security/saml_service_provider_metadata/examples/response/SamlServiceProviderMetadataResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data description: > A successful response from `POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data`, which indicates that the request is acknowledged. # type: response diff --git a/specification/security/suggest_user_profiles/examples/response/SuggestUserProfilesResponseExample1.yaml b/specification/security/suggest_user_profiles/examples/response/SuggestUserProfilesResponseExample1.yaml index 34244f5bb6..d46fa54586 100644 --- a/specification/security/suggest_user_profiles/examples/response/SuggestUserProfilesResponseExample1.yaml +++ b/specification/security/suggest_user_profiles/examples/response/SuggestUserProfilesResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_security/saml/metadata/saml1 description: > A successful response from `GET /_security/saml/metadata/saml1`. It contains the SAML metadata that was generated for the SAML realm as an XML string. diff --git a/specification/security/update_api_key/examples/response/UpdateApiKeyResponseExample1.yaml b/specification/security/update_api_key/examples/response/UpdateApiKeyResponseExample1.yaml index f83d64acdc..d003ec1af4 100644 --- a/specification/security/update_api_key/examples/response/UpdateApiKeyResponseExample1.yaml +++ b/specification/security/update_api_key/examples/response/UpdateApiKeyResponseExample1.yaml @@ -1,5 +1,4 @@ summary: Update role and metadata -method_request: PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx description: > A successful response from `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx`. The API key's effective permissions after the update will be the intersection of the supplied role descriptors and the owner user's permissions. diff --git a/specification/security/update_cross_cluster_api_key/examples/response/UpdateCrossClusterApiKeyResponseExample1.yaml b/specification/security/update_cross_cluster_api_key/examples/response/UpdateCrossClusterApiKeyResponseExample1.yaml index 25da0bd65c..d60a031197 100644 --- a/specification/security/update_cross_cluster_api_key/examples/response/UpdateCrossClusterApiKeyResponseExample1.yaml +++ b/specification/security/update_cross_cluster_api_key/examples/response/UpdateCrossClusterApiKeyResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: PUT /_security/cross_cluster/api_key/VuaCfGcBCdbkQm-e5aOx description: > A successful response from `PUT /_security/cross_cluster/api_key/VuaCfGcBCdbkQm-e5aOx` that indicates that the API key was updated. # type: response diff --git a/specification/security/update_user_profile_data/examples/response/UpdateUserProfileDataResponseExample1.yaml b/specification/security/update_user_profile_data/examples/response/UpdateUserProfileDataResponseExample1.yaml index f949088e90..d95c6487f9 100644 --- a/specification/security/update_user_profile_data/examples/response/UpdateUserProfileDataResponseExample1.yaml +++ b/specification/security/update_user_profile_data/examples/response/UpdateUserProfileDataResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data description: > A successful response from `POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data`, which indicates that the request is acknowledged. # type: response diff --git a/specification/shutdown/delete_node/examples/request/ShutdownDeleteNodeRequestExample1.yaml b/specification/shutdown/delete_node/examples/request/ShutdownDeleteNodeRequestExample1.yaml new file mode 100644 index 0000000000..cb044b354d --- /dev/null +++ b/specification/shutdown/delete_node/examples/request/ShutdownDeleteNodeRequestExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE /_nodes/USpTGYaBSIKbgSUJR2Z9lg/shutdown diff --git a/specification/shutdown/delete_node/examples/response/ShutdownDeleteNodeResponseExample1.yaml b/specification/shutdown/delete_node/examples/response/ShutdownDeleteNodeResponseExample1.yaml index c0b071cf45..9c252fdbe6 100644 --- a/specification/shutdown/delete_node/examples/response/ShutdownDeleteNodeResponseExample1.yaml +++ b/specification/shutdown/delete_node/examples/response/ShutdownDeleteNodeResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: DELETE /_nodes/USpTGYaBSIKbgSUJR2Z9lg/shutdown description: A successful response from `DELETE /_nodes/USpTGYaBSIKbgSUJR2Z9lg/shutdown`. # type: response # response_code: '' diff --git a/specification/shutdown/get_node/examples/request/ShutdownGetNodeRequestExample1.yaml b/specification/shutdown/get_node/examples/request/ShutdownGetNodeRequestExample1.yaml new file mode 100644 index 0000000000..0391f2dc2b --- /dev/null +++ b/specification/shutdown/get_node/examples/request/ShutdownGetNodeRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_nodes/USpTGYaBSIKbgSUJR2Z9lg/shutdown diff --git a/specification/shutdown/get_node/examples/response/ShutdownGetNodeResponseExample1.yaml b/specification/shutdown/get_node/examples/response/ShutdownGetNodeResponseExample1.yaml index b46615676a..88b99881ad 100644 --- a/specification/shutdown/get_node/examples/response/ShutdownGetNodeResponseExample1.yaml +++ b/specification/shutdown/get_node/examples/response/ShutdownGetNodeResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_nodes/USpTGYaBSIKbgSUJR2Z9lg/shutdown description: > Get the status of shutdown preparations with `GET /_nodes/USpTGYaBSIKbgSUJR2Z9lg/shutdown`. The response shows information about the shutdown preparations, including the status of shard migration, task migration, and plugin cleanup diff --git a/specification/slm/delete_lifecycle/examples/request/SlmDeleteLifecycleExample1.yaml b/specification/slm/delete_lifecycle/examples/request/SlmDeleteLifecycleExample1.yaml new file mode 100644 index 0000000000..b7692f83fb --- /dev/null +++ b/specification/slm/delete_lifecycle/examples/request/SlmDeleteLifecycleExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE /_slm/policy/daily-snapshots diff --git a/specification/slm/execute_lifecycle/examples/request/ExecuteSnapshotLifecycleRequestExample1.yaml b/specification/slm/execute_lifecycle/examples/request/ExecuteSnapshotLifecycleRequestExample1.yaml new file mode 100644 index 0000000000..055e6444e8 --- /dev/null +++ b/specification/slm/execute_lifecycle/examples/request/ExecuteSnapshotLifecycleRequestExample1.yaml @@ -0,0 +1 @@ +method_request: POST /_slm/policy/daily-snapshots/_execute diff --git a/specification/slm/execute_lifecycle/examples/response/ExecuteSnapshotLifecycleResponseExample1.yaml b/specification/slm/execute_lifecycle/examples/response/ExecuteSnapshotLifecycleResponseExample1.yaml index d4f7ba51d5..d8d5b9bd5e 100644 --- a/specification/slm/execute_lifecycle/examples/response/ExecuteSnapshotLifecycleResponseExample1.yaml +++ b/specification/slm/execute_lifecycle/examples/response/ExecuteSnapshotLifecycleResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /_slm/policy/daily-snapshots/_execute description: > Run `POST /_slm/policy/daily-snapshots/_execute` to take an immediate snapshot according to the `daily-snapshots` policy. # type: response diff --git a/specification/slm/execute_retention/examples/request/SlmExecuteRetentionExample1.yaml b/specification/slm/execute_retention/examples/request/SlmExecuteRetentionExample1.yaml new file mode 100644 index 0000000000..baa2e6b8f1 --- /dev/null +++ b/specification/slm/execute_retention/examples/request/SlmExecuteRetentionExample1.yaml @@ -0,0 +1 @@ +method_request: POST _slm/_execute_retention diff --git a/specification/slm/get_lifecycle/examples/request/GetSnapshotLifecycleRequestExample1.yaml b/specification/slm/get_lifecycle/examples/request/GetSnapshotLifecycleRequestExample1.yaml new file mode 100644 index 0000000000..9a1979971c --- /dev/null +++ b/specification/slm/get_lifecycle/examples/request/GetSnapshotLifecycleRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _slm/policy/daily-snapshots?human diff --git a/specification/slm/get_lifecycle/examples/response/GetSnapshotLifecycleResponseExample1.yaml b/specification/slm/get_lifecycle/examples/response/GetSnapshotLifecycleResponseExample1.yaml index f729583b6e..f06ec0ac23 100644 --- a/specification/slm/get_lifecycle/examples/response/GetSnapshotLifecycleResponseExample1.yaml +++ b/specification/slm/get_lifecycle/examples/response/GetSnapshotLifecycleResponseExample1.yaml @@ -1,5 +1,4 @@ summary: -method_request: GET _slm/policy/daily-snapshots?human description: A successful response from `GET _slm/policy/daily-snapshots?human`. # type: response # response_code: '' diff --git a/specification/slm/get_stats/examples/request/GetSnapshotLifecycleManagementStatsRequestExample1.yaml b/specification/slm/get_stats/examples/request/GetSnapshotLifecycleManagementStatsRequestExample1.yaml new file mode 100644 index 0000000000..bd0a032ae8 --- /dev/null +++ b/specification/slm/get_stats/examples/request/GetSnapshotLifecycleManagementStatsRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_slm/stats diff --git a/specification/slm/get_stats/examples/response/GetSnapshotLifecycleManagementStatsResponseExample1.yaml b/specification/slm/get_stats/examples/response/GetSnapshotLifecycleManagementStatsResponseExample1.yaml index 521d48cd5c..66e9de8ba0 100644 --- a/specification/slm/get_stats/examples/response/GetSnapshotLifecycleManagementStatsResponseExample1.yaml +++ b/specification/slm/get_stats/examples/response/GetSnapshotLifecycleManagementStatsResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_slm/stats description: A successful response from `GET /_slm/stats`. # type: response # response_code: '' diff --git a/specification/slm/get_status/examples/request/GetSnapshotLifecycleManagementStatusRequestExample1.yaml b/specification/slm/get_status/examples/request/GetSnapshotLifecycleManagementStatusRequestExample1.yaml new file mode 100644 index 0000000000..7a29eec0e2 --- /dev/null +++ b/specification/slm/get_status/examples/request/GetSnapshotLifecycleManagementStatusRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _slm/status diff --git a/specification/slm/get_status/examples/response/GetSnapshotLifecycleManagementStatusResponseExample1.yaml b/specification/slm/get_status/examples/response/GetSnapshotLifecycleManagementStatusResponseExample1.yaml index c1e1ae3211..b40e5e68ee 100644 --- a/specification/slm/get_status/examples/response/GetSnapshotLifecycleManagementStatusResponseExample1.yaml +++ b/specification/slm/get_status/examples/response/GetSnapshotLifecycleManagementStatusResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET _slm/status description: A successful response from `GET _slm/status`. # type: response # response_code: '' diff --git a/specification/slm/start/examples/request/StartSnapshotLifecycleManagementRequestExample1.yaml b/specification/slm/start/examples/request/StartSnapshotLifecycleManagementRequestExample1.yaml new file mode 100644 index 0000000000..d492c9aeb5 --- /dev/null +++ b/specification/slm/start/examples/request/StartSnapshotLifecycleManagementRequestExample1.yaml @@ -0,0 +1 @@ +method_request: POST _slm/start diff --git a/specification/slm/start/examples/response/StartSnapshotLifecycleManagementResponseExample1.yaml b/specification/slm/start/examples/response/StartSnapshotLifecycleManagementResponseExample1.yaml index 277a6abcfb..b21929e48d 100644 --- a/specification/slm/start/examples/response/StartSnapshotLifecycleManagementResponseExample1.yaml +++ b/specification/slm/start/examples/response/StartSnapshotLifecycleManagementResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST _slm/start description: A successful response from `POST _slm/start`. # type: response # response_code: '' diff --git a/specification/snapshot/cleanup_repository/examples/request/SnapshotCleanupRepositoryRequestExample1.yaml b/specification/snapshot/cleanup_repository/examples/request/SnapshotCleanupRepositoryRequestExample1.yaml new file mode 100644 index 0000000000..50442f35ae --- /dev/null +++ b/specification/snapshot/cleanup_repository/examples/request/SnapshotCleanupRepositoryRequestExample1.yaml @@ -0,0 +1 @@ +method_request: POST /_snapshot/my_repository/_cleanup diff --git a/specification/snapshot/cleanup_repository/examples/response/SnapshotCleanupRepositoryResponseExample1.yaml b/specification/snapshot/cleanup_repository/examples/response/SnapshotCleanupRepositoryResponseExample1.yaml index 7e1bb14558..152ea0ef9b 100644 --- a/specification/snapshot/cleanup_repository/examples/response/SnapshotCleanupRepositoryResponseExample1.yaml +++ b/specification/snapshot/cleanup_repository/examples/response/SnapshotCleanupRepositoryResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST /_snapshot/my_repository/_cleanup description: A successful response from `POST /_snapshot/my_repository/_cleanup`. # type: response # response_code: '' diff --git a/specification/snapshot/create/examples/response/SnapshotCreateResponseExample1.yaml b/specification/snapshot/create/examples/response/SnapshotCreateResponseExample1.yaml index 05ea3b0422..86c59b2e8f 100644 --- a/specification/snapshot/create/examples/response/SnapshotCreateResponseExample1.yaml +++ b/specification/snapshot/create/examples/response/SnapshotCreateResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: PUT /_snapshot/my_repository/snapshot_2?wait_for_completion=true description: A successful response from `PUT /_snapshot/my_repository/snapshot_2?wait_for_completion=true`. # type: response # response_code: '' diff --git a/specification/snapshot/delete/examples/request/SnapshotDeleteRequestExample1.yaml b/specification/snapshot/delete/examples/request/SnapshotDeleteRequestExample1.yaml new file mode 100644 index 0000000000..ae0b5b6df6 --- /dev/null +++ b/specification/snapshot/delete/examples/request/SnapshotDeleteRequestExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE /_snapshot/my_repository/snapshot_2,snapshot_3 diff --git a/specification/snapshot/delete/examples/response/SnapshotDeleteResponseExample1.yaml b/specification/snapshot/delete/examples/response/SnapshotDeleteResponseExample1.yaml index fe4b7113dc..aadfee7176 100644 --- a/specification/snapshot/delete/examples/response/SnapshotDeleteResponseExample1.yaml +++ b/specification/snapshot/delete/examples/response/SnapshotDeleteResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: DELETE /_snapshot/my_repository/snapshot_2,snapshot_3 description: > A successful response from `DELETE /_snapshot/my_repository/snapshot_2,snapshot_3`. The request deletes `snapshot_2` and `snapshot_3` from the repository named `my_repository`. diff --git a/specification/snapshot/delete_repository/examples/request/SnapshotDeleteRepositoryExample1.yaml b/specification/snapshot/delete_repository/examples/request/SnapshotDeleteRepositoryExample1.yaml new file mode 100644 index 0000000000..e60bd7a306 --- /dev/null +++ b/specification/snapshot/delete_repository/examples/request/SnapshotDeleteRepositoryExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE /_snapshot/my_repository diff --git a/specification/snapshot/get/examples/request/SnapshotGetRequestExample1.yaml b/specification/snapshot/get/examples/request/SnapshotGetRequestExample1.yaml new file mode 100644 index 0000000000..18780bc2f9 --- /dev/null +++ b/specification/snapshot/get/examples/request/SnapshotGetRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_snapshot/my_repository/snapshot_*?sort=start_time&from_sort_value=1577833200000 diff --git a/specification/snapshot/get/examples/response/SnapshotGetResponseExample1.yaml b/specification/snapshot/get/examples/response/SnapshotGetResponseExample1.yaml index e7c3aa566e..11610e653e 100644 --- a/specification/snapshot/get/examples/response/SnapshotGetResponseExample1.yaml +++ b/specification/snapshot/get/examples/response/SnapshotGetResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_snapshot/my_repository/snapshot_*?sort=start_time&from_sort_value=1577833200000 description: > A successful response from `GET /_snapshot/my_repository/snapshot_*?sort=start_time&from_sort_value=1577833200000`. The response contains information for all snapshots with names starting with `snapshot_` and that started on or after timestamp `1577833200000` (Jan 1st 2020) when sorted by snapshot start time in the default ascending order. diff --git a/specification/snapshot/get_repository/examples/request/SnapshotGetRepositoryRequestExample1.yaml b/specification/snapshot/get_repository/examples/request/SnapshotGetRepositoryRequestExample1.yaml new file mode 100644 index 0000000000..b327a9b4d9 --- /dev/null +++ b/specification/snapshot/get_repository/examples/request/SnapshotGetRepositoryRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_snapshot/my_repository diff --git a/specification/snapshot/get_repository/examples/response/SnapshotGetRepositoryResponseExample1.yaml b/specification/snapshot/get_repository/examples/response/SnapshotGetRepositoryResponseExample1.yaml index ea0b742152..0a86b84e54 100644 --- a/specification/snapshot/get_repository/examples/response/SnapshotGetRepositoryResponseExample1.yaml +++ b/specification/snapshot/get_repository/examples/response/SnapshotGetRepositoryResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_snapshot/my_repository description: A successful response from `GET /_snapshot/my_repository`. # type: response # response_code: '' diff --git a/specification/snapshot/repository_analyze/examples/request/SnapshotRepositoryAnalyzeRequestExample1.yaml b/specification/snapshot/repository_analyze/examples/request/SnapshotRepositoryAnalyzeRequestExample1.yaml new file mode 100644 index 0000000000..d8348ca32b --- /dev/null +++ b/specification/snapshot/repository_analyze/examples/request/SnapshotRepositoryAnalyzeRequestExample1.yaml @@ -0,0 +1,4 @@ +summary: Analyze a repository +method_request: POST /_snapshot/my_repository/_analyze?blob_count=10&max_blob_size=1mb&timeout=120s +type: request +description: Analyze `my_repository` by writing 10 blobs of 1mb max. Cancel the test after 2 minutes. diff --git a/specification/snapshot/repository_verify_integrity/examples/request/SnapshotRepositoryVerifyIntegrityExample1.yaml b/specification/snapshot/repository_verify_integrity/examples/request/SnapshotRepositoryVerifyIntegrityExample1.yaml new file mode 100644 index 0000000000..615f0c9723 --- /dev/null +++ b/specification/snapshot/repository_verify_integrity/examples/request/SnapshotRepositoryVerifyIntegrityExample1.yaml @@ -0,0 +1 @@ +method_request: POST /_snapshot/my_repository/_verify_integrity diff --git a/specification/snapshot/status/examples/request/SnapshotStatusRequestExample1.yaml b/specification/snapshot/status/examples/request/SnapshotStatusRequestExample1.yaml new file mode 100644 index 0000000000..37d4c3b95d --- /dev/null +++ b/specification/snapshot/status/examples/request/SnapshotStatusRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _snapshot/my_repository/snapshot_2/_status diff --git a/specification/snapshot/status/examples/response/SnapshotStatusResponseExample1.yaml b/specification/snapshot/status/examples/response/SnapshotStatusResponseExample1.yaml index 12f61fb0ed..f32a140a16 100644 --- a/specification/snapshot/status/examples/response/SnapshotStatusResponseExample1.yaml +++ b/specification/snapshot/status/examples/response/SnapshotStatusResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET _snapshot/my_repository/snapshot_2/_status description: > A successful response from `GET _snapshot/my_repository/snapshot_2/_status`. The response contains detailed status information for `snapshot_2` in the `my_repository` repository. diff --git a/specification/snapshot/verify_repository/examples/request/SnapshotVerifyRepositoryExample1.yaml b/specification/snapshot/verify_repository/examples/request/SnapshotVerifyRepositoryExample1.yaml new file mode 100644 index 0000000000..3ed8b23d23 --- /dev/null +++ b/specification/snapshot/verify_repository/examples/request/SnapshotVerifyRepositoryExample1.yaml @@ -0,0 +1 @@ +method_request: POST _snapshot/my_unverified_backup/_verify diff --git a/specification/sql/delete_async/examples/request/SqlDeleteAsyncExample1.yaml b/specification/sql/delete_async/examples/request/SqlDeleteAsyncExample1.yaml new file mode 100644 index 0000000000..20507060b5 --- /dev/null +++ b/specification/sql/delete_async/examples/request/SqlDeleteAsyncExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _sql/async/delete/FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI= diff --git a/specification/sql/get_async/examples/request/SqlGetAsyncExample1.yaml b/specification/sql/get_async/examples/request/SqlGetAsyncExample1.yaml new file mode 100644 index 0000000000..24bc18cf81 --- /dev/null +++ b/specification/sql/get_async/examples/request/SqlGetAsyncExample1.yaml @@ -0,0 +1 @@ +method_request: GET _sql/async/FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=?wait_for_completion_timeout=2s&format=json diff --git a/specification/sql/get_async_status/examples/request/SqlGetAsyncStatusExample1.yaml b/specification/sql/get_async_status/examples/request/SqlGetAsyncStatusExample1.yaml new file mode 100644 index 0000000000..26d6c9f359 --- /dev/null +++ b/specification/sql/get_async_status/examples/request/SqlGetAsyncStatusExample1.yaml @@ -0,0 +1 @@ +method_request: GET _sql/async/status/FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU= diff --git a/specification/ssl/certificates/examples/request/GetCertificatesRequestExample1.yaml b/specification/ssl/certificates/examples/request/GetCertificatesRequestExample1.yaml new file mode 100644 index 0000000000..175c6df797 --- /dev/null +++ b/specification/ssl/certificates/examples/request/GetCertificatesRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_ssl/certificates diff --git a/specification/ssl/certificates/examples/response/GetCertificatesResponseExample1.yaml b/specification/ssl/certificates/examples/response/GetCertificatesResponseExample1.yaml index bee9d55685..fd0c220f53 100644 --- a/specification/ssl/certificates/examples/response/GetCertificatesResponseExample1.yaml +++ b/specification/ssl/certificates/examples/response/GetCertificatesResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_ssl/certificates description: > A successful response from `GET /_ssl/certificates`, which provides information about the certificates on a single node of Elasticsearch. # type: response diff --git a/specification/synonyms/delete_synonym/examples/request/SynonymsDeleteSynonymExample1.yaml b/specification/synonyms/delete_synonym/examples/request/SynonymsDeleteSynonymExample1.yaml new file mode 100644 index 0000000000..6950eb1400 --- /dev/null +++ b/specification/synonyms/delete_synonym/examples/request/SynonymsDeleteSynonymExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _synonyms/my-synonyms-set diff --git a/specification/synonyms/delete_synonym_rule/examples/request/SynonymRuleDeleteRequestExample1.yaml b/specification/synonyms/delete_synonym_rule/examples/request/SynonymRuleDeleteRequestExample1.yaml new file mode 100644 index 0000000000..c5704a7c19 --- /dev/null +++ b/specification/synonyms/delete_synonym_rule/examples/request/SynonymRuleDeleteRequestExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _synonyms/my-synonyms-set/test-1 diff --git a/specification/synonyms/delete_synonym_rule/examples/response/SynonymRuleDeleteResponseExample1.yaml b/specification/synonyms/delete_synonym_rule/examples/response/SynonymRuleDeleteResponseExample1.yaml index 97c7015f97..9a0b3b7ec4 100644 --- a/specification/synonyms/delete_synonym_rule/examples/response/SynonymRuleDeleteResponseExample1.yaml +++ b/specification/synonyms/delete_synonym_rule/examples/response/SynonymRuleDeleteResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: DELETE _synonyms/my-synonyms-set/test-1 description: > A successful response from `DELETE _synonyms/my-synonyms-set/test-1`. All analyzers using this synonyms set will be reloaded automatically to reflect the rule being deleted. diff --git a/specification/synonyms/get_synonym/examples/request/SynonymsGetRequestExample1.yaml b/specification/synonyms/get_synonym/examples/request/SynonymsGetRequestExample1.yaml new file mode 100644 index 0000000000..384a86fcc2 --- /dev/null +++ b/specification/synonyms/get_synonym/examples/request/SynonymsGetRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _synonyms/my-synonyms-set diff --git a/specification/synonyms/get_synonym/examples/response/SynonymsGetResponseExample1.yaml b/specification/synonyms/get_synonym/examples/response/SynonymsGetResponseExample1.yaml index ffacd5d2de..ba8b37b77b 100644 --- a/specification/synonyms/get_synonym/examples/response/SynonymsGetResponseExample1.yaml +++ b/specification/synonyms/get_synonym/examples/response/SynonymsGetResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET _synonyms/my-synonyms-set description: A successful response from `GET _synonyms/my-synonyms-set`. # type: response # response_code: '' diff --git a/specification/synonyms/get_synonym_rule/examples/request/SynonymRuleGetRequestExample1.yaml b/specification/synonyms/get_synonym_rule/examples/request/SynonymRuleGetRequestExample1.yaml new file mode 100644 index 0000000000..05284fc243 --- /dev/null +++ b/specification/synonyms/get_synonym_rule/examples/request/SynonymRuleGetRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _synonyms/my-synonyms-set/test-1 diff --git a/specification/synonyms/get_synonym_rule/examples/response/SynonymRuleGetResponseExample1.yaml b/specification/synonyms/get_synonym_rule/examples/response/SynonymRuleGetResponseExample1.yaml index 4d2a31ea45..af8b93bec6 100644 --- a/specification/synonyms/get_synonym_rule/examples/response/SynonymRuleGetResponseExample1.yaml +++ b/specification/synonyms/get_synonym_rule/examples/response/SynonymRuleGetResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET _synonyms/my-synonyms-set/test-1 description: A successful response from `GET _synonyms/my-synonyms-set/test-1`. # type: response # response_code: '' diff --git a/specification/synonyms/get_synonyms_sets/examples/request/SynonymsSetsGetRequestExample1.yaml b/specification/synonyms/get_synonyms_sets/examples/request/SynonymsSetsGetRequestExample1.yaml new file mode 100644 index 0000000000..0b019af6ed --- /dev/null +++ b/specification/synonyms/get_synonyms_sets/examples/request/SynonymsSetsGetRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _synonyms diff --git a/specification/synonyms/get_synonyms_sets/examples/response/SynonymsSetsGetResponseExample1.yaml b/specification/synonyms/get_synonyms_sets/examples/response/SynonymsSetsGetResponseExample1.yaml index 99345534f0..edb95e9433 100644 --- a/specification/synonyms/get_synonyms_sets/examples/response/SynonymsSetsGetResponseExample1.yaml +++ b/specification/synonyms/get_synonyms_sets/examples/response/SynonymsSetsGetResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET _synonyms description: A successful response from `GET _synonyms`. # type: response # response_code: '' diff --git a/specification/synonyms/put_synonym/examples/400_response/SynonymsPutRequestExample1.yaml b/specification/synonyms/put_synonym/examples/400_response/SynonymsPutRequestExample1.yaml index a1417f46d5..4a06183e25 100644 --- a/specification/synonyms/put_synonym/examples/400_response/SynonymsPutRequestExample1.yaml +++ b/specification/synonyms/put_synonym/examples/400_response/SynonymsPutRequestExample1.yaml @@ -1,6 +1,4 @@ # summary: -# method_request: PUT _synonyms/my-synonyms-set -method_request: PUT _synonyms/my-synonyms-set description: > Run `PUT _synonyms/my-synonyms-set` to create a new synonyms set. If any of the synonym rules included is not valid, the API will return an error. diff --git a/specification/synonyms/put_synonym/examples/400_response/SynonymsPutResponseExample1.yaml b/specification/synonyms/put_synonym/examples/400_response/SynonymsPutResponseExample1.yaml index 5b79439819..08b38239cc 100644 --- a/specification/synonyms/put_synonym/examples/400_response/SynonymsPutResponseExample1.yaml +++ b/specification/synonyms/put_synonym/examples/400_response/SynonymsPutResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: PUT _synonyms/my-synonyms-set description: > An abbreviated response from `PUT _synonyms/my-synonyms-set`. If any of the synonym rules included is not valid, the API returns an error. diff --git a/specification/synonyms/put_synonym/examples/request/SynonymsPutRequestExample1.yaml b/specification/synonyms/put_synonym/examples/request/SynonymsPutRequestExample1.yaml new file mode 100644 index 0000000000..333ab6f65f --- /dev/null +++ b/specification/synonyms/put_synonym/examples/request/SynonymsPutRequestExample1.yaml @@ -0,0 +1 @@ +method_request: PUT _synonyms/my-synonyms-set diff --git a/specification/synonyms/put_synonym_rule/examples/response/SynonymRuleResponseExample1.yaml b/specification/synonyms/put_synonym_rule/examples/response/SynonymRuleResponseExample1.yaml index a0ed1d42f0..e16fd7c7e7 100644 --- a/specification/synonyms/put_synonym_rule/examples/response/SynonymRuleResponseExample1.yaml +++ b/specification/synonyms/put_synonym_rule/examples/response/SynonymRuleResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: PUT _synonyms/my-synonyms-set/test-1 description: > A successful response from `PUT _synonyms/my-synonyms-set/test-1`. diff --git a/specification/tasks/cancel/examples/request/TasksCancelExample1.yaml b/specification/tasks/cancel/examples/request/TasksCancelExample1.yaml new file mode 100644 index 0000000000..b286e870fa --- /dev/null +++ b/specification/tasks/cancel/examples/request/TasksCancelExample1.yaml @@ -0,0 +1 @@ +method_request: POST _tasks//_cancel diff --git a/specification/tasks/get/examples/200_response/GetTaskResponseExample1.yaml b/specification/tasks/get/examples/200_response/GetTaskResponseExample1.yaml index f64f1b4bd1..cea0957c00 100644 --- a/specification/tasks/get/examples/200_response/GetTaskResponseExample1.yaml +++ b/specification/tasks/get/examples/200_response/GetTaskResponseExample1.yaml @@ -1,5 +1,4 @@ summary: Get cluster actions -method_request: GET _tasks?actions=cluster:* description: > A successful response from `GET _tasks?actions=cluster:*`, which retrieves all cluster-related tasks. # type: response diff --git a/specification/tasks/get/examples/200_response/GetTaskResponseExample2.yaml b/specification/tasks/get/examples/200_response/GetTaskResponseExample2.yaml index 5910060a8b..e843a9ff3c 100644 --- a/specification/tasks/get/examples/200_response/GetTaskResponseExample2.yaml +++ b/specification/tasks/get/examples/200_response/GetTaskResponseExample2.yaml @@ -1,5 +1,4 @@ summary: Get details about a delete by query -method_request: GET _tasks?detailed=true&actions=*/delete/byquery description: > A successful response from `GET _tasks?detailed=true&actions=*/delete/byquery`, which gets the status of a delete by query operation. The `status` object contains the actual status. diff --git a/specification/tasks/get/examples/request/GetTaskRequestExample2.yaml b/specification/tasks/get/examples/request/GetTaskRequestExample2.yaml new file mode 100644 index 0000000000..7e7484325d --- /dev/null +++ b/specification/tasks/get/examples/request/GetTaskRequestExample2.yaml @@ -0,0 +1 @@ +method_request: GET _tasks?detailed=true&actions=*/delete/byquery diff --git a/specification/tasks/list/examples/200_response/ListTasksResponseExample1.yaml b/specification/tasks/list/examples/200_response/ListTasksResponseExample1.yaml index f1f9cc44a3..be315fc233 100644 --- a/specification/tasks/list/examples/200_response/ListTasksResponseExample1.yaml +++ b/specification/tasks/list/examples/200_response/ListTasksResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET _tasks?actions=*search&detailed description: > A successful response from `GET _tasks?actions=*search&detailed` The `detailed` parameter affects the `description` field, which contains human readable text that identifies the particular request that the task is performing. diff --git a/specification/tasks/list/examples/request/ListTasksRequestExample1.yaml b/specification/tasks/list/examples/request/ListTasksRequestExample1.yaml new file mode 100644 index 0000000000..ece939dea9 --- /dev/null +++ b/specification/tasks/list/examples/request/ListTasksRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _tasks?actions=*search&detailed diff --git a/specification/text_structure/find_field_structure/examples/request/FindFieldStructureRequestExample1.yaml b/specification/text_structure/find_field_structure/examples/request/FindFieldStructureRequestExample1.yaml new file mode 100644 index 0000000000..eaf803b14c --- /dev/null +++ b/specification/text_structure/find_field_structure/examples/request/FindFieldStructureRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _text_structure/find_field_structure?index=test-logs&field=message diff --git a/specification/text_structure/find_field_structure/examples/response/FindFieldStructureResponseExample1.yaml b/specification/text_structure/find_field_structure/examples/response/FindFieldStructureResponseExample1.yaml index 6945cac967..7b1dba7f19 100644 --- a/specification/text_structure/find_field_structure/examples/response/FindFieldStructureResponseExample1.yaml +++ b/specification/text_structure/find_field_structure/examples/response/FindFieldStructureResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET _text_structure/find_field_structure?index=test-logs&field=message description: A successful response from `GET _text_structure/find_field_structure?index=test-logs&field=message`. # type: response # response_code: '' diff --git a/specification/text_structure/find_message_structure/examples/response/FindMessageStructureResponseExample1.yaml b/specification/text_structure/find_message_structure/examples/response/FindMessageStructureResponseExample1.yaml index a908c8149f..a68d9f8ca5 100644 --- a/specification/text_structure/find_message_structure/examples/response/FindMessageStructureResponseExample1.yaml +++ b/specification/text_structure/find_message_structure/examples/response/FindMessageStructureResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST _text_structure/find_message_structure description: A successful response from `POST _text_structure/find_message_structure`. # type: response # response_code: '' diff --git a/specification/text_structure/find_structure/examples/response/FindStructureResponseExample1.yaml b/specification/text_structure/find_structure/examples/response/FindStructureResponseExample1.yaml index 9512d8f20d..7ea123d221 100644 --- a/specification/text_structure/find_structure/examples/response/FindStructureResponseExample1.yaml +++ b/specification/text_structure/find_structure/examples/response/FindStructureResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST _text_structure/find_structure description: A successful response from `POST _text_structure/find_structure`. # type: response # response_code: '' diff --git a/specification/text_structure/test_grok_pattern/examples/response/TestGrokPatternResponseExample1.yaml b/specification/text_structure/test_grok_pattern/examples/response/TestGrokPatternResponseExample1.yaml index ed8cf6a62f..e910b3dce8 100644 --- a/specification/text_structure/test_grok_pattern/examples/response/TestGrokPatternResponseExample1.yaml +++ b/specification/text_structure/test_grok_pattern/examples/response/TestGrokPatternResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET _text_structure/test_grok_pattern description: A successful response from `GET _text_structure/test_grok_pattern`. # type: response # response_code: '' diff --git a/specification/transform/delete_transform/examples/request/TransformDeleteTransformExample1.yaml b/specification/transform/delete_transform/examples/request/TransformDeleteTransformExample1.yaml new file mode 100644 index 0000000000..fbce5ab4f5 --- /dev/null +++ b/specification/transform/delete_transform/examples/request/TransformDeleteTransformExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _transform/ecommerce_transform diff --git a/specification/transform/get_transform/examples/request/TransformGetTransformExample1.yaml b/specification/transform/get_transform/examples/request/TransformGetTransformExample1.yaml new file mode 100644 index 0000000000..75e526a10e --- /dev/null +++ b/specification/transform/get_transform/examples/request/TransformGetTransformExample1.yaml @@ -0,0 +1 @@ +method_request: GET _transform?size=10 diff --git a/specification/transform/get_transform_stats/examples/request/TransformGetTransformStatsExample1.yaml b/specification/transform/get_transform_stats/examples/request/TransformGetTransformStatsExample1.yaml new file mode 100644 index 0000000000..a6416b60c4 --- /dev/null +++ b/specification/transform/get_transform_stats/examples/request/TransformGetTransformStatsExample1.yaml @@ -0,0 +1 @@ +method_request: GET _transform/ecommerce-customer-transform/_stats diff --git a/specification/transform/preview_transform/examples/response/PreviewTransformResponseExample1.yaml b/specification/transform/preview_transform/examples/response/PreviewTransformResponseExample1.yaml index aa968d78b9..dcac5dda85 100644 --- a/specification/transform/preview_transform/examples/response/PreviewTransformResponseExample1.yaml +++ b/specification/transform/preview_transform/examples/response/PreviewTransformResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST _transform/_preview description: An abbreviated response from `POST _transform/_preview` that contains a preview a transform that uses the pivot method. # type: response # response_code: 200 diff --git a/specification/transform/reset_transform/examples/request/TransformResetTransformExample1.yaml b/specification/transform/reset_transform/examples/request/TransformResetTransformExample1.yaml new file mode 100644 index 0000000000..ca1bd4d181 --- /dev/null +++ b/specification/transform/reset_transform/examples/request/TransformResetTransformExample1.yaml @@ -0,0 +1 @@ +method_request: POST _transform/ecommerce_transform/_reset diff --git a/specification/transform/schedule_now_transform/examples/request/TransformScheduleNowTransformExample1.yaml b/specification/transform/schedule_now_transform/examples/request/TransformScheduleNowTransformExample1.yaml new file mode 100644 index 0000000000..2d90b03137 --- /dev/null +++ b/specification/transform/schedule_now_transform/examples/request/TransformScheduleNowTransformExample1.yaml @@ -0,0 +1 @@ +method_request: POST _transform/ecommerce_transform/_schedule_now diff --git a/specification/transform/start_transform/examples/request/TransformStartTransformExample1.yaml b/specification/transform/start_transform/examples/request/TransformStartTransformExample1.yaml new file mode 100644 index 0000000000..18bafb90ed --- /dev/null +++ b/specification/transform/start_transform/examples/request/TransformStartTransformExample1.yaml @@ -0,0 +1 @@ +method_request: POST _transform/ecommerce-customer-transform/_start diff --git a/specification/transform/stop_transform/examples/request/TransformStopTransformExample1.yaml b/specification/transform/stop_transform/examples/request/TransformStopTransformExample1.yaml new file mode 100644 index 0000000000..12dc9d32b9 --- /dev/null +++ b/specification/transform/stop_transform/examples/request/TransformStopTransformExample1.yaml @@ -0,0 +1 @@ +method_request: POST _transform/ecommerce_transform/_stop diff --git a/specification/transform/upgrade_transforms/examples/request/TransformUpgradeTransformsExample1.yaml b/specification/transform/upgrade_transforms/examples/request/TransformUpgradeTransformsExample1.yaml new file mode 100644 index 0000000000..fdf4f3573b --- /dev/null +++ b/specification/transform/upgrade_transforms/examples/request/TransformUpgradeTransformsExample1.yaml @@ -0,0 +1 @@ +method_request: POST _transform/_upgrade diff --git a/specification/watcher/ack_watch/examples/request/WatcherAckWatchRequestExample1.yaml b/specification/watcher/ack_watch/examples/request/WatcherAckWatchRequestExample1.yaml new file mode 100644 index 0000000000..458d9b7f68 --- /dev/null +++ b/specification/watcher/ack_watch/examples/request/WatcherAckWatchRequestExample1.yaml @@ -0,0 +1 @@ +method_request: POST _watcher/watch/my_watch/_ack diff --git a/specification/watcher/ack_watch/examples/response/WatcherAckWatchResponseExample1.yaml b/specification/watcher/ack_watch/examples/response/WatcherAckWatchResponseExample1.yaml index 55783f9d94..09848ed691 100644 --- a/specification/watcher/ack_watch/examples/response/WatcherAckWatchResponseExample1.yaml +++ b/specification/watcher/ack_watch/examples/response/WatcherAckWatchResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST _watcher/watch/my_watch/_ack description: A successful response from `POST _watcher/watch/my_watch/_ack`. # type: response # response_code: 200 diff --git a/specification/watcher/activate_watch/examples/request/WatcherActivateWatchExample1.yaml b/specification/watcher/activate_watch/examples/request/WatcherActivateWatchExample1.yaml new file mode 100644 index 0000000000..902463d7c5 --- /dev/null +++ b/specification/watcher/activate_watch/examples/request/WatcherActivateWatchExample1.yaml @@ -0,0 +1 @@ +method_request: PUT _watcher/watch/my_watch/_activate diff --git a/specification/watcher/deactivate_watch/examples/request/WatcherDeactivateWatchExample1.yaml b/specification/watcher/deactivate_watch/examples/request/WatcherDeactivateWatchExample1.yaml new file mode 100644 index 0000000000..1857a34e66 --- /dev/null +++ b/specification/watcher/deactivate_watch/examples/request/WatcherDeactivateWatchExample1.yaml @@ -0,0 +1 @@ +method_request: PUT _watcher/watch/my_watch/_deactivate diff --git a/specification/watcher/delete_watch/examples/request/DeleteWatchRequestExample1.yaml b/specification/watcher/delete_watch/examples/request/DeleteWatchRequestExample1.yaml new file mode 100644 index 0000000000..af1cfc6370 --- /dev/null +++ b/specification/watcher/delete_watch/examples/request/DeleteWatchRequestExample1.yaml @@ -0,0 +1 @@ +method_request: DELETE _watcher/watch/my_watch diff --git a/specification/watcher/delete_watch/examples/response/DeleteWatchResponseExample1.yaml b/specification/watcher/delete_watch/examples/response/DeleteWatchResponseExample1.yaml index 94dcd9aa1e..e3c46417f4 100644 --- a/specification/watcher/delete_watch/examples/response/DeleteWatchResponseExample1.yaml +++ b/specification/watcher/delete_watch/examples/response/DeleteWatchResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: DELETE _watcher/watch/my_watch description: A successful response from `DELETE _watcher/watch/my_watch`. # type: response # response_code: 200 diff --git a/specification/watcher/execute_watch/examples/response/WatcherExecuteWatchResponseExample1.yaml b/specification/watcher/execute_watch/examples/response/WatcherExecuteWatchResponseExample1.yaml index ed78a47303..7e6c6a2db2 100644 --- a/specification/watcher/execute_watch/examples/response/WatcherExecuteWatchResponseExample1.yaml +++ b/specification/watcher/execute_watch/examples/response/WatcherExecuteWatchResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: POST _watcher/watch/my_watch/_execute description: > A successful response from `POST _watcher/watch/my_watch/_execute`. # type: response diff --git a/specification/watcher/get_settings/examples/request/WatcherGetSettingsExample1.yaml b/specification/watcher/get_settings/examples/request/WatcherGetSettingsExample1.yaml new file mode 100644 index 0000000000..1ab70df900 --- /dev/null +++ b/specification/watcher/get_settings/examples/request/WatcherGetSettingsExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_watcher/settings diff --git a/specification/watcher/get_watch/examples/request/GetWatchRequestExample1.yaml b/specification/watcher/get_watch/examples/request/GetWatchRequestExample1.yaml new file mode 100644 index 0000000000..6c9874e82e --- /dev/null +++ b/specification/watcher/get_watch/examples/request/GetWatchRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _watcher/watch/my_watch diff --git a/specification/watcher/get_watch/examples/response/GetWatchResponseExample1.yaml b/specification/watcher/get_watch/examples/response/GetWatchResponseExample1.yaml index 5cd95bedea..658da6e193 100644 --- a/specification/watcher/get_watch/examples/response/GetWatchResponseExample1.yaml +++ b/specification/watcher/get_watch/examples/response/GetWatchResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET _watcher/watch/my_watch description: A successful response from `GET _watcher/watch/my_watch`. # type: response # response_code: 200 diff --git a/specification/watcher/query_watches/examples/request/WatcherQueryWatchesRequestExample1.yaml b/specification/watcher/query_watches/examples/request/WatcherQueryWatchesRequestExample1.yaml new file mode 100644 index 0000000000..e3621c8fd9 --- /dev/null +++ b/specification/watcher/query_watches/examples/request/WatcherQueryWatchesRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_watcher/_query/watches diff --git a/specification/watcher/query_watches/examples/response/WatcherQueryWatchesResponseExample1.yaml b/specification/watcher/query_watches/examples/response/WatcherQueryWatchesResponseExample1.yaml index 286ffd6f28..d60a187ba9 100644 --- a/specification/watcher/query_watches/examples/response/WatcherQueryWatchesResponseExample1.yaml +++ b/specification/watcher/query_watches/examples/response/WatcherQueryWatchesResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: '' -method_request: GET /_watcher/_query/watches description: A successful response from `GET /_watcher/_query/watches`. # type: response # response_code: 200 diff --git a/specification/watcher/start/examples/request/WatcherStartRequestExample1.yaml b/specification/watcher/start/examples/request/WatcherStartRequestExample1.yaml new file mode 100644 index 0000000000..460c900873 --- /dev/null +++ b/specification/watcher/start/examples/request/WatcherStartRequestExample1.yaml @@ -0,0 +1 @@ +method_request: POST _watcher/_start diff --git a/specification/watcher/start/examples/response/WatcherStartResponseExample1.yaml b/specification/watcher/start/examples/response/WatcherStartResponseExample1.yaml index 244a81d158..1808a96b58 100644 --- a/specification/watcher/start/examples/response/WatcherStartResponseExample1.yaml +++ b/specification/watcher/start/examples/response/WatcherStartResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: '' -method_request: POST _watcher/_start description: A successful response from `POST _watcher/_start`. # type: response # response_code: 200 diff --git a/specification/watcher/stats/examples/request/WatcherStatsRequestExample1.yaml b/specification/watcher/stats/examples/request/WatcherStatsRequestExample1.yaml new file mode 100644 index 0000000000..ff8b145c37 --- /dev/null +++ b/specification/watcher/stats/examples/request/WatcherStatsRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET _watcher/stats diff --git a/specification/watcher/stats/examples/response/WatcherStatsResponseExample1.yaml b/specification/watcher/stats/examples/response/WatcherStatsResponseExample1.yaml index 730f58d87a..779bb81fff 100644 --- a/specification/watcher/stats/examples/response/WatcherStatsResponseExample1.yaml +++ b/specification/watcher/stats/examples/response/WatcherStatsResponseExample1.yaml @@ -1,5 +1,4 @@ summary: Basic metrics -method_request: GET _watcher/stats description: A successful response from `GET _watcher/stats`. # type: response # response_code: 200 diff --git a/specification/watcher/stats/examples/response/WatcherStatsResponseExample2.yaml b/specification/watcher/stats/examples/response/WatcherStatsResponseExample2.yaml index 5309fb394b..6cf5a4983d 100644 --- a/specification/watcher/stats/examples/response/WatcherStatsResponseExample2.yaml +++ b/specification/watcher/stats/examples/response/WatcherStatsResponseExample2.yaml @@ -1,5 +1,4 @@ summary: Current watch metrics -method_request: GET _watcher/stats?metric=current_watches description: A successful response from `GET _watcher/stats?metric=current_watches`. # type: response # response_code: 200 diff --git a/specification/watcher/stats/examples/response/WatcherStatsResponseExample3.yaml b/specification/watcher/stats/examples/response/WatcherStatsResponseExample3.yaml index 865a1c9ca4..374b90e9fe 100644 --- a/specification/watcher/stats/examples/response/WatcherStatsResponseExample3.yaml +++ b/specification/watcher/stats/examples/response/WatcherStatsResponseExample3.yaml @@ -1,5 +1,4 @@ summary: Queued watch metrics -method_request: GET _watcher/stats/queued_watches description: An abbreviated response from `GET _watcher/stats/queued_watches`. # type: response # response_code: 200 diff --git a/specification/watcher/stop/examples/request/WatcherStopRequestExample1.yaml b/specification/watcher/stop/examples/request/WatcherStopRequestExample1.yaml new file mode 100644 index 0000000000..7bc9342704 --- /dev/null +++ b/specification/watcher/stop/examples/request/WatcherStopRequestExample1.yaml @@ -0,0 +1 @@ +method_request: POST _watcher/_stop diff --git a/specification/watcher/stop/examples/response/WatcherStopResponseExample1.yaml b/specification/watcher/stop/examples/response/WatcherStopResponseExample1.yaml index 60fc861ada..175b2942ca 100644 --- a/specification/watcher/stop/examples/response/WatcherStopResponseExample1.yaml +++ b/specification/watcher/stop/examples/response/WatcherStopResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: '' -method_request: POST _watcher/_stop description: A successful response from `POST _watcher/_stop`. # type: response # response_code: 200 diff --git a/specification/xpack/info/examples/request/XPackInfoRequestExample1.yaml b/specification/xpack/info/examples/request/XPackInfoRequestExample1.yaml new file mode 100644 index 0000000000..5a9b53dc54 --- /dev/null +++ b/specification/xpack/info/examples/request/XPackInfoRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_xpack diff --git a/specification/xpack/info/examples/response/XPackInfoResponseExample1.yaml b/specification/xpack/info/examples/response/XPackInfoResponseExample1.yaml index 4001461db1..e728a6491d 100644 --- a/specification/xpack/info/examples/response/XPackInfoResponseExample1.yaml +++ b/specification/xpack/info/examples/response/XPackInfoResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_xpack description: A successful response from `GET /_xpack`. # type: response # response_code: 200 diff --git a/specification/xpack/usage/examples/request/XPackUsageRequestExample1.yaml b/specification/xpack/usage/examples/request/XPackUsageRequestExample1.yaml new file mode 100644 index 0000000000..7d5b9e797c --- /dev/null +++ b/specification/xpack/usage/examples/request/XPackUsageRequestExample1.yaml @@ -0,0 +1 @@ +method_request: GET /_xpack/usage diff --git a/specification/xpack/usage/examples/response/XPackUsageResponseExample1.yaml b/specification/xpack/usage/examples/response/XPackUsageResponseExample1.yaml index 8a5b450c98..744dff7063 100644 --- a/specification/xpack/usage/examples/response/XPackUsageResponseExample1.yaml +++ b/specification/xpack/usage/examples/response/XPackUsageResponseExample1.yaml @@ -1,5 +1,4 @@ # summary: -method_request: GET /_xpack/usage description: An abbreviated response from `GET /_xpack/usage`. # type: response # response_code: 200