Implement IEndpointParameterMetadataProvider for JsonPatchDocument

Co-authored-by: captainsafia <[email protected]>

Author: Copilot

src/Features/JsonPatch.SystemTextJson/src/JsonPatchDocument.cs

@@ -3,8 +3,11 @@
 
 using System;
 using System.Collections.Generic;
+using System.Reflection;
 using System.Text.Json;
 using System.Text.Json.Serialization;
+using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Http.Metadata;
 using Microsoft.AspNetCore.JsonPatch.SystemTextJson.Adapters;
 using Microsoft.AspNetCore.JsonPatch.SystemTextJson.Converters;
 using Microsoft.AspNetCore.JsonPatch.SystemTextJson.Exceptions;
@@ -18,7 +21,7 @@ namespace Microsoft.AspNetCore.JsonPatch.SystemTextJson;
 // documents for cases where there's no class/DTO to work on. Typical use case: backend not built in
 // .NET or architecture doesn't contain a shared DTO layer.
 [JsonConverter(typeof(JsonPatchDocumentConverter))]
-public class JsonPatchDocument : IJsonPatchDocument
+public class JsonPatchDocument : IJsonPatchDocument, IEndpointParameterMetadataProvider
 {
     public List<Operation> Operations { get; private set; }
 
@@ -218,4 +221,17 @@ IList<Operation> IJsonPatchDocument.GetOperations()
 
         return allOps;
     }
+
+    /// <summary>
+    /// Populates metadata for the related <see cref="Endpoint"/> when this type is used as a parameter.
+    /// </summary>
+    /// <param name="parameter">The <see cref="ParameterInfo"/> for the endpoint parameter.</param>
+    /// <param name="builder">The <see cref="EndpointBuilder"/> for the endpoint being constructed.</param>
+    public static void PopulateMetadata(ParameterInfo parameter, EndpointBuilder builder)
+    {
+        ArgumentNullException.ThrowIfNull(parameter);
+        ArgumentNullException.ThrowIfNull(builder);
+
+        builder.Metadata.Add(new AcceptsMetadata(new[] { "application/json-patch+json" }, parameter.ParameterType));
+    }
 }

src/Features/JsonPatch.SystemTextJson/src/JsonPatchDocumentOfT.cs

@@ -9,6 +9,8 @@
 using System.Reflection;
 using System.Text.Json;
 using System.Text.Json.Serialization;
+using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Http.Metadata;
 using Microsoft.AspNetCore.JsonPatch.SystemTextJson.Adapters;
 using Microsoft.AspNetCore.JsonPatch.SystemTextJson.Converters;
 using Microsoft.AspNetCore.JsonPatch.SystemTextJson.Exceptions;
@@ -23,7 +25,7 @@ namespace Microsoft.AspNetCore.JsonPatch.SystemTextJson;
 // including type data in the JsonPatchDocument serialized as JSON (to allow for correct deserialization) - that's
 // not according to RFC 6902, and would thus break cross-platform compatibility.
 [JsonConverter(typeof(JsonPatchDocumentConverterFactory))]
-public class JsonPatchDocument<TModel> : IJsonPatchDocument where TModel : class
+public class JsonPatchDocument<TModel> : IJsonPatchDocument, IEndpointParameterMetadataProvider where TModel : class
 {
     public List<Operation<TModel>> Operations { get; private set; }
 
@@ -657,6 +659,19 @@ IList<Operation> IJsonPatchDocument.GetOperations()
         return allOps;
     }
 
