Add strict_allow_templates option for the dynamic mapping parameter #7745

gaobinlong · 2024-07-17T07:09:55Z

Description

In this opensearch-project/OpenSearch#14555, we introduce a new option strict_allow_templates for the dynamic mapping parameter, we need to document the usage.

Issues Resolved

Closes #7676

Version

2.16.0

Frontend features

If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.

Checklist

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: gaobinlong <gbinlong@amazon.com>

github-actions · 2024-07-17T07:10:08Z

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

Signed-off-by: gaobinlong <gbinlong@amazon.com>

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

natebower

@gaobinlong @vagimeli Please see my comments and changes and let me know if you have any questions. Thanks!

_field-types/dynamic.md

natebower · 2024-07-18T11:01:59Z

_field-types/dynamic.md

+`true`  | Specfies that new fields can be added dynamically to the mapping. Default is `true`.
+`false` | Specifies that new fields cannot be added dynamically to the mapping. If a new field is detected, then it is not indexed or searchable but can be retrieved from the `_source` field.
+`strict` | Throws an exception. The indexing operation fails when new fields are detected.
+`strict_allow_templates` | Adds new fields matching dynamic templates if the new fields match predefined dynamic templates in the mapping; otherwise, indexing fails.


Is the first phrase a bit redundant? Can it just be "Adds new fields if they match predefined dynamic templates in the mapping"?

_field-types/dynamic.md

_field-types/supported-field-types/object.md

natebower · 2024-07-18T11:36:00Z

_field-types/dynamic.md

+```
+{% include copy-curl.html %}
+
+2. Index a document with an object field `patient` containing two string fields, and a new field `room` matching the dynamic templates using the following request:


Confirm that we do not mean "one of the dynamic templates".

natebower · 2024-07-18T11:36:17Z

_field-types/dynamic.md

+```
+{% include copy-curl.html %}
+
+Indexing succeeds because the new field `room` matches the dynamic templates. However, indexing fails for the new field `floor` because it does not match the dynamic templates and is not explicitly mapped, as shown in the following response:


Confirm that we do not mean "one of the dynamic templates".

natebower · 2024-07-18T11:39:13Z

_field-types/supported-field-types/object.md

@@ -149,6 +149,7 @@ Value | Description
 `true` | New fields can be added to the mapping dynamically. This is the default.
 `false` | New fields cannot be added to the mapping dynamically. If a new field is detected, it is not indexed or searchable. However, it is still retrievable from the _source field. 
 `strict` | When new fields are added to the mapping dynamically, an exception is thrown. To add a new field to an object, you have to add it to the mapping first.
+`strict_allow_templates` | If the new detected fields can match any predefined dynamic template in the mapping, then they will be added to the mapping, if not match an exception will be thrown as same as `strict`.


Please confirm the accuracy of my rewrite. The use of "any" here is what prompted my comments re: "one of the dynamic templates" in dynamic.md.

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Make changes to address editorial review comments Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

vagimeli

Doc and editorial reviews completed. Addressed editorial feedback, including comments with suggested rewrites.

…pensearch-project#7745) * Add strict_allow_templates option for the dynamic mapping parameter Signed-off-by: gaobinlong <gbinlong@amazon.com> * Fix typo Signed-off-by: gaobinlong <gbinlong@amazon.com> * Fix header Signed-off-by: gaobinlong <gbinlong@amazon.com> * Update dynamic.md Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/supported-field-types/object.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/supported-field-types/object.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/supported-field-types/nested.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update dynamic.md Make changes to address editorial review comments Signed-off-by: Melissa Vagi <vagimeli@amazon.com> --------- Signed-off-by: gaobinlong <gbinlong@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com>

…pensearch-project#7745) * Add strict_allow_templates option for the dynamic mapping parameter Signed-off-by: gaobinlong <gbinlong@amazon.com> * Fix typo Signed-off-by: gaobinlong <gbinlong@amazon.com> * Fix header Signed-off-by: gaobinlong <gbinlong@amazon.com> * Update dynamic.md Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/supported-field-types/object.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/supported-field-types/object.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/dynamic.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _field-types/supported-field-types/nested.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update dynamic.md Make changes to address editorial review comments Signed-off-by: Melissa Vagi <vagimeli@amazon.com> --------- Signed-off-by: gaobinlong <gbinlong@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Sander van de Geijn <sandervandegeijn@icloud.com>

Add strict_allow_templates option for the dynamic mapping parameter

968048a

Signed-off-by: gaobinlong <gbinlong@amazon.com>

gaobinlong requested review from hdhalter, kolchfa-aws, Naarcha-AWS, vagimeli, AMoo-Miki, natebower, dlvenable, stephen-crawford and epugh as code owners July 17, 2024 07:09

github-actions bot assigned hdhalter Jul 17, 2024

gaobinlong added 2 commits July 17, 2024 15:17

Fix typo

27e2b62

Signed-off-by: gaobinlong <gbinlong@amazon.com>

Fix header

b08b46c

Signed-off-by: gaobinlong <gbinlong@amazon.com>

hdhalter added v2.16.0 release-notes PR: Include this PR in the automated release notes labels Jul 17, 2024

hdhalter assigned vagimeli and unassigned hdhalter Jul 17, 2024

Update dynamic.md

032d1f9

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

vagimeli added the 5 - Editorial review PR: Editorial review in progress label Jul 18, 2024

Merge branch 'main' into strict_allow_templates

4fa3811

natebower reviewed Jul 18, 2024

View reviewed changes

vagimeli and others added 8 commits July 18, 2024 09:12

Update _field-types/dynamic.md

637996f

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _field-types/dynamic.md

8c3e4c2

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _field-types/dynamic.md

4564725

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _field-types/dynamic.md

16ede9f

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _field-types/dynamic.md

e4eb343

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _field-types/dynamic.md

c0f4c76

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _field-types/dynamic.md

e043ecc

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _field-types/supported-field-types/object.md

480ee1e

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

vagimeli and others added 13 commits July 18, 2024 09:15

Update _field-types/supported-field-types/object.md

92baea1

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _field-types/dynamic.md

a23dad8

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _field-types/dynamic.md

44f2f36

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _field-types/dynamic.md

86d670f

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _field-types/dynamic.md

f27ff68

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _field-types/dynamic.md

37750a7

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _field-types/dynamic.md

445757c

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _field-types/dynamic.md

cf8b350

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _field-types/dynamic.md

d2a9abc

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _field-types/dynamic.md

c62ad9e

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _field-types/dynamic.md

dc723de

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _field-types/supported-field-types/nested.md

50ea608

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update dynamic.md

ee1953f

Make changes to address editorial review comments Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

vagimeli approved these changes Jul 18, 2024

View reviewed changes

Merge branch 'main' into strict_allow_templates

b0568fa

vagimeli merged commit 0c3dace into opensearch-project:main Jul 18, 2024
4 of 5 checks passed

hdhalter added 3 - Done Issue is done/complete and removed 5 - Editorial review PR: Editorial review in progress labels Jul 18, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add strict_allow_templates option for the dynamic mapping parameter #7745

Add strict_allow_templates option for the dynamic mapping parameter #7745

gaobinlong commented Jul 17, 2024 •

edited

Loading

github-actions bot commented Jul 17, 2024

natebower left a comment

natebower Jul 18, 2024

natebower Jul 18, 2024

natebower Jul 18, 2024

natebower Jul 18, 2024

vagimeli left a comment

Add strict_allow_templates option for the dynamic mapping parameter #7745

Add strict_allow_templates option for the dynamic mapping parameter #7745

Conversation

gaobinlong commented Jul 17, 2024 • edited Loading

Description

Issues Resolved

Version

Frontend features

Checklist

github-actions bot commented Jul 17, 2024

natebower left a comment

Choose a reason for hiding this comment

natebower Jul 18, 2024

Choose a reason for hiding this comment

natebower Jul 18, 2024

Choose a reason for hiding this comment

natebower Jul 18, 2024

Choose a reason for hiding this comment

natebower Jul 18, 2024

Choose a reason for hiding this comment

vagimeli left a comment

Choose a reason for hiding this comment

gaobinlong commented Jul 17, 2024 •

edited

Loading