diff options
| author | Bryan Newbold <bnewbold@robocracy.org> | 2019-05-20 16:57:57 -0700 |
|---|---|---|
| committer | Bryan Newbold <bnewbold@robocracy.org> | 2019-05-20 16:57:57 -0700 |
| commit | cd829eedb5bfc7328ab5266650a625a6c88db6fa (patch) | |
| tree | 90aa164cbd7f4e86aadc25dbd036dab680c30e80 /guide/src/entity_fileset.md | |
| parent | eb31be2172264091e192bcb4f17ffd571253fffa (diff) | |
| download | fatcat-cd829eedb5bfc7328ab5266650a625a6c88db6fa.tar.gz fatcat-cd829eedb5bfc7328ab5266650a625a6c88db6fa.zip | |
start refactoring guide (per-entity pages)
Diffstat (limited to 'guide/src/entity_fileset.md')
| -rw-r--r-- | guide/src/entity_fileset.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/guide/src/entity_fileset.md b/guide/src/entity_fileset.md new file mode 100644 index 00000000..7e5ac757 --- /dev/null +++ b/guide/src/entity_fileset.md @@ -0,0 +1,21 @@ + +# Fileset Entity Reference + +## Fields + +Warning: This schema is not yet stable. + +- `manifest` (array of objects): each entry represents a file + - `path` (string, required): relative path to file (including filename) + - `size` (integer, required): in bytes + - `md5` (string): MD5 hash in lower-case hex + - `sha1` (string): SHA-1 hash in lower-case hex + - `sha256` (string): SHA-256 hash in lower-case hex + - `extra` (object): any extra metadata about this specific file +- `urls`: An array of "typed" URLs. Order is not meaningful, and may not be + preserved. + - `url` (string, required): + Eg: "https://example.edu/~frau/prcding.pdf". + - `rel` (string, required): + Eg: "webarchive". +- `release_ids` (array of string identifiers): references to `release` entities |