docs(elasticsearch): document field name mapping - #2349
Merged
soyuka merged 2 commits intoSep 30, 2026
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes api-platform/core#8470
The page said that snake_case document fields are converted to camelCase properties automatically. That has not been true since core v2.4.3 (api-platform/core@f8bd599b0): with no configuration, field names are not converted. It also contradicted the "use camelCase" rule earlier on the same page.
This PR removes the claim and adds a "Mapping Field Names" section. It documents the two ways to map snake_case documents: the global
name_converteroption, or an Elasticsearch-only override ofapi_platform.elasticsearch.name_converter.inner_fields. It also warns that the converter renames the fields used by filters and sorting.