-
Notifications
You must be signed in to change notification settings - Fork 4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Remove recommendation to use fully-qualified property names as queryables #31
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Big 👍🏼 on this, I've bumped in to inconsistencies in implementations w.r.t. properties.
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, it should be custom queryables always, no properties.
This probably caried over from the other specs, e.g. fields, sort or query. (We should also add sortables to the sort extension).
Good thing for the removal of contradictory text. At least it is clear about the expectation. However, I'm concerned about usability from a user's perspective. I believe the It is very confusing to have a mixture of query parameters that do not operate "at the same root level" of the JSON document within the same request, although referring to the same properties position within the document. For example, filtering by Another point that is also problematic is regarding the use of |
filter only works on queryables. Those queryable names can be chosen to be aligned with the other extensions or not, but it's up to the implementor to decide that. Sort get's something similar, sortables. Fields is a bit different in that you need to directly tell the location of the propertes, so it's expected to be slightly different. I don't see much of an issue here, I think. |
Wouldn't that make the removed recommendation "It is recommended to use fully-qualified property names (e.g., As it stands, even unqualified properties would be invalid if they are not in queryables. Regardless of what the recommendation says, the choice remains in the hands of the implementer, but it seems a pretty convenient approach to facilitate usage across extensions if they are fully-qualified. I don't think most users would be aware of the subtlety of fields by location vs sortby/filter by sortable/queryables when seeing similar property names within the request. |
Related Issue(s):
Proposed Changes:
PR Checklist: