Update plugins/federations.js

plugins/federations.js

@@ -80,6 +80,51 @@ FedsRoutes.post("/api/v2/federation/newfed", authenticateApiKey, apiLimiter, asy
   }
 });
 
+/**
+ * @swagger
+ * /api/v2/federation/subfed:
+ *   post:
+ *     summary: Add a sub-federation
+ *     tags: [Federation]
+ *     description: Adds a federation as a sub-federation under a parent federation.
+ *     security:
+ *       - apiKeyAuth: []
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             properties:
+ *               parent_uuid:
+ *                 type: string
+ *                 description: UUID of the parent federation.
+ *               child_uuid:
+ *                 type: string
+ *                 description: UUID of the child federation to be added as a sub-federation.
+ *     parameters:
+ *       - in: header
+ *         name: x-api-key
+ *         required: true
+ *         description: API key for authentication.
+ *         schema:
+ *           type: string
+ *     responses:
+ *       200:
+ *         description: Sub-federation added successfully.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 message:
+ *                   type: string
+ *                   example: "Federation ChildName is now a sub-federation of ParentName"
+ *       404:
+ *         description: Parent or child federation not found.
+ *       500:
+ *         description: Internal server error.
+ */
 FedsRoutes.post("/api/v2/federation/subfed", authenticateApiKey, apiLimiter, async (req, res) => {
   try {
     const { parent_uuid, child_uuid } = req.body;