Skip to content

Commit 0a74241

Browse files
committed
Link to examples in the update mapping API guide
1 parent 2db36bf commit 0a74241

File tree

4 files changed

+20
-36
lines changed

4 files changed

+20
-36
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 3 additions & 2 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: 2 additions & 2 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: 4 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/indices/put_mapping/IndicesPutMappingRequest.ts

Lines changed: 11 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -41,33 +41,17 @@ import { Dictionary, SingleKeyDictionary } from '@spec_utils/Dictionary'
4141
/**
4242
* Update field mappings.
4343
* Add new fields to an existing data stream or index.
44-
* You can also use this API to change the search settings of existing fields and add new properties to existing object fields.
45-
* For data streams, these changes are applied to all backing indices by default.
46-
*
47-
* **Add multi-fields to an existing field**
48-
*
49-
* Multi-fields let you index the same field in different ways.
50-
* You can use this API to update the fields mapping parameter and enable multi-fields for an existing field.
51-
* WARNING: If an index (or data stream) contains documents when you add a multi-field, those documents will not have values for the new multi-field.
52-
* You can populate the new multi-field with the update by query API.
53-
*
54-
* **Change supported mapping parameters for an existing field**
55-
*
56-
* The documentation for each mapping parameter indicates whether you can update it for an existing field using this API.
57-
* For example, you can use the update mapping API to update the `ignore_above` parameter.
58-
*
59-
* **Change the mapping of an existing field**
60-
*
61-
* Except for supported mapping parameters, you can't change the mapping or field type of an existing field.
62-
* Changing an existing field could invalidate data that's already indexed.
63-
*
64-
* If you need to change the mapping of a field in a data stream's backing indices, refer to documentation about modifying data streams.
65-
* If you need to change the mapping of a field in other indices, create a new index with the correct mapping and reindex your data into that index.
66-
*
67-
* **Rename a field**
68-
*
69-
* Renaming a field would invalidate data already indexed under the old field name.
70-
* Instead, add an alias field to create an alternate field name.
44+
* You can use the update mapping API to:
45+
46+
* - Add a new field to an existing index
47+
* - Update mappings for multiple indices in a single request
48+
* - Add new properties to an object field
49+
* - Enable multi-fields for an existing field
50+
* - Update supported mapping parameters
51+
* - Change a field's mapping using reindexing
52+
* - Rename a field using a field alias
53+
*
54+
* Learn how to use the update mapping API with practical examples in the [Update mapping API examples](https://www.elastic.co/docs//manage-data/data-store/mapping/update-mappings-examples) guide.
7155
* @rest_spec_name indices.put_mapping
7256
* @availability stack stability=stable
7357
* @availability serverless stability=stable visibility=public

0 commit comments

Comments
 (0)