search

biothings / discovery-app

The Data Discovery Engine project by the CD2H Data working-group
http://discovery.biothings.io
Apache License 2.0
4 stars 9 forks source link

Change 'string' to 'text' in validation editor #183

Closed gtsueng closed 3 months ago

gtsueng commented 2 years ago

Is your feature request related to a problem? Please describe. Users are building schemas based on Schema.org, but when it comes to some JSON validation rules, they're expected to switch vocabulary. This is jarring and confusing. For example, they know the expected type of their property should be schema:Text, but in the validation editor, they need to make the leap that schema:Text = string (not immediately obvious for non-programmers).

Describe the solution you'd like Change naming of drag/drop validation rules to better match schema.org expected types, whenever possible.

Describe alternatives you've considered Create FAQ for JSON schema validation rules that includes the mapping between schema.org data types and JSON schema data types and link it from validation editor, also highlight the link in the FAQ. I've tried being explicit about it in tutorials, and that did not work.

marcodarko commented 2 years ago

Maybe change all options to more user friendly names, eg. objectPerson to person(s), string > text, integer > number, etc... I'll leave this for now since we plan to revisit the list of available options.

gtsueng commented 1 year ago

I have generated frequency tables of the most popular properties, combinations of expected types, and commonly used expected types from Bioschemas profiles (draft and released). The frequency tables as well as mappings of properties to json schema validation rules can be found at https://github.com/gtsueng/bioschemas_yml_to_dde_json