Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Machine-readable schema #207

Open
nelhage opened this issue Jun 30, 2020 · 2 comments
Open

Machine-readable schema #207

nelhage opened this issue Jun 30, 2020 · 2 comments

Comments

@nelhage
Copy link

nelhage commented Jun 30, 2020

It'd be convenient to have a machine-readable schema describing which files exist, their keys, and the types (at least string/integer/double), to make it easier to write data loaders that could pull in and merge specified files and convert numeric types to the appropriate native types without hard-coding the field lists into the data loader.

This information is all available in the tables in README.md, so I'm just asking that you consider mirroring that data into a JSON file or some other machine-readable format that is also published with the data files.

Thanks for this great data source!

@owahltinez
Copy link
Contributor

This is a great idea. We were planning on automating some of the documentation aspects, so we needed to do this anyway and it's good to keep other use-cases in mind for that metadata.

Do you have any examples or references for a machine-readable schema similar to what you propose that would be useful to you?

@nelhage
Copy link
Author

nelhage commented Jul 1, 2020

I don't have an example of prior art, unfortunately.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants