Repository navigation
[REFACTOR] Swagger 문서 형식 통일 (백킹트랙/알림) #206
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
Merged
Merged
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
f48a221
docs: 알림 API Swagger 문서 형식 통일 (#200)
rkdehdrbs7885-oss d134a48
docs: 백킹트랙 API Swagger 문서 형식 통일 (#200)
rkdehdrbs7885-oss 5932d5c
docs: 백킹트랙 API Swagger 문서 형식 통일_2 (#200)
rkdehdrbs7885-oss 2665f65
Merge remote-tracking branch 'origin/develop' into refactor/#200-swag…
rkdehdrbs7885-oss cba0554
refactor: 코드 레빗 수정 (#200)
rkdehdrbs7885-oss 53aa20e
refactor: 팀 리뷰 수정 (#200)
rkdehdrbs7885-oss 8a86a0f
Merge remote-tracking branch 'origin/develop' into refactor/#200-swag…
rkdehdrbs7885-oss File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟠 P2
문제상황:
Tag의description이 "{도메인명} API" 짧은 형태로 안 바뀌고, 기존 긴 설명 문구에 API만 이어붙인 상태로 남아있음.@Tag(name = "백킹트랙", description = "백킹트랙 생성, 수정 및 조회 API")@Tag(name = "알림", description = "알림 조회 및 읽음 처리 API")문제가 되는 이유:
이번 #200 이슈의 양식(은우님이 공유한 예시
@Tag(name = "인증", description = "인증 API"))은description을
{도메인명} API짧은 형태로 통일하는 게 핵심인데이 PR은 Tag name의 영문 괄호 제거·대소문자(api→API)만 맞추고
description은 기존 긴 설명을 그대로 유지함.
이미 형식 통일된 다른 도메인(학습/사용자/분석/AI멘토 등)은 전부 짧은 형태라 이 PR만 형식이 다르게 남게 됨.
수정 방향:
description = "백킹트랙 API",description = "알림 API"로 축약.나머지는 깔끔해요 — summary 8개(백킹트랙) + 4개(알림) 전부 " API" 붙었고, 빠진 엔드포인트 없고, description 내용 자체는 안 건드려서 안전하고, develop이랑 충돌도 없습니다(
mergeable: true).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
넵! 수정했습니다!