diff options
| author |  SebastiaanZ <[email protected]> | 2019-04-27 17:33:39 +0200 |
|---|---|---|
| committer | SebastiaanZ <[email protected]> | 2019-04-27 17:33:39 +0200 |
| commit | 32c5307bfe4c3421d90891be53b4704de626e8a8 (patch) | |
| tree | 74e946dd5841fae27318b9b9e13ff9fd927c1053 /pydis_site | |
| parent | Finalizing and adding documentation to the nomination endpoint and simplifyin... (diff) | |
Documentation: Clarifying infraction query parameters and adding ordering parameter
Diffstat (limited to 'pydis_site')
| -rw-r--r-- | pydis_site/apps/api/viewsets/bot/infraction.py | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/pydis_site/apps/api/viewsets/bot/infraction.py b/pydis_site/apps/api/viewsets/bot/infraction.py index 8a279bc4..d12f0862 100644 --- a/pydis_site/apps/api/viewsets/bot/infraction.py +++ b/pydis_site/apps/api/viewsets/bot/infraction.py @@ -28,11 +28,12 @@ class InfractionViewSet(CreateModelMixin, RetrieveModelMixin, ListModelMixin, Ge #### Query parameters - **active** `bool`: whether the infraction is still active - - **actor** `int`: snowflake of the user which applied the infraction + - **actor__id** `int`: snowflake of the user which applied the infraction - **hidden** `bool`: whether the infraction is a shadow infraction - **search** `str`: regular expression applied to the infraction's reason - **type** `str`: the type of the infraction - - **user** `int`: snowflake of the user to which the infraction was applied + - **user__id** `int`: snowflake of the user to which the infraction was applied + - **ordering** `str`: comma-separated sequence of fields to order the returned results Invalid query parameters are ignored. |