Skip to content

Commit ffffc40

Browse files
committed
[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)
1 parent f80298e commit ffffc40

File tree

7 files changed

+159
-110
lines changed

7 files changed

+159
-110
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: 48 additions & 44 deletions
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
@@ -285,50 +286,53 @@ indexing-buffer,https://www.elastic.co/docs/reference/elasticsearch/configuratio
285286
index-modules-merge,https://www.elastic.co/docs/reference/elasticsearch/index-settings/merge
286287
index-settings,https://www.elastic.co/docs/reference/elasticsearch/index-settings/
287288
index-templates,https://www.elastic.co/docs/manage-data/data-store/templates
288-
index-templates-exist,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-exists-index-template
289-
index-templates-put,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-index-template
290-
index-templates-v1,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-template
291-
indices-aliases,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-update-aliases
292-
indices-aliases-exist,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-exists-alias
293-
indices-analyze,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-analyze
294-
indices-clearcache,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-clear-cache
295-
indices-clone-index,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-clone
296-
indices-close,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-close
297-
indices-component-template,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-component-template
298-
indices-create-data-stream,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-create-data-stream
299-
indices-create-index,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-create
300-
indices-delete-alias,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-delete-alias
301-
indices-delete-index,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-delete
302-
indices-delete-template,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-delete-index-template
303-
indices-delete-template-v1,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-delete-template
304-
indices-disk-usage,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-disk-usage
305-
indices-downsample-data-stream,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-downsample
306-
indices-exists,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-exists
307-
indices-flush,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-flush
308-
indices-forcemerge,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-forcemerge
309-
indices-get-alias,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-alias
310-
indices-get-field-mapping,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-mapping
311-
indices-get-index,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get
312-
indices-get-mapping,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-mapping
313-
indices-get-settings,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-settings
314-
indices-get-template,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-index-template
315-
indices-get-template-v1,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-template
316-
indices-open-close,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-open
317-
indices-put-mapping,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-mapping
318-
indices-recovery,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-recovery
319-
indices-refresh,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-refresh
320-
indices-reload-analyzers,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-reload-search-analyzers
321-
indices-resolve-cluster-api,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-resolve-cluster
322-
indices-resolve-index-api,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-resolve-index
323-
indices-rollover-index,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-rollover
324-
indices-segments,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-segments
325-
indices-shards-stores,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-shard-stores
326-
indices-shrink-index,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-shrink
327-
indices-simulate,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-simulate-index-template
328-
indices-simulate-template,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-simulate-template
329-
indices-split-index,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-split
330-
indices-stats,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-stats
331-
indices-template-exists-v1,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-exists-template
289+
index-templates-exist,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-index-template
290+
index-templates-put,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-index-template
291+
index-templates-v1,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-template
292+
indices-aliases,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-update-aliases
293+
indices-aliases-exist,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-alias
294+
indices-analyze,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-analyze
295+
indices-clearcache,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-clear-cache
296+
indices-clone-index,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-clone
297+
indices-close,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-close
298+
indices-component-template,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template
299+
indices-create-data-stream,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create-data-stream
300+
indices-create-index,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create
301+
indices-delete-alias,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-alias
302+
indices-delete-index,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete
303+
indices-delete-template,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-index-template
304+
indices-delete-template-v1,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-template
305+
indices-disk-usage,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-disk-usage
306+
indices-downsample-data-stream,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-downsample
307+
indices-exists,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists
308+
indices-flush,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-flush
309+
indices-forcemerge,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-forcemerge
310+
indices-get-alias,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-alias
311+
indices-get-data-stream-settings,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream-settings
312+
indices-get-field-mapping,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-mapping
313+
indices-get-index,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get
314+
indices-get-mapping,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-mapping
315+
indices-get-settings,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings
316+
indices-get-template,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-index-template
317+
indices-get-template-v1,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-template
318+
indices-open-close,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-open
319+
indices-put-data-stream-settings,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-stream-settings
320+
indices-put-mapping,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-mapping
321+
indices-recovery,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-recovery
322+
indices-refresh,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-refresh
323+
indices-refresh-disable,https://www.elastic.co/docs/deploy-manage/production-guidance/optimize-performance/indexing-speed#disable-refresh-interval
324+
indices-reload-analyzers,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-reload-search-analyzers
325+
indices-resolve-cluster-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster
326+
indices-resolve-index-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-index
327+
indices-rollover-index,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-rollover
328+
indices-segments,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-segments
329+
indices-shards-stores,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-shard-stores
330+
indices-shrink-index,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-shrink
331+
indices-simulate,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-simulate-index-template
332+
indices-simulate-template,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-simulate-template
333+
indices-split-index,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-split
334+
indices-stats,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-stats
335+
indices-template-exists-v1,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-template
332336
indices-templates,https://www.elastic.co/docs/manage-data/data-store/templates
333337
indices-update-settings,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-settings
334338
infer-trained-model,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-infer-trained-model

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)