feature/IO-2282-VSSTA-Integration: - doc blocks / cleanup

server/media/media.js

@@ -7,11 +7,21 @@ const { DELETE_MEDIA_DOCUMENTS } = require("../graphql-client/queries");
 const cloudinary = require("cloudinary").v2;
 cloudinary.config(process.env.CLOUDINARY_URL);
 
+/**
+ * @description Creates a signed upload URL for Cloudinary.
+ * @param req
+ * @param res
+ */
 const createSignedUploadURL = (req, res) => {
   logger.log("media-signed-upload", "DEBUG", req.user.email, null, null);
   res.send(cloudinary.utils.api_sign_request(req.body, process.env.CLOUDINARY_API_SECRET));
 };
 
+/**
+ * @description Downloads files from Cloudinary.
+ * @param req
+ * @param res
+ */
 const downloadFiles = (req, res) => {
   const { ids } = req.body;
 
@@ -25,6 +35,12 @@ const downloadFiles = (req, res) => {
   res.send(url);
 };
 
+/**
+ * @description Deletes files from Cloudinary and Apollo.
+ * @param req
+ * @param res
+ * @returns {Promise<void>}
+ */
 const deleteFiles = async (req, res) => {
   const { ids } = req.body;
 
@@ -89,6 +105,12 @@ const deleteFiles = async (req, res) => {
   }
 };
 
+/**
+ * @description Renames keys in Cloudinary and updates the database.
+ * @param req
+ * @param res
+ * @returns {Promise<void>}
+ */
 const renameKeys = async (req, res) => {
   const { documents, tojobid } = req.body;