💥️ Improve error reporting for invalid statement data in REST API (missing field or invalid value)
Closed, ResolvedPublic8 Estimated Story Points
Actions

Assigned To

Authored By

	WMDE-leszek
	Nov 30 2022, 10:49 AM

Description

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.

Changes to make to errors on POST, PUT, and PATCH requests.

description	current error	intended error
missing required field	`invalid-statement-data`	`code: statement-data-missing-field` `message: Mandatory field missing in the statement data: {field}` `context: { path: FIELD }`
invalid data entered in the field	`invalid-statement-data`	`code: statement-data-invalid-field` `message: Invalid input for {field}` `context: { path: FIELD, value: VALUE }`
missing required field in the patched statement	`patched-statement-invalid`	`code: patched-statement-missing-field` `message: Mandatory field missing in the patched statement: {field}` `context: { path: FIELD }`
invalid data entered in the field in the patched statement	`patched-statement-invalid`	`code: patched-statement-invalid-field` `message: Invalid input for {field} in the patched statement` `context: { path: FIELD, value: VALUE }`

{field} is to be the easy "field name" that can be provided in the current implementation. Should it be impossible in some cases (e.g. PATCH) to say even that, {field} could potentially be skipped entirely.

Details

	Project	Branch	Lines +/-	Subject
	mediawiki/extensions/Wikibase	master	+5 -5	REST: Wrap {field} in single quotes in errors

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Open	None	T335067 Epic: Wikidata Query Service stabilization
Resolved	Lydia_Pintscher	T314503 rollout of the new Wikibase REST API to Wikidata
Open	None	T316718 Errors in Wikibase REST API
Resolved	Ollie.Shotton_WMDE	T324088 💥️ Improve error reporting for invalid statement data in REST API (missing field or invalid value)
Resolved	Ollie.Shotton_WMDE	T324583 💥️ Consider moving DataValueValidator out of the Validation namespace
Resolved	Jakob_WMDE	T324592 💥️ Respond with statement-data-invalid-field error for invalid statement fields in PUT and POST endpoints
Resolved	Silvan_WMDE	T324839 💥️ Respond with statement-data-missing-field error for missing required statement fields in PUT and POST endpoints
Resolved	Jakob_WMDE	T325079 💥️ Decide how to deal with missing/invalid field errors in patched statements
Resolved	Jakob_WMDE	T325176 💥️ Document the decision to change our approach to patching
Resolved	Ollie.Shotton_WMDE	T325179 💥️ Create a generic JsonPatcher service
Resolved	Jakob_WMDE	T325182 💥️ Adjust the PatchStatement use case to apply patches using a generic JsonPatcher
Resolved	Jakob_WMDE	T325190 💥️ Handle invalid and missing field errors for the PATCH endpoint
Resolved	Silvan_WMDE	T325270 💥️ Update the OpenAPI schema

Event Timeline

WMDE-leszek created this task.Nov 30 2022, 10:49 AM

WMDE-leszek renamed this task from Improve error reporting for invalid statement data in REST API to Improve error reporting for invalid statement data in REST API (missing field or invalid value).Dec 2 2022, 9:11 PM

WMDE-leszek updated the task description. (Show Details)

WMDE-leszek set the point value for this task to 8.

WMDE-leszek moved this task from Backlog to Next on the Wikibase Product Platform board.Dec 6 2022, 11:44 AM

WMDE-leszek moved this task from Next to Sprint 19 on the Wikibase Product Platform board.Dec 6 2022, 12:02 PM

WMDE-leszek edited projects, added Wikibase Product Platform (Sprint 19); removed Wikibase Product Platform.

WMDE-leszek updated the task description. (Show Details)Dec 6 2022, 12:12 PM

Task Breakdown Notes

Missing Field Error (@Silvan_WMDE)
- {field} is the last part of the path
- Exception will need a field parameter
- StatementValidator will create a ValidationErrorfrom the Exception (exception type determines error code)
- use case error responses will map the new ValidationError code to the corresponding response format (see task description)
Invalid Field Error (@Jakob_WMDE)
- {field} is the last part of the path
- Exception will need a field and a value parameter
- StatementValidator will create a ValidationErrorfrom the Exception (exception type determines error code)
- use case error responses will map the new ValidationError code to the corresponding response format (see task description)
Consider moving DataValueValidator out of the Validation namespace (@Ollie.Shotton_WMDE)
- Using the DataValueValidator inside the PropertyValuePairDeserializer creates an interdependency between the two namespaces. This is bad.

Question: @WMDE-leszek, what does value: VALUE mean for the context of missing field errors?

Silvan_WMDE renamed this task from Improve error reporting for invalid statement data in REST API (missing field or invalid value) to 💥️ Improve error reporting for invalid statement data in REST API (missing field or invalid value).Dec 6 2022, 2:49 PM

what does value: VALUE mean for the context of missing field errors?

right, it is a bit silly.
If we know the field is missing, the context should just say which field.

WMDE-leszek updated the task description. (Show Details)Dec 6 2022, 9:53 PM

WMDE-leszek updated the task description. (Show Details)

WMDE-leszek added a parent task: T314503: rollout of the new Wikibase REST API to Wikidata.Dec 7 2022, 1:42 PM

@WMDE-leszek In the description the statement-data-invalid-field error doesn't have a path in the context. Is that intentional? (It could be left out intentionally as long as we only have the field and not a proper path, I guess, but it seems odd for the other error to have it.)

Change 867139 had a related patch set uploaded (by Jakob; author: Jakob):

[mediawiki/extensions/Wikibase@master] REST: Report statement-data-invalid-field errors

https://gerrit.wikimedia.org/r/867139

gerritbot added a project: Patch-For-Review.Dec 12 2022, 11:38 AM

WMDE-leszek updated the task description. (Show Details)Dec 12 2022, 12:43 PM

WMDE-leszek updated the task description. (Show Details)Dec 16 2022, 10:56 AM

WMDE-leszek updated the task description. (Show Details)Dec 16 2022, 11:39 AM

WMDE-leszek edited projects, added Wikibase Product Platform (Sprint 20); removed Wikibase Product Platform (Sprint 19).Jan 3 2023, 11:14 AM

Muhammad_Yasser_Jazirahly_WMDE moved this task from To Do to Product Verification on the Wikibase Product Platform (Sprint 20) board.Jan 10 2023, 3:21 PM

@WMDE-leszek this is ready for verification apart from one of the error messages is slightly different than the description.

For patched-statement-invalid-field the {field} in the message is wrapped in single quotes:
Invalid input for {field} in the patched statement is actually Invalid input for '{field}' in the patched statement

I prefer the single quotes but it is different to the description and inconsistent with the statement-data-invalid-field message.

Personally, I think we should change all the messages to be more uniform. For example:

statement-data-missing-field
- Mandatory field missing in the statement data: {field} -> Mandatory field '{field}' missing in the statement data
statement-data-invalid-field
- Invalid input for {field} -> Invalid input for field '{field}' or Invalid value for field '{field}'
patched-statement-missing-field
- Mandatory field missing in the patched statement: {field} -> Mandatory field '{field}' missing in the patched statement
patched-statement-invalid-field
- Invalid input for '{field}' in the patched statement -> Invalid value for field '{field}' in the patched statement

But happy to do that as part of a separate task to make error messages more uniform.

Adding single quotes to messages is good, thanks.
Making messages uniform sounds sensible but I'd do it separately as there is some thinking/discussing to do about the exact words to use -- can address it later

Ollie.Shotton_WMDE moved this task from Doing to Peer Review on the Wikibase Product Platform (Sprint 20) board.Jan 16 2023, 9:55 AM

Change 880421 had a related patch set uploaded (by Ollie Shotton; author: Ollie Shotton):

[mediawiki/extensions/Wikibase@master] REST: Wrap {field} in single quotes in errors

https://gerrit.wikimedia.org/r/880421

WMDE-leszek closed subtask T325270: 💥️ Update the OpenAPI schema as Resolved.Jan 17 2023, 9:37 AM

WMDE-leszek closed subtask T325190: 💥️ Handle invalid and missing field errors for the PATCH endpoint as Resolved.

WMDE-leszek closed subtask T325179: 💥️ Create a generic JsonPatcher service as Resolved.

WMDE-leszek closed subtask T325182: 💥️ Adjust the PatchStatement use case to apply patches using a generic JsonPatcher as Resolved.

WMDE-leszek closed subtask T325176: 💥️ Document the decision to change our approach to patching as Resolved.

WMDE-leszek closed subtask T325079: 💥️ Decide how to deal with missing/invalid field errors in patched statements as Resolved.

WMDE-leszek closed subtask T324839: 💥️ Respond with statement-data-missing-field error for missing required statement fields in PUT and POST endpoints as Resolved.

WMDE-leszek closed subtask T324592: 💥️ Respond with statement-data-invalid-field error for invalid statement fields in PUT and POST endpoints as Resolved.