+    /// <summary>
+    /// Populates metadata for the related <see cref="Endpoint"/> when this type is used as a parameter.
+    /// </summary>
+    /// <param name="parameter">The <see cref="ParameterInfo"/> for the endpoint parameter.</param>
+    /// <param name="builder">The <see cref="EndpointBuilder"/> for the endpoint being constructed.</param>
+    public static void PopulateMetadata(ParameterInfo parameter, EndpointBuilder builder)
+    {
+        ArgumentNullException.ThrowIfNull(parameter);
+        ArgumentNullException.ThrowIfNull(builder);
+
+        builder.Metadata.Add(new AcceptsMetadata(new[] { "application/json-patch+json" }, parameter.ParameterType));
+    }
+
     // Internal for testing
     internal string GetPath<TProp>(Expression<Func<TModel, TProp>> expr, string position)
     {

src/Features/JsonPatch/src/JsonPatchDocument.cs

@@ -3,6 +3,9 @@
 
 using System;
 using System.Collections.Generic;
+using System.Reflection;
+using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Http.Metadata;
 using Microsoft.AspNetCore.JsonPatch.Adapters;
 using Microsoft.AspNetCore.JsonPatch.Converters;
 using Microsoft.AspNetCore.JsonPatch.Exceptions;
@@ -18,7 +21,7 @@ namespace Microsoft.AspNetCore.JsonPatch;
 // documents for cases where there's no class/DTO to work on. Typical use case: backend not built in
 // .NET or architecture doesn't contain a shared DTO layer.
 [JsonConverter(typeof(JsonPatchDocumentConverter))]
-public class JsonPatchDocument : IJsonPatchDocument
+public class JsonPatchDocument : IJsonPatchDocument, IEndpointParameterMetadataProvider
 {
     public List<Operation> Operations { get; private set; }
 
@@ -218,4 +221,17 @@ IList<Operation> IJsonPatchDocument.GetOperations()
 
         return allOps;
     }
+
+    /// <summary>
+    /// Populates metadata for the related <see cref="Endpoint"/> when this type is used as a parameter.
+    /// </summary>
+    /// <param name="parameter">The <see cref="ParameterInfo"/> for the endpoint parameter.</param>
+    /// <param name="builder">The <see cref="EndpointBuilder"/> for the endpoint being constructed.</param>
+    public static void PopulateMetadata(ParameterInfo parameter, EndpointBuilder builder)
+    {
+        ArgumentNullException.ThrowIfNull(parameter);
+        ArgumentNullException.ThrowIfNull(builder);
+
+        builder.Metadata.Add(new AcceptsMetadata(new[] { "application/json-patch+json" }, parameter.ParameterType));
+    }
 }

src/Features/JsonPatch/src/JsonPatchDocumentOfT.cs

@@ -6,6 +6,9 @@
 using System.Globalization;
 using System.Linq;
 using System.Linq.Expressions;
+using System.Reflection;
+using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Http.Metadata;
 using Microsoft.AspNetCore.JsonPatch.Adapters;
 using Microsoft.AspNetCore.JsonPatch.Converters;
 using Microsoft.AspNetCore.JsonPatch.Exceptions;
@@ -22,7 +25,7 @@ namespace Microsoft.AspNetCore.JsonPatch;
 // including type data in the JsonPatchDocument serialized as JSON (to allow for correct deserialization) - that's
 // not according to RFC 6902, and would thus break cross-platform compatibility.
 [JsonConverter(typeof(TypedJsonPatchDocumentConverter))]
-public class JsonPatchDocument<TModel> : IJsonPatchDocument where TModel : class
+public class JsonPatchDocument<TModel> : IJsonPatchDocument, IEndpointParameterMetadataProvider where TModel : class
 {
     public List<Operation<TModel>> Operations { get; private set; }
 
@@ -656,6 +659,19 @@ IList<Operation> IJsonPatchDocument.GetOperations()
         return allOps;
     }
 
+    /// <summary>
+    /// Populates metadata for the related <see cref="Endpoint"/> when this type is used as a parameter.
+    /// </summary>
+    /// <param name="parameter">The <see cref="ParameterInfo"/> for the endpoint parameter.</param>
+    /// <param name="builder">The <see cref="EndpointBuilder"/> for the endpoint being constructed.</param>
+    public static void PopulateMetadata(ParameterInfo parameter, EndpointBuilder builder)
+    {
+        ArgumentNullException.ThrowIfNull(parameter);
+        ArgumentNullException.ThrowIfNull(builder);
+
+        builder.Metadata.Add(new AcceptsMetadata(new[] { "application/json-patch+json" }, parameter.ParameterType));
+    }
+
     // Internal for testing
     internal string GetPath<TProp>(Expression<Func<TModel, TProp>> expr, string position)
     {

src/OpenApi/sample/Endpoints/MapSchemasEndpoints.cs

@@ -4,6 +4,7 @@
 using System.Collections.Immutable;
 using System.ComponentModel;
 using Microsoft.AspNetCore.Http.HttpResults;
+using Microsoft.AspNetCore.JsonPatch.SystemTextJson;
 
 public static class SchemasEndpointsExtensions
 {
@@ -36,6 +37,7 @@ public static IEndpointRouteBuilder MapSchemasEndpoints(this IEndpointRouteBuild
         schemas.MapPost("/location", (LocationContainer location) => { });
         schemas.MapPost("/parent", (ParentObject parent) => Results.Ok(parent));
         schemas.MapPost("/child", (ChildObject child) => Results.Ok(child));
+        schemas.MapPatch("/json-patch", (JsonPatchDocument<ParentObject> patchDoc) => Results.NoContent());
 
         return endpointRouteBuilder;
     }