Skip to content

Root entity in example in data-entities.md is missing the mandatory field "description" #506

@nimpo

Description

@nimpo

Describe the bug
6.3 of the specification states that the root entity of an RO Crate MUST (RFC2119) contain all elements: "@⁠type", "@⁠id", "name", "description", "datePublished" "license" [sic]

The example in section 7.4 is missing a "description" element.

URL
https://github.com/ResearchObject/ro-crate/blob/main/docs/_specification/1.2/data-entities.md#example-attached-ro-crate-package

Suggested fix
To the example root entity add

description: "",

Additional context
Description MUST be present, but need not contain any data as this is covered by a SHOULD directive.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions