Skip to content

Commit f83ceb0

Browse files
committed
```
Add ext_doc_id annotations for refresh and analyzer settings - Add indices-refresh-disable and analyzer-update-existing to doc IDs table - Link IndexSettings to analyzer update documentation - Link IndicesPutSettingsRequest to both refresh disable and analyzer update docs - Add explanatory text pointing users to linked documentation examples ```
1 parent 291ffd3 commit f83ceb0

File tree

3 files changed

+8
-0
lines changed

3 files changed

+8
-0
lines changed

specification/_doc_ids/table.csv

Lines changed: 2 additions & 0 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/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
@@ -319,6 +320,7 @@ indices-put-data-stream-settings,https://www.elastic.co/docs/api/doc/elasticsear
319320
indices-put-mapping,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-mapping
320321
indices-recovery,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-recovery
321322
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
322324
indices-reload-analyzers,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-reload-search-analyzers
323325
indices-resolve-cluster-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster
324326
indices-resolve-index-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-index

specification/indices/_types/IndexSettings.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ export class RetentionLease {
7070
/**
7171
* @doc_id index-modules-settings
7272
* @ext_doc_id index-settings
73+
* @ext_doc_id analyzer-update-existing
7374
* @behavior_meta AdditionalProperties fieldname=other_settings description="Additional settings not covered in this type."
7475
*/
7576
export class IndexSettings

specification/indices/put_settings/IndicesPutSettingsRequest.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ 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+
* For performance optimization during bulk indexing, you can disable the refresh interval.
35+
* Refer to the linked documentation for an example.
3436
* There are multiple valid ways to represent index settings in the request body. You can specify only the setting, for example:
3537
*
3638
* ```
@@ -75,12 +77,15 @@ 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 the linked documentation for step-by-step examples of updating analyzers on existing indices.
7881
* @rest_spec_name indices.put_settings
7982
* @availability stack stability=stable
8083
* @availability serverless stability=stable visibility=public
8184
* @index_privileges manage
8285
* @doc_id indices-update-settings
8386
* @ext_doc_id index-settings
87+
* @ext_doc_id indices-refresh-disable
88+
* @ext_doc_id analyzer-update-existing
8489
*/
8590
export interface Request extends RequestBase {
8691
urls: [

0 commit comments

Comments
 (0)