As a Wikidata gadget developer I want to know what part of my input caused an error so that I can adjust my code and make successful edits as intended.
The following table summarizes the intended changes to error reports ("error code" and the English error message) in particular situations. WMDE team can find more details, including example input, in the internal working document: https://docs.google.com/spreadsheets/d/1NWvIlCGl23J62Ug08En2Uu-wVRRwx36p-ECZJ6T2fSE/edit#gid=0
Additionally, context field is to be added to error responses on PATCH routes. Its value is a JSON object. In PATCH error responses, error context is supposed to be a JSON Patch object that is relevant for an error.
| Description | current error (code) | Intended error |
|---|---|---|
| incorrect JSON patch operation | invalid-patch | "code": "invalid-patch-operation" "message": "Incorrect JSON patch operation: '<op>'" "context": { "operation": <operation_object> } |
| invalid field type in JSON patch (either of op, path, from is not a string) | invalid-patch | "code": "invalid-patch-field-type" "message": "The value of '<field>' must be of type string" "context": { "operation": <operation_object>, "field": <field> } |
| missing mandatory field in JSON patch (op, path, value, also from on copy/move patches) | invalid-patch | "code": "missing-json-patch-field" "message": "Missing '<field>' in JSON patch" "context": { "operation": <operation_object>, "field": <field> } |
| Path not found on the resource (statement) | cannot-apply-patch | "code": "patch-target-not-found" "message": "Target '<target>' not found on the resource" "context": { "operation": <operation_object>, "field": <field> } |
| JSON Patch test operation failed | patch-test-failed | "code": "patch-test-failed" "message": "Test operation in the provided patch failed. At path '<path>' expected '<expected>', actual: '<actual>'" "context": { "operation": <operation_object>, "actual-value": <actual> } |
| patched-statement-invalid | ||
| patched-statement-invalid | ||
| Value does match not the data type of the property | patched-statement-invalid | "code": "patched-statement-value-type-mismatch" "message": "Value of '<property-id>' does not match property data type after the changes" "context": { "patched-statement": <patched_statement>, "property-id": <property-id> } |
Note: Should finding the data needed for error message or error context turn out to be cumbersome, adjusting those to say something less useful but still helpful is possible. Let's consult if the situation arises.
Update: Crossed out error response changes that are no longer part of this story. See comment from PM.