Docs 113

[alexeyzimarev]

User description

Docs for v112, 113. Also fix interceptors docs (#2287)

---

PR Type

Documentation, Bug fix

---

Description

• Added comprehensive documentation for RestSharp v112 and v113 covering all major features including client creation, request preparation, execution, response handling, authentication, serialization, error handling, and interceptors

• Created complete usage guides with practical examples for configuration, request parameters, file uploads, JSON/XML serialization, and dependency injection integration

• Documented advanced topics including OAuth1/OAuth2 authentication, custom authenticators, custom serializers, and interceptor implementation

• Added practical Twitter API v2 client implementation example demonstrating real-world usage patterns

• Fixed interceptor documentation bug across v110, v111, and main docs: corrected method name from AfterHttpResponse to AfterHttpRequest

• Updated Docusaurus configuration from v3.4.0 to v3.9.2 with React v19.2.0 and TypeScript ~5.9.3

• Updated documentation versions list to include v112 and v113

• Added changelog documentation for v112 and v113 releases including security fixes for CVE-2024-45302

---

Diagram Walkthrough

flowchart LR
  A["RestSharp v112/v113<br/>Documentation"] --> B["Usage Guides"]
  A --> C["Advanced Topics"]
  A --> D["Bug Fixes"]
  B --> B1["Client Creation"]
  B --> B2["Request Preparation"]
  B --> B3["Request Execution"]
  B --> B4["Response Handling"]
  C --> C1["Authentication"]
  C --> C2["Serialization"]
  C --> C3["Error Handling"]
  C --> C4["Interceptors"]
  D --> D1["Fix Interceptor<br/>Method Names"]
  D --> D2["Update Docusaurus<br/>Config"]

Loading

File Walkthrough

	Relevant files
Documentation	28 files configuration.md RestClient configuration documentation for v112                    docs/versioned_docs/version-v112/advanced/configuration.md Added comprehensive documentation for RestClient configuration covering basic setup, custom HttpClient usage, and message handler customization Documented all available RestClientOptions with detailed descriptions of each configuration property Included examples for creating clients with different constructor patterns and configuration approaches Documented request-level configuration properties for fine-tuning individual requests +230/-0  configuration.md RestClient configuration documentation for v113                    docs/versioned_docs/version-v113/advanced/configuration.md Added comprehensive documentation for RestClient configuration covering basic setup, custom HttpClient usage, and message handler customization Documented all available RestClientOptions with detailed descriptions of each configuration property Included examples for creating clients with different constructor patterns and configuration approaches Documented request-level configuration properties for fine-tuning individual requests +230/-0  request.md Request preparation and parameter handling guide for v112 docs/versioned_docs/version-v112/usage/request.md Added complete guide for preparing and creating RestRequest instances with various parameter types Documented request headers, query parameters, URL segments, cookies, and request body handling Included examples for AddObject and AddObjectStatic methods for bulk parameter addition Documented file upload functionality with FileParameter options and examples +350/-0  request.md Request preparation and parameter handling guide for v113 docs/versioned_docs/version-v113/usage/request.md Added complete guide for preparing and creating RestRequest instances with various parameter types Documented request headers, query parameters, URL segments, cookies, and request body handling Included examples for AddObject and AddObjectStatic methods for bulk parameter addition Documented file upload functionality with FileParameter options and examples +350/-0  execute.md Request execution and response handling documentation for v112 docs/versioned_docs/version-v112/usage/execute.md Added documentation for executing requests using various ExecuteAsync methods and their generic overloads Documented simplified API for JSON requests including GET and POST calls with deserialization Included examples for downloading binary data and JSON streaming functionality Documented sync call alternatives and requests without body +172/-0  execute.md Request execution and response handling documentation for v113 docs/versioned_docs/version-v113/usage/execute.md Added documentation for executing requests using various ExecuteAsync methods and their generic overloads Documented simplified API for JSON requests including GET and POST calls with deserialization Included examples for downloading binary data and JSON streaming functionality Documented sync call alternatives and requests without body +172/-0  authenticators.md Authentication methods and authenticators documentation for v112 docs/versioned_docs/version-v112/advanced/authenticators.md Added comprehensive documentation for all built-in authenticators including Basic, OAuth1, OAuth2, and JWT Documented OAuth1 flow with request token, access token, and protected resource examples Included examples for xAuth and 0-legged OAuth scenarios Documented custom authenticator implementation by inheriting from IAuthenticator interface +185/-0  authenticators.md Authentication methods and authenticators documentation for v113 docs/versioned_docs/version-v113/advanced/authenticators.md Added comprehensive documentation for all built-in authenticators including Basic, OAuth1, OAuth2, and JWT Documented OAuth1 flow with request token, access token, and protected resource examples Included examples for xAuth and 0-legged OAuth scenarios Documented custom authenticator implementation by inheriting from IAuthenticator interface +185/-0  example.md Practical API client implementation example for v112          docs/versioned_docs/version-v112/usage/example.md Added practical example of building a Twitter API v2 client using RestSharp with OAuth2 authentication Documented client model design with interface and DTOs for API abstraction Included custom authenticator implementation inheriting from AuthenticatorBase for token management Demonstrated dependency injection integration with ASP.NET Core Options pattern +152/-0  example.md Practical API client implementation example for v113          docs/versioned_docs/version-v113/usage/example.md Added practical example of building a Twitter API v2 client using RestSharp with OAuth2 authentication Documented client model design with interface and DTOs for API abstraction Included custom authenticator implementation inheriting from AuthenticatorBase for token management Demonstrated dependency injection integration with ASP.NET Core Options pattern +152/-0  client.md RestClient creation and dependency injection documentation for v113 docs/versioned_docs/version-v113/usage/client.md Added documentation for RestClient constructors and instantiation patterns Documented simple factory pattern for caching HttpClient instances by base URL Included dependency injection integration with Microsoft DI container and IHttpClientFactory Documented Blazor WebAssembly support with platform-specific limitations and examples +123/-0  serialization.md Serialization configuration and custom serializers documentation for v112 docs/versioned_docs/version-v112/advanced/serialization.md Added comprehensive documentation for RestSharp serialization and deserialization capabilities Documented default JSON serializer using System.Text.Json with custom options support Included documentation for XML, NewtonsoftJson, and CSV serializers with package references Documented custom serializer implementation by implementing IRestSerializer interface +148/-0  di.md Dependency injection integration and client factory documentation for v113 docs/versioned_docs/version-v113/usage/di.md Added documentation for RestSharp dependency injection integration via RestSharp.Extensions.DependencyInjection package Documented default client registration with AddRestClient extension method Included named client registration pattern for multiple configured clients Provided examples for ASP.NET Core bootstrap and client factory usage +99/-0    serialization.md RestSharp v113 serialization documentation                              docs/versioned_docs/version-v113/advanced/serialization.md New comprehensive documentation file covering RestSharp serialization support Documents JSON, XML, NewtonsoftJson, and CSV serializers with configuration examples Includes custom serializer implementation example using IRestSerializer interface Explains content type handling and AcceptedContentTypes property usage +148/-0  intro.md RestSharp v112 introduction and quick start guide                docs/versioned_docs/version-v112/intro.md New introduction and quick start guide for RestSharp v112 Covers basic usage patterns, async/await methods, and error handling Documents JSON and XML body serialization with AddJsonBody and AddXmlBody Explains response handling with RestResponse and RestResponse types +112/-0  intro.md RestSharp v113 introduction and quick start guide                docs/versioned_docs/version-v113/intro.md New introduction and quick start guide for RestSharp v113 Covers basic usage patterns, async/await methods, and error handling Documents JSON and XML body serialization with AddJsonBody and AddXmlBody Explains response handling with RestResponse and RestResponse types +112/-0  client.md RestSharp v112 client creation and configuration guide      docs/versioned_docs/version-v112/usage/client.md New documentation for creating and configuring RestSharp clients Covers constructors, client factory pattern, and HttpClient reuse scenarios Includes Blazor WebAssembly support with examples Documents RestClientOptions configuration and advanced setup options +115/-0  error-handling.md RestSharp v112 error handling and exception behavior          docs/versioned_docs/version-v112/advanced/error-handling.md New error handling documentation for RestSharp v112 Documents ResponseStatus property and error configuration options Includes table of exception throwing behavior for different method overloads Explains ThrowOnAnyError, ThrowOnDeserializationError, and FailOnDeserializationError options +71/-0    error-handling.md RestSharp v113 error handling and exception behavior          docs/versioned_docs/version-v113/advanced/error-handling.md New error handling documentation for RestSharp v113 Documents ResponseStatus property and error configuration options Includes table of exception throwing behavior for different method overloads Explains ThrowOnAnyError, ThrowOnDeserializationError, and FailOnDeserializationError options +71/-0    interceptors.md RestSharp v112 interceptors implementation and usage          docs/versioned_docs/version-v112/advanced/interceptors.md New interceptors documentation for RestSharp v112 Documents Interceptor base class and overridable methods Includes examples of implementing custom interceptors and adding them to clients/requests Covers deprecation notice and migration to CompatibilityInterceptor +84/-0    interceptors.md RestSharp v113 interceptors implementation and usage          docs/versioned_docs/version-v113/advanced/interceptors.md New interceptors documentation for RestSharp v113 Documents Interceptor base class and overridable methods Includes examples of implementing custom interceptors and adding them to clients/requests Covers deprecation notice and migration to CompatibilityInterceptor +84/-0    response.md RestSharp v112 response object properties and handling      docs/versioned_docs/version-v112/usage/response.md New response handling documentation for RestSharp v112 Documents RestResponse and RestResponse properties and their types Includes comprehensive table of response properties with descriptions Explains Data property for generic responses +36/-0    response.md RestSharp v113 response object properties and handling      docs/versioned_docs/version-v113/usage/response.md New response handling documentation for RestSharp v113 Documents RestResponse and RestResponse properties and their types Includes comprehensive table of response properties with descriptions Explains Data property for generic responses +36/-0    changelog.md RestSharp v113 changelog and release notes                              docs/versioned_docs/version-v113/changelog.md New changelog file for RestSharp v113 documenting version history Lists v112.0 and v112.1 security fixes for CVE-2024-45302 Documents v113.0 features including .NET 9/10 support and dependency injection Includes changes to IsSuccessful behavior for 404 responses +29/-0    basics.md RestSharp v112 basics and core concepts                                    docs/versioned_docs/version-v112/usage/basics.md New basics documentation for RestSharp v112 usage Explains RestSharp as wrapper around HttpClient with key capabilities Documents parameter handling, serialization, and response deserialization Recommends typed client pattern for API integration +23/-0    basics.md RestSharp v113 basics and core concepts                                    docs/versioned_docs/version-v113/usage/basics.md New basics documentation for RestSharp v113 usage Explains RestSharp as wrapper around HttpClient with key capabilities Documents parameter handling, serialization, and response deserialization Recommends typed client pattern for API integration +23/-0    changelog.md RestSharp v112 changelog and release notes                              docs/versioned_docs/version-v112/changelog.md New changelog file for RestSharp v112 documenting version history Lists v112.0 security fix for CVE-2024-45302 regarding CRLF in headers Documents v112.1 follow-up security fix removing \t from forbidden characters +19/-0    changelog.md Main changelog security fixes for v112 releases                    docs/docs/changelog.md Added v112.0 and v112.1 security fix information to main changelog Documents CVE-2024-45302 fix for CRLF in header values Documents v112.1 follow-up fix removing tab character restrictions +9/-1
Configuration changes	8 files versions.json Update documentation versions list                                              docs/versions.json Added v113 and v112 to the versions list at the beginning Maintains existing v111 and v110 versions +2/-0      docusaurus.config.ts Docusaurus configuration structure update                                docs/docusaurus.config.ts Moved onBrokenMarkdownLinks configuration into new markdown.hooks object Updated Docusaurus configuration structure for v3.9.2 compatibility Maintains warning behavior for broken markdown links in new location +5/-1      _category_.json RestSharp v112 usage section category configuration            docs/versioned_docs/version-v112/usage/category.json New category configuration file for v112 "Using RestSharp" section Sets sidebar position to 3 with auto-generated index +7/-0      _category_.json RestSharp v113 usage section category configuration            docs/versioned_docs/version-v113/usage/category.json New category configuration file for v113 "Using RestSharp" section Sets sidebar position to 3 with auto-generated index +7/-0      _category_.json RestSharp v112 advanced topics category configuration        docs/versioned_docs/version-v112/advanced/category.json New category configuration file for v112 "Advanced topics" section Sets sidebar position to 4 with auto-generated index +7/-0      _category_.json RestSharp v113 advanced topics category configuration        docs/versioned_docs/version-v113/advanced/category.json New category configuration file for v113 "Advanced topics" section Sets sidebar position to 4 with auto-generated index +7/-0      version-v112-sidebars.json RestSharp v112 sidebar configuration                                          docs/versioned_sidebars/version-v112-sidebars.json New sidebar configuration file for RestSharp v112 documentation Configures autogenerated sidebar from versioned docs directory +8/-0      version-v113-sidebars.json RestSharp v113 sidebar configuration                                          docs/versioned_sidebars/version-v113-sidebars.json New sidebar configuration file for RestSharp v113 documentation Configures autogenerated sidebar from versioned docs directory +8/-0
Dependencies	1 files package.json Documentation dependencies and package manager updates      docs/package.json Updated Docusaurus dependencies from v3.4.0 to v3.9.2 Upgraded React from v18.0.0 to v19.2.0 and related packages Updated TypeScript from ~5.2.2 to ~5.9.3 Replaced engines node requirement with packageManager [email protected] +13/-15
Bug fix	3 files interceptors.md Interceptors documentation method name correction                docs/versioned_docs/version-v110/advanced/interceptors.md Fixed method name from AfterHttpResponse to AfterHttpRequest Corrects documentation to match actual interceptor interface method name +1/-1      interceptors.md Interceptors documentation method name correction                docs/versioned_docs/version-v111/advanced/interceptors.md Fixed method name from AfterHttpResponse to AfterHttpRequest Corrects documentation to match actual interceptor interface method name +1/-1      interceptors.md Interceptors documentation method name correction                docs/docs/advanced/interceptors.md Fixed method name from AfterHttpResponse to AfterHttpRequest Corrects documentation to match actual interceptor interface method name +1/-1

---

[qodo-merge-for-open-source]

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢	No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
🟡	🎫 #2287 🟢 Fix incorrect documentation stating that there is a method called AfterHttpResponse when no such method exists Correct the documentation to reference the actual method name `AfterHttpRequest` ⚪ Fix the misleading code documentation for AfterHttpRequest that says "Intercepts the request before being sent" when it actually receives an HttpResponseMessage parameter
Codebase Duplication Compliance
🟢	No codebase code duplication found No new components were introduced in the PR code
Custom Compliance
🟢	Generic: Comprehensive Audit Trails Objective: To create a detailed and reliable record of critical system actions for security analysis and compliance. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Meaningful Naming and Self-Documenting Code Objective: Ensure all identifiers clearly express their purpose and intent, making code self-documenting Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Robust Error Handling and Edge Case Management Objective: Ensure comprehensive error handling that provides meaningful context and graceful degradation Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Secure Error Handling Objective: To prevent the leakage of sensitive system information through error messages while providing sufficient detail for internal debugging. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Secure Logging Practices Objective: To ensure logs are useful for debugging and auditing without exposing sensitive information like PII, PHI, or cardholder data. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Security-First Input Validation and Data Handling Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent vulnerabilities Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
Update

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

[cloudflare-workers-and-pages]

Deploying restsharp with    Cloudflare Pages

Latest commit:	46a2cff
Status:	✅  Deploy successful!
Preview URL:	https://6858c7c2.restsharp.pages.dev
Branch Preview URL:	https://docs-113.restsharp.pages.dev

View logs

[qodo-merge-for-open-source]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
Possible issue	Fix incorrect constructor usage Fix the TwitterClient constructor to correctly use IOptions. Extract the options value and use its properties to configure RestClient, as there is no constructor that accepts an IOptions interface. docs/versioned_docs/version-v113/usage/example.md [74-77] public TwitterClient(IOptions<TwitterClientOptions> options) { - var opt = new RestClientOptions("https://api.twitter.com/2"); - _client = new RestClient(options); + var twitterOptions = options.Value; + var restOptions = new RestClientOptions("https://api.twitter.com/2") { + Authenticator = new TwitterAuthenticator( + "https://api.twitter.com", + twitterOptions.ApiKey, + twitterOptions.ApiSecret + ) + }; + _client = new RestClient(restOptions); } Apply / Chat Suggestion importance[1-10]: 7 __ Why: The suggestion correctly identifies a critical error in the constructor logic where an IOptions<T> is passed directly to RestClient, which is invalid. The fix makes the documentation example functional.	Medium
	✅ Fix incorrect method call example Suggestion Impact: The suggestion was directly implemented in the commit. The code example was corrected by adding 'client.' before the method call and changing the variable from 'request' to 'updatedAddress'. code diff: -var response = await PostJsonAsync<AddressUpdateRequest, AddressUpdateResponse>( - "address/update", request, cancellationToken +var response = await client.PostJsonAsync<AddressUpdateRequest, AddressUpdateResponse>( + "address/update", updatedAddress, cancellationToken Fix an incorrect PostJsonAsync method call example by adding the client instance and using the correct variable for the request body. docs/versioned_docs/version-v112/intro.md [97-99] -var response = await PostJsonAsync<AddressUpdateRequest, AddressUpdateResponse>( - "address/update", request, cancellationToken +var response = await client.PostJsonAsync<AddressUpdateRequest, AddressUpdateResponse>( + "address/update", updatedAddress, cancellationToken ); [Suggestion processed] Suggestion importance[1-10]: 7 __ Why: The suggestion correctly identifies that the provided code example is non-functional as it's missing the client instance and uses an incorrect variable, and the proposed fix makes the example correct and usable.	Medium
	✅ Fix syntax error and type Suggestion Impact: The commit directly implements the suggestion by changing 'new Url' to 'new Uri' and replacing the comma with a semicolon on line 6 of the documentation file code diff: - options.BaseUrl = new Url("https://localhost:5000/api"), + options.BaseUrl = new Uri("https://localhost:5000/api"); Fix a syntax error by replacing a comma with a semicolon and correct the type from Url to Uri in the RestClient configuration example. docs/versioned_docs/version-v113/advanced/configuration.md [64-67] var client = new RestClient(options => { - options.BaseUrl = new Url("https://localhost:5000/api"), + options.BaseUrl = new Uri("https://localhost:5000/api"); options.DisableCharset = true }); [Suggestion processed] Suggestion importance[1-10]: 6 __ Why: The suggestion correctly identifies a syntax error (a comma instead of a semicolon) and a type error (Url instead of Uri) in a documentation code example, improving its correctness and usability.	Low
	✅ Fix invalid JSON string format Suggestion Impact: The suggestion was directly implemented. The commit changed the JSON string from invalid format (unquoted key) to valid JSON format by adding double quotes around the "data" key, exactly as suggested. code diff: -const json = "{ data: { foo: \"bar\" } }"; +const json = "{ \"data\": { \"foo\": \"bar\" } }"; Correct an invalid JSON string in a code example by enclosing the data key in double quotes as required by the JSON specification. docs/versioned_docs/version-v113/usage/request.md [256-257] -const json = "{ data: { foo: \"bar\" } }"; +const json = "{ \"data\": { \"foo\": \"bar\" } }"; request.AddStringBody(json, ContentType.Json); [Suggestion processed] Suggestion importance[1-10]: 6 __ Why: The suggestion correctly identifies that the JSON string in the documentation example is invalid because a key is not quoted, which would cause issues for users copying the code.	Low
	Prevent potential null reference exception Add a null check for response.Content before deserialization to prevent a potential ArgumentNullException if the response body is empty. docs/versioned_docs/version-v112/advanced/serialization.md [133] -public T? Deserialize<T>(RestResponse response) => JsonSerializer.Deserialize<T>(response.Content!); +public T? Deserialize<T>(RestResponse response) + => response.Content == null ? default : JsonSerializer.Deserialize<T>(response.Content); Apply / Chat Suggestion importance[1-10]: 6 __ Why: The suggestion correctly identifies a potential ArgumentNullException in the example code if response.Content is null and provides a robust fix, improving the quality of the documentation.	Low
General	✅ Correct a typo in package name Suggestion Impact: The suggestion was directly implemented. The commit fixes the exact typo identified in the suggestion, correcting "DepdencyInjection" to "DependencyInjection" on line 6 of the diff. code diff: -* The new package `RestSharp.Extensions.DepdencyInjection` integrates RestSharp with Microsoft DI container and `IHttpClientFactory`. +* The new package `RestSharp.Extensions.DependencyInjection` integrates RestSharp with Microsoft DI container and `IHttpClientFactory`. Correct a typo in the RestSharp.Extensions.DependencyInjection package name mentioned in the changelog. docs/versioned_docs/version-v113/changelog.md [29] -* The new package `RestSharp.Extensions.DepdencyInjection` integrates RestSharp with Microsoft DI container and `IHttpClientFactory`. +* The new package `RestSharp.Extensions.DependencyInjection` integrates RestSharp with Microsoft DI container and `IHttpClientFactory`. [Suggestion processed] Suggestion importance[1-10]: 7 __ Why: The suggestion correctly identifies and fixes a typo in a package name within the changelog, which is crucial for preventing user confusion and errors when trying to install the package.	Medium
Update

[github-actions]

Test Results

   42 files     42 suites   18m 20s ⏱️
  477 tests   477 ✅ 0 💤 0 ❌
3 334 runs  3 334 ✅ 0 💤 0 ❌

Results for commit 46a2cff.