devoops-server/gss-api-app/src/main/java/com/devoops/controller/docs/RepositoryControllerSwagger.java at 5b83e1002bc502c65a2d7e966de9b7931d62dd30 · mash-up-kr/devoops-server · 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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
package com.devoops.controller.docs;

import com.devoops.domain.entity.user.User;
import com.devoops.dto.request.RepositorySaveRequest;
import com.devoops.dto.response.MyRepositoriesResponse;
import com.devoops.dto.response.RepositoryPullRequestResponses;
import com.devoops.dto.response.RepositorySaveResponse;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.parameters.RequestBody;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.security.SecurityRequirement;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.http.ResponseEntity;

@Tag(name = "Repository API")
@SecurityRequirement(name = "Authorization")
public interface RepositoryControllerSwagger {

    @Operation(
            summary = "레포지토리 PR 리스트 반환",
            responses = {@ApiResponse(
                    responseCode = "200",
                    description = "레포지토리 PR 리스트 반환 성공",
                    content = @Content(schema = @Schema(implementation = RepositoryPullRequestResponses.class)))
            }
    )
    ResponseEntity<RepositoryPullRequestResponses> getRepositoryPullRequests(
            @Parameter(hidden = true) User user,
            @Parameter(
                    name = "repositoryId",
                    description = "레포지토리 ID",
                    example = "100"
            ) long repositoryId,

            @Parameter(
                    name = "size",
                    description = "페이지 사이즈 크기",
                    example = "5"
            )
            int size,
            @Parameter(
                    name = "page",
                    description = "페이지 숫자",
                    example = "10"
            )
            int page
    );

    @Operation(
            summary = "회원의 PR 리스트 반환",
            responses = {@ApiResponse(
                    responseCode = "200",
                    description = "회원 소유의 PR 리스트 반환 성공",
                    content = @Content(schema = @Schema(implementation = RepositoryPullRequestResponses.class)))
            }
    )
    ResponseEntity<RepositoryPullRequestResponses> getRepositoryEntirePullRequests(
            @Parameter(hidden = true) User user,
            @Parameter(
                    name = "size",
                    description = "페이지 사이즈 크기",
                    example = "5"
            )
            int size,
            @Parameter(
                    name = "page",
                    description = "페이지 숫자",
                    example = "10"
            )
            int page
    );

    @Operation(
            summary = "신규 레포지토리 저장",
            requestBody = @RequestBody(content = @Content(schema = @Schema(implementation = RepositorySaveRequest.class))),
            responses = {@ApiResponse(
                    responseCode = "201",
                    description = "신규 레포지토리 생성 성공",
                    content = @Content(schema = @Schema(implementation = RepositorySaveResponse.class)))
            }
    )
    ResponseEntity<RepositorySaveResponse> saveRepository(
            @Parameter(hidden = true) User user,
            RepositorySaveRequest request
    );

    @Operation(
            summary = "나의 레포지토리 목록 조회",
            responses = {@ApiResponse(
                    responseCode = "200",
                    description = "나의 레포지토리 목록 조회 성공",
                    content = @Content(schema = @Schema(implementation = MyRepositoriesResponse.class)))
            }
    )
    ResponseEntity<MyRepositoriesResponse> getMyRepositories(@Parameter(hidden = true) User user);

    @Operation(
            summary = "레포지토리 삭제",
            responses = {@ApiResponse(
                    responseCode = "204",
                    description = "나의 레포지토리 삭제 성공")}
    )
    ResponseEntity<Void> deleteRepositories(
            @Parameter(hidden = true) User user,
            long repositoryId
    );
}