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

clarity on manifest requirements in historic inventories #538

Closed
pwinckles opened this issue Apr 2, 2021 · 0 comments · Fixed by #547
Closed

clarity on manifest requirements in historic inventories #538

pwinckles opened this issue Apr 2, 2021 · 0 comments · Fixed by #547
Labels
OCFL Object Ready for Review Ready for review by editorial group
Milestone

Comments

@pwinckles
Copy link

My understanding is that the spec requires that the manifest entry of every inventory version contains references to all of the content files in its version and all prior versions. If this is the case, I think the language in the spec could be more clear.

Here are the relevant texts:

Every file within a version's content directory MUST be referenced in the manifest section of the inventory.

And:

The value of the manifest key is a JSON object, with keys corresponding to the digests of every content file in all versions of the OCFL Object.

The second quote could be clarified by appending something along the lines of "at the time it was written" as it clearly cannot mean all versions. However, a change like that would still leave the door open for a later version to write a file to a prior version's content directory. Doing so would not violate the requirement for either inventory to reference all of the content files that existed at the time they were created.

The first quote seems to make the stronger requirement that a version's inventory must reference all of the files within its own content directory, but is left slightly ambiguous because it is not clear which inventory "the inventory" is referring to.

@zimeon zimeon added this to the 1.1 milestone May 4, 2021
awoods pushed a commit that referenced this issue May 23, 2021
@awoods awoods added the Ready for Review Ready for review by editorial group label May 23, 2021
neilsjefferies pushed a commit that referenced this issue Jun 10, 2021
Resolves: #538

Co-authored-by: anw822 <andrew_woods@harvard.edu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OCFL Object Ready for Review Ready for review by editorial group
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants