JsonPatchDocument: Use application/json-patch+json content type in OpenAPI #62057
+304
−9
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR implements
IEndpointParameterMetadataProvider
on the JsonPatchDocument classes to ensure they are properly represented in OpenAPI documents with the correct content type according to RFC 6902.Changes
Implemented
IEndpointParameterMetadataProvider
interface on:JsonPatchDocument<T>
in the Newtonsoft.Json namespaceJsonPatchDocument
in the Newtonsoft.Json namespaceJsonPatchDocument<T>
in the System.Text.Json namespaceJsonPatchDocument
in the System.Text.Json namespaceAdded proper conditional compilation for multi-targeting (NET vs other frameworks)
Added test endpoint in
MapSchemasEndpoints.cs
demonstrating the featureUpdated snapshot tests to include the new media type
Before / After
Before this change, JsonPatchDocument parameters were shown with the generic
application/json
content type in OpenAPI documentation.After this change, they use the proper
application/json-patch+json
content type as specified in RFC 6902.Testing
Added an endpoint that accepts a JsonPatchDocument in the OpenApi test project and verified the generated schema has the correct content type. All existing tests pass.
Fixes #61956.
Warning
Firewall rules blocked me from connecting to one or more addresses
I tried to connect to the following addresses, but was blocked by firewall rules:
cdn.fwupd.org
/usr/bin/fwupdmgr refresh
(dns block)pkgs.dev.azure.com
npm ci
(dns block)./.dotnet/dotnet build src/Features/JsonPatch/src/Microsoft.AspNetCore.JsonPatch.csproj
(dns block)/home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js
(dns block)plugins-artifacts.gradle.org
/usr/lib/jvm/temurin-17-jdk-amd64/bin/java --add-opens=java.base/java.util=ALL-UNNAMED --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens=java.base/java.lang.invoke=ALL-UNNAMED --add-opens=java.prefs/java.util.prefs=ALL-UNNAMED --add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED --add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED --add-opens=java.base/java.nio.charset=ALL-UNNAMED --add-opens=java.base/java.net=ALL-UNNAMED --add-opens=java.base/java.util.concurrent.atomic=ALL-UNNAMED -XX:MaxMetaspaceSize=384m -XX:+HeapDumpOnOutOfMemoryError -Xms256m -Xmx512m -Dfile.encoding=UTF-8 -Duser.country -Duser.language=en -Duser.variant -cp /home/REDACTED/.gradle/wrapper/dists/gradle-8.10-bin/deqhafrv1ntovfmgh0nh3npr9/gradle-8.10/lib/gradle-daemon-main-8.10.jar -javaagent:/home/REDACTED/.gradle/wrapper/dists/gradle-8.10-bin/deqhafrv1ntovfmgh0nh3npr9/gradle-8.10/lib/agents/gradle-instrumentation-agent-8.10.jar org.gradle.launcher.daemon.bootstrap.GradleDaemon 8.10
(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.