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

[DOCS] 이메일 전송 내역 삭제 문서 보충 #70

Open
goldentrash opened this issue Jan 14, 2025 · 1 comment
Open

[DOCS] 이메일 전송 내역 삭제 문서 보충 #70

goldentrash opened this issue Jan 14, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@goldentrash
Copy link
Contributor

image

현재 생성된 문서는 위와 같습니다. #57 에서 대상 EmailTask를 QS로 보냄을 논의한 적이 있는데, 현재 문서에는 드러나지 않고 있네요. API에서 Parameter 전달 방법에 대한 문서 보충이 필요합니다.

@goldentrash goldentrash added the documentation Improvements or additions to documentation label Jan 14, 2025
@goldentrash
Copy link
Contributor Author

현 테스트 코드에 해당 부분이 누락되어 있지 않았네요. 혹시 openapi spec v3에 DELETE는 QS를 포함하지 못하도록 하는 규칙이 있나 알아봤는데 이 또한 해당사항이 없습니다. (오히려 request body를 path param이나 QS로 옮기라는 조언을 발견...)

        //when
        ResultActions result = mockMvc.perform(
                RestDocumentationRequestBuilders.delete("/api/v1/emails")
                        .header("Authorization", "Bearer " + jwt)
                        .queryParam("emailIds", "1", "2")
                        .contentType(APPLICATION_JSON)
                        .with(csrf()));

혹시 몰라 테스트 코드를 위와 같이 변경해 보았는데 여전히 문서에는 나타나지 않았습니다. 어쩌면 com.epages.restdocs-api-spec의 버그일수도 모르겠네요.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant