o2r-project / o2r-meta

Metadata toolsuite for an extract-map-validate workflow supporting reproducible research
Apache License 2.0
2 stars 3 forks source link

Required property identifier is not further defined in the o2r schema; ercIdentifier to be removed #92

Closed nuest closed 6 years ago

nuest commented 6 years ago

https://github.com/o2r-project/o2r-meta/blob/master/schema/json/o2r-meta-schema.json#L41

Shouldn't the structure of the required property identifier be further defined? What about ercIdentifier - is it used somewhere? Imho it could be removed.

ghost commented 6 years ago

identifier: is a subelement of depends meaning "name". It was called "identifier" because codemeta uses that name for a similar element. ercIdentifier: As far as I know, it is no longer in use, except in old examples and maps where is could go obsolete with no consequences.

nuest commented 6 years ago

Ok, let's remove ercIdentifier then.

I included the wrong link, sorry! I actually mean this identifier: https://github.com/o2r-project/o2r-meta/blob/master/schema/json/o2r-meta-schema.json#L135

ghost commented 6 years ago

That identifier element holds the persistent identifiers, e.g.

    "identifier": {
        "doi": "10.5555/666655554444",
        "doiurl": "https://doi.org/10.5555/666655554444",
        "reserveddoi": null
    }

We cannot know what specific identifiers will be included, although we use doi as de facto default. But a 3rd party repository could use a handle identifier exclusively. There is a lot of other persistent identifiers which could be used here exclusively or in combination with each other. That's why I would advise to keep the subelements undefined. Newer versions of json schema have the contain key word, which can be used to create controlled lists in order to require at least one element of several possiblities.

edit: we're using draft 4 of json schema, contain is available from draft 6 onwards

nuest commented 6 years ago

I'm OK with not defining the top level identifier further with your arguments in mind.

AFAICS this issue can be closed after ercIdentifier is removed.

ghost commented 6 years ago

ercIdentifier will be removed with https://github.com/o2r-project/o2r-meta/pull/93