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

Clarify that there MUST be an inventory.json file in the Object Root #293

Closed
ahankinson opened this issue Dec 31, 2018 · 0 comments
Closed
Assignees
Milestone

Comments

@ahankinson
Copy link
Contributor

We have decided to make the presence of an inventory.json file optional in the version directories (3.7 "Every version directory SHOULD include an inventory file that is an Inventory of all content for versions up to and including that particular version.") However, we don't also specify a MUST for the inventory.json file in the root of the object.

This can lead to the absurd situation where an OCFL Object without an inventory.json file is technically valid!

Propose modifying §3.7 to read:

"Every OCFL Object MUST have an inventory file within the OCFL Object Root, corresponding to the state of the OCFL Object at the current version. Additionally, every version directory SHOULD include an inventory file that is an Inventory of all content for versions up to and including that particular version. Where an OCFL Object contains inventory.json in version directories, the inventory.json in the OCFL Object Root MUST be the same as the file in the most recent version."

@ahankinson ahankinson self-assigned this Dec 31, 2018
ahankinson added a commit that referenced this issue Dec 31, 2018
@ahankinson ahankinson added this to the Beta milestone Dec 31, 2018
rosy1280 pushed a commit that referenced this issue Jan 15, 2019
* Fixed: Clarify inventory.json must be present

Fixes #293

* Fixed: Remove extraneous space
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant