Merge pull request #6 from twcrews/dev

5.1.0

Author: twcrews

CHANGELOG.md

@@ -5,6 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [5.1.0] - 2026-02-25
+
+### Added
+
+- Add extension method overloads for `HttpResponseMessage` extensions.
+  - Add overload for `ReadJsonApiDocumentAsync` which does not accept a `JsonSerializerOptions` parameter.
+  - Add overload for `ReadJsonApiDocumentAsync<T>` which does not accept a `JsonSerializerOptions` parameter.
+  - Add overload for `ReadJsonApiCollectionDocumentAsync<T>` which does not accept a `JsonSerializerOptions` parameter.
+
+### Remarks
+
+This version just adds extension methods that mirror `ReadFromJsonAsync<T>(HttpContent, CancellationToken)`, not requiring the `JsonSerializerOptions` parameter. Basically a syntactic shortcut for QOL.
+
 ## [5.0.0] - 2026-02-20
 
 ### Changed
@@ -84,6 +97,7 @@ Additionally, this version aims to be more idiomatic by renaming class propertie
 
 Initial release.
 
+[5.1.0]: https://github.com/twcrews/jsonapi-client/compare/5.0.0...5.1.0
 [5.0.0]: https://github.com/twcrews/jsonapi-client/compare/4.0.0...5.0.0
 [4.0.0]: https://github.com/twcrews/jsonapi-client/compare/3.0.0...4.0.0
 [3.0.0]: https://github.com/twcrews/jsonapi-client/compare/2.0.0...3.0.0

Crews.Web.JsonApiClient/Crews.Web.JsonApiClient.csproj

@@ -9,7 +9,7 @@
 
   <PropertyGroup>
     <PackageId>Crews.Web.JsonApiClient</PackageId>
-    <PackageVersion>5.0.0</PackageVersion>
+    <PackageVersion>5.1.0</PackageVersion>
     <Authors>Tommy Crews</Authors>
     <Description>
       A library containing serialization models and methods for the JSON:API specification.

Crews.Web.JsonApiClient/HttpResponseMessageExtensions.cs

@@ -24,6 +24,20 @@ public static class HttpResponseMessageExtensions
 		CancellationToken cancellationToken = default)
 		=> response.Content.ReadFromJsonAsync<JsonApiDocument>(options, cancellationToken);
 
+	/// <summary>
+	/// Deserializes the HTTP response content as a weakly-typed JSON:API document.
+	/// </summary>
+	/// <param name="response">The HTTP response message.</param>
+	/// <param name="cancellationToken">A cancellation token to cancel the operation.</param>
+	/// <returns>
+	/// A task representing the asynchronous operation. The task result contains a <see cref="JsonApiDocument"/>
+	/// instance, or <see langword="null"/> if the response content is empty or invalid.
+	/// </returns>
+	public static Task<JsonApiDocument?> ReadJsonApiDocumentAsync(
+		this HttpResponseMessage response,
+		CancellationToken cancellationToken = default)
+		=> response.Content.ReadFromJsonAsync<JsonApiDocument>(cancellationToken);
+
 	/// <summary>
 	/// Deserializes the HTTP response content as a strongly-typed JSON:API document with a single resource.
 	/// </summary>
@@ -42,6 +56,22 @@ public static class HttpResponseMessageExtensions
 		where T : JsonApiResource
 		=> response.Content.ReadFromJsonAsync<JsonApiDocument<T>>(options, cancellationToken);
 
+	/// <summary>
+	/// Deserializes the HTTP response content as a strongly-typed JSON:API document with a single resource.
+	/// </summary>
+	/// <typeparam name="T">The resource type, which must inherit from <see cref="JsonApiResource"/>.</typeparam>
+	/// <param name="response">The HTTP response message.</param>
+	/// <param name="cancellationToken">A cancellation token to cancel the operation.</param>
+	/// <returns>
+	/// A task representing the asynchronous operation. The task result contains a <see cref="JsonApiDocument{T}"/>
+	/// instance, or <see langword="null"/> if the response content is empty or invalid.
+	/// </returns>
+	public static Task<JsonApiDocument<T>?> ReadJsonApiDocumentAsync<T>(
+		this HttpResponseMessage response,
+		CancellationToken cancellationToken = default)
+		where T : JsonApiResource
+		=> response.Content.ReadFromJsonAsync<JsonApiDocument<T>>(cancellationToken);
+
 	/// <summary>
 	/// Deserializes the HTTP response content as a strongly-typed JSON:API document with a resource collection.
 	/// </summary>
@@ -59,4 +89,20 @@ public static class HttpResponseMessageExtensions
 		CancellationToken cancellationToken = default)
 		where T : JsonApiResource
 		=> response.Content.ReadFromJsonAsync<JsonApiCollectionDocument<T>>(options, cancellationToken);
+
+	/// <summary>
+	/// Deserializes the HTTP response content as a strongly-typed JSON:API document with a resource collection.
+	/// </summary>
+	/// <typeparam name="T">The resource type, which must inherit from <see cref="JsonApiResource"/>.</typeparam>
+	/// <param name="response">The HTTP response message.</param>
+	/// <param name="cancellationToken">A cancellation token to cancel the operation.</param>
+	/// <returns>
+	/// A task representing the asynchronous operation. The task result contains a <see cref="JsonApiCollectionDocument{T}"/>
+	/// instance, or <see langword="null"/> if the response content is empty or invalid.
+	/// </returns>
+	public static Task<JsonApiCollectionDocument<T>?> ReadJsonApiCollectionDocumentAsync<T>(
+		this HttpResponseMessage response,
+		CancellationToken cancellationToken = default)
+		where T : JsonApiResource
+		=> response.Content.ReadFromJsonAsync<JsonApiCollectionDocument<T>>(cancellationToken);
 }