docs: drawer

Services/server/src/controllers/folderController.ts

@@ -31,6 +31,10 @@ if (!DEFAULT_INDEX) throw Error("Default ElasticSearch index must be specified."
 
 @Route("/cabinet/{cabinetName}/drawer/{drawerName}/folder")
 export class FolderController extends Controller {
+  /**
+   * @example cabinetName "ตู้เอกสาร 1"
+   * @example drawerName "ลิ้นชัก 1"
+   */
   @Get("/")
   @Tags("แฟ้ม")
   @Security("bearerAuth")
@@ -50,6 +54,10 @@ export class FolderController extends Controller {
     return list;
   }
 
+  /**
+   * @example cabinetName "ตู้เอกสาร 1"
+   * @example drawerName "ลิ้นชัก 1"
+   */
   @Post("/")
   @Tags("แฟ้ม")
   @Security("bearerAuth", ["admin"])
@@ -58,7 +66,13 @@ export class FolderController extends Controller {
   @SuccessResponse(HttpStatusCode.CREATED, "สำเร็จ")
   public async createFolder(
     @Request() request: { user: { preferred_username: string } },
-    @Body() body: { name: string },
+    @Body()
+    body: {
+      /**
+       * @example "แฟ้ม 1"
+       */
+      name: string;
+    },
     @Path() cabinetName: string,
     @Path() drawerName: string,
   ) {
@@ -80,13 +94,24 @@ export class FolderController extends Controller {
     return this.setStatus(HttpStatusCode.CREATED);
   }
 
+  /**
+   * @example cabinetName "ตู้เอกสาร 1"
+   * @example drawerName "ลิ้นชัก 1"
+   * @example folderName "แฟ้ม 1"
+   */
   @Put("/{folderName}")
   @Tags("แฟ้ม")
   @Security("bearerAuth", ["admin"])
   @Response(HttpStatusCode.INTERNAL_SERVER_ERROR, "เกิดข้อผิดพลาดไม่สามารถย้ายไฟล์ได้")
   @SuccessResponse(HttpStatusCode.NO_CONTENT, "สำเร็จ")
   public async editFolder(
-    @Body() body: { name: string },
+    @Body()
+    body: {
+      /**
+       * @example "แฟ้มใหม่"
+       */
+      name: string;
+    },
     @Path() cabinetName: string,
     @Path() drawerName: string,
     @Path() folderName: string,
@@ -139,6 +164,11 @@ export class FolderController extends Controller {
     return this.setStatus(HttpStatusCode.NO_CONTENT);
   }
 
+  /**
+   * @example cabinetName "ตู้เอกสาร 1"
+   * @example drawerName "ลิ้นชัก 1"
+   * @example folderName "แฟ้ม 1"
+   */
   @Delete("/{folderName}")
   @Tags("แฟ้ม")
   @Security("bearerAuth", ["admin"])