public-mirrors/Sieve
1
0
Fork 0
mirror of https://github.com/Biarity/Sieve.git synced 2024-11-22 13:32:33 +01:00
Code Issues Projects Releases Wiki Activity

Merge branch 'master' of https://github.com/Biarity/Sieve

Browse Source
This commit is contained in:
Biarity 2018-02-08 09:13:14 +10:00
commit cd3ca59d4d
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -130,7 +130,7 @@ More formally:
* `sorts` is a comma-delimited ordered list of property names to sort by. Adding a `-` before the name switches to sorting descendingly. * `sorts` is a comma-delimited ordered list of property names to sort by. Adding a `-` before the name switches to sorting descendingly.
* `filters` is a comma-delimited list of `{Name}{Operator}{Value}` where * `filters` is a comma-delimited list of `{Name}{Operator}{Value}` where
* `{Name}` is the name of a property with the Sieve attribute or the name of a custom filter method for TEntity * `{Name}` is the name of a property with the Sieve attribute or the name of a custom filter method for TEntity
* `{Operator}` is one of the [Operators](#operators) (has to be preceeded by a space when using custom filter methods) * `{Operator}` is one of the [Operators](#operators)
* `{Value}` is the value to use for filtering * `{Value}` is the value to use for filtering
* `page` is the number of page to return * `page` is the number of page to return
* `pageSize` is the number of items returned per page * `pageSize` is the number of items returned per page
@ -138,6 +138,7 @@ More formally:
Notes: Notes:
* Don't forget to remove commas from any `{Value}` fields * Don't forget to remove commas from any `{Value}` fields
* You can have spaces anywhere except *within* `{Name}` or `{Operator}` fields * You can have spaces anywhere except *within* `{Name}` or `{Operator}` fields
* Here's a [good example on how to work with arrays](https://github.com/Biarity/Sieve/issues/2)
### Creating your own DSL ### Creating your own DSL
You can replace this DSL with your own (eg. use JSON instead) by implementing an [ISieveModel](https://github.com/Biarity/Sieve/blob/master/Sieve/Models/ISieveModel.cs). You can use the default [SieveModel](https://github.com/Biarity/Sieve/blob/master/Sieve/Models/SieveModel.cs) for reference. You can replace this DSL with your own (eg. use JSON instead) by implementing an [ISieveModel](https://github.com/Biarity/Sieve/blob/master/Sieve/Models/ISieveModel.cs). You can use the default [SieveModel](https://github.com/Biarity/Sieve/blob/master/Sieve/Models/SieveModel.cs) for reference.