Vps 25/resource api definitions are implemented

backend/src/routes/api/resources.js

@@ -24,7 +24,15 @@ const HTTP_INTERNAL_SERVER_ERROR = 500;
 // Apply auth middleware to all routes below this point
 router.use(auth);
 
-// Create a New Resource
+/**
+ * @route POST /
+ * @desc Create a New Resource
+ * @param {Object} req.body - The resource details.
+ * @param {string} req.body.type - The type of the resource.
+ * @param {string} req.body.content - The content of the resource.
+ * @param {string} req.body.name - The name of the resource.
+ * @returns {Object} 201 - The newly created resource.
+ */
 router.post(
   "/",
   handle(async (req, res) => {
@@ -34,7 +42,14 @@ router.post(
   })
 );
 
-// Retrieve a Specific Resource
+/**
+ * @route GET /:resourceId
+ * @desc Retrieve a Specific Resource
+ * @param {string} req.params.resourceId - The unique identifier of the resource.
+ * @returns {Object} 200 - The resource details.
+ * @returns {string} 400 - Bad Request if resourceId is not provided.
+ * @returns {string} 404 - Not Found if the resource does not exist.
+ */
 router.get("/:resourceId", async (req, res) => {
   if (!req.params.resourceId) {
     return res.status(HTTP_BAD_REQUEST).send("Bad Request");
@@ -46,7 +61,14 @@ router.get("/:resourceId", async (req, res) => {
   return res.status(HTTP_OK).json(resource);
 });
 
-// Delete a Resource
+/**
+ * @route DELETE /:resourceId
+ * @desc Delete a Resource
+ * @param {string} req.params.resourceId - The unique identifier of the resource.
+ * @returns {string} 204 - Resource deleted successfully.
+ * @returns {string} 400 - Bad Request if resourceId is not provided.
+ * @returns {string} 404 - Not Found if the resource does not exist.
+ */
 router.delete("/:resourceId", async (req, res) => {
   if (!req.params.resourceId) {
     return res.status(HTTP_BAD_REQUEST).send("Bad Request");
@@ -58,7 +80,13 @@ router.delete("/:resourceId", async (req, res) => {
   return res.status(HTTP_NO_CONTENT).send("Resource deleted");
 });
 
-// Retrieve All Visible Resources
+/**
+ * @route GET /group/:groupId
+ * @desc Retrieve All Visible Resources for a Group
+ * @param {string} req.params.groupId - The unique identifier of the group.
+ * @returns {Object[]} 200 - An array of visible resources for the group.
+ * @returns {string} 400 - Bad Request if groupId is not provided.
+ */
 router.get("/group/:groupId", async (req, res) => {
   const { groupId } = req.params;
   if (!groupId) {
@@ -68,7 +96,14 @@ router.get("/group/:groupId", async (req, res) => {
   return res.status(HTTP_OK).json(resources);
 });
 
-// Add a flag to group flags
+/**
+ * @route POST /group/:groupId/:flag
+ * @desc Add a Flag to Group Flags
+ * @param {string} req.params.groupId - The unique identifier of the group.
+ * @param {string} req.params.flag - The flag to be added.
+ * @returns {string[]} 200 - The updated list of flags for the group.
+ * @returns {string} 400 - Bad Request if groupId or flag is not provided.
+ */
 router.post("/group/:groupId/:flag", async (req, res) => {
   const { groupId, flag } = req.params;
   if (!groupId || !flag) {
@@ -78,7 +113,14 @@ router.post("/group/:groupId/:flag", async (req, res) => {
   return res.status(HTTP_OK).json(flags);
 });
 
-// Remove a flag from group flags
+/**
+ * @route DELETE /group/:groupId/:flag
+ * @desc Remove a Flag from Group Flags
+ * @param {string} req.params.groupId - The unique identifier of the group.
+ * @param {string} req.params.flag - The flag to be removed.
+ * @returns {string[]} 200 - The updated list of flags for the group.
+ * @returns {string} 400 - Bad Request if groupId or flag is not provided.
+ */
 router.delete("/group/:groupId/:flag", async (req, res) => {
   const { groupId, flag } = req.params;
   if (!groupId || !flag) {
@@ -88,7 +130,20 @@ router.delete("/group/:groupId/:flag", async (req, res) => {
   return res.status(HTTP_OK).json(flags);
 });
 
-// Update a Resource
+/**
+ * @route PUT /:resourceId
+ * @desc Update a Resource
+ * @param {string} req.params.resourceId - The unique identifier of the resource.
+ * @param {Object} req.body - The updated resource details.
+ * @param {string} req.body.type - The type of the resource.
+ * @param {string} req.body.content - The content of the resource.
+ * @param {string} req.body.name - The name of the resource.
+ * @returns {Object} 200 - The updated resource.
+ * @returns {string} 400 - Bad Request if required fields are missing.
+ * @returns {string} 404 - Not Found if the resource does not exist.
+ * @returns {string} 500 - Internal Server Error if an unexpected error occurs.
+ */
+
 router.put("/:resourceId", async (req, res) => {
   const { resourceId } = req.params;
   const { name, type, content } = req.body;