Skip to content

docs(errors): attribute the detail[] validation shape to FastAPI - #123

Merged
mattmillerai merged 1 commit into
mainfrom
matt/router-error-detail-comment
Sep 1, 2026
Merged

docs(errors): attribute the detail[] validation shape to FastAPI#123
mattmillerai merged 1 commit into
mainfrom
matt/router-error-detail-comment

Conversation

@mattmillerai

@mattmillerai mattmillerai commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Summary

One comment change, no behaviour.

tests/test_error_mapping.py described Router's per-field validation body as the "fal/FastAPI detail[] shape". The detail[] body carrying loc / msg / type is FastAPI's own validation error format. Naming a specific third-party API next to it implied the shape originates there, which is both inaccurate and more than this SDK needs to say about where a wire format came from.

Dropping the vendor name leaves the attribution correct: this is the FastAPI shape, and Router happens to serve it.

Verification

Comment-only. tests/test_error_mapping.py compiles and the assertions around it are unchanged.

Summary by CodeRabbit

  • Documentation
    • Updated a test comment to accurately describe the FastAPI validation error format.

The `detail[]` body with `loc`/`msg`/`type` is FastAPI's own validation
error format. Naming a specific third-party API alongside it implied the
shape originates there, which is not where it comes from and is not what
this SDK is describing.
@mattmillerai
mattmillerai requested review from a team as code owners September 1, 2026 08:22
@coderabbitai

coderabbitai Bot commented Sep 1, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Team

Run ID: aa343d18-fd63-4096-b3a2-b8834bfc73f6

📥 Commits

Reviewing files that changed from the base of the PR and between 7136b48 and d779d6d.

📒 Files selected for processing (1)
  • tests/test_error_mapping.py

Included review availability: 0 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 1 review per hour.


📝 Walkthrough

Walkthrough

The pull request updates one test comment to match the FastAPI detail[] validation-body shape. No runtime behavior changes.

Changes

Validation comment

Layer / File(s) Summary
Update validation-body comment
tests/test_error_mapping.py
The comment removes the obsolete fal/ reference.

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

Merge Risk: ⚪ Minimal · up to d779d

This is a comment-only documentation correction in a test file with no product or runtime behavior change; no actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers: alexisrolland

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the comment change: it attributes the detail[] validation shape to FastAPI and removes the incorrect vendor attribution.
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.
  • Fix all pre-merge checks with AI
✨ Finishing Touches 💡 1
📝 Generate docstrings 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch matt/router-error-detail-comment

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

@mattmillerai mattmillerai added the cursor-review Request an automated Cursor review label Sep 1, 2026

@github-actions github-actions 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.

🔍 Cursor Review — Consolidated panel

Triggered by @mattmillerai.

✅ No high-signal findings.

Panel: 6/6 reviewers contributed findings.

@mattmillerai mattmillerai added the full-autonomy Approved AI-brownfield: merges on machine gates alone, no human approver. Design doc + flag req'd. label Sep 1, 2026

@robinjhuang robinjhuang left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Auto-approved under the full-autonomy policy.

Gates verified at d779d6d5c90d10488f8fe40ab3aa2167b32e4d7e:

  • full-autonomy label present
  • assigned to, or review requested from, @robinjhuang
  • not a draft
  • 8 required check(s) green — none failing, none pending

Issued by full-autonomy-approve.yml (run). This approval attests
that the machine gates above passed at this commit. It does not attest that a
human read the diff.

@mattmillerai
mattmillerai merged commit ce4242b into main Sep 1, 2026
38 checks passed
@mattmillerai
mattmillerai deleted the matt/router-error-detail-comment branch September 1, 2026 18:34
@github-actions github-actions Bot locked and limited conversation to collaborators Sep 1, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

cursor-review Request an automated Cursor review full-autonomy Approved AI-brownfield: merges on machine gates alone, no human approver. Design doc + flag req'd.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants