Skip to content

Commit 7847730

Browse files
authored
Update README.md (new minor release)
1 parent 143f339 commit 7847730

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,34 @@ I simulate the relationships of cats developing over time. Currently this serves
2222
- for authentication:
2323
- `/api/token/`:`POST`-> Get Access Token / Login
2424
- `/api/token/refresh`:`POST` -> Refresh Token
25+
26+
#### [v2.1.0](https://github.com/hannaseithe/catSim/releases/tag/v2.0.0):
27+
Added filtering, ordering and pagination to `/api/simulations/`:`GET` endpoint
28+
29+
Filters:
30+
e.g. `/api/simulations/?status=finished&user=2`
31+
- `status` match: `exact`
32+
- `user` match: `exact`
33+
- `created_at_min` match `>=` (accepts DateTime Iso Format)
34+
- `created_at_max` match `<=` (accepts DateTime Iso Format)
35+
- `iterations` match: `exact`
36+
- `iterations_min` match `>=`
37+
- `iterations_max` match `<=`
38+
- `cat_amount` match: `exact`
39+
- `cat_amount_min` match `>=`
40+
- `cat_amount_max` match `<=`
41+
- `node_amount` match: `exact`
42+
- `node_amount_min` match `>=`
43+
- `node_amount_max` match `<=`
44+
45+
Order_Fields:
46+
e.g. `/api/simulations/?ordering=iterations`
47+
- `created_at`
48+
- `iterations`
49+
- `cat_amount`
50+
- `node_amount`
51+
52+
Pagination:
53+
e.g. `/api/simulations/?page=2&page_size=20`
54+
- `page_size` defines the size of a page
55+
- `page` defines the page number

0 commit comments

Comments
 (0)