aboutsummaryrefslogtreecommitdiffstats
path: root/guide/src/entity_fileset.md
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2021-11-17 16:23:09 -0800
committerBryan Newbold <bnewbold@robocracy.org>2021-11-17 16:23:09 -0800
commit1e0bf431fbd1ab00f27a305ff3492de8eac90ba6 (patch)
tree0dbeffe9eef5882eb3ced5b15d1137c569241b90 /guide/src/entity_fileset.md
parentf64a469b8a8aa9319013d6099ad38e7cde495e18 (diff)
downloadfatcat-1e0bf431fbd1ab00f27a305ff3492de8eac90ba6.tar.gz
fatcat-1e0bf431fbd1ab00f27a305ff3492de8eac90ba6.zip
guide: document content_scope field
Diffstat (limited to 'guide/src/entity_fileset.md')
-rw-r--r--guide/src/entity_fileset.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/guide/src/entity_fileset.md b/guide/src/entity_fileset.md
index e1ac3e67..6083a09d 100644
--- a/guide/src/entity_fileset.md
+++ b/guide/src/entity_fileset.md
@@ -21,6 +21,10 @@
- `rel` (string, required):
Eg: "webarchive".
- `release_ids` (array of string identifiers): references to `release` entities
+- `content_scope` (string): for situations where the fileset does not simply
+ contain the full representation of a work (eg, all files in dataset, for a
+ `dataset` release), describes what that scope of coverage is. Uses same
+ vocabulary as File entity.
- `extra` (object with string keys): additional metadata about this group of
files, including upstream platform-specific metadata and identifiers