Description
There are a few fixes and improvements we should make to the JSON Patch documentation for .NET 10.
-[x] Move JSON Patch article under APIs (out from under Controllers), after the "Middleware" topic. [Fixed with PR #37082]
-[ ] Remove JsonPatch support from "Consider controller-based APIs if you need:" here:
- https://learn.microsoft.com/en-us/aspnet/core/fundamentals/apis?view=aspnetcore-10.0#choosing-between-approaches
In the "Enable JSON Patch support with System.Text.Json" section
-[x] Remove "--prerelease" from the dotnet add command to add Microsoft.AspNetCore.JsonPatch.SystemTextJson [Completed with PR #36870]
-[ ] References to "T" should be "TModel"

In the "Action method code applying JSON Patch" section
-[ ] Replace this with a section that describes the Patch method in the CustomerApi.cs file (the Minimal APIs PATCH endpoint)
- Need to update the section title
- Note the example error response should be updated
In the "Get the code" section:
-[ ] Update the sample project with code in the main branch of this repo:
- https://github.com/mikekistler/aspnet-json-patch
-[ ] The "View or download sample code" should link to
- https://github.com/dotnet/AspNetCore.Docs/tree/main/aspnetcore/web-api/jsonpatch/samples/10.x/JsonPatchSample
-[ ] Replace the instructions for testing the sample (I think they are unclear or broken -- what JSON project folder?) with something like this:
- To test the sample, run the app and send HTTP requests using the included http file.
Under "Additional resources"
-[ ] Update the "ASP.NET Core JSON Patch source code" link to:
- https://github.com/dotnet/aspnetcore/tree/main/src/Features/JsonPatch.SystemTextJson/src
Page URL
https://learn.microsoft.com/en-us/aspnet/core/web-api/jsonpatch?view=aspnetcore-10.0
Content source URL
https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/web-api/jsonpatch.md
Document ID
6a88d237-1a03-b865-e3c5-20ceedef2a1f
Platform Id
54f6475a-b72c-2ccc-3ab8-5326d9d05c50
Article author
@wadepickett
Metadata
- ID: 593f528c-61b9-7021-335d-c1c0ec1814d1
- PlatformId: 54f6475a-b72c-2ccc-3ab8-5326d9d05c50
- Service: aspnet-core
- Sub-service: web-api
Related Issues
Associated WorkItem - 560749
Description
There are a few fixes and improvements we should make to the JSON Patch documentation for .NET 10.
-[x] Move JSON Patch article under APIs (out from under Controllers), after the "Middleware" topic. [Fixed with PR #37082]
-[ ] Remove JsonPatch support from "Consider controller-based APIs if you need:" here:
- https://learn.microsoft.com/en-us/aspnet/core/fundamentals/apis?view=aspnetcore-10.0#choosing-between-approaches
In the "Enable JSON Patch support with System.Text.Json" section
-[x] Remove "--prerelease" from the dotnet add command to add Microsoft.AspNetCore.JsonPatch.SystemTextJson [Completed with PR #36870]
-[ ] References to "T" should be "TModel"
In the "Action method code applying JSON Patch" section
-[ ] Replace this with a section that describes the Patch method in the CustomerApi.cs file (the Minimal APIs PATCH endpoint)
- Need to update the section title
- Note the example error response should be updated
In the "Get the code" section:
-[ ] Update the sample project with code in the main branch of this repo:
- https://github.com/mikekistler/aspnet-json-patch
-[ ] The "View or download sample code" should link to
- https://github.com/dotnet/AspNetCore.Docs/tree/main/aspnetcore/web-api/jsonpatch/samples/10.x/JsonPatchSample
-[ ] Replace the instructions for testing the sample (I think they are unclear or broken -- what JSON project folder?) with something like this:
- To test the sample, run the app and send HTTP requests using the included http file.
Under "Additional resources"
-[ ] Update the "ASP.NET Core JSON Patch source code" link to:
- https://github.com/dotnet/aspnetcore/tree/main/src/Features/JsonPatch.SystemTextJson/src
Page URL
https://learn.microsoft.com/en-us/aspnet/core/web-api/jsonpatch?view=aspnetcore-10.0
Content source URL
https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/web-api/jsonpatch.md
Document ID
6a88d237-1a03-b865-e3c5-20ceedef2a1f
Platform Id
54f6475a-b72c-2ccc-3ab8-5326d9d05c50
Article author
@wadepickett
Metadata
Related Issues
Associated WorkItem - 560749