Skip to content

fix: Swagger 문서 개선 및 Firebase 환경변수 추가 - #134

Merged
Junhyukkkk merged 4 commits into
developfrom
fix/swagger-hidden-params
May 20, 2026
Merged

Junhyukkkk merged 4 commits into
developfrom
fix/swagger-hidden-params

Conversation

@Junhyukkkk

Copy link
Copy Markdown
Member

📌 관련 이슈

  • closes #

🔍 작업 내용

Swagger API 문서에서 불필요하게 노출되던 파라미터를 숨기고, 각 API에 설명을 추가했습니다.
또한 배포 시 필요한 Firebase 환경변수를 release.yml에 추가했습니다.

📝 변경 사항

  • @AnonymousId 파라미터에 @Parameter(hidden = true) 추가하여 Swagger에서 숨김 처리
  • 모든 컨트롤러에 @Tag, @Operation 어노테이션 추가하여 API 설명 보강
    • VoteController, ImmersiveVoteController, VoteEmojiController
    • VoteResultController, GuestFreeVoteController
    • NotificationController, DeviceController
    • NotificationSettingController, NotificationPromptController
    • AuthController, UserController
  • release.yml에 FIREBASE_SERVICE_ACCOUNT_PATH 환경변수 추가

💬 리뷰어에게

  • Swagger UI에서 anonymousId가 쿼리 파라미터로 노출되지 않는지 확인 부탁드립니다
  • API 설명이 적절한지 확인 부탁드립니다

@github-actions

Copy link
Copy Markdown

빌드 성공
배포 준비 완료!

@Junhyukkkk
Junhyukkkk merged commit d2487de into develop May 20, 2026
5 checks passed
@Junhyukkkk
Junhyukkkk deleted the fix/swagger-hidden-params branch May 20, 2026 06:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant