fix: Apply field_names mapping to OpenAPI filter schema#444
Merged
Conversation
The field_names DSL was respected at runtime for filter parsing (via filter_ref_transformer) but the generated OpenAPI spec still advertised filter properties and component schema ids under the raw internal field name. A resource with field_names(title: :subject) accepted filter[subject]=... at runtime but the spec advertised filter[title]=... Route the filter property keys (attribute/calculation/aggregate) and the "-filter-<name>" component schema id through AshJsonApi.Resource.Info.field_to_json_key/2 so the spec matches runtime behavior. Relationship keys and boolean combinators are unaffected as they are not subject to field_names mapping. This also changes the filter property key type from atom to string, consistent with how the rest of the spec represents JSON:API keys. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
|
🚀 Thank you for your contribution! 🚀 |
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
2 participants
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.
The field_names DSL was respected at runtime for filter parsing (via filter_ref_transformer) but the generated OpenAPI spec still advertised filter properties and component schema ids under the raw internal field name. A resource with field_names(title: :subject) accepted filter[subject]=... at runtime but the spec advertised filter[title]=...
Route the filter property keys (attribute/calculation/aggregate) and the "-filter-" component schema id through
AshJsonApi.Resource.Info.field_to_json_key/2 so the spec matches runtime behavior. Relationship keys and boolean combinators are unaffected as they are not subject to field_names mapping.
This also changes the filter property key type from atom to string, consistent with how the rest of the spec represents JSON:API keys.
Contributor checklist
Leave anything that you believe does not apply unchecked.