gbfs-validator icon indicating copy to clipboard operation
gbfs-validator copied to clipboard

Published 20 hours ago • verified publisher icon MobilityData

Human Friendly Error Messages

Open mplsmitch opened this issue 10 months ago • 0 comments

One of the priorities for the validator that was identified at the North American GBFS Workshop on Oct 16-17 is the development of human friendly error messages.

I'm opening this issue to start a discussion on how this might be accomplished.

Ideally, error messages would clearly identify the problem and it's location in the feed, and give the user enough information to fix it, using language that is understandable to all users.

I've run several feeds through the validator and collected a few examples of errors that are ambiguous or possibly misleading:

Cannot read properties of undefined (reading 'find')

SyntaxError: Unexpected token '<', "<HTML> <HE"... is not valid JSON

A URL that returns a 404 results in this error:

Sorry, this version is not yet implemented or not detectable !

If this topic is of interest to you, please weigh in with ideas on how validator outputs might be improved. Examples are encouraged.

mplsmitch avatar Oct 24 '23 20:10 mplsmitch