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.

Sign up for GitHub

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

Filtering for boolean #336

Merged
merged 4 commits into from
Nov 28, 2024
Merged

Filtering for boolean #336

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f1507c5
Filtering for boolean
rartych Nov 6, 2024
5af0f61
Update API-design-guidelines.md
rartych Nov 27, 2024
e9437be
Merge branch 'main' into boolean_filtering
rartych Nov 27, 2024
d0dcc7a
Update API-design-guidelines.md
rartych Nov 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions documentation/API-design-guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -923,6 +923,13 @@ And according to the filtering based on string and enums data, being searched fo
| non equal | `GET .../?name!=Jonh` |
| Contains | `GET .../?name=~Rafa` |

For boolean parameters the filter can be set for True or False value:

| **Operation** | **Strings/enums** |
|---------------|-----------------------|
| True | `GET .../?boolAttr=true` |
| False | `GET .../?boolAttr=false` |


**Additional rules**:
- The operator "`&`" is evaluated as an AND between different attributes.
Expand Down