Skip to content
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

query-parameters.md standards alignment #53

Merged
merged 4 commits into from
Mar 19, 2021
Merged

query-parameters.md standards alignment #53

merged 4 commits into from
Mar 19, 2021

Conversation

TimGoodwill
Copy link

@TimGoodwill TimGoodwill commented Sep 23, 2020

Update query-parameters.md filtering and output selection keyword to align with previous DTA standards and current international gov API standards.

The ‘attributes’ keyword is an unusual choice for output selection. Sparse fieldsets (‘fields’) is a flexible, widely used and well understood mechanism (Google, JSON-API), and is used in the previous DTA API standards, the WhiteHouse API standards and the NZ gov API standards. The fields keyword does not rely on dependant keywords, and 'plays nicely' with multiple independent parameters. ‘filter’ (rather than 'filters') is a prevalent industry standard (Microsoft, Google, OData), and should use OData syntax to support existing filter string parsing libraries, negate the need to escape reserved chars, and disambiguate the '=' char.
Issue #25 Issue #42 Issue #43

Update query-parameters.md filtering and output selection keyword to align with previous DTA standards and current international gov API standards
@TimGoodwill TimGoodwill mentioned this pull request Sep 24, 2020
Reference OData query standard.
Copy link

@jordanwalsh23 jordanwalsh23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is approved to be merged into the v1.1.0 release.

@ghost
Copy link

ghost commented Nov 23, 2020

Good to see references to oData querying syntax for the Advanced Filtering, but all filtering should follow the industry OData 4.0 standard.

We really shouldn't be creating our own bespoke non-interoperable standard. It would be better to abstain if there is no consensus to use OData

@TimGoodwill
Copy link
Author

TimGoodwill commented Nov 24, 2020

Good to see references to oData querying syntax for the Advanced Filtering, but all filtering should follow the industry OData 4.0 standard.

Updated to ref OData 4.0

We really shouldn't be creating our own bespoke non-interoperable standard. It would be better to abstain if there is no consensus to use OData

There is no impediment to individual agencies implementing OData in its entirety, however that is a huge commitment. Certainly embedding the OData standard is a discussion for another phase. This is an amendment is to ensure that if limited complex filtering is to be offered, the filter keyword and syntax is broadly compatible with OData and common practice.

@colugo colugo merged commit fdd0f22 into apigovau:master Mar 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants