support(jsdoc): Add swagger document to external-user-group-relation.ts

apps/app/src/features/external-user-group/server/routes/apiv3/external-user-group-relation.ts

@@ -28,6 +28,46 @@ module.exports = (crowi: Crowi): Router => {
     ],
   };
 
+  /**
+   * @swagger
+   * /external-user-group-relations:
+   *   get:
+   *     summary: /external-user-group-relations
+   *     description: Get user group relations
+   *     tags: [ExternalUserGroups]
+   *     security:
+   *       - cookieAuth: []
+   *     parameters:
+   *       - name: groupIds
+   *         in: query
+   *         description: The group IDs to get relations for
+   *         type: array
+   *         items:
+   *           type: string
+   *       - name: childGroupIds
+   *         in: query
+   *         description: The child group IDs to get relations for
+   *         required: false
+   *         type: array
+   *         items:
+   *           type: string
+   *     responses:
+   *       200:
+   *         description: The user group relations
+   *         content:
+   *           application/json:
+   *             schema:
+   *               type: object
+   *               properties:
+   *                 userGroupRelations:
+   *                   type: array
+   *                   items:
+   *                     type: object
+   *                 relationsOfChildGroups:
+   *                   type: array
+   *                   items:
+   *                     type: object
+   */
   router.get('/', loginRequiredStrictly, adminRequired, validators.list, async(req: Request, res: ApiV3Response) => {
     const { query } = req;