From db5bf92acf14fad5be5f3a4c824475a15a98fb3b Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Mon, 1 Jun 2020 16:42:53 -0700 Subject: [PATCH] [7.x][DOCS] Replace docdir attribute with es-repo-dir (#57489) (#57494) --- docs/java-api/index.asciidoc | 8 +- docs/java-api/query-dsl.asciidoc | 2 +- docs/java-rest/high-level/index.asciidoc | 4 +- docs/java-rest/low-level/index.asciidoc | 4 +- docs/plugins/authors.asciidoc | 2 +- docs/reference/cat/alias.asciidoc | 16 +- docs/reference/cat/allocation.asciidoc | 18 +-- docs/reference/cat/anomaly-detectors.asciidoc | 112 ++++++------- docs/reference/cat/count.asciidoc | 12 +- docs/reference/cat/datafeeds.asciidoc | 40 ++--- .../reference/cat/dataframeanalytics.asciidoc | 20 +-- docs/reference/cat/fielddata.asciidoc | 12 +- docs/reference/cat/health.asciidoc | 12 +- docs/reference/cat/indices.asciidoc | 24 +-- docs/reference/cat/master.asciidoc | 14 +- docs/reference/cat/nodeattrs.asciidoc | 14 +- docs/reference/cat/nodes.asciidoc | 16 +- docs/reference/cat/pending_tasks.asciidoc | 16 +- docs/reference/cat/plugins.asciidoc | 14 +- docs/reference/cat/recovery.asciidoc | 24 +-- docs/reference/cat/repositories.asciidoc | 14 +- docs/reference/cat/segments.asciidoc | 32 ++-- docs/reference/cat/shards.asciidoc | 20 +-- docs/reference/cat/snapshots.asciidoc | 14 +- docs/reference/cat/tasks.asciidoc | 16 +- docs/reference/cat/templates.asciidoc | 14 +- docs/reference/cat/thread_pool.asciidoc | 14 +- docs/reference/cat/trainedmodel.asciidoc | 14 +- docs/reference/cat/transforms.asciidoc | 66 ++++---- docs/reference/cluster/get-settings.asciidoc | 4 +- docs/reference/cluster/health.asciidoc | 8 +- .../cluster/nodes-hot-threads.asciidoc | 4 +- docs/reference/cluster/nodes-info.asciidoc | 6 +- docs/reference/cluster/nodes-stats.asciidoc | 20 +-- docs/reference/cluster/nodes-usage.asciidoc | 4 +- docs/reference/cluster/pending.asciidoc | 4 +- docs/reference/cluster/reroute.asciidoc | 2 +- docs/reference/cluster/state.asciidoc | 8 +- docs/reference/cluster/stats.asciidoc | 8 +- docs/reference/cluster/tasks.asciidoc | 16 +- .../cluster/update-settings.asciidoc | 4 +- docs/reference/docs/bulk.asciidoc | 30 ++-- docs/reference/docs/delete-by-query.asciidoc | 62 ++++---- docs/reference/docs/delete.asciidoc | 18 +-- docs/reference/docs/get.asciidoc | 18 +-- docs/reference/docs/index_.asciidoc | 18 +-- docs/reference/docs/multi-get.asciidoc | 16 +- .../reference/docs/multi-termvectors.asciidoc | 22 +-- docs/reference/docs/reindex.asciidoc | 16 +- docs/reference/docs/termvectors.asciidoc | 22 +-- docs/reference/docs/update-by-query.asciidoc | 2 +- docs/reference/docs/update.asciidoc | 12 +- docs/reference/eql/eql-search-api.asciidoc | 6 +- docs/reference/how-to/indexing-speed.asciidoc | 2 +- .../ilm/apis/delete-lifecycle.asciidoc | 2 +- docs/reference/ilm/apis/explain.asciidoc | 2 +- .../reference/ilm/apis/get-lifecycle.asciidoc | 2 +- docs/reference/ilm/apis/get-status.asciidoc | 2 +- docs/reference/ilm/apis/move-to-step.asciidoc | 2 +- .../reference/ilm/apis/put-lifecycle.asciidoc | 2 +- .../apis/remove-policy-from-index.asciidoc | 2 +- docs/reference/ilm/apis/retry-policy.asciidoc | 2 +- docs/reference/ilm/apis/start.asciidoc | 2 +- docs/reference/ilm/apis/stop.asciidoc | 2 +- docs/reference/indices/add-alias.asciidoc | 8 +- docs/reference/indices/alias-exists.asciidoc | 12 +- docs/reference/indices/aliases.asciidoc | 8 +- .../indices/apis/reload-analyzers.asciidoc | 6 +- docs/reference/indices/clearcache.asciidoc | 8 +- docs/reference/indices/clone-index.asciidoc | 10 +- docs/reference/indices/close.asciidoc | 14 +- .../indices/component-templates.asciidoc | 16 +- docs/reference/indices/create-index.asciidoc | 10 +- docs/reference/indices/delete-alias.asciidoc | 6 +- .../indices/delete-index-template.asciidoc | 4 +- docs/reference/indices/delete-index.asciidoc | 8 +- docs/reference/indices/flush.asciidoc | 8 +- docs/reference/indices/forcemerge.asciidoc | 8 +- docs/reference/indices/get-alias.asciidoc | 14 +- .../indices/get-field-mapping.asciidoc | 10 +- .../indices/get-index-template.asciidoc | 10 +- docs/reference/indices/get-index.asciidoc | 16 +- docs/reference/indices/get-mapping.asciidoc | 14 +- docs/reference/indices/get-settings.asciidoc | 16 +- .../indices/index-templates.asciidoc | 16 +- .../reference/indices/indices-exists.asciidoc | 14 +- docs/reference/indices/open-close.asciidoc | 12 +- docs/reference/indices/put-mapping.asciidoc | 12 +- docs/reference/indices/recovery.asciidoc | 10 +- docs/reference/indices/refresh.asciidoc | 8 +- .../reference/indices/rollover-index.asciidoc | 14 +- docs/reference/indices/segments.asciidoc | 26 +-- docs/reference/indices/shard-stores.asciidoc | 8 +- docs/reference/indices/shrink-index.asciidoc | 10 +- docs/reference/indices/split-index.asciidoc | 10 +- docs/reference/indices/stats.asciidoc | 20 +-- docs/reference/indices/synced-flush.asciidoc | 8 +- .../indices/template-exists.asciidoc | 8 +- docs/reference/indices/templates.asciidoc | 8 +- docs/reference/indices/types-exists.asciidoc | 4 +- .../indices/update-settings.asciidoc | 12 +- .../ingest/apis/delete-pipeline.asciidoc | 2 +- .../apis/enrich/put-enrich-policy.asciidoc | 2 +- .../ingest/apis/get-pipeline.asciidoc | 4 +- .../ingest/apis/put-pipeline.asciidoc | 2 +- docs/reference/ingest/enrich.asciidoc | 4 +- .../ingest/processors/inference.asciidoc | 14 +- docs/reference/mapping.asciidoc | 4 +- docs/reference/mapping/types/nested.asciidoc | 4 +- .../apis/get-bucket.asciidoc | 4 +- .../apis/get-overall-buckets.asciidoc | 2 +- .../apis/get-record.asciidoc | 2 +- .../apis/get-snapshot.asciidoc | 2 +- docs/reference/rest-api/common-parms.asciidoc | 2 +- docs/reference/rest-api/usage.asciidoc | 2 +- docs/reference/search/count.asciidoc | 30 ++-- docs/reference/search/explain.asciidoc | 24 +-- docs/reference/search/field-caps.asciidoc | 10 +- docs/reference/search/multi-search.asciidoc | 10 +- docs/reference/search/rank-eval.asciidoc | 6 +- docs/reference/search/request-body.asciidoc | 2 +- docs/reference/search/search-shards.asciidoc | 14 +- .../reference/search/search-template.asciidoc | 16 +- docs/reference/search/search.asciidoc | 24 +-- docs/reference/search/validate.asciidoc | 22 +-- .../apis/mount-snapshot.asciidoc | 4 +- docs/reference/settings/common-defs.asciidoc | 2 +- .../settings/security-settings.asciidoc | 148 +++++++++--------- docs/reference/settings/ssl-settings.asciidoc | 52 +++--- docs/reference/setup/restart-cluster.asciidoc | 16 +- .../slm/apis/slm-get-status.asciidoc | 2 +- docs/reference/slm/apis/slm-put.asciidoc | 2 +- docs/reference/slm/apis/slm-start.asciidoc | 2 +- docs/reference/slm/apis/slm-stop.asciidoc | 2 +- .../apis/clean-up-repo-api.asciidoc | 2 +- 135 files changed, 893 insertions(+), 893 deletions(-) diff --git a/docs/java-api/index.asciidoc b/docs/java-api/index.asciidoc index 4f947cbfd5b..f4cff29ac40 100644 --- a/docs/java-api/index.asciidoc +++ b/docs/java-api/index.asciidoc @@ -1,6 +1,6 @@ = Java API -include::../Versions.asciidoc[] +include::{elasticsearch-root}/docs/Versions.asciidoc[] [[java-api]] [preface] @@ -131,10 +131,10 @@ and add it as a dependency. As an example, we will use the `slf4j-simple` logger -------------------------------------------------- -:client-tests: {docdir}/../../server/src/internalClusterTest/java/org/elasticsearch/client/documentation -:hlrc-tests: {docdir}/../../client/rest-high-level/src/test/java/org/elasticsearch/client +:client-tests: {elasticsearch-root}/server/src/internalClusterTest/java/org/elasticsearch/client/documentation +:hlrc-tests: {elasticsearch-root}/client/rest-high-level/src/test/java/org/elasticsearch/client -:client-reindex-tests: {docdir}/../../modules/reindex/src/test/java/org/elasticsearch/client/documentation +:client-reindex-tests: {elasticsearch-root}/modules/reindex/src/test/java/org/elasticsearch/client/documentation include::client.asciidoc[] diff --git a/docs/java-api/query-dsl.asciidoc b/docs/java-api/query-dsl.asciidoc index f4823fa08ab..859462e5767 100644 --- a/docs/java-api/query-dsl.asciidoc +++ b/docs/java-api/query-dsl.asciidoc @@ -19,7 +19,7 @@ Note that you can easily print (aka debug) JSON generated queries using The `QueryBuilder` can then be used with any API that accepts a query, such as `count` and `search`. -:query-dsl-test: {docdir}/../../client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/QueryDSLDocumentationTests.java +:query-dsl-test: {elasticsearch-root}/client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/QueryDSLDocumentationTests.java include::query-dsl/match-all-query.asciidoc[] diff --git a/docs/java-rest/high-level/index.asciidoc b/docs/java-rest/high-level/index.asciidoc index 2010c9c539a..21d78da171c 100644 --- a/docs/java-rest/high-level/index.asciidoc +++ b/docs/java-rest/high-level/index.asciidoc @@ -24,8 +24,8 @@ the same response objects. -- -:doc-tests: {docdir}/../../client/rest-high-level/src/test/java/org/elasticsearch/client/documentation -:hlrc-tests: {docdir}/../../client/rest-high-level/src/test/java/org/elasticsearch/client +:doc-tests: {elasticsearch-root}/client/rest-high-level/src/test/java/org/elasticsearch/client/documentation +:hlrc-tests: {elasticsearch-root}/client/rest-high-level/src/test/java/org/elasticsearch/client include::getting-started.asciidoc[] include::supported-apis.asciidoc[] diff --git a/docs/java-rest/low-level/index.asciidoc b/docs/java-rest/low-level/index.asciidoc index 92230a657a9..9c7b4c0c55d 100644 --- a/docs/java-rest/low-level/index.asciidoc +++ b/docs/java-rest/low-level/index.asciidoc @@ -24,11 +24,11 @@ The low-level client's features include: -- -:doc-tests: {docdir}/../../client/rest/src/test/java/org/elasticsearch/client/documentation +:doc-tests: {elasticsearch-root}/client/rest/src/test/java/org/elasticsearch/client/documentation include::usage.asciidoc[] include::configuration.asciidoc[] -:doc-tests: {docdir}/../../client/sniffer/src/test/java/org/elasticsearch/client/sniff/documentation +:doc-tests: {elasticsearch-root}/client/sniffer/src/test/java/org/elasticsearch/client/sniff/documentation include::sniffer.asciidoc[] include::../license.asciidoc[] diff --git a/docs/plugins/authors.asciidoc b/docs/plugins/authors.asciidoc index fceeeac892c..d0dc227df0b 100644 --- a/docs/plugins/authors.asciidoc +++ b/docs/plugins/authors.asciidoc @@ -1,7 +1,7 @@ [[plugin-authors]] == Help for plugin authors -:plugin-properties-files: {docdir}/../../buildSrc/src/main/resources +:plugin-properties-files: {elasticsearch-root}/buildSrc/src/main/resources The Elasticsearch repository contains examples of: diff --git a/docs/reference/cat/alias.asciidoc b/docs/reference/cat/alias.asciidoc index 91ad7a2577f..b166cc9af80 100644 --- a/docs/reference/cat/alias.asciidoc +++ b/docs/reference/cat/alias.asciidoc @@ -20,25 +20,25 @@ filter and routing information. ``:: (Optional, string) -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-alias] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-alias] [[cat-alias-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] -include::{docdir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{docdir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] [[cat-alias-api-example]] diff --git a/docs/reference/cat/allocation.asciidoc b/docs/reference/cat/allocation.asciidoc index 5407d13ee37..c62045d58b9 100644 --- a/docs/reference/cat/allocation.asciidoc +++ b/docs/reference/cat/allocation.asciidoc @@ -19,26 +19,26 @@ and their disk space. [[cat-allocation-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=node-id] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id] [[cat-allocation-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=bytes] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes] -include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{docdir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] -include::{docdir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-allocation-api-example]] ==== {api-examples-title} diff --git a/docs/reference/cat/anomaly-detectors.asciidoc b/docs/reference/cat/anomaly-detectors.asciidoc index 1fa8e7b4863..2cbbdc88c50 100644 --- a/docs/reference/cat/anomaly-detectors.asciidoc +++ b/docs/reference/cat/anomaly-detectors.asciidoc @@ -35,20 +35,20 @@ NOTE: This API returns a maximum of 10,000 jobs. ``:: (Optional, string) -include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] [[cat-anomaly-detectors-query-params]] ==== {api-query-parms-title} `allow_no_jobs`:: (Optional, boolean) -include::{docdir}/ml/ml-shared.asciidoc[tag=allow-no-jobs] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-jobs] -include::{docdir}/rest-api/common-parms.asciidoc[tag=bytes] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes] -include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-repo-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 @@ -57,75 +57,75 @@ specified columns. Valid columns are: `assignment_explanation`, `ae`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=assignment-explanation-anomaly-jobs] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=assignment-explanation-anomaly-jobs] `buckets.count`, `bc`, `bucketsCount`::: (Default) -include::{docdir}/ml/ml-shared.asciidoc[tag=bucket-count-anomaly-jobs] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-count-anomaly-jobs] `buckets.time.exp_avg`, `btea`, `bucketsTimeExpAvg`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=bucket-time-exponential-average] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-time-exponential-average] `buckets.time.exp_avg_hour`, `bteah`, `bucketsTimeExpAvgHour`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=bucket-time-exponential-average-hour] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-time-exponential-average-hour] `buckets.time.max`, `btmax`, `bucketsTimeMax`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=bucket-time-maximum] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-time-maximum] `buckets.time.min`, `btmin`, `bucketsTimeMin`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=bucket-time-minimum] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-time-minimum] `buckets.time.total`, `btt`, `bucketsTimeTotal`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=bucket-time-total] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-time-total] `data.buckets`, `db`, `dataBuckets`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=bucket-count] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-count] `data.earliest_record`, `der`, `dataEarliestRecord`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=earliest-record-timestamp] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=earliest-record-timestamp] `data.empty_buckets`, `deb`, `dataEmptyBuckets`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=empty-bucket-count] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=empty-bucket-count] `data.input_bytes`, `dib`, `dataInputBytes`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=input-bytes] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=input-bytes] `data.input_fields`, `dif`, `dataInputFields`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=input-field-count] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=input-field-count] `data.input_records`, `dir`, `dataInputRecords`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=input-record-count] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=input-record-count] `data.invalid_dates`, `did`, `dataInvalidDates`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=invalid-date-count] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=invalid-date-count] `data.last`, `dl`, `dataLast`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=last-data-time] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=last-data-time] `data.last_empty_bucket`, `dleb`, `dataLastEmptyBucket`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=latest-empty-bucket-timestamp] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=latest-empty-bucket-timestamp] `data.last_sparse_bucket`, `dlsb`, `dataLastSparseBucket`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=latest-sparse-record-timestamp] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=latest-sparse-record-timestamp] `data.latest_record`, `dlr`, `dataLatestRecord`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=latest-record-timestamp] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=latest-record-timestamp] `data.missing_fields`, `dmf`, `dataMissingFields`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=missing-field-count] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=missing-field-count] `data.out_of_order_timestamps`, `doot`, `dataOutOfOrderTimestamps`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=out-of-order-timestamp-count] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=out-of-order-timestamp-count] `data.processed_fields`, `dpf`, `dataProcessedFields`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=processed-field-count] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=processed-field-count] `data.processed_records`, `dpr`, `dataProcessedRecords`::: (Default) -include::{docdir}/ml/ml-shared.asciidoc[tag=processed-record-count] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=processed-record-count] `data.sparse_buckets`, `dsb`, `dataSparseBuckets`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=sparse-bucket-count] +include::{es-repo-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}. @@ -169,99 +169,99 @@ The total runtime in milliseconds for forecasts related to the {anomaly-job}. `forecasts.total`, `ft`, `forecastsTotal`::: (Default) -include::{docdir}/ml/ml-shared.asciidoc[tag=forecast-total] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=forecast-total] `id`::: (Default) -include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] `model.bucket_allocation_failures`, `mbaf`, `modelBucketAllocationFailures`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=bucket-allocation-failures-count] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-allocation-failures-count] `model.by_fields`, `mbf`, `modelByFields`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=total-by-field-count] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=total-by-field-count] `model.bytes`, `mb`, `modelBytes`::: (Default) -include::{docdir}/ml/ml-shared.asciidoc[tag=model-bytes] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-bytes] `model.bytes_exceeded`, `mbe`, `modelBytesExceeded`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=model-bytes-exceeded] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-bytes-exceeded] `model.categorization_status`, `mcs`, `modelCategorizationStatus`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=categorization-status] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=categorization-status] `model.categorized_doc_count`, `mcdc`, `modelCategorizedDocCount`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=categorized-doc-count] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=categorized-doc-count] `model.dead_category_count`, `mdcc`, `modelDeadCategoryCount`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=dead-category-count] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=dead-category-count] `model.failed_category_count`, `mdcc`, `modelFailedCategoryCount`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=failed-category-count] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=failed-category-count] `model.frequent_category_count`, `mfcc`, `modelFrequentCategoryCount`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=frequent-category-count] +include::{es-repo-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::{docdir}/ml/ml-shared.asciidoc[tag=model-memory-limit-anomaly-jobs] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-memory-limit-anomaly-jobs] `model.memory_status`, `mms`, `modelMemoryStatus`::: (Default) -include::{docdir}/ml/ml-shared.asciidoc[tag=model-memory-status] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-memory-status] `model.over_fields`, `mof`, `modelOverFields`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=total-over-field-count] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=total-over-field-count] `model.partition_fields`, `mpf`, `modelPartitionFields`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=total-partition-field-count] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=total-partition-field-count] `model.rare_category_count`, `mrcc`, `modelRareCategoryCount`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=rare-category-count] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=rare-category-count] `model.timestamp`, `mt`, `modelTimestamp`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=model-timestamp] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-timestamp] `model.total_category_count`, `mtcc`, `modelTotalCategoryCount`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=total-category-count] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=total-category-count] `node.address`, `na`, `nodeAddress`::: The network address of the node. + -include::{docdir}/ml/ml-shared.asciidoc[tag=node-jobs] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-jobs] `node.ephemeral_id`, `ne`, `nodeEphemeralId`::: The ephemeral ID of the node. + -include::{docdir}/ml/ml-shared.asciidoc[tag=node-jobs] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-jobs] `node.id`, `ni`, `nodeId`::: The unique identifier of the node. + -include::{docdir}/ml/ml-shared.asciidoc[tag=node-jobs] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-jobs] `node.name`, `nn`, `nodeName`::: The node name. + -include::{docdir}/ml/ml-shared.asciidoc[tag=node-jobs] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-jobs] `opened_time`, `ot`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=open-time] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=open-time] `state`, `s`::: (Default) -include::{docdir}/ml/ml-shared.asciidoc[tag=state-anomaly-job] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=state-anomaly-job] -include::{docdir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{docdir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-anomaly-detectors-example]] ==== {api-examples-title} diff --git a/docs/reference/cat/count.asciidoc b/docs/reference/cat/count.asciidoc index 7ae127885f5..6a5d7e79a55 100644 --- a/docs/reference/cat/count.asciidoc +++ b/docs/reference/cat/count.asciidoc @@ -22,21 +22,21 @@ which have not yet been removed by the merge process. [[cat-count-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] [[cat-count-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] -include::{docdir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-count-api-example]] diff --git a/docs/reference/cat/datafeeds.asciidoc b/docs/reference/cat/datafeeds.asciidoc index 57645633757..e891d66b68b 100644 --- a/docs/reference/cat/datafeeds.asciidoc +++ b/docs/reference/cat/datafeeds.asciidoc @@ -36,18 +36,18 @@ NOTE: This API returns a maximum of 10,000 jobs. ``:: (Optional, string) -include::{docdir}/ml/ml-shared.asciidoc[tag=datafeed-id] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id] [[cat-datafeeds-query-params]] ==== {api-query-parms-title} `allow_no_datafeeds`:: (Optional, boolean) -include::{docdir}/ml/ml-shared.asciidoc[tag=allow-no-datafeeds] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-datafeeds] -include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-repo-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 @@ -56,60 +56,60 @@ specified columns. Valid columns are: `assignment_explanation`, `ae`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=assignment-explanation-datafeeds] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=assignment-explanation-datafeeds] `buckets.count`, `bc`, `bucketsCount`::: (Default) -include::{docdir}/ml/ml-shared.asciidoc[tag=bucket-count] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-count] `id`::: (Default) -include::{docdir}/ml/ml-shared.asciidoc[tag=datafeed-id] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id] `node.address`, `na`, `nodeAddress`::: The network address of the node. + -include::{docdir}/ml/ml-shared.asciidoc[tag=node-datafeeds] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-datafeeds] `node.ephemeral_id`, `ne`, `nodeEphemeralId`::: The ephemeral ID of the node. + -include::{docdir}/ml/ml-shared.asciidoc[tag=node-datafeeds] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-datafeeds] `node.id`, `ni`, `nodeId`::: The unique identifier of the node. + -include::{docdir}/ml/ml-shared.asciidoc[tag=node-datafeeds] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-datafeeds] `node.name`, `nn`, `nodeName`::: The node name. + -include::{docdir}/ml/ml-shared.asciidoc[tag=node-datafeeds] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-datafeeds] `search.bucket_avg`, `sba`, `searchBucketAvg`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=search-bucket-avg] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=search-bucket-avg] `search.count`, `sc`, `searchCount`::: (Default) -include::{docdir}/ml/ml-shared.asciidoc[tag=search-count] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=search-count] `search.exp_avg_hour`, `seah`, `searchExpAvgHour`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=search-exp-avg-hour] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=search-exp-avg-hour] `search.time`, `st`, `searchTime`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=search-time] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=search-time] `state`, `s`::: (Default) -include::{docdir}/ml/ml-shared.asciidoc[tag=state-datafeed] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=state-datafeed] -include::{docdir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{docdir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-datafeeds-example]] ==== {api-examples-title} diff --git a/docs/reference/cat/dataframeanalytics.asciidoc b/docs/reference/cat/dataframeanalytics.asciidoc index faa7c07ee27..fec1ce329a8 100644 --- a/docs/reference/cat/dataframeanalytics.asciidoc +++ b/docs/reference/cat/dataframeanalytics.asciidoc @@ -39,15 +39,15 @@ For more information, see <> and {ml-docs}/setup.html[Set u ``:: (Optional, string) -include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-default] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-default] [[cat-dfanalytics-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-repo-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 @@ -56,14 +56,14 @@ specified columns. Valid columns are: `assignment_explanation`, `ae`::: -include::{docdir}/ml/ml-shared.asciidoc[tag=assignment-explanation-dfanalytics] +include::{es-repo-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::{docdir}/ml/ml-shared.asciidoc[tag=description-dfa] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=description-dfa] `dest_index`, `di`, `destIndex`::: Name of the destination index. @@ -73,7 +73,7 @@ Contains messages about the reason why a {dfanalytics-job} failed. `id`::: (Default) -include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics] +include::{es-repo-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 @@ -108,13 +108,13 @@ The type of analysis that the {dfanalytics-job} performs. `version`, `v`::: The {es} version number in which the {dfanalytics-job} was created. -include::{docdir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{docdir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-dfanalytics-example]] diff --git a/docs/reference/cat/fielddata.asciidoc b/docs/reference/cat/fielddata.asciidoc index 27a21cc9fba..e855517d013 100644 --- a/docs/reference/cat/fielddata.asciidoc +++ b/docs/reference/cat/fielddata.asciidoc @@ -27,17 +27,17 @@ information. [[cat-fielddata-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=bytes] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes] -include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] -include::{docdir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-fielddata-api-example]] diff --git a/docs/reference/cat/health.asciidoc b/docs/reference/cat/health.asciidoc index f9a9003ac22..e257e4f2958 100644 --- a/docs/reference/cat/health.asciidoc +++ b/docs/reference/cat/health.asciidoc @@ -39,22 +39,22 @@ over a longer period of time. See <>. [[cat-health-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] -include::{docdir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{docdir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] `ts` (timestamps):: (Optional, boolean) If `true`, returns `HH:MM:SS` and https://en.wikipedia.org/wiki/Unix_time[Unix `epoch`] timestamps. Defaults to `true`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-health-api-example]] diff --git a/docs/reference/cat/indices.asciidoc b/docs/reference/cat/indices.asciidoc index 3a8b773e37a..d7bf54a33e6 100644 --- a/docs/reference/cat/indices.asciidoc +++ b/docs/reference/cat/indices.asciidoc @@ -39,17 +39,17 @@ To get an accurate count of {es} documents, use the <> or [[cat-indices-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] [[cat-indices-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=bytes] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes] -include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] `health`:: + @@ -64,26 +64,26 @@ are: By default, the response includes indices of any health status. -- -include::{docdir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{docdir}/rest-api/common-parms.asciidoc[tag=include-unloaded-segments] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-unloaded-segments] -include::{docdir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-repo-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::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{docdir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] [[cat-indices-api-example]] diff --git a/docs/reference/cat/master.asciidoc b/docs/reference/cat/master.asciidoc index b1263297ee6..759b6d3737e 100644 --- a/docs/reference/cat/master.asciidoc +++ b/docs/reference/cat/master.asciidoc @@ -17,19 +17,19 @@ and name. [[cat-master-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] -include::{docdir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{docdir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-master-api-example]] diff --git a/docs/reference/cat/nodeattrs.asciidoc b/docs/reference/cat/nodeattrs.asciidoc index 6b916ca1660..f068241a911 100644 --- a/docs/reference/cat/nodeattrs.asciidoc +++ b/docs/reference/cat/nodeattrs.asciidoc @@ -14,9 +14,9 @@ Returns information about custom node attributes. [[cat-nodeattrs-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-repo-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. @@ -48,15 +48,15 @@ Process ID, such as `13061`. Bound transport port, such as `9300`. -- -include::{docdir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{docdir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-nodeattrs-api-example]] diff --git a/docs/reference/cat/nodes.asciidoc b/docs/reference/cat/nodes.asciidoc index 2e0351b07d0..8ad8783614f 100644 --- a/docs/reference/cat/nodes.asciidoc +++ b/docs/reference/cat/nodes.asciidoc @@ -14,15 +14,15 @@ Returns information about a cluster's nodes. [[cat-nodes-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=bytes] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes] -include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-repo-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::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-repo-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. @@ -283,7 +283,7 @@ Time spent in suggest, such as `0`. Number of suggest operations, such as `0`. -- -include::{docdir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] `local`:: (Optional, boolean) @@ -294,13 +294,13 @@ computed from the cluster state on the master node. In either case the coordinating node sends a request for further information to each selected node. -include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{docdir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-nodes-api-example]] diff --git a/docs/reference/cat/pending_tasks.asciidoc b/docs/reference/cat/pending_tasks.asciidoc index 7eb405a6e2b..bb40a753c63 100644 --- a/docs/reference/cat/pending_tasks.asciidoc +++ b/docs/reference/cat/pending_tasks.asciidoc @@ -15,21 +15,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::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] -include::{docdir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{docdir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{docdir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-pending-tasks-api-example]] diff --git a/docs/reference/cat/plugins.asciidoc b/docs/reference/cat/plugins.asciidoc index cc83cb5b929..d31827005e9 100644 --- a/docs/reference/cat/plugins.asciidoc +++ b/docs/reference/cat/plugins.asciidoc @@ -16,19 +16,19 @@ Returns a list of plugins running on each node of a cluster. [[cat-plugins-tasks-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] -include::{docdir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{docdir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-plugins-api-example]] diff --git a/docs/reference/cat/recovery.asciidoc b/docs/reference/cat/recovery.asciidoc index 4848adbe09d..15538742bd9 100644 --- a/docs/reference/cat/recovery.asciidoc +++ b/docs/reference/cat/recovery.asciidoc @@ -24,37 +24,37 @@ The cat recovery API returns information about shard recoveries, both ongoing and completed. It is a more compact view of the JSON <> API. -include::{docdir}/indices/recovery.asciidoc[tag=shard-recovery-desc] +include::{es-repo-dir}/indices/recovery.asciidoc[tag=shard-recovery-desc] [[cat-recovery-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] [[cat-recovery-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=active-only] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=active-only] -include::{docdir}/rest-api/common-parms.asciidoc[tag=bytes] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes] -include::{docdir}/rest-api/common-parms.asciidoc[tag=detailed] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=detailed] -include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] -include::{docdir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-query-parm] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-query-parm] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{docdir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-recovery-api-example]] diff --git a/docs/reference/cat/repositories.asciidoc b/docs/reference/cat/repositories.asciidoc index 750320f95f5..5e61238b4cc 100644 --- a/docs/reference/cat/repositories.asciidoc +++ b/docs/reference/cat/repositories.asciidoc @@ -16,19 +16,19 @@ Returns the <> for a cluster. [[cat-repositories-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] -include::{docdir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{docdir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-repositories-api-example]] diff --git a/docs/reference/cat/segments.asciidoc b/docs/reference/cat/segments.asciidoc index de360153e2d..8dc8f29328b 100644 --- a/docs/reference/cat/segments.asciidoc +++ b/docs/reference/cat/segments.asciidoc @@ -19,17 +19,17 @@ API. [[cat-segments-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] [[cat-segments-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=bytes] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes] -include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] + -- If you do not specify which columns to include, the API returns the default @@ -52,39 +52,39 @@ Valid columns are: `segment`:: (Default) -include::{docdir}/rest-api/common-parms.asciidoc[tag=segment] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=segment] `generation`:: (Default) -include::{docdir}/rest-api/common-parms.asciidoc[tag=generation] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=generation] `docs.count`:: (Default) -include::{docdir}/rest-api/common-parms.asciidoc[tag=docs-count] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-count] `docs.deleted`:: (Default) -include::{docdir}/rest-api/common-parms.asciidoc[tag=docs-deleted] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-deleted] `size`:: (Default) -include::{docdir}/rest-api/common-parms.asciidoc[tag=segment-size] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=segment-size] `size.memory`:: (Default) -include::{docdir}/rest-api/common-parms.asciidoc[tag=memory] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=memory] `committed`:: (Default) -include::{docdir}/rest-api/common-parms.asciidoc[tag=committed] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=committed] `searchable`:: (Default) -include::{docdir}/rest-api/common-parms.asciidoc[tag=segment-search] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=segment-search] `version`:: (Default) -include::{docdir}/rest-api/common-parms.asciidoc[tag=segment-version] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=segment-version] `compound`:: (Default) If `true`, the segment is stored in a compound file. This means Lucene @@ -94,11 +94,11 @@ merged all files from the segment in a single file to save file descriptors. ID of the node, such as `k0zy`. -- -include::{docdir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-segments-api-example]] diff --git a/docs/reference/cat/shards.asciidoc b/docs/reference/cat/shards.asciidoc index e2f362f8e7f..5eb51d3d58b 100644 --- a/docs/reference/cat/shards.asciidoc +++ b/docs/reference/cat/shards.asciidoc @@ -20,17 +20,17 @@ docs, the bytes it takes on disk, and the node where it's located. [[cat-shards-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] [[cat-shards-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=bytes] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes] -include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] + -- If you do not specify which columns to include, the API returns the default @@ -263,17 +263,17 @@ Reason the shard is unassigned. Returned values are: -- -include::{docdir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{docdir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{docdir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-shards-api-example]] diff --git a/docs/reference/cat/snapshots.asciidoc b/docs/reference/cat/snapshots.asciidoc index 430f0dcd0fe..ebef8044706 100644 --- a/docs/reference/cat/snapshots.asciidoc +++ b/docs/reference/cat/snapshots.asciidoc @@ -29,9 +29,9 @@ If the repository fails during the request, {es} returns an error. [[cat-snapshots-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] + -- If you do not specify which columns to include, the API returns the default @@ -90,19 +90,19 @@ units>>. Reason for any snapshot failures. -- -include::{docdir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-repo-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::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{docdir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-snapshots-api-example]] diff --git a/docs/reference/cat/tasks.asciidoc b/docs/reference/cat/tasks.asciidoc index 6629cf2f792..9721ebb95e0 100644 --- a/docs/reference/cat/tasks.asciidoc +++ b/docs/reference/cat/tasks.asciidoc @@ -29,25 +29,25 @@ of the JSON <> API. [[cat-tasks-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=detailed] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=detailed] -include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] -include::{docdir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{docdir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-tasks-api-response-codes]] ==== {api-response-codes-title} -include::{docdir}/cluster/tasks.asciidoc[tag=tasks-api-404] +include::{es-repo-dir}/cluster/tasks.asciidoc[tag=tasks-api-404] [[cat-tasks-api-examples]] diff --git a/docs/reference/cat/templates.asciidoc b/docs/reference/cat/templates.asciidoc index b16275e0426..fc6b61fa821 100644 --- a/docs/reference/cat/templates.asciidoc +++ b/docs/reference/cat/templates.asciidoc @@ -28,19 +28,19 @@ the request. Accepts wildcard expressions. [[cat-templates-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] -include::{docdir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{docdir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-templates-api-example]] diff --git a/docs/reference/cat/thread_pool.asciidoc b/docs/reference/cat/thread_pool.asciidoc index 95978c8cf01..0ead8513001 100644 --- a/docs/reference/cat/thread_pool.asciidoc +++ b/docs/reference/cat/thread_pool.asciidoc @@ -28,9 +28,9 @@ request. Accepts wildcard expressions. [[cat-thread-pool-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] + -- If you do not specify which columns to include, the API returns the default @@ -101,18 +101,18 @@ Type of thread pool. Returned values are `fixed` or `scaling`. -- -include::{docdir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{docdir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] `size`:: (Optional, <>) Multiplier used to display quantities. -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-thread-pool-api-example]] diff --git a/docs/reference/cat/trainedmodel.asciidoc b/docs/reference/cat/trainedmodel.asciidoc index 679133157cd..5d994c73a9b 100644 --- a/docs/reference/cat/trainedmodel.asciidoc +++ b/docs/reference/cat/trainedmodel.asciidoc @@ -36,11 +36,11 @@ For more information, see <> and [[cat-trained-model-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=bytes] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes] -include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-repo-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 @@ -97,13 +97,13 @@ measuring the computational complexity of the model. `version`, `v`::: The {es} version number in which the trained model was created. -include::{docdir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] -include::{docdir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-trained-model-example]] diff --git a/docs/reference/cat/transforms.asciidoc b/docs/reference/cat/transforms.asciidoc index b1b6b40e741..428c6bfd0d6 100644 --- a/docs/reference/cat/transforms.asciidoc +++ b/docs/reference/cat/transforms.asciidoc @@ -33,22 +33,22 @@ privileges. For more information, see <> and ``:: (Optional, string) -include::{docdir}/rest-api/common-parms.asciidoc[tag=transform-id-wildcard] +include::{es-repo-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::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-match-transforms1] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-match-transforms1] -include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] `from`:: (Optional, integer) -include::{docdir}/rest-api/common-parms.asciidoc[tag=from-transforms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=from-transforms] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h] +include::{es-repo-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 @@ -57,10 +57,10 @@ specified columns. Valid columns are: `changes_last_detection_time`, `cldt`::: -include::{docdir}/rest-api/common-parms.asciidoc[tag=checkpointing-changes-last-detected-at] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=checkpointing-changes-last-detected-at] `checkpoint_duration_time_exp_avg`, `cdtea`, `checkpointTimeExpAvg`::: -include::{docdir}/rest-api/common-parms.asciidoc[tag=exponential-avg-checkpoint-duration-ms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-checkpoint-duration-ms] `create_time`, `ct`, `createTime`::: (Default) @@ -72,94 +72,94 @@ The description of the {transform}. `dest_index`, `di`, `destIndex`::: (Default) -include::{docdir}/rest-api/common-parms.asciidoc[tag=dest-index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-index] `documents_indexed`, `doci`::: -include::{docdir}/rest-api/common-parms.asciidoc[tag=docs-indexed] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-indexed] `documents_processed`, `docp`::: -include::{docdir}/rest-api/common-parms.asciidoc[tag=docs-processed] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-processed] `frequency`, `f`::: (Default) -include::{docdir}/rest-api/common-parms.asciidoc[tag=frequency] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=frequency] `id`::: (Default) -include::{docdir}/rest-api/common-parms.asciidoc[tag=transform-id] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id] `index_failure`, `if`::: -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-failures] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-failures] `index_time`, `itime`::: -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-time-ms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-time-ms] `index_total`, `it`::: -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-total] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-total] `indexed_documents_exp_avg`, `idea`::: -include::{docdir}/rest-api/common-parms.asciidoc[tag=exponential-avg-documents-indexed] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-documents-indexed] `max_page_search_size`, `mpsz`::: (Default) -include::{docdir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size] `pages_processed`, `pp`::: -include::{docdir}/rest-api/common-parms.asciidoc[tag=pages-processed] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pages-processed] `pipeline`, `p`::: (Default) -include::{docdir}/rest-api/common-parms.asciidoc[tag=dest-pipeline] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=dest-pipeline] `processed_documents_exp_avg`, `pdea`::: -include::{docdir}/rest-api/common-parms.asciidoc[tag=exponential-avg-documents-processed] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=exponential-avg-documents-processed] `processing_time`, `pt`::: -include::{docdir}/rest-api/common-parms.asciidoc[tag=processing-time-ms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=processing-time-ms] `reason`, `r`::: -include::{docdir}/rest-api/common-parms.asciidoc[tag=state-transform-reason] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=state-transform-reason] `search_failure`, `sf`::: -include::{docdir}/rest-api/common-parms.asciidoc[tag=search-failures] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-failures] `search_time`, `stime`::: -include::{docdir}/rest-api/common-parms.asciidoc[tag=search-time-ms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-time-ms] `search_total`, `st`::: -include::{docdir}/rest-api/common-parms.asciidoc[tag=search-total] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-total] `source_index`, `si`, `sourceIndex`::: (Default) -include::{docdir}/rest-api/common-parms.asciidoc[tag=source-index-transforms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source-index-transforms] `state`, `s`::: (Default) -include::{docdir}/rest-api/common-parms.asciidoc[tag=state-transform] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=state-transform] `transform_type`, `tt`::: (Default) Indicates the type of {transform}: `batch` or `continuous`. `trigger_count`, `tc`::: -include::{docdir}/rest-api/common-parms.asciidoc[tag=trigger-count] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=trigger-count] `version`, `v`::: (Default) The version of {es} that existed on the node when the {transform} was created. -include::{docdir}/rest-api/common-parms.asciidoc[tag=help] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] `size`:: (Optional, integer) -include::{docdir}/rest-api/common-parms.asciidoc[tag=size-transforms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=size-transforms] -include::{docdir}/rest-api/common-parms.asciidoc[tag=time] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] -include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v] [[cat-transforms-api-examples]] ==== {api-examples-title} diff --git a/docs/reference/cluster/get-settings.asciidoc b/docs/reference/cluster/get-settings.asciidoc index ba199e054c3..01be2af5c37 100644 --- a/docs/reference/cluster/get-settings.asciidoc +++ b/docs/reference/cluster/get-settings.asciidoc @@ -20,10 +20,10 @@ defined, but can also include the default settings by calling the ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] `include_defaults`:: (Optional, boolean) If `true`, returns all default cluster settings. Defaults to `false`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] \ No newline at end of file +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] \ No newline at end of file diff --git a/docs/reference/cluster/health.asciidoc b/docs/reference/cluster/health.asciidoc index 1752d850d4e..f1d03cc464a 100644 --- a/docs/reference/cluster/health.asciidoc +++ b/docs/reference/cluster/health.asciidoc @@ -39,7 +39,7 @@ GET /_cluster/health?wait_for_status=yellow&timeout=50s [[cluster-health-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] [[cluster-health-api-query-params]] ==== {api-query-parms-title} @@ -48,9 +48,9 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index] (Optional, string) Can be one of `cluster`, `indices` or `shards`. Controls the details level of the health information returned. Defaults to `cluster`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] `wait_for_active_shards`:: (Optional, string) A number controlling to how many active shards to wait @@ -91,7 +91,7 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] (string) The name of the cluster. `status`:: -include::{docdir}/rest-api/common-parms.asciidoc[tag=cluster-health-status] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cluster-health-status] `timed_out`:: (boolean) If `false` the response returned within the period of diff --git a/docs/reference/cluster/nodes-hot-threads.asciidoc b/docs/reference/cluster/nodes-hot-threads.asciidoc index b8cd88494bc..b3fb77d1695 100644 --- a/docs/reference/cluster/nodes-hot-threads.asciidoc +++ b/docs/reference/cluster/nodes-hot-threads.asciidoc @@ -26,7 +26,7 @@ threads. [[cluster-nodes-hot-threads-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=node-id] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id] [[cluster-nodes-hot-threads-api-query-params]] @@ -50,7 +50,7 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=node-id] (Optional, integer) Specifies the number of hot threads to provide information for. Defaults to `3`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] `type`:: (Optional, string) The type to sample. Available options are `block`, `cpu`, and diff --git a/docs/reference/cluster/nodes-info.asciidoc b/docs/reference/cluster/nodes-info.asciidoc index 39e0a22c8be..1ee40560f4d 100644 --- a/docs/reference/cluster/nodes-info.asciidoc +++ b/docs/reference/cluster/nodes-info.asciidoc @@ -80,7 +80,7 @@ By default, it returns all attributes and core settings for a node. -- -include::{docdir}/rest-api/common-parms.asciidoc[tag=node-id] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id] [[cluster-nodes-info-api-response-body]] @@ -153,9 +153,9 @@ running process: [[cluster-nodes-info-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[cluster-nodes-info-api-example]] diff --git a/docs/reference/cluster/nodes-stats.asciidoc b/docs/reference/cluster/nodes-stats.asciidoc index 1b80274edcb..a1b1a2fd526 100644 --- a/docs/reference/cluster/nodes-stats.asciidoc +++ b/docs/reference/cluster/nodes-stats.asciidoc @@ -109,29 +109,29 @@ using metrics. * `warmer` -- -include::{docdir}/rest-api/common-parms.asciidoc[tag=node-id] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id] [[cluster-nodes-stats-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=completion-fields] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=completion-fields] -include::{docdir}/rest-api/common-parms.asciidoc[tag=fielddata-fields] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fielddata-fields] -include::{docdir}/rest-api/common-parms.asciidoc[tag=fields] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fields] -include::{docdir}/rest-api/common-parms.asciidoc[tag=groups] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=groups] -include::{docdir}/rest-api/common-parms.asciidoc[tag=level] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=level] `types`:: (Optional, string) A comma-separated list of document types for the `indexing` index metric. -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] -include::{docdir}/rest-api/common-parms.asciidoc[tag=include-segment-file-sizes] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-segment-file-sizes] [role="child_attributes"] [[cluster-nodes-stats-api-response-body]] @@ -224,11 +224,11 @@ node. ======= `count`:: (integer) -include::{docdir}/rest-api/common-parms.asciidoc[tag=docs-count] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-count] `deleted`:: (integer) -include::{docdir}/rest-api/common-parms.asciidoc[tag=docs-deleted] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-deleted] ======= `store`:: diff --git a/docs/reference/cluster/nodes-usage.asciidoc b/docs/reference/cluster/nodes-usage.asciidoc index 923e0ae9443..020efa32259 100644 --- a/docs/reference/cluster/nodes-usage.asciidoc +++ b/docs/reference/cluster/nodes-usage.asciidoc @@ -43,13 +43,13 @@ of features for each node. All the nodes selective options are explained that action has been called on the node. -- -include::{docdir}/rest-api/common-parms.asciidoc[tag=node-id] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id] [[cluster-nodes-usage-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[cluster-nodes-usage-api-example]] diff --git a/docs/reference/cluster/pending.asciidoc b/docs/reference/cluster/pending.asciidoc index 79d17cd37b7..53025199fcc 100644 --- a/docs/reference/cluster/pending.asciidoc +++ b/docs/reference/cluster/pending.asciidoc @@ -29,9 +29,9 @@ might be reported by both task api and pending cluster tasks API. [[cluster-pending-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[cluster-pending-api-response-body]] diff --git a/docs/reference/cluster/reroute.asciidoc b/docs/reference/cluster/reroute.asciidoc index 32851c0a16b..b61d30181fb 100644 --- a/docs/reference/cluster/reroute.asciidoc +++ b/docs/reference/cluster/reroute.asciidoc @@ -102,7 +102,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::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [role="child_attributes"] [[cluster-reroute-api-request-body]] diff --git a/docs/reference/cluster/state.asciidoc b/docs/reference/cluster/state.asciidoc index 3fbd0143f4a..265a4b3e7e7 100644 --- a/docs/reference/cluster/state.asciidoc +++ b/docs/reference/cluster/state.asciidoc @@ -86,7 +86,7 @@ you can request only the part of the cluster state that you need: Shows the cluster state version. -- -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] [[cluster-state-api-query-params]] @@ -104,15 +104,15 @@ Defaults to `true`. that are open, closed or both. Available options: `open`, `closed`, `none`, `all`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] `ignore_unavailable`:: (Optional, boolean) If `true`, unavailable indices (missing or closed) will be ignored. -include::{docdir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-repo-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 diff --git a/docs/reference/cluster/stats.asciidoc b/docs/reference/cluster/stats.asciidoc index e334a88ed20..db725d2c6a0 100644 --- a/docs/reference/cluster/stats.asciidoc +++ b/docs/reference/cluster/stats.asciidoc @@ -28,15 +28,15 @@ memory usage) and information about the current nodes that form the cluster ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=node-filter] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-filter] [[cluster-stats-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeout] [role="child_attributes"] [[cluster-stats-api-response-body]] @@ -78,7 +78,7 @@ https://en.wikipedia.org/wiki/Unix_time[Unix timestamp], in milliseconds, of the last time the cluster statistics were refreshed. `status`:: -include::{docdir}/rest-api/common-parms.asciidoc[tag=cluster-health-status] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cluster-health-status] + See <>. diff --git a/docs/reference/cluster/tasks.asciidoc b/docs/reference/cluster/tasks.asciidoc index af8f600c10d..31c51526584 100644 --- a/docs/reference/cluster/tasks.asciidoc +++ b/docs/reference/cluster/tasks.asciidoc @@ -27,25 +27,25 @@ on one or more nodes in the cluster. [[tasks-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=task-id] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=task-id] [[tasks-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=actions] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=actions] -include::{docdir}/rest-api/common-parms.asciidoc[tag=detailed] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=detailed] -include::{docdir}/rest-api/common-parms.asciidoc[tag=group-by] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=group-by] -include::{docdir}/rest-api/common-parms.asciidoc[tag=node-id-query-parm] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id-query-parm] -include::{docdir}/rest-api/common-parms.asciidoc[tag=parent-task-id] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=parent-task-id] -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] -include::{docdir}/rest-api/common-parms.asciidoc[tag=wait_for_completion] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_completion] [[tasks-api-response-codes]] diff --git a/docs/reference/cluster/update-settings.asciidoc b/docs/reference/cluster/update-settings.asciidoc index 7d78616e38b..9ff4cebe1f2 100644 --- a/docs/reference/cluster/update-settings.asciidoc +++ b/docs/reference/cluster/update-settings.asciidoc @@ -44,13 +44,13 @@ difficult to notice these discrepancies. [[cluster-update-settings-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] `include_defaults`:: (Optional, boolean) If `true`, returns all default cluster settings. Defaults to `false`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[cluster-update-settings-api-example]] diff --git a/docs/reference/docs/bulk.asciidoc b/docs/reference/docs/bulk.asciidoc index e711d48a993..e2457a9f5aa 100644 --- a/docs/reference/docs/bulk.asciidoc +++ b/docs/reference/docs/bulk.asciidoc @@ -198,21 +198,21 @@ See <>. [[docs-bulk-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=pipeline] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pipeline] -include::{docdir}/rest-api/common-parms.asciidoc[tag=refresh] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh] -include::{docdir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] -include::{docdir}/rest-api/common-parms.asciidoc[tag=source] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source] -include::{docdir}/rest-api/common-parms.asciidoc[tag=source_excludes] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_excludes] -include::{docdir}/rest-api/common-parms.asciidoc[tag=source_includes] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_includes] -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeout] -include::{docdir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] [[bulk-api-request-body]] ==== {api-request-body-title} @@ -225,9 +225,9 @@ Indexes the specified document if it does not already exist. The following line must contain the source data to be indexed. + -- -include::{docdir}/rest-api/common-parms.asciidoc[tag=bulk-index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index] -include::{docdir}/rest-api/common-parms.asciidoc[tag=bulk-id] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-id] -- `delete`:: @@ -235,7 +235,7 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=bulk-id] Removes the specified document from the index. + -- -include::{docdir}/rest-api/common-parms.asciidoc[tag=bulk-index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index] `_id`:: (Required, string) @@ -249,9 +249,9 @@ If the document exists, replaces the document and increments the version. The following line must contain the source data to be indexed. + -- -include::{docdir}/rest-api/common-parms.asciidoc[tag=bulk-index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index] -include::{docdir}/rest-api/common-parms.asciidoc[tag=bulk-id] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-id] -- `update`:: @@ -260,9 +260,9 @@ Performs a partial document update. The following line must contain the partial document and update options. + -- -include::{docdir}/rest-api/common-parms.asciidoc[tag=bulk-index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index] -include::{docdir}/rest-api/common-parms.asciidoc[tag=bulk-id] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-id] -- `doc`:: diff --git a/docs/reference/docs/delete-by-query.asciidoc b/docs/reference/docs/delete-by-query.asciidoc index b064e6b9784..d1cd77baa96 100644 --- a/docs/reference/docs/delete-by-query.asciidoc +++ b/docs/reference/docs/delete-by-query.asciidoc @@ -161,75 +161,75 @@ or omit to search all indices. [[docs-delete-by-query-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=analyzer] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=analyzer] -include::{docdir}/rest-api/common-parms.asciidoc[tag=analyze_wildcard] +include::{es-repo-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::{docdir}/rest-api/common-parms.asciidoc[tag=default_operator] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=default_operator] -include::{docdir}/rest-api/common-parms.asciidoc[tag=df] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=df] -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=from] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=from] -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{docdir}/rest-api/common-parms.asciidoc[tag=lenient] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=lenient] -include::{docdir}/rest-api/common-parms.asciidoc[tag=max_docs] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=max_docs] -include::{docdir}/rest-api/common-parms.asciidoc[tag=preference] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference] -include::{docdir}/rest-api/common-parms.asciidoc[tag=search-q] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-q] -include::{docdir}/rest-api/common-parms.asciidoc[tag=request_cache] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=request_cache] -include::{docdir}/rest-api/common-parms.asciidoc[tag=refresh] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh] -include::{docdir}/rest-api/common-parms.asciidoc[tag=requests_per_second] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=requests_per_second] -include::{docdir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] -include::{docdir}/rest-api/common-parms.asciidoc[tag=scroll] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=scroll] -include::{docdir}/rest-api/common-parms.asciidoc[tag=scroll_size] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=scroll_size] -include::{docdir}/rest-api/common-parms.asciidoc[tag=search_type] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search_type] -include::{docdir}/rest-api/common-parms.asciidoc[tag=search_timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search_timeout] -include::{docdir}/rest-api/common-parms.asciidoc[tag=slices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=slices] -include::{docdir}/rest-api/common-parms.asciidoc[tag=sort] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sort] -include::{docdir}/rest-api/common-parms.asciidoc[tag=source] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source] -include::{docdir}/rest-api/common-parms.asciidoc[tag=source_excludes] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_excludes] -include::{docdir}/rest-api/common-parms.asciidoc[tag=source_includes] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_includes] -include::{docdir}/rest-api/common-parms.asciidoc[tag=stats] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=stats] -include::{docdir}/rest-api/common-parms.asciidoc[tag=terminate_after] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=terminate_after] -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeout] -include::{docdir}/rest-api/common-parms.asciidoc[tag=version] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version] -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeout] -include::{docdir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] [[docs-delete-by-query-api-request-body]] ==== {api-request-body-title} diff --git a/docs/reference/docs/delete.asciidoc b/docs/reference/docs/delete.asciidoc index 479db4a453e..d658a7b4c2c 100644 --- a/docs/reference/docs/delete.asciidoc +++ b/docs/reference/docs/delete.asciidoc @@ -141,23 +141,23 @@ DELETE /twitter/_doc/1?timeout=5m [[docs-delete-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=if_seq_no] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=if_seq_no] -include::{docdir}/rest-api/common-parms.asciidoc[tag=if_primary_term] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=if_primary_term] -include::{docdir}/rest-api/common-parms.asciidoc[tag=pipeline] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pipeline] -include::{docdir}/rest-api/common-parms.asciidoc[tag=refresh] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh] -include::{docdir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeout] -include::{docdir}/rest-api/common-parms.asciidoc[tag=doc-version] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=doc-version] -include::{docdir}/rest-api/common-parms.asciidoc[tag=version_type] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version_type] -include::{docdir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] [[docs-delete-api-example]] ==== {api-examples-title} diff --git a/docs/reference/docs/get.asciidoc b/docs/reference/docs/get.asciidoc index c6624e1e575..f3f3ede247d 100644 --- a/docs/reference/docs/get.asciidoc +++ b/docs/reference/docs/get.asciidoc @@ -156,28 +156,28 @@ deleted documents in the background as you continue to index more data. [[docs-get-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=preference] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference] -include::{docdir}/rest-api/common-parms.asciidoc[tag=realtime] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=realtime] `refresh`:: (Optional, boolean) If `true`, {es} refreshes the affected shards to make this operation visible to search. If `false`, do nothing with refreshes. Defaults to `false`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] -include::{docdir}/rest-api/common-parms.asciidoc[tag=stored_fields] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=stored_fields] -include::{docdir}/rest-api/common-parms.asciidoc[tag=source] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source] -include::{docdir}/rest-api/common-parms.asciidoc[tag=source_excludes] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_excludes] -include::{docdir}/rest-api/common-parms.asciidoc[tag=source_includes] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_includes] -include::{docdir}/rest-api/common-parms.asciidoc[tag=doc-version] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=doc-version] -include::{docdir}/rest-api/common-parms.asciidoc[tag=version_type] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version_type] [[docs-get-api-response-body]] ==== {api-response-body-title} diff --git a/docs/reference/docs/index_.asciidoc b/docs/reference/docs/index_.asciidoc index 918e8fe03cc..89130ba4894 100644 --- a/docs/reference/docs/index_.asciidoc +++ b/docs/reference/docs/index_.asciidoc @@ -37,9 +37,9 @@ POST request. [[docs-index-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=if_seq_no] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=if_seq_no] -include::{docdir}/rest-api/common-parms.asciidoc[tag=if_primary_term] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=if_primary_term] `op_type`:: (Optional, enum) Set to `create` to only index the document @@ -48,19 +48,19 @@ if it does not already exist (_put if absent_). If a document with the specified `/_create` endpoint. Valid values: `index`, `create`. If document id is specified, it defaults to `index`. Otherwise, it defaults to `create`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=pipeline] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pipeline] -include::{docdir}/rest-api/common-parms.asciidoc[tag=refresh] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh] -include::{docdir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] -include::{docdir}/rest-api/common-parms.asciidoc[tag=doc-version] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=doc-version] -include::{docdir}/rest-api/common-parms.asciidoc[tag=version_type] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version_type] -include::{docdir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] [[docs-index-api-request-body]] ==== {api-request-body-title} diff --git a/docs/reference/docs/multi-get.asciidoc b/docs/reference/docs/multi-get.asciidoc index 395d033f26c..1ac7ddf202b 100644 --- a/docs/reference/docs/multi-get.asciidoc +++ b/docs/reference/docs/multi-get.asciidoc @@ -58,21 +58,21 @@ or when a document in the `docs` array does not specify an index. [[docs-multi-get-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=preference] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference] -include::{docdir}/rest-api/common-parms.asciidoc[tag=realtime] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=realtime] -include::{docdir}/rest-api/common-parms.asciidoc[tag=refresh] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh] -include::{docdir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] -include::{docdir}/rest-api/common-parms.asciidoc[tag=stored_fields] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=stored_fields] -include::{docdir}/rest-api/common-parms.asciidoc[tag=source] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source] -include::{docdir}/rest-api/common-parms.asciidoc[tag=source_excludes] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_excludes] -include::{docdir}/rest-api/common-parms.asciidoc[tag=source_includes] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_includes] [[docs-multi-get-api-request-body]] ==== {api-request-body-title} diff --git a/docs/reference/docs/multi-termvectors.asciidoc b/docs/reference/docs/multi-termvectors.asciidoc index f351c29745a..657c375c5dc 100644 --- a/docs/reference/docs/multi-termvectors.asciidoc +++ b/docs/reference/docs/multi-termvectors.asciidoc @@ -58,27 +58,27 @@ that can be included in the response. [[docs-multi-termvectors-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=fields] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fields] -include::{docdir}/rest-api/common-parms.asciidoc[tag=field_statistics] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=field_statistics] -include::{docdir}/rest-api/common-parms.asciidoc[tag=offsets] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=offsets] -include::{docdir}/rest-api/common-parms.asciidoc[tag=payloads] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=payloads] -include::{docdir}/rest-api/common-parms.asciidoc[tag=positions] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=positions] -include::{docdir}/rest-api/common-parms.asciidoc[tag=preference] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference] -include::{docdir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] -include::{docdir}/rest-api/common-parms.asciidoc[tag=realtime] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=realtime] -include::{docdir}/rest-api/common-parms.asciidoc[tag=term_statistics] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=term_statistics] -include::{docdir}/rest-api/common-parms.asciidoc[tag=version] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version] -include::{docdir}/rest-api/common-parms.asciidoc[tag=version_type] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version_type] [float] [[docs-multi-termvectors-api-example]] diff --git a/docs/reference/docs/reindex.asciidoc b/docs/reference/docs/reindex.asciidoc index 3f7020a17be..9f24f909457 100644 --- a/docs/reference/docs/reindex.asciidoc +++ b/docs/reference/docs/reindex.asciidoc @@ -417,21 +417,21 @@ POST _reindex [[docs-reindex-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=refresh] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh] -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeout] -include::{docdir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] -include::{docdir}/rest-api/common-parms.asciidoc[tag=wait_for_completion] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_completion] -include::{docdir}/rest-api/common-parms.asciidoc[tag=requests_per_second] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=requests_per_second] -include::{docdir}/rest-api/common-parms.asciidoc[tag=scroll] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=scroll] -include::{docdir}/rest-api/common-parms.asciidoc[tag=slices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=slices] -include::{docdir}/rest-api/common-parms.asciidoc[tag=max_docs] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=max_docs] [[docs-reindex-api-request-body]] ==== {api-request-body-title} diff --git a/docs/reference/docs/termvectors.asciidoc b/docs/reference/docs/termvectors.asciidoc index 8d3d5012aa6..f8d4d00a9d4 100644 --- a/docs/reference/docs/termvectors.asciidoc +++ b/docs/reference/docs/termvectors.asciidoc @@ -137,27 +137,27 @@ from is randomly selected. Use `routing` only to hit a particular shard. [[docs-termvectors-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=fields] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fields] -include::{docdir}/rest-api/common-parms.asciidoc[tag=field_statistics] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=field_statistics] -include::{docdir}/rest-api/common-parms.asciidoc[tag=offsets] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=offsets] -include::{docdir}/rest-api/common-parms.asciidoc[tag=payloads] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=payloads] -include::{docdir}/rest-api/common-parms.asciidoc[tag=positions] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=positions] -include::{docdir}/rest-api/common-parms.asciidoc[tag=preference] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference] -include::{docdir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] -include::{docdir}/rest-api/common-parms.asciidoc[tag=realtime] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=realtime] -include::{docdir}/rest-api/common-parms.asciidoc[tag=term_statistics] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=term_statistics] -include::{docdir}/rest-api/common-parms.asciidoc[tag=version] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version] -include::{docdir}/rest-api/common-parms.asciidoc[tag=version_type] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version_type] [[docs-termvectors-api-example]] ==== {api-examples-title} diff --git a/docs/reference/docs/update-by-query.asciidoc b/docs/reference/docs/update-by-query.asciidoc index d85f76a6765..d84a91fab5b 100644 --- a/docs/reference/docs/update-by-query.asciidoc +++ b/docs/reference/docs/update-by-query.asciidoc @@ -188,7 +188,7 @@ POST twitter/_update_by_query?pipeline=set-foo // TEST[setup:twitter] [float] -==== URL Parameters +==== URL parameters In addition to the standard parameters like `pretty`, the Update By Query API also supports `refresh`, `wait_for_completion`, `wait_for_active_shards`, `timeout`, diff --git a/docs/reference/docs/update.asciidoc b/docs/reference/docs/update.asciidoc index 234d4527fc2..b2028f2b224 100644 --- a/docs/reference/docs/update.asciidoc +++ b/docs/reference/docs/update.asciidoc @@ -46,20 +46,20 @@ automatically if it doesn't exist. For more information, see <>. [[docs-update-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=if_seq_no] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=if_seq_no] -include::{docdir}/rest-api/common-parms.asciidoc[tag=if_primary_term] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=if_primary_term] `lang`:: (Optional, string) The script language. Default: `painless`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=refresh] +include::{es-repo-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::{docdir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] `_source`:: (Optional, list) Set to `false` to disable source retrieval (default: `true`). @@ -71,9 +71,9 @@ You can also specify a comma-separated list of the fields you want to retrieve. `_source_includes`:: (Optional, list) Specify the source fields you want to retrieve. -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] -include::{docdir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] [[update-api-example]] ==== {api-examples-title} diff --git a/docs/reference/eql/eql-search-api.asciidoc b/docs/reference/eql/eql-search-api.asciidoc index 49ddb4941cb..7dd2cbf9849 100644 --- a/docs/reference/eql/eql-search-api.asciidoc +++ b/docs/reference/eql/eql-search-api.asciidoc @@ -71,15 +71,15 @@ To search all indices, use `_all` or `*`. [[eql-search-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `false`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] [[eql-search-api-request-body]] ==== {api-request-body-title} diff --git a/docs/reference/how-to/indexing-speed.asciidoc b/docs/reference/how-to/indexing-speed.asciidoc index e5a84f8ddc9..97cd88d06e0 100644 --- a/docs/reference/how-to/indexing-speed.asciidoc +++ b/docs/reference/how-to/indexing-speed.asciidoc @@ -43,7 +43,7 @@ The operation that consists of making changes visible to search - called a <> - is costly, and calling it often while there is ongoing indexing activity can hurt indexing speed. -include::{docdir}/indices/refresh.asciidoc[tag=refresh-interval-default] +include::{es-repo-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 diff --git a/docs/reference/ilm/apis/delete-lifecycle.asciidoc b/docs/reference/ilm/apis/delete-lifecycle.asciidoc index bcc2107f2da..51af2b30791 100644 --- a/docs/reference/ilm/apis/delete-lifecycle.asciidoc +++ b/docs/reference/ilm/apis/delete-lifecycle.asciidoc @@ -36,7 +36,7 @@ the request fails and returns an error. [[ilm-delete-lifecycle-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[ilm-delete-lifecycle-example]] ==== {api-examples-title} diff --git a/docs/reference/ilm/apis/explain.asciidoc b/docs/reference/ilm/apis/explain.asciidoc index 8bfd9e7a26f..1c9e0b11242 100644 --- a/docs/reference/ilm/apis/explain.asciidoc +++ b/docs/reference/ilm/apis/explain.asciidoc @@ -46,7 +46,7 @@ about any failures. {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::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[ilm-explain-lifecycle-example]] ==== {api-examples-title} diff --git a/docs/reference/ilm/apis/get-lifecycle.asciidoc b/docs/reference/ilm/apis/get-lifecycle.asciidoc index b67fb69d363..59052bce237 100644 --- a/docs/reference/ilm/apis/get-lifecycle.asciidoc +++ b/docs/reference/ilm/apis/get-lifecycle.asciidoc @@ -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::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[ilm-get-lifecycle-example]] ==== {api-examples-title} diff --git a/docs/reference/ilm/apis/get-status.asciidoc b/docs/reference/ilm/apis/get-status.asciidoc index 600496da222..12218e30c09 100644 --- a/docs/reference/ilm/apis/get-status.asciidoc +++ b/docs/reference/ilm/apis/get-status.asciidoc @@ -33,7 +33,7 @@ or `STOPPED`. You can change the status of the {ilm-init} plugin with the [[ilm-get-status-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[ilm-get-status-example]] ==== {api-examples-title} diff --git a/docs/reference/ilm/apis/move-to-step.asciidoc b/docs/reference/ilm/apis/move-to-step.asciidoc index 4c1087453db..49ed402ffe7 100644 --- a/docs/reference/ilm/apis/move-to-step.asciidoc +++ b/docs/reference/ilm/apis/move-to-step.asciidoc @@ -45,7 +45,7 @@ an unexpected step into the next step. [[ilm-move-to-step-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [role="child_attributes"] [[ilm-move-to-step-request-body]] diff --git a/docs/reference/ilm/apis/put-lifecycle.asciidoc b/docs/reference/ilm/apis/put-lifecycle.asciidoc index 7c1e2d97044..02cfe37920b 100644 --- a/docs/reference/ilm/apis/put-lifecycle.asciidoc +++ b/docs/reference/ilm/apis/put-lifecycle.asciidoc @@ -41,7 +41,7 @@ previous versions. [[ilm-put-lifecycle-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[ilm-put-lifecycle-example]] ==== {api-examples-title} diff --git a/docs/reference/ilm/apis/remove-policy-from-index.asciidoc b/docs/reference/ilm/apis/remove-policy-from-index.asciidoc index be82ed841e0..9bce82cf4a2 100644 --- a/docs/reference/ilm/apis/remove-policy-from-index.asciidoc +++ b/docs/reference/ilm/apis/remove-policy-from-index.asciidoc @@ -36,7 +36,7 @@ indices. [[ilm-remove-policy-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[ilm-remove-policy-example]] ==== {api-examples-title} diff --git a/docs/reference/ilm/apis/retry-policy.asciidoc b/docs/reference/ilm/apis/retry-policy.asciidoc index 41f0e82675f..1f4fad0ce50 100644 --- a/docs/reference/ilm/apis/retry-policy.asciidoc +++ b/docs/reference/ilm/apis/retry-policy.asciidoc @@ -36,7 +36,7 @@ step. [[ilm-retry-policy-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[ilm-retry-policy-example]] ==== {api-examples-title} diff --git a/docs/reference/ilm/apis/start.asciidoc b/docs/reference/ilm/apis/start.asciidoc index fac7ddcbbb1..d375b10e9c3 100644 --- a/docs/reference/ilm/apis/start.asciidoc +++ b/docs/reference/ilm/apis/start.asciidoc @@ -32,7 +32,7 @@ necessary if it has been stopped using the <>. [[ilm-start-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[ilm-start-example]] ==== {api-examples-title} diff --git a/docs/reference/ilm/apis/stop.asciidoc b/docs/reference/ilm/apis/stop.asciidoc index 8f6e71558be..dd15423423c 100644 --- a/docs/reference/ilm/apis/stop.asciidoc +++ b/docs/reference/ilm/apis/stop.asciidoc @@ -37,7 +37,7 @@ if {ilm-init} is running. [[ilm-stop-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[ilm-stop-example]] ==== {api-examples-title} diff --git a/docs/reference/indices/add-alias.asciidoc b/docs/reference/indices/add-alias.asciidoc index c1f75bdb2dd..231b5712b0e 100644 --- a/docs/reference/indices/add-alias.asciidoc +++ b/docs/reference/indices/add-alias.asciidoc @@ -6,7 +6,7 @@ Creates or updates an index alias. -include::{docdir}/glossary.asciidoc[tag=index-alias-desc] +include::{es-repo-dir}/glossary.asciidoc[tag=index-alias-desc] [source,console] ---- @@ -46,7 +46,7 @@ Name of the index alias to create or update. [[add-alias-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[add-alias-api-request-body]] @@ -54,9 +54,9 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] `filter`:: (Required, query object) -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-alias-filter] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-alias-filter] -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-routing] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-routing] [[add-alias-api-example]] ==== {api-examples-title} diff --git a/docs/reference/indices/alias-exists.asciidoc b/docs/reference/indices/alias-exists.asciidoc index de2a6baa440..09de5378b54 100644 --- a/docs/reference/indices/alias-exists.asciidoc +++ b/docs/reference/indices/alias-exists.asciidoc @@ -6,7 +6,7 @@ Checks if an index alias exists. -include::{docdir}/glossary.asciidoc[tag=index-alias-desc] +include::{es-repo-dir}/glossary.asciidoc[tag=index-alias-desc] [source,console] ---- @@ -29,20 +29,20 @@ HEAD /_alias/alias1 ``:: (Required, string) -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-alias] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-alias] -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] [[alias-exists-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `all`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{docdir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] [[alias-exists-api-response-codes]] diff --git a/docs/reference/indices/aliases.asciidoc b/docs/reference/indices/aliases.asciidoc index bb672b11d23..5cb819ab100 100644 --- a/docs/reference/indices/aliases.asciidoc +++ b/docs/reference/indices/aliases.asciidoc @@ -6,7 +6,7 @@ Adds or removes index aliases. -include::{docdir}/glossary.asciidoc[tag=index-alias-desc] +include::{es-repo-dir}/glossary.asciidoc[tag=index-alias-desc] [source,console] ---- @@ -42,7 +42,7 @@ searching, and routing values. An alias cannot have the same name as an index. [[indices-aliases-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[indices-aliases-api-request-body]] @@ -102,7 +102,7 @@ this parameter is required for the `add` or `remove` action. `filter`:: (Optional, query object) -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-alias-filter] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-alias-filter] + See <> for an example. @@ -130,7 +130,7 @@ until an additional index is referenced. At that point, there will be no write i writes will be rejected. ==== -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-routing] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-routing] + See <> for an example. diff --git a/docs/reference/indices/apis/reload-analyzers.asciidoc b/docs/reference/indices/apis/reload-analyzers.asciidoc index b5df64c53ae..b9b5bc79732 100644 --- a/docs/reference/indices/apis/reload-analyzers.asciidoc +++ b/docs/reference/indices/apis/reload-analyzers.asciidoc @@ -73,15 +73,15 @@ used to limit the request. [[indices-reload-analyzers-api-query-params]] === {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] [discrete] diff --git a/docs/reference/indices/clearcache.asciidoc b/docs/reference/indices/clearcache.asciidoc index 8caf99f6d3f..ba83b8baf34 100644 --- a/docs/reference/indices/clearcache.asciidoc +++ b/docs/reference/indices/clearcache.asciidoc @@ -24,17 +24,17 @@ POST /twitter/_cache/clear [[clear-cache-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] [[clear-cache-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. @@ -68,7 +68,7 @@ or field aliases. Comma-separated list of index names used to limit the request. -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] `query`:: (Optional, boolean) diff --git a/docs/reference/indices/clone-index.asciidoc b/docs/reference/indices/clone-index.asciidoc index e9c9dd2796a..dfcf0f4da82 100644 --- a/docs/reference/indices/clone-index.asciidoc +++ b/docs/reference/indices/clone-index.asciidoc @@ -155,20 +155,20 @@ on index creation applies to the clone index action as well. (Required, string) Name of the source index to clone. -include::{docdir}/rest-api/common-parms.asciidoc[tag=target-index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=target-index] [[clone-index-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[clone-index-api-request-body]] ==== {api-request-body-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=target-index-aliases] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=target-index-aliases] -include::{docdir}/rest-api/common-parms.asciidoc[tag=target-index-settings] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=target-index-settings] diff --git a/docs/reference/indices/close.asciidoc b/docs/reference/indices/close.asciidoc index f44a89de639..fe657c77aa1 100644 --- a/docs/reference/indices/close.asciidoc +++ b/docs/reference/indices/close.asciidoc @@ -24,13 +24,13 @@ POST /twitter/_close You use the close index API to close open indices. -include::{docdir}/indices/open-close.asciidoc[tag=closed-index] +include::{es-repo-dir}/indices/open-close.asciidoc[tag=closed-index] [[close-index-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] + To close all indices, use `_all` or `*`. To disallow the closing of indices with `_all` or wildcard expressions, @@ -42,19 +42,19 @@ or using the <> API. [[close-index-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{docdir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[close-index-api-example]] diff --git a/docs/reference/indices/component-templates.asciidoc b/docs/reference/indices/component-templates.asciidoc index eebaddca6db..b12a4daf98c 100644 --- a/docs/reference/indices/component-templates.asciidoc +++ b/docs/reference/indices/component-templates.asciidoc @@ -98,7 +98,7 @@ GET /_component_template/template_1 [[get-component-template-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-template] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-template] + To return all component templates, omit this parameter or use a value of `*`. @@ -106,11 +106,11 @@ To return all component templates, omit this parameter or use a value of `*`. [[get-component-template-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] -include::{docdir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[get-component-template-api-example]] @@ -150,7 +150,7 @@ Name of the component template to create. If `true`, this request cannot replace or update existing component templates. Defaults to `false`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[put-component-template-api-request-body]] ==== {api-request-body-title} @@ -160,11 +160,11 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] This is the template to be applied, may optionally include a `mappings`, `settings`, or `aliases` configuration. -include::{docdir}/rest-api/common-parms.asciidoc[tag=aliases] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=aliases] -include::{docdir}/rest-api/common-parms.asciidoc[tag=mappings] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=mappings] -include::{docdir}/rest-api/common-parms.asciidoc[tag=settings] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=settings] `version`:: (Optional, integer) diff --git a/docs/reference/indices/create-index.asciidoc b/docs/reference/indices/create-index.asciidoc index 2b8c88f2061..f234c2fdc5f 100644 --- a/docs/reference/indices/create-index.asciidoc +++ b/docs/reference/indices/create-index.asciidoc @@ -52,11 +52,11 @@ Index names must meet the following criteria: [[indices-create-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=include-type-name] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-type-name] -include::{docdir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[indices-create-api-request-body]] @@ -66,9 +66,9 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] (Optional, <>) Index aliases which include the index. See <>. -include::{docdir}/rest-api/common-parms.asciidoc[tag=mappings] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=mappings] -include::{docdir}/rest-api/common-parms.asciidoc[tag=settings] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=settings] [[indices-create-api-example]] ==== {api-examples-title} diff --git a/docs/reference/indices/delete-alias.asciidoc b/docs/reference/indices/delete-alias.asciidoc index 3a3eed4b80a..923d28212db 100644 --- a/docs/reference/indices/delete-alias.asciidoc +++ b/docs/reference/indices/delete-alias.asciidoc @@ -6,7 +6,7 @@ Deletes an existing index alias. -include::{docdir}/glossary.asciidoc[tag=index-alias-desc] +include::{es-repo-dir}/glossary.asciidoc[tag=index-alias-desc] [source,console] ---- @@ -36,7 +36,7 @@ use a value of `_all` or `*`. ``:: (Required, string) -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-alias] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-alias] + To delete all aliases, use a value of `_all` or `*`. @@ -45,4 +45,4 @@ use a value of `_all` or `*`. [[delete-alias-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] diff --git a/docs/reference/indices/delete-index-template.asciidoc b/docs/reference/indices/delete-index-template.asciidoc index 5060496af5d..5c2da119780 100644 --- a/docs/reference/indices/delete-index-template.asciidoc +++ b/docs/reference/indices/delete-index-template.asciidoc @@ -43,10 +43,10 @@ include::templates.asciidoc[tag=index-template-def] [[delete-template-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-template] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-template] [[delete-template-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] diff --git a/docs/reference/indices/delete-index.asciidoc b/docs/reference/indices/delete-index.asciidoc index d3d6c243f07..377f87392e0 100644 --- a/docs/reference/indices/delete-index.asciidoc +++ b/docs/reference/indices/delete-index.asciidoc @@ -42,14 +42,14 @@ this setting in the `elasticsearch.yml` file or using the [[delete-index-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] diff --git a/docs/reference/indices/flush.asciidoc b/docs/reference/indices/flush.asciidoc index 066d3256e81..4916e70d758 100644 --- a/docs/reference/indices/flush.asciidoc +++ b/docs/reference/indices/flush.asciidoc @@ -53,7 +53,7 @@ flush API was called. [[flush-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] + To flush all indices, omit this parameter @@ -63,11 +63,11 @@ or use a value of `_all` or `*`. [[flush-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. @@ -87,7 +87,7 @@ This parameter is considered internal. -- -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] `wait_if_ongoing`:: + diff --git a/docs/reference/indices/forcemerge.asciidoc b/docs/reference/indices/forcemerge.asciidoc index f131daa087f..9bd8165b376 100644 --- a/docs/reference/indices/forcemerge.asciidoc +++ b/docs/reference/indices/forcemerge.asciidoc @@ -61,7 +61,7 @@ is set to `1`, as all segments need to be rewritten into a new one. [[forcemerge-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] + To force merge all indices in the cluster, omit this parameter @@ -71,11 +71,11 @@ or use a value of `_all` or `*`. [[forcemerge-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. @@ -86,7 +86,7 @@ If `true`, after the force merge. Defaults to `true`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] `max_num_segments`:: + diff --git a/docs/reference/indices/get-alias.asciidoc b/docs/reference/indices/get-alias.asciidoc index a57f34d7c73..ee58b652db2 100644 --- a/docs/reference/indices/get-alias.asciidoc +++ b/docs/reference/indices/get-alias.asciidoc @@ -6,7 +6,7 @@ Returns information about one or more index aliases. -include::{docdir}/glossary.asciidoc[tag=index-alias-desc] +include::{es-repo-dir}/glossary.asciidoc[tag=index-alias-desc] [source,console] ---- @@ -31,28 +31,28 @@ GET /twitter/_alias/alias1 ``:: (Optional, string) -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-alias] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-alias] + To retrieve information for all index aliases, use a value of `_all` or `*`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] [[get-alias-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `all`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{docdir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] [[get-alias-api-example]] diff --git a/docs/reference/indices/get-field-mapping.asciidoc b/docs/reference/indices/get-field-mapping.asciidoc index 5152537f44e..edd448bf509 100644 --- a/docs/reference/indices/get-field-mapping.asciidoc +++ b/docs/reference/indices/get-field-mapping.asciidoc @@ -26,7 +26,7 @@ GET /twitter/_mapping/field/user [[get-field-mapping-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] ``:: (Optional, string) Comma-separated list or wildcard expression of fields used to @@ -36,15 +36,15 @@ limit returned information. [[get-field-mapping-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] -include::{docdir}/rest-api/common-parms.asciidoc[tag=include-type-name] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-type-name] -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] `include_defaults`:: (Optional, boolean) If `true`, the response includes default mapping values. diff --git a/docs/reference/indices/get-index-template.asciidoc b/docs/reference/indices/get-index-template.asciidoc index 10d2f3d26ef..c113e3b8a63 100644 --- a/docs/reference/indices/get-index-template.asciidoc +++ b/docs/reference/indices/get-index-template.asciidoc @@ -42,7 +42,7 @@ GET /_template/template_1 [[get-template-v1-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-template] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-template] + To return all index templates, omit this parameter or use a value of `_all` or `*`. @@ -51,13 +51,13 @@ or use a value of `_all` or `*`. [[get-template-v1-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] -include::{docdir}/rest-api/common-parms.asciidoc[tag=include-type-name] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-type-name] -include::{docdir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[get-template-v1-api-example]] diff --git a/docs/reference/indices/get-index.asciidoc b/docs/reference/indices/get-index.asciidoc index f8e8859274c..6a402dd1e2f 100644 --- a/docs/reference/indices/get-index.asciidoc +++ b/docs/reference/indices/get-index.asciidoc @@ -39,22 +39,22 @@ Use a value of `_all` to retrieve information for all indices in the cluster. [[get-index-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] -include::{docdir}/rest-api/common-parms.asciidoc[tag=include-defaults] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-defaults] -include::{docdir}/rest-api/common-parms.asciidoc[tag=include-type-name] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-type-name] -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{docdir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] diff --git a/docs/reference/indices/get-mapping.asciidoc b/docs/reference/indices/get-mapping.asciidoc index 1d8036dd55a..4d9a3c6cd55 100644 --- a/docs/reference/indices/get-mapping.asciidoc +++ b/docs/reference/indices/get-mapping.asciidoc @@ -28,27 +28,27 @@ through the parameter `include_type_name`. For more details, please see <>, i.e. status code `200` is also returned if an alias exists with that name. @@ -31,21 +31,21 @@ i.e. status code `200` is also returned if an alias exists with that name. [[indices-exists-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] -include::{docdir}/rest-api/common-parms.asciidoc[tag=include-defaults] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-defaults] -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{docdir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] [[indices-exists-api-response-codes]] diff --git a/docs/reference/indices/open-close.asciidoc b/docs/reference/indices/open-close.asciidoc index d568cbad3c8..dbb88263c32 100644 --- a/docs/reference/indices/open-close.asciidoc +++ b/docs/reference/indices/open-close.asciidoc @@ -67,7 +67,7 @@ index creation applies to the `_open` and `_close` index actions as well. [[open-index-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] + To open all indices, use `_all` or `*`. To disallow the opening of indices with `_all` or wildcard expressions, @@ -79,19 +79,19 @@ or using the <> API. [[open-index-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `closed`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{docdir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[open-index-api-example]] diff --git a/docs/reference/indices/put-mapping.asciidoc b/docs/reference/indices/put-mapping.asciidoc index a3915b75174..fc540c46f28 100644 --- a/docs/reference/indices/put-mapping.asciidoc +++ b/docs/reference/indices/put-mapping.asciidoc @@ -37,7 +37,7 @@ please see <>. [[put-mapping-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] + To update the mapping of all indices, omit this parameter or use a value of `_all`. @@ -46,19 +46,19 @@ To update the mapping of all indices, omit this parameter or use a value of [[put-mapping-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `false`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=include-type-name] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-type-name] -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[put-mapping-api-request-body]] diff --git a/docs/reference/indices/recovery.asciidoc b/docs/reference/indices/recovery.asciidoc index 884f7d2fd31..a16cf6e6419 100644 --- a/docs/reference/indices/recovery.asciidoc +++ b/docs/reference/indices/recovery.asciidoc @@ -34,14 +34,14 @@ of syncing a replica shard from a primary shard. Upon completion, the replica shard is available for search. -include::{docdir}/glossary.asciidoc[tag=recovery-triggers] +include::{es-repo-dir}/glossary.asciidoc[tag=recovery-triggers] // end::shard-recovery-desc[] [[index-recovery-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] + Use a value of `_all` to retrieve information for all indices in the cluster. @@ -49,11 +49,11 @@ Use a value of `_all` to retrieve information for all indices in the cluster. [[index-recovery-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=active-only] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=active-only] -include::{docdir}/rest-api/common-parms.asciidoc[tag=detailed] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=detailed] -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-query-parm] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-query-parm] [[index-recovery-api-response-body]] diff --git a/docs/reference/indices/refresh.asciidoc b/docs/reference/indices/refresh.asciidoc index 108fb79f371..8d0c5655f44 100644 --- a/docs/reference/indices/refresh.asciidoc +++ b/docs/reference/indices/refresh.asciidoc @@ -61,7 +61,7 @@ before running the search. [[refresh-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] + To refresh all indices in the cluster, omit this parameter @@ -71,15 +71,15 @@ or use a value of `_all` or `*`. [[refresh-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] [[refresh-api-example]] diff --git a/docs/reference/indices/rollover-index.asciidoc b/docs/reference/indices/rollover-index.asciidoc index fd0dbf6b16b..dae76dd0424 100644 --- a/docs/reference/indices/rollover-index.asciidoc +++ b/docs/reference/indices/rollover-index.asciidoc @@ -85,7 +85,7 @@ to assign to the target index. (Optional*, string) Name of the target index to create and assign the index alias. -include::{docdir}/indices/create-index.asciidoc[tag=index-name-reqs] +include::{es-repo-dir}/indices/create-index.asciidoc[tag=index-name-reqs] *This parameter is not required if the alias is assigned to an index name that ends with `-` and a number, @@ -113,17 +113,17 @@ the request checks whether the index matches provided conditions but does not perform a rollover. Defaults to `false`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=include-type-name] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-type-name] -include::{docdir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[rollover-index-api-request-body]] ==== {api-request-body-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=aliases] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=aliases] `conditions`:: + @@ -153,9 +153,9 @@ TIP: To see the current index size, use the <> API. The `pri.store.size` value shows the combined size of all primary shards. -- -include::{docdir}/rest-api/common-parms.asciidoc[tag=mappings] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=mappings] -include::{docdir}/rest-api/common-parms.asciidoc[tag=settings] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=settings] [[rollover-index-api-example]] diff --git a/docs/reference/indices/segments.asciidoc b/docs/reference/indices/segments.asciidoc index 09bdbe4b401..a85ed5eadcc 100644 --- a/docs/reference/indices/segments.asciidoc +++ b/docs/reference/indices/segments.asciidoc @@ -25,21 +25,21 @@ GET /twitter/_segments [[index-segments-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] [[index-segments-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] `verbose`:: experimental:[] @@ -54,39 +54,39 @@ Defaults to `false`. ``:: (String) -include::{docdir}/rest-api/common-parms.asciidoc[tag=segment] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=segment] `generation`:: (Integer) -include::{docdir}/rest-api/common-parms.asciidoc[tag=generation] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=generation] `num_docs`:: (Integer) -include::{docdir}/rest-api/common-parms.asciidoc[tag=docs-count] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-count] `deleted_docs`:: (Integer) -include::{docdir}/rest-api/common-parms.asciidoc[tag=docs-deleted] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-deleted] `size_in_bytes`:: (Integer) -include::{docdir}/rest-api/common-parms.asciidoc[tag=segment-size] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=segment-size] `memory_in_bytes`:: (Integer) -include::{docdir}/rest-api/common-parms.asciidoc[tag=memory] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=memory] `committed`:: (Boolean) -include::{docdir}/rest-api/common-parms.asciidoc[tag=committed] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=committed] `search`:: (Boolean) -include::{docdir}/rest-api/common-parms.asciidoc[tag=segment-search] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=segment-search] `version`:: (String) -include::{docdir}/rest-api/common-parms.asciidoc[tag=segment-version] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=segment-version] `compound`:: (Boolean) diff --git a/docs/reference/indices/shard-stores.asciidoc b/docs/reference/indices/shard-stores.asciidoc index 996332532bb..e4b442944b6 100644 --- a/docs/reference/indices/shard-stores.asciidoc +++ b/docs/reference/indices/shard-stores.asciidoc @@ -45,7 +45,7 @@ or have one or more unassigned replica shards. [[index-shard-stores-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] + To retrieve information for all indices in the cluster, use a value of `_all` or `*` @@ -55,15 +55,15 @@ or omit this parameter. [[index-shard-stores-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] `status`:: + diff --git a/docs/reference/indices/shrink-index.asciidoc b/docs/reference/indices/shrink-index.asciidoc index 03c44cb6b39..58850aae0a8 100644 --- a/docs/reference/indices/shrink-index.asciidoc +++ b/docs/reference/indices/shrink-index.asciidoc @@ -198,19 +198,19 @@ on index creation applies to the shrink index action as well. (Required, string) Name of the source index to shrink. -include::{docdir}/rest-api/common-parms.asciidoc[tag=target-index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=target-index] [[shrink-index-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[shrink-index-api-request-body]] ==== {api-request-body-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=target-index-aliases] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=target-index-aliases] -include::{docdir}/rest-api/common-parms.asciidoc[tag=target-index-settings] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=target-index-settings] diff --git a/docs/reference/indices/split-index.asciidoc b/docs/reference/indices/split-index.asciidoc index d4c88c7fcf8..dc23f415d2a 100644 --- a/docs/reference/indices/split-index.asciidoc +++ b/docs/reference/indices/split-index.asciidoc @@ -233,20 +233,20 @@ on index creation applies to the split index action as well. (Required, string) Name of the source index to split. -include::{docdir}/rest-api/common-parms.asciidoc[tag=target-index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=target-index] [[split-index-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[split-index-api-request-body]] ==== {api-request-body-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=target-index-aliases] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=target-index-aliases] -include::{docdir}/rest-api/common-parms.asciidoc[tag=target-index-settings] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=target-index-settings] diff --git a/docs/reference/indices/stats.asciidoc b/docs/reference/indices/stats.asciidoc index 089704c9661..88adc86e46e 100644 --- a/docs/reference/indices/stats.asciidoc +++ b/docs/reference/indices/stats.asciidoc @@ -51,39 +51,39 @@ to which the shard contributed. [[index-stats-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] + To retrieve statistics for all indices, use a value of `_all` or `*` or omit this parameter. -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-metric] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-metric] [[index-stats-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=fields] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fields] -include::{docdir}/rest-api/common-parms.asciidoc[tag=completion-fields] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=completion-fields] -include::{docdir}/rest-api/common-parms.asciidoc[tag=fielddata-fields] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fielddata-fields] `forbid_closed_indices`:: (Optional, boolean) If `true`, statistics are *not* collected from closed indices. Defaults to `true`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=groups] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=groups] -include::{docdir}/rest-api/common-parms.asciidoc[tag=level] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=level] -include::{docdir}/rest-api/common-parms.asciidoc[tag=include-segment-file-sizes] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-segment-file-sizes] -include::{docdir}/rest-api/common-parms.asciidoc[tag=include-unloaded-segments] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-unloaded-segments] [[index-stats-api-example]] diff --git a/docs/reference/indices/synced-flush.asciidoc b/docs/reference/indices/synced-flush.asciidoc index c05c95d34ac..b83c127881e 100644 --- a/docs/reference/indices/synced-flush.asciidoc +++ b/docs/reference/indices/synced-flush.asciidoc @@ -131,7 +131,7 @@ should consider any indexing operation on an index as having removed its [[synced-flush-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] + To sync-flush all indices, omit this parameter @@ -141,13 +141,13 @@ or use a value of `_all` or `*`. [[synced-flush-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] [[synced-flush-api-response-codes]] diff --git a/docs/reference/indices/template-exists.asciidoc b/docs/reference/indices/template-exists.asciidoc index 43fa5131dad..5c9f13dae48 100644 --- a/docs/reference/indices/template-exists.asciidoc +++ b/docs/reference/indices/template-exists.asciidoc @@ -32,17 +32,17 @@ include::templates.asciidoc[tag=index-template-def] [[template-exists-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-template] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-template] [[template-exists-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] -include::{docdir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[template-exists-api-response-codes]] diff --git a/docs/reference/indices/templates.asciidoc b/docs/reference/indices/templates.asciidoc index a9bf173c821..0c4ed20d3b0 100644 --- a/docs/reference/indices/templates.asciidoc +++ b/docs/reference/indices/templates.asciidoc @@ -112,7 +112,7 @@ Templates with lower `order` values are merged first. Templates with higher `order` values are merged later, overriding templates with lower values. -include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[put-index-template-v1-api-request-body]] @@ -123,11 +123,11 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] Array of wildcard expressions used to match the names of indices during creation. -include::{docdir}/rest-api/common-parms.asciidoc[tag=aliases] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=aliases] -include::{docdir}/rest-api/common-parms.asciidoc[tag=mappings] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=mappings] -include::{docdir}/rest-api/common-parms.asciidoc[tag=settings] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=settings] `version`:: (Optional, integer) diff --git a/docs/reference/indices/types-exists.asciidoc b/docs/reference/indices/types-exists.asciidoc index 53626c31d94..31b48819d9d 100644 --- a/docs/reference/indices/types-exists.asciidoc +++ b/docs/reference/indices/types-exists.asciidoc @@ -25,9 +25,9 @@ HEAD twitter/_mapping/tweet [[indices-types-exists-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] -include::{docdir}/rest-api/common-parms.asciidoc[tag=type] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=type] [[indices-types-exists-api-response-codes]] diff --git a/docs/reference/indices/update-settings.asciidoc b/docs/reference/indices/update-settings.asciidoc index 0593cc14929..f8889d9ce37 100644 --- a/docs/reference/indices/update-settings.asciidoc +++ b/docs/reference/indices/update-settings.asciidoc @@ -27,7 +27,7 @@ PUT /twitter/_settings [[update-index-settings-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] + To update a setting for all indices, use `_all` or exclude this parameter. @@ -36,23 +36,23 @@ use `_all` or exclude this parameter. [[update-index-settings-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `false`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] `preserve_existing`:: (Optional, boolean) If `true`, existing index settings remain unchanged. Defaults to `false`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[update-index-settings-api-request-body]] diff --git a/docs/reference/ingest/apis/delete-pipeline.asciidoc b/docs/reference/ingest/apis/delete-pipeline.asciidoc index 67e551102f1..ce55c9b17ff 100644 --- a/docs/reference/ingest/apis/delete-pipeline.asciidoc +++ b/docs/reference/ingest/apis/delete-pipeline.asciidoc @@ -53,7 +53,7 @@ use a value of `*`. [[delete-pipeline-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[delete-pipeline-api-api-example]] diff --git a/docs/reference/ingest/apis/enrich/put-enrich-policy.asciidoc b/docs/reference/ingest/apis/enrich/put-enrich-policy.asciidoc index 0db8afd3e4f..b9842f46363 100644 --- a/docs/reference/ingest/apis/enrich/put-enrich-policy.asciidoc +++ b/docs/reference/ingest/apis/enrich/put-enrich-policy.asciidoc @@ -79,7 +79,7 @@ include::../../enrich.asciidoc[tag=update-enrich-policy] ``:: (Required, string) -include::{docdir}/rest-api/common-parms.asciidoc[tag=enrich-policy] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=enrich-policy] [[put-enrich-policy-api-request-body]] diff --git a/docs/reference/ingest/apis/get-pipeline.asciidoc b/docs/reference/ingest/apis/get-pipeline.asciidoc index b046b788668..8039d9648b8 100644 --- a/docs/reference/ingest/apis/get-pipeline.asciidoc +++ b/docs/reference/ingest/apis/get-pipeline.asciidoc @@ -45,14 +45,14 @@ GET /_ingest/pipeline/my-pipeline-id [[get-pipeline-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=path-pipeline] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=path-pipeline] [[get-pipeline-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[get-pipeline-api-api-example]] diff --git a/docs/reference/ingest/apis/put-pipeline.asciidoc b/docs/reference/ingest/apis/put-pipeline.asciidoc index 01f9c360fef..b6090ed194c 100644 --- a/docs/reference/ingest/apis/put-pipeline.asciidoc +++ b/docs/reference/ingest/apis/put-pipeline.asciidoc @@ -40,7 +40,7 @@ PUT _ingest/pipeline/my-pipeline-id [[put-pipeline-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[put-pipeline-api-response-body]] diff --git a/docs/reference/ingest/enrich.asciidoc b/docs/reference/ingest/enrich.asciidoc index e5e7c17a147..6e3f8cd5946 100644 --- a/docs/reference/ingest/enrich.asciidoc +++ b/docs/reference/ingest/enrich.asciidoc @@ -122,7 +122,7 @@ that doesn't change frequently. [[enrich-prereqs]] ==== Prerequisites -include::{docdir}/ingest/apis/enrich/put-enrich-policy.asciidoc[tag=enrich-policy-api-prereqs] +include::{es-repo-dir}/ingest/apis/enrich/put-enrich-policy.asciidoc[tag=enrich-policy-api-prereqs] [[create-enrich-source-index]] ==== Add enrich data @@ -209,7 +209,7 @@ documents first and verifying enrich data was added correctly using the [[update-enrich-data]] ==== Update an enrich index -include::{docdir}/ingest/apis/enrich/execute-enrich-policy.asciidoc[tag=update-enrich-index] +include::{es-repo-dir}/ingest/apis/enrich/execute-enrich-policy.asciidoc[tag=update-enrich-index] If wanted, you can <> or <> any already ingested documents diff --git a/docs/reference/ingest/processors/inference.asciidoc b/docs/reference/ingest/processors/inference.asciidoc index 7abaadfe499..f59955c5a57 100644 --- a/docs/reference/ingest/processors/inference.asciidoc +++ b/docs/reference/ingest/processors/inference.asciidoc @@ -42,11 +42,11 @@ Regression configuration for inference. `results_field`:: (Optional, string) -include::{docdir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] `num_top_feature_importance_values`:: (Optional, integer) -include::{docdir}/ml/ml-shared.asciidoc[tag=inference-config-regression-num-top-feature-importance-values] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-regression-num-top-feature-importance-values] [discrete] @@ -57,23 +57,23 @@ Classification configuration for inference. `num_top_classes`:: (Optional, integer) -include::{docdir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-classes] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-classes] `num_top_feature_importance_values`:: (Optional, integer) -include::{docdir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-feature-importance-values] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-num-top-feature-importance-values] `results_field`:: (Optional, string) -include::{docdir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-results-field] `top_classes_results_field`:: (Optional, string) -include::{docdir}/ml/ml-shared.asciidoc[tag=inference-config-classification-top-classes-results-field] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-top-classes-results-field] `prediction_field_type`:: (Optional, string) -include::{docdir}/ml/ml-shared.asciidoc[tag=inference-config-classification-prediction-field-type] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-classification-prediction-field-type] [discrete] [[inference-processor-config-example]] diff --git a/docs/reference/mapping.asciidoc b/docs/reference/mapping.asciidoc index 69182b0b9bd..7c7f34ae6cd 100644 --- a/docs/reference/mapping.asciidoc +++ b/docs/reference/mapping.asciidoc @@ -190,9 +190,9 @@ PUT /my-index/_mapping [[update-mapping]] === Update the mapping of a field -include::{docdir}/indices/put-mapping.asciidoc[tag=change-field-mapping] +include::{es-repo-dir}/indices/put-mapping.asciidoc[tag=change-field-mapping] -include::{docdir}/indices/put-mapping.asciidoc[tag=rename-field] +include::{es-repo-dir}/indices/put-mapping.asciidoc[tag=rename-field] [float] [[view-mapping]] diff --git a/docs/reference/mapping/types/nested.asciidoc b/docs/reference/mapping/types/nested.asciidoc index 9b22be57001..87e75b9aefc 100644 --- a/docs/reference/mapping/types/nested.asciidoc +++ b/docs/reference/mapping/types/nested.asciidoc @@ -222,11 +222,11 @@ then 101 Lucene documents would be created: one for the parent document, and one nested object. Because of the expense associated with `nested` mappings, Elasticsearch puts settings in place to guard against performance problems: -include::{docdir}/mapping.asciidoc[tag=nested-fields-limit] +include::{es-repo-dir}/mapping.asciidoc[tag=nested-fields-limit] In the previous example, the `user` mapping would count as only 1 towards this limit. -include::{docdir}/mapping.asciidoc[tag=nested-objects-limit] +include::{es-repo-dir}/mapping.asciidoc[tag=nested-objects-limit] To illustrate how this setting works, consider adding another `nested` type called `comments` to the previous example mapping. For each document, the combined number of `user` and `comment` diff --git a/docs/reference/ml/anomaly-detection/apis/get-bucket.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-bucket.asciidoc index e0311238ce4..d6b52c1ff16 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-bucket.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-bucket.asciidoc @@ -52,7 +52,7 @@ this value. `desc`:: (Optional, boolean) -include::{docdir}/ml/ml-shared.asciidoc[tag=desc-results] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=desc-results] `end`:: (Optional, string) Returns buckets with timestamps earlier than this time. @@ -101,7 +101,7 @@ influencer. This score might be updated as newer data is analyzed. `bucket_span`::: (number) -include::{docdir}/ml/ml-shared.asciidoc[tag=bucket-span-results] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-span-results] `initial_anomaly_score`::: (number) The score between 0-100 for each bucket influencer. This score is the diff --git a/docs/reference/ml/anomaly-detection/apis/get-overall-buckets.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-overall-buckets.asciidoc index d6ffac0bf36..243e7849c20 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-overall-buckets.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-overall-buckets.asciidoc @@ -76,7 +76,7 @@ time. `exclude_interim`:: (Optional, boolean) -include::{docdir}/ml/ml-shared.asciidoc[tag=exclude-interim-results] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-interim-results] + -- If any of the job bucket results within the overall bucket interval are interim diff --git a/docs/reference/ml/anomaly-detection/apis/get-record.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-record.asciidoc index 4374e2fed1e..402e32a5a5b 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-record.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-record.asciidoc @@ -110,7 +110,7 @@ scores are not applicable to causes. `detector_index`:: (number) -include::{docdir}/ml/ml-shared.asciidoc[tag=detector-index] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=detector-index] `field_name`:: (string) Certain functions require a field to operate on, for example, `sum()`. diff --git a/docs/reference/ml/anomaly-detection/apis/get-snapshot.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-snapshot.asciidoc index 0ade47018da..d8affb98ed9 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-snapshot.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-snapshot.asciidoc @@ -189,7 +189,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=retain] `snapshot_id`:: (string) -include::{docdir}/ml/ml-shared.asciidoc[tag=snapshot-id] +include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=snapshot-id] `snapshot_doc_count`:: (long) For internal use only. diff --git a/docs/reference/rest-api/common-parms.asciidoc b/docs/reference/rest-api/common-parms.asciidoc index e9d92bde8f0..dec4d97ff5e 100644 --- a/docs/reference/rest-api/common-parms.asciidoc +++ b/docs/reference/rest-api/common-parms.asciidoc @@ -968,7 +968,7 @@ tag::target-index[] (Required, string) Name of the target index to create. -include::{docdir}/indices/create-index.asciidoc[tag=index-name-reqs] +include::{es-repo-dir}/indices/create-index.asciidoc[tag=index-name-reqs] -- end::target-index[] diff --git a/docs/reference/rest-api/usage.asciidoc b/docs/reference/rest-api/usage.asciidoc index 2d9bfc096b3..dd7a01a79d0 100644 --- a/docs/reference/rest-api/usage.asciidoc +++ b/docs/reference/rest-api/usage.asciidoc @@ -22,7 +22,7 @@ available under the current license and some usage statistics. [[usage-api-query-parms]] === {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [discrete] [[usage-api-example]] diff --git a/docs/reference/search/count.asciidoc b/docs/reference/search/count.asciidoc index ee825de01b8..03faee06998 100644 --- a/docs/reference/search/count.asciidoc +++ b/docs/reference/search/count.asciidoc @@ -37,52 +37,52 @@ scalability of count. [[search-count-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] [[search-count-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=analyzer] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=analyzer] -include::{docdir}/rest-api/common-parms.asciidoc[tag=analyze_wildcard] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=analyze_wildcard] -include::{docdir}/rest-api/common-parms.asciidoc[tag=default_operator] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=default_operator] -include::{docdir}/rest-api/common-parms.asciidoc[tag=df] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=df] -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=ignore_throttled] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ignore_throttled] -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{docdir}/rest-api/common-parms.asciidoc[tag=lenient] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=lenient] `min_score`:: (Optional, float) Sets the minimum `_score` value that documents must have to be included in the result. -include::{docdir}/rest-api/common-parms.asciidoc[tag=preference] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference] -include::{docdir}/rest-api/common-parms.asciidoc[tag=search-q] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-q] -include::{docdir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] -include::{docdir}/rest-api/common-parms.asciidoc[tag=terminate_after] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=terminate_after] [[search-count-request-body]] ==== {api-request-body-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=query] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=query] [[search-count-api-example]] diff --git a/docs/reference/search/explain.asciidoc b/docs/reference/search/explain.asciidoc index 38df7639d52..aeb8b9ba430 100644 --- a/docs/reference/search/explain.asciidoc +++ b/docs/reference/search/explain.asciidoc @@ -49,37 +49,37 @@ Only a single index name can be provided to this parameter. [[sample-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=analyzer] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=analyzer] -include::{docdir}/rest-api/common-parms.asciidoc[tag=analyze_wildcard] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=analyze_wildcard] -include::{docdir}/rest-api/common-parms.asciidoc[tag=default_operator] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=default_operator] -include::{docdir}/rest-api/common-parms.asciidoc[tag=df] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=df] -include::{docdir}/rest-api/common-parms.asciidoc[tag=lenient] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=lenient] -include::{docdir}/rest-api/common-parms.asciidoc[tag=preference] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference] -include::{docdir}/rest-api/common-parms.asciidoc[tag=search-q] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-q] `stored_fields`:: (Optional, string) A comma-separated list of stored fields to return in the response. -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-routing] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-routing] -include::{docdir}/rest-api/common-parms.asciidoc[tag=source] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source] -include::{docdir}/rest-api/common-parms.asciidoc[tag=source_excludes] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_excludes] -include::{docdir}/rest-api/common-parms.asciidoc[tag=source_includes] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_includes] [[sample-api-request-body]] ==== {api-request-body-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=query] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=query] [[sample-api-example]] diff --git a/docs/reference/search/field-caps.asciidoc b/docs/reference/search/field-caps.asciidoc index a460b02fa7c..9458b66177e 100644 --- a/docs/reference/search/field-caps.asciidoc +++ b/docs/reference/search/field-caps.asciidoc @@ -32,25 +32,25 @@ fields among multiple indices. [[search-field-caps-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] [[search-field-caps-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + -- Defaults to `open`. -- -include::{docdir}/rest-api/common-parms.asciidoc[tag=fields] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fields] -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] `include_unmapped`:: (Optional, boolean) If `true`, unmapped fields are included in the response. diff --git a/docs/reference/search/multi-search.asciidoc b/docs/reference/search/multi-search.asciidoc index 9f95277ce48..97adbbea22d 100644 --- a/docs/reference/search/multi-search.asciidoc +++ b/docs/reference/search/multi-search.asciidoc @@ -50,14 +50,14 @@ this endpoint the `Content-Type` header should be set to `application/x-ndjson`. [[search-multi-search-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] + To search all indices, use `_all` or omit this parameter. [[search-multi-search-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] `ccs_minimize_roundtrips`:: (Optional, boolean) @@ -65,7 +65,7 @@ If `true`, network roundtrips between the coordinating node and remote clusters are minimized for {ccs} requests. Defaults to `true`. See <>. -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. @@ -74,7 +74,7 @@ Defaults to `open`. If `true`, concrete, expanded or aliased indices are ignored when frozen. Defaults to `false`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] `max_concurrent_searches`:: (Optional, integer) @@ -170,7 +170,7 @@ If `true`, the request does *not* return an error if a wildcard expression or This parameter also applies to <> that point to a missing or closed index. -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. diff --git a/docs/reference/search/rank-eval.asciidoc b/docs/reference/search/rank-eval.asciidoc index 70cabc6fc6b..025b8fdebbb 100644 --- a/docs/reference/search/rank-eval.asciidoc +++ b/docs/reference/search/rank-eval.asciidoc @@ -68,17 +68,17 @@ generation in your application. [[search-rank-eval-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + -- Defaults to `open`. -- -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] [[search-rank-eval-api-example]] diff --git a/docs/reference/search/request-body.asciidoc b/docs/reference/search/request-body.asciidoc index b901bb2c058..3cd15b5eeaa 100644 --- a/docs/reference/search/request-body.asciidoc +++ b/docs/reference/search/request-body.asciidoc @@ -34,7 +34,7 @@ The search request can be executed with a search DSL, which includes the [[search-request-body-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] [[search-request-body-api-request-body]] ==== {api-request-body-title} diff --git a/docs/reference/search/search-shards.asciidoc b/docs/reference/search/search-shards.asciidoc index 2c949cfe486..279a9155683 100644 --- a/docs/reference/search/search-shards.asciidoc +++ b/docs/reference/search/search-shards.asciidoc @@ -28,29 +28,29 @@ are used, the filter is returned as part of the `indices` section. [[search-shards-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] [[search-shards-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + -- Defaults to `open`. -- -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{docdir}/rest-api/common-parms.asciidoc[tag=local] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] -include::{docdir}/rest-api/common-parms.asciidoc[tag=preference] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference] -include::{docdir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] [[search-shards-api-example]] diff --git a/docs/reference/search/search-template.asciidoc b/docs/reference/search/search-template.asciidoc index 4e866f4ffe4..588ef1c5ee2 100644 --- a/docs/reference/search/search-template.asciidoc +++ b/docs/reference/search/search-template.asciidoc @@ -46,13 +46,13 @@ per type and context as described in the [[search-template-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] [[search-template-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. @@ -60,7 +60,7 @@ Defaults to `true`. (Optional, boolean) If `true`, network round-trips are minimized for cross-cluster search requests. Defaults to `true`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] `explain`:: (Optional, boolean) If `true`, the response includes additional details about @@ -70,9 +70,9 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] (Optional, boolean) If `true`, specified concrete, expanded or aliased indices are not included in the response when throttled. Defaults to `false`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{docdir}/rest-api/common-parms.asciidoc[tag=preference] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference] `profile`:: (Optional, boolean) If `true`, the query execution is profiled. Defaults @@ -82,11 +82,11 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=preference] (Optional, boolean) If `true`, `hits.total` are rendered as an integer in the response. Defaults to `false`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=routing] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] -include::{docdir}/rest-api/common-parms.asciidoc[tag=scroll] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=scroll] -include::{docdir}/rest-api/common-parms.asciidoc[tag=search_type] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search_type] `typed_keys`:: (Optional, boolean) If `true`, aggregation and suggester names are diff --git a/docs/reference/search/search.asciidoc b/docs/reference/search/search.asciidoc index 61dfcb17fae..277eede102b 100644 --- a/docs/reference/search/search.asciidoc +++ b/docs/reference/search/search.asciidoc @@ -33,12 +33,12 @@ query string parameter>> or <>. [[search-search-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] [[search-search-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. @@ -68,7 +68,7 @@ coordinating node and the remote clusters are minimized when executing (Optional, string) A comma-separated list of fields to return as the docvalue representation of a field for each hit. -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. @@ -84,7 +84,7 @@ both parameters are specified, only the query parameter is used. ==== -- -include::{docdir}/rest-api/common-parms.asciidoc[tag=from] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=from] + -- By default, you cannot page through more than 10,000 documents using the `from` @@ -112,7 +112,7 @@ both parameters are specified, only the query parameter is used. (Optional, boolean) If `true`, concrete, expanded or aliased indices will be ignored when frozen. Defaults to `false`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] `max_concurrent_shard_requests`:: (Optional, integer) Defines the number of concurrent shard requests per node @@ -137,7 +137,7 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] performed on. Random by default. [[search-api-query-params-q]] -include::{docdir}/rest-api/common-parms.asciidoc[tag=search-q] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-q] + -- You can use the `q` parameter to run a query parameter search. Query parameter @@ -165,7 +165,7 @@ level settings. (Optional, <>) Specifies how long a consistent view of the index should be maintained for scrolled search. -include::{docdir}/rest-api/common-parms.asciidoc[tag=search_type] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search_type] `seq_no_primary_term`:: + @@ -213,9 +213,9 @@ both parameters are specified, only the query parameter is used. If `true`, the response includes the `_source` of matching documents under `hits`. Defaults to `true`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=source_excludes] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_excludes] -include::{docdir}/rest-api/common-parms.asciidoc[tag=source_includes] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_includes] `stats`:: (Optional, string) Specific `tag` of the request for logging and statistical @@ -233,7 +233,7 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=source_includes] (Optional, string) The source text for which the suggestions should be returned. -include::{docdir}/rest-api/common-parms.asciidoc[tag=terminate_after] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=terminate_after] + -- Defaults to `0`, which does not terminate query execution early. @@ -304,7 +304,7 @@ both parameters are specified, only the query parameter is used. ==== -- -include::{docdir}/rest-api/common-parms.asciidoc[tag=from] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=from] + -- By default, you cannot page through more than 10,000 documents using the `from` @@ -372,7 +372,7 @@ parameters are specified, only the query parameter is used. ==== -- -include::{docdir}/rest-api/common-parms.asciidoc[tag=terminate_after] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=terminate_after] + -- Defaults to `0`, which does not terminate query execution early. diff --git a/docs/reference/search/validate.asciidoc b/docs/reference/search/validate.asciidoc index ed9738cef45..3e61f43b9b5 100644 --- a/docs/reference/search/validate.asciidoc +++ b/docs/reference/search/validate.asciidoc @@ -27,9 +27,9 @@ request body. [[search-validate-api-path-params]] ==== {api-path-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=index] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] -include::{docdir}/rest-api/common-parms.asciidoc[tag=query] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=query] [[search-validate-api-query-params]] @@ -39,33 +39,33 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=query] (Optional, boolean) If `true`, the validation is executed on all shards instead of one random shard per index. Defaults to `false`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `false`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=analyzer] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=analyzer] -include::{docdir}/rest-api/common-parms.asciidoc[tag=analyze_wildcard] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=analyze_wildcard] -include::{docdir}/rest-api/common-parms.asciidoc[tag=default_operator] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=default_operator] -include::{docdir}/rest-api/common-parms.asciidoc[tag=df] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=df] -include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] `explain`:: (Optional, boolean) If `true`, the response returns detailed information if an error has occurred. Defaults to `false`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{docdir}/rest-api/common-parms.asciidoc[tag=lenient] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=lenient] `rewrite`:: (Optional, boolean) If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed. Defaults to `false`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=search-q] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-q] [[search-validate-api-example]] diff --git a/docs/reference/searchable-snapshots/apis/mount-snapshot.asciidoc b/docs/reference/searchable-snapshots/apis/mount-snapshot.asciidoc index 04bd9d5ad80..1b061b28573 100644 --- a/docs/reference/searchable-snapshots/apis/mount-snapshot.asciidoc +++ b/docs/reference/searchable-snapshots/apis/mount-snapshot.asciidoc @@ -43,9 +43,9 @@ to mount. [[searchable-snapshots-api-mount-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] -include::{docdir}/rest-api/common-parms.asciidoc[tag=wait_for_completion] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_completion] [[searchable-snapshots-api-mount-request-body]] ==== {api-request-body-title} diff --git a/docs/reference/settings/common-defs.asciidoc b/docs/reference/settings/common-defs.asciidoc index a76b45df200..f434577c53a 100644 --- a/docs/reference/settings/common-defs.asciidoc +++ b/docs/reference/settings/common-defs.asciidoc @@ -10,7 +10,7 @@ List of paths to PEM encoded certificate files that should be trusted. end::ssl-certificate-authorities[] tag::ssl-cipher-suites-values[] -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-cipher-suites-values-java11] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-cipher-suites-values-java11] end::ssl-cipher-suites-values[] tag::ssl-cipher-suites-values-java11[] diff --git a/docs/reference/settings/security-settings.asciidoc b/docs/reference/settings/security-settings.asciidoc index 5365c4271eb..ca41aed33c2 100644 --- a/docs/reference/settings/security-settings.asciidoc +++ b/docs/reference/settings/security-settings.asciidoc @@ -459,72 +459,72 @@ An `s` at the end indicates seconds, or `ms` indicates milliseconds. Defaults to `5s` (5 seconds ). `ssl.key`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-key-pem] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-key-pem] + If the LDAP server requires client authentication, it uses this file. You cannot use this setting and `ssl.keystore.path` at the same time. `ssl.key_passphrase`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-key-passphrase] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-key-passphrase] `ssl.secure_key_passphrase` (<>):: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-secure-key-passphrase] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-secure-key-passphrase] `ssl.certificate`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-certificate] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-certificate] + This certificate is presented to clients when they connect. `ssl.certificate_authorities`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-certificate-authorities] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-certificate-authorities] + You cannot use this setting and `ssl.truststore.path` at the same time. `ssl.keystore.path`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] + You cannot use this setting and `ssl.key` at the same time. `ssl.keystore.type`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-type-pkcs12] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-type-pkcs12] `ssl.keystore.password`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] `ssl.keystore.secure_password` (<>):: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] `ssl.keystore.key_password`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] `ssl.keystore.secure_key_password`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] `ssl.truststore.path`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] + You cannot use this setting and `ssl.certificate_authorities` at the same time. `ssl.truststore.password`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] `ssl.truststore.secure_password` (<>):: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] `ssl.truststore.type`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-truststore-type-pkcs11] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-type-pkcs11] `ssl.verification_mode`:: Indicates the type of verification when using `ldaps` to protect against man in the middle attacks and certificate forgery. -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-verification-mode-values] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-verification-mode-values] `ssl.supported_protocols`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-supported-protocols] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-supported-protocols] `ssl.cipher_suites`:: Specifies the cipher suites that should be supported when communicating with the LDAP server. -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-cipher-suites-values] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-cipher-suites-values] `cache.ttl`:: Specifies the time-to-live for cached user entries. A user and a hash of its @@ -710,73 +710,73 @@ An `s` at the end indicates seconds, or `ms` indicates milliseconds. Defaults to `5s` (5 seconds ). `ssl.certificate`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-certificate] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-certificate] + This certificate is presented to clients when they connect. `ssl.certificate_authorities`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-certificate-authorities] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-certificate-authorities] + You cannot use this setting and `ssl.truststore.path` at the same time. `ssl.key`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-key-pem] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-key-pem] + If the Active Directory server requires client authentication, it uses this file. You cannot use this setting and `ssl.keystore.path` at the same time. `ssl.key_passphrase`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-key-passphrase] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-key-passphrase] `ssl.secure_key_passphrase` (<>):: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-secure-key-passphrase] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-secure-key-passphrase] `ssl.keystore.key_password`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] `ssl.keystore.secure_key_password` (<>):: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] `ssl.keystore.password`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] `ssl.secure_keystore.password` (<>):: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] //TBD: Why/how is this different than `ssl.keystore.secure_password`? `ssl.keystore.path`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] + You cannot use this setting and `ssl.key` at the same time. `ssl.keystore.type`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-type-pkcs12] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-type-pkcs12] `ssl.truststore.password`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] `ssl.truststore.secure_password` (<>):: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] `ssl.truststore.path`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] + You cannot use this setting and `ssl.certificate_authorities` at the same time. `ssl.truststore.type`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-truststore-type-pkcs11] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-type-pkcs11] `ssl.verification_mode`:: Indicates the type of verification when using `ldaps` to protect against man in the middle attacks and certificate forgery. -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-verification-mode-values] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-verification-mode-values] `ssl.supported_protocols`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-supported-protocols] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-supported-protocols] `ssl.cipher_suites`:: Specifies the cipher suites that should be supported when communicating with the Active Directory server. -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-cipher-suites-values] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-cipher-suites-values] `cache.ttl`:: Specifies the time-to-live for cached user entries. A user and a hash of its @@ -825,11 +825,11 @@ for SSL. This setting cannot be used with `truststore.path`. Algorithm for the truststore. Defaults to `SunX509`. `truststore.password`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] If `truststore.path` is set, this setting is required. `truststore.secure_password` (<>):: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] `truststore.path`:: The path of a truststore to use. Defaults to the trusted certificates configured @@ -1106,88 +1106,88 @@ NOTE: These settings are not used for any purpose other than loading metadata over https. `ssl.key`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-key-pem] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-key-pem] + If HTTP client authentication is required, it uses this file. You cannot use this setting and `ssl.keystore.path` at the same time. `ssl.key_passphrase`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-key-passphrase] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-key-passphrase] + You cannot use this setting and `ssl.secure_key_passphrase` at the same time. `ssl.secure_key_passphrase` (<>):: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-secure-key-passphrase] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-secure-key-passphrase] + You cannot use this setting and `ssl.key_passphrase` at the same time. `ssl.certificate`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-certificate] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-certificate] + This setting can be used only if `ssl.key` is set. `ssl.certificate_authorities`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-certificate-authorities] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-certificate-authorities] + This setting and `ssl.truststore.path` cannot be used at the same time. `ssl.keystore.path`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] + It must be either a Java keystore (jks) or a PKCS#12 file. You cannot use this setting and `ssl.key` at the same time. `ssl.keystore.type`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-type-pkcs12] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-type-pkcs12] `ssl.keystore.password`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] + You cannot use this setting and `ssl.keystore.secure_password` at the same time. `ssl.keystore.secure_password` (<>):: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] + You cannot use this setting and `ssl.keystore.password` at the same time. `ssl.keystore.key_password`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] + You cannot use this setting and `ssl.keystore.secure_key_password` at the same time. `ssl.keystore.secure_key_password` (<>):: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] You cannot use this setting and `ssl.keystore.key_password` at the same time. `ssl.truststore.path`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] + You cannot use this setting and `ssl.certificate_authorities` at the same time. `ssl.truststore.type`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-truststore-type] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-type] `ssl.truststore.password`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] + You cannot use this setting and `ssl.truststore.secure_password` at the same time. `ssl.truststore.secure_password` (<>):: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] + This setting cannot be used with `ssl.truststore.password`. `ssl.verification_mode`:: Controls the verification of certificates. -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-verification-mode-values] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-verification-mode-values] `ssl.supported_protocols`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-supported-protocols] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-supported-protocols] `ssl.cipher_suites`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-cipher-suites-values] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-cipher-suites-values] [float] [[ref-kerberos-settings]] @@ -1381,90 +1381,90 @@ NOTE: These settings are _only_ used for the back-channel communication between {es} and the OpenID Connect Provider `ssl.key`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-key-pem] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-key-pem] + If HTTP client authentication is required, it uses this file. You cannot use this setting and `ssl.keystore.path` at the same time. `ssl.key_passphrase`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-key-passphrase] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-key-passphrase] + You cannot use this setting and `ssl.secure_key_passphrase` at the same time. `ssl.secure_key_passphrase` (<>):: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-secure-key-passphrase] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-secure-key-passphrase] + You cannot use this setting and `ssl.key_passphrase` at the same time. `ssl.certificate`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-certificate] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-certificate] + This setting can be used only if `ssl.key` is set. `ssl.certificate_authorities`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-certificate-authorities] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-certificate-authorities] + This setting and `ssl.truststore.path` cannot be used at the same time. `ssl.keystore.path`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] + It must be either a Java keystore (jks) or a PKCS#12 file. You cannot use this setting and `ssl.key` at the same time. `ssl.keystore.type`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-type-pkcs12] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-type-pkcs12] `ssl.keystore.password`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] + You cannot use this setting and `ssl.keystore.secure_password` at the same time. `ssl.keystore.secure_password` (<>):: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] + You cannot use this setting and `ssl.keystore.password` at the same time. `ssl.keystore.key_password`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] + You cannot use this setting and `ssl.keystore.secure_key_password` at the same time. `ssl.keystore.secure_key_password` (<>):: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] + You cannot use this setting and `ssl.keystore.key_password` at the same time. `ssl.truststore.path`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] + You cannot use this setting and `ssl.certificate_authorities` at the same time. `ssl.truststore.type`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-truststore-type] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-type] `ssl.truststore.password`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] + You cannot use this setting and `ssl.truststore.secure_password` at the same time. `ssl.truststore.secure_password` (<>):: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] + You cannot use this setting and `ssl.truststore.password` at the same time. `ssl.verification_mode`:: Controls the verification of certificates. -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-verification-mode-values] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-verification-mode-values] `ssl.supported_protocols`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-supported-protocols] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-supported-protocols] `ssl.cipher_suites`:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-cipher-suites-values] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-cipher-suites-values] [float] [[load-balancing]] diff --git a/docs/reference/settings/ssl-settings.asciidoc b/docs/reference/settings/ssl-settings.asciidoc index 1e8a2c62877..9905e47a2ee 100644 --- a/docs/reference/settings/ssl-settings.asciidoc +++ b/docs/reference/settings/ssl-settings.asciidoc @@ -7,7 +7,7 @@ Used to enable or disable TLS/SSL. The default is `false`. endif::server[] +{ssl-prefix}.ssl.supported_protocols+:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-supported-protocols] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-supported-protocols] ifdef::server[] +{ssl-prefix}.ssl.client_authentication+:: @@ -26,11 +26,11 @@ endif::server[] ifdef::verifies[] +{ssl-prefix}.ssl.verification_mode+:: Controls the verification of certificates. -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-verification-mode-values] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-verification-mode-values] endif::verifies[] +{ssl-prefix}.ssl.cipher_suites+:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-cipher-suites-values] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-cipher-suites-values] [#{ssl-context}-tls-ssl-key-trusted-certificate-settings] ===== {component} TLS/SSL key and trusted certificate settings @@ -50,19 +50,19 @@ endif::server[] When using PEM encoded files, use the following settings: +{ssl-prefix}.ssl.key+:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-key-pem] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-key-pem] +{ssl-prefix}.ssl.key_passphrase+:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-key-passphrase] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-key-passphrase] +{ssl-prefix}.ssl.secure_key_passphrase+ (<>):: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-secure-key-passphrase] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-secure-key-passphrase] +{ssl-prefix}.ssl.certificate+:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-certificate] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-certificate] +{ssl-prefix}.ssl.certificate_authorities+:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-certificate-authorities] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-certificate-authorities] ===== Java keystore files @@ -70,28 +70,28 @@ When using Java keystore files (JKS), which contain the private key, certificate and certificates that should be trusted, use the following settings: +{ssl-prefix}.ssl.keystore.path+:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] +{ssl-prefix}.ssl.keystore.password+:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] +{ssl-prefix}.ssl.keystore.secure_password+ (<>):: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] +{ssl-prefix}.ssl.keystore.key_password+:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] +{ssl-prefix}.ssl.keystore.secure_key_password+ (<>):: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] +{ssl-prefix}.ssl.truststore.path+:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] +{ssl-prefix}.ssl.truststore.password+:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] +{ssl-prefix}.ssl.truststore.secure_password+ (<>):: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] [#{ssl-context}-pkcs12-files] ===== PKCS#12 files @@ -102,35 +102,35 @@ that contain the private key, certificate and certificates that should be truste PKCS#12 files are configured in the same way as Java keystore files: +{ssl-prefix}.ssl.keystore.path+:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-path] +{ssl-prefix}.ssl.keystore.type+:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-type-pkcs12] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-type-pkcs12] +{ssl-prefix}.ssl.keystore.password+:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-password] +{ssl-prefix}.ssl.keystore.secure_password+ (<>):: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-password] +{ssl-prefix}.ssl.keystore.key_password+:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-key-password] +{ssl-prefix}.ssl.keystore.secure_key_password+ (<>):: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-keystore-secure-key-password] +{ssl-prefix}.ssl.truststore.path+:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-path] +{ssl-prefix}.ssl.truststore.type+:: Set this to `PKCS12` to indicate that the truststore is a PKCS#12 file. //TBD:Should this use the ssl-truststore-type-pkcs11 or ssl-truststore-type definition and default values? +{ssl-prefix}.ssl.truststore.password+:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-password] +{ssl-prefix}.ssl.truststore.secure_password+ (<>):: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-secure-password] [#{ssl-context}-pkcs11-tokens] ===== PKCS#11 tokens @@ -146,7 +146,7 @@ Set this to `PKCS11` to indicate that the PKCS#11 token should be used as a keys //TBD: Is the default value `jks`? +{ssl-prefix}.truststore.type+:: -include::{docdir}/settings/common-defs.asciidoc[tag=ssl-truststore-type-pkcs11] +include::{es-repo-dir}/settings/common-defs.asciidoc[tag=ssl-truststore-type-pkcs11] [NOTE] When configuring the PKCS#11 token that your JVM is configured to use as diff --git a/docs/reference/setup/restart-cluster.asciidoc b/docs/reference/setup/restart-cluster.asciidoc index 58402758a72..bafbec62a14 100644 --- a/docs/reference/setup/restart-cluster.asciidoc +++ b/docs/reference/setup/restart-cluster.asciidoc @@ -17,7 +17,7 @@ time, so the service remains uninterrupted. . *Disable shard allocation.* + -- -include::{docdir}/upgrade/disable-shard-alloc.asciidoc[] +include::{es-repo-dir}/upgrade/disable-shard-alloc.asciidoc[] -- // end::disable_shard_alloc[] // tag::stop_indexing[] @@ -27,7 +27,7 @@ include::{docdir}/upgrade/disable-shard-alloc.asciidoc[] Performing a <> speeds up shard recovery. -include::{docdir}/upgrade/synced-flush.asciidoc[] +include::{es-repo-dir}/upgrade/synced-flush.asciidoc[] -- // end::stop_indexing[] //tag::stop_ml[] @@ -66,7 +66,7 @@ or jobs with large model states. . *Shut down all nodes.* + -- -include::{docdir}/upgrade/shut-down-node.asciidoc[] +include::{es-repo-dir}/upgrade/shut-down-node.asciidoc[] -- . *Perform any needed changes.* @@ -170,11 +170,11 @@ the datafeeds from {kib} or with the <> and === Rolling restart -include::{docdir}/setup/restart-cluster.asciidoc[tag=disable_shard_alloc] +include::{es-repo-dir}/setup/restart-cluster.asciidoc[tag=disable_shard_alloc] -include::{docdir}/setup/restart-cluster.asciidoc[tag=stop_indexing] +include::{es-repo-dir}/setup/restart-cluster.asciidoc[tag=stop_indexing] -include::{docdir}/setup/restart-cluster.asciidoc[tag=stop_ml] +include::{es-repo-dir}/setup/restart-cluster.asciidoc[tag=stop_ml] + -- * If you perform a rolling restart, you can also leave your machine learning @@ -187,7 +187,7 @@ cluster. . *Shut down a single node in case of rolling restart.* + -- -include::{docdir}/upgrade/shut-down-node.asciidoc[] +include::{es-repo-dir}/upgrade/shut-down-node.asciidoc[] -- . *Perform any needed changes.* @@ -231,4 +231,4 @@ When the node has recovered and the cluster is stable, repeat these steps for each node that needs to be changed. -- -include::{docdir}/setup/restart-cluster.asciidoc[tag=restart_ml] +include::{es-repo-dir}/setup/restart-cluster.asciidoc[tag=restart_ml] diff --git a/docs/reference/slm/apis/slm-get-status.asciidoc b/docs/reference/slm/apis/slm-get-status.asciidoc index bda8a77f050..6d8efcee3a8 100644 --- a/docs/reference/slm/apis/slm-get-status.asciidoc +++ b/docs/reference/slm/apis/slm-get-status.asciidoc @@ -24,7 +24,7 @@ You halt and restart the {slm-init} plugin with the ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[slm-api-get-status-prereqs]] ==== {api-prereq-title} diff --git a/docs/reference/slm/apis/slm-put.asciidoc b/docs/reference/slm/apis/slm-put.asciidoc index 675530364d1..b993a022eb3 100644 --- a/docs/reference/slm/apis/slm-put.asciidoc +++ b/docs/reference/slm/apis/slm-put.asciidoc @@ -41,7 +41,7 @@ you want to create or update. [[slm-api-put-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [role="child_attributes"] [[slm-api-put-request-body]] diff --git a/docs/reference/slm/apis/slm-start.asciidoc b/docs/reference/slm/apis/slm-start.asciidoc index db7be92b82b..0e651a111dd 100644 --- a/docs/reference/slm/apis/slm-start.asciidoc +++ b/docs/reference/slm/apis/slm-start.asciidoc @@ -29,7 +29,7 @@ Manually starting {slm-init} is only necessary if it has been stopped using the ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[slm-api-start-example]] ==== {api-examples-title} diff --git a/docs/reference/slm/apis/slm-stop.asciidoc b/docs/reference/slm/apis/slm-stop.asciidoc index dacbe61ac7a..056abf27b7d 100644 --- a/docs/reference/slm/apis/slm-stop.asciidoc +++ b/docs/reference/slm/apis/slm-stop.asciidoc @@ -36,7 +36,7 @@ Use the <> to see if {slm-init} is running. ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[slm-api-stop-example]] ==== {api-examples-title} diff --git a/docs/reference/snapshot-restore/apis/clean-up-repo-api.asciidoc b/docs/reference/snapshot-restore/apis/clean-up-repo-api.asciidoc index 4356403f65f..4c0184945fa 100644 --- a/docs/reference/snapshot-restore/apis/clean-up-repo-api.asciidoc +++ b/docs/reference/snapshot-restore/apis/clean-up-repo-api.asciidoc @@ -62,7 +62,7 @@ Name of the snapshot repository to review and clean up. [[clean-up-snapshot-repo-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [role="child_attributes"] [[clean-up-snapshot-repo-api-response-body]]