Просмотр исходного кода

support(jsdoc): add swagger document to logout.js

Atsushi Nakatsugawa 1 год назад
Родитель
Сommit
339ec1023b
1 измененных файлов с 15 добавлено и 0 удалено
  1. 15 0
      apps/app/src/server/routes/apiv3/logout.js

+ 15 - 0
apps/app/src/server/routes/apiv3/logout.js

@@ -13,6 +13,21 @@ module.exports = (crowi) => {
   const activityEvent = crowi.event('activity');
   const addActivity = generateAddActivityMiddleware(crowi);
 
+  /**
+   * @swagger
+   *  /logout:
+   *    post:
+   *      tags: [Users]
+   *      security:
+   *        - cookieAuth: []
+   *      summary: Logout user
+   *      description: Logout the currently authenticated user
+   *      responses:
+   *        200:
+   *          description: Successfully logged out
+   *        500:
+   *          description: Internal server error
+   */
   router.post('/', addActivity, async(req, res) => {
     req.session.destroy();