-
Notifications
You must be signed in to change notification settings - Fork 10.3k
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
base: main
Are you sure you want to change the base?
Conversation
Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com>
Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com>
Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Revert any changes to package.json and package-lock.json files to their state in main.
Remove any package.json.bak files.
…iles Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com>
I've reverted all changes to package.json and package-lock.json files and removed the package.json.bak files in commit 7548949. |
src/Features/JsonPatch.SystemTextJson/src/JsonPatchDocumentOfT.cs
Outdated
Show resolved
Hide resolved
Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com>
Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com>
Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com>
I've reverted the PublicAPI directory restructuring in commit c46b7c7 while maintaining the PopulateMetadata API entries in the original PublicAPI.Unshipped.txt files. The files are now back to their original structure. |
src/Features/JsonPatch.SystemTextJson/src/JsonPatchDocumentOfT.cs
Outdated
Show resolved
Hide resolved
…rovider Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com>
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.