Skip to content

docs: add custom HTTP clients concept page and HTTPX guide#658

Merged
vdusek merged 2 commits intomasterfrom
worktree-add-doc-guide
Mar 5, 2026
Merged

docs: add custom HTTP clients concept page and HTTPX guide#658
vdusek merged 2 commits intomasterfrom
worktree-add-doc-guide

Conversation

@vdusek
Copy link
Contributor

@vdusek vdusek commented Mar 4, 2026

Summary

Description

  • Add concept page documenting the pluggable HTTP client architecture (default client config, abstract base classes, HttpResponse protocol, call method parameters)
  • Add guide page with step-by-step HTTPX implementation example (sync + async)
  • Add ApiLink component for linking to API reference from docs

Test plan

  • Doc page was rendered and manually checked locally
  • CI passes

🤖 Generated with Claude Code

Add documentation for the custom HTTP client architecture:
- Concept page explaining the pluggable HTTP client system, architecture,
  call method parameters, HttpResponse protocol, and usage examples
- Guide page with a step-by-step HTTPX implementation example
- ApiLink component for linking to API reference from docs
- Extracted all inline code examples into dedicated Python files
- Added ruff and ty overrides for documentation code files

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@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 Mar 4, 2026
@vdusek vdusek self-assigned this Mar 4, 2026
@vdusek vdusek requested a review from Pijukatel March 4, 2026 13:27
@github-actions github-actions bot added this to the 135th sprint - Tooling team milestone Mar 4, 2026
@codecov
Copy link

codecov bot commented Mar 4, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.59%. Comparing base (3fee70a) to head (eefbd1d).
⚠️ Report is 3 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #658      +/-   ##
==========================================
+ Coverage   96.52%   96.59%   +0.06%     
==========================================
  Files          45       45              
  Lines        4318     4318              
==========================================
+ Hits         4168     4171       +3     
+ Misses        150      147       -3     
Flag Coverage Δ
integration 94.85% <ø> (+0.30%) ⬆️
unit 78.04% <ø> (ø)

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 merged commit f9fc39c into master Mar 5, 2026
26 checks passed
@vdusek vdusek deleted the worktree-add-doc-guide branch March 5, 2026 08:05
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