Skip to content

Commit a0cd134

Browse files
authored
Merge pull request #336 from rartych/boolean_filtering
Filtering for boolean
2 parents 56ab6a3 + d0dcc7a commit a0cd134

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

documentation/API-design-guidelines.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -941,13 +941,19 @@ As filtering may reveal sensitive information, privacy and security constraints
941941

942942
And according to the filtering based on string and enums data, being searched for:
943943

944-
945944
| **Operation** | **Strings/enums** |
946945
| ----- | ----- |
947946
| equal | `GET .../?type=mobile` |
948947
| non equal | `GET .../?type!=mobile` |
949948
| Contains | `GET .../?type=~str` |
950949

950+
For boolean parameters the filter can be set for True or False value:
951+
952+
| **Operation** | **Booleans** |
953+
|---------------|-----------------------|
954+
| True | `GET .../?boolAttr=true` |
955+
| False | `GET .../?boolAttr=false` |
956+
951957
**Additional rules**:
952958
- The operator "`&`" is evaluated as an AND between different attributes.
953959
- A Query Param (attribute) can contain one or n values separated by "`,`".

0 commit comments

Comments
 (0)