Skip to content

[DOCS] Add links for longer-form examples for refresh and analyzer updates #4525

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 12, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions output/openapi/elasticsearch-openapi.json

Large diffs are not rendered by default.

24 changes: 18 additions & 6 deletions output/openapi/elasticsearch-serverless-openapi.json

Large diffs are not rendered by default.

112 changes: 58 additions & 54 deletions output/schema/schema.json

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions specification/_doc_ids/table.csv
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ analysis-tokenizers,https://www.elastic.co/docs/reference/text-analysis/tokenize
analysis,https://www.elastic.co/docs/manage-data/data-store/text-analysis
analyze-repository,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-repository-analyze
analyzer-anatomy,https://www.elastic.co/docs/manage-data/data-store/text-analysis/anatomy-of-an-analyzer
analyzer-update-existing,https://www.elastic.co/docs/manage-data/data-store/text-analysis/specify-an-analyzer#update-analyzers-on-existing-indices
anthropic-messages,https://docs.anthropic.com/en/api/messages
anthropic-models,https://docs.anthropic.com/en/docs/about-claude/models/all-models#model-names
api-date-math-index-names,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/api-conventions#api-date-math-index-names
Expand Down Expand Up @@ -320,6 +321,7 @@ indices-put-data-stream-settings,https://www.elastic.co/docs/api/doc/elasticsear
indices-put-mapping,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-mapping
indices-recovery,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-recovery
indices-refresh,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-refresh
indices-refresh-disable,https://www.elastic.co/docs/deploy-manage/production-guidance/optimize-performance/indexing-speed#disable-refresh-interval
indices-reload-analyzers,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-reload-search-analyzers
indices-resolve-cluster-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster
indices-resolve-index-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-index
Expand Down
4 changes: 4 additions & 0 deletions specification/_global/bulk/BulkRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -140,10 +140,14 @@ import { OperationContainer, UpdateAction } from './types'
* 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.
* The request will only wait for those three shards to refresh.
* The other two shards that make up the index do not participate in the `_bulk` request at all.
*
* You might want to disable the refresh interval temporarily to improve indexing throughput for large bulk requests.
* Refer to the linked documentation for step-by-step instructions using the index settings API.
* @rest_spec_name bulk
* @availability stack stability=stable
* @availability serverless stability=stable visibility=public
* @doc_id docs-bulk
* @ext_doc_id indices-refresh-disable
* @doc_tag document
*
*/
Expand Down
2 changes: 2 additions & 0 deletions specification/indices/_types/IndexSettings.ts
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,8 @@ export class IndexSettings
max_refresh_listeners?: integer
/**
* Settings to define analyzers, tokenizers, token filters and character filters.
* Refer to the linked documentation for step-by-step examples of updating analyzers on existing indices.
* @ext_doc_id analyzer-update-existing
*/
analyze?: SettingsAnalyze
highlight?: SettingsHighlight
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ import { IndexSettings } from '@indices/_types/IndexSettings'
* The list of per-index settings that can be updated dynamically on live indices can be found in index settings documentation.
* To preserve existing settings from being updated, set the `preserve_existing` parameter to `true`.
*
* There are multiple valid ways to represent index settings in the request body. You can specify only the setting, for example:
* For performance optimization during bulk indexing, you can disable the refresh interval.
* Refer to [disable refresh interval](https://www.elastic.co/docs/deploy-manage/production-guidance/optimize-performance/indexing-speed#disable-refresh-interval) for an example.
* There are multiple valid ways to represent index settings in the request body. You can specify only the setting, for example:
*
* ```
* {
Expand Down Expand Up @@ -75,6 +77,7 @@ import { IndexSettings } from '@indices/_types/IndexSettings'
* This affects searches and any new data added to the stream after the rollover.
* However, it does not affect the data stream's backing indices or their existing data.
* To change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it.
* 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.
* @rest_spec_name indices.put_settings
* @availability stack stability=stable
* @availability serverless stability=stable visibility=public
Expand Down
Loading