Skip to content

Add v114.1 documentation and Docusaurus version snapshot - #2418

Merged
alexeyzimarev merged 2 commits into
devfrom
docs-114.1
Oct 21, 2026
Merged

alexeyzimarev merged 2 commits into
devfrom
docs-114.1

Conversation

@alexeyzimarev

Copy link
Copy Markdown
Member

Description

Documents the 114.1.0 release and cuts the matching Docusaurus docs version.

Notes

  • The snapshot was produced by replicating what pnpm docusaurus docs:version v114.1 does (copy of docs/docs, sidebar file, versions.json entry), because no Node toolchain was available locally. The Docusaurus build has not been run on this branch, so a build check before merging is recommended.
  • Previous docs versions were cut per major only. If one entry per major is preferred, the alternative is to re-cut v114 from this content instead of adding v114.1.

Purpose

This pull request is a:

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation

Checklist

  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

🤖 Generated with Claude Code

- Add v114.1 changelog: TrailingHeaders, lazy default serializers, sync Execute on thread pool, AddObjectStatic null fix, CsvHelper bump
- Document TrailingHeaders on the response page
- Note lazy default serializer registration on the serialization page
- Create Docusaurus v114.1 versioned docs snapshot and sidebar

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

Deploying restsharp with  Cloudflare Pages  Cloudflare Pages

Latest commit: b7a68a8
Status: ✅  Deploy successful!
Preview URL: https://323d2e70.restsharp.pages.dev
Branch Preview URL: https://docs-114-1.restsharp.pages.dev

View logs

@qodo-free-for-open-source-projects

Copy link
Copy Markdown
Contributor

PR Summary by Qodo

Document v114.1 and add a Docusaurus version snapshot

📝 Documentation ⚙️ Configuration changes 🕐 20-40 Minutes

Grey Divider

AI Description

• Document v114.1 changes, including response trailers, lazy serializers, synchronous execution,
 fixes, and dependency updates.
• Explain trailer availability and serializer replacement in the current guides.
• Snapshot the guides as v114.1 and add the version to Docusaurus navigation.
Diagram

graph TD
  A["Current guides"] --> B["v114.1 snapshot"] --> E["Docusaurus docs"] --> F["Documentation readers"]
  C["Version sidebar"] --> E
  D["Version list"] --> E
  A --> E
Loading
High-Level Assessment

The following are alternative approaches to this PR:

1. Refresh the existing v114 snapshot
  • ➕ Preserves the prior convention of one documentation snapshot per major version.
  • ➕ Avoids duplicating a full documentation tree for a minor release.
  • ➖ Changes previously frozen v114 content.
  • ➖ Provides no distinct v114.1 selection for readers.

Recommendation: Keep the separate v114.1 snapshot if readers need documentation that reflects this specific release; it preserves the existing v114 snapshot. If the project intentionally maintains only one snapshot per major, refresh v114 instead. Run a Docusaurus build before merging, since the manually created snapshot has not been build-checked.

Files changed (22) +2038 / -1

Documentation (20) +2029 / -1
DOCUMENTATION.mdExtend the documented snapshot range +1/-1

Extend the documented snapshot range

• Changes the repository documentation map to include frozen versions through v114.1.

DOCUMENTATION.md

serialization.mdExplain lazy default serializer registration +4/-0

Explain lazy default serializer registration

• Notes that replacing the default JSON serializer avoids loading System.Text.Json, including the .NET Framework assembly-binding motivation.

docs/docs/advanced/serialization.md

changelog.mdAdd v114.1 release notes +19/-0

Add v114.1 release notes

• Records response trailers, lazy serializers, thread-pool execution for synchronous calls, the AddObjectStatic null fix, and the CsvHelper update.

docs/docs/changelog.md

response.mdDocument response trailing headers +13/-0

Document response trailing headers

• Adds TrailingHeaders to the response properties and shows how to read a trailer. Explains the .NET 8+ requirement and why trailers are unavailable through DownloadStreamAsync.

docs/docs/usage/response.md

_category_.jsonSnapshot the advanced-topics category +7/-0

Snapshot the advanced-topics category

• Adds the advanced-topics label, position, and generated-index configuration for v114.1.

docs/versioned_docs/version-v114.1/advanced/category.json

authenticators.mdSnapshot authenticator guidance +271/-0

Snapshot authenticator guidance

• Copies the current guidance for basic authentication, OAuth1, OAuth2 token lifecycles, JWT, and custom authenticators into v114.1.

docs/versioned_docs/version-v114.1/advanced/authenticators.md

configuration.mdSnapshot client configuration guidance +318/-0

Snapshot client configuration guidance

• Copies constructor, handler, option, timeout, redirect, and parameter-formatting guidance into v114.1.

docs/versioned_docs/version-v114.1/advanced/configuration.md

error-handling.mdSnapshot error-handling guidance +73/-0

Snapshot error-handling guidance

• Preserves explanations of response statuses, exceptions, and error-related client options for v114.1.

docs/versioned_docs/version-v114.1/advanced/error-handling.md

interceptors.mdSnapshot interceptor guidance +84/-0

Snapshot interceptor guidance

• Copies interceptor implementation, registration, and migration examples into v114.1.

docs/versioned_docs/version-v114.1/advanced/interceptors.md

ios-maui-cookies.mdSnapshot iOS and MAUI cookie guidance +52/-0

Snapshot iOS and MAUI cookie guidance

• Preserves the NSURLSession cookie-handling explanation, workaround, and multi-tenant cautions for v114.1.

docs/versioned_docs/version-v114.1/advanced/ios-maui-cookies.md

serialization.mdSnapshot serialization guidance +152/-0

Snapshot serialization guidance

• Copies serializer configuration and format guidance into v114.1, including the new note about lazy defaults.

docs/versioned_docs/version-v114.1/advanced/serialization.md

changelog.mdSnapshot the v114.1 changelog +64/-0

Snapshot the v114.1 changelog

• Preserves the new v114.1 release notes alongside the existing v114.0 notes in the versioned documentation.

docs/versioned_docs/version-v114.1/changelog.md

intro.mdSnapshot the quick-start guide +112/-0

Snapshot the quick-start guide

• Copies introductory installation, request, serialization, and response examples into v114.1.

docs/versioned_docs/version-v114.1/intro.md

_category_.jsonSnapshot the usage category +7/-0

Snapshot the usage category

• Adds the usage-section label, position, and generated-index configuration for v114.1.

docs/versioned_docs/version-v114.1/usage/category.json

basics.mdSnapshot RestSharp basics +23/-0

Snapshot RestSharp basics

• Copies the overview of RestSharp capabilities and typed API clients into v114.1.

docs/versioned_docs/version-v114.1/usage/basics.md

client.mdSnapshot client creation guidance +115/-0

Snapshot client creation guidance

• Copies constructor, client-factory, HttpClient reuse, and Blazor guidance into v114.1.

docs/versioned_docs/version-v114.1/usage/client.md

example.mdSnapshot the typed-client example +120/-0

Snapshot the typed-client example

• Preserves the Twitter API client and OAuth2 client-credentials example for v114.1.

docs/versioned_docs/version-v114.1/usage/example.md

execute.mdSnapshot request-execution guidance +172/-0

Snapshot request-execution guidance

• Copies asynchronous, synchronous, JSON, binary download, and streaming-call guidance into v114.1.

docs/versioned_docs/version-v114.1/usage/execute.md

request.mdSnapshot request preparation guidance +360/-0

Snapshot request preparation guidance

• Copies parameter, header, cookie, body, and file-upload guidance into v114.1.

docs/versioned_docs/version-v114.1/usage/request.md

response.mdSnapshot response guidance with trailers +62/-0

Snapshot response guidance with trailers

• Copies the response-property reference into v114.1, including the new TrailingHeaders example and platform and streaming limitations.

docs/versioned_docs/version-v114.1/usage/response.md

Other (2) +9 / -0
version-v114.1-sidebars.jsonAdd the v114.1 sidebar +8/-0

Add the v114.1 sidebar

• Configures an autogenerated tutorial sidebar for the v114.1 snapshot.

docs/versioned_sidebars/version-v114.1-sidebars.json

versions.jsonRegister v114.1 as the newest snapshot +1/-0

Register v114.1 as the newest snapshot

• Prepends v114.1 to the Docusaurus version list while retaining earlier frozen versions.

docs/versions.json

@qodo-free-for-open-source-projects

qodo-free-for-open-source-projects Bot commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0) 🎨 UX issues (0) 🔗 Cross-repo conflicts (0) 📜 Skill insights (0)

Grey Divider


Remediation recommended

1. Custom response writers lose trailers ✓ Resolved
Description
RestResponse.FromHttpResponse returns the AdvancedResponseWriter result before the default
response initializer copies HttpResponseMessage.TrailingHeaders. Any request using
AdvancedResponseWriter therefore receives an empty TrailingHeaders collection on .NET 8+,
despite the response-page and changelog claims, and the versioned snapshot repeats the same
guarantee.
Code

docs/docs/usage/response.md[56]

+Trailers are populated on .NET 8 and later, after the response content has been fully read. On .NET Framework and .NET Standard targets, `HttpClient` does not expose trailers, so the collection is always empty. Trailers are also not available when streaming the response with `DownloadStreamAsync`, since the body is not read by RestSharp in that case.
Evidence
The documentation makes an unconditional .NET 8+ availability claim, but the response factory
returns a custom response before executing the default initializer that maps trailers. The public
AdvancedResponseWriter property makes this an externally reachable behavior.

docs/docs/usage/response.md[46-56]
docs/versioned_docs/version-v114.1/usage/response.md[46-56]
docs/docs/changelog.md[13-17]
src/RestSharp/Response/RestResponse.cs[39-79]
src/RestSharp/Request/RestRequest.cs[222-233]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The response documentation says trailers are populated on .NET 8+ whenever the response body is read, but `AdvancedResponseWriter` bypasses RestSharp's default response construction and leaves `TrailingHeaders` empty.
### Fix Focus Areas
- docs/docs/usage/response.md[56-56]
- docs/docs/changelog.md[17-17]
- docs/versioned_docs/version-v114.1/usage/response.md[56-56]
- docs/versioned_docs/version-v114.1/changelog.md[17-17]
### Recommended Fix
Qualify the trailer documentation to state that the collection is populated on the normal response-processing path after the body is read, but is not automatically populated when `AdvancedResponseWriter` supplies a custom `RestResponse`. Apply the same clarification to the changelog and v114.1 snapshot.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

Tip of the day
💡 Did you know, you can start a comment with 'qodo' or '@qodo' to chat about any finding

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

Comment thread docs/docs/usage/response.md Outdated
@github-actions

github-actions Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

Test Results

   42 files     42 suites   19m 26s ⏱️
  573 tests   573 ✅ 0 💤 0 ❌
3 998 runs  3 998 ✅ 0 💤 0 ❌

Results for commit b7a68a8.

♻️ This comment has been updated with latest results.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@sonarqubecloud

Copy link
Copy Markdown

@alexeyzimarev
alexeyzimarev merged commit 466e5f8 into dev Oct 21, 2026
13 checks passed
@alexeyzimarev
alexeyzimarev deleted the docs-114.1 branch October 21, 2026 13:17
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