Update Mailbox information endpoint added to API generation

Author: NickOvt

Diff for: lib/api/mailboxes.js

@@ -528,19 +528,47 @@ module.exports = (db, server, mailboxHandler) => {
     );
 
     server.put(
-        '/users/:user/mailboxes/:mailbox',
+        {
+            path: '/users/:user/mailboxes/:mailbox',
+            summary: 'Update Mailbox information',
+            tags: ['Mailboxes'],
+            validationObjs: {
+                requestBody: {
+                    path: Joi.string()
+                        .regex(/\/{2,}|\/$/, { invert: true })
+                        .description('Full path of the mailbox, use this to rename an existing Mailbox'),
+                    retention: Joi.number()
+                        .empty('')
+                        .min(0)
+                        .description(
+                            'Retention policy for the Mailbox (in ms). Changing retention value only affects messages added to this folder after the change'
+                        ),
+                    subscribed: booleanSchema.description('Change Mailbox subscription state'),
+                    hidden: booleanSchema.description('Is the folder hidden or not. Hidden folders can not be opened in IMAP.'),
+                    sess: sessSchema,
+                    ip: sessIPSchema
+                },
+                pathParams: { user: userId, mailbox: mailboxId },
+                queryParams: {},
+                response: {
+                    200: {
+                        description: 'Success',
+                        model: Joi.object({
+                            success: successRes
+                        })
+                    }
+                }
+            }
+        },
         tools.responseWrapper(async (req, res) => {
             res.charSet('utf-8');
 
-            const schema = Joi.object().keys({
-                user: Joi.string().hex().lowercase().length(24).required(),
-                mailbox: Joi.string().hex().lowercase().length(24).required(),
-                path: Joi.string().regex(/\/{2,}|\/$/, { invert: true }),
-                retention: Joi.number().empty('').min(0),
-                subscribed: booleanSchema,
-                hidden: booleanSchema,
-                sess: sessSchema,
-                ip: sessIPSchema
+            const { pathParams, requestBody, queryParams } = req.route.spec.validationObjs;
+
+            const schema = Joi.object({
+                ...pathParams,
+                ...requestBody,
+                ...queryParams
             });
 
             const result = schema.validate(req.params, {