-
Notifications
You must be signed in to change notification settings - Fork 2
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
Create flat layout RFC #1
Open
birkland
wants to merge
1
commit into
master
Choose a base branch
from
example-pr
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
# RFC 0003: Flat Layout | ||
|
||
* Category: Specification | ||
* Obsoleted by: n/a | ||
* Obsoletes: n/a | ||
|
||
*Note: This is not a real RFC. It's an example of its kind* | ||
|
||
## Overview | ||
|
||
This RFC defines a layout URI `https://birkland.github.io/ocfl-rfc-demo/0003-flat-layout` for use in [ocfl_layout.json](https://ocfl.io/draft/spec/#root-structure). When this URI is specified, the OCFL root is structured as a flat hierarchy, where each directory directly underneath the OCFL storage root is an OCFL object root. | ||
|
||
Directory names are a function of the object ID, and may be encoded via one of the methods prescribed in this RFC (e.g character encoding for the sake of filesystem compatibility). The encoding algorithm is specified by a URL parameter | ||
|
||
## URI structure | ||
|
||
An `ocfl_layout.json` file MUST be present in the OCFL object root. The `url` value MUST contain a URL that begins with `https://birkland.github.io/ocfl-rfc-demo/0003-flat-layout`, and MAY contain an `encoding` query parameter that describes how the ocfl object ID is encoded into a directory name. The value | ||
of the `description` field is arbitrary and irrelevant as far as this spec is concerned, a value of "Flat Layout" is sufficient, but copying the contents of this RFC | ||
would also be appropriate. | ||
|
||
The `encoding` parameter MUST be one of the following values, or absent in the case of "no encoding": | ||
|
||
* `url`. The directory names shall be determined by the urlencoded value of the ocfl object ID. | ||
* `pairtree`. The directory names shall be the value determined by [pairtree cleaning](https://tools.ietf.org/html/draft-kunze-pairtree-01#section-3) | ||
* {`sha1`, `sha256`, `sha512`}. If `encoding` is a digest algorithm, the directory names shall be determined by the digest value of the ocfl object ID. | ||
|
||
## Example | ||
|
||
### sha encoded | ||
|
||
This `ocfl_layout.json` file specifies a flat layout using sha1 encoding | ||
|
||
```json | ||
{ | ||
"url": "https://birkland.github.io/ocfl-rfc-demo/0003-flat-layout?encoding=sha1", | ||
"description": "Flat Layout" | ||
} | ||
|
||
An OCFL object with id `ark:12345/6` would have its path computed as follows: | ||
|
||
* Calculate a sha1 of the ID: `75b3b936989b76068528e71e4615808a2221dc3f` | ||
|
||
On the filesystem, an ocfl object root containing an object with that ID would look like: | ||
```plaintext | ||
[storage_root] | ||
├── 0=ocfl_1.0 | ||
├── ocfl_layout.json | ||
└── 75b3b936989b76068528e71e4615808a2221dc3f | ||
├── 0=ocfl_object_1.0 | ||
└── ... |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should close "```json" block.