-
Notifications
You must be signed in to change notification settings - Fork 352
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
Support no-$ for system query parameters in OData library. #637
Comments
cpham97
pushed a commit
to cpham97/odata.net
that referenced
this issue
Jul 15, 2016
LaylaLiu
pushed a commit
to LaylaLiu/odata.net
that referenced
this issue
Jul 19, 2016
LaylaLiu
pushed a commit
to LaylaLiu/odata.net
that referenced
this issue
Jul 19, 2016
LaylaLiu
pushed a commit
to LaylaLiu/odata.net
that referenced
this issue
Jul 19, 2016
LaylaLiu
pushed a commit
to LaylaLiu/odata.net
that referenced
this issue
Jul 20, 2016
LaylaLiu
pushed a commit
to LaylaLiu/odata.net
that referenced
this issue
Jul 28, 2016
LaylaLiu
pushed a commit
to LaylaLiu/odata.net
that referenced
this issue
Jul 28, 2016
Closed per #639 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Rationale
OData makes liberal use of the '$' sign prefix for its system query parameters. Customers across several of our REST APIs have expressed distaste for this atypical formation, and also expressed that this stops them from using Microsoft APIs inside 3rd party tooling that tends to define query parameters particularly as having a syntax similar to typical programming language identifiers (e.g., something like [a-zA-Z][a-zA-Z0-9]* ). Therefore, making '$' sign prefix of system query parameters become optional would be significant tool unblocker and delighter.
Assemblies affected
OData .Net lib 6.16.
Change proposal
All '$' signs in system query parameters after the '?' should become optional.
Here is an example of a complex query using OData query parameters to their fullest, nested form:
GET www.onenote.com/api/beta/Notebooks?expand=sections,sectionGroups(expand=sections,sectionGroups(levels=max;expand=sections))
should yield same result as
GET www.onenote.com/api/beta/Notebooks?$expand=sections,sectionGroups($expand=sections,sectionGroups($levels=max;$expand=sections))
Additional details
It's important to note that the standard-compliant '$' prefix syntax for system query parameters must not be affected by this change, but rather an additional and simpler syntax is being added. The support MUST be opt-in for the library consumer.
The text was updated successfully, but these errors were encountered: