Skip to content

Commit 1035317

Browse files
Anaethelionswallez
andauthored
enhance typed_keys_quirk warning usage for contributors
Co-authored-by: Sylvain Wallez <[email protected]>
1 parent 33c4619 commit 1035317

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/modeling-guide.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -334,6 +334,8 @@ An example of internal variants are the type mapping properties.
334334
335335
#### typed_keys_quirk
336336
337+
**Note**: this feature exists because of some early Elasticsearch APIs where tagging was forgotten, and added after the fact using this quirk to avoid breaking compatibility. **It should not be used for new APIs.**
338+
337339
The key that defines the variant is external to the definition, like in the
338340
case of aggregations in responses or suggesters.
339341

0 commit comments

Comments
 (0)