Detached crate example in the spec is not valid

[simleo]

The Converting from Attached to Detached RO-Crate Package section takes as example https://about.workflowhub.eu/Workflow-RO-Crate/1.0/ro-crate-metadata.json and shows the following as (abbreviated) example output of the conversion to detached:

ro-crate/docs/_specification/1.2/appendix/relative-uris.md

Lines 92 to 116 in 182b892

	{
	"@context": [
	{"@base": "arcp://uuid,d6be5c9b-132a-4a93-9837-3e02e06c08e6/"},
	"https://w3id.org/ro/crate/1.1/context"
	],
	"@graph": [
	{
	"@id": "https://about.workflowhub.eu/Workflow-RO-Crate/1.0/ro-crate-metadata.json",
	"@type": "CreativeWork",
	"conformsTo": {"@id": "https://w3id.org/ro/crate/1.1"},
	"about": {"@id": "https://about.workflowhub.eu/Workflow-RO-Crate/1.0/"},
	"creator": {"@id": "https://orcid.org/0000-0001-9842-9718"}
	},
	{
	"@id": "https://about.workflowhub.eu/Workflow-RO-Crate/1.0/",
	"@type": "Dataset",
	"hasPart": [
	{ "@id": "https://about.workflowhub.eu/Workflow-RO-Crate/1.0/index.html"},
	{ "@id": "https://about.workflowhub.eu/Workflow-RO-Crate/1.0/example/"},
	],
	"name": "Workflow RO-Crate profile"
	},
	...
	]
	}

The above metadata, however, is not valid, since the metadata descriptor's @id is not ro-crate-metadata.json but https://about.workflowhub.eu/Workflow-RO-Crate/1.0/ro-crate-metadata.json. The spec for the metadata descriptor says that the @id must be ro-crate-metadata.json, "Even in Detached RO-Crate Packages".

[jmfernandez]

So, does the example should be something like next?

 { 
   "@context": [ 
     {"@base": "arcp://uuid,d6be5c9b-132a-4a93-9837-3e02e06c08e6/"}, 
     "https://w3id.org/ro/crate/1.1/context" 
   ], 
   "@graph": [ 
     { 
       "@id": "ro-crate-metadata.json",
       "@type": "CreativeWork", 
       "conformsTo": {"@id": "https://w3id.org/ro/crate/1.1"}, 
       "contentUrl": "https://about.workflowhub.eu/Workflow-RO-Crate/1.0/ro-crate-metadata.json", 
       "about": {"@id": "https://about.workflowhub.eu/Workflow-RO-Crate/1.0/"}, 
       "creator": {"@id": "https://orcid.org/0000-0001-9842-9718"} 
     }, 
     { 
       "@id": "https://about.workflowhub.eu/Workflow-RO-Crate/1.0/", 
       "@type": "Dataset", 
       "hasPart": [ 
         { "@id": "https://about.workflowhub.eu/Workflow-RO-Crate/1.0/index.html"}, 
         { "@id": "https://about.workflowhub.eu/Workflow-RO-Crate/1.0/example/"}, 
       ], 
       "name": "Workflow RO-Crate profile" 
     }, 
     ... 
   ] 
 }

[simleo]

So, does the example should be something like next?

    ], 
    "@graph": [ 
      { 
-       "@id": "https://about.workflowhub.eu/Workflow-RO-Crate/1.0/ro-crate-metadata.json", 
+       "@id": "ro-crate-metadata.json",
        "@type": "CreativeWork", 
        "conformsTo": {"@id": "https://w3id.org/ro/crate/1.1"}, 
+       "contentUrl": "https://about.workflowhub.eu/Workflow-RO-Crate/1.0/ro-crate-metadata.json", 
        "about": {"@id": "https://about.workflowhub.eu/Workflow-RO-Crate/1.0/"}, 
        "creator": {"@id": "https://orcid.org/0000-0001-9842-9718"} 
      }, 

Maybe, I'm not sure about the addition of contentUrl since this is a special entity. The spec text should also change to explain that the JSON tooling output needs manual post-processing or something like that.

[elichad]

@simleo do you want to raise a PR to fix this issue?

You could also add something in the text to make clear that the metadata descriptor @id must remain as ro-crate-metadata.json after the conversion.

--

I'm not sure about the addition of contentUrl since this is a special entity

I think including contentUrl would be fine, as the metadata descriptor is not a closed entity (you can also add author, license, etc if those differ from the rest of the crate).