Rename domain in addresses endpoint added to API docs generation

Author: NickOvt

lib/api/addresses.js

@@ -2432,15 +2432,43 @@ module.exports = (db, server, userHandler, settingsHandler) => {
     );
 
     server.put(
-        '/addresses/renameDomain',
+        {
+            path: '/addresses/renameDomain',
+            summary: 'Rename domain in addresses',
+            description: 'Renames domain names for addresses, DKIM keys and Domain Aliases',
+            tags: ['Addresses'],
+            validationObjs: {
+                requestBody: {
+                    oldDomain: Joi.string().required().description('Old Domain Name'),
+                    newDomain: Joi.string().required().description('New Domain Name'),
+                    sess: sessSchema,
+                    ip: sessIPSchema
+                },
+                queryParams: {},
+                pathParams: {},
+                response: {
+                    200: {
+                        description: 'Success',
+                        model: Joi.object({
+                            success: successRes,
+                            modifiedAddresses: Joi.number().required().description('Number of modified addresses'),
+                            modifiedUsers: Joi.number().required().description('Number of modified users'),
+                            modifiedDkim: Joi.number().required().description('Number of modified DKIM keys'),
+                            modifiedAliases: Joi.number().required().description('Number of modified Domain Aliases')
+                        })
+                    }
+                }
+            }
+        },
         tools.responseWrapper(async (req, res) => {
             res.charSet('utf-8');
 
-            const schema = Joi.object().keys({
-                oldDomain: Joi.string().required(),
-                newDomain: Joi.string().required(),
-                sess: sessSchema,
-                ip: sessIPSchema
+            const { pathParams, requestBody, queryParams } = req.route.spec.validationObjs;
+
+            const schema = Joi.object({
+                ...pathParams,
+                ...queryParams,
+                ...requestBody
             });
 
             const result = schema.validate(req.params, {