swagger adds

Author: sasi2312

.gitignore

@@ -1,5 +1,5 @@
 dmp_2/__pycache__/*
-
-dmp_2/.env
+.env
 env/*
 
+__pycache__/*

app.py

@@ -1,79 +1,172 @@
 from flask import Flask, jsonify
 from db import SupabaseInterface
 from collections import defaultdict
+from flasgger import Swagger
+
 
 app = Flask(__name__)
 
+Swagger(app)
+
 
 @app.route('/api/greeting', methods=['GET'])
 def greeting():
+    """
+    A simple greeting endpoint.
+    ---
+    responses:
+      200:
+        description: A greeting message
+        schema:
+          type: object
+          properties:
+            message:
+              type: string
+              example: Hello, welcome to my API!
+    """
     response = {
         'message': 'Hello, welcome to my API!'
     }
     return jsonify(response)
 
 @app.route('/api/get-data', methods=['GET'])
 def get_data():
-    # Fetch data from Supabase
+    """
+    Fetch data from Supabase.
+    ---
+    responses:
+      200:
+        description: Data fetched successfully
+        schema:
+          type: array
+          items:
+            type: object
+      500:
+        description: Error fetching data
+        schema:
+          type: object
+          properties:
+            error:
+              type: string
+    """
     try:
-        import pdb;pdb.set_trace()
         response = SupabaseInterface().get_instance().client.table('dmp_pr_updates').select('*').execute()
         data = response.data
         return jsonify(data)
     except Exception as e:
         return jsonify({'error': str(e)}), 500
-    
-    
+
 def group_by_owner(data):
     grouped_data = defaultdict(list)
     for record in data:
         owner = record['owner']
         grouped_data[owner].append(record)
     return grouped_data
 
-#DMP - CMS API's
-
 @app.route('/api/issues', methods=['GET'])
 def get_issues():
+    """
+    Fetch all issues and group by owner.
+    ---
+    responses:
+      200:
+        description: Issues grouped by owner
+        schema:
+          type: object
+          additionalProperties:
+            type: array
+            items:
+              type: object
+      500:
+        description: Error fetching issues
+        schema:
+          type: object
+          properties:
+            error:
+              type: string
+    """
     try:
         response = SupabaseInterface().get_instance().client.table('dmp_issue_updates').select('*').execute()
         data = response.data
         grouped_data = group_by_owner(data)
         return jsonify(grouped_data)
     except Exception as e:
         return jsonify({'error': str(e)}), 500
-    
+
 @app.route('/api/issues/<owner>', methods=['GET'])
 def get_issues_by_owner(owner):
-    # Fetch data from Supabase
+    """
+    Fetch issues by owner.
+    ---
+    parameters:
+      - name: owner
+        in: path
+        type: string
+        required: true
+        description: The owner of the issues
+    responses:
+      200:
+        description: Issues fetched successfully
+        schema:
+          type: array
+          items:
+            type: object
+      500:
+        description: Error fetching issues
+        schema:
+          type: object
+          properties:
+            error:
+              type: string
+    """
     try:
-        import pdb;pdb.set_trace()
         response = SupabaseInterface().get_instance().client.table('dmp_issue_updates').select('*').eq('owner', owner).execute()
-        
         if not response.data:
             return jsonify({'error': "No data found"}), 500
-
-        data = response.data              
+        data = response.data
         return jsonify(data)
-    
     except Exception as e:
         return jsonify({'error': str(e)}), 500
-    
 
 @app.route('/api/issues/<owner>/<issue>', methods=['GET'])
-def get_issues_by_owner_id(owner,issue):
-    # Fetch data from Supabase
+def get_issues_by_owner_id(owner, issue):
+    """
+    Fetch issues by owner and issue number.
+    ---
+    parameters:
+      - name: owner
+        in: path
+        type: string
+        required: true
+        description: The owner of the issues
+      - name: issue
+        in: path
+        type: string
+        required: true
+        description: The issue number
+    responses:
+      200:
+        description: Issues fetched successfully
+        schema:
+          type: array
+          items:
+            type: object
+      500:
+        description: Error fetching issues
+        schema:
+          type: object
+          properties:
+            error:
+              type: string
+    """
     try:
         response = SupabaseInterface().get_instance().client.table('dmp_issue_updates').select('*').eq('owner', owner).eq('issue_number', issue).execute()
-        
         if not response.data:
             return jsonify({'error': "No data found"}), 500
-
-        data = response.data              
+        data = response.data
         return jsonify(data)
-    
     except Exception as e:
         return jsonify({'error': str(e)}), 500
-    
+
 if __name__ == '__main__':
-    app.run(debug=True)
+    app.run(debug=True)

requirements.txt

@@ -3,3 +3,4 @@ httpx==0.27.0
 python-dotenv==1.0.1
 supabase==2.4.5
 gunicorn==22.0.0
+flasgger==0.9.7.1