Skip to content

fix: OpenAPI dialect와 component schema 참조 정합성 수정 - #2404

Merged
taejinn merged 1 commit into
developfrom
fix/2403-openapi-schema-validity
Sep 2, 2026
Merged

fix: OpenAPI dialect와 component schema 참조 정합성 수정#2404
taejinn merged 1 commit into
developfrom
fix/2403-openapi-schema-validity

Conversation

@taejinn

@taejinn taejinn commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

🔍 개요

  • 런타임 OpenAPI의 dialect와 Springdoc schema 표현을 3.0.3으로 정렬하고 전역 error schema 참조를 해소합니다.

🚀 주요 변경 내용

  • springdoc.api-docs.version=OPENAPI_3_0을 설정합니다.
  • 생성 문서 header를 openapi: 3.0.3으로 정렬합니다.
  • ErrorResponse, FieldError, ModelConverters referenced schema를 Components에 등록합니다.
  • Campus /v3/api-docs의 모든 local $ref를 해소합니다.

💬 참고 사항

  • 영향
    • 심각도는 P1 OpenAPI·SDK 계약 오류이며 클라이언트 validator와 SDK 생성기가 유효한 3.0.3 문서를 소비합니다.
    • 기존 controller/service 동작을 유지하며 OpenAPI 생성 설정을 정렬합니다.
  • 검증
    • CampusOpenApiSchemaContractTest 3개로 dialect 3.0.3, ErrorResponse·FieldError component 등록, 전체 local $ref 해소를 확인했습니다.
  • 반영 순서

✅ Checklist (완료 조건)

  • 코드 스타일 가이드 준수
  • 테스트 코드 포함됨
  • Reviewers / Assignees / Labels 지정 완료
  • 보안 및 민감 정보 검증 (API 키, 환경 변수, 개인정보 등)

@taejinn taejinn added 버그 정상적으로 동작하지 않는 문제상황입니다. 공통 백엔드 공통으로 작업할 이슈입니다. labels Sep 2, 2026
@coderabbitai

coderabbitai Bot commented Sep 2, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 38 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Team

Run ID: a3de262b-b8f1-44c2-8379-12a26463148a

📥 Commits

Reviewing files that changed from the base of the PR and between 0bb7977 and 07866ed.

📒 Files selected for processing (3)
  • src/main/java/in/koreatech/koin/global/config/SwaggerConfig.java
  • src/main/resources/application.yml
  • src/test/java/in/koreatech/koin/acceptance/domain/CampusOpenApiSchemaContractTest.java

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown

Unit Test Results

1 120 tests   1 117 ✔️  2m 32s ⏱️
   251 suites         3 💤
   251 files           0

Results for commit 07866ed.

♻️ This comment has been updated with latest results.

@taejinn
taejinn marked this pull request as ready for review September 2, 2026 12:58
@taejinn
taejinn requested review from dnjswldnd-3513 and insik03 and removed request for BaeJinho4028 and ImTotem September 2, 2026 13:03
@taejinn
taejinn force-pushed the fix/2403-openapi-schema-validity branch from 063a300 to 07866ed Compare September 2, 2026 15:41
@taejinn
taejinn merged commit e447c44 into develop Sep 2, 2026
6 checks passed
@taejinn
taejinn deleted the fix/2403-openapi-schema-validity branch September 2, 2026 15:50
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.

[공통] 런타임 OpenAPI dialect와 component 참조 정합성 오류

2 participants