Skip to content

Commit 5281c4b

Browse files
committed
- 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
1 parent f83ceb0 commit 5281c4b

File tree

3 files changed

+8
-5
lines changed

3 files changed

+8
-5
lines changed

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 & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,6 @@ export class RetentionLease {
7070
/**
7171
* @doc_id index-modules-settings
7272
* @ext_doc_id index-settings
73-
* @ext_doc_id analyzer-update-existing
7473
* @behavior_meta AdditionalProperties fieldname=other_settings description="Additional settings not covered in this type."
7574
*/
7675
export class IndexSettings
@@ -126,6 +125,8 @@ export class IndexSettings
126125
max_refresh_listeners?: integer
127126
/**
128127
* 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
129130
*/
130131
analyze?: SettingsAnalyze
131132
highlight?: SettingsHighlight

specification/indices/put_settings/IndicesPutSettingsRequest.ts

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ import { IndexSettings } from '@indices/_types/IndexSettings'
3232
* To preserve existing settings from being updated, set the `preserve_existing` parameter to `true`.
3333
*
3434
* For performance optimization during bulk indexing, you can disable the refresh interval.
35-
* Refer to the linked documentation for an example.
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.
3636
* There are multiple valid ways to represent index settings in the request body. You can specify only the setting, for example:
3737
*
3838
* ```
@@ -77,15 +77,13 @@ import { IndexSettings } from '@indices/_types/IndexSettings'
7777
* This affects searches and any new data added to the stream after the rollover.
7878
* However, it does not affect the data stream's backing indices or their existing data.
7979
* To change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it.
80-
* Refer to the linked documentation for step-by-step examples of updating analyzers on existing indices.
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.
8181
* @rest_spec_name indices.put_settings
8282
* @availability stack stability=stable
8383
* @availability serverless stability=stable visibility=public
8484
* @index_privileges manage
8585
* @doc_id indices-update-settings
8686
* @ext_doc_id index-settings
87-
* @ext_doc_id indices-refresh-disable
88-
* @ext_doc_id analyzer-update-existing
8987
*/
9088
export interface Request extends RequestBase {
9189
urls: [

0 commit comments

Comments
 (0)