Skip to content

Commit 757fae2

Browse files
committed
Docs: deleteCommit API Swagger 수정
1 parent 5bb7cbb commit 757fae2

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

src/main/java/io/ejangs/docsa/domain/commit/swagger/DeleteCommitDocs.java

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@
2525
2626
삭제 조건은 아래와 같습니다:
2727
28-
- 각 브랜치의 LeafCommit만 삭제 가능
29-
- 어느 브랜치의 FromCommit이면 삭제 불가
30-
- 브랜치의 RootCommit은 삭제 불가(RootCommit까지 삭제하고 싶은 경우 브랜치 삭제를 권장합니다)
28+
- 각 버전의 LeafCommit만 삭제 가능
29+
- 어느 버전의 FromCommit이면 삭제 불가
30+
- 버전의 RootCommit은 삭제 불가(RootCommit까지 삭제하고 싶은 경우 버전 삭제를 권장합니다)
3131
""",
3232
parameters = {
3333
@Parameter(
@@ -39,7 +39,7 @@
3939
),
4040
@Parameter(
4141
name = "commitId",
42-
description = "삭제하려는 commit의 id",
42+
description = "삭제하려는 기록의 id",
4343
example = "1",
4444
required = true,
4545
in = ParameterIn.PATH
@@ -58,7 +58,18 @@
5858
mediaType = MediaType.APPLICATION_JSON_VALUE,
5959
examples = {
6060
@ExampleObject(
61-
name = "삭제하려는 기록이 LeafCommit이 아니거나 FromCommit, RootCommit인 경우 삭제할 수 없다.",
61+
name = "삭제하려는 기록이 LeafCommit이 아닐 경우 삭제할 수 없다.",
62+
value = """
63+
{
64+
"status": 400,
65+
"message": "버전의 마지막 기록이 아닙니다.",
66+
"error": "IS_NOT_LEAF_COMMIT"
67+
}
68+
"""
69+
70+
),
71+
@ExampleObject(
72+
name = "삭제하려는 기록이 FromCommit, RootCommit인 경우 삭제할 수 없다.",
6273
value = """
6374
{
6475
"status": 400,
@@ -120,18 +131,18 @@
120131
),
121132
@ApiResponse(
122133
responseCode = "500",
123-
description = "기록 삭제 실패 - 서버 내에서 알 수 없는 이유로 기록 삭제 실패",
134+
description = "기록 삭제 실패 - MySQL 또는 MongoDB 데이터 처리 실패",
124135
content = @Content(
125136
schema = @Schema(implementation = ErrorResponse.class),
126137
mediaType = MediaType.APPLICATION_JSON_VALUE,
127138
examples = {
128139
@ExampleObject(
129-
name = "서버 오류로 기록 삭제 실패",
140+
name = "MySQL 또는 MongoDB 데이터 처리 실패",
130141
value = """
131142
{
132143
"status": 500,
133-
"message": "서버 오류로 인해 기록 삭제에 실패했습니다.",
134-
"error": "FAIL_DELETE_COMMIT"
144+
"message": "데이터 처리 중 오류가 발생했습니다. 잠시 후 다시 시도해주세요.",
145+
"error": "DATABASE_ERROR"
135146
}
136147
"""
137148
),

0 commit comments

Comments
 (0)