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

github: make it easier to validate/generate a ".zenodo.json" #1606

Open
slint opened this issue Sep 24, 2018 · 5 comments
Open

github: make it easier to validate/generate a ".zenodo.json" #1606

slint opened this issue Sep 24, 2018 · 5 comments

Comments

@slint
Copy link
Member

slint commented Sep 24, 2018

A lot of people are having issues with creating a valid .zenodo.json, since the only way to test it at the moment, is via just trying things out. Ideally there should be a simple JSON validator on the GitHub settings page, which does some basic validation of the metadata (e.g. if the license field is correct/resolvable).

@yarikoptic
Copy link

I want to wholeheartedly support this Enhancement proposal.
E.g., I though I've followed instructions to the letter but now zenodo errors out while processing the grants entry (see 0.11.1 release Errors on https://zenodo.org/account/settings/github/repository/datalad/datalad# ):

Invalid grant ID(s): 10.13039/501100000925"

I followed the description on http://developers.zenodo.org/#representation so I had:

  "grants": [
    {"id": "10.13039/501100000925"}
  ],

NB well - that error helped me now to see that I took the DOI for the above entry (National Health and Medical Research Council) instead of NSF, will fix now

After another reading, my current guess is that the correct format must have not just the DOI of the funder, but also some ID (grant ID I guess, but which one since there is at times a number of them) after ::, something like

  "grants": [
    {"id": "10.13039/100000001::1429999"}
  ],

to refer to https://www.nsf.gov/awardsearch/showAward?AWD_ID=1429999 . But I would not know if that is correct until we kick out the next release.

Having a validator, which could also verify correct composition of the grant entries, and possibly refer to the easy search for funders' DOIs (now there is only a text "OpenAIRE-supported grants", and still do not know where to look e.g. for BMBF's DOI), would be of great help!

ref: datalad/datalad#3032

@jcolomb
Copy link

jcolomb commented Sep 13, 2019

Could not even find a good readme file on how to create that file...

@deargle
Copy link

deargle commented Sep 25, 2019

Poor consolation, but FWIW there exists https://sandbox.zenodo.org to make trial-and-error easier with dummy repos

@vsoch
Copy link

vsoch commented Jun 28, 2020

Heyo! Is there still no automated way to generate this file for an existing archive? Using the API?

@jspaaks
Copy link

jspaaks commented Apr 13, 2022

FYI I have been working on a JSONschema for the metadata in .zenodo.json files. You can find it here https://github.com/zenodraft/zenodo-upload-metadata-schema, along with a do-everything example. I plan to use the schema for validating metadata files as part of zenodraft, a CLI to upload files to Zenodo / Zenodo Sandbox. Hope this helps someone!

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

No branches or pull requests

7 participants