Add JsonContent.Create overloads which accept JsonTypeInfo #89614

brantburnett · 2023-07-28T02:42:49Z

This adds JsonContent.Create overloads that accept JsonTypeInfo parameters as approved in #51544.

namespace System.Net.Http.Json
{
    public partial class JsonContent
    {
        public static JsonContent Create<TValue>(TValue? inputValue, JsonTypeInfo<TValue> jsonTypeInfo, MediaTypeHeaderValue? mediaType = null);
        public static JsonContent Create(object? inputValue, JsonTypeInfo jsonTypeInfo, MediaTypeHeaderValue? mediaType = null);
    }
}

I did consider changing the internal JsonContent<T> overload to inherit from JsonContent. However, this requires unsealing JsonContent which was not approved. More importantly, to work well ObjectType and especially Value would need to be made virtual, which is not an allowed change to the API surface due to binary compatibility requirements. This approach seemed cleaner at the cost of a very lightweight additional abstraction layer.

Fixes #51544

ghost · 2023-07-28T02:42:54Z

Note regarding the new-api-needs-documentation label:

This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.

ghost · 2023-07-28T02:42:59Z

Tagging subscribers to this area: @dotnet/area-system-text-json, @gregsdennis
See info in area-owners.md if you want to be subscribed.

Issue Details

This adds JsonContent.Create overloads that accept JsonTypeInfo parameters as approved in #51544.

namespace System.Net.Http.Json
{
    public partial class JsonContent
    {
        public static JsonContent Create<TValue>(TValue? inputValue, JsonTypeInfo<TValue> jsonTypeInfo, MediaTypeHeaderValue? mediaType = null);
        public static JsonContent Create(object? inputValue, JsonTypeInfo jsonTypeInfo, MediaTypeHeaderValue? mediaType = null);
    }
}

I did consider changing the internal JsonContent<T> overload to inherit from JsonContent. However, this requires unsealing JsonContent which was not approved. More importantly, to work well ObjectType and especially Value would need to be made virtual, which is not an allowed change to the API surface due to binary compatibility requirements. This approach seemed cleaner at the cost of a very lightweight additional abstraction layer.

Fixes #51544

Author:	brantburnett
Assignees:	-
Labels:	`area-System.Text.Json`, `new-api-needs-documentation`
Milestone:	-

src/libraries/System.Net.Http.Json/ref/System.Net.Http.Json.cs

src/libraries/System.Net.Http.Json/src/System/Net/Http/Json/JsonContent.JsonTypeInfoOfT.cs

src/libraries/System.Net.Http.Json/src/System/Net/Http/Json/JsonContent.Object.cs

src/libraries/System.Net.Http.Json/src/System/Net/Http/Json/JsonContentOfT.cs

src/libraries/System.Net.Http.Json/src/System/Net/Http/Json/JsonContent.cs

src/libraries/System.Net.Http.Json/tests/FunctionalTests/JsonContentTests.cs

src/libraries/System.Net.Http.Json/src/System/Net/Http/Json/JsonContent.cs

…onContent.cs Co-authored-by: Eirik Tsarpalis <[email protected]>

eiriktsarpalis

Thank you for your contribution, and for simplifying the implementation :-)

brantburnett · 2023-07-31T14:50:46Z

Thank you for your contribution, and for simplifying the implementation :-)

Thanks for teaching me the new JsonTypeInfo tricks. :)

Add JsonContent.Create overloads which accept JsonTypeInfo

77975ca

ghost added area-System.Text.Json new-api-needs-documentation labels Jul 28, 2023

ghost added the community-contribution Indicates that the PR has been added by a community member label Jul 28, 2023