biothings / mygene.info

MyGene.info: A BioThings API for gene annotations
http://mygene.info
Other
113 stars 20 forks source link

generate a data schema and allow returned JSON objects follow strict schema #52

Open newgene opened 5 years ago

newgene commented 5 years ago

A more "formal" solution to #42 and #7:

dhimmel commented 3 years ago

Strong +1 to consistent return types. strict_schema=true would greatly improve the user experience. I recently wrote up some notes on MyGene. Copying the relevant section below:

MyGene doesn't have a schema for its gene output format (https://github.com/biothings/mygene.info/issues/52). Several fields return inconsistent types (https://github.com/biothings/mygene.info/issues/42), and its not clear what fields have the possibility to return a list as opposed to a scaler. Two options exist to opt-into consistent return types: always_list and allow_null, but these must be explicitly applied to columns without knowing a priori which columns need them.