Merge pull request #31 from itsdeannat/add-missing-api-doc-content

Update help text for serializer and update schema
itsdeannat · Nov 13, 2024 · 902958e · 902958e
2 parents 5375be8 + c0a30b2
commit 902958e
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/brew/serializers.py b/brew/serializers.py
@@ -23,7 +23,7 @@ class ProductSerializer(serializers.ModelSerializer):
     id = serializers.IntegerField(help_text='A unique integer value identifying this product.')
     product_name = serializers.CharField(help_text='The product name')
     temperature = serializers.CharField(help_text='Drink temperature', required=False)
-    caffeine_amount = serializers.IntegerField(help_text="Caffeine amount", required=False)
+    caffeine_amount = serializers.IntegerField(help_text="Caffeine amount in milligrams", required=False)
     price = serializers.FloatField(help_text='The price of the product in USD')
     description = serializers.CharField(help_text='A description of the product')
     quantity = serializers.IntegerField(help_text='Amount of product available')

diff --git a/schema.yml b/schema.yml
@@ -358,7 +358,7 @@ components:
           description: Drink temperature
         caffeine_amount:
           type: integer
-          description: Caffeine amount
+          description: Caffeine amount in milligrams
         price:
           type: number
           format: double