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

#135.7 chats API에 swagger 적용 #440

Merged
merged 7 commits into from
Jan 19, 2024
Merged

#135.7 chats API에 swagger 적용 #440

merged 7 commits into from
Jan 19, 2024

Conversation

chlehdwon
Copy link
Contributor

@chlehdwon chlehdwon commented Dec 9, 2023

Summary

It closes #135

Extra info

chats.js를 swagger을 사용하여 문서화합니다.
문서화 작업 중 반복되는 작업을 피하기 위한 함수 및 변수를 정의하는 utils.js를 정의합니다.

Images or Screenshots

image

Further Work

  • rooms 문서화
  • express-validator 대신 ajv만으로 validation하도록 schema 전체 변경

@chlehdwon chlehdwon marked this pull request as draft December 9, 2023 14:13
@chlehdwon chlehdwon added the documentation Improvements or additions to documentation label Dec 13, 2023
@chlehdwon
Copy link
Contributor Author

chlehdwon commented Jan 7, 2024

일단 이거 적용 후 /chats validation 관련 문제는 별도 pr을 통해 해결하겠습니다~!

@chlehdwon chlehdwon marked this pull request as ready for review January 7, 2024 17:16
Copy link
Member

@14KGun 14KGun left a comment

Choose a reason for hiding this comment

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

수고하셨습니다 !!!! 👍 👍

Comment on lines +14 to +24
"application/json": {
schema: {
type: "object",
properties: {
roomId: {
type: "string",
pattern: objectIdPattern,
description: "채팅을 보내는 방의 id",
},
},
},
Copy link
Member

Choose a reason for hiding this comment

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

required 필드 없어도 될까요??? 🤔🤔🤔

required: ["reportedId", "type", "time", "roomId"],

report 관련 API 는 스웨거에서 required field 로 인식하는 것 같은데

image

chats 는 아니네요 ㅜㅜ

image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

아 required... 조만간 전면 수정 들어가겠습니다 😥

@14KGun 14KGun self-requested a review January 16, 2024 13:51
Copy link
Member

@kmc7468 kmc7468 left a comment

Choose a reason for hiding this comment

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

와.. 정말 큰 작업인데 수고하셨습니다!

Copy link
Member

@14KGun 14KGun left a comment

Choose a reason for hiding this comment

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

LGTM!

@chlehdwon chlehdwon merged commit a44467e into dev Jan 19, 2024
@chlehdwon chlehdwon deleted the #135.7-docs-chats branch January 19, 2024 00:04
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

Successfully merging this pull request may close these issues.

API 검수
3 participants