From 8d29d0c424baef414945797e888b123fff4858c0 Mon Sep 17 00:00:00 2001
From: IshayuR <ishayu.ray@outlook.com>
Date: Wed, 6 Nov 2024 15:33:38 -0500
Subject: [PATCH] implement Swagger documentation for main.py

---
 Backend/__pycache__/petfuc.cpython-311.pyc  | Bin 0 -> 725 bytes
 Backend/__pycache__/userfuc.cpython-311.pyc | Bin 0 -> 1293 bytes
 Backend/main.py                             |  94 +++++++++++++++-----
 3 files changed, 73 insertions(+), 21 deletions(-)
 create mode 100644 Backend/__pycache__/petfuc.cpython-311.pyc
 create mode 100644 Backend/__pycache__/userfuc.cpython-311.pyc

diff --git a/Backend/__pycache__/petfuc.cpython-311.pyc b/Backend/__pycache__/petfuc.cpython-311.pyc
new file mode 100644
index 0000000000000000000000000000000000000000..f26ccc6f63374c4b6130b724ca16dc739d03ee00
GIT binary patch
literal 725
zcmZWny>AmS6u0j#9~@~VNCRz@!3#r#+R&(cNiBj>Au1tMsp*pCWSyPl=-oN8eUwzK
zlz|0_fsKV3sQ72f7I|f2J1Ju6#JfuhNIcoU_u=Q~pP&6@VZlWp2j6e^zgh_W$ec?7
zKbL6()JMcn7ctDN5Jy(m!id>#QP*b9K57<@U$~t?phzTG5^^$>;&s5dBE2N`bs%D}
zge1>9oju}<C`#hMr&*lPm=RZsMDxG7?$7MlGi*w)l!$}g$j@oap#<87IlTt}tnev1
zLCj*ngcVqkl|B_uvBvXkP$&2^c;Eg+fN%MD-z6Z==Jbdbq|ak6De#cMNkn9KCnqPl
zPGn4mT<1HeQoabd=8PN#dO-AmYDmr341Q>AMI+-xG~@<9FqNkwjyZI|KT5Q*_mY0I
zXsm!4C#DgHWd6q3Px{=HLosWJDQrv5napn3w9J(mnIP82VN_F<y$K-~k6Q<dOVtY0
zfQ}MLM=f9R_WGUnrC#mPFl=wEb~ughuD7<Sf5>Cjf@|~=e{DE2i+!%WS#=MhvId3A
zFx7p4F-l!@ZE3ul7E!e^sV+~h!>CPe-kQ|v>D5A|ks^Tc&aVopR6lII+j_rs?krDX
zD|*><Ov&?@@IB8IdLdPZ(t&t>!Woh`GJ6T&qP#i#E{|j#-0XeSCO~Rqj8n_TPKq)p
VBV0d6EB}tPxQJI$^gra)e*^j_#o+(|

literal 0
HcmV?d00001

