pepkit / pipestat

Pipeline results reporting package
https://pep.databio.org/pipestat/
BSD 2-Clause "Simplified" License
4 stars 2 forks source link

Schema validation exception messaging #173

Closed khoroshevskyi closed 3 months ago

khoroshevskyi commented 4 months ago

In Bedboss, I faced with a validation error while uploading results via Pipestat. Unfortunately, the error message provided was not sufficiently clear, making it difficult to pinpoint the specific column/result_identifier responsible for the issue.

image

nsheff commented 4 months ago

I'm interpreting that as:

you are trying to report a result called 'path', which has to be of type 'string', but instead you're giving it a 'None'.

would it be better to say something like:

"For result 'path', you are reporting the value 'None', which failed validation because: 'None is not of type 'string''"

khoroshevskyi commented 4 months ago

Path is a key in one of the record_identifiers of result_identifiers, however, we don't know which specific record identifier is causing the error.

donaldcampbelljr commented 3 months ago

I've added a new exception that adds clarity to the original validation error message to help aid the user when this occurs.