From a2b18e9ab956cd5548852107bce128434433c39b Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Thu, 29 Oct 2020 10:05:57 -0400 Subject: [PATCH] [DOCS] Fix case for 'Boolean' (#64299) (#64342) --- .../_token-filter-template.asciidoc | 2 +- .../asciifolding-tokenfilter.asciidoc | 2 +- .../cjk-bigram-tokenfilter.asciidoc | 2 +- .../common-grams-tokenfilter.asciidoc | 4 +- ...ctionary-decompounder-tokenfilter.asciidoc | 2 +- .../edgengram-tokenfilter.asciidoc | 2 +- .../tokenfilters/elision-tokenfilter.asciidoc | 2 +- .../hunspell-tokenfilter.asciidoc | 8 ++-- ...henation-decompounder-tokenfilter.asciidoc | 2 +- .../keep-words-tokenfilter.asciidoc | 2 +- .../keyword-marker-tokenfilter.asciidoc | 2 +- .../limit-token-count-tokenfilter.asciidoc | 2 +- .../tokenfilters/minhash-tokenfilter.asciidoc | 2 +- .../tokenfilters/ngram-tokenfilter.asciidoc | 2 +- .../pattern_replace-tokenfilter.asciidoc | 2 +- .../tokenfilters/shingle-tokenfilter.asciidoc | 2 +- .../tokenfilters/stop-tokenfilter.asciidoc | 4 +- .../tokenfilters/unique-tokenfilter.asciidoc | 2 +- .../word-delimiter-graph-tokenfilter.asciidoc | 22 ++++----- .../word-delimiter-tokenfilter.asciidoc | 18 +++---- docs/reference/cat/anomaly-detectors.asciidoc | 2 +- docs/reference/cat/datafeeds.asciidoc | 2 +- docs/reference/cat/health.asciidoc | 2 +- docs/reference/cat/indices.asciidoc | 2 +- docs/reference/cat/nodes.asciidoc | 2 +- docs/reference/cat/snapshots.asciidoc | 2 +- docs/reference/cat/transforms.asciidoc | 2 +- .../cluster/allocation-explain.asciidoc | 6 +-- docs/reference/cluster/get-settings.asciidoc | 2 +- docs/reference/cluster/health.asciidoc | 6 +-- .../cluster/nodes-hot-threads.asciidoc | 2 +- docs/reference/cluster/nodes-stats.asciidoc | 2 +- docs/reference/cluster/reroute.asciidoc | 6 +-- docs/reference/cluster/state.asciidoc | 4 +- docs/reference/cluster/stats.asciidoc | 6 +-- docs/reference/cluster/tasks.asciidoc | 2 +- .../cluster/update-settings.asciidoc | 2 +- .../cluster/voting-exclusions.asciidoc | 2 +- docs/reference/docs/bulk.asciidoc | 2 +- docs/reference/docs/get.asciidoc | 2 +- docs/reference/docs/multi-get.asciidoc | 2 +- docs/reference/docs/reindex.asciidoc | 2 +- docs/reference/eql/eql-search-api.asciidoc | 14 +++--- docs/reference/eql/functions.asciidoc | 2 +- .../reference/ilm/actions/ilm-delete.asciidoc | 2 +- .../ilm/actions/ilm-migrate.asciidoc | 2 +- .../actions/ilm-searchable-snapshot.asciidoc | 2 +- docs/reference/ilm/apis/explain.asciidoc | 4 +- docs/reference/indices/aliases.asciidoc | 6 +-- docs/reference/indices/analyze.asciidoc | 2 +- docs/reference/indices/clearcache.asciidoc | 6 +-- .../indices/component-templates.asciidoc | 2 +- .../indices/dangling-index-delete.asciidoc | 2 +- .../indices/dangling-index-import.asciidoc | 2 +- .../indices/data-stream-stats.asciidoc | 2 +- docs/reference/indices/flush.asciidoc | 4 +- docs/reference/indices/forcemerge.asciidoc | 4 +- docs/reference/indices/get-alias.asciidoc | 2 +- .../indices/get-field-mapping.asciidoc | 2 +- docs/reference/indices/get-index.asciidoc | 2 +- .../indices/put-component-template.asciidoc | 2 +- .../indices/put-index-template-v1.asciidoc | 2 +- .../indices/put-index-template.asciidoc | 2 +- docs/reference/indices/put-mapping.asciidoc | 2 +- .../reference/indices/rollover-index.asciidoc | 2 +- docs/reference/indices/segments.asciidoc | 2 +- .../indices/simulate-template.asciidoc | 2 +- docs/reference/indices/stats.asciidoc | 2 +- .../indices/update-settings.asciidoc | 2 +- .../enrich/execute-enrich-policy.asciidoc | 2 +- .../ingest/apis/simulate-pipeline.asciidoc | 2 +- docs/reference/licensing/get-license.asciidoc | 2 +- .../licensing/update-license.asciidoc | 2 +- docs/reference/mapping/types/nested.asciidoc | 4 +- .../anomaly-detection/apis/close-job.asciidoc | 4 +- .../apis/delete-datafeed.asciidoc | 2 +- .../apis/delete-forecast.asciidoc | 2 +- .../apis/delete-job.asciidoc | 2 +- .../apis/find-file-structure.asciidoc | 6 +-- .../anomaly-detection/apis/flush-job.asciidoc | 2 +- .../apis/get-bucket.asciidoc | 10 ++-- .../apis/get-datafeed-stats.asciidoc | 2 +- .../apis/get-datafeed.asciidoc | 2 +- .../apis/get-influencer.asciidoc | 6 +-- .../apis/get-job-stats.asciidoc | 4 +- .../anomaly-detection/apis/get-job.asciidoc | 2 +- .../apis/get-overall-buckets.asciidoc | 6 +-- .../apis/get-record.asciidoc | 6 +-- .../apis/get-snapshot.asciidoc | 4 +- .../anomaly-detection/apis/open-job.asciidoc | 2 +- .../anomaly-detection/apis/put-job.asciidoc | 14 +++--- .../apis/revert-snapshot.asciidoc | 2 +- .../apis/set-upgrade-mode.asciidoc | 2 +- .../apis/start-datafeed.asciidoc | 2 +- .../apis/stop-datafeed.asciidoc | 4 +- .../apis/update-job.asciidoc | 10 ++-- .../apis/update-snapshot.asciidoc | 2 +- .../apis/delete-dfanalytics.asciidoc | 2 +- .../apis/evaluate-dfanalytics.asciidoc | 2 +- .../apis/explain-dfanalytics.asciidoc | 4 +- .../apis/get-dfanalytics-stats.asciidoc | 8 ++-- .../apis/get-dfanalytics.asciidoc | 2 +- .../apis/get-trained-models-stats.asciidoc | 2 +- .../apis/get-trained-models.asciidoc | 6 +-- .../apis/put-dfanalytics.asciidoc | 6 +-- .../apis/put-trained-models.asciidoc | 2 +- .../apis/start-dfanalytics.asciidoc | 2 +- .../apis/stop-dfanalytics.asciidoc | 4 +- .../apis/update-dfanalytics.asciidoc | 2 +- docs/reference/ml/ml-shared.asciidoc | 4 +- docs/reference/query-dsl/fuzzy-query.asciidoc | 2 +- .../query-dsl/has-child-query.asciidoc | 2 +- .../query-dsl/has-parent-query.asciidoc | 4 +- .../query-dsl/intervals-query.asciidoc | 6 +-- docs/reference/query-dsl/match-query.asciidoc | 6 +-- .../reference/query-dsl/nested-query.asciidoc | 2 +- .../query-dsl/parent-id-query.asciidoc | 2 +- .../reference/query-dsl/prefix-query.asciidoc | 2 +- .../query-dsl/query-string-query.asciidoc | 12 ++--- .../reference/query-dsl/regexp-query.asciidoc | 2 +- .../simple-query-string-query.asciidoc | 8 ++-- docs/reference/query-dsl/term-query.asciidoc | 2 +- .../query-dsl/wildcard-query.asciidoc | 2 +- .../apis/repositories-meterings-body.asciidoc | 2 +- docs/reference/rest-api/common-parms.asciidoc | 48 +++++++++---------- docs/reference/rest-api/info.asciidoc | 2 +- docs/reference/rollup/apis/stop-job.asciidoc | 2 +- .../search/clear-scroll-api.asciidoc | 2 +- docs/reference/search/field-caps.asciidoc | 2 +- docs/reference/search/multi-search.asciidoc | 14 +++--- docs/reference/search/profile.asciidoc | 2 +- docs/reference/search/scroll-api.asciidoc | 2 +- .../reference/search/search-template.asciidoc | 12 ++--- docs/reference/search/search.asciidoc | 38 +++++++-------- docs/reference/search/validate.asciidoc | 6 +-- docs/reference/settings/ilm-settings.asciidoc | 8 ++-- docs/reference/settings/slm-settings.asciidoc | 2 +- docs/reference/slm/apis/slm-put.asciidoc | 4 +- .../apis/create-snapshot-api.asciidoc | 8 ++-- .../apis/get-repo-api.asciidoc | 2 +- .../apis/get-snapshot-api.asciidoc | 6 +-- .../apis/get-snapshot-status-api.asciidoc | 4 +- .../apis/put-repo-api.asciidoc | 8 ++-- .../apis/restore-snapshot-api.asciidoc | 10 ++-- .../transform/apis/delete-transform.asciidoc | 2 +- .../apis/get-transform-stats.asciidoc | 2 +- .../transform/apis/get-transform.asciidoc | 2 +- .../transform/apis/put-transform.asciidoc | 2 +- .../transform/apis/stop-transform.asciidoc | 8 ++-- .../transform/apis/update-transform.asciidoc | 2 +- .../security/create-role-mappings.asciidoc | 2 +- .../rest-api/security/create-users.asciidoc | 2 +- .../rest-api/security/get-api-keys.asciidoc | 2 +- .../rest-api/security/has-privileges.asciidoc | 2 +- .../security/invalidate-api-keys.asciidoc | 2 +- .../security/role-mapping-resources.asciidoc | 2 +- x-pack/docs/en/rest-api/security/ssl.asciidoc | 2 +- .../rest-api/watcher/execute-watch.asciidoc | 2 +- .../en/rest-api/watcher/put-watch.asciidoc | 2 +- .../docs/en/rest-api/watcher/stats.asciidoc | 2 +- .../en/rest-api/idp-saml-register-sp.asciidoc | 2 +- 161 files changed, 330 insertions(+), 330 deletions(-) diff --git a/docs/reference/analysis/tokenfilters/_token-filter-template.asciidoc b/docs/reference/analysis/tokenfilters/_token-filter-template.asciidoc index ea5b040a479..c2558d0b91b 100644 --- a/docs/reference/analysis/tokenfilters/_token-filter-template.asciidoc +++ b/docs/reference/analysis/tokenfilters/_token-filter-template.asciidoc @@ -180,7 +180,7 @@ Guidelines //// `foo`:: -(Optional, boolean) +(Optional, Boolean) If `true`, do a cool thing. Defaults to `false`. diff --git a/docs/reference/analysis/tokenfilters/asciifolding-tokenfilter.asciidoc b/docs/reference/analysis/tokenfilters/asciifolding-tokenfilter.asciidoc index 777acc4dd52..6b836f26dad 100644 --- a/docs/reference/analysis/tokenfilters/asciifolding-tokenfilter.asciidoc +++ b/docs/reference/analysis/tokenfilters/asciifolding-tokenfilter.asciidoc @@ -100,7 +100,7 @@ PUT /asciifold_example ==== Configurable parameters `preserve_original`:: -(Optional, boolean) +(Optional, Boolean) If `true`, emit both original tokens and folded tokens. Defaults to `false`. diff --git a/docs/reference/analysis/tokenfilters/cjk-bigram-tokenfilter.asciidoc b/docs/reference/analysis/tokenfilters/cjk-bigram-tokenfilter.asciidoc index 7affc2a79d6..4fd7164e82d 100644 --- a/docs/reference/analysis/tokenfilters/cjk-bigram-tokenfilter.asciidoc +++ b/docs/reference/analysis/tokenfilters/cjk-bigram-tokenfilter.asciidoc @@ -159,7 +159,7 @@ All non-CJK input is passed through unmodified. -- `output_unigrams` -(Optional, boolean) +(Optional, Boolean) If `true`, emit tokens in both bigram and {wikipedia}/N-gram[unigram] form. If `false`, a CJK character is output in unigram form when it has no adjacent characters. Defaults to diff --git a/docs/reference/analysis/tokenfilters/common-grams-tokenfilter.asciidoc b/docs/reference/analysis/tokenfilters/common-grams-tokenfilter.asciidoc index 474ebcf4382..4913df9290c 100644 --- a/docs/reference/analysis/tokenfilters/common-grams-tokenfilter.asciidoc +++ b/docs/reference/analysis/tokenfilters/common-grams-tokenfilter.asciidoc @@ -171,14 +171,14 @@ Either this or the `common_words` parameter is required. -- `ignore_case`:: -(Optional, boolean) +(Optional, Boolean) If `true`, matches for common words matching are case-insensitive. Defaults to `false`. `query_mode`:: + -- -(Optional, boolean) +(Optional, Boolean) If `true`, the filter excludes the following tokens from the output: * Unigrams for common words diff --git a/docs/reference/analysis/tokenfilters/dictionary-decompounder-tokenfilter.asciidoc b/docs/reference/analysis/tokenfilters/dictionary-decompounder-tokenfilter.asciidoc index 2c399b975aa..0e3c5804f26 100644 --- a/docs/reference/analysis/tokenfilters/dictionary-decompounder-tokenfilter.asciidoc +++ b/docs/reference/analysis/tokenfilters/dictionary-decompounder-tokenfilter.asciidoc @@ -130,7 +130,7 @@ Minimum word character length. Shorter word tokens are excluded from the output. Defaults to `5`. `only_longest_match`:: -(Optional, boolean) +(Optional, Boolean) If `true`, only include the longest matching subword. Defaults to `false`. [[analysis-dict-decomp-tokenfilter-customize]] diff --git a/docs/reference/analysis/tokenfilters/edgengram-tokenfilter.asciidoc b/docs/reference/analysis/tokenfilters/edgengram-tokenfilter.asciidoc index 845a471d44b..a3c4fa36ce1 100644 --- a/docs/reference/analysis/tokenfilters/edgengram-tokenfilter.asciidoc +++ b/docs/reference/analysis/tokenfilters/edgengram-tokenfilter.asciidoc @@ -174,7 +174,7 @@ See <>. Minimum character length of a gram. Defaults to `1`. `preserve_original`:: -(Optional, boolean) +(Optional, Boolean) Emits original token when set to `true`. Defaults to `false`. `side`:: diff --git a/docs/reference/analysis/tokenfilters/elision-tokenfilter.asciidoc b/docs/reference/analysis/tokenfilters/elision-tokenfilter.asciidoc index 6bdf2e728bf..3d6d629886c 100644 --- a/docs/reference/analysis/tokenfilters/elision-tokenfilter.asciidoc +++ b/docs/reference/analysis/tokenfilters/elision-tokenfilter.asciidoc @@ -146,7 +146,7 @@ specified. -- `articles_case`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the filter treats any provided elisions as case sensitive. Defaults to `false`. diff --git a/docs/reference/analysis/tokenfilters/hunspell-tokenfilter.asciidoc b/docs/reference/analysis/tokenfilters/hunspell-tokenfilter.asciidoc index 8b1d8baf755..068ee36877f 100644 --- a/docs/reference/analysis/tokenfilters/hunspell-tokenfilter.asciidoc +++ b/docs/reference/analysis/tokenfilters/hunspell-tokenfilter.asciidoc @@ -45,7 +45,7 @@ Each dictionary can be configured with one setting: [[analysis-hunspell-ignore-case-settings]] `ignore_case`:: -(Static, boolean) +(Static, Boolean) If true, dictionary matching will be case insensitive. Defaults to `false`. This setting can be configured globally in `elasticsearch.yml` using @@ -147,7 +147,7 @@ directory's path must be registered using the `indices.analysis.hunspell.dictionary.location`>> setting. `dedup`:: -(Optional, boolean) +(Optional, Boolean) If `true`, duplicate tokens are removed from the filter's output. Defaults to `true`. @@ -177,7 +177,7 @@ If this parameter is not specified, the `lang` or `language` parameter is required. `longest_only`:: -(Optional, boolean) +(Optional, Boolean) If `true`, only the longest stemmed version of each token is included in the output. If `false`, all stemmed versions of the token are included. Defaults to `false`. @@ -231,7 +231,7 @@ settings>>, you can configure the following global settings for the `hunspell` filter using `elasticsearch.yml`: `indices.analysis.hunspell.dictionary.lazy`:: -(Static, boolean) +(Static, Boolean) If `true`, the loading of Hunspell dictionaries is deferred until a dictionary is used. If `false`, the dictionary directory is checked for dictionaries when the node starts, and any dictionaries are automatically loaded. Defaults to diff --git a/docs/reference/analysis/tokenfilters/hyphenation-decompounder-tokenfilter.asciidoc b/docs/reference/analysis/tokenfilters/hyphenation-decompounder-tokenfilter.asciidoc index 72b3d5dcf62..eed66d81e91 100644 --- a/docs/reference/analysis/tokenfilters/hyphenation-decompounder-tokenfilter.asciidoc +++ b/docs/reference/analysis/tokenfilters/hyphenation-decompounder-tokenfilter.asciidoc @@ -108,7 +108,7 @@ Minimum word character length. Shorter word tokens are excluded from the output. Defaults to `5`. `only_longest_match`:: -(Optional, boolean) +(Optional, Boolean) If `true`, only include the longest matching subword. Defaults to `false`. [[analysis-hyp-decomp-tokenfilter-customize]] diff --git a/docs/reference/analysis/tokenfilters/keep-words-tokenfilter.asciidoc b/docs/reference/analysis/tokenfilters/keep-words-tokenfilter.asciidoc index d8346990a26..a0a9c08bf99 100644 --- a/docs/reference/analysis/tokenfilters/keep-words-tokenfilter.asciidoc +++ b/docs/reference/analysis/tokenfilters/keep-words-tokenfilter.asciidoc @@ -95,7 +95,7 @@ Either this parameter or `keep_words` must be specified. -- `keep_words_case`:: -(Optional, boolean) +(Optional, Boolean) If `true`, lowercase all keep words. Defaults to `false`. [[analysis-keep-words-tokenfilter-customize]] diff --git a/docs/reference/analysis/tokenfilters/keyword-marker-tokenfilter.asciidoc b/docs/reference/analysis/tokenfilters/keyword-marker-tokenfilter.asciidoc index df7cb09f85b..aab546326a9 100644 --- a/docs/reference/analysis/tokenfilters/keyword-marker-tokenfilter.asciidoc +++ b/docs/reference/analysis/tokenfilters/keyword-marker-tokenfilter.asciidoc @@ -303,7 +303,7 @@ The API returns the following response. Note the `jumping` token has a ==== Configurable parameters `ignore_case`:: -(Optional, boolean) +(Optional, Boolean) If `true`, matching for the `keywords` and `keywords_path` parameters ignores letter case. Defaults to `false`. diff --git a/docs/reference/analysis/tokenfilters/limit-token-count-tokenfilter.asciidoc b/docs/reference/analysis/tokenfilters/limit-token-count-tokenfilter.asciidoc index 5268571f7e9..e06cba7871b 100644 --- a/docs/reference/analysis/tokenfilters/limit-token-count-tokenfilter.asciidoc +++ b/docs/reference/analysis/tokenfilters/limit-token-count-tokenfilter.asciidoc @@ -29,7 +29,7 @@ Maximum number of tokens to keep. Once this limit is reached, any remaining tokens are excluded from the output. Defaults to `1`. `consume_all_tokens`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the `limit` filter exhausts the token stream, even if the `max_token_count` has already been reached. Defaults to `false`. diff --git a/docs/reference/analysis/tokenfilters/minhash-tokenfilter.asciidoc b/docs/reference/analysis/tokenfilters/minhash-tokenfilter.asciidoc index 7cc7e2e41c4..bfbf59908ea 100644 --- a/docs/reference/analysis/tokenfilters/minhash-tokenfilter.asciidoc +++ b/docs/reference/analysis/tokenfilters/minhash-tokenfilter.asciidoc @@ -38,7 +38,7 @@ Hashes are retained by ascending size, starting with the bucket's smallest hash first. `with_rotation`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the filter fills empty buckets with the value of the first non-empty bucket to its circular right if the `hash_set_size` is `1`. If the `bucket_count` argument is greater than `1`, this parameter defaults to `true`. diff --git a/docs/reference/analysis/tokenfilters/ngram-tokenfilter.asciidoc b/docs/reference/analysis/tokenfilters/ngram-tokenfilter.asciidoc index 1f30c6d6254..fc6aea3d069 100644 --- a/docs/reference/analysis/tokenfilters/ngram-tokenfilter.asciidoc +++ b/docs/reference/analysis/tokenfilters/ngram-tokenfilter.asciidoc @@ -186,7 +186,7 @@ Maximum length of characters in a gram. Defaults to `2`. Minimum length of characters in a gram. Defaults to `1`. `preserve_original`:: -(Optional, boolean) +(Optional, Boolean) Emits original token when set to `true`. Defaults to `false`. You can use the <> index-level diff --git a/docs/reference/analysis/tokenfilters/pattern_replace-tokenfilter.asciidoc b/docs/reference/analysis/tokenfilters/pattern_replace-tokenfilter.asciidoc index d366ee74c2a..b28fde47d58 100644 --- a/docs/reference/analysis/tokenfilters/pattern_replace-tokenfilter.asciidoc +++ b/docs/reference/analysis/tokenfilters/pattern_replace-tokenfilter.asciidoc @@ -99,7 +99,7 @@ The filter produces the following tokens. ==== Configurable parameters `all`:: -(Optional, boolean) +(Optional, Boolean) If `true`, all substrings matching the `pattern` parameter's regular expression are replaced. If `false`, the filter replaces only the first matching substring in each token. Defaults to `true`. diff --git a/docs/reference/analysis/tokenfilters/shingle-tokenfilter.asciidoc b/docs/reference/analysis/tokenfilters/shingle-tokenfilter.asciidoc index cb7cf92221a..0598fb32971 100644 --- a/docs/reference/analysis/tokenfilters/shingle-tokenfilter.asciidoc +++ b/docs/reference/analysis/tokenfilters/shingle-tokenfilter.asciidoc @@ -333,7 +333,7 @@ cannot exceed the <> index-level setting, which defaults to `3`. `output_unigrams`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the output includes the original input tokens. If `false`, the output only includes shingles; the original input tokens are removed. Defaults to `true`. diff --git a/docs/reference/analysis/tokenfilters/stop-tokenfilter.asciidoc b/docs/reference/analysis/tokenfilters/stop-tokenfilter.asciidoc index c9e92de3eff..e3eef08efc9 100644 --- a/docs/reference/analysis/tokenfilters/stop-tokenfilter.asciidoc +++ b/docs/reference/analysis/tokenfilters/stop-tokenfilter.asciidoc @@ -150,7 +150,7 @@ break. -- `ignore_case`:: -(Optional, boolean) +(Optional, Boolean) If `true`, stop word matching is case insensitive. For example, if `true`, a stop word of `the` matches and removes `The`, `THE`, or `the`. Defaults to `false`. @@ -158,7 +158,7 @@ stop word of `the` matches and removes `The`, `THE`, or `the`. Defaults to `remove_trailing`:: + -- -(Optional, boolean) +(Optional, Boolean) If `true`, the last token of a stream is removed if it's a stop word. Defaults to `true`. diff --git a/docs/reference/analysis/tokenfilters/unique-tokenfilter.asciidoc b/docs/reference/analysis/tokenfilters/unique-tokenfilter.asciidoc index ca6b1d5115e..5afed11923a 100644 --- a/docs/reference/analysis/tokenfilters/unique-tokenfilter.asciidoc +++ b/docs/reference/analysis/tokenfilters/unique-tokenfilter.asciidoc @@ -112,7 +112,7 @@ PUT custom_unique_example ==== Configurable parameters `only_on_same_position`:: -(Optional, boolean) +(Optional, Boolean) If `true`, only remove duplicate tokens in the same position. Defaults to `false`. diff --git a/docs/reference/analysis/tokenfilters/word-delimiter-graph-tokenfilter.asciidoc b/docs/reference/analysis/tokenfilters/word-delimiter-graph-tokenfilter.asciidoc index 59a8b4d0b29..2999df6a9a1 100644 --- a/docs/reference/analysis/tokenfilters/word-delimiter-graph-tokenfilter.asciidoc +++ b/docs/reference/analysis/tokenfilters/word-delimiter-graph-tokenfilter.asciidoc @@ -169,7 +169,7 @@ recommend using the <> or `adjust_offsets`:: + -- -(Optional, boolean) +(Optional, Boolean) If `true`, the filter adjusts the offsets of split or catenated tokens to better reflect their actual position in the token stream. Defaults to `true`. @@ -186,7 +186,7 @@ could produce tokens with illegal offsets. `catenate_all`:: + -- -(Optional, boolean) +(Optional, Boolean) If `true`, the filter produces catenated tokens for chains of alphanumeric characters separated by non-alphabetic delimiters. For example: `super-duper-xl-500` -> [ **`superduperxl500`**, `super`, `duper`, `xl`, `500` ]. @@ -212,7 +212,7 @@ you plan to use these queries. `catenate_numbers`:: + -- -(Optional, boolean) +(Optional, Boolean) If `true`, the filter produces catenated tokens for chains of numeric characters separated by non-alphabetic delimiters. For example: `01-02-03` -> [ **`010203`**, `01`, `02`, `03` ]. Defaults to `false`. @@ -237,7 +237,7 @@ you plan to use these queries. `catenate_words`:: + -- -(Optional, boolean) +(Optional, Boolean) If `true`, the filter produces catenated tokens for chains of alphabetical characters separated by non-alphabetic delimiters. For example: `super-duper-xl` -> [ **`superduperxl`**, `super`, `duper`, `xl` ]. Defaults to `false`. @@ -259,19 +259,19 @@ you plan to use these queries. -- `generate_number_parts`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the filter includes tokens consisting of only numeric characters in the output. If `false`, the filter excludes these tokens from the output. Defaults to `true`. `generate_word_parts`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the filter includes tokens consisting of only alphabetical characters in the output. If `false`, the filter excludes these tokens from the output. Defaults to `true`. `ignore_keywords`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the filter skips tokens with a `keyword` attribute of `true`. Defaults to `false`. @@ -280,7 +280,7 @@ Defaults to `false`. `preserve_original`:: + -- -(Optional, boolean) +(Optional, Boolean) If `true`, the filter includes the original version of any split tokens in the output. This original version includes non-alphanumeric delimiters. For example: `super-duper-xl-500` -> [ **`super-duper-xl-500`**, `super`, `duper`, `xl`, @@ -313,17 +313,17 @@ break. -- `split_on_case_change`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the filter splits tokens at letter case transitions. For example: `camelCase` -> [ `camel`, `Case` ]. Defaults to `true`. `split_on_numerics`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the filter splits tokens at letter-number transitions. For example: `j2se` -> [ `j`, `2`, `se` ]. Defaults to `true`. `stem_english_possessive`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the filter removes the English possessive (`'s`) from the end of each token. For example: `O'Neil's` -> [ `O`, `Neil` ]. Defaults to `true`. diff --git a/docs/reference/analysis/tokenfilters/word-delimiter-tokenfilter.asciidoc b/docs/reference/analysis/tokenfilters/word-delimiter-tokenfilter.asciidoc index 5010254d8d9..c65dade6272 100644 --- a/docs/reference/analysis/tokenfilters/word-delimiter-tokenfilter.asciidoc +++ b/docs/reference/analysis/tokenfilters/word-delimiter-tokenfilter.asciidoc @@ -178,7 +178,7 @@ interfere with the filter's configurable parameters, such as `catenate_all` or `catenate_all`:: + -- -(Optional, boolean) +(Optional, Boolean) If `true`, the filter produces catenated tokens for chains of alphanumeric characters separated by non-alphabetic delimiters. For example: `super-duper-xl-500` -> [ `super`, **`superduperxl500`**, `duper`, `xl`, `500` @@ -196,7 +196,7 @@ you plan to use these queries. `catenate_numbers`:: + -- -(Optional, boolean) +(Optional, Boolean) If `true`, the filter produces catenated tokens for chains of numeric characters separated by non-alphabetic delimiters. For example: `01-02-03` -> [ `01`, **`010203`**, `02`, `03` ]. Defaults to `false`. @@ -213,7 +213,7 @@ you plan to use these queries. `catenate_words`:: + -- -(Optional, boolean) +(Optional, Boolean) If `true`, the filter produces catenated tokens for chains of alphabetical characters separated by non-alphabetic delimiters. For example: `super-duper-xl` -> [ `super`, **`superduperxl`**, `duper`, `xl` ]. Defaults to `false`. @@ -228,19 +228,19 @@ you plan to use these queries. -- `generate_number_parts`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the filter includes tokens consisting of only numeric characters in the output. If `false`, the filter excludes these tokens from the output. Defaults to `true`. `generate_word_parts`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the filter includes tokens consisting of only alphabetical characters in the output. If `false`, the filter excludes these tokens from the output. Defaults to `true`. `preserve_original`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the filter includes the original version of any split tokens in the output. This original version includes non-alphanumeric delimiters. For example: `super-duper-xl-500` -> [ **`super-duper-xl-500`**, `super`, `duper`, `xl`, @@ -262,17 +262,17 @@ break. -- `split_on_case_change`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the filter splits tokens at letter case transitions. For example: `camelCase` -> [ `camel`, `Case` ]. Defaults to `true`. `split_on_numerics`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the filter splits tokens at letter-number transitions. For example: `j2se` -> [ `j`, `2`, `se` ]. Defaults to `true`. `stem_english_possessive`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the filter removes the English possessive (`'s`) from the end of each token. For example: `O'Neil's` -> [ `O`, `Neil` ]. Defaults to `true`. diff --git a/docs/reference/cat/anomaly-detectors.asciidoc b/docs/reference/cat/anomaly-detectors.asciidoc index a819f1562ac..5fdfa1583df 100644 --- a/docs/reference/cat/anomaly-detectors.asciidoc +++ b/docs/reference/cat/anomaly-detectors.asciidoc @@ -41,7 +41,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] ==== {api-query-parms-title} `allow_no_match`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-jobs] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes] diff --git a/docs/reference/cat/datafeeds.asciidoc b/docs/reference/cat/datafeeds.asciidoc index a28dddbcba1..6802d2e70e3 100644 --- a/docs/reference/cat/datafeeds.asciidoc +++ b/docs/reference/cat/datafeeds.asciidoc @@ -42,7 +42,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id] ==== {api-query-parms-title} `allow_no_match`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-datafeeds] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] diff --git a/docs/reference/cat/health.asciidoc b/docs/reference/cat/health.asciidoc index 1182aa91a83..f16ffb802aa 100644 --- a/docs/reference/cat/health.asciidoc +++ b/docs/reference/cat/health.asciidoc @@ -50,7 +50,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time] `ts` (timestamps):: -(Optional, boolean) If `true`, returns `HH:MM:SS` and +(Optional, Boolean) If `true`, returns `HH:MM:SS` and {wikipedia}/Unix_time[Unix `epoch`] timestamps. Defaults to `true`. diff --git a/docs/reference/cat/indices.asciidoc b/docs/reference/cat/indices.asciidoc index 5515b236183..cd1d4a04d9f 100644 --- a/docs/reference/cat/indices.asciidoc +++ b/docs/reference/cat/indices.asciidoc @@ -80,7 +80,7 @@ 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 +(Optional, Boolean) If `true`, the response only includes information from primary shards. Defaults to `false`. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s] diff --git a/docs/reference/cat/nodes.asciidoc b/docs/reference/cat/nodes.asciidoc index 684dee05021..f1706d0fea1 100644 --- a/docs/reference/cat/nodes.asciidoc +++ b/docs/reference/cat/nodes.asciidoc @@ -19,7 +19,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes] 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 +(Optional, Boolean) If `true`, return the full node ID. If `false`, return the shortened node ID. Defaults to `false`. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h] diff --git a/docs/reference/cat/snapshots.asciidoc b/docs/reference/cat/snapshots.asciidoc index 72512c8efa8..a628ba54cd6 100644 --- a/docs/reference/cat/snapshots.asciidoc +++ b/docs/reference/cat/snapshots.asciidoc @@ -93,7 +93,7 @@ Reason for any snapshot failures. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help] `ignore_unavailable`:: -(Optional, boolean) If `true`, the response does not include information from +(Optional, Boolean) If `true`, the response does not include information from unavailable snapshots. Defaults to `false`. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] diff --git a/docs/reference/cat/transforms.asciidoc b/docs/reference/cat/transforms.asciidoc index 83002b6138c..e8f131f5a1c 100644 --- a/docs/reference/cat/transforms.asciidoc +++ b/docs/reference/cat/transforms.asciidoc @@ -39,7 +39,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id-wildcard] ==== {api-query-parms-title} `allow_no_match`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-match-transforms1] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] diff --git a/docs/reference/cluster/allocation-explain.asciidoc b/docs/reference/cluster/allocation-explain.asciidoc index fef2fdfe681..24b74af493c 100644 --- a/docs/reference/cluster/allocation-explain.asciidoc +++ b/docs/reference/cluster/allocation-explain.asciidoc @@ -30,11 +30,11 @@ you might expect otherwise. ==== {api-query-parms-title} `include_disk_info`:: - (Optional, boolean) If `true`, returns information about disk usage and + (Optional, Boolean) If `true`, returns information about disk usage and shard sizes. Defaults to `false`. `include_yes_decisions`:: - (Optional, boolean) If `true`, returns 'YES' decisions in explanation. + (Optional, Boolean) If `true`, returns 'YES' decisions in explanation. Defaults to `false`. @@ -50,7 +50,7 @@ you might expect otherwise. explanation for. `primary`:: - (Optional, boolean) If `true`, returns explanation for the primary shard + (Optional, Boolean) If `true`, returns explanation for the primary shard for the given shard ID. `shard`:: diff --git a/docs/reference/cluster/get-settings.asciidoc b/docs/reference/cluster/get-settings.asciidoc index 01be2af5c37..0a286602ef5 100644 --- a/docs/reference/cluster/get-settings.asciidoc +++ b/docs/reference/cluster/get-settings.asciidoc @@ -23,7 +23,7 @@ defined, but can also include the default settings by calling the include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] `include_defaults`:: - (Optional, boolean) If `true`, returns all default cluster settings. + (Optional, Boolean) If `true`, returns all default cluster settings. Defaults to `false`. 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 869a72e7f49..5c4be3df744 100644 --- a/docs/reference/cluster/health.asciidoc +++ b/docs/reference/cluster/health.asciidoc @@ -70,12 +70,12 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] priority are processed. `wait_for_no_initializing_shards`:: - (Optional, boolean) A boolean value which controls whether to wait (until + (Optional, Boolean) A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards. `wait_for_no_relocating_shards`:: - (Optional, boolean) A boolean value which controls whether to wait (until + (Optional, Boolean) A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards. @@ -101,7 +101,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] 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 + (Boolean) If `false` the response returned within the period of time that is specified by the `timeout` parameter (`30s` by default). `number_of_nodes`:: diff --git a/docs/reference/cluster/nodes-hot-threads.asciidoc b/docs/reference/cluster/nodes-hot-threads.asciidoc index b3fb77d1695..1a5d8e894d6 100644 --- a/docs/reference/cluster/nodes-hot-threads.asciidoc +++ b/docs/reference/cluster/nodes-hot-threads.asciidoc @@ -34,7 +34,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id] `ignore_idle_threads`:: - (Optional, boolean) If true, known idle threads (e.g. waiting in a socket + (Optional, Boolean) If true, known idle threads (e.g. waiting in a socket select, or to get a task from an empty queue) are filtered out. Defaults to true. diff --git a/docs/reference/cluster/nodes-stats.asciidoc b/docs/reference/cluster/nodes-stats.asciidoc index 5b53fc61169..0ae6295bee3 100644 --- a/docs/reference/cluster/nodes-stats.asciidoc +++ b/docs/reference/cluster/nodes-stats.asciidoc @@ -312,7 +312,7 @@ Number of deletion operations currently running. Total number of noop operations. `is_throttled`:: -(boolean) +(Boolean) Number of times operations were throttled. diff --git a/docs/reference/cluster/reroute.asciidoc b/docs/reference/cluster/reroute.asciidoc index 1a64e6e0920..d97ee128aa4 100644 --- a/docs/reference/cluster/reroute.asciidoc +++ b/docs/reference/cluster/reroute.asciidoc @@ -58,11 +58,11 @@ query parameter, which will attempt a single retry round for these shards. ==== {api-query-parms-title} `dry_run`:: - (Optional, boolean) If `true`, then the request simulates the operation only + (Optional, Boolean) If `true`, then the request simulates the operation only and returns the resulting state. `explain`:: - (Optional, boolean) If `true`, then the response contains an explanation of + (Optional, Boolean) If `true`, then the response contains an explanation of why the commands can or cannot be executed. `metric`:: @@ -99,7 +99,7 @@ query parameter, which will attempt a single retry round for these shards. `retry_failed`:: - (Optional, boolean) If `true`, then retries allocation of shards that are + (Optional, Boolean) If `true`, then retries allocation of shards that are blocked due to too many subsequent allocation failures. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] diff --git a/docs/reference/cluster/state.asciidoc b/docs/reference/cluster/state.asciidoc index d4fcfffefbd..8847b54e71b 100644 --- a/docs/reference/cluster/state.asciidoc +++ b/docs/reference/cluster/state.asciidoc @@ -99,7 +99,7 @@ To target all data streams and indices in a cluster, omit this parameter or use ==== {api-query-parms-title} `allow_no_indices`:: - (Optional, boolean) If `true`, the wildcard indices expression that resolves + (Optional, Boolean) If `true`, the wildcard indices expression that resolves into no concrete indices will be ignored. (This includes `_all` string or when no indices have been specified). + @@ -113,7 +113,7 @@ Defaults to `true`. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] `ignore_unavailable`:: - (Optional, boolean) If `true`, unavailable indices (missing or closed) will + (Optional, Boolean) If `true`, unavailable indices (missing or closed) will be ignored. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local] diff --git a/docs/reference/cluster/stats.asciidoc b/docs/reference/cluster/stats.asciidoc index 17043fe5791..b5affc837a7 100644 --- a/docs/reference/cluster/stats.asciidoc +++ b/docs/reference/cluster/stats.asciidoc @@ -885,11 +885,11 @@ The full version number includes a plus sign (`+`) followed by the build number. Vendor of the JVM. `bundled_jdk`:: -(boolean) +(Boolean) If `true`, the JVM includes a bundled Java Development Kit (JDK). `using_bundled_jdk`:: -(boolean) +(Boolean) If `true`, a bundled JDK is in use by JVM. `count`:: @@ -1019,7 +1019,7 @@ Provider Interface (SPI). If this plugin extends no other plugins, this array is empty. `has_native_controller`::: -(boolean) +(Boolean) If `true`, the plugin has a native controller process. ====== ===== diff --git a/docs/reference/cluster/tasks.asciidoc b/docs/reference/cluster/tasks.asciidoc index e028d4d7102..88145cdf459 100644 --- a/docs/reference/cluster/tasks.asciidoc +++ b/docs/reference/cluster/tasks.asciidoc @@ -233,7 +233,7 @@ example, the following command will cancel all reindex tasks running on the nodes `nodeId1` and `nodeId2`. `wait_for_completion`:: -(Optional, boolean) If `true`, the request blocks until the cancellation of the +(Optional, Boolean) If `true`, the request blocks until the cancellation of the task and its descendant tasks is completed. Otherwise, the request can return soon after the cancellation is started. Defaults to `false`. diff --git a/docs/reference/cluster/update-settings.asciidoc b/docs/reference/cluster/update-settings.asciidoc index 627516884c7..b05d846b9ff 100644 --- a/docs/reference/cluster/update-settings.asciidoc +++ b/docs/reference/cluster/update-settings.asciidoc @@ -47,7 +47,7 @@ difficult to notice these discrepancies. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] `include_defaults`:: - (Optional, boolean) If `true`, returns all default cluster settings. + (Optional, Boolean) If `true`, returns all default cluster settings. Defaults to `false`. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] diff --git a/docs/reference/cluster/voting-exclusions.asciidoc b/docs/reference/cluster/voting-exclusions.asciidoc index 761b73b923e..f92ea8c5a30 100644 --- a/docs/reference/cluster/voting-exclusions.asciidoc +++ b/docs/reference/cluster/voting-exclusions.asciidoc @@ -64,7 +64,7 @@ condition is satisfied, the request fails and returns an error. Defaults to `30s`. `wait_for_removal`:: -(Optional, boolean) Specifies whether to wait for all excluded nodes to be +(Optional, Boolean) Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. Defaults to `true`, meaning that all excluded nodes must be removed from the cluster before this API takes any action. If set to `false` then the voting diff --git a/docs/reference/docs/bulk.asciidoc b/docs/reference/docs/bulk.asciidoc index c367e2a5d5d..45a2e29d342 100644 --- a/docs/reference/docs/bulk.asciidoc +++ b/docs/reference/docs/bulk.asciidoc @@ -305,7 +305,7 @@ information. How long, in milliseconds, it took to process the bulk request. `errors`:: -(boolean) +(Boolean) If `true`, one or more of the operations in the bulk request did not complete successfully. diff --git a/docs/reference/docs/get.asciidoc b/docs/reference/docs/get.asciidoc index 73bac5c3286..7264bc64864 100644 --- a/docs/reference/docs/get.asciidoc +++ b/docs/reference/docs/get.asciidoc @@ -161,7 +161,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=realtime] `refresh`:: -(Optional, boolean) +(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`. diff --git a/docs/reference/docs/multi-get.asciidoc b/docs/reference/docs/multi-get.asciidoc index 4f6e70867ef..28cbb77ebfe 100644 --- a/docs/reference/docs/multi-get.asciidoc +++ b/docs/reference/docs/multi-get.asciidoc @@ -97,7 +97,7 @@ Required if no index is specified in the request URI. Required if routing is used during indexing. `_source`:: -(Optional, boolean) If `false`, excludes all `_source` fields. Defaults to `true`. +(Optional, Boolean) If `false`, excludes all `_source` fields. Defaults to `true`. `source_include`::: (Optional, array) The fields to extract and return from the `_source` field. `source_exclude`::: diff --git a/docs/reference/docs/reindex.asciidoc b/docs/reference/docs/reindex.asciidoc index 55e59398912..ac5aeea6bf5 100644 --- a/docs/reference/docs/reindex.asciidoc +++ b/docs/reference/docs/reindex.asciidoc @@ -550,7 +550,7 @@ For more information, see <>. `timed_out`:: -{boolean) This flag is set to `true` if any of the requests executed during the +{Boolean) This flag is set to `true` if any of the requests executed during the reindex timed out. `total`:: diff --git a/docs/reference/eql/eql-search-api.asciidoc b/docs/reference/eql/eql-search-api.asciidoc index 86fbccb358c..e293faddfce 100644 --- a/docs/reference/eql/eql-search-api.asciidoc +++ b/docs/reference/eql/eql-search-api.asciidoc @@ -57,7 +57,7 @@ To search all data streams and indices in a cluster, use ==== {api-query-parms-title} `allow_no_indices`:: -(Optional, boolean) +(Optional, Boolean) + NOTE: This parameter's behavior differs from the `allow_no_indices` parameter used in other <>. @@ -81,7 +81,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] Defaults to `open`. `ignore_unavailable`:: -(Optional, boolean) If `true`, missing or closed indices are not included in the +(Optional, Boolean) If `true`, missing or closed indices are not included in the response. Defaults to `true`. `keep_alive`:: @@ -110,7 +110,7 @@ If both parameters are specified, only the query parameter is used. `keep_on_completion`:: + -- -(Optional, boolean) +(Optional, Boolean) If `true`, the search and its results are stored on the cluster. If `false`, the search and its results are stored on the cluster only if the @@ -209,7 +209,7 @@ If both parameters are specified, only the query parameter is used. `keep_on_completion`:: + -- -(Optional, boolean) +(Optional, Boolean) If `true`, the search and its results are stored on the cluster. If `false`, the search and its results are stored on the cluster only if the @@ -320,13 +320,13 @@ API>> to get the current status and available results for the search. -- `is_partial`:: -(boolean) +(Boolean) If `true`, the response does not contain complete search results. `is_running`:: + -- -(boolean) +(Boolean) If `true`, the search request is still executing. [IMPORTANT] @@ -366,7 +366,7 @@ Took time does *not* include: -- `timed_out`:: -(boolean) +(Boolean) If `true`, the request timed out before completion. `hits`:: diff --git a/docs/reference/eql/functions.asciidoc b/docs/reference/eql/functions.asciidoc index d16549b4538..a3e707c6891 100644 --- a/docs/reference/eql/functions.asciidoc +++ b/docs/reference/eql/functions.asciidoc @@ -137,7 +137,7 @@ field data types: -- ``:: -(Optional, boolean) +(Optional, Boolean) If `true`, match the longest possible substring, similar to `.*` in regular expressions. If `false`, match the shortest possible substring, similar to `.*?` in regular expressions. Defaults to `false`. diff --git a/docs/reference/ilm/actions/ilm-delete.asciidoc b/docs/reference/ilm/actions/ilm-delete.asciidoc index 26750acce3b..fe66b72fa72 100644 --- a/docs/reference/ilm/actions/ilm-delete.asciidoc +++ b/docs/reference/ilm/actions/ilm-delete.asciidoc @@ -11,7 +11,7 @@ Permanently removes the index. `delete_searchable_snapshot`:: beta:[] -(Optional, boolean) +(Optional, Boolean) Deletes the searchable snapshot created in the cold phase. Defaults to `true`. This option is applicable when the <>. ==== Options `enabled`:: -(Optional, boolean) +(Optional, Boolean) Controls whether {ilm-init} automatically migrates the index during this phase. Defaults to `true`. diff --git a/docs/reference/ilm/actions/ilm-searchable-snapshot.asciidoc b/docs/reference/ilm/actions/ilm-searchable-snapshot.asciidoc index 8d52efe4c00..667453e3a43 100644 --- a/docs/reference/ilm/actions/ilm-searchable-snapshot.asciidoc +++ b/docs/reference/ilm/actions/ilm-searchable-snapshot.asciidoc @@ -33,7 +33,7 @@ Specifies where to store the snapshot. See <> for more information. `force_merge_index`:: -(Optional, boolean) +(Optional, Boolean) Force merges the managed index to one segment. Defaults to `true`. If the managed index was already force merged using the diff --git a/docs/reference/ilm/apis/explain.asciidoc b/docs/reference/ilm/apis/explain.asciidoc index 17f016a0040..003d10af6c0 100644 --- a/docs/reference/ilm/apis/explain.asciidoc +++ b/docs/reference/ilm/apis/explain.asciidoc @@ -44,11 +44,11 @@ To target all data streams and indices in a cluster, use `_all` or `*`. ==== {api-query-parms-title} `only_managed`:: - (Optional, boolean) Filters the returned indices to only indices that are managed by + (Optional, Boolean) Filters the returned indices to only indices that are managed by {ilm-init}. `only_errors`:: - (Optional, boolean) Filters the returned indices to only indices that are managed by + (Optional, Boolean) Filters the returned indices to only indices that are managed by {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. diff --git a/docs/reference/indices/aliases.asciidoc b/docs/reference/indices/aliases.asciidoc index 0f9351daed6..fa5f871c261 100644 --- a/docs/reference/indices/aliases.asciidoc +++ b/docs/reference/indices/aliases.asciidoc @@ -111,18 +111,18 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-alias-filter] See <> for an example. `is_hidden`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the alias will be excluded from wildcard expressions by default, unless overriden in the request using the `expand_wildcards` parameter, similar to <>. This property must be set to the same value on all indices that share an alias. Defaults to `false`. `must_exist`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the alias to remove must exist. Defaults to `false`. `is_write_index`:: -(Optional, boolean) +(Optional, Boolean) If `true`, assigns the index as an alias's write index. Defaults to `false`. + diff --git a/docs/reference/indices/analyze.asciidoc b/docs/reference/indices/analyze.asciidoc index 02a4e00588a..d115702c1fa 100644 --- a/docs/reference/indices/analyze.asciidoc +++ b/docs/reference/indices/analyze.asciidoc @@ -81,7 +81,7 @@ Array of character filters used to preprocess characters before the tokenizer. See <> for a list of character filters. `explain`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the response includes token attributes and additional details. Defaults to `false`. experimental:[The format of the additional detail information is labelled as experimental in Lucene and it may change in the future.] diff --git a/docs/reference/indices/clearcache.asciidoc b/docs/reference/indices/clearcache.asciidoc index 7cfae6775ce..6a71f289655 100644 --- a/docs/reference/indices/clearcache.asciidoc +++ b/docs/reference/indices/clearcache.asciidoc @@ -48,7 +48,7 @@ Defaults to `open`. `fielddata`:: + -- -(Optional, boolean) +(Optional, Boolean) If `true`, clears the fields cache. @@ -78,12 +78,12 @@ used to limit the request. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] `query`:: -(Optional, boolean) +(Optional, Boolean) If `true`, clears the query cache. `request`:: -(Optional, boolean) +(Optional, Boolean) If `true`, clears the request cache. diff --git a/docs/reference/indices/component-templates.asciidoc b/docs/reference/indices/component-templates.asciidoc index 9c3441582ee..3816c6653c1 100644 --- a/docs/reference/indices/component-templates.asciidoc +++ b/docs/reference/indices/component-templates.asciidoc @@ -88,7 +88,7 @@ Name of the component template to create. ==== {api-query-parms-title} `create`:: -(Optional, boolean) +(Optional, Boolean) If `true`, this request cannot replace or update existing component templates. Defaults to `false`. diff --git a/docs/reference/indices/dangling-index-delete.asciidoc b/docs/reference/indices/dangling-index-delete.asciidoc index 3e3a74c456f..45080566f64 100644 --- a/docs/reference/indices/dangling-index-delete.asciidoc +++ b/docs/reference/indices/dangling-index-delete.asciidoc @@ -37,7 +37,7 @@ UUID of the index to delete. You can find this using the ==== {api-query-parms-title} `accept_data_loss`:: -(Optional, boolean) +(Optional, Boolean) This field must be set to `true` in order to carry out the import, since it will no longer be possible to recover the data from the dangling index. diff --git a/docs/reference/indices/dangling-index-import.asciidoc b/docs/reference/indices/dangling-index-import.asciidoc index c905748216f..21ee0b56297 100644 --- a/docs/reference/indices/dangling-index-import.asciidoc +++ b/docs/reference/indices/dangling-index-import.asciidoc @@ -36,7 +36,7 @@ UUID of the index to import, which you can find using the ==== {api-query-parms-title} `accept_data_loss`:: -(Required, boolean) +(Required, Boolean) This field must be set to `true` to import a dangling index. Because {es} cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data diff --git a/docs/reference/indices/data-stream-stats.asciidoc b/docs/reference/indices/data-stream-stats.asciidoc index 8a9a19a74fc..a3773079a28 100644 --- a/docs/reference/indices/data-stream-stats.asciidoc +++ b/docs/reference/indices/data-stream-stats.asciidoc @@ -73,7 +73,7 @@ To target all data streams in a cluster, omit this parameter or use `*`. ==== {api-query-parms-title} `human`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the response includes statistics in human-readable <>. Defaults to `false`. diff --git a/docs/reference/indices/flush.asciidoc b/docs/reference/indices/flush.asciidoc index 10da70381bb..9601476412b 100644 --- a/docs/reference/indices/flush.asciidoc +++ b/docs/reference/indices/flush.asciidoc @@ -76,7 +76,7 @@ Defaults to `open`. `force`:: + -- -(Optional, boolean) +(Optional, Boolean) If `true`, the request forces a flush even if there are no changes to commit to the index. @@ -94,7 +94,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailab `wait_if_ongoing`:: + -- -(Optional, boolean) +(Optional, Boolean) If `true`, the flush operation blocks until execution when another flush operation is running. diff --git a/docs/reference/indices/forcemerge.asciidoc b/docs/reference/indices/forcemerge.asciidoc index 86ac22ba284..8c83e93a127 100644 --- a/docs/reference/indices/forcemerge.asciidoc +++ b/docs/reference/indices/forcemerge.asciidoc @@ -90,7 +90,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] Defaults to `open`. `flush`:: -(Optional, boolean) +(Optional, Boolean) If `true`, {es} performs a <> on the indices after the force merge. @@ -113,7 +113,7 @@ If so, executes it. `only_expunge_deletes`:: + -- -(Optional, boolean) +(Optional, Boolean) If `true`, only expunge segments containing document deletions. Defaults to `false`. diff --git a/docs/reference/indices/get-alias.asciidoc b/docs/reference/indices/get-alias.asciidoc index c580b7063ee..d9b6ee31f27 100644 --- a/docs/reference/indices/get-alias.asciidoc +++ b/docs/reference/indices/get-alias.asciidoc @@ -51,7 +51,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] Defaults to `all`. `ignore_unavailable`:: -(Optional, boolean) +(Optional, Boolean) If `false`, requests that include a missing index in the `` argument return an error. Defaults to `false`. diff --git a/docs/reference/indices/get-field-mapping.asciidoc b/docs/reference/indices/get-field-mapping.asciidoc index db2d1d7cce1..1e40c6981f0 100644 --- a/docs/reference/indices/get-field-mapping.asciidoc +++ b/docs/reference/indices/get-field-mapping.asciidoc @@ -54,7 +54,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-type-name] 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. +(Optional, Boolean) If `true`, the response includes default mapping values. Defaults to `false`. `local`:: diff --git a/docs/reference/indices/get-index.asciidoc b/docs/reference/indices/get-index.asciidoc index ff048f746d2..b0f4dcbde41 100644 --- a/docs/reference/indices/get-index.asciidoc +++ b/docs/reference/indices/get-index.asciidoc @@ -54,7 +54,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-defaults] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-type-name] `ignore_unavailable`:: -(Optional, boolean) +(Optional, Boolean) If `false`, requests that target a missing index return an error. Defaults to `false`. diff --git a/docs/reference/indices/put-component-template.asciidoc b/docs/reference/indices/put-component-template.asciidoc index c5c48cb521f..1a05b91539c 100644 --- a/docs/reference/indices/put-component-template.asciidoc +++ b/docs/reference/indices/put-component-template.asciidoc @@ -85,7 +85,7 @@ Name of the component template to create. ==== {api-query-parms-title} `create`:: -(Optional, boolean) +(Optional, Boolean) If `true`, this request cannot replace or update existing component templates. Defaults to `false`. diff --git a/docs/reference/indices/put-index-template-v1.asciidoc b/docs/reference/indices/put-index-template-v1.asciidoc index 4085433db4e..cc5f065412e 100644 --- a/docs/reference/indices/put-index-template-v1.asciidoc +++ b/docs/reference/indices/put-index-template-v1.asciidoc @@ -95,7 +95,7 @@ Name of the index template to create. ==== {api-query-parms-title} `create`:: -(Optional, boolean) +(Optional, Boolean) If `true`, this request cannot replace or update existing index templates. Defaults to `false`. diff --git a/docs/reference/indices/put-index-template.asciidoc b/docs/reference/indices/put-index-template.asciidoc index d0989eac528..8537a92c239 100644 --- a/docs/reference/indices/put-index-template.asciidoc +++ b/docs/reference/indices/put-index-template.asciidoc @@ -70,7 +70,7 @@ Name of the index template to create. ==== {api-query-parms-title} `create`:: -(Optional, boolean) +(Optional, Boolean) If `true`, this request cannot replace or update existing index templates. Defaults to `false`. include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] diff --git a/docs/reference/indices/put-mapping.asciidoc b/docs/reference/indices/put-mapping.asciidoc index ee925b1dfc3..002183ad7bd 100644 --- a/docs/reference/indices/put-mapping.asciidoc +++ b/docs/reference/indices/put-mapping.asciidoc @@ -66,7 +66,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailab include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] `write_index_only`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the mappings are applied only to the current write index for the target. Defaults to `false`. diff --git a/docs/reference/indices/rollover-index.asciidoc b/docs/reference/indices/rollover-index.asciidoc index e38a03e8f89..0a70c5f79d3 100644 --- a/docs/reference/indices/rollover-index.asciidoc +++ b/docs/reference/indices/rollover-index.asciidoc @@ -115,7 +115,7 @@ is required. ==== {api-query-parms-title} `dry_run`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the request checks whether the index matches provided conditions but does not perform a rollover. diff --git a/docs/reference/indices/segments.asciidoc b/docs/reference/indices/segments.asciidoc index 3a20bc36e44..89bcce73322 100644 --- a/docs/reference/indices/segments.asciidoc +++ b/docs/reference/indices/segments.asciidoc @@ -50,7 +50,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailab `verbose`:: experimental:[] -(Optional, boolean) +(Optional, Boolean) If `true`, the response includes detailed information about Lucene's memory usage. Defaults to `false`. diff --git a/docs/reference/indices/simulate-template.asciidoc b/docs/reference/indices/simulate-template.asciidoc index dbef5cfbe93..6d58ad2ef6f 100644 --- a/docs/reference/indices/simulate-template.asciidoc +++ b/docs/reference/indices/simulate-template.asciidoc @@ -82,7 +82,7 @@ omit this parameter and specify the template configuration in the request body. //// `create`:: -(Optional, boolean) If `true`, the template passed in the body is +(Optional, Boolean) If `true`, the template passed in the body is only used if no existing templates match the same index patterns. If `false`, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; diff --git a/docs/reference/indices/stats.asciidoc b/docs/reference/indices/stats.asciidoc index 6352da9cc34..afd8409a48c 100644 --- a/docs/reference/indices/stats.asciidoc +++ b/docs/reference/indices/stats.asciidoc @@ -78,7 +78,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=completion-fields] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fielddata-fields] `forbid_closed_indices`:: -(Optional, boolean) +(Optional, Boolean) If `true`, statistics are *not* collected from closed indices. Defaults to `true`. diff --git a/docs/reference/indices/update-settings.asciidoc b/docs/reference/indices/update-settings.asciidoc index d0b4fef8958..4afb12120e7 100644 --- a/docs/reference/indices/update-settings.asciidoc +++ b/docs/reference/indices/update-settings.asciidoc @@ -55,7 +55,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] `preserve_existing`:: -(Optional, boolean) If `true`, existing index settings remain unchanged. +(Optional, Boolean) If `true`, existing index settings remain unchanged. Defaults to `false`. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] diff --git a/docs/reference/ingest/apis/enrich/execute-enrich-policy.asciidoc b/docs/reference/ingest/apis/enrich/execute-enrich-policy.asciidoc index 4635d03b9ec..35e9b9e69b5 100644 --- a/docs/reference/ingest/apis/enrich/execute-enrich-policy.asciidoc +++ b/docs/reference/ingest/apis/enrich/execute-enrich-policy.asciidoc @@ -106,6 +106,6 @@ Enrich policy to execute. ==== {api-request-body-title} `wait_for_completion`:: -(Required, boolean) +(Required, Boolean) If `true`, the request blocks other enrich policy execution requests until complete. Defaults to `true`. diff --git a/docs/reference/ingest/apis/simulate-pipeline.asciidoc b/docs/reference/ingest/apis/simulate-pipeline.asciidoc index 3c53a61506b..92ceda99268 100644 --- a/docs/reference/ingest/apis/simulate-pipeline.asciidoc +++ b/docs/reference/ingest/apis/simulate-pipeline.asciidoc @@ -86,7 +86,7 @@ Pipeline ID used to simulate an ingest. ==== {api-query-parms-title} `verbose`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the response includes output data for each processor in the executed pipeline. diff --git a/docs/reference/licensing/get-license.asciidoc b/docs/reference/licensing/get-license.asciidoc index 5fe58c060cd..527d6ef54ca 100644 --- a/docs/reference/licensing/get-license.asciidoc +++ b/docs/reference/licensing/get-license.asciidoc @@ -27,7 +27,7 @@ https://www.elastic.co/subscriptions. ==== Query Parameters `local`:: - (boolean) Specifies whether to retrieve local information. The default value + (Boolean) Specifies whether to retrieve local information. The default value is `false`, which means the information is retrieved from the master node. diff --git a/docs/reference/licensing/update-license.asciidoc b/docs/reference/licensing/update-license.asciidoc index bd20f09aa17..823f564331d 100644 --- a/docs/reference/licensing/update-license.asciidoc +++ b/docs/reference/licensing/update-license.asciidoc @@ -41,7 +41,7 @@ https://www.elastic.co/subscriptions. ==== {api-query-parms-title} `acknowledge`:: - (Optional, boolean) + (Optional, Boolean) Specifies whether you acknowledge the license changes. The default value is `false`. diff --git a/docs/reference/mapping/types/nested.asciidoc b/docs/reference/mapping/types/nested.asciidoc index 9915c632bde..20057d9ccd7 100644 --- a/docs/reference/mapping/types/nested.asciidoc +++ b/docs/reference/mapping/types/nested.asciidoc @@ -203,13 +203,13 @@ may be added to an existing nested object. [[nested-include-in-parent-parm]] `include_in_parent`:: -(Optional, boolean) +(Optional, Boolean) If `true`, all fields in the nested object are also added to the parent document as standard (flat) fields. Defaults to `false`. [[nested-include-in-root-parm]] `include_in_root`:: -(Optional, boolean) +(Optional, Boolean) If `true`, all fields in the nested object are also added to the root document as standard (flat) fields. Defaults to `false`. diff --git a/docs/reference/ml/anomaly-detection/apis/close-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/close-job.asciidoc index 4ce644b050b..1fa767da583 100644 --- a/docs/reference/ml/anomaly-detection/apis/close-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/close-job.asciidoc @@ -67,11 +67,11 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-wildca == {api-query-parms-title} `allow_no_match`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-jobs] `force`:: -(Optional, boolean) Use to close a failed job, or to forcefully close a job +(Optional, Boolean) Use to close a failed job, or to forcefully close a job which has not responded to its initial close request. `timeout`:: diff --git a/docs/reference/ml/anomaly-detection/apis/delete-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-datafeed.asciidoc index 2f60d869cb2..38c6dcd2ab9 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-datafeed.asciidoc @@ -35,7 +35,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id] == {api-query-parms-title} `force`:: - (Optional, boolean) Use to forcefully delete a started {dfeed}; this method is + (Optional, Boolean) Use to forcefully delete a started {dfeed}; this method is quicker than stopping and deleting the {dfeed}. [[ml-delete-datafeed-example]] diff --git a/docs/reference/ml/anomaly-detection/apis/delete-forecast.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-forecast.asciidoc index 3b9903e8e30..9d39712944c 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-forecast.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-forecast.asciidoc @@ -54,7 +54,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] == {api-query-parms-title} `allow_no_forecasts`:: - (Optional, boolean) Specifies whether an error occurs when there are no + (Optional, Boolean) Specifies whether an error occurs when there are no forecasts. In particular, if this parameter is set to `false` and there are no forecasts associated with the job, attempts to delete all forecasts return an error. The default value is `true`. diff --git a/docs/reference/ml/anomaly-detection/apis/delete-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-job.asciidoc index 2923e64ba2f..13e0bc7f7c3 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-job.asciidoc @@ -47,7 +47,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] == {api-query-parms-title} `force`:: -(Optional, boolean) Use to forcefully delete an opened job; this method is +(Optional, Boolean) Use to forcefully delete an opened job; this method is quicker than closing and deleting the job. `wait_for_completion`:: diff --git a/docs/reference/ml/anomaly-detection/apis/find-file-structure.asciidoc b/docs/reference/ml/anomaly-detection/apis/find-file-structure.asciidoc index 2444e5eb5a2..a1c7516c018 100644 --- a/docs/reference/ml/anomaly-detection/apis/find-file-structure.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/find-file-structure.asciidoc @@ -86,7 +86,7 @@ chosen. of the rows can have a different number of columns than the first row. `explain`:: - (Optional, boolean) If this parameter is set to `true`, the response includes + (Optional, Boolean) If this parameter is set to `true`, the response includes a field named `explanation`, which is an array of strings that indicate how the structure finder produced its result. The default value is `false`. @@ -109,7 +109,7 @@ columns than the first row. a Grok pattern. `has_header_row`:: - (Optional, boolean) If you have set `format` to `delimited`, you can use this + (Optional, Boolean) If you have set `format` to `delimited`, you can use this parameter to indicate whether the column names are in the first row of the file. If this parameter is not specified, the structure finder guesses based on the similarity of the first row of the file to other rows. @@ -146,7 +146,7 @@ to request analysis of 100000 lines to achieve some variety. argument to a character that does not appear anywhere in the sample. `should_trim_fields`:: - (Optional, boolean) If you have set `format` to `delimited`, you can specify + (Optional, Boolean) If you have set `format` to `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them. If this parameter is not specified and the delimiter is pipe (`|`), the default value is `true`. Otherwise, the default value is `false`. diff --git a/docs/reference/ml/anomaly-detection/apis/flush-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/flush-job.asciidoc index 983e3d76e6e..0d72266f94a 100644 --- a/docs/reference/ml/anomaly-detection/apis/flush-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/flush-job.asciidoc @@ -48,7 +48,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] generated and the model is updated for data from the specified time interval. `calc_interim`:: - (boolean) Optional. If true, calculates the interim results for the most + (Boolean) Optional. If true, calculates the interim results for the most recent bucket or all buckets within the latency period. `end`:: diff --git a/docs/reference/ml/anomaly-detection/apis/get-bucket.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-bucket.asciidoc index 5b206d26f34..77cc43738d9 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-bucket.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-bucket.asciidoc @@ -50,18 +50,18 @@ specify this parameter, the API returns information about all buckets. this value. `desc`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=desc-results] `end`:: (Optional, string) Returns buckets with timestamps earlier than this time. `exclude_interim`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-interim-results] `expand`:: -(Optional, boolean) If true, the output includes anomaly records. +(Optional, Boolean) If true, the output includes anomaly records. `page`.`from`:: (Optional, integer) Skips the specified number of buckets. @@ -113,7 +113,7 @@ initial value that was calculated at the time the bucket was processed. (string) The field value of the influencer. `is_interim`::: -(boolean) +(Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=is-interim] `job_id`::: @@ -148,7 +148,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-span-results] the initial value that was calculated at the time the bucket was processed. `is_interim`:: -(boolean) +(Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=is-interim] `job_id`:: diff --git a/docs/reference/ml/anomaly-detection/apis/get-datafeed-stats.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-datafeed-stats.asciidoc index d2bde11cc9a..d002973b8f6 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-datafeed-stats.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-datafeed-stats.asciidoc @@ -57,7 +57,7 @@ all {dfeeds}. == {api-query-parms-title} `allow_no_match`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-datafeeds] [role="child_attributes"] diff --git a/docs/reference/ml/anomaly-detection/apis/get-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-datafeed.asciidoc index 649905c4422..e622609df48 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-datafeed.asciidoc @@ -54,7 +54,7 @@ all {dfeeds}. == {api-query-parms-title} `allow_no_match`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-datafeeds] [[ml-get-datafeed-results]] diff --git a/docs/reference/ml/anomaly-detection/apis/get-influencer.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-influencer.asciidoc index b374c445474..94418a2b6ce 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-influencer.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-influencer.asciidoc @@ -41,14 +41,14 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] == {api-request-body-title} `desc`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=desc-results] `end`:: (Optional, string) Returns influencers with timestamps earlier than this time. `exclude_interim`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-interim-results] `influencer_score`:: @@ -97,7 +97,7 @@ the influencer aggregated across detectors. This is the initial value that was calculated at the time the bucket was processed. `is_interim`:: -(boolean) +(Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=is-interim] `job_id`:: diff --git a/docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc index 48abc9e1f53..7b8de2662d4 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc @@ -47,7 +47,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-defaul == {api-query-parms-title} `allow_no_match`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-jobs] [role="child_attributes"] @@ -143,7 +143,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=sparse-bucket-count] //End data_counts `deleting`:: -(boolean) +(Boolean) Indicates that the process of deleting the job is in progress but not yet completed. It is only reported when `true`. diff --git a/docs/reference/ml/anomaly-detection/apis/get-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-job.asciidoc index 655078ad446..fe89201d3e1 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-job.asciidoc @@ -47,7 +47,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-defaul == {api-query-parms-title} `allow_no_match`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-jobs] [[ml-get-job-results]] 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 3468f4f4e37..78040a54987 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-overall-buckets.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-overall-buckets.asciidoc @@ -63,7 +63,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-wildca == {api-request-body-title} `allow_no_match`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-jobs] `bucket_span`:: @@ -76,7 +76,7 @@ value. time. `exclude_interim`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-interim-results] + -- @@ -105,7 +105,7 @@ properties: (number) The length of the bucket in seconds. Matches the job with the longest `bucket_span` value. `is_interim`:: -(boolean) +(Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=is-interim] `jobs`:: diff --git a/docs/reference/ml/anomaly-detection/apis/get-record.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-record.asciidoc index e4841e28995..7b85f8223e0 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-record.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-record.asciidoc @@ -50,14 +50,14 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] == {api-request-body-title} `desc`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=desc-results] `end`:: (Optional, string) Returns records with timestamps earlier than this time. `exclude_interim`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-interim-results] `page`.`from`:: @@ -145,7 +145,7 @@ the anomalousness of this record. This is the initial value that was calculated at the time the bucket was processed. `is_interim`:: -(boolean) +(Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=is-interim] `job_id`:: diff --git a/docs/reference/ml/anomaly-detection/apis/get-snapshot.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-snapshot.asciidoc index 5fcc2784c94..7219089922f 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-snapshot.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-snapshot.asciidoc @@ -44,7 +44,7 @@ by specifying `*` as the ``, or by omitting the ``. == {api-request-body-title} `desc`:: - (Optional, boolean) If true, the results are sorted in descending order. + (Optional, Boolean) If true, the results are sorted in descending order. `end`:: (Optional, date) Returns snapshots with timestamps earlier than this time. @@ -186,7 +186,7 @@ separately for each detector and partition. //End model_size_stats `retain`:: -(boolean) +(Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=retain] `snapshot_id`:: diff --git a/docs/reference/ml/anomaly-detection/apis/open-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/open-job.asciidoc index ea4593aa8f0..94f9deb97d5 100644 --- a/docs/reference/ml/anomaly-detection/apis/open-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/open-job.asciidoc @@ -55,7 +55,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] open lazily and has not yet been assigned to a node, this value is an empty string. `opened`:: - (boolean) For a successful response, this value is always `true`. On failure, an + (Boolean) For a successful response, this value is always `true`. On failure, an exception is returned instead. [[ml-open-job-example]] diff --git a/docs/reference/ml/anomaly-detection/apis/put-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/put-job.asciidoc index cf479d17c3e..4a779ee2f52 100644 --- a/docs/reference/ml/anomaly-detection/apis/put-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/put-job.asciidoc @@ -40,7 +40,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-define == {api-request-body-title} `allow_lazy_open`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-lazy-open] //Begin analysis_config @@ -169,7 +169,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=over-field-name] include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=partition-field-name] `use_null`:::: -(boolean) +(Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=use-null] ===== //End analysis_config.detectors @@ -183,7 +183,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=influencers] include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=latency] `multivariate_by_fields`::: -(boolean) +(Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=multivariate-by-fields] //Begin analysis_config.per_partition_categorization @@ -195,11 +195,11 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization] [%collapsible%open] ===== `enabled`:::: -(boolean) +(Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization-enabled] `stop_on_warn`:::: -(boolean) +(Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization-stop-on-warn] ===== //End analysis_config.per_partition_categorization @@ -262,11 +262,11 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-plot-config] [%collapsible%open] ==== `annotations_enabled`::: -(boolean) +(Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-plot-config-annotations-enabled] `enabled`::: -(boolean) +(Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-plot-config-enabled] `terms`::: diff --git a/docs/reference/ml/anomaly-detection/apis/revert-snapshot.asciidoc b/docs/reference/ml/anomaly-detection/apis/revert-snapshot.asciidoc index b37cf0795da..bacf744c249 100644 --- a/docs/reference/ml/anomaly-detection/apis/revert-snapshot.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/revert-snapshot.asciidoc @@ -47,7 +47,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=snapshot-id] == {api-request-body-title} `delete_intervening_results`:: - (Optional, boolean) If true, deletes the results in the time period between + (Optional, Boolean) If true, deletes the results in the time period between the latest results and the time of the reverted snapshot. It also resets the model to accept records for this time period. The default value is false. diff --git a/docs/reference/ml/anomaly-detection/apis/set-upgrade-mode.asciidoc b/docs/reference/ml/anomaly-detection/apis/set-upgrade-mode.asciidoc index 3e47feee971..07f39f6c6a6 100644 --- a/docs/reference/ml/anomaly-detection/apis/set-upgrade-mode.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/set-upgrade-mode.asciidoc @@ -60,7 +60,7 @@ IMPORTANT: No new {ml} jobs can be opened while the `upgrade_mode` setting is == {api-query-parms-title} `enabled`:: - (Optional, boolean) When `true`, this enables `upgrade_mode`. Defaults to + (Optional, Boolean) When `true`, this enables `upgrade_mode`. Defaults to `false`. `timeout`:: diff --git a/docs/reference/ml/anomaly-detection/apis/start-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/start-datafeed.asciidoc index 5e6b618ce35..5bc306b0fc7 100644 --- a/docs/reference/ml/anomaly-detection/apis/start-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/start-datafeed.asciidoc @@ -103,7 +103,7 @@ If the {dfeed} is allowed to open lazily and has not yet been assigned to a node, this value is an empty string. `started`:: - (boolean) For a successful response, this value is always `true`. On failure, an + (Boolean) For a successful response, this value is always `true`. On failure, an exception is returned instead. [[ml-start-datafeed-example]] diff --git a/docs/reference/ml/anomaly-detection/apis/stop-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/stop-datafeed.asciidoc index cda51b8d427..716010c01e9 100644 --- a/docs/reference/ml/anomaly-detection/apis/stop-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/stop-datafeed.asciidoc @@ -47,14 +47,14 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id-wildcard] == {api-query-parms-title} `allow_no_match`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-datafeeds] [[ml-stop-datafeed-request-body]] == {api-request-body-title} `force`:: - (Optional, boolean) If true, the {dfeed} is stopped forcefully. + (Optional, Boolean) If true, the {dfeed} is stopped forcefully. `timeout`:: (Optional, time) Controls the amount of time to wait until a {dfeed} stops. diff --git a/docs/reference/ml/anomaly-detection/apis/update-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/update-job.asciidoc index 4275d07eb3b..74d73cae8c0 100644 --- a/docs/reference/ml/anomaly-detection/apis/update-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/update-job.asciidoc @@ -35,7 +35,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection] The following properties can be updated after the job is created: `allow_lazy_open`:: -(boolean) +(Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-lazy-open] + -- @@ -181,11 +181,11 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-plot-config] [%collapsible%open] ==== `annotations_enabled`::: -(boolean) +(Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-plot-config-annotations-enabled] `enabled`::: -(boolean) +(Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-plot-config-enabled] `terms`::: @@ -207,11 +207,11 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization] [%collapsible%open] ==== `enabled`::: -(boolean) +(Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization-enabled] `stop_on_warn`::: -(boolean) +(Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization-stop-on-warn] ==== //End per_partition_categorization diff --git a/docs/reference/ml/anomaly-detection/apis/update-snapshot.asciidoc b/docs/reference/ml/anomaly-detection/apis/update-snapshot.asciidoc index 2f6c55f5caa..b637311e718 100644 --- a/docs/reference/ml/anomaly-detection/apis/update-snapshot.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/update-snapshot.asciidoc @@ -41,7 +41,7 @@ The following properties can be updated after the model snapshot is created: (Optional, string) A description of the model snapshot. `retain`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=retain] [[ml-update-snapshot-example]] diff --git a/docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc index 374359c7f4b..29e78f43fb7 100644 --- a/docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc @@ -39,7 +39,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics] == {api-query-parms-title} `force`:: - (Optional, boolean) If `true`, it deletes a job that is not stopped; this method is + (Optional, Boolean) If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job. `timeout`:: diff --git a/docs/reference/ml/df-analytics/apis/evaluate-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/evaluate-dfanalytics.asciidoc index 4bf0bc0565a..70be9d067bc 100644 --- a/docs/reference/ml/df-analytics/apis/evaluate-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/evaluate-dfanalytics.asciidoc @@ -197,7 +197,7 @@ belongs. `class_name` in the list of their top classes. `include_curve`:::: - (Optional, boolean) Whether or not the curve should be returned in + (Optional, Boolean) Whether or not the curve should be returned in addition to the score. Default value is false. `multiclass_confusion_matrix`::: diff --git a/docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc index 2b802ac1016..ccd33b8500e 100644 --- a/docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc @@ -78,10 +78,10 @@ the field names. [%collapsible%open] ==== `is_included`::: -(boolean) Whether the field is selected to be included in the analysis. +(Boolean) Whether the field is selected to be included in the analysis. `is_required`::: -(boolean) Whether the field is required. +(Boolean) Whether the field is required. `feature_type`::: (string) The feature type of this field for the analysis. May be `categorical` diff --git a/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc b/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc index 3735b9d3924..333e7a017de 100644 --- a/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc +++ b/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc @@ -46,7 +46,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-def == {api-query-parms-title} `allow_no_match`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match] `from`:: @@ -58,7 +58,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=from] include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=size] `verbose`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=verbose] [role="child_attributes"] @@ -223,7 +223,7 @@ heuristics. [%collapsible%open] ======= `compute_feature_influence`:::: -(boolean) +(Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=compute-feature-influence] `feature_influence_threshold`:::: @@ -243,7 +243,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=n-neighbors] include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=outlier-fraction] `standardization_enabled`:::: -(boolean) +(Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=standardization-enabled] ======= //End parameters diff --git a/docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc index 2de63dd23a3..cb1d5690afd 100644 --- a/docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc @@ -59,7 +59,7 @@ You can get information for all {dfanalytics-jobs} by using _all, by specifying == {api-query-parms-title} `allow_no_match`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match] `from`:: diff --git a/docs/reference/ml/df-analytics/apis/get-trained-models-stats.asciidoc b/docs/reference/ml/df-analytics/apis/get-trained-models-stats.asciidoc index 4cd0f2d3fcd..3e70ed2abce 100644 --- a/docs/reference/ml/df-analytics/apis/get-trained-models-stats.asciidoc +++ b/docs/reference/ml/df-analytics/apis/get-trained-models-stats.asciidoc @@ -54,7 +54,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-id] == {api-query-parms-title} `allow_no_match`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-models] `from`:: diff --git a/docs/reference/ml/df-analytics/apis/get-trained-models.asciidoc b/docs/reference/ml/df-analytics/apis/get-trained-models.asciidoc index d3a8a258a54..96cfdf5ce3a 100644 --- a/docs/reference/ml/df-analytics/apis/get-trained-models.asciidoc +++ b/docs/reference/ml/df-analytics/apis/get-trained-models.asciidoc @@ -57,16 +57,16 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-id] == {api-query-parms-title} `allow_no_match`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-models] `decompress_definition`:: -(Optional, boolean) +(Optional, Boolean) Specifies whether the included model definition should be returned as a JSON map (`true`) or in a custom compressed format (`false`). Defaults to `true`. `for_export`:: -(Optional, boolean) +(Optional, Boolean) Indicates if certain fields should be removed from the model configuration on retrieval. This allows the model to be in an acceptable format to be retrieved and then added to another cluster. Default is false. diff --git a/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc index f5ff3aa8692..724d4af703c 100644 --- a/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc @@ -61,7 +61,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-def == {api-request-body-title} `allow_lazy_start`:: -(Optional, boolean) +(Optional, Boolean) Specifies whether this job can start when there is insufficient {ml} node capacity for it to be immediately assigned to a node. The default is `false`; if a {ml} node with capacity to run the job cannot immediately be found, the @@ -175,7 +175,7 @@ The configuration information necessary to perform [%collapsible%open] ===== `compute_feature_influence`:::: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=compute-feature-influence] `feature_influence_threshold`:::: @@ -195,7 +195,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=n-neighbors] include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=outlier-fraction] `standardization_enabled`:::: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=standardization-enabled] //End outlier_detection ===== diff --git a/docs/reference/ml/df-analytics/apis/put-trained-models.asciidoc b/docs/reference/ml/df-analytics/apis/put-trained-models.asciidoc index 4179b5369ae..ecf0537d242 100644 --- a/docs/reference/ml/df-analytics/apis/put-trained-models.asciidoc +++ b/docs/reference/ml/df-analytics/apis/put-trained-models.asciidoc @@ -212,7 +212,7 @@ Indicates the positive value (in other words, when to choose the left node) decision type. Supported `lt`, `lte`, `gt`, `gte`. Defaults to `lte`. `default_left`:: -(Optional, boolean) +(Optional, Boolean) Indicates whether to default to the left when the feature is missing. Defaults to `true`. diff --git a/docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc index 6004e5a8f94..8536e6c356f 100644 --- a/docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc @@ -69,7 +69,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=timeout-start] == {api-response-body-title} `acknowledged`:: - (boolean) For a successful response, this value is always `true`. On failure, an + (Boolean) For a successful response, this value is always `true`. On failure, an exception is returned instead. `node`:: diff --git a/docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc index c24c05b6772..56dc7497e05 100644 --- a/docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc @@ -53,12 +53,12 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-def == {api-query-parms-title} `allow_no_match`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match] `force`:: - (Optional, boolean) If true, the {dfanalytics-job} is stopped forcefully. + (Optional, Boolean) If true, the {dfanalytics-job} is stopped forcefully. `timeout`:: (Optional, <>) diff --git a/docs/reference/ml/df-analytics/apis/update-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/update-dfanalytics.asciidoc index bb434219da0..1de505f06ae 100644 --- a/docs/reference/ml/df-analytics/apis/update-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/update-dfanalytics.asciidoc @@ -55,7 +55,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-def == {api-request-body-title} `allow_lazy_start`:: -(Optional, boolean) +(Optional, Boolean) Specifies whether this job can start when there is insufficient {ml} node capacity for it to be immediately assigned to a node. The default is `false`; if a {ml} node with capacity to run the job cannot immediately be found, the API diff --git a/docs/reference/ml/ml-shared.asciidoc b/docs/reference/ml/ml-shared.asciidoc index a6d3d35e98d..be7912efab7 100644 --- a/docs/reference/ml/ml-shared.asciidoc +++ b/docs/reference/ml/ml-shared.asciidoc @@ -307,7 +307,7 @@ Specifies whether the feature influence calculation is enabled. Defaults to end::compute-feature-influence[] tag::custom-preprocessor[] -(Optional, boolean) +(Optional, Boolean) Boolean value indicating if the analytics job created the preprocessor or if a user provided it. This adjusts the feature importance calculation. When `true`, the feature importance calculation returns importance for the @@ -462,7 +462,7 @@ real-time {dfeed} runs. In particular, the default `check_window` span calculation is based on the maximum of `2h` or `8 * bucket_span`. `enabled`:: -(boolean) Specifies whether the {dfeed} periodically checks for delayed data. +(Boolean) Specifies whether the {dfeed} periodically checks for delayed data. Defaults to `true`. ==== end::delayed-data-check-config[] diff --git a/docs/reference/query-dsl/fuzzy-query.asciidoc b/docs/reference/query-dsl/fuzzy-query.asciidoc index ef9c9a9dbf7..6a9b6010a1f 100644 --- a/docs/reference/query-dsl/fuzzy-query.asciidoc +++ b/docs/reference/query-dsl/fuzzy-query.asciidoc @@ -92,7 +92,7 @@ variations examined. expansions. Defaults to `0`. `transpositions`:: -(Optional, boolean) Indicates whether edits include transpositions of two +(Optional, Boolean) Indicates whether edits include transpositions of two adjacent characters (ab → ba). Defaults to `true`. `rewrite`:: diff --git a/docs/reference/query-dsl/has-child-query.asciidoc b/docs/reference/query-dsl/has-child-query.asciidoc index c5d969b5191..7b8158aaab5 100644 --- a/docs/reference/query-dsl/has-child-query.asciidoc +++ b/docs/reference/query-dsl/has-child-query.asciidoc @@ -82,7 +82,7 @@ document. `ignore_unmapped`:: + -- -(Optional, boolean) Indicates whether to ignore an unmapped `type` and not +(Optional, Boolean) Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. Defaults to `false`. If `false`, {es} returns an error if the `type` is unmapped. diff --git a/docs/reference/query-dsl/has-parent-query.asciidoc b/docs/reference/query-dsl/has-parent-query.asciidoc index 375d1caec1d..6c4148a8dad 100644 --- a/docs/reference/query-dsl/has-parent-query.asciidoc +++ b/docs/reference/query-dsl/has-parent-query.asciidoc @@ -82,7 +82,7 @@ its child documents. `score`:: + -- -(Optional, boolean) Indicates whether the <> of a matching parent document is aggregated into its child documents. Defaults to `false`. @@ -97,7 +97,7 @@ into its child documents' relevance scores. `ignore_unmapped`:: + -- -(Optional, boolean) Indicates whether to ignore an unmapped `parent_type` and +(Optional, Boolean) Indicates whether to ignore an unmapped `parent_type` and not return any documents instead of an error. Defaults to `false`. If `false`, {es} returns an error if the `parent_type` is unmapped. diff --git a/docs/reference/query-dsl/intervals-query.asciidoc b/docs/reference/query-dsl/intervals-query.asciidoc index 7fc9d60b263..b408e04a6b8 100644 --- a/docs/reference/query-dsl/intervals-query.asciidoc +++ b/docs/reference/query-dsl/intervals-query.asciidoc @@ -98,7 +98,7 @@ set to `0`, the terms must appear next to each other. -- `ordered`:: -(Optional, boolean) +(Optional, Boolean) If `true`, matching terms must appear in their specified order. Defaults to `false`. @@ -193,7 +193,7 @@ edit distance defined by <>. If the fuzzy expansion matches more tha expansions. Defaults to `0`. `transpositions`:: -(Optional, boolean) Indicates whether edits include transpositions of two +(Optional, Boolean) Indicates whether edits include transpositions of two adjacent characters (ab → ba). Defaults to `true`. `fuzziness`:: @@ -235,7 +235,7 @@ set to `0`, the terms must appear next to each other. -- `ordered`:: -(Optional, boolean) If `true`, intervals produced by the rules should appear in +(Optional, Boolean) If `true`, intervals produced by the rules should appear in the order in which they are specified. Defaults to `false`. `filter`:: diff --git a/docs/reference/query-dsl/match-query.asciidoc b/docs/reference/query-dsl/match-query.asciidoc index 6f4e7fa022a..93303ef1047 100644 --- a/docs/reference/query-dsl/match-query.asciidoc +++ b/docs/reference/query-dsl/match-query.asciidoc @@ -58,7 +58,7 @@ default analyzer is used. `auto_generate_synonyms_phrase_query`:: + -- -(Optional, boolean) If `true`, <> +(Optional, Boolean) If `true`, <> queries are automatically created for multi-term synonyms. Defaults to `true`. See <> for an @@ -79,7 +79,7 @@ expand. Defaults to `50`. matching. Defaults to `0`. `fuzzy_transpositions`:: -(Optional, boolean) If `true`, edits for fuzzy matching include +(Optional, Boolean) If `true`, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to `true`. `fuzzy_rewrite`:: @@ -94,7 +94,7 @@ method of `top_terms_blended_freqs_${max_expansions}` by default. -- `lenient`:: -(Optional, boolean) If `true`, format-based errors, such as providing a text +(Optional, Boolean) If `true`, format-based errors, such as providing a text `query` value for a <> field, are ignored. Defaults to `false`. `operator`:: diff --git a/docs/reference/query-dsl/nested-query.asciidoc b/docs/reference/query-dsl/nested-query.asciidoc index 50a4e3d4901..853e1012bcf 100644 --- a/docs/reference/query-dsl/nested-query.asciidoc +++ b/docs/reference/query-dsl/nested-query.asciidoc @@ -109,7 +109,7 @@ Add together the relevance scores of all matching child objects. `ignore_unmapped`:: + -- -(Optional, boolean) Indicates whether to ignore an unmapped `path` and not +(Optional, Boolean) Indicates whether to ignore an unmapped `path` and not return any documents instead of an error. Defaults to `false`. If `false`, {es} returns an error if the `path` is an unmapped field. diff --git a/docs/reference/query-dsl/parent-id-query.asciidoc b/docs/reference/query-dsl/parent-id-query.asciidoc index 8b46d6bbc06..8b573c08dcc 100644 --- a/docs/reference/query-dsl/parent-id-query.asciidoc +++ b/docs/reference/query-dsl/parent-id-query.asciidoc @@ -102,7 +102,7 @@ documents of this parent document. `ignore_unmapped`:: + -- -(Optional, boolean) Indicates whether to ignore an unmapped `type` and not +(Optional, Boolean) Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. Defaults to `false`. If `false`, {es} returns an error if the `type` is unmapped. diff --git a/docs/reference/query-dsl/prefix-query.asciidoc b/docs/reference/query-dsl/prefix-query.asciidoc index 9d28dfb6b42..b400924edb1 100644 --- a/docs/reference/query-dsl/prefix-query.asciidoc +++ b/docs/reference/query-dsl/prefix-query.asciidoc @@ -42,7 +42,7 @@ provided ``. information, see the <>. `case_insensitive`:: -(Optional, boolean) allows ASCII case insensitive matching of the +(Optional, Boolean) allows ASCII case insensitive matching of the value with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field's mapping. diff --git a/docs/reference/query-dsl/query-string-query.asciidoc b/docs/reference/query-dsl/query-string-query.asciidoc index c2a9428c350..a36289722a7 100644 --- a/docs/reference/query-dsl/query-string-query.asciidoc +++ b/docs/reference/query-dsl/query-string-query.asciidoc @@ -84,11 +84,11 @@ It is defined by the `indices.query.bool.max_clause_count` -- `allow_leading_wildcard`:: -(Optional, boolean) If `true`, the wildcard characters `*` and `?` are allowed +(Optional, Boolean) If `true`, the wildcard characters `*` and `?` are allowed as the first character of the query string. Defaults to `true`. `analyze_wildcard`:: -(Optional, boolean) If `true`, the query attempts to analyze wildcard terms in +(Optional, Boolean) If `true`, the query attempts to analyze wildcard terms in the query string. Defaults to `false`. `analyzer`:: @@ -98,7 +98,7 @@ query string into tokens. Defaults to the `default_field`. If no analyzer is mapped, the index's default analyzer is used. `auto_generate_synonyms_phrase_query`:: -(Optional, boolean) If `true`, <> +(Optional, Boolean) If `true`, <> queries are automatically created for multi-term synonyms. Defaults to `true`. See <> for an example. @@ -129,7 +129,7 @@ AND of AND Hungary`. -- `enable_position_increments`:: -(Optional, boolean) If `true`, enable position increments in queries constructed +(Optional, Boolean) If `true`, enable position increments in queries constructed from a `query_string` search. Defaults to `true`. `fields`:: @@ -154,11 +154,11 @@ matching. Defaults to `50`. matching. Defaults to `0`. `fuzzy_transpositions`:: -(Optional, boolean) If `true`, edits for fuzzy matching include +(Optional, Boolean) If `true`, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to `true`. `lenient`:: -(Optional, boolean) If `true`, format-based errors, such as providing a text +(Optional, Boolean) If `true`, format-based errors, such as providing a text value for a <> field, are ignored. Defaults to `false`. `max_determinized_states`:: diff --git a/docs/reference/query-dsl/regexp-query.asciidoc b/docs/reference/query-dsl/regexp-query.asciidoc index c50207299f2..480809ce135 100644 --- a/docs/reference/query-dsl/regexp-query.asciidoc +++ b/docs/reference/query-dsl/regexp-query.asciidoc @@ -69,7 +69,7 @@ valid values and more information, see <>. `case_insensitive`:: -(Optional, boolean) allows case insensitive matching of the regular expression +(Optional, Boolean) allows case insensitive matching of the regular expression value with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field's mapping. diff --git a/docs/reference/query-dsl/simple-query-string-query.asciidoc b/docs/reference/query-dsl/simple-query-string-query.asciidoc index 116855f857b..7b79e82f9ab 100644 --- a/docs/reference/query-dsl/simple-query-string-query.asciidoc +++ b/docs/reference/query-dsl/simple-query-string-query.asciidoc @@ -80,7 +80,7 @@ deprecated:[6.0.0, set `fields` to `*` instead](Optional, boolean) If `true`, search all searchable fields in the index's field mapping. `analyze_wildcard`:: -(Optional, boolean) If `true`, the query attempts to analyze wildcard terms in +(Optional, Boolean) If `true`, the query attempts to analyze wildcard terms in the query string. Defaults to `false`. `analyzer`:: @@ -90,7 +90,7 @@ query string into tokens. Defaults to the `default_field`. If no analyzer is mapped, the index's default analyzer is used. `auto_generate_synonyms_phrase_query`:: -(Optional, boolean) If `true`, <> +(Optional, Boolean) If `true`, <> queries are automatically created for multi-term synonyms. Defaults to `true`. See <> for an example. @@ -108,11 +108,11 @@ matching. Defaults to `50`. matching. Defaults to `0`. `fuzzy_transpositions`:: -(Optional, boolean) If `true`, edits for fuzzy matching include +(Optional, Boolean) If `true`, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to `true`. `lenient`:: -(Optional, boolean) If `true`, format-based errors, such as providing a text +(Optional, Boolean) If `true`, format-based errors, such as providing a text value for a <> field, are ignored. Defaults to `false`. `minimum_should_match`:: diff --git a/docs/reference/query-dsl/term-query.asciidoc b/docs/reference/query-dsl/term-query.asciidoc index 1a2626f937b..17ad147da3e 100644 --- a/docs/reference/query-dsl/term-query.asciidoc +++ b/docs/reference/query-dsl/term-query.asciidoc @@ -63,7 +63,7 @@ Boost values are relative to the default value of `1.0`. A boost value between increases the relevance score. `case_insensitive`:: -(Optional, boolean) allows ASCII case insensitive matching of the +(Optional, Boolean) allows ASCII case insensitive matching of the value with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field's mapping diff --git a/docs/reference/query-dsl/wildcard-query.asciidoc b/docs/reference/query-dsl/wildcard-query.asciidoc index 56daf53e120..ae84c60abbc 100644 --- a/docs/reference/query-dsl/wildcard-query.asciidoc +++ b/docs/reference/query-dsl/wildcard-query.asciidoc @@ -70,7 +70,7 @@ increases the relevance score. <>. `case_insensitive`:: -(Optional, boolean) allows case insensitive matching of the +(Optional, Boolean) allows case insensitive matching of the pattern with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field's mapping. diff --git a/docs/reference/repositories-metering-api/apis/repositories-meterings-body.asciidoc b/docs/reference/repositories-metering-api/apis/repositories-meterings-body.asciidoc index b38e50f8018..c92c0311f81 100644 --- a/docs/reference/repositories-metering-api/apis/repositories-meterings-body.asciidoc +++ b/docs/reference/repositories-metering-api/apis/repositories-meterings-body.asciidoc @@ -100,7 +100,7 @@ Time the repository was deleted or updated. Recorded in milliseconds since the https://en.wikipedia.org/wiki/Unix_time[Unix Epoch]. `archived`:: -(boolean) +(Boolean) A flag that tells whether or not this object has been archived. When a repository is closed or updated the repository metering information is archived and kept for a certain period of time. This allows retrieving diff --git a/docs/reference/rest-api/common-parms.asciidoc b/docs/reference/rest-api/common-parms.asciidoc index 3e5a2f03c2b..234fa722dbc 100644 --- a/docs/reference/rest-api/common-parms.asciidoc +++ b/docs/reference/rest-api/common-parms.asciidoc @@ -14,7 +14,7 @@ end::actions[] tag::active-only[] `active_only`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the response only includes ongoing shard recoveries. Defaults to `false`. @@ -48,7 +48,7 @@ end::target-index-aliases[] tag::allow-no-indices[] `allow_no_indices`:: -(Optional, boolean) +(Optional, Boolean) If `false`, the request returns an error if any wildcard expression, <>, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. @@ -99,7 +99,7 @@ end::analyzer[] tag::analyze_wildcard[] `analyze_wildcard`:: -(Optional, boolean) If `true`, wildcard and prefix queries are +(Optional, Boolean) If `true`, wildcard and prefix queries are analyzed. Defaults to `false`. end::analyze_wildcard[] @@ -171,7 +171,7 @@ end::dest-pipeline[] tag::detailed[] `detailed`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the response includes detailed information about shard recoveries. Defaults to `false`. @@ -257,7 +257,7 @@ end::exponential-avg-documents-processed[] tag::field_statistics[] `field_statistics`:: -(Optional, boolean) If `true`, the response includes the document count, sum of document frequencies, +(Optional, Boolean) If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. Defaults to `true`. end::field_statistics[] @@ -293,7 +293,7 @@ end::index-alias-filter[] tag::flat-settings[] `flat_settings`:: -(Optional, boolean) If `true`, returns settings in flat format. Defaults to +(Optional, Boolean) If `true`, returns settings in flat format. Defaults to `false`. end::flat-settings[] @@ -365,7 +365,7 @@ end::cat-h[] tag::help[] `help`:: -(Optional, boolean) If `true`, the response includes help information. Defaults +(Optional, Boolean) If `true`, the response includes help information. Defaults to `false`. end::help[] @@ -390,13 +390,13 @@ end::if_seq_no[] tag::ignore_throttled[] `ignore_throttled`:: -(Optional, boolean) If `true`, concrete, expanded or aliased indices are +(Optional, Boolean) If `true`, concrete, expanded or aliased indices are ignored when frozen. Defaults to `true`. end::ignore_throttled[] tag::index-ignore-unavailable[] `ignore_unavailable`:: -(Optional, boolean) If `true`, missing or closed indices are not included in the +(Optional, Boolean) If `true`, missing or closed indices are not included in the response. Defaults to `false`. end::index-ignore-unavailable[] @@ -408,7 +408,7 @@ end::include-defaults[] tag::include-segment-file-sizes[] `include_segment_file_sizes`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). Defaults to `false`. @@ -423,7 +423,7 @@ end::include-type-name[] tag::include-unloaded-segments[] `include_unloaded_segments`:: -(Optional, boolean) If `true`, the response includes information from segments +(Optional, Boolean) If `true`, the response includes information from segments that are **not** loaded into memory. Defaults to `false`. end::include-unloaded-segments[] @@ -547,7 +547,7 @@ end::component-template[] tag::lenient[] `lenient`:: -(Optional, boolean) If `true`, format-based query failures (such as +(Optional, Boolean) If `true`, format-based query failures (such as providing text to a numeric field) will be ignored. Defaults to `false`. end::lenient[] @@ -569,7 +569,7 @@ end::level[] tag::local[] `local`:: -(Optional, boolean) If `true`, the request retrieves information from the local +(Optional, Boolean) If `true`, the request retrieves information from the local node only. Defaults to `false`, which means information is retrieved from the master node. end::local[] @@ -604,7 +604,7 @@ end::memory[] tag::require-alias[] `require_alias`:: -(Optional, boolean) When true, this requires the destination to be an alias. +(Optional, Boolean) When true, this requires the destination to be an alias. Defaults to false. end::require-alias[] @@ -630,7 +630,7 @@ end::node-id-query-parm[] tag::offsets[] ``:: -(Optional, boolean) If `true`, the response includes term offsets. +(Optional, Boolean) If `true`, the response includes term offsets. Defaults to `true`. end::offsets[] @@ -650,7 +650,7 @@ end::parent-task-id[] tag::payloads[] `payloads`:: -(Optional, boolean) If `true`, the response includes term payloads. +(Optional, Boolean) If `true`, the response includes term payloads. Defaults to `true`. end::payloads[] @@ -719,7 +719,7 @@ end::pivot-group-by[] tag::positions[] `positions`:: -(Optional, boolean) If `true`, the response includes term positions. +(Optional, Boolean) If `true`, the response includes term positions. Defaults to `true`. end::positions[] @@ -750,7 +750,7 @@ end::query[] tag::realtime[] `realtime`:: -(Optional, boolean) If `true`, the request is real-time as opposed to near-real-time. +(Optional, Boolean) If `true`, the request is real-time as opposed to near-real-time. Defaults to `true`. See <>. end::realtime[] @@ -764,7 +764,7 @@ end::refresh[] tag::request_cache[] `request_cache`:: -(Optional, boolean) If `true`, the request cache is used for this request. +(Optional, Boolean) If `true`, the request cache is used for this request. Defaults to the index-level setting. end::request_cache[] @@ -952,7 +952,7 @@ end::stats[] tag::stored_fields[] `stored_fields`:: -(Optional, boolean) If `true`, retrieves the document fields stored in the +(Optional, Boolean) If `true`, retrieves the document fields stored in the index rather than the document `_source`. Defaults to `false`. end::stored_fields[] @@ -1010,7 +1010,7 @@ end::task-id[] tag::term_statistics[] `term_statistics`:: -(Optional, boolean) If `true`, the response includes term frequency and document frequency. +(Optional, Boolean) If `true`, the response includes term frequency and document frequency. Defaults to `false`. end::term_statistics[] @@ -1071,13 +1071,13 @@ end::trigger-count[] tag::cat-v[] `v`:: -(Optional, boolean) If `true`, the response includes column headings. +(Optional, Boolean) If `true`, the response includes column headings. Defaults to `false`. end::cat-v[] tag::version[] `version`:: -(Optional, boolean) If `true`, returns the document version as part of a hit. +(Optional, Boolean) If `true`, returns the document version as part of a hit. end::version[] tag::doc-version[] @@ -1112,6 +1112,6 @@ end::wait_for_active_shards[] tag::wait_for_completion[] `wait_for_completion`:: -(Optional, boolean) If `true`, the request blocks until the operation is complete. +(Optional, Boolean) If `true`, the request blocks until the operation is complete. Defaults to `true`. end::wait_for_completion[] diff --git a/docs/reference/rest-api/info.asciidoc b/docs/reference/rest-api/info.asciidoc index 675efc406f7..50c87fe99e1 100644 --- a/docs/reference/rest-api/info.asciidoc +++ b/docs/reference/rest-api/info.asciidoc @@ -31,7 +31,7 @@ The information provided by this API includes: include in the response. For example, `build,license,features`. `human`:: - (Optional, boolean) Defines whether additional human-readable information is + (Optional, Boolean) Defines whether additional human-readable information is included in the response. In particular, it adds descriptions and a tag line. The default value is `true`. diff --git a/docs/reference/rollup/apis/stop-job.asciidoc b/docs/reference/rollup/apis/stop-job.asciidoc index 11b8ee497a8..727981265cb 100644 --- a/docs/reference/rollup/apis/stop-job.asciidoc +++ b/docs/reference/rollup/apis/stop-job.asciidoc @@ -52,7 +52,7 @@ the API call itself timed out while waiting for the status change. -- `wait_for_completion`:: - (Optional, boolean) If set to `true`, causes the API to block until the + (Optional, Boolean) If set to `true`, causes the API to block until the indexer state completely stops. If set to `false`, the API returns immediately and the indexer is stopped asynchronously in the background. Defaults to `false`. diff --git a/docs/reference/search/clear-scroll-api.asciidoc b/docs/reference/search/clear-scroll-api.asciidoc index a494db6bb41..a005babfd1b 100644 --- a/docs/reference/search/clear-scroll-api.asciidoc +++ b/docs/reference/search/clear-scroll-api.asciidoc @@ -77,7 +77,7 @@ Scroll IDs to clear. To clear all scroll IDs, use `_all`. ==== {api-response-body-title} `succeeded`:: -(boolean) +(Boolean) If `true`, the request succeeded. This does not indicate whether any scrolling search requests were cleared. diff --git a/docs/reference/search/field-caps.asciidoc b/docs/reference/search/field-caps.asciidoc index 9d352273999..d0024c03a34 100644 --- a/docs/reference/search/field-caps.asciidoc +++ b/docs/reference/search/field-caps.asciidoc @@ -68,7 +68,7 @@ Defaults to `open`. 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. + (Optional, Boolean) If `true`, unmapped fields are included in the response. Defaults to `false`. [[search-field-caps-api-request-body]] diff --git a/docs/reference/search/multi-search.asciidoc b/docs/reference/search/multi-search.asciidoc index a1da1ad5a7a..254bae58fca 100644 --- a/docs/reference/search/multi-search.asciidoc +++ b/docs/reference/search/multi-search.asciidoc @@ -69,7 +69,7 @@ in a cluster, omit this parameter or use `_all` or `*`. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] `ccs_minimize_roundtrips`:: -(Optional, boolean) +(Optional, Boolean) If `true`, network roundtrips between the coordinating node and remote clusters are minimized for {ccs} requests. Defaults to `true`. See <>. @@ -79,7 +79,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] Defaults to `open`. `ignore_throttled`:: -(Optional, boolean) +(Optional, Boolean) If `true`, concrete, expanded or aliased indices are ignored when frozen. Defaults to `true`. @@ -122,7 +122,7 @@ conditions is met: - The primary sort of the query targets an indexed field. `rest_total_hits_as_int`:: -(Optional, boolean) +(Optional, Boolean) If `true`, `hits.total` are returned as an integer in the response. Defaults to `false`, which returns an object. @@ -151,7 +151,7 @@ shards. This is usually slower but more accurate. -- `typed_keys`:: -(Optional, boolean) +(Optional, Boolean) Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. @@ -172,7 +172,7 @@ line. -- `allow_no_indices`::: -(Optional, boolean) +(Optional, Boolean) If `true`, the request does *not* return an error if a wildcard expression or `_all` value retrieves only missing or closed indices. + @@ -184,7 +184,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] Defaults to `open`. `ignore_unavailable`::: -(Optional, boolean) If `true`, documents from missing or closed indices are not +(Optional, Boolean) If `true`, documents from missing or closed indices are not included in the response. Defaults to `false`. `index`::: @@ -200,7 +200,7 @@ is used as a fallback. Node or shard used to perform the search. Random by default. `request_cache`::: -(Optional, boolean) +(Optional, Boolean) If `true`, the request cache can be used for this search. Defaults to index-level settings. See <>. diff --git a/docs/reference/search/profile.asciidoc b/docs/reference/search/profile.asciidoc index 7bc73f99347..71fff8cfdca 100644 --- a/docs/reference/search/profile.asciidoc +++ b/docs/reference/search/profile.asciidoc @@ -396,7 +396,7 @@ The meaning of the stats are as follows: However, not all queries can use next_doc, so `advance` is also timed for those queries. {empty} + {empty} + - Conjunctions (e.g. `must` clauses in a boolean) are typical consumers of `advance` + Conjunctions (e.g. `must` clauses in a Boolean) are typical consumers of `advance` `match`:: diff --git a/docs/reference/search/scroll-api.asciidoc b/docs/reference/search/scroll-api.asciidoc index 50396f233e1..98627abf905 100644 --- a/docs/reference/search/scroll-api.asciidoc +++ b/docs/reference/search/scroll-api.asciidoc @@ -110,7 +110,7 @@ IMPORTANT: Scroll IDs can be long. We recommend only specifying scroll IDs using the <>. `rest_total_hits_as_int`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the API response's `hit.total` property is returned as an integer. If `false`, the API response's `hit.total` property is returned as an object. Defaults to `false`. diff --git a/docs/reference/search/search-template.asciidoc b/docs/reference/search/search-template.asciidoc index 19be9ce73fc..cf0c78bf549 100644 --- a/docs/reference/search/search-template.asciidoc +++ b/docs/reference/search/search-template.asciidoc @@ -57,17 +57,17 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] Defaults to `true`. `ccs_minimize_roundtrips`:: - (Optional, boolean) If `true`, network round-trips are minimized for + (Optional, Boolean) If `true`, network round-trips are minimized for cross-cluster search requests. Defaults to `true`. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] `explain`:: - (Optional, boolean) If `true`, the response includes additional details about + (Optional, Boolean) If `true`, the response includes additional details about score computation as part of a hit. Defaults to `false`. `ignore_throttled`:: - (Optional, boolean) If `true`, specified concrete, expanded or aliased indices + (Optional, Boolean) If `true`, specified concrete, expanded or aliased indices are not included in the response when throttled. Defaults to `true`. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] @@ -75,11 +75,11 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailab include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference] `profile`:: - (Optional, boolean) If `true`, the query execution is profiled. Defaults + (Optional, Boolean) If `true`, the query execution is profiled. Defaults to `false`. `rest_total_hits_as_int`:: - (Optional, boolean) If `true`, `hits.total` are rendered as an integer in + (Optional, Boolean) If `true`, `hits.total` are rendered as an integer in the response. Defaults to `false`. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] @@ -89,7 +89,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=scroll] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search_type] `typed_keys`:: - (Optional, boolean) If `true`, aggregation and suggester names are + (Optional, Boolean) If `true`, aggregation and suggester names are prefixed by their respective types in the response. Defaults to `false`. diff --git a/docs/reference/search/search.asciidoc b/docs/reference/search/search.asciidoc index 644a2aba5e2..853b6f57582 100644 --- a/docs/reference/search/search.asciidoc +++ b/docs/reference/search/search.asciidoc @@ -55,7 +55,7 @@ Defaults to `true`. [[search-partial-responses]] `allow_partial_search_results`:: -(Optional, boolean) +(Optional, Boolean) If `true`, returns partial results if there are request timeouts or <>. If `false`, returns an error with no partial results. Defaults to `true`. @@ -71,7 +71,7 @@ shards in the request can be large. Defaults to `512`. [[ccs-minimize-roundtrips]] `ccs_minimize_roundtrips`:: -(Optional, boolean) If `true`, network round-trips between the +(Optional, Boolean) If `true`, network round-trips between the coordinating node and the remote clusters are minimized when executing {ccs} (CCS) requests. See <>. Defaults to `true`. @@ -84,7 +84,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] Defaults to `open`. `explain`:: -(Optional, boolean) If `true`, returns detailed information about score +(Optional, Boolean) If `true`, returns detailed information about score computation as part of a hit. Defaults to `false`. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=from] @@ -94,7 +94,7 @@ By default, you cannot page through more than 10,000 hits using the `from` and <> parameter. `ignore_throttled`:: -(Optional, boolean) If `true`, concrete, expanded or aliased indices will be +(Optional, Boolean) If `true`, concrete, expanded or aliased indices will be ignored when frozen. Defaults to `true`. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] @@ -168,12 +168,12 @@ parameter in the request body. If both parameters are specified, documents matching the `query` request body parameter are not returned. `request_cache`:: -(Optional, boolean) If `true`, the caching of search results is enabled for +(Optional, Boolean) If `true`, the caching of search results is enabled for requests where `size` is `0`. See <>. Defaults to index level settings. `rest_total_hits_as_int`:: -(Optional, boolean) Indicates whether hits.total should be rendered as an +(Optional, Boolean) Indicates whether hits.total should be rendered as an integer or an object in the rest search response. Defaults to `false`. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] @@ -211,7 +211,7 @@ searches. ==== `seq_no_primary_term`:: -(Optional, boolean) If `true`, returns sequence number and primary term of the +(Optional, Boolean) If `true`, returns sequence number and primary term of the last modification of each hit. See <>. `size`:: @@ -234,11 +234,11 @@ the search response. Defaults to `true`. [%collapsible%open] ==== `true`:: -(boolean) +(Boolean) The entire document source is returned. `false`:: -(boolean) +(Boolean) The document source is not returned. ``:: @@ -281,22 +281,22 @@ for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout. `track_scores`:: -(Optional, boolean) If `true`, calculate and return document scores, even if +(Optional, Boolean) If `true`, calculate and return document scores, even if the scores are not used for sorting. Defaults to `false`. `track_total_hits`:: -(Optional, integer or boolean) +(Optional, integer or Boolean) Number of hits matching the query to count accurately. Defaults to `10000`. + If `true`, the exact number of hits is returned at the cost of some performance. If `false`, the response does not include the total number of hits matching the query. `typed_keys`:: -(Optional, boolean) If `true`, aggregation and suggester names are be prefixed +(Optional, Boolean) If `true`, aggregation and suggester names are be prefixed by their respective types in the response. Defaults to `true`. `version`:: -(Optional, boolean) +(Optional, Boolean) If `true`, returns document version as part of a hit. Defaults to `false`. [role="child_attributes"] @@ -361,7 +361,7 @@ For other field data types, this parameter is not supported. [[request-body-search-explain]] `explain`:: -(Optional, boolean) If `true`, returns detailed information about score +(Optional, Boolean) If `true`, returns detailed information about score computation as part of a hit. Defaults to `false`. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=from] @@ -401,7 +401,7 @@ lower `_score` are not included in the search results. [[request-body-search-seq-no-primary-term]] `seq_no_primary_term`:: -(Optional, boolean) If `true`, returns sequence number and primary term of the +(Optional, Boolean) If `true`, returns sequence number and primary term of the last modification of each hit. See <>. `size`:: @@ -421,11 +421,11 @@ the search response. Defaults to `true`. [%collapsible%open] ==== `true`:: -(boolean) +(Boolean) The entire document source is returned. `false`:: -(boolean) +(Boolean) The document source is not returned. ``:: @@ -474,7 +474,7 @@ request fails and returns an error. Defaults to no timeout. [[request-body-search-version]] `version`:: -(Optional, boolean) +(Optional, Boolean) If `true`, returns document version as part of a hit. Defaults to `false`. @@ -518,7 +518,7 @@ Took time does *not* include: -- `timed_out`:: -(boolean) +(Boolean) If `true`, the request timed out before completion; returned results may be partial or empty. diff --git a/docs/reference/search/validate.asciidoc b/docs/reference/search/validate.asciidoc index ba7cb0ba198..624fd039af3 100644 --- a/docs/reference/search/validate.asciidoc +++ b/docs/reference/search/validate.asciidoc @@ -42,7 +42,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=query] ==== {api-query-parms-title} `all_shards`:: - (Optional, boolean) If `true`, the validation is executed on all shards + (Optional, Boolean) If `true`, the validation is executed on all shards instead of one random shard per index. Defaults to `false`. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] @@ -60,7 +60,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=df] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] `explain`:: - (Optional, boolean) If `true`, the response returns detailed information if an + (Optional, Boolean) If `true`, the response returns detailed information if an error has occurred. Defaults to `false`. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] @@ -68,7 +68,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailab include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=lenient] `rewrite`:: - (Optional, boolean) If `true`, returns a more detailed explanation showing the + (Optional, Boolean) If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed. Defaults to `false`. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-q] diff --git a/docs/reference/settings/ilm-settings.asciidoc b/docs/reference/settings/ilm-settings.asciidoc index 38d93b37fc0..e94dc98b357 100644 --- a/docs/reference/settings/ilm-settings.asciidoc +++ b/docs/reference/settings/ilm-settings.asciidoc @@ -11,12 +11,12 @@ These are the settings available for configuring <>, boolean) +(<>, Boolean) deprecated:[7.8.0,Basic License features are always enabled] + This deprecated setting has no effect and will be removed in Elasticsearch 8.0. `indices.lifecycle.history_index_enabled`:: -(<>, boolean) +(<>, Boolean) Whether ILM's history index is enabled. If enabled, ILM will record the history of actions taken as part of ILM policies to the `ilm-history-*` indices. Defaults to `true`. @@ -30,7 +30,7 @@ These index-level {ilm-init} settings are typically configured through index templates. For more information, see <>. `index.lifecycle.indexing_complete`:: -(<>, boolean) +(<>, Boolean) Indicates whether or not the index has been rolled over. Automatically set to `true` when {ilm-init} completes the rollover action. You can explicitly set it to <>. @@ -49,7 +49,7 @@ want to use the original creation date to calculate the index age. Specified as a Unix epoch value. `index.lifecycle.parse_origination_date`:: -(<>, boolean) +(<>, Boolean) Set to `true` to parse the origination date from the index name. This origination date is used to calculate the index age for its phase transitions. The index name must match the pattern `^.*-{date_format}-\\d+`, diff --git a/docs/reference/settings/slm-settings.asciidoc b/docs/reference/settings/slm-settings.asciidoc index bc466f2121d..c5e395961ae 100644 --- a/docs/reference/settings/slm-settings.asciidoc +++ b/docs/reference/settings/slm-settings.asciidoc @@ -13,7 +13,7 @@ These are the settings available for configuring [[slm-history-index-enabled]] `slm.history_index_enabled`:: -(<>, boolean) +(<>, Boolean) Controls whether {slm-init} records the history of actions taken as part of {slm-init} policies to the `slm-history-*` indices. Defaults to `true`. diff --git a/docs/reference/slm/apis/slm-put.asciidoc b/docs/reference/slm/apis/slm-put.asciidoc index 6c531c7da1e..b185ed82b3f 100644 --- a/docs/reference/slm/apis/slm-put.asciidoc +++ b/docs/reference/slm/apis/slm-put.asciidoc @@ -55,12 +55,12 @@ Configuration for each snapshot created by the policy. [%collapsible%open] ==== `ignore_unavailable`:: -(Optional, boolean) +(Optional, Boolean) If `true`, missing data streams or indices do *not* cause snapshot creation to fail and return an error. Defaults to `false`. `include_global_state`:: -(Optional, boolean) +(Optional, Boolean) If `true`, cluster states are included in snapshots. Defaults to `false`. `indices`:: diff --git a/docs/reference/snapshot-restore/apis/create-snapshot-api.asciidoc b/docs/reference/snapshot-restore/apis/create-snapshot-api.asciidoc index e6e05f83bf3..8a4971a5c50 100644 --- a/docs/reference/snapshot-restore/apis/create-snapshot-api.asciidoc +++ b/docs/reference/snapshot-restore/apis/create-snapshot-api.asciidoc @@ -75,7 +75,7 @@ Name of the snapshot to create. This name must be unique in the snapshot reposit ==== {api-request-body-title} `ignore_unavailable`:: -(Optional, boolean) +(Optional, Boolean) If `false`, the request returns an error for any data stream or index that is missing or closed. Defaults to `false`. + If `true`, the request ignores data streams and indices in `indices` that are missing or closed. @@ -91,7 +91,7 @@ argument is provided, the snapshot only includes the specified data streams and `include_global_state`:: + -- -(Optional, boolean) +(Optional, Boolean) If `true`, the current cluster state is included in the snapshot. Defaults to `true`. @@ -114,13 +114,13 @@ Attaches arbitrary metadata to the snapshot, such as a record of who took the sn [[create-snapshot-api-partial]] `partial`:: -(Optional, boolean) +(Optional, Boolean) If `false`, the entire snapshot will fail if one or more indices included in the snapshot do not have all primary shards available. Defaults to `false`. + If `true`, allows taking a partial snapshot of indices with unavailable shards. `wait_for_completion`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the request returns a response when the snapshot is complete. If `false`, the request returns a response when the snapshot initializes. Defaults to `false`. diff --git a/docs/reference/snapshot-restore/apis/get-repo-api.asciidoc b/docs/reference/snapshot-restore/apis/get-repo-api.asciidoc index 6d34ce600d9..3ea15aa8793 100644 --- a/docs/reference/snapshot-restore/apis/get-repo-api.asciidoc +++ b/docs/reference/snapshot-restore/apis/get-repo-api.asciidoc @@ -48,7 +48,7 @@ cluster, omit this parameter or use `*` or `_all`. ==== {api-query-parms-title} `local`:: -(Optional, boolean) If `true`, the request gets information from the local node +(Optional, Boolean) If `true`, the request gets information from the local node only. If `false`, the request gets information from the master node. Defaults to `false`. diff --git a/docs/reference/snapshot-restore/apis/get-snapshot-api.asciidoc b/docs/reference/snapshot-restore/apis/get-snapshot-api.asciidoc index c65aa574193..f15dc4107a8 100644 --- a/docs/reference/snapshot-restore/apis/get-snapshot-api.asciidoc +++ b/docs/reference/snapshot-restore/apis/get-snapshot-api.asciidoc @@ -71,13 +71,13 @@ Set <> to `true` to re [[get-snapshot-api-ignore-unavailable]] `ignore_unavailable`:: -(Optional, boolean) +(Optional, Boolean) If `false`, the request returns an error for any snapshots that are unavailable. Defaults to `false`. + If `true`, the request ignores snapshots that are unavailable, such as those that are corrupted or temporarily cannot be returned. `verbose`:: -(Optional, boolean) +(Optional, Boolean) If `true`, returns all available information about a snapshot. Defaults to `true`. + If `false`, omits additional information about the snapshot, such as version information, start and end times, and the number of snapshotted shards. @@ -111,7 +111,7 @@ List of indices included in the snapshot. List of <> included in the snapshot. `include_global_state`:: -(boolean) +(Boolean) Indicates whether the current cluster state is included in the snapshot. `start_time`:: diff --git a/docs/reference/snapshot-restore/apis/get-snapshot-status-api.asciidoc b/docs/reference/snapshot-restore/apis/get-snapshot-status-api.asciidoc index 90977c7479e..b52bbd73c83 100644 --- a/docs/reference/snapshot-restore/apis/get-snapshot-status-api.asciidoc +++ b/docs/reference/snapshot-restore/apis/get-snapshot-status-api.asciidoc @@ -112,7 +112,7 @@ NOTE: Wildcard (`*`) expressions are not supported for ``. ==== {api-request-body-title} `ignore_unavailable`:: -(Optional, boolean) +(Optional, Boolean) If `false`, the request returns an error for any snapshots that are unavailable. Defaults to `false`. + If `true`, the request ignores snapshots that are unavailable, such as those that are corrupted or temporarily cannot be returned. @@ -158,7 +158,7 @@ Indicates the current snapshot state. -- `include_global_state`:: -(boolean) +(Boolean) Indicates whether the current cluster state is included in the snapshot. [[get-snapshot-status-shards-stats]] diff --git a/docs/reference/snapshot-restore/apis/put-repo-api.asciidoc b/docs/reference/snapshot-restore/apis/put-repo-api.asciidoc index afab92b5a92..a1b180980ca 100644 --- a/docs/reference/snapshot-restore/apis/put-repo-api.asciidoc +++ b/docs/reference/snapshot-restore/apis/put-repo-api.asciidoc @@ -61,7 +61,7 @@ a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to `30s`. `verify`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the request verifies the repository is functional on all master and data nodes in the cluster. If `false`, this verification is skipped. Defaults to `true`. @@ -164,7 +164,7 @@ broken down into chunks of this size or smaller. Defaults to `null` (unlimited file size). `compress`:: -(Optional, boolean) +(Optional, Boolean) If `true`, metadata files, such as index mappings and settings, are compressed in snapshots. Data files are not compressed. Defaults to `true`. @@ -184,7 +184,7 @@ that restores are also throttled through <>. Maximum snapshot creation rate per node. Defaults to `40mb` per second. `readonly`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the repository is read-only. The cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it. @@ -244,7 +244,7 @@ place of a host, path, query, or fragment in the URL. -- `verify`:: -(Optional, boolean) +(Optional, Boolean) If `true`, the request verifies the repository is functional on all master and data nodes in the cluster. If `false`, this verification is skipped. Defaults to `true`. diff --git a/docs/reference/snapshot-restore/apis/restore-snapshot-api.asciidoc b/docs/reference/snapshot-restore/apis/restore-snapshot-api.asciidoc index e72bf5ea11c..aa83ebe0eb6 100644 --- a/docs/reference/snapshot-restore/apis/restore-snapshot-api.asciidoc +++ b/docs/reference/snapshot-restore/apis/restore-snapshot-api.asciidoc @@ -101,7 +101,7 @@ Name of the snapshot to restore. ==== {api-request-body-title} `ignore_unavailable`:: -(Optional, boolean) +(Optional, Boolean) If `false`, the request returns an error for any data stream or index that is missing or closed. Defaults to `false`. + If `true`, the request ignores data streams and indices in `indices` that are missing or closed. @@ -111,7 +111,7 @@ If `true`, the request ignores data streams and indices in `indices` that are mi A comma-separated list of index settings that should not be restored from a snapshot. `include_aliases`:: -(Optional, boolean) +(Optional, Boolean) If `true`, index aliases from the original snapshot are restored. Defaults to `true`. + @@ -122,7 +122,7 @@ indices. `include_global_state`:: + -- -(Optional, boolean) +(Optional, Boolean) If `false`, the cluster state is not restored. Defaults to `false`. If `true`, the current cluster state is included in the restore operation. @@ -160,7 +160,7 @@ argument is provided, the restore operation only includes the specified data str [[restore-snapshot-api-partial]] `partial`:: -(Optional, boolean) +(Optional, Boolean) If `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available. Defaults to `false`. + If `true`, allows restoring a partial snapshot of indices with unavailable shards. Only shards that were successfully included in the snapshot @@ -185,7 +185,7 @@ include::{es-ref-dir}/snapshot-restore/restore-snapshot.asciidoc[tag=rename-rest Defines the rename replacement string. See <> for more information. `wait_for_completion`:: -(Optional, boolean) +(Optional, Boolean) If `false`, the request returns a response when the restore operation initializes. Defaults to `false`. + diff --git a/docs/reference/transform/apis/delete-transform.asciidoc b/docs/reference/transform/apis/delete-transform.asciidoc index a9911f74932..d15be858846 100644 --- a/docs/reference/transform/apis/delete-transform.asciidoc +++ b/docs/reference/transform/apis/delete-transform.asciidoc @@ -41,7 +41,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id] == {api-query-parms-title} `force`:: -(Optional, boolean) When `true`, the {transform} is deleted regardless of its +(Optional, Boolean) When `true`, the {transform} is deleted regardless of its current state. The default value is `false`, meaning that the {transform} must be `stopped` before it can be deleted. diff --git a/docs/reference/transform/apis/get-transform-stats.asciidoc b/docs/reference/transform/apis/get-transform-stats.asciidoc index ceb1a7d194d..75135801d89 100644 --- a/docs/reference/transform/apis/get-transform-stats.asciidoc +++ b/docs/reference/transform/apis/get-transform-stats.asciidoc @@ -60,7 +60,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id-wildcard] == {api-query-parms-title} `allow_no_match`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-match-transforms1] `from`:: diff --git a/docs/reference/transform/apis/get-transform.asciidoc b/docs/reference/transform/apis/get-transform.asciidoc index 939bc59413d..8f9e63a0722 100644 --- a/docs/reference/transform/apis/get-transform.asciidoc +++ b/docs/reference/transform/apis/get-transform.asciidoc @@ -54,7 +54,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id-wildcard] == {api-query-parms-title} `allow_no_match`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-match-transforms1] `from`:: diff --git a/docs/reference/transform/apis/put-transform.asciidoc b/docs/reference/transform/apis/put-transform.asciidoc index e7b9309204b..54a7c4d635a 100644 --- a/docs/reference/transform/apis/put-transform.asciidoc +++ b/docs/reference/transform/apis/put-transform.asciidoc @@ -72,7 +72,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id] == {api-query-parms-title} `defer_validation`:: - (Optional, boolean) When `true`, deferrable validations are not run. This + (Optional, Boolean) When `true`, deferrable validations are not run. This behavior may be desired if the source index does not exist until after the {transform} is created. diff --git a/docs/reference/transform/apis/stop-transform.asciidoc b/docs/reference/transform/apis/stop-transform.asciidoc index b02f441fced..66c4a4fb90c 100644 --- a/docs/reference/transform/apis/stop-transform.asciidoc +++ b/docs/reference/transform/apis/stop-transform.asciidoc @@ -54,11 +54,11 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id] == {api-query-parms-title} `allow_no_match`:: -(Optional, boolean) +(Optional, Boolean) include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-match-transforms2] `force`:: - (Optional, boolean) Set to `true` to stop a failed {transform} or to + (Optional, Boolean) Set to `true` to stop a failed {transform} or to forcefully stop a {transform} that did not respond to the initial stop request. @@ -71,12 +71,12 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-match-transfo call itself timed out while waiting for the status change. Defaults to `30s` `wait_for_completion`:: - (Optional, boolean) If set to `true`, causes the API to block until the indexer + (Optional, Boolean) If set to `true`, causes the API to block until the indexer state completely stops. If set to `false`, the API returns immediately and the indexer will be stopped asynchronously in the background. Defaults to `false`. `wait_for_checkpoint`:: - (Optional, boolean) If set to `true`, the transform will not completely stop + (Optional, Boolean) If set to `true`, the transform will not completely stop until the current checkpoint is completed. If set to `false`, the {transform} stops as soon as possible. Defaults to `false`. diff --git a/docs/reference/transform/apis/update-transform.asciidoc b/docs/reference/transform/apis/update-transform.asciidoc index e67a138896e..be1ebbc38c1 100644 --- a/docs/reference/transform/apis/update-transform.asciidoc +++ b/docs/reference/transform/apis/update-transform.asciidoc @@ -68,7 +68,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id] == {api-query-parms-title} `defer_validation`:: - (Optional, boolean) When `true`, deferrable validations are not run. This + (Optional, Boolean) When `true`, deferrable validations are not run. This behavior may be desired if the source index does not exist until after the {transform} is updated. diff --git a/x-pack/docs/en/rest-api/security/create-role-mappings.asciidoc b/x-pack/docs/en/rest-api/security/create-role-mappings.asciidoc index b7d1e23574f..2ac92e81a0d 100644 --- a/x-pack/docs/en/rest-api/security/create-role-mappings.asciidoc +++ b/x-pack/docs/en/rest-api/security/create-role-mappings.asciidoc @@ -79,7 +79,7 @@ The following parameters can be specified in the body of a PUT or POST request and pertain to adding a role mapping: `enabled`:: -(Required, boolean) Mappings that have `enabled` set to `false` are ignored when +(Required, Boolean) Mappings that have `enabled` set to `false` are ignored when role mapping is performed. `metadata`:: diff --git a/x-pack/docs/en/rest-api/security/create-users.asciidoc b/x-pack/docs/en/rest-api/security/create-users.asciidoc index 5f5640b9969..781ba82dc5b 100644 --- a/x-pack/docs/en/rest-api/security/create-users.asciidoc +++ b/x-pack/docs/en/rest-api/security/create-users.asciidoc @@ -61,7 +61,7 @@ printable symbols in the {wikipedia}/Basic_Latin_(Unicode_block)[Basic Latin (AS The following parameters can be specified in the body of a POST or PUT request: `enabled`:: -(boolean) Specifies whether the user is enabled. The default value is `true`. +(Boolean) Specifies whether the user is enabled. The default value is `true`. `email`:: (string) The email of the user. diff --git a/x-pack/docs/en/rest-api/security/get-api-keys.asciidoc b/x-pack/docs/en/rest-api/security/get-api-keys.asciidoc index b673fe94c38..ca9f90c2f69 100644 --- a/x-pack/docs/en/rest-api/security/get-api-keys.asciidoc +++ b/x-pack/docs/en/rest-api/security/get-api-keys.asciidoc @@ -46,7 +46,7 @@ used with either `id` or `name` or when `owner` flag is set to `true`. either `id` or `name` or when `owner` flag is set to `true`. `owner`:: -(Optional, boolean) A boolean flag that can be used to query API keys owned +(Optional, Boolean) A boolean flag that can be used to query API keys owned by the currently authenticated user. Defaults to false. The 'realm_name' or 'username' parameters cannot be specified when this parameter is set to 'true' as they are assumed to be the currently authenticated ones. diff --git a/x-pack/docs/en/rest-api/security/has-privileges.asciidoc b/x-pack/docs/en/rest-api/security/has-privileges.asciidoc index c5091992e0a..0f5ba47289d 100644 --- a/x-pack/docs/en/rest-api/security/has-privileges.asciidoc +++ b/x-pack/docs/en/rest-api/security/has-privileges.asciidoc @@ -39,7 +39,7 @@ privilege is assigned to the user. `index`:: `names`::: (list) A list of indices. -`allow_restricted_indices`::: (boolean) This needs to be set to `true` (default +`allow_restricted_indices`::: (Boolean) This needs to be set to `true` (default is `false`) if using wildcards or regexps for patterns that cover restricted indices. Implicitly, restricted indices do not match index patterns because restricted indices usually have limited privileges and including them in diff --git a/x-pack/docs/en/rest-api/security/invalidate-api-keys.asciidoc b/x-pack/docs/en/rest-api/security/invalidate-api-keys.asciidoc index 0d279ba290a..64806da5c7f 100644 --- a/x-pack/docs/en/rest-api/security/invalidate-api-keys.asciidoc +++ b/x-pack/docs/en/rest-api/security/invalidate-api-keys.asciidoc @@ -51,7 +51,7 @@ used with either `id` or `name` or when `owner` flag is set to `true`. either `id` or `name` or when `owner` flag is set to `true`. `owner`:: -(Optional, boolean) A boolean flag that can be used to query API keys owned +(Optional, Boolean) A boolean flag that can be used to query API keys owned by the currently authenticated user. Defaults to false. The 'realm_name' or 'username' parameters cannot be specified when this parameter is set to 'true' as they are assumed to be the currently authenticated ones. diff --git a/x-pack/docs/en/rest-api/security/role-mapping-resources.asciidoc b/x-pack/docs/en/rest-api/security/role-mapping-resources.asciidoc index be3454d3e3e..4c9ed582b67 100644 --- a/x-pack/docs/en/rest-api/security/role-mapping-resources.asciidoc +++ b/x-pack/docs/en/rest-api/security/role-mapping-resources.asciidoc @@ -5,7 +5,7 @@ A role mapping resource has the following properties: `enabled`:: -(boolean) Mappings that have `enabled` set to `false` are ignored when role +(Boolean) Mappings that have `enabled` set to `false` are ignored when role mapping is performed. `metadata`:: diff --git a/x-pack/docs/en/rest-api/security/ssl.asciidoc b/x-pack/docs/en/rest-api/security/ssl.asciidoc index 7ce2ff65df3..9e56d592f31 100644 --- a/x-pack/docs/en/rest-api/security/ssl.asciidoc +++ b/x-pack/docs/en/rest-api/security/ssl.asciidoc @@ -68,7 +68,7 @@ single certificate. The fields in each object are: `subject_dn`:: (string) The Distinguished Name of the certificate's subject. `serial_number`:: (string) The hexadecimal representation of the certificate's serial number. -`has_private_key`:: (boolean) If {es} has access to the private key for this +`has_private_key`:: (Boolean) If {es} has access to the private key for this certificate, this field has a value of `true`. `expiry`:: (string) The ISO formatted date of the certificate's expiry (not-after) date. diff --git a/x-pack/docs/en/rest-api/watcher/execute-watch.asciidoc b/x-pack/docs/en/rest-api/watcher/execute-watch.asciidoc index 3a98a4c547f..a558d5bdb46 100644 --- a/x-pack/docs/en/rest-api/watcher/execute-watch.asciidoc +++ b/x-pack/docs/en/rest-api/watcher/execute-watch.asciidoc @@ -49,7 +49,7 @@ and debugging your watches prior to adding them to {watcher}. ==== {api-query-parms-title} `debug`:: - (Optional, boolean) Defines whether the watch runs in debug mode. The default + (Optional, Boolean) Defines whether the watch runs in debug mode. The default value is `false`. [[watcher-api-execute-watch-request-body]] diff --git a/x-pack/docs/en/rest-api/watcher/put-watch.asciidoc b/x-pack/docs/en/rest-api/watcher/put-watch.asciidoc index b5aafa86705..3e610ffd880 100644 --- a/x-pack/docs/en/rest-api/watcher/put-watch.asciidoc +++ b/x-pack/docs/en/rest-api/watcher/put-watch.asciidoc @@ -53,7 +53,7 @@ is executed. ==== {api-query-parms-title} `active`:: - (Optional, boolean) Defines whether the watch is active or inactive by default. + (Optional, Boolean) Defines whether the watch is active or inactive by default. The default value is `true`, which means the watch is active by default. [[watcher-api-put-watch-request-body]] diff --git a/x-pack/docs/en/rest-api/watcher/stats.asciidoc b/x-pack/docs/en/rest-api/watcher/stats.asciidoc index afc3191ae9b..2dbca69a676 100644 --- a/x-pack/docs/en/rest-api/watcher/stats.asciidoc +++ b/x-pack/docs/en/rest-api/watcher/stats.asciidoc @@ -29,7 +29,7 @@ this API. For more information, see ==== {api-path-parms-title} `emit_stacktraces`:: - (Optional, boolean) Defines whether stack traces are generated for each watch + (Optional, Boolean) Defines whether stack traces are generated for each watch that is running. The default value is `false`. ``:: diff --git a/x-pack/plugin/identity-provider/docs/en/rest-api/idp-saml-register-sp.asciidoc b/x-pack/plugin/identity-provider/docs/en/rest-api/idp-saml-register-sp.asciidoc index 66c59486f5b..3a66a0c33d9 100644 --- a/x-pack/plugin/identity-provider/docs/en/rest-api/idp-saml-register-sp.asciidoc +++ b/x-pack/plugin/identity-provider/docs/en/rest-api/idp-saml-register-sp.asciidoc @@ -53,7 +53,7 @@ If set, it must match the value that is passed in the URL parameter. (Required, string) The assertion consumer service URL of the service provider. `enabled`:: -(Optional, boolean) Defines whether this service provider is enabled or not. Defaults to `true`. +(Optional, Boolean) Defines whether this service provider is enabled or not. Defaults to `true`. `name_id_format`:: (Optional, string) The SAML NameID Format that this service provider wants the NameIDs of the authenticating users to have in the SAML