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

Add optional minimal validation #64

Open
simleo opened this issue May 19, 2021 · 4 comments
Open

Add optional minimal validation #64

simleo opened this issue May 19, 2021 · 4 comments
Labels
enhancement New feature or request

Comments

@simleo
Copy link
Collaborator

simleo commented May 19, 2021

Tough RO-Crate's philosophy is to impose few strict requirements, and rely on examples and best practices for details, a certain degree of validation can be performed. We could add an option to do that. The default should be no validation though, both for backwards compatibility and to continue reaping the benefits of RO-Crate's flexibility.

We could start with an option for minimal validation (even explicitly checking that the metadata file is valid JSON would be something) and perhaps plug in CheckMyCrate at some point.

@simleo simleo added the enhancement New feature or request label May 19, 2021
@jmfernandez
Copy link

Validation is being needed sooner or later, but an informational one. It is going to be needed the moment the different RO-Crate profiles are going to be supported, in order to report whether the minimal set of properties and structure for a given profile is reached or not

@stain
Copy link
Contributor

stain commented May 19, 2021

When opening an RO-Crate it would realistically require it to at least be valid JSON - I don't think at the moment it checks it is valid JSON-LD, but that is a RO-Crate requirement as well.

See https://docs.google.com/document/d/1lcmlTTJCcD9sUf6Vv6gRk3URI-CY54R8jK_4R8P3b80/edit# for thoughts on different levels of validation.

@SteffenBrinckmann
Copy link

I would really second this feature-request as it would help us a lot. We want to use RO-crates as import / export for electronic labnotebooks (https://github.com/TheELNConsortium/TheELNFileFormat)

@kinow
Copy link
Member

kinow commented Feb 22, 2023

+1 as well. Just finished adding RO-Crate to Autosubmit on a branch, and now I am trying to validate the RO-Crate somehow. The first pass will be reading the spec & WorkflowHub requirements, but having an automated tool or script would be very helpful.

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

No branches or pull requests

5 participants