Fixed doc strings return formatting a bit. Figured out how to properly use docstrings

KeithGalli · KeithGalli · commit 7ae9eb92cac7 · 2023-10-08T21:23:15.000-04:00
diff --git a/app.py b/app.py
@@ -61,22 +61,20 @@ def get(self):
         responses:
             200:
                 description: A successful GET request
-                content:
-                    application/json:
-                      schema:
-                        type: object
-                        properties:
-                            books:
-                                type: array
-                                items:
-                                    type: object
-                                    properties:
-                                        title:
-                                            type: string
-                                            description: The title of the book
-                                        author:
-                                            type: string
-                                            description: The author of the book
+                schema:
+                    type: object
+                    properties:
+                        books:
+                            type: array
+                            items:
+                                type: object
+                                properties:
+                                    title:
+                                        type: string
+                                        description: The title of the book
+                                    author:
+                                        type: string
+                                        description: The author of the book
         """
 
         count = request.args.get('count')  # Default to returning 10 books if count is not provided
@@ -85,7 +83,7 @@ def get(self):
         # Get all the books
         books = book_review.get_all_records(count=count, sort=sort)
 
-        return jsonify({"books": books})
+        return {"books": books}, 200
     
 class AddRecord(Resource):
 
@@ -114,28 +112,23 @@ def post(self):
         responses:
             200:
                 description: A successful POST request
-                content:
-                    application/json:
-                        schema:
-                            type: object
-                        properties:
-                            message:
-                                type: string
+            400: 
+                description: Bad request, missing 'Book' or 'Rating' in the request body
         """
 
         data = request.json
         print(data)
 
         # Check if 'Book' and 'Rating' are present in the request body
         if 'Book' not in data or 'Rating' not in data:
-            return jsonify({"message": "Bad request, missing 'Book' or 'Rating' in the request body"})
+            return {"message": "Bad request, missing 'Book' or 'Rating' in the request body"}, 400
         # Call the add_record function to add the record to the DB table
         success = book_review.add_record(data)
 
         if success:
-            return jsonify({"message": "Record added successfully"})
+            return {"message": "Record added successfully"}, 200
         else:
-            return jsonify({"message": "Failed to add record"})
+            return {"message": "Failed to add record"}, 500
         
 
 
