summaryrefslogtreecommitdiffstats
path: root/guide/src/entity_fileset.md
blob: e1ac3e674d7b1b89028d77e018a5ad376663c4f9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

# Fileset Entity Reference

## Fields

- `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):
            Eg: "https://example.edu/~frau/prcding.pdf".
    - `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