Skip to content

🎨 Palette: OpenAPI μŠ€ν‚€λ§ˆ 예제 μΆ”κ°€λ‘œ λ°±μ—”λ“œ DX κ°œμ„  - #763

Open
seonghobae wants to merge 3 commits into
developfrom
ux-improve-openapi-schema-14353309580207807095
Open

🎨 Palette: OpenAPI μŠ€ν‚€λ§ˆ 예제 μΆ”κ°€λ‘œ λ°±μ—”λ“œ DX κ°œμ„ #763
seonghobae wants to merge 3 commits into
developfrom
ux-improve-openapi-schema-14353309580207807095

Conversation

@seonghobae

@seonghobae seonghobae commented Aug 30, 2026

Copy link
Copy Markdown
Collaborator

πŸ’‘ What: FastAPI /parse μ—”λ“œν¬μΈνŠΈμ˜ 폼 νŒŒλΌλ―Έν„°μ— json_schema_extra={"example": "ch"}λ₯Ό μΆ”κ°€ν•˜κ³  λΆˆν•„μš”ν•œ File(...) 의 μƒλž΅ 기호λ₯Ό μ œκ±°ν–ˆμŠ΅λ‹ˆλ‹€.\n🎯 Why: Swagger UIλ₯Ό μ‚¬μš©ν•˜λŠ” κ°œλ°œμžλ“€μ—κ²Œ λͺ…ν™•ν•œ μ˜ˆμ‹œλ₯Ό μ œκ³΅ν•˜μ—¬ μΈν„°νŽ˜μ΄μŠ€ 이해도λ₯Ό 높이고 개발자 κ²½ν—˜(DX)을 ν–₯μƒμ‹œν‚€κΈ° μœ„ν•¨μž…λ‹ˆλ‹€.\nβ™Ώ Accessibility: API λ¬Έμ„œ 가독성 및 μ‚¬μš©μ„± κ°œμ„ 


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


Devin Review

@google-labs-jules

Copy link
Copy Markdown

πŸ‘‹ 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

coderabbitai Bot commented Aug 30, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 3 minutes.

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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 3f6e863c-6014-4059-9508-2ee44fa1a467

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between e06b1f3 and d71b6bb.

πŸ“’ Files selected for processing (2)
  • .jules/palette.md
  • src/newsdom_api/main.py

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.

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Devin Review found 2 potential issues.

Devin Review

Comment thread src/newsdom_api/main.py
Comment on lines 218 to +222
description=(
"MinerU parsing mode: `auto` (born-digital text PDFs skip forced "
"OCR), `ocr` (force OCR), or `txt` (embedded text layer only)."
)
),
json_schema_extra={"example": "auto"},

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

πŸ” OpenAPI 예제 νšŒκ·€ 검증 λˆ„λ½

μƒˆ json_schema_extra 값은 μƒμ„±λœ /openapi.jsonμ—μ„œ κ²€μ¦λ˜μ§€ μ•ŠμŠ΅λ‹ˆλ‹€. μ €μž₯μ†Œμ˜ TDD κ·œμΉ™μ— 따라 두 예제λ₯Ό κ³ μ •ν•˜λŠ” νšŒκ·€ ν…ŒμŠ€νŠΈκ°€ ν•„μš”ν•©λ‹ˆλ‹€.

(Refers to this code)

Devin Review

Was this helpful? React with πŸ‘ or πŸ‘Ž to provide feedback.

Comment thread .jules/palette.md

**Learning:** λ°±μ—”λ“œ μ „μš© ν”„λ‘œμ νŠΈ(ν”„λ‘ νŠΈμ—”λ“œκ°€ μ—†λŠ” 경우)μ—μ„œλŠ” 'UX(μ‚¬μš©μž κ²½ν—˜)'κ°€ 주둜 'DX(개발자 κ²½ν—˜)'둜 ν•΄μ„λ©λ‹ˆλ‹€. OpenAPI/Swagger μŠ€ν‚€λ§ˆμ— `json_schema_extra={"example": ...}`와 같은 ꡬ체적인 μ˜ˆμ‹œλ₯Ό μΆ”κ°€ν•˜λ©΄ APIλ₯Ό μ‚¬μš©ν•˜λŠ” κ°œλ°œμžλ“€μ˜ μΈν„°νŽ˜μ΄μŠ€ 이해도λ₯Ό 높일 수 μžˆμŠ΅λ‹ˆλ‹€.
**Action:** ν–₯ν›„ λ°±μ—”λ“œ API μ€‘μ‹¬μ˜ ν”„λ‘œμ νŠΈμ—μ„œλŠ” Pydantic μŠ€ν‚€λ§ˆ μ •μ˜μ— ν’λΆ€ν•œ λ¬Έμ„œν™”μ™€ 예제 데이터가 ν¬ν•¨λ˜μ–΄ μžˆλŠ”μ§€ ν™•μΈν•˜μ—¬ 개발자 κ²½ν—˜μ„ κ°œμ„ ν•  κ²ƒμž…λ‹ˆλ‹€.
## 2024-08-30 - OpenAPI μŠ€ν‚€λ§ˆ 예제 μΆ”κ°€λ‘œ λ°±μ—”λ“œ DX κ°œμ„ 

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

πŸ” μž‘μ—… 기둝 λ‚ μ§œ 뢈일치

2026λ…„ λ³€κ²½ ν•­λͺ©μ΄ 2024λ…„μœΌλ‘œ κΈ°λ‘λ˜μ—ˆμŠ΅λ‹ˆλ‹€. μ‹œκ°„μˆœ ν•™μŠ΅ 기둝과 후속 μž‘μ—…μ— 잘λͺ»λœ λ³€κ²½ μ‹œμ μ„ μ „λ‹¬ν•©λ‹ˆλ‹€.

Devin Review

Was this helpful? React with πŸ‘ or πŸ‘Ž to provide feedback.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant