[DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413)

* Remove `es-test-dir` book-scoped variable

* Remove `plugins-examples-dir` book-scoped variable

* Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables

- In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed.
- In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path
- In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem

* Replace `es-repo-dir` with `es-ref-dir`

* Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
This commit is contained in:
Liam Thompson 2024-04-17 14:37:07 +02:00 committed by GitHub
parent 9b91d9c072
commit 33a71e3289
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
344 changed files with 2331 additions and 2328 deletions

View file

@ -454,11 +454,11 @@ Requires the `manage_ml` cluster privilege. This privilege is included in the
`<job_id>`::
(Required, string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
`<snapshot_id>`::
(Required, string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=snapshot-id]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=snapshot-id]
[[ml-update-snapshot-request-body]]
== {api-request-body-title}
@ -470,7 +470,7 @@ The following properties can be updated after the model snapshot is created:
`retain`::
(Optional, Boolean)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=retain]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=retain]
[[ml-update-snapshot-example]]

View file

@ -40,15 +40,15 @@ is an object it has the following properties:
=====
`char_filter`::::
(array of strings or objects)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=char-filter]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=char-filter]
`tokenizer`::::
(string or object)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=tokenizer]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=tokenizer]
`filter`::::
(array of strings or objects)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=filter]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=filter]
=====
`categorization_filters`::

View file

@ -65,7 +65,7 @@ aggregations some options can be overridden for each of the two types of model.
`num_top_feature_importance_values`::
(Optional, integer)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-regression-num-top-feature-importance-values]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-regression-num-top-feature-importance-values]
[discrete]
[[inference-agg-classification-opt]]
@ -73,15 +73,15 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-regression-num
`num_top_classes`::
(Optional, integer)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-classes]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-classes]
`num_top_feature_importance_values`::
(Optional, integer)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-feature-importance-values]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-feature-importance-values]
`prediction_field_type`::
(Optional, string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-prediction-field-type]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-prediction-field-type]
[[inference-bucket-agg-example]]

View file

@ -308,7 +308,7 @@ POST _aliases
----
// TEST[s/^/PUT _data_stream\/logs-nginx.access-prod\nPUT _data_stream\/logs-my_app-default\n/]
include::{es-repo-dir}/indices/aliases.asciidoc[tag=write-index-defaults]
include::{es-ref-dir}/indices/aliases.asciidoc[tag=write-index-defaults]
TIP: We recommend using data streams to store append-only time series data. If
you need to update or delete existing time series data, you can perform update or delete operations

View file

@ -48,7 +48,7 @@ Where the file looks like:
[source,stemmer_override]
--------------------------------------------------
include::{es-test-dir}/cluster/config/analysis/stemmer_override.txt[]
include::{elasticsearch-root}/docs/src/test/cluster/config/analysis/stemmer_override.txt[]
--------------------------------------------------
You can also define the overrides rules inline:

View file

@ -205,18 +205,18 @@ on a remote cluster is currently not supported. For example, this will throw an
Multi-target APIs that can target indices support the following query
string parameters:
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
The defaults settings for the above parameters depend on the API being used.
Some multi-target APIs that can target indices also support the following query
string parameter:
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ignore_throttled]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=ignore_throttled]
NOTE: APIs with a single target, such as the <<docs-get,get document API>>, do
not support multi-target syntax.

View file

@ -39,19 +39,19 @@ wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or
[[cat-alias-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
[[cat-alias-api-example]]
==== {api-examples-title}

View file

@ -30,26 +30,26 @@ and their disk space.
[[cat-allocation-api-path-params]]
==== {api-path-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=node-id]
[[cat-allocation-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bytes]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
[[cat-allocation-api-response-body]]
==== {api-response-body-title}

View file

@ -43,20 +43,20 @@ For more information about {anomaly-detect}, see
`<job_id>`::
(Optional, string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
[[cat-anomaly-detectors-query-params]]
==== {api-query-parms-title}
`allow_no_match`::
(Optional, Boolean)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-jobs]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-jobs]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bytes]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
+
If you do not specify which columns to include, the API returns the default
columns. If you explicitly specify one or more columns, it returns only the
@ -65,75 +65,75 @@ specified columns.
Valid columns are:
`assignment_explanation`, `ae`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=assignment-explanation-anomaly-jobs]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=assignment-explanation-anomaly-jobs]
`buckets.count`, `bc`, `bucketsCount`:::
(Default)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-count-anomaly-jobs]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-count-anomaly-jobs]
`buckets.time.exp_avg`, `btea`, `bucketsTimeExpAvg`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-time-exponential-average]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-time-exponential-average]
`buckets.time.exp_avg_hour`, `bteah`, `bucketsTimeExpAvgHour`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-time-exponential-average-hour]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-time-exponential-average-hour]
`buckets.time.max`, `btmax`, `bucketsTimeMax`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-time-maximum]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-time-maximum]
`buckets.time.min`, `btmin`, `bucketsTimeMin`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-time-minimum]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-time-minimum]
`buckets.time.total`, `btt`, `bucketsTimeTotal`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-time-total]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-time-total]
`data.buckets`, `db`, `dataBuckets`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-count]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-count]
`data.earliest_record`, `der`, `dataEarliestRecord`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=earliest-record-timestamp]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=earliest-record-timestamp]
`data.empty_buckets`, `deb`, `dataEmptyBuckets`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=empty-bucket-count]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=empty-bucket-count]
`data.input_bytes`, `dib`, `dataInputBytes`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=input-bytes]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=input-bytes]
`data.input_fields`, `dif`, `dataInputFields`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=input-field-count]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=input-field-count]
`data.input_records`, `dir`, `dataInputRecords`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=input-record-count]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=input-record-count]
`data.invalid_dates`, `did`, `dataInvalidDates`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=invalid-date-count]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=invalid-date-count]
`data.last`, `dl`, `dataLast`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=last-data-time]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=last-data-time]
`data.last_empty_bucket`, `dleb`, `dataLastEmptyBucket`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=latest-empty-bucket-timestamp]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=latest-empty-bucket-timestamp]
`data.last_sparse_bucket`, `dlsb`, `dataLastSparseBucket`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=latest-sparse-record-timestamp]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=latest-sparse-record-timestamp]
`data.latest_record`, `dlr`, `dataLatestRecord`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=latest-record-timestamp]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=latest-record-timestamp]
`data.missing_fields`, `dmf`, `dataMissingFields`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=missing-field-count]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=missing-field-count]
`data.out_of_order_timestamps`, `doot`, `dataOutOfOrderTimestamps`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=out-of-order-timestamp-count]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=out-of-order-timestamp-count]
`data.processed_fields`, `dpf`, `dataProcessedFields`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=processed-field-count]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=processed-field-count]
`data.processed_records`, `dpr`, `dataProcessedRecords`:::
(Default)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=processed-record-count]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=processed-record-count]
`data.sparse_buckets`, `dsb`, `dataSparseBuckets`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=sparse-bucket-count]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=sparse-bucket-count]
`forecasts.memory.avg`, `fmavg`, `forecastsMemoryAvg`:::
The average memory usage in bytes for forecasts related to the {anomaly-job}.
@ -177,99 +177,99 @@ The total runtime in milliseconds for forecasts related to the {anomaly-job}.
`forecasts.total`, `ft`, `forecastsTotal`:::
(Default)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=forecast-total]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=forecast-total]
`id`:::
(Default)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
`model.bucket_allocation_failures`, `mbaf`, `modelBucketAllocationFailures`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-allocation-failures-count]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-allocation-failures-count]
`model.by_fields`, `mbf`, `modelByFields`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=total-by-field-count]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=total-by-field-count]
`model.bytes`, `mb`, `modelBytes`:::
(Default)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-bytes]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-bytes]
`model.bytes_exceeded`, `mbe`, `modelBytesExceeded`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-bytes-exceeded]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-bytes-exceeded]
`model.categorization_status`, `mcs`, `modelCategorizationStatus`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=categorization-status]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=categorization-status]
`model.categorized_doc_count`, `mcdc`, `modelCategorizedDocCount`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=categorized-doc-count]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=categorized-doc-count]
`model.dead_category_count`, `mdcc`, `modelDeadCategoryCount`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dead-category-count]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=dead-category-count]
`model.failed_category_count`, `mdcc`, `modelFailedCategoryCount`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=failed-category-count]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=failed-category-count]
`model.frequent_category_count`, `mfcc`, `modelFrequentCategoryCount`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=frequent-category-count]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=frequent-category-count]
`model.log_time`, `mlt`, `modelLogTime`:::
The timestamp when the model stats were gathered, according to server time.
`model.memory_limit`, `mml`, `modelMemoryLimit`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-memory-limit-anomaly-jobs]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-memory-limit-anomaly-jobs]
`model.memory_status`, `mms`, `modelMemoryStatus`:::
(Default)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-memory-status]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-memory-status]
`model.over_fields`, `mof`, `modelOverFields`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=total-over-field-count]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=total-over-field-count]
`model.partition_fields`, `mpf`, `modelPartitionFields`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=total-partition-field-count]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=total-partition-field-count]
`model.rare_category_count`, `mrcc`, `modelRareCategoryCount`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=rare-category-count]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=rare-category-count]
`model.timestamp`, `mt`, `modelTimestamp`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-timestamp]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=model-timestamp]
`model.total_category_count`, `mtcc`, `modelTotalCategoryCount`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=total-category-count]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=total-category-count]
`node.address`, `na`, `nodeAddress`:::
The network address of the node.
+
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-jobs]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-jobs]
`node.ephemeral_id`, `ne`, `nodeEphemeralId`:::
The ephemeral ID of the node.
+
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-jobs]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-jobs]
`node.id`, `ni`, `nodeId`:::
The unique identifier of the node.
+
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-jobs]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-jobs]
`node.name`, `nn`, `nodeName`:::
The node name.
+
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-jobs]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-jobs]
`opened_time`, `ot`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=open-time]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=open-time]
`state`, `s`:::
(Default)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=state-anomaly-job]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=state-anomaly-job]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
[[cat-anomaly-detectors-example]]
==== {api-examples-title}

View file

@ -40,19 +40,19 @@ wildcard expressions. If omitted, all component templates are returned.
[[cat-component-templates-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
[[cat-component-templates-api-example]]

View file

@ -43,15 +43,15 @@ and indices, omit this parameter or use `*` or `_all`.
[[cat-count-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
[[cat-count-api-example]]

View file

@ -42,18 +42,18 @@ NOTE: This API returns a maximum of 10,000 jobs.
`<feed_id>`::
(Optional, string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=datafeed-id]
[[cat-datafeeds-query-params]]
==== {api-query-parms-title}
`allow_no_match`::
(Optional, Boolean)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-datafeeds]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-datafeeds]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
+
If you do not specify which columns to include, the API returns the default
columns. If you explicitly specify one or more columns, it returns only the
@ -62,60 +62,60 @@ specified columns.
Valid columns are:
`assignment_explanation`, `ae`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=assignment-explanation-datafeeds]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=assignment-explanation-datafeeds]
`buckets.count`, `bc`, `bucketsCount`:::
(Default)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-count]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=bucket-count]
`id`:::
(Default)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=datafeed-id]
`node.address`, `na`, `nodeAddress`:::
The network address of the node.
+
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-datafeeds]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-datafeeds]
`node.ephemeral_id`, `ne`, `nodeEphemeralId`:::
The ephemeral ID of the node.
+
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-datafeeds]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-datafeeds]
`node.id`, `ni`, `nodeId`:::
The unique identifier of the node.
+
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-datafeeds]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-datafeeds]
`node.name`, `nn`, `nodeName`:::
The node name.
+
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-datafeeds]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=node-datafeeds]
`search.bucket_avg`, `sba`, `searchBucketAvg`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=search-bucket-avg]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=search-bucket-avg]
`search.count`, `sc`, `searchCount`:::
(Default)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=search-count]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=search-count]
`search.exp_avg_hour`, `seah`, `searchExpAvgHour`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=search-exp-avg-hour]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=search-exp-avg-hour]
`search.time`, `st`, `searchTime`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=search-time]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=search-time]
`state`, `s`:::
(Default)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=state-datafeed]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=state-datafeed]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
[[cat-datafeeds-example]]
==== {api-examples-title}

View file

@ -46,15 +46,15 @@ For more information, see <<security-privileges>> and {ml-docs-setup-privileges}
`<data_frame_analytics_id>`::
(Optional, string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-default]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-default]
[[cat-dfanalytics-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
+
If you do not specify which columns to include, the API returns the default
columns. If you explicitly specify one or more columns, it returns only the
@ -63,14 +63,14 @@ specified columns.
Valid columns are:
`assignment_explanation`, `ae`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=assignment-explanation-dfanalytics]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=assignment-explanation-dfanalytics]
`create_time`, `ct`, `createTime`:::
(Default)
The time when the {dfanalytics-job} was created.
`description`, `d`:::
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=description-dfa]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=description-dfa]
`dest_index`, `di`, `destIndex`:::
Name of the destination index.
@ -80,7 +80,7 @@ Contains messages about the reason why a {dfanalytics-job} failed.
`id`:::
(Default)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics]
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics]
`model_memory_limit`, `mml`, `modelMemoryLimit`:::
The approximate maximum amount of memory resources that are permitted for the
@ -115,13 +115,13 @@ The type of analysis that the {dfanalytics-job} performs.
`version`, `v`:::
The {es} version number in which the {dfanalytics-job} was created.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
[[cat-dfanalytics-example]]

View file

