PetLog_BE/src/main/java/com/petlog/docs/MemberControllerDocs.java at 4ecf880e6bc6cbb52b56d73c8e38fd2b11d44804 · PetLog-project/PetLog_BE · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
package com.petlog.docs;

import com.petlog.auth.resolver.Authenticated;
import com.petlog.member.controller.dto.request.UpdateIsNotificationEnabledRequestDto;
import com.petlog.member.controller.dto.response.GetIsNotificationEnabledResponseDto;
import io.swagger.v3.oas.annotations.Operation;
import com.petlog.common.response.ApiResponse;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.http.ResponseEntity;

@Tag(name = "회원 API")
public interface MemberControllerDocs {

    @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "200", description = "알림 수신 여부 조회에 성공하였습니다.")
    @Operation(summary = "알림 수신 여부 조회 API")
    ResponseEntity<ApiResponse<GetIsNotificationEnabledResponseDto>> getIsNotificationEnabled(@Authenticated final Long memberId);

    @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "200", description = "알림 수신 여부 설정에 성공하였습니다.")
    @Operation(summary = "알림 수신 여부 설정 API")
    ResponseEntity<ApiResponse<Void>> updateIsNotificationEnabled(@Authenticated final Long memberId, final UpdateIsNotificationEnabledRequestDto request);

    @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "200", description = "회원 탈퇴에 성공하였습니다.")
    @Operation(summary = "회원 탈퇴 API")
    ResponseEntity<ApiResponse<Void>> withdraw();
}