🎨 Palette: OpenAPI 스키마 예제 추가 및 정리

[seonghobae]

💡 What: ArticleNode 스키마에서 불필요한 ... 기본값 마커를 제거하고 HealthResponse 스키마에 json_schema_extra={"example": "ok"}를 추가하여 Swagger UI 예시를 강화했습니다.
🎯 Why: 백엔드 환경에서 DX는 곧 UX입니다. Pydantic v2에서 ...는 필수 필드에 불필요한 시각적 노이즈를 주며, OpenAPI 문서의 예제 추가는 API 소비자(개발자)의 문서 이해도와 경험을 직접적으로 향상시킵니다.
📸 Before/After: N/A (백엔드 스키마 변경)
♿ Accessibility/DX: Swagger UI의 OpenAPI 명세를 더 깨끗하고 직관적으로 사용할 수 있게 개선하여 소비자 개발자 경험(DX)을 향상시켰습니다.

---

PR created automatically by Jules for task 4324983210057298136 started by @seonghobae

[google-labs-jules]

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.

---

For security, I will only act on instructions from the user who triggered this task.

[coderabbitai]

Warning

Review limit reached

@seonghobae, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 36 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 4c86b0a0-f02e-45fc-9a4d-912f2d5d654d

📥 Commits

Reviewing files that changed from the base of the PR and between 04491c0 and 60aecf7.

⛔ Files ignored due to path filters (1)

• uv.lock is excluded by !**/*.lock

📒 Files selected for processing (3)

• .jules/palette.md
• .trivyignore
• src/newsdom_api/schemas.py

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch palette-dx-schema-improvements-4324983210057298136

---

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

[Copilot]

Pull request overview

Pydantic 스키마 선언을 더 깔끔하게 정리하고, OpenAPI(Swagger UI)에서 더 유용한 예시가 노출되도록 스키마 메타데이터를 보강한 PR입니다.

Changes:

• ArticleNode.headline에서 필수 필드 표시용 ...(ellipsis) 기본값 마커를 제거해 스키마 선언을 단순화했습니다.
• HealthResponse.status에 json_schema_extra={"example": "ok"}를 추가해 Swagger UI 예시를 강화했습니다.
• .jules/palette.md에 동일 내용의 항목이 추가되었습니다(중복 기록).

Reviewed changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 1 comment.

File	Description
src/newsdom_api/schemas.py	Article/Health 관련 스키마 선언을 정리하고 OpenAPI 예시를 보강
.jules/palette.md	DX(OpenAPI 예시/ellipsis 정리) 관련 팔레트 기록을 추가(현재 중복 발생)

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 3 out of 4 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

.jules/palette.md:6

• The palette entry adds a second (duplicated) section dated 2025-02-24 while the existing header still contains the unreplaced "$(date +%Y-%m-%d)" placeholder. This leaves the log with two near-identical entries and a non-literal date marker; prefer a single entry with the actual PR date.

## 2025-02-24 - Enhance Developer UX with OpenAPI Schema Examples
**Learning:** In a backend-only FastAPI project without frontend files, "UX" improvements naturally translate to Developer Experience (DX). Enhancing Pydantic schemas with `json_schema_extra={"example": ...}` rather than just using the `description` field provides concrete, immediate value in the generated Swagger UI. Additionally, explicitly defining the ellipsis `...` for required fields is redundant and noisy in modern Pydantic V2 when no default is provided.
**Action:** When working on API schemas, proactively provide representative `json_schema_extra` examples to improve the consumer documentation experience, and omit the `...` default marker to keep schema declarations clean and idiomatic.