Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat : 개념학습 스웨거 설명 추가 (#15) #57

Merged
merged 1 commit into from
Feb 6, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@ public class ConceptController {

private final ConceptService conceptService;

@Operation(summary = "개념 학습 세트 조회", description = "개념 학습 세트를 조회합니다.")
@Operation(
summary = "개념 학습 세트 조회",
description = "개념 학습 세트를 조회합니다. 개념 학습 세트 id와 레벨을 받아 개념 학습 목록을 반환합니다.")
@GetMapping("/{learningSetId}/concepts")
public ResponseEntity<ApiResponse<Object>> getConcepts(
final @PathVariable("learningSetId") long learningSetId,
Expand All @@ -42,7 +44,9 @@ public ResponseEntity<ApiResponse<Object>> getConcepts(
.body(ApiResponse.from(ConceptListResponse.toConceptListResponse(conceptListDTO)));
}

@Operation(summary = "개념 학습 완료 처리", description = "개념 학습을 완료 처리합니다.")
@Operation(
summary = "개념 학습 완료 처리",
description = "개념 학습을 완료 처리합니다. 개념 학습 세트 id와 레벨을 받아 개념 학습을 완료합니다.")
@PostMapping("/{learningSetId}/concepts/complete")
public ResponseEntity<ApiResponse<?>> completeConcept(
final @AuthenticationPrincipal CustomUserDetails currentUser,
Expand Down Expand Up @@ -74,7 +78,9 @@ public ResponseEntity<ApiResponse<Object>> unscrapConcept(
return ResponseEntity.status(HttpStatus.OK).body(ApiResponse.from(ApiResponse.EMPTY_RESPONSE));
}

@Operation(summary = "개별 개념 학습 조회", description = "개별 개념 학습을 조회합니다.")
@Operation(
summary = "개별 개념 학습 조회",
description = "개별 개념 학습을 조회합니다." + " 개념 id를 받아 개념 상세 정보를 반환합니다. 스크랩한 개념보기 기능을 위한 API입니다.")
@GetMapping("/concept/{conceptId}")
public ResponseEntity<ApiResponse<Object>> getConcept(
final @PathVariable("conceptId") long conceptId) {
Expand Down