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

name, license, datePublished and description are SHOULD and not MUST properties #37

Closed
salexan2001 opened this issue Nov 7, 2024 · 2 comments

Comments

@salexan2001
Copy link

According to https://www.researchobject.org/ro-crate/specification/1.1/root-data-entity.html#direct-properties-of-the-root-data-entity, name, license, datePublished and description are SHOULD and not MUST properties.

Currently the rocrate-validator reports these as MUST properties and validation fails, e.g. for an eln-file from RSPace with:

  The following requirements have not meet:                                                                                                                                     
                                                                                                                                                                                
                                                                                                                                  [profile: RO-Crate Metadata Specification 1.1]
     [ ro-crate-1.1.8 ]: RO-Crate Root Data Entity REQUIRED properties                                                                                                          
                                                                                                                                                                                
      The Root Data Entity MUST have a name, description, license and datePublished                                                                                             
                                                                                                                                                                                
          Failed checks                                                                                                                                                         
                                                                                                                                                                                
       [    MUST 8.3    ]  Root Data Entity: `licence` property:                                                                                                                
                           Check if the Root Data Entity includes a license property (as specified by schema.org) to provide information about the                              
                           license of the dataset.                                                                                                                              
         Detected issues                                                                                                                                                        
         - [Violation on <./>]: The Root Data Entity MUST have a `license` property (as specified by schema.org).                                                               
                 SHOULD link to a Contextual Entity in the RO-Crate Metadata File with a name and description.                                                                  
                 MAY have a URI (eg for Creative Commons or Open Source licenses).                                                                                              
                 MAY, if necessary be a textual description of how the RO-Crate may be used.       

See also the discussion in this issue: TheELNConsortium/TheELNFileFormat#88

@kikkomep
Copy link
Member

kikkomep commented Nov 7, 2024

Hi @salexan2001 !

We have already discussed this issue in #14, where @elichad pointed out that, according to the specification, the properties you mentioned are REQUIRED and not merely RECOMMENDED. What is recommended (SHOULD) is solely the value of these properties, while their presence is mandatory.

You can also find an example of a minimal RO-Crate in the specifications, which illustrates that these properties must be present.

@salexan2001
Copy link
Author

Thanks for the info!

This issue is currently discussed here: TheELNConsortium/TheELNFileFormat#88

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