Skip to content

armgit / wger

Public Imported from GitHub
0

Self hosted FLOSS fitness/workout, nutrition and weight tracker

Describe the nutritional value actions in the schema

Roland Geiderf7ef957270dd
diff --git a/wger/nutrition/api/serializers.py b/wger/nutrition/api/serializers.py
index 73e40c718..74b454b61 100644
--- a/wger/nutrition/api/serializers.py
+++ b/wger/nutrition/api/serializers.py
@@ -297,11 +297,27 @@ class NutritionalValuesSerializer(serializers.Serializer):
energy = serializers.FloatField()
protein = serializers.FloatField()
carbohydrates = serializers.FloatField()
- carbohydrates_sugar = serializers.FloatField()
+ # These four default to None on NutritionalValues, so they go out as null
+ # for ingredients that don't carry the value
+ carbohydrates_sugar = serializers.FloatField(allow_null=True)
fat = serializers.FloatField()
- fat_saturated = serializers.FloatField()
- fiber = serializers.FloatField()
- sodium = serializers.FloatField()
+ fat_saturated = serializers.FloatField(allow_null=True)
+ fiber = serializers.FloatField(allow_null=True)
+ sodium = serializers.FloatField(allow_null=True)
+
+
+class IngredientValuesSerializer(NutritionalValuesSerializer):
+ """
+ Nutritional values for a given amount and unit of an ingredient.
+
+ Carries the form errors instead of usable values when the amount or unit
+ query parameters don't validate.
+ """
+
+ errors = serializers.DictField(
+ child=serializers.ListField(child=serializers.CharField()),
+ required=False,
+ )
class MealInfoSerializer(serializers.ModelSerializer):
diff --git a/wger/nutrition/api/views.py b/wger/nutrition/api/views.py
index 9cb6ad644..395272ab3 100644
--- a/wger/nutrition/api/views.py
+++ b/wger/nutrition/api/views.py
@@ -25,6 +25,11 @@ from django.utils.decorators import method_decorator
from django.views.decorators.cache import cache_page
# Third Party
+from drf_spectacular.types import OpenApiTypes
+from drf_spectacular.utils import (
+ OpenApiParameter,
+ extend_schema,
+)
from rest_framework import viewsets
from rest_framework.decorators import action
from rest_framework.response import Response
@@ -38,6 +43,7 @@ from wger.nutrition.api.serializers import (
IngredientImageSerializer,
IngredientInfoSerializer,
IngredientSerializer,
+ IngredientValuesSerializer,
IngredientWeightUnitSerializer,
LogItemSerializer,
MealItemSerializer,
@@ -98,6 +104,24 @@ class IngredientViewSet(viewsets.ReadOnlyModelViewSet):
self.throttle_scope = 'ingredient_list' if self.action == 'list' else 'ingredient_detail'
return super().get_throttles()
+ @extend_schema(
+ parameters=[
+ OpenApiParameter(
+ 'amount',
+ OpenApiTypes.DECIMAL,
+ OpenApiParameter.QUERY,
+ required=True,
+ description='The amount to calculate the values for',
+ ),
+ OpenApiParameter(
+ 'unit',
+ OpenApiTypes.INT,
+ OpenApiParameter.QUERY,
+ description='ID of an ingredient weight unit. Defaults to grams.',
+ ),
+ ],
+ responses={200: IngredientValuesSerializer},
+ )
@action(detail=True)
def get_values(self, request, pk):
"""
@@ -254,6 +278,7 @@ class NutritionPlanViewSet(viewsets.ModelViewSet):
"""
serializer.save(user=self.request.user)
+ @extend_schema(responses={200: NutritionalValuesSerializer})
@action(detail=True)
def nutritional_values(self, request, pk):
"""
@@ -347,6 +372,7 @@ class MealViewSet(WgerOwnerObjectModelViewSet):
"""
return [(NutritionPlan, 'plan')]
+ @extend_schema(responses={200: NutritionalValuesSerializer})
@action(detail=True)
def nutritional_values(self, request, pk):
"""
@@ -395,6 +421,7 @@ class MealItemViewSet(WgerOwnerObjectModelViewSet):
"""
return [(Meal, 'meal')]
+ @extend_schema(responses={200: NutritionalValuesSerializer})
@action(detail=True)
def nutritional_values(self, request, pk):
"""
@@ -431,6 +458,7 @@ class LogItemViewSet(WgerOwnerObjectModelViewSet):
"""
return [(NutritionPlan, 'plan'), (Meal, 'meal')]
+ @extend_schema(responses={200: NutritionalValuesSerializer})
@action(detail=True)
def nutritional_values(self, request, pk):
"""