fix jsdoc

apps/app/src/features/growi-plugin/server/routes/apiv3/admin/index.ts

@@ -105,7 +105,8 @@ module.exports = (crowi: Crowi): Router => {
    *       - name: id
    *         in: path
    *         required: true
-   *         type: string
+   *         schema:
+   *           type: string
    *     responses:
    *       200:
    *         description: OK
@@ -158,7 +159,8 @@ module.exports = (crowi: Crowi): Router => {
    *       - name: id
    *         in: path
    *         required: true
-   *         type: string
+   *         schema:
+   *           type: string
    *     responses:
    *       200:
    *         description: OK

apps/app/src/features/templates/server/routes/apiv3/index.ts

@@ -51,7 +51,8 @@ module.exports = (crowi: Crowi) => {
    *         in: query
    *         description: Whether to include invalid templates
    *         required: false
-   *         type: boolean
+   *         schema:
+   *           type: boolean
    *     responses:
    *       200:
    *         description: OK
@@ -126,9 +127,15 @@ module.exports = (crowi: Crowi) => {
    *       - name: templateId
    *         in: path
    *         description: The template ID
+   *         required: true
+   *         schema:
+   *           type: string
    *       - name: locale
    *         in: path
    *         description: The locale
+   *         required: true
+   *         schema:
+   *           type: string
    *     responses:
    *       200:
    *         description: OK
@@ -170,15 +177,27 @@ module.exports = (crowi: Crowi) => {
    *       - name: organizationId
    *         in: path
    *         description: The organization ID
+   *         required: true
+   *         schema:
+   *           type: string
    *       - name: reposId
    *         in: path
    *         description: The repository ID
+   *         required: true
+   *         schema:
+   *           type: string
    *       - name: templateId
    *         in: path
    *         description: The template ID
+   *         required: true
+   *         schema:
+   *           type: string
    *       - name: locale
    *         in: path
    *         description: The locale
+   *         required: true
+   *         schema:
+   *           type: string
    *     responses:
    *       200:
    *         description: OK

apps/app/src/server/routes/apiv3/activity.ts

@@ -190,15 +190,18 @@ module.exports = (crowi: Crowi): Router => {
    *       - name: limit
    *         in: query
    *         required: false
-   *         type: integer
+   *         schema:
+   *           type: integer
    *       - name: offset
    *         in: query
    *         required: false
-   *         type: integer
+   *         schema:
+   *           type: integer
    *       - name: searchFilter
    *         in: query
    *         required: false
-   *         type: string
+   *         schema:
+   *           type: string
    *     responses:
    *       200:
    *         description: Activity fetched successfully

apps/app/src/server/routes/apiv3/forgot-password.js

@@ -98,7 +98,7 @@ module.exports = (crowi) => {
    *      summary: Request password reset
    *      tags: [Users]
    *      security:
-   *        -
+   *        - cookieAuth: []
    *      requestBody:
    *        required: true
    *        content:
@@ -160,7 +160,7 @@ module.exports = (crowi) => {
    *      summary: Reset password
    *      tags: [Users]
    *      security:
-   *        -
+   *        - cookieAuth: []
    *      requestBody:
    *        required: true
    *        content:

apps/app/src/server/routes/apiv3/g2g-transfer.ts

@@ -356,7 +356,7 @@ module.exports = (crowi: Crowi): Router => {
    *                  description: Metadata of the attachment
    *      responses:
    *        '200':
-   *          description:
+   *          description: Successfully imported attachment file
    *          content:
    *            application/json:
    *              schema:
@@ -406,7 +406,7 @@ module.exports = (crowi: Crowi): Router => {
    *        - transferHeaderAuth: []
    *      responses:
    *        '200':
-   *          description:
+   *          description: Successfully got GROWI information
    *          content:
    *            application/json:
    *              schema:

apps/app/src/server/routes/apiv3/page-listing.ts

@@ -114,7 +114,8 @@ const routerFactory = (crowi: Crowi): Router => {
    *       - name: path
    *         in: query
    *         required: true
-   *         type: string
+   *         schema:
+   *           type: string
    *     responses:
    *       200:
    *         description: Get the ancestors and children of a page
@@ -177,10 +178,12 @@ const routerFactory = (crowi: Crowi): Router => {
    *     parameters:
    *       - name: id
    *         in: query
-   *         type: string
+   *         schema:
+   *           type: string
    *       - name: path
    *         in: query
-   *         type: string
+   *         schema:
+   *           type: string
    *     responses:
    *       200:
    *         description: Get the children of a page
@@ -231,16 +234,22 @@ const routerFactory = (crowi: Crowi): Router => {
    *     parameters:
    *       - name: pageIds
    *         in: query
-   *         type: array
+   *         schema:
+   *           type: array
+   *           items:
+   *             type: string
    *       - name: path
    *         in: query
-   *         type: string
+   *         schema:
+   *           type: string
    *       - name: attachBookmarkCount
    *         in: query
-   *         type: boolean
+   *         schema:
+   *           type: boolean
    *       - name: attachShortBody
    *         in: query
-   *         type: boolean
+   *         schema:
+   *           type: boolean
    *     responses:
    *       200:
    *         description: Get the information of a page

apps/app/src/server/routes/apiv3/page/index.ts

@@ -760,7 +760,7 @@ module.exports = (crowi) => {
 
   /**
    * @swagger
-   *   /:pageId/grant:
+   *   /{pageId}/grant:
    *     put:
    *       tags: [Page]
    *       security:
@@ -825,12 +825,19 @@ module.exports = (crowi) => {
   /**
   * @swagger
   *
-  *    /page/export:
+  *    /page/export/{pageId}:
   *      get:
   *        tags: [Page]
   *        security:
   *          - cookieAuth: []
   *        description: return page's markdown
+  *        parameters:
+  *          - name: pageId
+  *            in: path
+  *            description: ID of the page
+  *            required: true
+  *            schema:
+  *              type: string
   *        responses:
   *          200:
   *            description: Return page's markdown
@@ -1046,7 +1053,7 @@ module.exports = (crowi) => {
   /**
    * @swagger
    *
-   *   /:pageId/content-width:
+   *   /{pageId}/content-width:
    *     put:
    *       tags: [Page]
    *       summary: Update content width
@@ -1099,7 +1106,7 @@ module.exports = (crowi) => {
 
   /**
    * @swagger
-   *   /:pageId/publish:
+   *   /{pageId}/publish:
    *     put:
    *       tags: [Page]
    *       summary: Publish page
@@ -1123,7 +1130,7 @@ module.exports = (crowi) => {
 
   /**
    * @swagger
-   *   /:pageId/unpublish:
+   *   /{pageId}/unpublish:
    *     put:
    *       tags: [Page]
    *       summary: Unpublish page
@@ -1147,7 +1154,7 @@ module.exports = (crowi) => {
 
   /**
    * @swagger
-   *   /:pageId/yjs-data:
+   *   /{pageId}/yjs-data:
    *     get:
    *       tags: [Page]
    *       summary: Get Yjs data
@@ -1182,7 +1189,7 @@ module.exports = (crowi) => {
 
   /**
    * @swagger
-   *   /:pageId/sync-latest-revision-body-to-yjs-draft:
+   *   /{pageId}/sync-latest-revision-body-to-yjs-draft:
    *     put:
    *       tags: [Page]
    *       summary: Sync latest revision body to Yjs draft

apps/app/src/server/routes/apiv3/pages/index.js

@@ -368,7 +368,9 @@ module.exports = (crowi) => {
     *          200:
     *            description: Succeeded to resume rename page operation.
     *            content:
-    *              description: Empty response
+    *              application/json:
+    *                schema:
+    *                  type: object
     */
   router.post('/resume-rename', accessTokenParser, loginRequiredStrictly, validator.resumeRenamePage, apiV3FormValidator,
     async(req, res) => {