@ -39,17 +39,17 @@ information.
[[cat-fielddata-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bytes]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
[[cat-fielddata-api-example]]

View file

@ -51,22 +51,22 @@ over a longer period of time. See <<cat-health-api-example-large-cluster>>.
[[cat-health-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time]
`ts` (timestamps)::
(Optional, Boolean) If `true`, returns `HH:MM:SS` and
{wikipedia}/Unix_time[Unix `epoch`] timestamps. Defaults to
`true`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
[[cat-health-api-example]]

View file

@ -62,11 +62,11 @@ and indices, omit this parameter or use `*` or `_all`.
[[cat-indices-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bytes]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
`health`::
+
@ -81,24 +81,24 @@ are:
By default, the response includes indices of any health status.
--
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-unloaded-segments]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=include-unloaded-segments]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[[pri-flag]]
`pri` (primary shards)::
(Optional, Boolean) If `true`, the response only includes information from
primary shards. Defaults to `false`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
[[cat-indices-api-example]]

View file

@ -29,19 +29,19 @@ and name.
[[cat-master-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
[[cat-master-api-example]]

View file

@ -27,9 +27,9 @@ Returns information about custom node attributes.
[[cat-nodeattrs-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
+
--
If you do not specify which columns to include, the API returns the default columns in the order listed below. If you explicitly specify one or more columns, it only returns the specified columns.
@ -61,15 +61,15 @@ Process ID, such as `13061`.
Bound transport port, such as `9300`.
--
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
[[cat-nodeattrs-api-example]]

View file

@ -27,15 +27,15 @@ Returns information about a cluster's nodes.
[[cat-nodes-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bytes]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
`full_id`::
(Optional, Boolean) If `true`, return the full node ID. If `false`, return the
shortened node ID. Defaults to `false`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
+
--
If you do not specify which columns to include, the API returns the default columns in the order listed below. If you explicitly specify one or more columns, it only returns the specified columns.
@ -328,17 +328,17 @@ Number of mappings, including <<runtime,runtime>> and <<object,object>> fields.
Estimated heap overhead, in bytes, of mappings on this node, which allows for 1KiB of heap for every mapped field.
--
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-unloaded-segments]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=include-unloaded-segments]
[[cat-nodes-api-example]]
==== {api-examples-title}

View file

@ -28,21 +28,21 @@ Returns cluster-level changes that have not yet been executed, similar to the
[[cat-pending-tasks-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
[[cat-pending-tasks-api-example]]

View file

@ -29,19 +29,19 @@ Returns a list of plugins running on each node of a cluster.
[[cat-plugins-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
[[cat-plugins-api-example]]

View file

@ -39,7 +39,7 @@ The cat recovery API returns information about shard recoveries, both
ongoing and completed. It is a more compact view of the JSON
<<indices-recovery,index recovery>> API.
include::{es-repo-dir}/indices/recovery.asciidoc[tag=shard-recovery-desc]
include::{es-ref-dir}/indices/recovery.asciidoc[tag=shard-recovery-desc]
[[cat-recovery-path-params]]
@ -53,25 +53,25 @@ and indices, omit this parameter or use `*` or `_all`.
[[cat-recovery-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=active-only]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=active-only]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bytes]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=detailed]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=detailed]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-query-parm]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-query-parm]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
[[cat-recovery-api-example]]

View file

@ -29,19 +29,19 @@ Returns the <<snapshots-register-repository,snapshot repositories>> for a cluste
[[cat-repositories-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
[[cat-repositories-api-example]]

View file

@ -44,11 +44,11 @@ and indices, omit this parameter or use `*` or `_all`.
[[cat-segments-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bytes]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
+
--
If you do not specify which columns to include, the API returns the default
@ -71,39 +71,39 @@ Valid columns are:
`segment`::
(Default)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=segment]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=segment]
`generation`::
(Default)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=generation]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=generation]
`docs.count`::
(Default)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-count]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=docs-count]
`docs.deleted`::
(Default)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-deleted]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=docs-deleted]
`size`::
(Default)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=segment-size]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=segment-size]
`size.memory`::
(Default)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=memory]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=memory]
`committed`::
(Default)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=committed]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=committed]
`searchable`::
(Default)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=segment-search]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=segment-search]
`version`::
(Default)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=segment-version]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=segment-version]
`compound`::
(Default) If `true`, the segment is stored in a compound file. This means Lucene
@ -113,11 +113,11 @@ merged all files from the segment in a single file to save file descriptors.
ID of the node, such as `k0zy`.
--
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
[[cat-segments-api-example]]

View file

