docs(be): add client user jsdoc #3374
Open
+103
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
✅ Syncing Preview App Succeeded Application: |
|
✅ Syncing Preview App Succeeded Application: |
RyuRaseul
reviewed
Jan 29, 2026
Contributor
RyuRaseul
left a comment
RyuRaseul
left a comment
There was a problem hiding this comment.
아직 JSDoc이 작성되지 않은 API들도 귀찮으시겠지만 부탁드립니다!
Comment on lines
+95
to
+99
| /** | ||
| * | ||
| * @param {string} email 이메일 주소 | ||
| * @return | ||
| */ |
Contributor
There was a problem hiding this comment.
여기가 비어있어요! 채워주시면 감사하겠습니다!
| * | ||
| * @param {string} newPassword 변경하려는 새로운 비밀번호 | ||
| * @param {Request} req | ||
| * @throws {UnprocessableDataException} |
Contributor
There was a problem hiding this comment.
어떤 상황에 해당 Exception이 발생하는지 적어주면 좋을 것 같습니다!
| * | ||
| * @param {string} key 사용자 식별을 위한 key값 (이메일 주소) | ||
| * @param {string} value 캐시하는 value값 (pin 번호) | ||
| * @param {number} ttl 인증이 유효한 시간 (TTL) |
Contributor
There was a problem hiding this comment.
TTL이 몇 분으로 설정되어있는지 추가해주세요!
지금 구조 상으로는 5분으로 되어있습니다!
| } | ||
|
|
||
| /** | ||
| * 입력된 비밀번호가 설정한 형식에 부합하는 올바른 비밀번호인지 검증합니다. |
Contributor
There was a problem hiding this comment.
여기도 밑에 있는 정규식을 풀어서 써주면 좋을 것 같아요!
해당 정규식은 8자 이상, 영어 소문자, 대문자, 숫자, 특수문자를 적어도 1개씩 포함하라는 의미인 것 같습니다!
Comment on lines
+464
to
+469
| /** | ||
| * DB에 새로운 user 프로필을 생성합니다. | ||
| * | ||
| * @param createUserProfileData user 프로필 정보 | ||
| * @returns {Promise<UserProfile>} 생성된 user 프로필 객체를 반환합니다. | ||
| */ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
client user jsdoc 추가 및 보완
Before submitting the PR, please make sure you do the following
fixes #123).