Skip to content

docs: add typed models concept guide#777

Open
vdusek wants to merge 1 commit intomasterfrom
docs/typed-models-concept
Open

docs: add typed models concept guide#777
vdusek wants to merge 1 commit intomasterfrom
docs/typed-models-concept

Conversation

@vdusek
Copy link
Copy Markdown
Contributor

@vdusek vdusek commented May 5, 2026

Summary

Adds a concepts page documenting the v3 typed-model surface: how response Pydantic models are accessed, how to provide structured input as plain dicts (with matching TypedDicts for shape), forward compatibility under extra='allow', and where to browse all generated models in the API reference.

The README's Fully typed responses feature bullet referenced typed models without a dedicated concept page — this fills that gap.

Document the v3 typed-model surface: how response Pydantic models work,
how to pass structured input as dicts (with matching TypedDicts), forward
compatibility under extra='allow', and where to browse all generated
models in the API reference.
@vdusek vdusek added adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team. labels May 5, 2026
@vdusek vdusek self-assigned this May 5, 2026
@github-actions github-actions Bot added this to the 140th sprint - Tooling team milestone May 5, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented May 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.54%. Comparing base (94d5bf4) to head (f6a6d7a).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #777      +/-   ##
==========================================
- Coverage   97.56%   97.54%   -0.03%     
==========================================
  Files          47       47              
  Lines        4725     4725              
==========================================
- Hits         4610     4609       -1     
- Misses        115      116       +1     
Flag Coverage Δ
integration 95.15% <ø> (-0.39%) ⬇️
unit 82.11% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@vdusek vdusek requested a review from janbuchar May 5, 2026 09:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants