Skip to content

Commit

Permalink
Merge pull request #336 from rartych/boolean_filtering
Browse files Browse the repository at this point in the history
Filtering for boolean
  • Loading branch information
rartych authored Nov 28, 2024
2 parents 56ab6a3 + d0dcc7a commit a0cd134
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion documentation/API-design-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -941,13 +941,19 @@ As filtering may reveal sensitive information, privacy and security constraints

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


| **Operation** | **Strings/enums** |
| ----- | ----- |
| equal | `GET .../?type=mobile` |
| non equal | `GET .../?type!=mobile` |
| Contains | `GET .../?type=~str` |

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

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

**Additional rules**:
- The operator "`&`" is evaluated as an AND between different attributes.
- A Query Param (attribute) can contain one or n values separated by "`,`".
Expand Down

0 comments on commit a0cd134

Please sign in to comment.