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(be): re-write admin problem module api docs #1296

Merged
merged 7 commits into from
Feb 6, 2024

Conversation

Jaehyeon1020
Copy link
Member

@Jaehyeon1020 Jaehyeon1020 commented Feb 4, 2024

Description

Closes #1264

Admin Problem 모듈의 api docs를 새로운 api docs convention에 맞춰 재작성합니다.

Additional context

일부 예외 처리 로직이 잘못되어 UNPROCESSABLE 또는 NOT_FOUND로 표시되어야 하는데 INTERNAL_SERVER_ERROR로 표시되는 문제가 있습니다. 이 경우 일단 assert에 error code를 추가해놓지 않았고, 문제 수정 후 추가할 예정입니다.
=> 수정했습니다


Before submitting the PR, please make sure you do the following

Copy link

vercel bot commented Feb 4, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
codedang ✅ Ready (Inspect) Visit Preview Feb 5, 2024 7:14am

- prisma 접근 코드에 await 처리 안되어있는 부분 수정
- docs 에러코드 작성
collection/admin/Problem/Create Problem/Succeed.bru Outdated Show resolved Hide resolved
collection/admin/Problem/Create Problem/Succeed.bru Outdated Show resolved Hide resolved
collection/admin/Problem/Delete a Problem/Succeed.bru Outdated Show resolved Hide resolved
collection/admin/Problem/Get Contest Problems/Succeed.bru Outdated Show resolved Hide resolved
collection/admin/Problem/Update a Problem/Succeed.bru Outdated Show resolved Hide resolved
collection/admin/Problem/Update a Problem/Succeed.bru Outdated Show resolved Hide resolved
@cho-to
Copy link
Contributor

cho-to commented Feb 4, 2024

저도 assert 보완 / Input 관련 상세설명 추가만 되면 좋을 것 같습니다~

- 새롭게 정해진 convention에 따라 args를 설명하는 표 삭제
Copy link
Member

@SH9480P SH9480P left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

수고하셨습니다~

@SH9480P SH9480P merged commit 23d53b5 into main Feb 6, 2024
10 checks passed
@SH9480P SH9480P deleted the 1264-admin-problem-api-docs branch February 6, 2024 06:44
cho-to added a commit that referenced this pull request Feb 19, 2024
* docs(be): re-write admin problem module api docs

* fix(be): add missing await
- prisma 접근 코드에 await 처리 안되어있는 부분 수정
- docs 에러코드 작성

* docs(be): modify assert option

* docs(be): delete args table
- 새롭게 정해진 convention에 따라 args를 설명하는 표 삭제

* docs(be): modify assert

* fix(be): apply http error

* docs(be): modify api docs

Co-authored-by: cho-to <[email protected]>
Co-authored-by: SH9480P <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Admin Problem api docs 보충
3 participants