Skip to content

Commit ab247d6

Browse files
authored
[BACKPORT 9.0][DOCS] Add links for longer-form examples for refresh and analyzer updates (#4525 (#4540)
* [DOCS] Add links for longer-form examples for refresh and analyzer updates (#4525) - link bulk request to refresh disable docs - link analyze settings to analyzer update docs - use markdown links in PUT settings to avoid duplicates - add contextual verbiage pointing to linked docs (cherry picked from commit f1305c4) * fix unintended link changes in csv file
1 parent 5aa4fd1 commit ab247d6

File tree

7 files changed

+114
-67
lines changed

7 files changed

+114
-67
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 18 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/openapi/elasticsearch-serverless-openapi.json

Lines changed: 24 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 59 additions & 55 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/_doc_ids/table.csv

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ analysis-tokenizers,https://www.elastic.co/docs/reference/text-analysis/tokenize
1414
analysis,https://www.elastic.co/docs/manage-data/data-store/text-analysis
1515
analyze-repository,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-repository-analyze
1616
analyzer-anatomy,https://www.elastic.co/docs/manage-data/data-store/text-analysis/anatomy-of-an-analyzer
17+
analyzer-update-existing,https://www.elastic.co/docs/manage-data/data-store/text-analysis/specify-an-analyzer#update-analyzers-on-existing-indices
1718
anthropic-messages,https://docs.anthropic.com/en/api/messages
1819
anthropic-models,https://docs.anthropic.com/en/docs/about-claude/models/all-models#model-names
1920
api-date-math-index-names,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/api-conventions#api-date-math-index-names
@@ -317,6 +318,7 @@ indices-open-close,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operatio
317318
indices-put-mapping,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-mapping
318319
indices-recovery,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-recovery
319320
indices-refresh,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-refresh
321+
indices-refresh-disable,https://www.elastic.co/docs/deploy-manage/production-guidance/optimize-performance/indexing-speed#disable-refresh-interval
320322
indices-reload-analyzers,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-reload-search-analyzers
321323
indices-resolve-cluster-api,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-resolve-cluster
322324
indices-resolve-index-api,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-resolve-index
@@ -911,4 +913,4 @@ watcher-api-update-settings,https://www.elastic.co/docs/api/doc/elasticsearch/v9
911913
watsonx-api-keys,https://cloud.ibm.com/iam/apikeys
912914
watsonx-api-models,https://www.ibm.com/products/watsonx-ai/foundation-models
913915
watsonx-api-version,https://cloud.ibm.com/apidocs/watsonx-ai#active-version-dates
914-
xpack-rollup,https://www.elastic.co/docs/manage-data/lifecycle/rollup
916+
xpack-rollup,https://www.elastic.co/docs/manage-data/lifecycle/rollup

specification/_global/bulk/BulkRequest.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,10 +140,14 @@ import { OperationContainer, UpdateAction } from './types'
140140
* Imagine a `_bulk?refresh=wait_for` request with three documents in it that happen to be routed to different shards in an index with five shards.
141141
* The request will only wait for those three shards to refresh.
142142
* The other two shards that make up the index do not participate in the `_bulk` request at all.
143+
*
144+
* You might want to disable the refresh interval temporarily to improve indexing throughput for large bulk requests.
145+
* Refer to the linked documentation for step-by-step instructions using the index settings API.
143146
* @rest_spec_name bulk
144147
* @availability stack stability=stable
145148
* @availability serverless stability=stable visibility=public
146149
* @doc_id docs-bulk
150+
* @ext_doc_id indices-refresh-disable
147151
* @doc_tag document
148152
*
149153
*/

specification/indices/_types/IndexSettings.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,8 @@ export class IndexSettings
125125
max_refresh_listeners?: integer
126126
/**
127127
* Settings to define analyzers, tokenizers, token filters and character filters.
128+
* Refer to the linked documentation for step-by-step examples of updating analyzers on existing indices.
129+
* @ext_doc_id analyzer-update-existing
128130
*/
129131
analyze?: SettingsAnalyze
130132
highlight?: SettingsHighlight

specification/indices/put_settings/IndicesPutSettingsRequest.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,9 @@ import { IndexSettings } from '@indices/_types/IndexSettings'
3131
* The list of per-index settings that can be updated dynamically on live indices can be found in index settings documentation.
3232
* To preserve existing settings from being updated, set the `preserve_existing` parameter to `true`.
3333
*
34-
* There are multiple valid ways to represent index settings in the request body. You can specify only the setting, for example:
34+
* For performance optimization during bulk indexing, you can disable the refresh interval.
35+
* Refer to [disable refresh interval](https://www.elastic.co/docs/deploy-manage/production-guidance/optimize-performance/indexing-speed#disable-refresh-interval) for an example.
36+
* There are multiple valid ways to represent index settings in the request body. You can specify only the setting, for example:
3537
*
3638
* ```
3739
* {
@@ -75,6 +77,7 @@ import { IndexSettings } from '@indices/_types/IndexSettings'
7577
* This affects searches and any new data added to the stream after the rollover.
7678
* However, it does not affect the data stream's backing indices or their existing data.
7779
* To change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it.
80+
* Refer to [updating analyzers on existing indices](https://www.elastic.co/docs/manage-data/data-store/text-analysis/specify-an-analyzer#update-analyzers-on-existing-indices) for step-by-step examples.
7881
* @rest_spec_name indices.put_settings
7982
* @availability stack stability=stable
8083
* @availability serverless stability=stable visibility=public

0 commit comments

Comments
 (0)