Skip to content

JsonPatchDocument: Use application/json-patch+json content type in OpenAPI #62057

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented May 22, 2025

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 namespace
    • JsonPatchDocument in the Newtonsoft.Json namespace
    • JsonPatchDocument<T> in the System.Text.Json namespace
    • JsonPatchDocument in the System.Text.Json namespace
  • Added proper conditional compilation for multi-targeting (NET vs other frameworks)

  • Added test endpoint in MapSchemasEndpoints.cs demonstrating the feature

  • Updated 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
    • Triggering command: /usr/bin/fwupdmgr refresh (dns block)
  • pkgs.dev.azure.com
    • Triggering command: npm ci (dns block)
    • Triggering command: ./.dotnet/dotnet build src/Features/JsonPatch/src/Microsoft.AspNetCore.JsonPatch.csproj (dns block)
    • Triggering command: /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
    • Triggering command: /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:&#43;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.

Copy link
Contributor

Greetings human! You've submitted a PR that modifies code that is shared with https://github.com/dotnet/runtime . Please make sure you synchronize this code with the changes in that repo!

@Copilot Copilot AI changed the title [WIP] JSON Patch request body should use content-type application/json-patch+json JsonPatchDocument: Use application/json-patch+json content type in OpenAPI May 22, 2025
@Copilot Copilot AI requested a review from captainsafia May 22, 2025 05:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

JSON Patch request body should use content-type application/json-patch+json
2 participants