🎨 Palette: OpenAPI 문서화를 위한 스키마 예제 추가

[seonghobae]

💡 What: ParseQuality 및 HealthResponse Pydantic 스키마 필드에 json_schema_extra 예제 값을 추가했습니다.
🎯 Why: 백엔드 API에서 개발자 경험(DX)을 개선하기 위해 OpenAPI(Swagger UI) 문서의 가독성과 명확성을 높였습니다. API 소비자가 기대되는 응답 형식을 더 쉽게 이해할 수 있습니다.
📸 Before/After: 스키마 설명만 제공되던 기존과 달리, Swagger UI에서 각 필드별 구체적인 예시(예: "success", "mineru", ["Low OCR confidence on page 3"], "ok")가 함께 표시됩니다.
♿ Accessibility/DX: API 소비자가 별도의 문서 확인 없이 Swagger UI 상에서 기대 응답 형식을 즉시 파악할 수 있도록 직관성을 강화했습니다.

---

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

Summary by CodeRabbit

• 문서화
  • OpenAPI 스키마에 주요 응답 필드의 구체적인 예시 값을 추가해 API 문서의 이해도를 높였습니다.
  • 파싱 상태, 파서 정보, 경고 목록 및 헬스 상태에 대한 예시가 제공됩니다.

[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: 23 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: 5fdbd341-08b9-4ddc-bab2-6fdc9318f140

📥 Commits

Reviewing files that changed from the base of the PR and between 387c1a9 and 59a187b.

⛔ Files ignored due to path filters (1)

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

📒 Files selected for processing (1)

• .trivyignore

📝 Walkthrough

Walkthrough

ParseQuality와 HealthResponse 필드에 OpenAPI JSON Schema 예시 메타데이터를 추가하고, 관련 학습 문서를 갱신합니다.

Changes

스키마 예시 메타데이터

Layer / File(s)	Summary
응답 스키마 예시 추가 src/newsdom_api/schemas.py, .jules/palette.md	ParseQuality의 status, parser, warnings 및 HealthResponse.status에 json_schema_extra 예시 값을 추가하고, OpenAPI 스키마 예시 관련 문서 항목을 추가합니다.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

• ContextualWisdomLab/newsdom-api#449: 동일한 ParseQuality 필드에 json_schema_extra 예시 값을 추가한 변경과 코드 수준에서 관련됩니다.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	제목이 스키마 예제 추가로 OpenAPI 문서화 개선이라는 주요 변경을 정확히 요약합니다.
Description check	✅ Passed	Summary/Why/Before-After/DX는 충분하지만 템플릿의 Git Flow target, Verification, Notes 항목이 비어 있습니다.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches 💡 1

🛠️ Fix failing CI checks 💡

• Fix failing CI checks

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch palette/openapi-examples-531394102776921066

---

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

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.jules/palette.md:
- Around line 4-6: Update the new “2024-07-29 - OpenAPI 스키마 예제 추가를 통한 DX 향상”
heading in the palette documentation to have one blank line before and after it,
separating it from adjacent paragraphs and satisfying MD022.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 2bc98878-eafa-4012-8ad5-9c41a753fa1f

📥 Commits

Reviewing files that changed from the base of the PR and between 04491c0 and 387c1a9.

📒 Files selected for processing (2)

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

[coderabbitai]

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

헤딩 앞뒤에 빈 줄을 추가해 주세요.

Line 4의 새 ## 헤딩이 앞뒤 문단과 바로 붙어 있어 MD022 경고가 발생합니다. 헤딩 전후에 빈 줄을 추가해 주세요.

수정 예시

 **Action:** 향후 Pydantic 모델 작성 시 API 소비자의 이해를 돕기 위해 필드에 구체적인 예제 값을 기본적으로 추가하도록 합니다.
 
+ 
 ## 2024-07-29 - OpenAPI 스키마 예제 추가를 통한 DX 향상
+
 **Learning:** 백엔드 전용 FastAPI 프로젝트에서는 Pydantic 스키마에 `json_schema_extra={"example": ...}`를 추가하여 OpenAPI 문서 품질을 높이는 것이 중요한 사용자 경험(DX) 향상 요소임을 확인했습니다.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	## 2024-07-29 - OpenAPI 스키마 예제 추가를 통한 DX 향상
	**Learning:** 백엔드 전용 FastAPI 프로젝트에서는 Pydantic 스키마에 `json_schema_extra={"example": ...}`를 추가하여 OpenAPI 문서 품질을 높이는 것이 중요한 사용자 경험(DX) 향상 요소임을 확인했습니다.
	**Action:** 향후 Pydantic 모델 작성 시 API 소비자의 이해를 돕기 위해 필드에 구체적인 예제 값을 기본적으로 추가하도록 합니다.
	## 2024-07-29 - OpenAPI 스키마 예제 추가를 통한 DX 향상
	**Learning:** 백엔드 전용 FastAPI 프로젝트에서는 Pydantic 스키마에 `json_schema_extra={"example": ...}`를 추가하여 OpenAPI 문서 품질을 높이는 것이 중요한 사용자 경험(DX) 향상 요소임을 확인했습니다.
	**Action:** 향후 Pydantic 모델 작성 시 API 소비자의 이해를 돕기 위해 필드에 구체적인 예제 값을 기본적으로 추가하도록 합니다.

🧰 Tools

🪛 markdownlint-cli2 (0.23.1)

[warning] 4-4: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above

(MD022, blanks-around-headings)

---

[warning] 4-4: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.jules/palette.md around lines 4 - 6, Update the new “2024-07-29 - OpenAPI
스키마 예제 추가를 통한 DX 향상” heading in the palette documentation to have one blank line
before and after it, separating it from adjacent paragraphs and satisfying
MD022.

Source: Linters/SAST tools