Alexander/FitTrackee
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs - update api endpoints documentation

Browse Source
This commit is contained in:
Sam 2022-10-26 20:27:12 +02:00
parent 85a425d232
commit 7ea74d51e7
2 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
fittrackee/users/users.py
View File

@ -173,9 +173,10 @@ def get_users(auth_user: User) -> Dict:
:query integer page: page if using pagination (default: 1)
:query integer per_page: number of users per page (default: 10, max: 50)
:query string q: query on user name
:query string order_by: sorting criteria (``username``, ``created_at``,
``workouts_count``, ``admin``, ``is_active``)
:query string order: sorting order (default: ``asc``)
:query string order: sorting order: ``asc``, ``desc`` (default: ``asc``)
:query string order_by: sorting criteria: ``username``, ``created_at``,
``workouts_count``, ``admin``, ``is_active``
(default: ``username``)
:reqheader Authorization: OAuth 2.0 Bearer Token

5
fittrackee/workouts/workouts.py
View File

@ -197,7 +197,10 @@ def get_workouts(auth_user: User) -> Union[Dict, HttpResponse]:
:query float ave_speed_to: maximal average speed
:query float max_speed_from: minimal max. speed
:query float max_speed_to: maximal max. speed
:query string order: sorting order (default: ``desc``)
:query string order: sorting order: ``asc``, ``desc`` (default: ``desc``)
:query string order_by: sorting criteria: ``ave_speed``, ``distance``,
``duration``, ``workout_date`` (default:
``workout_date``)
:reqheader Authorization: OAuth 2.0 Bearer Token