Add /indexes/{indexUID}/fields
route to get all field names
#5718
+308
−0
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.
Summary
This PR adds a new dedicated route
/indexes/{indexUID}/fields
that returns a complete list of all field names in an index, including nested fields. This provides a lightweight alternative to the stats route for clients that only need field information without the overhead of field distribution calculations.Changes Made
1. Route Details
GET /indexes/{indexUid}/fields
["id", "title", "user.name", "user.email"]
)indexes.get
permission2. Implementation Details
FieldsIdsMap::names()
to get all field names including nested fieldsuser.profile.age
)3. Testing
fields()
method to test utilities incrates/meilisearch/tests/common/index.rs
crates/meilisearch/tests/index/stats.rs
:Example Usage
Breaking Changes
None - this is a new route that doesn't affect existing functionality.
no db change