@ -44,11 +44,11 @@ and indices, omit this parameter or use `*` or `_all`.
[[cat-shards-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bytes]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
+
--
If you do not specify which columns to include, the API returns the default
@ -297,15 +297,15 @@ values include:
--
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
[[cat-shards-api-example]]

View file

@ -46,9 +46,9 @@ If any repository fails during the request, {es} returns an error.
[[cat-snapshots-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
+
--
If you do not specify which columns to include, the API returns the default
@ -107,19 +107,19 @@ units>>.
Reason for any snapshot failures.
--
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
`ignore_unavailable`::
(Optional, Boolean) If `true`, the response does not include information from
unavailable snapshots. Defaults to `false`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
[[cat-snapshots-api-example]]

View file

@ -41,13 +41,13 @@ of the JSON <<tasks,task management>> API.
[[cat-tasks-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=detailed]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=detailed]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
`nodes`::
(Optional, string)
@ -58,17 +58,17 @@ wildcard (`*`) expressions.
(Optional, string)
Parent task ID used to limit the response.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
[[cat-tasks-api-response-codes]]
==== {api-response-codes-title}
include::{es-repo-dir}/cluster/tasks.asciidoc[tag=tasks-api-404]
include::{es-ref-dir}/cluster/tasks.asciidoc[tag=tasks-api-404]
[[cat-tasks-api-examples]]

View file

@ -39,19 +39,19 @@ expressions. If omitted, all templates are returned.
[[cat-templates-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
[[cat-templates-api-example]]

View file

@ -40,9 +40,9 @@ request. Accepts wildcard expressions.
[[cat-thread-pool-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
+
--
If you do not specify which columns to include, the API returns the default
@ -113,17 +113,17 @@ Type of thread pool. Returned values are `fixed`, `fixed_auto_queue_size`, `dire
--
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
[[cat-thread-pool-api-example]]

View file

@ -41,11 +41,11 @@ For more information, see <<security-privileges>> and {ml-docs-setup-privileges}
[[cat-trained-model-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bytes]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
+
If you do not specify which columns to include, the API returns the default
columns. If you explicitly specify one or more columns, it returns only the
@ -102,13 +102,13 @@ measuring the computational complexity of the model.
`version`, `v`:::
The {es} version number in which the trained model was created.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
[[cat-trained-model-example]]

View file

@ -41,22 +41,22 @@ privileges. For more information, see <<security-privileges>> and
`<transform_id>`::
(Optional, string)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id-wildcard]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-id-wildcard]
[[cat-transforms-api-query-params]]
==== {api-query-parms-title}
`allow_no_match`::
(Optional, Boolean)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-match-transforms1]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-match-transforms1]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
`from`::
(Optional, integer)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=from-transforms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=from-transforms]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
+
If you do not specify which columns to include, the API returns the default
columns. If you explicitly specify one or more columns, it returns only the
@ -66,14 +66,14 @@ Valid columns are:
`changes_last_detection_time`, `cldt`:::
(Default)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=checkpointing-changes-last-detected-at]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=checkpointing-changes-last-detected-at]
`checkpoint`, `cp`:::
(Default)
The sequence number for the checkpoint.
`checkpoint_duration_time_exp_avg`, `cdtea`, `checkpointTimeExpAvg`:::
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-checkpoint-duration-ms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-checkpoint-duration-ms]
`checkpoint_progress`, `c`, `checkpointProgress`:::
(Default)
@ -83,106 +83,106 @@ The progress of the next checkpoint that is currently in progress.
The time the {transform} was created.
`delete_time`, `dtime`:::
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=delete-time-ms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=delete-time-ms]
`description`, `d`:::
The description of the {transform}.
`dest_index`, `di`, `destIndex`:::
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-index]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-index]
`documents_deleted`, `docd`:::
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-deleted-transform]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=docs-deleted-transform]
`documents_indexed`, `doci`:::
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-indexed]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=docs-indexed]
`docs_per_second`, `dps`:::
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-docs-per-second]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-docs-per-second]
`documents_processed`, `docp`:::
(Default)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-processed]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=docs-processed]
`frequency`, `f`:::
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=frequency]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=frequency]
`id`:::
(Default)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-id]
`index_failure`, `if`:::
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-failures]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-failures]
`index_time`, `itime`:::
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-time-ms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-time-ms]
`index_total`, `it`:::
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-total]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-total]
`indexed_documents_exp_avg`, `idea`:::
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-documents-indexed]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-documents-indexed]
`last_search_time`, `lst`, `lastSearchTime`:::
(Default)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=checkpointing-last-search-time]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=checkpointing-last-search-time]
`max_page_search_size`, `mpsz`:::
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size]
`pages_processed`, `pp`:::
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pages-processed]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=pages-processed]
`pipeline`, `p`:::
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-pipeline]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=dest-pipeline]
`processed_documents_exp_avg`, `pdea`:::
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-documents-processed]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-documents-processed]
`processing_time`, `pt`:::
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=processing-time-ms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=processing-time-ms]
`reason`, `r`:::
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=state-transform-reason]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=state-transform-reason]
`search_failure`, `sf`:::
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-failures]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search-failures]
`search_time`, `stime`:::
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-time-ms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search-time-ms]
`search_total`, `st`:::
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-total]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search-total]
`source_index`, `si`, `sourceIndex`:::
(Default)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-index-transforms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source-index-transforms]
`state`, `s`:::
(Default)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=state-transform]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=state-transform]
`transform_type`, `tt`:::
Indicates the type of {transform}: `batch` or `continuous`.
`trigger_count`, `tc`:::
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=trigger-count]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=trigger-count]
`version`, `v`:::
The version of {es} that existed on the node when the {transform} was
created.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
`size`::
(Optional, integer)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=size-transforms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=size-transforms]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
[[cat-transforms-api-examples]]
==== {api-examples-title}

View file

@ -57,7 +57,7 @@ This API deletes a configured collection of
[[ccr-delete-auto-follow-pattern-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[[ccr-delete-auto-follow-pattern-examples]]
==== {api-examples-title}

View file

@ -75,7 +75,7 @@ This API will return the specified auto-follow pattern collection.
[[ccr-get-auto-follow-pattern-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[[ccr-get-auto-follow-pattern-examples]]
==== {api-examples-title}

View file

@ -43,7 +43,7 @@ meantime.
[[ccr-pause-auto-follow-pattern-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[[ccr-pause-auto-follow-pattern-examples]]
==== {api-examples-title}

View file

@ -74,7 +74,7 @@ the new patterns.
[[ccr-put-auto-follow-pattern-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[[ccr-put-auto-follow-pattern-request-body]]
==== {api-request-body-title}

View file

@ -38,7 +38,7 @@ have been deleted or closed in the meantime.
[[ccr-resume-auto-follow-pattern-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[[ccr-resume-auto-follow-pattern-examples]]
==== {api-examples-title}

View file

@ -52,7 +52,7 @@ replication options and whether the follower indices are active or paused.
[[ccr-get-follow-info-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[role="child_attributes"]
[[ccr-get-follow-info-response-body]]

View file

@ -56,7 +56,7 @@ following task.
[[ccr-post-pause-follow-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[[ccr-post-pause-follow-examples]]
==== {api-examples-title}

View file

@ -69,7 +69,7 @@ returns, the follower index will resume fetching operations from the leader inde
[[ccr-post-resume-follow-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[[ccr-post-resume-follow-request-body]]
==== {api-request-body-title}

View file

@ -63,7 +63,7 @@ irreversible operation.
[[ccr-post-unfollow-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[[ccr-post-unfollow-examples]]
==== {api-examples-title}

View file

@ -65,7 +65,7 @@ referenced leader index. When this API returns, the follower index exists, and
follower shard requires transferring all the remote Lucene segment files to
the follower index.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[[ccr-put-follow-request-body]]
==== {api-request-body-title}

View file

@ -56,7 +56,7 @@ shard-level stats as in the <<ccr-get-follow-stats,get follower stats API>>.
`timeout`::
(Optional, time) Controls the amount of time to wait for results. Defaults to unlimited.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[role="child_attributes"]
[[ccr-get-stats-response-body]]

View file

@ -159,7 +159,7 @@ cluster with cluster alias `leader`.
connected to.
====
include::{es-repo-dir}/security/authentication/remote-clusters-privileges-cert.asciidoc[tag=configure-ccr-privileges]
include::{es-ref-dir}/security/authentication/remote-clusters-privileges-cert.asciidoc[tag=configure-ccr-privileges]
[[ccr-getting-started-follower-index]]
==== Create a follower index to replicate a specific index

View file

@ -34,10 +34,10 @@ defined, but can also include the default settings by calling the
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=flat-settings]
`include_defaults`::
(Optional, Boolean) If `true`, returns default cluster settings from the local node.
Defaults to `false`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]

View file

@ -61,9 +61,9 @@ To target all data streams and indices in a cluster, omit this parameter or use
(Optional, string) Can be one of `cluster`, `indices` or `shards`. Controls
the details level of the health information returned. Defaults to `cluster`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
`wait_for_active_shards`::
(Optional, string) A number controlling to how many active shards to wait
@ -104,7 +104,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
(string) The name of the cluster.
`status`::
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cluster-health-status]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cluster-health-status]
`timed_out`::
(Boolean) If `false` the response returned within the period of

View file

@ -30,7 +30,7 @@ threads.
[[cluster-nodes-hot-threads-api-path-params]]
==== {api-path-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=node-id]
[[cluster-nodes-hot-threads-api-query-params]]
@ -56,7 +56,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id]
troubleshooting, set this parameter to a large number (e.g.
`9999`) to get information about all the threads in the system.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
`type`::
(Optional, string) The type to sample. Available options are `block`, `cpu`, and

View file

@ -101,7 +101,7 @@ can also request the metric `_all` to retrieve all metrics, or you can request
the metric `_none` to suppress all metrics and retrieve only the identity of
the node.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=node-id]
[[cluster-nodes-info-api-response-body]]
==== {api-response-body-title}
@ -182,9 +182,9 @@ running process:
[[cluster-nodes-info-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=flat-settings]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
[[cluster-nodes-info-api-example]]

View file

@ -127,31 +127,31 @@ using metrics.
* `dense_vector`
--
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=node-id]
[[cluster-nodes-stats-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=completion-fields]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=completion-fields]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fielddata-fields]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=fielddata-fields]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fields]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=fields]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=groups]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=groups]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=level]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=level]
`types`::
(Optional, string) A comma-separated list of document types for the
`indexing` index metric.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-segment-file-sizes]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=include-segment-file-sizes]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-unloaded-segments]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=include-unloaded-segments]
[role="child_attributes"]
[[cluster-nodes-stats-api-response-body]]
@ -244,11 +244,11 @@ node.
=======
`count`::
(integer)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-count]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=docs-count]
`deleted`::
(integer)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-deleted]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=docs-deleted]
=======
`store`::

View file

@ -48,13 +48,13 @@ of features for each node. All the nodes selective options are explained
that action has been called on the node.
--
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=node-id]
[[cluster-nodes-usage-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
[[cluster-nodes-usage-api-example]]

View file

@ -34,9 +34,9 @@ might be reported by both task api and pending cluster tasks API.
[[cluster-pending-api-path-params]]
==== {api-path-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[[cluster-pending-api-response-body]]

View file

@ -34,7 +34,7 @@ Note that if the prevalidation result for a set of nodes returns `true` (i.e. it
[[prevalidate-node-removal-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
`names`::
(Optional, string) Comma-separated list of node names.

View file

@ -112,7 +112,7 @@ query parameter, which will attempt a single retry round for these shards.
(Optional, Boolean) If `true`, then retries allocation of shards that are
blocked due to too many subsequent allocation failures.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
[role="child_attributes"]
[[cluster-reroute-api-request-body]]

View file

@ -115,15 +115,15 @@ Defaults to `true`.
that are open, closed or both. Available options: `open`, `closed`, `none`,
`all`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=flat-settings]
`ignore_unavailable`::
(Optional, Boolean) If `true`, unavailable indices (missing or closed) will
be ignored.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
`wait_for_metadata_version`::
(Optional, integer) Waits for the metadata version to be equal or greater

View file

@ -33,7 +33,7 @@ memory usage) and information about the current nodes that form the cluster
==== {api-path-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-filter]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=node-filter]
[[cluster-stats-api-query-params]]
@ -86,7 +86,7 @@ Unique identifier for the cluster.
the last time the cluster statistics were refreshed.
`status`::
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cluster-health-status]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cluster-health-status]
+
See <<cluster-health>>.

View file

@ -32,23 +32,23 @@ on one or more nodes in the cluster.
[[tasks-api-path-params]]
==== {api-path-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=task-id]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=task-id]
[[tasks-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=actions]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=actions]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=detailed]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=detailed]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=group-by]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=group-by]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=nodes]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=nodes]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=parent-task-id]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=parent-task-id]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
`wait_for_completion`::
(Optional, Boolean) If `true`, the request blocks until all found tasks are complete.

View file

@ -47,7 +47,7 @@ DELETE /_internal/desired_nodes
[[update-desired-nodes-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
`dry_run`::
(Optional, Boolean) If `true`, then the request simulates the update and

View file

@ -22,18 +22,18 @@ Configures <<dynamic-cluster-setting,dynamic cluster settings>>.
==== {api-description-title}
:strip-api-link: true
include::{es-repo-dir}/setup/configuration.asciidoc[tag=cluster-setting-precedence]
include::{es-ref-dir}/setup/configuration.asciidoc[tag=cluster-setting-precedence]
[[cluster-update-settings-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=flat-settings]
`include_defaults`::
(Optional, Boolean) If `true`, returns all default cluster settings.
Defaults to `false`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
[[cluster-update-settings-api-example]]

View file

@ -41,34 +41,34 @@ The following API is available for <<tsds,time series data streams>>:
For concepts and tutorials, see <<data-streams>>.
include::{es-repo-dir}/indices/create-data-stream.asciidoc[]
include::{es-ref-dir}/indices/create-data-stream.asciidoc[]
include::{es-repo-dir}/indices/delete-data-stream.asciidoc[]
include::{es-ref-dir}/indices/delete-data-stream.asciidoc[]
include::{es-repo-dir}/indices/get-data-stream.asciidoc[]
include::{es-ref-dir}/indices/get-data-stream.asciidoc[]
include::{es-repo-dir}/indices/migrate-to-data-stream.asciidoc[]
include::{es-ref-dir}/indices/migrate-to-data-stream.asciidoc[]
include::{es-repo-dir}/indices/data-stream-stats.asciidoc[]
include::{es-ref-dir}/indices/data-stream-stats.asciidoc[]
include::{es-repo-dir}/data-streams/promote-data-stream-api.asciidoc[]
include::{es-ref-dir}/data-streams/promote-data-stream-api.asciidoc[]
include::{es-repo-dir}/data-streams/modify-data-streams-api.asciidoc[]
include::{es-ref-dir}/data-streams/modify-data-streams-api.asciidoc[]
include::{es-repo-dir}/data-streams/lifecycle/apis/put-lifecycle.asciidoc[]
include::{es-ref-dir}/data-streams/lifecycle/apis/put-lifecycle.asciidoc[]
include::{es-repo-dir}/data-streams/lifecycle/apis/get-lifecycle.asciidoc[]
include::{es-ref-dir}/data-streams/lifecycle/apis/get-lifecycle.asciidoc[]
include::{es-repo-dir}/data-streams/lifecycle/apis/delete-lifecycle.asciidoc[]
include::{es-ref-dir}/data-streams/lifecycle/apis/delete-lifecycle.asciidoc[]
include::{es-repo-dir}/data-streams/lifecycle/apis/explain-lifecycle.asciidoc[]
include::{es-ref-dir}/data-streams/lifecycle/apis/explain-lifecycle.asciidoc[]
include::{es-repo-dir}/data-streams/lifecycle/apis/get-lifecycle-stats.asciidoc[]
include::{es-ref-dir}/data-streams/lifecycle/apis/get-lifecycle-stats.asciidoc[]
include::{es-repo-dir}/data-streams/lifecycle/apis/put-global-retention.asciidoc[]
include::{es-ref-dir}/data-streams/lifecycle/apis/put-global-retention.asciidoc[]
include::{es-repo-dir}/data-streams/lifecycle/apis/get-global-retention.asciidoc[]
include::{es-ref-dir}/data-streams/lifecycle/apis/get-global-retention.asciidoc[]
include::{es-repo-dir}/data-streams/lifecycle/apis/delete-global-retention.asciidoc[]
include::{es-ref-dir}/data-streams/lifecycle/apis/delete-global-retention.asciidoc[]
include::{es-repo-dir}/indices/downsample-data-stream.asciidoc[]
include::{es-ref-dir}/indices/downsample-data-stream.asciidoc[]

View file

@ -37,7 +37,7 @@ To target all data streams use `*` or `_all`.
[[delete-data-lifecycle-api-query-parms]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ds-expand-wildcards]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=ds-expand-wildcards]
+
Defaults to `open`.

View file

@ -40,7 +40,7 @@ execution.
(Optional, Boolean) Includes default configurations related to the lifecycle of the target.
Defaults to `false`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
[[data-streams-explain-lifecycle-example]]
==== {api-examples-title}

View file

@ -28,9 +28,9 @@ Gets the global retention configuration that is applied on data streams managed
[[get-global-retention-api-query-parms]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[[get-global-retention-api-response-body]]
==== {api-response-body-title}

View file

@ -39,7 +39,7 @@ To target all data streams use `*` or `_all`.
[[get-data-lifecycle-api-query-parms]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ds-expand-wildcards]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=ds-expand-wildcards]
+
Defaults to `open`.

View file

@ -36,7 +36,7 @@ To target all data streams use `*` or `_all`.
[[put-data-lifecycle-api-query-parms]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ds-expand-wildcards]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=ds-expand-wildcards]
+
Defaults to `open`.

View file

@ -261,7 +261,7 @@ PUT _data_stream/my-data-stream
[[secure-data-stream]]
=== Secure the data stream
include::{es-repo-dir}/security/authorization/alias-privileges.asciidoc[tag=data-stream-security]
include::{es-ref-dir}/security/authorization/alias-privileges.asciidoc[tag=data-stream-security]
For an example, see <<data-stream-privileges>>.

View file

@ -249,21 +249,21 @@ on.
were executed for each `index` or `create`.
Defaults to `false`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pipeline]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=pipeline]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=refresh]
`require_alias`::
(Optional, Boolean) If `true`, the request's actions must target an index alias.
Defaults to `false`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_excludes]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source_excludes]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_includes]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source_includes]
`timeout`::
+
@ -280,7 +280,7 @@ timeout before failing. The actual wait time could be longer, particularly when
multiple waits occur.
--
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards]
[[bulk-api-request-body]]
==== {api-request-body-title}
@ -293,15 +293,15 @@ Indexes the specified document if it does not already exist.
The following line must contain the source data to be indexed.
+
--
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index-ds]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-index-ds]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-id]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-id]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-list-executed-pipelines]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-list-executed-pipelines]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-dynamic-templates]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-dynamic-templates]
--
`delete`::
@ -309,12 +309,12 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-dynamic-templates
Removes the specified document from the index.
+
--
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-index]
`_id`::
(Required, string) The document ID.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias]
--
`index`::
@ -324,15 +324,15 @@ If the document exists, replaces the document and increments the version.
The following line must contain the source data to be indexed.
+
--
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-index]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-id]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-id]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-list-executed-pipelines]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-list-executed-pipelines]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-dynamic-templates]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-dynamic-templates]
--
`update`::
@ -341,12 +341,12 @@ Performs a partial document update.
The following line must contain the partial document and update options.
+
--
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-index]
`_id`::
(Required, string) The document ID.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias]
--
`doc`::

View file

@ -175,76 +175,76 @@ this parameter or use `* or `_all`.
[[docs-delete-by-query-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
+
Defaults to `true`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=analyzer]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=analyzer]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=analyze_wildcard]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=analyze_wildcard]
`conflicts`::
(Optional, string) What to do if delete by query hits version conflicts:
`abort` or `proceed`. Defaults to `abort`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=default_operator]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=default_operator]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=df]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=df]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
+
Defaults to `open`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=lenient]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=lenient]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=max_docs]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=max_docs]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=preference]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-q]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search-q]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=request_cache]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=request_cache]
`refresh`::
(Optional, Boolean) If `true`, {es} refreshes all shards involved in the
delete by query after the request completes. Defaults to `false`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=requests_per_second]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=requests_per_second]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing]
`scroll`::
(Optional, <<time-units,time value>>)
Period to retain the <<scroll-search-context,search context>> for scrolling. See
<<scroll-search-results>>.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=scroll_size]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=scroll_size]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search_type]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search_type]
`search_timeout`::
(Optional, <<time-units, time units>>)
Explicit timeout for each search request.
Defaults to no timeout.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=slices]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=slices]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sort]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sort]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=stats]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=stats]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=terminate_after]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=terminate_after]
`timeout`::
(Optional, <<time-units, time units>>)
Period each deletion request <<index-wait-for-active-shards,waits for active
shards>>. Defaults to `1m` (one minute).
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=version]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards]
[[docs-delete-by-query-api-request-body]]
==== {api-request-body-title}

