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

support(jsdoc): Add swagger document to user-activation.ts

Atsushi Nakatsugawa 1 год назад
Родитель
Сommit
239645a9bc
1 измененных файлов с 20 добавлено и 0 удалено
  1. 20 0
      apps/app/src/server/routes/user-activation.ts

+ 20 - 0
apps/app/src/server/routes/user-activation.ts

@@ -12,6 +12,26 @@ type CrowiReq = ReqWithUserRegistrationOrder & {
   crowi: Crowi,
   crowi: Crowi,
 }
 }
 
 
+/**
+ * @swagger
+ *
+ * /user-activation/:token:
+ *   get:
+ *     summary: /user-activation/:token
+ *     tags: [Users]
+ *     parameters:
+ *       - name: token
+ *         in: path
+ *         required: true
+ *         type: string
+ *     responses:
+ *       200:
+ *         description: User activation successful
+ *         content:
+ *           text/html:
+ *             schema:
+ *               type: string
+ */
 export const renderUserActivationPage = (crowi: Crowi) => {
 export const renderUserActivationPage = (crowi: Crowi) => {
   return (req: CrowiReq, res: Response): void => {
   return (req: CrowiReq, res: Response): void => {
     const { userRegistrationOrder } = req;
     const { userRegistrationOrder } = req;