Skip to content

armgit / wger

Public Imported from GitHub
0

Self hosted FLOSS fitness/workout, nutrition and weight tracker

Polish some of the docstrings used in the api documentation

Roland Geidere263c70e597e
diff --git a/wger/core/api/views.py b/wger/core/api/views.py
index 3ed236f05..6c8558a3b 100644
--- a/wger/core/api/views.py
+++ b/wger/core/api/views.py
@@ -185,7 +185,7 @@ class ApplicationVersionView(viewsets.ViewSet):
class PermissionView(viewsets.ViewSet):
"""
- Returns the application's version
+ Checks whether the user has a django permission
"""
permission_classes = (AllowAny, )
@@ -228,6 +228,7 @@ class PermissionView(viewsets.ViewSet):
class RequiredApplicationVersionView(viewsets.ViewSet):
"""
Returns the minimum required version of flutter app to access this server
+ such as 1.4.2 or 3.0.0
"""
permission_classes = (AllowAny, )
@@ -244,8 +245,10 @@ class RequiredApplicationVersionView(viewsets.ViewSet):
class UserAPILoginView(viewsets.ViewSet):
"""
- API endpoint for api user objects
- .. warning:: This endpoint is deprecated
+ API login endpoint. Returns a token that can subsequently passed in the
+ header.
+
+ Note that it is recommended to use token authorization instead.
"""
permission_classes = (AllowAny, )
queryset = User.objects.all()
@@ -263,6 +266,17 @@ class UserAPILoginView(viewsets.ViewSet):
},
)
+ @staticmethod
+ @extend_schema(
+ parameters=[],
+ responses={
+ status.HTTP_200_OK:
+ inline_serializer(
+ name='loginSerializer',
+ fields={'token': CharField()},
+ ),
+ }
+ )
def post(self, request):
data = request.data
serializer = self.serializer_class(data=data)
@@ -284,12 +298,8 @@ class UserAPILoginView(viewsets.ViewSet):
return Response(
data={
'token': token.key,
- 'message': "This endpoint is deprecated."
},
status=status.HTTP_200_OK,
- headers={
- "Deprecation": "Sat, 01 Oct 2022 23:59:59 GMT",
- }
)
@@ -306,6 +316,16 @@ class UserAPIRegistrationViewSet(viewsets.ViewSet):
"""
return UserProfile.objects.filter(user=self.request.user)
+ @extend_schema(
+ parameters=[],
+ responses={
+ status.HTTP_200_OK:
+ inline_serializer(
+ name='loginSerializer',
+ fields={'token': CharField()},
+ ),
+ }
+ )
def post(self, request):
data = request.data
serializer = self.serializer_class(data=data)
@@ -329,7 +349,7 @@ class UserAPIRegistrationViewSet(viewsets.ViewSet):
class LanguageViewSet(viewsets.ReadOnlyModelViewSet):
"""
- API endpoint for workout objects
+ API endpoint for the languages used in the application
"""
queryset = Language.objects.all()
serializer_class = LanguageSerializer
@@ -343,7 +363,9 @@ class LanguageViewSet(viewsets.ReadOnlyModelViewSet):
class DaysOfWeekViewSet(viewsets.ReadOnlyModelViewSet):
"""
- API endpoint for workout objects
+ API endpoint for the days of the week (monday, tuesday, etc.).
+
+ This has historical reasons, and it's better and easier to just define a simple enum
"""
queryset = DaysOfWeek.objects.all()
serializer_class = DaysOfWeekSerializer
@@ -353,7 +375,7 @@ class DaysOfWeekViewSet(viewsets.ReadOnlyModelViewSet):
class LicenseViewSet(viewsets.ReadOnlyModelViewSet):
"""
- API endpoint for workout objects
+ API endpoint for license objects
"""
queryset = License.objects.all()
serializer_class = LicenseSerializer
diff --git a/wger/core/models/profile.py b/wger/core/models/profile.py
index 8edda7b73..ba7ca646f 100644
--- a/wger/core/models/profile.py
+++ b/wger/core/models/profile.py
@@ -523,8 +523,8 @@ by the US Department of Agriculture. It is extremely complete, with around
"""
if (
not WeightEntry.objects.filter(user=self.user).exists() or (
- datetime.date.today() - WeightEntry.objects.filter(user=self.user).latest().date
- > datetime.timedelta(days=3)
+ datetime.date.today() - WeightEntry.objects.filter(user=self.user).latest().date >
+ datetime.timedelta(days=3)
)
):
entry = WeightEntry()
diff --git a/wger/exercises/api/views.py b/wger/exercises/api/views.py
index c097e6f2b..f1a1746a5 100644
--- a/wger/exercises/api/views.py
+++ b/wger/exercises/api/views.py
@@ -90,17 +90,19 @@ from wger.utils.constants import (
)
from wger.utils.language import load_language
+
logger = logging.getLogger(__name__)
class ExerciseBaseViewSet(ModelViewSet):
"""
- API endpoint for exercise base objects. For a read-only endpoint with all the
- information of an exercise, see /api/v2/exercisebaseinfo/
+ API endpoint for exercise base objects.
+
+ For a read-only endpoint with all the information of an exercise, see /api/v2/exercisebaseinfo/
"""
queryset = ExerciseBase.objects.all()
serializer_class = ExerciseBaseSerializer
- permission_classes = (CanContributeExercises,)
+ permission_classes = (CanContributeExercises, )
ordering_fields = '__all__'
filterset_fields = (
'category',
@@ -134,10 +136,10 @@ class ExerciseBaseViewSet(ModelViewSet):
class ExerciseTranslationViewSet(ModelViewSet):
"""
- API endpoint for editing or adding exercise objects.
+ API endpoint for editing or adding exercise translation objects.
"""
queryset = Exercise.objects.all()
- permission_classes = (CanContributeExercises,)
+ permission_classes = (CanContributeExercises, )
serializer_class = ExerciseTranslationSerializer
ordering_fields = '__all__'
filterset_fields = (
@@ -201,10 +203,12 @@ class ExerciseTranslationViewSet(ModelViewSet):
class ExerciseViewSet(viewsets.ReadOnlyModelViewSet):
"""
- Deprecated API endpoint for exercise objects. Use /api/v2/exercisebaseinfo/ instead.
+ API endpoint for exercise objects, use /api/v2/exercisebaseinfo/ instead.
+
+ This is only kept for backwards compatibility and will be removed in the future
"""
queryset = Exercise.objects.all()
- permission_classes = (CanContributeExercises,)
+ permission_classes = (CanContributeExercises, )
serializer_class = ExerciseSerializer
ordering_fields = '__all__'
filterset_fields = (
@@ -292,11 +296,14 @@ class ExerciseViewSet(viewsets.ReadOnlyModelViewSet):
],
# yapf: disable
responses={
- 200: inline_serializer(
+ 200:
+ inline_serializer(
name='ExerciseSearchResponse',
fields={
- 'value': CharField(),
- 'data': inline_serializer(
+ 'value':
+ CharField(),
+ 'data':
+ inline_serializer(
name='ExerciseSearchItemResponse',
fields={
'id': IntegerField(),
@@ -361,7 +368,7 @@ def search(request):
class ExerciseInfoViewset(viewsets.ReadOnlyModelViewSet):
"""
- Deprecated API endpoint for exercise objects. Use /api/v2/exercisebaseinfo/ instead.
+ API endpoint for exercise objects, use /api/v2/exercisebaseinfo/ instead.
"""
queryset = Exercise.objects.all()
@@ -392,7 +399,8 @@ class ExerciseInfoViewset(viewsets.ReadOnlyModelViewSet):
class ExerciseBaseInfoViewset(viewsets.ReadOnlyModelViewSet):
"""
Read-only info API endpoint for exercise objects, grouped by the exercise
- base. Returns nested data structures for more easy and faster parsing.
+ base. Returns nested data structures for more easy and faster parsing and
+ is the recommended way to access the exercise data.
"""
queryset = ExerciseBase.objects.all()
@@ -421,7 +429,7 @@ class EquipmentViewSet(viewsets.ReadOnlyModelViewSet):
queryset = Equipment.objects.all()
serializer_class = EquipmentSerializer
ordering_fields = '__all__'
- filterset_fields = ('name',)
+ filterset_fields = ('name', )
@method_decorator(cache_page(settings.WGER_SETTINGS['EXERCISE_CACHE_TTL']))
def dispatch(self, request, *args, **kwargs):
@@ -431,11 +439,15 @@ class EquipmentViewSet(viewsets.ReadOnlyModelViewSet):
class DeletionLogViewSet(viewsets.ReadOnlyModelViewSet):
"""
API endpoint for exercise deletion logs
+
+ This lists objects that where deleted on a wger instance and should be deleted
+ as well when performing a sync (e.g. because many exercises where submitted at
+ once or an image was uploaded that hasn't a CC license)
"""
queryset = DeletionLog.objects.all()
serializer_class = DeletionLogSerializer
ordering_fields = '__all__'
- filterset_fields = ('model_type',)
+ filterset_fields = ('model_type', )
class ExerciseCategoryViewSet(viewsets.ReadOnlyModelViewSet):
@@ -445,7 +457,7 @@ class ExerciseCategoryViewSet(viewsets.ReadOnlyModelViewSet):
queryset = ExerciseCategory.objects.all()
serializer_class = ExerciseCategorySerializer
ordering_fields = '__all__'
- filterset_fields = ('name',)
+ filterset_fields = ('name', )
@method_decorator(cache_page(settings.WGER_SETTINGS['EXERCISE_CACHE_TTL']))
def dispatch(self, request, *args, **kwargs):
@@ -459,7 +471,7 @@ class ExerciseImageViewSet(ModelViewSet):
queryset = ExerciseImage.objects.all()
serializer_class = ExerciseImageSerializer
- permission_classes = (CanContributeExercises,)
+ permission_classes = (CanContributeExercises, )
ordering_fields = '__all__'
filterset_fields = (
'is_main',
@@ -521,7 +533,7 @@ class ExerciseVideoViewSet(ModelViewSet):
"""
queryset = ExerciseVideo.objects.all()
serializer_class = ExerciseVideoSerializer
- permission_classes = (CanContributeExercises,)
+ permission_classes = (CanContributeExercises, )
ordering_fields = '__all__'
filterset_fields = (
'is_main',
@@ -558,7 +570,7 @@ class ExerciseCommentViewSet(ModelViewSet):
API endpoint for exercise comment objects
"""
serializer_class = ExerciseCommentSerializer
- permission_classes = (CanContributeExercises,)
+ permission_classes = (CanContributeExercises, )
ordering_fields = '__all__'
filterset_fields = ('comment', 'exercise')
@@ -600,7 +612,7 @@ class ExerciseAliasViewSet(ModelViewSet):
"""
serializer_class = ExerciseAliasSerializer
queryset = Alias.objects.all()
- permission_classes = (CanContributeExercises,)
+ permission_classes = (CanContributeExercises, )
ordering_fields = '__all__'
filterset_fields = ('alias', 'exercise')
@@ -633,7 +645,7 @@ class ExerciseVariationViewSet(ModelViewSet):
"""
serializer_class = ExerciseVariationSerializer
queryset = Variation.objects.all()
- permission_classes = (CanContributeExercises,)
+ permission_classes = (CanContributeExercises, )
class MuscleViewSet(viewsets.ReadOnlyModelViewSet):
diff --git a/wger/manager/api/serializers.py b/wger/manager/api/serializers.py
index 17b81cc7c..3d5c6a116 100644
--- a/wger/manager/api/serializers.py
+++ b/wger/manager/api/serializers.py
@@ -58,16 +58,6 @@ class WorkoutTemplateSerializer(serializers.ModelSerializer):
fields = ('id', 'name', 'creation_date', 'description', 'is_public')
-class WorkoutAndTemplateSerializer(serializers.ModelSerializer):
- """
- Workout or template serializer
- """
-
- class Meta:
- model = Workout
- fields = ('id', 'name', 'creation_date', 'description', 'is_template', 'is_public')
-
-
class WorkoutSessionSerializer(serializers.ModelSerializer):
"""
Workout session serializer
diff --git a/wger/manager/api/views.py b/wger/manager/api/views.py
index 51f628c04..aef224cbf 100644
--- a/wger/manager/api/views.py
+++ b/wger/manager/api/views.py
@@ -38,7 +38,6 @@ from wger.manager.api.serializers import (
ScheduleStepSerializer,
SetSerializer,
SettingSerializer,
- WorkoutAndTemplateSerializer,
WorkoutCanonicalFormSerializer,
WorkoutLogSerializer,
WorkoutSerializer,
@@ -61,7 +60,7 @@ from wger.weight.helpers import process_log_entries
class WorkoutViewSet(viewsets.ModelViewSet):
"""
- API endpoint for workout objects
+ API endpoint for routine objects
"""
serializer_class = WorkoutSerializer
is_private = True
@@ -123,9 +122,9 @@ class WorkoutViewSet(viewsets.ModelViewSet):
return Response({'chart_data': json.loads(chart_data), 'logs': serialized_logs})
-class UserWorkoutTemplateViewSet(viewsets.ModelViewSet):
+class UserWorkoutTemplateViewSet(viewsets.ReadOnlyModelViewSet):
"""
- API endpoint for workout objects
+ API endpoint for routine template objects
"""
serializer_class = WorkoutTemplateSerializer
is_private = True
@@ -171,28 +170,6 @@ class PublicWorkoutTemplateViewSet(viewsets.ModelViewSet):
serializer.save(user=self.request.user)
-class WorkoutAndTemplateViewSet(viewsets.ModelViewSet):
- """
- API endpoint for workout objects
- """
- serializer_class = WorkoutAndTemplateSerializer
- is_private = True
- ordering_fields = '__all__'
- filterset_fields = ('name', 'description', 'creation_date')
-
- def get_queryset(self):
- """
- Only allow access to appropriate objects
- """
- return Workout.both.filter(user=self.request.user)
-
- def perform_create(self, serializer):
- """
- Set the owner
- """
- serializer.save(user=self.request.user)
-
-
class WorkoutSessionViewSet(WgerOwnerObjectModelViewSet):
"""
API endpoint for workout sessions objects
@@ -298,7 +275,7 @@ class ScheduleViewSet(viewsets.ModelViewSet):
class DayViewSet(WgerOwnerObjectModelViewSet):
"""
- API endpoint for training day objects
+ API endpoint for routine day objects
"""
serializer_class = DaySerializer
is_private = True
diff --git a/wger/settings_global.py b/wger/settings_global.py
index d82c58c96..61ee28e6b 100644
--- a/wger/settings_global.py
+++ b/wger/settings_global.py
@@ -24,6 +24,7 @@ from datetime import timedelta
from wger import get_version
from wger.utils.constants import DOWNLOAD_INGREDIENT_WGER
+
"""
This file contains the global settings that don't usually need to be changed.
For a full list of options, visit:
@@ -172,7 +173,7 @@ TEMPLATES = [
'django.template.loaders.app_directories.Loader',
],
'debug':
- False
+ False
},
},
]
@@ -255,7 +256,7 @@ AVAILABLE_LANGUAGES = (
LANGUAGE_CODE = 'en'
# All translation files are in one place
-LOCALE_PATHS = (os.path.join(SITE_ROOT, 'locale'),)
+LOCALE_PATHS = (os.path.join(SITE_ROOT, 'locale'), )
# Primary keys are AutoFields
DEFAULT_AUTO_FIELD = 'django.db.models.AutoField'
@@ -484,7 +485,7 @@ CORS_URLS_REGEX = r'^/api/.*$'
#
# Ignore these URLs if they cause 404
#
-IGNORABLE_404_URLS = (re.compile(r'^/favicon\.ico$'),)
+IGNORABLE_404_URLS = (re.compile(r'^/favicon\.ico$'), )
#
# Password rules
diff --git a/wger/urls.py b/wger/urls.py
index babfcff96..774c55763 100644
--- a/wger/urls.py
+++ b/wger/urls.py
@@ -296,7 +296,6 @@ urlpatterns += [
SpectacularRedocView.as_view(url_name='schema'),
name='api-redoc',
),
-
path('email/', include(email_urls)),
]