View file

@ -152,24 +152,24 @@ DELETE /my-index-000001/_doc/1?timeout=5m
[[docs-delete-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=if_seq_no]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=if_seq_no]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=if_primary_term]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=if_primary_term]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=refresh]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing]
`timeout`::
(Optional, <<time-units, time units>>)
Period to <<index-wait-for-active-shards,wait for active shards>>. Defaults to
`1m` (one minute).
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=doc-version]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=doc-version]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version_type]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=version_type]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards]
[[docs-delete-api-example]]
==== {api-examples-title}

View file

@ -162,27 +162,27 @@ deleted documents in the background as you continue to index more data.
[[docs-get-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=preference]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=realtime]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=realtime]
`refresh`::
(Optional, Boolean) If `true`, the request refreshes the relevant shard before
retrieving the document. Defaults to `false`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=stored_fields]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=stored_fields]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_excludes]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source_excludes]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_includes]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source_includes]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=doc-version]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=doc-version]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version_type]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=version_type]
[[docs-get-api-response-body]]
==== {api-response-body-title}

View file

@ -86,9 +86,9 @@ format and omit this parameter.
[[docs-index-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=if_seq_no]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=if_seq_no]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=if_primary_term]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=if_primary_term]
[[docs-index-api-op_type]]
`op_type`::
@ -101,11 +101,11 @@ If document id is specified, it defaults to `index`. Otherwise, it defaults to `
NOTE: If the request targets a data stream, an `op_type` of `create` is
required. See <<add-documents-to-a-data-stream>>.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pipeline]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=pipeline]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=refresh]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing]
`timeout`::
+
@ -122,13 +122,13 @@ timeout before failing. The actual wait time could be longer, particularly when
multiple waits occur.
--
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=doc-version]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=doc-version]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version_type]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=version_type]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=require-alias]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=require-alias]
[[docs-index-api-request-body]]
==== {api-request-body-title}

View file

@ -64,23 +64,23 @@ or when a document in the `docs` array does not specify an index.
[[docs-multi-get-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=preference]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=realtime]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=realtime]
`refresh`::
(Optional, Boolean) If `true`, the request refreshes relevant shards before
retrieving documents. Defaults to `false`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=stored_fields]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=stored_fields]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_excludes]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source_excludes]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_includes]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source_includes]
[[docs-multi-get-api-request-body]]
==== {api-request-body-title}

View file

@ -64,27 +64,27 @@ that can be included in the response.
[[docs-multi-termvectors-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fields]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=fields]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=field_statistics]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=field_statistics]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=offsets]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=offsets]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=payloads]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=payloads]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=positions]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=positions]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=preference]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=realtime]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=realtime]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=term_statistics]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=term_statistics]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=version]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version_type]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=version_type]
[discrete]
[[docs-multi-termvectors-api-example]]

View file

@ -483,21 +483,21 @@ timeout before failing. The actual wait time could be longer, particularly when
multiple waits occur.
--
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards]
`wait_for_completion`::
(Optional, Boolean) If `true`, the request blocks until the operation is complete.
Defaults to `true`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=requests_per_second]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=requests_per_second]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=require-alias]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=require-alias]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=scroll]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=scroll]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=slices]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=slices]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=max_docs]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=max_docs]
[[docs-reindex-api-request-body]]
==== {api-request-body-title}

View file

@ -143,27 +143,27 @@ from is randomly selected. Use `routing` only to hit a particular shard.
[[docs-termvectors-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fields]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=fields]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=field_statistics]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=field_statistics]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=offsets]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=offsets]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=payloads]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=payloads]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=positions]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=positions]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=preference]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=realtime]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=realtime]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=term_statistics]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=term_statistics]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=version]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version_type]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=version_type]
[[docs-termvectors-api-example]]
==== {api-examples-title}

View file

@ -167,70 +167,70 @@ this parameter or use `*` or `_all`.
[[docs-update-by-query-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
+
Defaults to `true`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=analyzer]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=analyzer]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=analyze_wildcard]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=analyze_wildcard]
`conflicts`::
(Optional, string) What to do if update by query hits version conflicts:
`abort` or `proceed`. Defaults to `abort`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=default_operator]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=default_operator]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=df]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=df]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
+
Defaults to `open`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=lenient]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=lenient]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=max_docs]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=max_docs]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pipeline]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=pipeline]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=preference]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-q]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search-q]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=request_cache]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=request_cache]
`refresh`::
(Optional, Boolean)
If `true`, {es} refreshes affected shards to make the operation visible to
search. Defaults to `false`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=requests_per_second]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=requests_per_second]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing]
`scroll`::
(Optional, <<time-units,time value>>)
Period to retain the <<scroll-search-context,search context>> for scrolling. See
<<scroll-search-results>>.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=scroll_size]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=scroll_size]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search_type]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search_type]
`search_timeout`::
(Optional, <<time-units, time units>>)
Explicit timeout for each search request.
Defaults to no timeout.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=slices]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=slices]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sort]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=sort]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=stats]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=stats]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=terminate_after]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=terminate_after]
`timeout`::
+
@ -246,9 +246,9 @@ timeout before failing. The actual wait time could be longer, particularly when
multiple waits occur.
--
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=version]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards]
[[docs-update-by-query-api-request-body]]
==== {api-request-body-title}

View file

@ -53,22 +53,22 @@ automatically if it doesn't exist. For more information, see <<index-creation>>.
[[docs-update-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=if_seq_no]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=if_seq_no]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=if_primary_term]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=if_primary_term]
`lang`::
(Optional, string) The script language. Default: `painless`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=require-alias]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=require-alias]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=refresh]
`retry_on_conflict`::
(Optional, integer) Specify how many times should the operation be retried when
a conflict occurs. Default: 0.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing]
`_source`::
(Optional, list) Set to `false` to disable source retrieval (default: `true`).
@ -94,7 +94,7 @@ timeout before failing. The actual wait time could be longer, particularly when
multiple waits occur.
--
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards]
[[update-api-example]]
==== {api-examples-title}

View file

@ -99,7 +99,7 @@ ignored.
Defaults to `true`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
+
Defaults to `open`.
@ -206,7 +206,7 @@ returned.
+
A greater `fetch_size` value often increases search speed but uses more memory.
include::{es-repo-dir}/search/search.asciidoc[tag=fields-param-def]
include::{es-ref-dir}/search/search.asciidoc[tag=fields-param-def]
`filter`::
(Optional, <<query-dsl,Query DSL object>>)
@ -280,7 +280,7 @@ command].
NOTE: This parameter may change the set of returned hits. However, it does not
change the sort order of hits in the response.
include::{es-repo-dir}/search/search.asciidoc[tag=runtime-mappings-def]
include::{es-ref-dir}/search/search.asciidoc[tag=runtime-mappings-def]
[[eql-search-api-params-size]]
`size`::

View file

@ -1013,7 +1013,7 @@ You can also use the `fields` parameter to retrieve and format specific fields
in the response. This field is identical to the search API's
<<search-fields,`fields` parameter>>.
include::{es-repo-dir}/search/search-your-data/retrieve-selected-fields.asciidoc[tag=fields-param-desc]
include::{es-ref-dir}/search/search-your-data/retrieve-selected-fields.asciidoc[tag=fields-param-desc]
The following search request uses the `fields` parameter to retrieve values for
the `event.type` field, all fields starting with `process.`, and the
@ -1039,7 +1039,7 @@ GET /my-data-stream/_eql/search?filter_path=-hits.events._source
----
// TEST[setup:sec_logs]
include::{es-repo-dir}/search/search-your-data/retrieve-selected-fields.asciidoc[tag=fields-param-callouts]
include::{es-ref-dir}/search/search-your-data/retrieve-selected-fields.asciidoc[tag=fields-param-callouts]
The response includes values as a flat list in the `fields` section for each
hit.

View file

@ -13,16 +13,16 @@ With {esql}, you can execute a single query across multiple clusters.
==== Prerequisites
include::{es-repo-dir}/search/search-your-data/search-across-clusters.asciidoc[tag=ccs-prereqs]
include::{es-ref-dir}/search/search-your-data/search-across-clusters.asciidoc[tag=ccs-prereqs]
include::{es-repo-dir}/search/search-your-data/search-across-clusters.asciidoc[tag=ccs-gateway-seed-nodes]
include::{es-ref-dir}/search/search-your-data/search-across-clusters.asciidoc[tag=ccs-gateway-seed-nodes]
include::{es-repo-dir}/search/search-your-data/search-across-clusters.asciidoc[tag=ccs-proxy-mode]
include::{es-ref-dir}/search/search-your-data/search-across-clusters.asciidoc[tag=ccs-proxy-mode]
[discrete]
[[ccq-remote-cluster-setup]]
==== Remote cluster setup
include::{es-repo-dir}/search/search-your-data/search-across-clusters.asciidoc[tag=ccs-remote-cluster-setup]
include::{es-ref-dir}/search/search-your-data/search-across-clusters.asciidoc[tag=ccs-remote-cluster-setup]
<1> Since `skip_unavailable` was not set on `cluster_three`, it uses
the default of `false`. See the <<ccq-skip-unavailable-clusters>>
@ -221,4 +221,4 @@ in the response, such as execution time, selected target indices, and shards.
[[ccq-during-upgrade]]
==== Query across clusters during an upgrade
include::{es-repo-dir}/search/search-your-data/search-across-clusters.asciidoc[tag=ccs-during-upgrade]
include::{es-ref-dir}/search/search-your-data/search-across-clusters.asciidoc[tag=ccs-during-upgrade]

View file

@ -91,7 +91,7 @@ your query.
[[esql-enrich-prereqs]]
==== Prerequisites
include::{es-repo-dir}/ingest/apis/enrich/put-enrich-policy.asciidoc[tag=enrich-policy-api-prereqs]
include::{es-ref-dir}/ingest/apis/enrich/put-enrich-policy.asciidoc[tag=enrich-policy-api-prereqs]
[discrete]
[[esql-create-enrich-source-index]]
@ -130,7 +130,7 @@ include::processing-commands/enrich.asciidoc[tag=examples]
[[esql-update-enrich-data]]
==== Update an enrich index
include::{es-repo-dir}/ingest/apis/enrich/execute-enrich-policy.asciidoc[tag=update-enrich-index]
include::{es-ref-dir}/ingest/apis/enrich/execute-enrich-policy.asciidoc[tag=update-enrich-index]
[discrete]
[[esql-update-enrich-policies]]

View file

@ -21,7 +21,7 @@ This getting started is also available as an https://github.com/elastic/elastics
To follow along with the queries in this guide, you can either set up your own
deployment, or use Elastic's public {esql} demo environment.
include::{es-repo-dir}/tab-widgets/esql/esql-getting-started-widget-sample-data.asciidoc[]
include::{es-ref-dir}/tab-widgets/esql/esql-getting-started-widget-sample-data.asciidoc[]
[discrete]
[[esql-getting-started-running-queries]]
@ -29,7 +29,7 @@ include::{es-repo-dir}/tab-widgets/esql/esql-getting-started-widget-sample-data.
In {kib}, you can use Console or Discover to run {esql} queries:
include::{es-repo-dir}/tab-widgets/esql/esql-getting-started-widget-discover-console.asciidoc[]
include::{es-ref-dir}/tab-widgets/esql/esql-getting-started-widget-discover-console.asciidoc[]
[discrete]
[[esql-getting-started-first-query]]
@ -279,7 +279,7 @@ Before you can use `ENRICH`, you first need to
<<esql-create-enrich-policy,create>> and <<esql-execute-enrich-policy,execute>>
an <<esql-enrich-policy,enrich policy>>.
include::{es-repo-dir}/tab-widgets/esql/esql-getting-started-widget-enrich-policy.asciidoc[]
include::{es-ref-dir}/tab-widgets/esql/esql-getting-started-widget-enrich-policy.asciidoc[]
After creating and executing a policy, you can use it with the `ENRICH`
command:

View file

@ -24,7 +24,7 @@ values may differ.
The currently supported options are:
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
+
Defaults to `true`.
@ -37,7 +37,7 @@ missing or closed index.
+
Defaults to `true`.
include::{es-repo-dir}/search/search.asciidoc[tag=search-preference]
include::{es-ref-dir}/search/search.asciidoc[tag=search-preference]
*Examples*

View file

@ -1,7 +1,7 @@
[[esql]]
= {esql}
:esql-tests: {xes-repo-dir}/../../plugin/esql/qa
:esql-tests: {elasticsearch-root}/x-pack/docs/{lang}/../../plugin/esql/qa
:esql-specs: {esql-tests}/testFixtures/src/main/resources
[partintro]

View file

@ -24,8 +24,8 @@ The simplest way to set up {es} is to create a managed deployment with {ess} on
{ecloud}. If you prefer to manage your own test environment, install and
run {es} using Docker.
include::{es-repo-dir}/tab-widgets/code.asciidoc[]
include::{es-repo-dir}/tab-widgets/quick-start-install-widget.asciidoc[]
include::{es-ref-dir}/tab-widgets/code.asciidoc[]
include::{es-ref-dir}/tab-widgets/quick-start-install-widget.asciidoc[]
[discrete]
[[send-requests-to-elasticsearch]]
@ -36,7 +36,7 @@ with {es} using any client that sends HTTP requests, such as
https://curl.se[curl]. You can also use {kib}'s Console to send requests to
{es}.
include::{es-repo-dir}/tab-widgets/api-call-widget.asciidoc[]
include::{es-ref-dir}/tab-widgets/api-call-widget.asciidoc[]
[discrete]
[[add-data]]

View file

@ -94,7 +94,7 @@ Indices in Elasticsearch are stored in one or more shards. Each shard is a Lucen
The <<indices-forcemerge,force merge API>> can be used to reduce the number of segments per shard. In many cases, the number of segments can be reduced to one per shard by setting `max_num_segments=1`.
include::{es-repo-dir}/indices/forcemerge.asciidoc[tag=force-merge-read-only-warn]
include::{es-ref-dir}/indices/forcemerge.asciidoc[tag=force-merge-read-only-warn]
[discrete]
=== Shrink index

View file

@ -43,7 +43,7 @@ The operation that consists of making changes visible to search - called a
<<indices-refresh,refresh>> - is costly, and calling it often while there is
ongoing indexing activity can hurt indexing speed.
include::{es-repo-dir}/indices/refresh.asciidoc[tag=refresh-interval-default]
include::{es-ref-dir}/indices/refresh.asciidoc[tag=refresh-interval-default]
This is the optimal configuration if you have no or very little search traffic
(e.g. less than one search request every 5 minutes) and want to optimize for
indexing speed. This behavior aims to automatically optimize bulk indexing in

View file

@ -109,7 +109,7 @@ force merge to one segment, the kNN search only need to check a single,
all-inclusive HNSW graph. Force merging `dense_vector` fields is an expensive
operation that can take significant time to complete.
include::{es-repo-dir}/indices/forcemerge.asciidoc[tag=force-merge-read-only-warn]
include::{es-ref-dir}/indices/forcemerge.asciidoc[tag=force-merge-read-only-warn]
[discrete]
==== Create large segments during bulk indexing

View file

@ -26,7 +26,7 @@ stream.
The steps for setting up data tiers vary based on your deployment type:
include::{es-repo-dir}/tab-widgets/data-tiers-widget.asciidoc[]
include::{es-ref-dir}/tab-widgets/data-tiers-widget.asciidoc[]
[discrete]
[[register-snapshot-repository]]
@ -39,7 +39,7 @@ To use {search-snaps}, you must register a supported snapshot repository. The
steps for registering this repository vary based on your deployment type and
storage provider:
include::{es-repo-dir}/tab-widgets/snapshot-repo-widget.asciidoc[]
include::{es-ref-dir}/tab-widgets/snapshot-repo-widget.asciidoc[]
[discrete]
[[create-edit-index-lifecycle-policy]]
@ -58,7 +58,7 @@ ensure your policy:
* Uses {search-snaps} in the cold and frozen phases, if wanted.
* Includes a delete phase, if needed.
include::{es-repo-dir}/tab-widgets/ilm-widget.asciidoc[]
include::{es-ref-dir}/tab-widgets/ilm-widget.asciidoc[]
[discrete]
[[create-ts-component-templates]]
@ -68,19 +68,19 @@ TIP: If you use {fleet} or {agent}, skip to <<search-visualize-your-data>>.
{fleet} and {agent} use built-in templates to create data streams for you.
If you use a custom application, you need to set up your own data stream.
include::{es-repo-dir}/data-streams/set-up-a-data-stream.asciidoc[tag=ds-create-component-templates]
include::{es-ref-dir}/data-streams/set-up-a-data-stream.asciidoc[tag=ds-create-component-templates]
[discrete]
[[create-ts-index-template]]
=== Create an index template
include::{es-repo-dir}/data-streams/set-up-a-data-stream.asciidoc[tag=ds-create-index-template]
include::{es-ref-dir}/data-streams/set-up-a-data-stream.asciidoc[tag=ds-create-index-template]
[discrete]
[[add-data-to-data-stream]]
=== Add data to a data stream
include::{es-repo-dir}/data-streams/set-up-a-data-stream.asciidoc[tag=ds-create-data-stream]
include::{es-ref-dir}/data-streams/set-up-a-data-stream.asciidoc[tag=ds-create-data-stream]
[discrete]
[[search-visualize-your-data]]

View file

@ -35,7 +35,7 @@ the request fails and returns an error.
[[ilm-delete-lifecycle-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
[[ilm-delete-lifecycle-example]]
==== {api-examples-title}

View file

@ -49,7 +49,7 @@ or `_all`.
{ilm-init} and are in an error state, either due to an encountering an error while
executing the policy, or attempting to use a policy that does not exist.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
[[ilm-explain-lifecycle-example]]
==== {api-examples-title}

View file

@ -36,7 +36,7 @@ modified date. If no policy is specified, returns all defined policies.
[[ilm-get-lifecycle-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
[[ilm-get-lifecycle-example]]
==== {api-examples-title}

View file

@ -27,7 +27,7 @@ You can start or stop {ilm-init} with the <<ilm-start,start {ilm-init}>> and
[[ilm-get-status-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
[role="child_attributes"]
[[ilm-get-status-response-body]]

View file

@ -50,7 +50,7 @@ policy are considered valid, an index cannot move to a step that is not part of
[[ilm-move-to-step-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
[role="child_attributes"]
[[ilm-move-to-step-request-body]]

View file

@ -46,7 +46,7 @@ To avoid naming collisions with built-in and Fleet-managed ILM policies, avoid u
[[ilm-put-lifecycle-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
[[ilm-put-lifecycle-example]]
==== {api-examples-title}

View file

@ -40,7 +40,7 @@ target. Supports wildcards (`*`). To target all data streams and indices, use
[[ilm-remove-policy-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
[[ilm-remove-policy-example]]
==== {api-examples-title}

View file

@ -35,7 +35,7 @@ step.
[[ilm-retry-policy-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
[[ilm-retry-policy-example]]
==== {api-examples-title}

View file

@ -31,7 +31,7 @@ necessary if it has been stopped using the <<ilm-stop, Stop {ilm-init} API>>.
[[ilm-start-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
[[ilm-start-example]]
==== {api-examples-title}

View file

@ -36,7 +36,7 @@ if {ilm-init} is running.
[[ilm-stop-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
[[ilm-stop-example]]
==== {api-examples-title}

View file

@ -86,7 +86,7 @@ PUT /my-index-000001/_block/write
[[add-index-block-api-path-params]]
==== {api-path-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index]
+
By default, you must explicitly name the indices you are adding blocks to.
To allow the adding of blocks to indices with `_all`, `*`, or other wildcard
@ -116,17 +116,17 @@ Disable write operations. However, metadata changes are still allowed.
[[add-index-block-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
+
Defaults to `true`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
+
Defaults to `open`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
[discrete]
[[add-index-block-api-example]]

View file

@ -1,13 +1,6 @@
[[elasticsearch-reference]]
= Elasticsearch Guide
:include-xpack: true
:es-test-dir: {elasticsearch-root}/docs/src/test
:plugins-examples-dir: {elasticsearch-root}/plugins/examples
:dependencies-dir: {elasticsearch-root}/build-tools-internal
:xes-repo-dir: {elasticsearch-root}/x-pack/docs/{lang}
:es-repo-dir: {elasticsearch-root}/docs/reference
include::../Versions.asciidoc[]
include::links.asciidoc[]

View file

@ -46,7 +46,7 @@ indices return an error.
[[add-alias-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
[[add-alias-api-request-body]]
==== {api-request-body-title}

Some files were not shown because too many files have changed in this diff Show more