Update plugins/federations.js

plugins/federations.js

@@ -182,6 +182,56 @@ FedsRoutes.get("/api/v2/federation/getfed/:uuid", authenticateApiKey, apiLimiter
   }
 });
 
+/**
+ * @swagger
+ * /api/v2/federation/unban:
+ *   post:
+ *     summary: Unban a user in a federation
+ *     tags: [Federation]
+ *     description: Removes a user from the banned list of a specified federation.
+ *     security:
+ *       - apiKeyAuth: []
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             properties:
+ *               name:
+ *                 type: string
+ *                 description: Name of the federation where the user will be unbanned.
+ *               user_id:
+ *                 type: integer
+ *                 description: User ID to be unbanned.
+ *     parameters:
+ *       - in: header
+ *         name: x-api-key
+ *         required: true
+ *         description: API key for authentication.
+ *         schema:
+ *           type: string
+ *     responses:
+ *       200:
+ *         description: User unbanned successfully.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 success:
+ *                   type: boolean
+ *                   example: true
+ *                 message:
+ *                   type: string
+ *                   example: "User 12345 unbanned from federation FederationName."
+ *       400:
+ *         description: Missing federation name or user ID.
+ *       404:
+ *         description: Federation not found.
+ *       500:
+ *         description: Internal server error.
+ */
 FedsRoutes.post('/api/v2/federation/unban', authenticateApiKey, async (req, res) => {
     try {
         const { name, user_id } = req.body;
@@ -210,7 +260,51 @@ FedsRoutes.post('/api/v2/federation/unban', authenticateApiKey, async (req, res)
     }
 });
 
-
+/**
+ * @swagger
+ * /api/v2/federation/ban:
+ *   post:
+ *     summary: Ban a user in a federation
+ *     tags: [Federation]
+ *     description: Bans a user in the specified federation and all its sub-federations.
+ *     security:
+ *       - apiKeyAuth: []
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             properties:
+ *               federation_uuid:
+ *                 type: string
+ *                 description: UUID of the federation where the user will be banned.
+ *               user_id:
+ *                 type: integer
+ *                 description: User ID to be banned.
+ *     parameters:
+ *       - in: header
+ *         name: x-api-key
+ *         required: true
+ *         description: API key for authentication.
+ *         schema:
+ *           type: string
+ *     responses:
+ *       200:
+ *         description: User banned successfully.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 message:
+ *                   type: string
+ *                   example: "User 12345 banned in FederationName and all its sub-federations"
+ *       404:
+ *         description: Federation not found.
+ *       500:
+ *         description: Internal server error.
+ */
 FedsRoutes.post("/api/v2/federation/ban", authenticateApiKey, apiLimiter, async (req, res) => {
     try {
         const { federation_uuid, user_id } = req.body;