Backend/feature/projects endpoint

backend/project/__init__.py

@@ -5,6 +5,7 @@
 from flask import Flask
 from .db_in import db
 from .endpoints.index.index import index_bp
+from .endpoints.projects.project_endpoint import project_bp
 from .endpoints.courses import courses_bp
 
 
@@ -18,6 +19,7 @@ def create_app():
 
     app = Flask(__name__)
     app.register_blueprint(index_bp)
+    app.register_blueprint(project_bp)
     app.register_blueprint(courses_bp)
 
     return app

backend/project/endpoints/index/OpenAPI_Object.json

@@ -42,7 +42,192 @@
     ]
   },
   "paths": {
-
+    "/projects": {
+      "get": {
+        "description": "Returns all projects from the database that the user has access to",
+        "responses": {
+          "200": {
+            "description": "A list of projects",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "project_id": {
+                        "type": "int"
+                      },
+                      "descriptions": {
+                        "type": "string"
+                      },
+                      "title": {
+                        "type": "string"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      "post": {
+        "description": "Upload a new project",
+        "responses": {
+          "201": {
+            "description": "Uploaded a new project succesfully",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "message": "string"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/projects/{id}": {
+      "get": {
+        "description": "Return a project with corresponding id",
+        "responses": {
+          "200": {
+            "description": "A project with corresponding id",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "archieved": {
+                      "type": "bool"
+                    },
+                    "assignment_file": {
+                      "type": "string"
+                    },
+                    "course_id": {
+                      "type": "int"
+                    },
+                    "deadline": {
+                      "type": "date"
+                    },
+                    "descriptions": {
+                      "type": "array",
+                      "items": {
+                        "description": "string"
+                      }
+                    },
+                    "project_id": {
+                      "type": "int"
+                    },
+                    "regex_expressions": {
+                      "type": "array",
+                      "items": {
+                        "regex": "string"
+                      }
+                    },
+                    "script_name": {
+                      "type": "string"
+                    },
+                    "test_path": {
+                      "type": "string"
+                    },
+                    "title": {
+                      "type": "string"
+                    },
+                    "visible_for_students": {
+                      "type": "bool"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "An id that doesn't correspond to an existing project",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "message": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      "patch": {
+        "description": "Patch certain fields of a project",
+        "responses": {
+          "200": {
+            "description": "Patched a project succesfully",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "message": "string"
+                  }
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Tried to patch a project that is not present",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "message": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      "delete": {
+        "description": "Delete a project with given id",
+        "responses": {
+          "200": {
+            "description": "Removed a project succesfully",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "message": "string"
+                  }
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Tried to remove a project that is not present",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "message": "string"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/courses": {
       "get": {
         "description": "Get a list of all courses.",
@@ -85,7 +270,7 @@
                 }
               }
             }
-          }  
+          }
             },
           "parameters": [
             {
@@ -111,7 +296,7 @@
               "schema": {
                 "type": "string"
               }
-            }  
+            }
           ]
         },
       "post": {
@@ -611,7 +796,7 @@
         }
       },
       "post":{
-        "description": "Assign students to a course.", 
+        "description": "Assign students to a course.",
         "parameters": [
           {
             "name": "course_id",
@@ -733,7 +918,7 @@
               }
             }
           }
-        } 
+        }
       },
       "delete":{
         "description": "Remove students from a course.",
@@ -918,7 +1103,7 @@
         }
       },
       "post":{
-        "description": "Assign admins to a course.", 
+        "description": "Assign admins to a course.",
         "parameters": [
           {
             "name": "course_id",
@@ -1040,7 +1225,7 @@
               }
             }
           }
-        } 
+        }
       },
       "delete":{
         "description": "Remove an admin from a course.",
@@ -1156,6 +1341,6 @@
           }
           }
       }
-    
+
   }
 }

backend/project/endpoints/projects/endpoint_parser.py

@@ -0,0 +1,31 @@
+"""
+Parser for the argument when posting or patching a project
+"""
+
+from flask_restful import reqparse
+
+parser = reqparse.RequestParser()
+parser.add_argument('title', type=str, help='Projects title')
+parser.add_argument('descriptions', type=str, help='Projects description')
+parser.add_argument('assignment_file', type=str, help='Projects assignment file')
+parser.add_argument("deadline", type=str, help='Projects deadline')
+parser.add_argument("course_id", type=str, help='Projects course_id')
+parser.add_argument("visible_for_students", type=bool, help='Projects visibility for students')
+parser.add_argument("archieved", type=bool, help='Projects')
+parser.add_argument("test_path", type=str, help='Projects test path')
+parser.add_argument("script_name", type=str, help='Projects test script path')
+parser.add_argument("regex_expressions", type=str, help='Projects regex expressions')
+
+
+def parse_project_params():
+    """
+    Return a dict of every non None value in the param
+    """
+    args = parser.parse_args()
+    result_dict = {}
+
+    for key, value in args.items():
+        if value is not None:
+            result_dict[key] = value
+
+    return result_dict