From 1286c2573426f6a252412aa8fbe7f22f07ba9a49 Mon Sep 17 00:00:00 2001 From: romanmyko Date: Mon, 21 Oct 2024 21:35:19 +0300 Subject: [PATCH] format docstring --- BackEnd/administration/views.py | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/BackEnd/administration/views.py b/BackEnd/administration/views.py index 93af6477..3d100d5f 100644 --- a/BackEnd/administration/views.py +++ b/BackEnd/administration/views.py @@ -35,9 +35,19 @@ class UsersListView(ListAPIView): """ - List of users. - - Query parameters - - Filters: DjangoFilterBackend + View to list users with optional filtering and ordering. + + ### Query Parameters: + - **id** / **surname** / **email** / **is_active** / **is_staff** / **is_superuser** / **is_deleted** + - **company_name** / **registration_date** + + ### Ordering: + - Use the `ordering` parameter to sort the results. + - Example: `/users/?ordering=id` (ascending by ID) or `/users/?ordering=-id` (descending by ID). + + ### Filters: + - Filters are applied using `DjangoFilterBackend`. All the above query parameters are supported for filtering. + **Without is_deleted** """ permission_classes = [IsStaffUser]