Update plugins/federations.js

plugins/federations.js

@@ -4,6 +4,66 @@ import { authenticateApiKey, apiLimiter } from '../middleware/midware.js';
 import { Federation } from '../models.js';
 const FedsRoutes = express.Router();
 
+/**
+ * @swagger
+ * /api/v2/federation/newfed:
+ *   post:
+ *     summary: Create a new federation
+ *     tags: [Federation]
+ *     description: Creates a new federation with a unique name and owner.
+ *     security:
+ *       - apiKeyAuth: []
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             properties:
+ *               name:
+ *                 type: string
+ *                 description: The unique name of the federation.
+ *               owner:
+ *                 type: integer
+ *                 description: The user ID of the federation owner.
+ *     parameters:
+ *       - in: header
+ *         name: x-api-key
+ *         required: true
+ *         description: API key for authentication.
+ *         schema:
+ *           type: string
+ *     responses:
+ *       200:
+ *         description: Federation created successfully.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 message:
+ *                   type: string
+ *                   example: Federation created successfully
+ *                 federation:
+ *                   type: object
+ *                   properties:
+ *                     name:
+ *                       type: string
+ *                     owner:
+ *                       type: integer
+ *                     banned_users:
+ *                       type: array
+ *                       items:
+ *                         type: integer
+ *                     sub_federations:
+ *                       type: array
+ *                       items:
+ *                         type: string
+ *       400:
+ *         description: Federation already exists or missing parameters.
+ *       500:
+ *         description: Internal server error.
+ */
 FedsRoutes.post("/api/v2/federation/newfed", authenticateApiKey, apiLimiter, async (req, res) => {
   try {
     const { name, owner } = req.body;