Docs - update api endpoints documentation

2022-10-26 20:27:12 +02:00
parent 85a425d232
commit 7ea74d51e7
2 changed files with 8 additions and 4 deletions
--- a/fittrackee/workouts/workouts.py
+++ b/fittrackee/workouts/workouts.py
@ -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