package roomescape.member.docs

import io.swagger.v3.oas.annotations.Operation
import io.swagger.v3.oas.annotations.responses.ApiResponse
import io.swagger.v3.oas.annotations.responses.ApiResponses
import io.swagger.v3.oas.annotations.tags.Tag
import org.springframework.http.ResponseEntity
import roomescape.auth.web.support.Admin
import roomescape.common.dto.response.CommonApiResponse
import roomescape.member.web.MembersResponse

@Tag(name = "2. 회원 API", description = "회원 정보를 관리할 때 사용합니다.")
interface MemberAPI {
    @Admin
    @Operation(summary = "모든 회원 조회", tags = ["관리자 로그인이 필요한 API"])
    @ApiResponses(
            ApiResponse(
                    responseCode = "200",
                    description = "성공",
                    useReturnTypeSchema = true
            )
    )
    fun readAllMembers(): ResponseEntity<CommonApiResponse<MembersResponse>>
}