Skip to content

Commit

Permalink
format docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
romanmyko committed Oct 21, 2024
1 parent 8426692 commit 1286c25
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions BackEnd/administration/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down

0 comments on commit 1286c25

Please sign in to comment.