fix: 잘못 기입된 주석 변경

ok-su-su · Sep 13, 2024 · c9ead1b · c9ead1b
1 parent efdf67e
commit c9ead1b
Showing 1 changed file with 15 additions and 4 deletions.
diff --git a/api/src/main/kotlin/com/oksusu/susu/api/envelope/presentation/DevEnvelopeResource.kt b/api/src/main/kotlin/com/oksusu/susu/api/envelope/presentation/DevEnvelopeResource.kt
@@ -14,15 +14,26 @@ import org.springframework.web.bind.annotation.GetMapping
 import org.springframework.web.bind.annotation.RequestMapping
 import org.springframework.web.bind.annotation.RestController
 
-@Tag(name = SwaggerTag.DEV_ENVELOPE_SWAGGER_TAG, description = "개발용 OAuth API")
+@Tag(name = SwaggerTag.DEV_ENVELOPE_SWAGGER_TAG, description = "개발용 Envelope API")
 @RestController
 @RequestMapping(value = ["/api/v1/dev/envelopes"], produces = [MediaType.APPLICATION_JSON_VALUE])
 class DevEnvelopeResource(
     private val envelopeFacade: EnvelopeFacade,
 ) {
-    @Operation(tags = [SwaggerTag.DEV_SWAGGER_TAG], summary = "hour summary 호출")
-    @GetMapping("/hour-summaries")
-    suspend fun getHourSummaries(
+    /**
+     * **검색조건**
+     * - uid: 조회할 대상
+     * - types: SENT: 보낸 봉투만, RECEIVED: 받은 봉투만, 그외 케이스는 전체 봉투 정보
+     * - friendName: 친구 이름으로 검색, ex) %동건%
+     *
+     * **정렬조건**
+     * - createdAt: 생성일
+     * - amount: 봉투 금액
+     * - handedOverAt: 전달일
+     */
+    @Operation(tags = [SwaggerTag.DEV_SWAGGER_TAG], summary = "봉투 검색")
+    @GetMapping
+    suspend fun search(
         adminUser: AdminUser,
         @ParameterObject request: DevSearchEnvelopeRequest,
         @ParameterObject pageRequest: SusuPageRequest,