dotnet runtime_error ai_generated true

Microsoft.AspNetCore.JsonPatch.JsonPatchException: The property at path 'path' could not be updated.

ID: dotnet/aspnetcore-json-patch-document-invalid

Also available as: JSON · Markdown · 中文
85%Fix Rate
84%Confidence
1Evidence
2024-01-22First Seen

Version Compatibility

VersionStatusIntroducedDeprecatedNotes
6.0 active — — —
7.0 active — — —
8.0 active — — —

Root Cause

A JSON Patch operation (e.g., replace, add, remove) targets a property that does not exist on the target object, or the operation violates model validation rules, often due to incorrect path syntax or missing properties.

generic

中文

JSON Patch 操作（如 replace、add、remove）针对目标对象上不存在的属性，或操作违反了模型验证规则，通常是由于路径语法错误或缺少属性。

Official Documentation

https://learn.microsoft.com/en-us/aspnet/core/web-api/json-patch

Workarounds

  1. 85% success Validate the JSON Patch document before applying it: use 'var patchDoc = new JsonPatchDocument<MyModel>(); patchDoc.Operations.Add(new Operation("replace", "/PropertyName", null, "newValue"));' and check that '/PropertyName' exists via reflection or model metadata. 
    Validate the JSON Patch document before applying it: use 'var patchDoc = new JsonPatchDocument<MyModel>(); patchDoc.Operations.Add(new Operation("replace", "/PropertyName", null, "newValue"));' and check that '/PropertyName' exists via reflection or model metadata.
  2. 80% success Apply the patch to a copy of the model and use TryValidateModel to catch validation errors: 'var tempModel = new MyModel(); patchDoc.ApplyTo(tempModel); if (!TryValidateModel(tempModel)) return BadRequest(ModelState);' 
    Apply the patch to a copy of the model and use TryValidateModel to catch validation errors: 'var tempModel = new MyModel(); patchDoc.ApplyTo(tempModel); if (!TryValidateModel(tempModel)) return BadRequest(ModelState);'

中文步骤

  1. Validate the JSON Patch document before applying it: use 'var patchDoc = new JsonPatchDocument<MyModel>(); patchDoc.Operations.Add(new Operation("replace", "/PropertyName", null, "newValue"));' and check that '/PropertyName' exists via reflection or model metadata.
  2. Apply the patch to a copy of the model and use TryValidateModel to catch validation errors: 'var tempModel = new MyModel(); patchDoc.ApplyTo(tempModel); if (!TryValidateModel(tempModel)) return BadRequest(ModelState);'

Dead Ends

Common approaches that don't work:

  1. 90% fail

    Adding [FromBody] to the action parameter does not fix the patch document; the issue is with the operation path or target model structure.

  2. 70% fail

    Changing the HTTP method from PATCH to PUT may bypass the patch logic but breaks RESTful conventions and can cause unintended full replacement of the resource.