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.

Sign up for GitHub

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

Jump to bottom

Additional MUSTs re manifest keys #561

Merged
merged 5 commits into from
Oct 5, 2021
Merged

Additional MUSTs re manifest keys #561

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0bf6500
Additional MUSTs re manifest keys
zimeon Sep 22, 2021
41728d8
Fix reference to state blocks
zimeon Sep 29, 2021
49259e2
Align with spec text
zimeon Oct 3, 2021
f7bacb8
Merge branch 'main' into issue-537-part-1
zimeon Oct 3, 2021
3d28d74
Make all of E107 match the spec...
zimeon Oct 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions draft/spec/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -673,14 +673,15 @@ <h2>Basic Structure</h2>
<section id="manifest">
<h2>Manifest</h2>
<p>
The value of the <code>manifest</code> key is a JSON object, with keys corresponding to the digests
of every content file in the current and previous versions of the <a>OCFL Object</a>. The value for
each key <span id="E092">MUST</span> be an array containing the <a>content path</a>s of files in the
OCFL Object that have content with the given digest. As JSON keys are case sensitive, while digests may
not be, there is an additional requirement that each digest value <span id="E096">MUST</span> occur
only once in the manifest regardless of case. Content paths within a manifest block
<span id="E042">MUST</span> be relative to the <a>OCFL Object Root</a>. The following restrictions
avoid ambiguity and provide path safety for clients processing the <code>manifest</code>.
The value of the <code>manifest</code> key <span id="E106">MUST</span> be a JSON object, and each key
<span id="E107">MUST</span> correspond to a digest value key found in one or more <code>state</code>
blocks of the current and/or previous <code>version</code> blocks of the <a>OCFL Object</a>. The
value for each key <span id="E092">MUST</span> be an array containing the <a>content path</a>s of files
in the OCFL Object that have content with the given digest. As JSON keys are case sensitive, while
digests may not be, there is an additional requirement that each digest value
<span id="E096">MUST</span> occur only once in the manifest regardless of case. Content paths within a
manifest block <span id="E042">MUST</span> be relative to the <a>OCFL Object Root</a>. The following
restrictions avoid ambiguity and provide path safety for clients processing the <code>manifest</code>.
</p>
<ul>
<li>The content path <span id="E098">MUST</span> be interpreted as a set of one or more
Expand Down
2 changes: 2 additions & 0 deletions draft/spec/validation-codes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,8 @@
| E103 | 'Each version directory within an OCFL Object MUST conform to either the same or a later OCFL specification version as the preceding version directory.' | https://ocfl.io/draft/spec/#E103
| E104 | 'Version directory names MUST be constructed by prepending v to the version number.' | https://ocfl.io/draft/spec/#E104
| E105 | 'The version number MUST be taken from the sequence of positive, base-ten integers: 1, 2, 3, etc.' | https://ocfl.io/draft/spec/#E105
| E106 | 'The value of the manifest key MUST be a JSON object.' | https://ocfl.io/draft/spec/#E106
| E107 | '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 blocks of the current and/or previous version blocks of the OCFL Object.' | https://ocfl.io/draft/spec/#E107

## Warnings (corresponding with SHOULD in specification)

Expand Down