grant ID JSON output - Githubissues

CrossRef / cayenne

MOVED to https://gitlab.com/crossref/rest_api

https://gitlab.com/crossref/rest_api

MIT License

17 stars 9 forks source link

grant ID JSON output #87

Open pdfeeney opened 5 years ago

pdfeeney commented 5 years ago

We will be including the new Grant ID metadata in the REST API output, here's my first take on what that will look like:

sample input XML: https://github.com/CrossRef/grantID-schema/blob/master/grantid_full_example.xml
fields are mapped in this google doc
proposed JSON (draft, needs work): https://github.com/CrossRef/grantID-schema/blob/master/grantID.json

Note that each grant has (potentially) several 'projects' which contain the bulk of the grant metadata.

ppolischuk commented 5 years ago

Thanks, the mappings are particularly helpful in reviewing. For my own education, what is the reasoning behind using different names for things in the JSON, eg givenName (XML) and given (JSON); description (XML) and abstract (JSON); award-number (XML) and award (JSON)?

I can think of some reasons why, like consistency with other field names in the existing JSON output, but I know there have been some requests for us to be more consistent between metadata output formats in the past.

Relatedly, do we ever publish something like the mappings between the two?

pdfeeney commented 5 years ago

Ultimately I'd like the JSON and XML to be more consistent. I wasn't involved in the JSON naming originally and I'm not sure what the terms are based on, but I prefer that we move towards a more commonly used vocabulary (givenName is consistent with schema.org and DataCite, for example) and use that instead of basing our input XML on the current JSON. We can do that now but that will of course not be backwards compatible, I suggest that we wait for a larger update to make changes to existing names.

We haven't historically published mappings between the two but should.