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

must a manifest entry be referenced in at least one version's state #537

Closed
pwinckles opened this issue Mar 29, 2021 · 5 comments · Fixed by OCFL/fixtures#97
Closed

must a manifest entry be referenced in at least one version's state #537

pwinckles opened this issue Mar 29, 2021 · 5 comments · Fixed by OCFL/fixtures#97
Assignees
Labels
OCFL Object Ready for Review Ready for review by editorial group
Milestone

Comments

@pwinckles
Copy link

pwinckles commented Mar 29, 2021

Fixture E050_file_in_manifest_not_used, is a test for a manifest entry that is not referenced in any version state. It specifies the error should be E050:

The keys of [the “state” JSON object] are digest values, each of which must correspond to an entry in the manifest of the inventory.

That text states that every logical path MUST have a corresponding manifest entry. It does not state that ever manifest entry MUST have at least one corresponding logical path. The nearest I can find to such a requirement in the spec is:

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.

But, that line, besides not having an associated validation code, is ambiguous. If "versions" are version objects in the inventory, then that could be read as requiring that every manifest entry be references in at least one version's state. But, if "versions" are version directories on disk, then it doesn't seem to be a requirement at all.

@zimeon zimeon added this to the 1.1 milestone May 4, 2021
@awoods
Copy link
Member

awoods commented Sep 6, 2021

Suggested resolution:

  1. Update text of first sentence of 3.5.2 Manifest to:

    The value of the manifest key MUST be a JSON object, all keys of which MUST correspond to digest value keys found in one or more state JSON objects of the current and/or previous version blocks of the OCFL Object.

  2. Update E050_file_in_manifest_not_used to reference the newly created requirement code from above.
  3. Create a new test that checks the scenario of E050 wherein a file in the version's state object is not found in the object's manifest.

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

zimeon commented Sep 22, 2021

Proposing a PR with minor wording change from the above:

The value of the manifest key must be a JSON object, and each key must correspond to a digest value key found in one or more state JSON objects of the current and/or previous version blocks of the OCFL Object.

@rosy1280
Copy link
Contributor

@zimeon this ticket wasn't closed when you merged #561 can you please close this if it is completed?

@zimeon
Copy link
Contributor

zimeon commented Oct 21, 2021

There are three parts to the agreed solution, #561 does only part 1. Still need parts 2 & 3.

@zimeon
Copy link
Contributor

zimeon commented Oct 28, 2021

OCFL/fixtures#97 is part 2, OCFL/fixtures#98 is part 3. Complete and can close when both merged

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.

4 participants