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

Improve guidelines on filtering #3

Open
a-akimov opened this issue Oct 2, 2022 · 0 comments
Open

Improve guidelines on filtering #3

a-akimov opened this issue Oct 2, 2022 · 0 comments

Comments

@a-akimov
Copy link
Member

a-akimov commented Oct 2, 2022

The filtering guidelines could use some more details:

  • What the filter syntax should be. For instance, the example in the style guide uses filtering via =, but the current implementation of the Partner API supports < <= > >= iexact isnull. Is the current implementation compliant (since it uses query params like the rule states) or not (since the actual filtering syntax differs from the style guide example)?

  • How to design multi-value filters (e.g. "return invoices with the 'draft' or 'issued' status). Whether to use ?key=value1&key=value2 or ?key=value1,value2 or some other syntax.

  • Consider also mentioning what the response should be if the filter returns nothing. I guess it should be 200 ОК {"data":[]}  rather than, say, 404 Not Found.

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

No branches or pull requests

1 participant