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

Manifest is missing MUSTS #533

Closed
pwinckles opened this issue Mar 19, 2021 · 3 comments
Closed

Manifest is missing MUSTS #533

pwinckles opened this issue Mar 19, 2021 · 3 comments
Assignees
Labels
OCFL Object Ready for Review Ready for review by editorial group
Milestone

Comments

@pwinckles
Copy link

The manifest section does not have the same level of thoroughness when it comes to MUSTS as the versions section does. For example:

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.

vs

An OCFL Object Inventory MUST include a block for storing versions. This block MUST have the key of versions within the inventory, and it MUST be a JSON object.

The result is that the validation codes are not as specific for manifest and rely more on inferences from other codes. In this example, if manifest is not a JSON object I think E033 makes the most sense. Whereas, if versions is not a JSON object the more specific E044 could be used.

@zimeon
Copy link
Contributor

zimeon commented Mar 26, 2021

So far, I have used E041 for either missing manifest key or it not being a JSON object, based on:

In addition to these keys, there MUST be two other blocks present, manifest and versions, which are discussed in the next two sections.

if the "is a" became a "MUST" in:

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.

then that would clearly take over for the "not an object" case.

Seems that there is no lack of clarity for what is correct here, just uncertainty over the best way to handle validation. I think this makes it a 2.0 (or 1.1) issue.

@awoods
Copy link
Member

awoods commented Sep 6, 2021

This specific example may be resolved by: #537 (comment)

@awoods awoods added the Ready for Review Ready for review by editorial group label Sep 6, 2021
@zimeon
Copy link
Contributor

zimeon commented Oct 5, 2021

Addressed by #561

@zimeon zimeon closed this as completed Oct 5, 2021
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

No branches or pull requests

3 participants