Skip to content

Commit 00160fc

Browse files
committed
CLAP-175 Docs: Swagger 내용 작성
1 parent 2ee702a commit 00160fc

File tree

3 files changed

+12
-0
lines changed

3 files changed

+12
-0
lines changed

src/main/java/clap/server/adapter/inbound/web/admin/ManagementLabelController.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
import clap.server.application.port.inbound.admin.UpdateLabelUsecase;
88
import clap.server.common.annotation.architecture.WebAdapter;
99
import io.swagger.v3.oas.annotations.Operation;
10+
import io.swagger.v3.oas.annotations.Parameter;
11+
import io.swagger.v3.oas.annotations.enums.ParameterIn;
1012
import io.swagger.v3.oas.annotations.tags.Tag;
1113
import lombok.RequiredArgsConstructor;
1214
import org.springframework.security.access.annotation.Secured;
@@ -32,6 +34,7 @@ public void addLabel(@AuthenticationPrincipal SecurityUserDetails userInfo,
3234
}
3335

3436
@Operation(summary = "구분(label) 수정 API")
37+
@Parameter(name = "labelId", description = "구분(label) 고유 ID", required = true, in = ParameterIn.PATH)
3538
@PatchMapping("/{labelId}")
3639
@Secured({"ROLE_ADMIN"})
3740
public void updateLabel(@AuthenticationPrincipal SecurityUserDetails userInfo,
@@ -42,6 +45,7 @@ public void updateLabel(@AuthenticationPrincipal SecurityUserDetails userInfo,
4245
}
4346

4447
@Operation(summary = "구분(label) 삭제 API")
48+
@Parameter(name = "labelId", description = "구분(label) 고유 ID", required = true, in = ParameterIn.PATH)
4549
@DeleteMapping("/{labelId}")
4650
@Secured({"ROLE_ADMIN"})
4751
public void deleteLabel(@AuthenticationPrincipal SecurityUserDetails userInfo,
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
package clap.server.adapter.inbound.web.dto.label;
22

3+
import clap.server.adapter.outbound.persistense.entity.member.constant.MemberRole;
34
import clap.server.adapter.outbound.persistense.entity.task.constant.LabelColor;
5+
import io.swagger.v3.oas.annotations.media.Schema;
46

57
public record AddAndEditLabelRequest(
68

9+
@Schema(description = "구분(label) 이름")
710
String labelName,
11+
@Schema(description = "구분(label) 색상")
812
LabelColor labelColor
913
) {}
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
package clap.server.adapter.inbound.web.dto.label;
22

33
import clap.server.adapter.outbound.persistense.entity.task.constant.LabelColor;
4+
import io.swagger.v3.oas.annotations.media.Schema;
45

56
public record FindLabelListResponse(
7+
@Schema(description = "구분(label) 고유 ID")
68
Long labelId,
9+
@Schema(description = "구분(label) 이름")
710
String labelName,
11+
@Schema(description = "구분(label) 색상")
812
LabelColor labelColor
913
) {
1014
}

0 commit comments

Comments
 (0)