diff options
| author | Bryan Newbold <bnewbold@robocracy.org> | 2021-10-13 12:44:10 -0700 |
|---|---|---|
| committer | Bryan Newbold <bnewbold@robocracy.org> | 2021-10-13 16:21:31 -0700 |
| commit | 9a333ff02d6b0eb26adb963934557529353de9a4 (patch) | |
| tree | c3ac52f716c736e46591c5dec8a34c3fd77c1453 /guide/src/entity_fileset.md | |
| parent | 6fc3cb3bd7dc8a1b40c65fc0ea609a8521aa8daf (diff) | |
| download | fatcat-9a333ff02d6b0eb26adb963934557529353de9a4.tar.gz fatcat-9a333ff02d6b0eb26adb963934557529353de9a4.zip | |
guide updates for v0.4 schema changes
Diffstat (limited to 'guide/src/entity_fileset.md')
| -rw-r--r-- | guide/src/entity_fileset.md | 23 |
1 files changed, 21 insertions, 2 deletions
diff --git a/guide/src/entity_fileset.md b/guide/src/entity_fileset.md index 7e5ac757..e1ac3e67 100644 --- a/guide/src/entity_fileset.md +++ b/guide/src/entity_fileset.md @@ -3,15 +3,17 @@ ## 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 + - `mimetype` (string): Content type in MIME type schema - `extra` (object): any extra metadata about this specific file + - `original_url`: live web canonical URL to download this file (optional) + - `webarchive_url`: web archive capture of this file (optional) + - `platform_id`: platform-specific identifier for this file - `urls`: An array of "typed" URLs. Order is not meaningful, and may not be preserved. - `url` (string, required): @@ -19,3 +21,20 @@ Warning: This schema is not yet stable. - `rel` (string, required): Eg: "webarchive". - `release_ids` (array of string identifiers): references to `release` entities +- `extra` (object with string keys): additional metadata about this group of + files, including upstream platform-specific metadata and identifiers + +#### URL `rel` types + +- `repository`: URL of a live-web landing page or other location where content can be + found. May not be machine-reachable. +- `webarchive`: web archive version of `repository` +- `repository-bundle`: direct URL to a live-web "archive" file, such as `.zip`, + which contains all of the individual files in this fileset +- `webarchive-bundle`: web archive version of `repository-bundle` +- `archive-bundle`: file archive version of `repository-bundle` +- `repository-base`: live-web base URL/directory from which file `path` can be + appended to fetch individual files +- `archive-base`: base URL/directory from which file `path` can be appended to fetch + individual files + |