From 5424785262849f71fc26f45d2c6c9705d118e359 Mon Sep 17 00:00:00 2001
From: sungjindev <sungjin.developer@gmail.com>
Date: Sat, 24 Feb 2024 15:17:56 +0900
Subject: [PATCH] =?UTF-8?q?feat=20:=20=EC=82=AC=EC=9A=A9=EC=9E=90=20?=
 =?UTF-8?q?=EC=A0=9C=EB=B3=B4=20=EA=B4=80=EB=A0=A8=20API=20=EB=AA=85?=
 =?UTF-8?q?=EC=84=B8=20=EB=AC=B8=EC=84=9C=EC=97=90=20Exceptions=20?=
 =?UTF-8?q?=EA=B4=80=EB=A0=A8=20=EB=82=B4=EC=9A=A9=20=EC=B6=94=EA=B0=80=20?=
 =?UTF-8?q?(#113)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../nainga/domain/report/api/ReportApi.java   | 21 ++++++++++++++++---
 1 file changed, 18 insertions(+), 3 deletions(-)

diff --git a/src/main/java/com/nainga/nainga/domain/report/api/ReportApi.java b/src/main/java/com/nainga/nainga/domain/report/api/ReportApi.java
index 7e5c4c3..d2cc173 100644
--- a/src/main/java/com/nainga/nainga/domain/report/api/ReportApi.java
+++ b/src/main/java/com/nainga/nainga/domain/report/api/ReportApi.java
@@ -27,7 +27,12 @@ public class ReportApi {
             "formattedAddress: 등록 요청하는 가게 주소<br>" +
             "certifications: 가게가 가지고 있는 인증제들의 이름을 담은 리스트. 착한가격업소, 모범음식점, 안심식당이 아닌 경우 예외 발생<br>" +
             "[Response Body]<br>" +
-            "등록된 reportId<br>")
+            "등록된 reportId<br>" +
+            "[Exceptions]<br>" +
+            "- 잘못된 인증제 이름이 들어온 경우<br>" +
+            "httpStatusValue: 404<br>" +
+            "httpStatusCode: INVALID_CERTIFICATION<br>" +
+            "message: There is a wrong certification. You can only use certifications such as 착한가격업소, 모범음식점, 안심식당.<br>")
     @PostMapping("api/report/newStore/v1")
     public Result<Long> saveNewStoreReport(@Valid @RequestBody SaveNewStoreReportRequest saveNewStoreReportRequest) {
         Long reportId = reportService.saveNewStoreReport(saveNewStoreReportRequest);
@@ -42,7 +47,12 @@ public Result<Long> saveNewStoreReport(@Valid @RequestBody SaveNewStoreReportReq
             "storeId: 수정 혹은 삭제를 요청하는 가게 id<br>" +
             "contents: 제보 내용<br>" +
             "[Response Body]<br>" +
-            "등록된 reportId<br>")
+            "등록된 reportId<br>" +
+            "[Exceptions]<br>" +
+            "- 잘못된 dtype이 들어온 경우<br>" +
+            "httpStatusValue: 404<br>" +
+            "httpStatusCode: INVALID_DTYPE<br>" +
+            "message: There is a wrong dtype. You can only use a dtype such as fix or del.<br>")
     @PostMapping("api/report/specificStore/v1")
     public Result<Long> saveSpecificStoreReport(@Valid @RequestBody SaveSpecificStoreReportRequest saveSpecificStoreReportRequest) {
         Long reportId = reportService.saveSpecificStoreReport(saveSpecificStoreReportRequest);
@@ -55,7 +65,12 @@ public Result<Long> saveSpecificStoreReport(@Valid @RequestBody SaveSpecificStor
             "[Request Body]<br>" +
             "reportId: 검색할 사용자 제보의 reportId. 유효하지 않은 reportId의 경우 예외 발생<br>" +
             "[Response Body]<br>" +
-            "해당 reportId로 검색된 사용자 제보 내용<br>")
+            "해당 reportId로 검색된 사용자 제보 내용<br>" +
+            "[Exceptions]<br>" +
+            "- 잘못된 reportId가 들어온 경우<br>" +
+            "httpStatusValue: 404<br>" +
+            "httpStatusCode: INVALID_REPORT_ID<br>" +
+            "message: There is a wrong reportId.<br>")
     @GetMapping("api/report/byId/v1")
     public Result<Report> findById(@NotNull @RequestParam(value = "reportId") Long reportId) {
         Report report = reportService.findById(reportId);