diff --git a/Backend/__pycache__/userfuc.cpython-311.pyc b/Backend/__pycache__/userfuc.cpython-311.pyc
new file mode 100644
index 0000000000000000000000000000000000000000..a1a2b87db4e245eabe660d8a314f5ae5a3eaf6e2
GIT binary patch
literal 1293
zcmcIk&ubGw6rN2c$(mSdYx=`loAFS}DrwrFpjgC~B1%gY8!x$pac0u4COctvx22^*
z4tf_ay?E$JDgHBw6f6sZAiW2Im!5pPn>4Wso*bBOX5No)-}~~&r-6Yaf_0~PbK?Xf
z^uvF2SFCes&%$LNaa2SbsHky`M|hND9{Yfc5gvboicy{b#9RlA@eAw7NbasC3!A1*
zs*<}EL262FnOxYU>{`q*r3E*s$fH8xDPgi&buE)o-%hB-Nm5DI5xv-?hlMhkhx2p!
zIWNVeWeH$muHz-v9hVEsF|dc%XjORnQ)=7WQgKgTl_95>e8QMp3;3DVZ4b_9XSbJw
z4xK*NL4VwteGh#E`{y&ChWc}$Z*BKplE9*z6W11sIFfMc&==GeL2F7luCjVIQ4v)r
z-wv{jh?jm2Sr6%!DU~CZA#({by*RDagvAdvPk(7k%V)IxBFO1t&QGv&roBmbTt#<s
z%oh3ixqSD`mT9Guzm+WrTD?7=TcYe0Fy;K>$}XF&?RY~_Y{`F@%AN13OTaw<yFCR^
zM?ZBGyYdxhzTnJ(-o(ZcHX7JCNo5*1(}oE2-&K7O=%YkcZi!IXvXa%FjQ-U8Lt2%B
zLcMs%q5SSb3Dux)Plxt%I*fp847M8bVHn`=ovwjrAMK$7IR9K+`+aI&L!=Yw#c^!`
z9{m=Wq{!~wpyy|zR-sIgN@th}jJISabp$8drn5<Cs0U?Cx|S2_qyrxeQ*=W(UdkVk
zMaCXmWoc+$$`adMu6_YVRQRD#fo_DF0H*7(?P-8IYU$|m)PC-L?%+mqID0glt*;zU
z8E;qKC7bx_x726@j|MWW8F4RBDsjn5r9gN!4*9`cDPPop_b`++_yJD!h48Q9zPbi}
zf4J>3Kr5<gS}PLOa0~gMqw$FbN`D`nJf0xO6Enw?)2&2wa0a}CGxb#KVq7CFbO!0O
PTVR9dnD0FgLCwDaas@Sj

literal 0
HcmV?d00001

diff --git a/Backend/main.py b/Backend/main.py
index 0728623..d9f1042 100644
--- a/Backend/main.py
+++ b/Backend/main.py
@@ -1,54 +1,106 @@
 """
-This module provides functions for HTTP communication and 
-route functions
+This module provides functions for HTTP communication and route functions.
 """
 from flask import Flask, request, jsonify
+from flasgger import Swagger
 from petfuc import get_random_pet
 from userfuc import add_user_faviorte, remove_user_faviorte, replace_user_location
 
 app = Flask(__name__)
+Swagger(app)  # Initialize Swagger
 
-#Get Random Pet information - For homepage
+# Get Random Pet information - For homepage
 @app.route("/Get_Random_pet", methods=["GET"])
 def random_pet():
     """
-    Function to extract random pet information
+    Retrieve a random pet's information for the homepage.
+    ---
+    responses:
+      200:
+        description: Returns random pet information successfully.
+        schema:
+          type: object
+          properties:
+            name:
+              type: string
+              example: 'Rex'
+            breed:
+              type: string
+              example: 'Dog'
+            age:
+              type: integer
+              example: 5
     """
-    return get_random_pet(), 200 # Return dog information
+    return get_random_pet(), 200
 
-# Faviortes route. add user faviorte pet to database
+# Favorites route. Add user favorite pet to database
 @app.route("/Add_User_Faviorte", methods=["POST"])
 def adduserfaviorte():
     """
-    Function to add user from database
+    Add a pet to the user's favorites in the database.
+    ---
+    parameters:
+      - in: body
+        name: pet
+        required: true
+        schema:
+          type: object
+          properties:
+            pet_id:
+              type: integer
+              example: 101
+    responses:
+      200:
+        description: Pet added to favorites successfully.
     """
     json_data = request.get_json()
-
-    # Api accesses database and append post json in database
-    #Retrun database with succses code
     return jsonify(add_user_faviorte(json_data)), 200
 
-# Un Faviote Route. remove user faviorte pet from there database
+# Unfavorite Route. Remove user favorite pet from their database
 @app.route("/Remove_User_Faviorte", methods=["DELETE"])
 def removeuserfaviorte():
     """
-    Function to remove user from database
+    Remove a pet from the user's favorites in the database.
+    ---
+    parameters:
+      - in: body
+        name: pet
+        required: true
+        schema:
+          type: object
+          properties:
+            pet_id:
+              type: integer
+              example: 101
+    responses:
+      200:
+        description: Pet removed from favorites successfully.
     """
     json_data = request.get_json()
+    return jsonify(remove_user_faviorte(json_data)), 200
 
-    # Api accesses database and append post json in database
-    #Retrun database with succses code
-    return jsonify(remove_user_faviorte(json_data)), 200 # return new user database
-
-# Change a Users account location
+# Change a User's account location
 @app.route("/Change_User_Location", methods=["PUT"])
 def replace_user_information():
     """
-    Function to change the location associated with
-    an account
+    Change the location associated with a user's account.
+    ---
+    parameters:
+      - in: body
+        name: location
+        required: true
+        schema:
+          type: object
+          properties:
+            new_location:
+              type: string
+              example: 'New York, NY'
+    responses:
+      200:
+        description: User location updated successfully.
     """
-    newlocation = request.get_json() # Get new location from post request
-    return jsonify(replace_user_location(newlocation)) # retrun user account info
+    newlocation = request.get_json()
+    return jsonify(replace_user_location(newlocation)), 200
 
 if __name__ == "__main__":
     app.run(host="0.0.0.0", port=5000, debug=True)