Attached detached lite #390
Conversation
…d/detached definitons
Co-authored-by: Simone Leo <[email protected]>
Co-authored-by: Simone Leo <[email protected]>
Co-authored-by: Simone Leo <[email protected]>
Co-authored-by: Simone Leo <[email protected]>
Co-authored-by: Simone Leo <[email protected]>
| * The `@id` MUST be a relative path that resolves to a directory that is present in the _RO-Crate Root_. | ||
|
|
||
| For a _Detached RO-Crate Package_: | ||
| * If the `@id` is a _URI Path it MAY be used to create a directory and MAY resolve to a service which returns a list of files |
There was a problem hiding this comment.
Similar issue as above, e.g. @id: "folder/subfolder/"from detached cratehttp://example.com/api/get_crate?1239` would wrongly resolve to http://example.com/api/folder/subfolder/
Removing new term which was left over from the other commit
|
I think |
Co-authored-by: Eli Chadwick <[email protected]>
… into attached-detached-lite
|
Quick comment with my understanding of the primary spec changes in this PR (i.e. ignoring restructuring & rephrasing): PreviouslyThis table represents (my understanding of) the difference between attached/detached crates prior to this PR:
The RDE Now
The RDE
I'll add specific review comments tomorrow (out of time today) but @ptsefton does this sound right to you? |
|
Yes that's correct. Good summary.
Get Outlook for Android<https://aka.ms/AAb9ysg>
…________________________________
From: Eli Chadwick ***@***.***>
Sent: Tuesday, January 28, 2025 5:25:54 AM
To: ResearchObject/ro-crate ***@***.***>
Cc: Peter Sefton ***@***.***>; Mention ***@***.***>
Subject: Re: [ResearchObject/ro-crate] Attached detached lite (PR #390)
Quick comment with my understanding of the primary spec changes in this PR:
Previously
This table represents (my understanding of) the difference between attached/detached crates prior to this PR:
Data Entity @ids all absolute URIs Data Entity @ids include local URIs
RDE has @id ./ Attached Attached
RDE has @id absolute URI Detached Not permitted
The RDE @id was a major factor (by proxy) in defining whether a crate was attached or detached.
Now
Data Entity @ids all absolute URIs Data Entity @ids include local URIs
RDE has @id ./ Attached Attached
RDE has @id absolute URI Attached or Detached Attached
The RDE @id can no longer be used as a proxy for whether a crate is attached or detached. Instead this PR makes clearer the following distinction that it's about how a crate is being distributed or processed:
* an Attached crate package is a directory containing the metadata file
* a Detached crate package is a standalone metadata document
I'll add specific review comments tomorrow (out of time today) but @ptsefton<https://github.com/ptsefton> does this sound right to you?
—
Reply to this email directly, view it on GitHub<#390 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AAFYTWA4C5CUNZXFIQAGDGD2MZ23FAVCNFSM6AAAAABU5SLFAOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMMJWGU3TSMBRGM>.
You are receiving this because you were mentioned.Message ID: ***@***.***>
|
There was a problem hiding this comment.
Here are my nitpicks as promised :) I'm happy with the overall requirements changes as summarised in #390 (comment), so these comments focus on wording and structure.
Some outstanding to-do items that aren't covered by the comments:
- Add
localPathto RO-Crate context (via ro-terms?) [could make a separate issue] - Update other references to attached/detached crates in line with the changes in this PR [could make a separate issue]. In particular:
- data-entities.md "Determining entity identifier for a referenced RO-Crate"
- relative-uris.md appendix, particularly the sections on converting between different types of crate
- change
{:note}callouts to new style - cross-link referenced sections where possible
- fix CI failures
- final proofread after comments are resolved
|
|
||
| _Data Entities_ can also be other types, for instance an online database. These SHOULD have a `@type` of [CreativeWork] (or one of its subtypes) and typically have a `@id` which is an absolute URI. | ||
| _Data Entities_ representing directories MUST have `Dataset` as a value for `@type`. The term _directory_ here includes HTTP file listings where `@id` is an absolute URI, however "external," _Detached_ directories SHOULD have a programmatic listing of their content (e.g. another RO-Crate). It follows that the _RO-Crate Root_ is itself a data entity. |
There was a problem hiding this comment.
Not clear to me what "external" / "detached" directories means here, and how these differ from the HTTP file listings mentioned right before. I'm not an expert on this aspect!
There was a problem hiding this comment.
I am not sure how to word this either - @stain can you help?
| * The `@id` MUST be a relative path that resolves to a directory that is present in the _RO-Crate Root_. | ||
|
|
||
| For a _Detached RO-Crate Package_: | ||
| * If the `@id` is a _URI Path it MAY be used to create a directory and MAY resolve to a service which returns a list of files |
There was a problem hiding this comment.
Think we can now remove "it MAY be used to create a directory" as we have moved away from the idea of @id as suggested file path
Co-authored-by: Eli Chadwick <[email protected]>
Co-authored-by: Eli Chadwick <[email protected]>
… into attached-detached-lite Just updating
This is another approach to clarifying Attached vs Detached that does not introduce much new terminology or conformsTo etc. Again, this is a first pass to see if this approach makes sense, it will need checking.
I moved a bit of stuff around in structure.md but there are no major changes there except to cover how to deal with a Detached RO-Crate Package. Also, did not try to deal with how you'd link one to a website.
In the section on Data Entites i further tidied up the logic around @ids and contentUrls -- I think this has made it clearer, and I don't think it will be hard to implement.
Thanks for your feedback @simleo about the complexity in my last try.