summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Czygan <martin.czygan@gmail.com>2019-12-17 21:23:10 +0100
committerMartin Czygan <martin.czygan@gmail.com>2019-12-17 21:23:10 +0100
commit245b2e89dde752ec43b05238b56065b3f5b80ed5 (patch)
tree1d33797b1753725be578d8336e4e9d77b36256dc
parentda6d0b72768f465d917489531a07e08ae4f7d220 (diff)
downloadfatcat-245b2e89dde752ec43b05238b56065b3f5b80ed5.tar.gz
fatcat-245b2e89dde752ec43b05238b56065b3f5b80ed5.zip
document year and date of withdrawn release
-rw-r--r--guide/src/entity_release.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/guide/src/entity_release.md b/guide/src/entity_release.md
index 20b24719..8d2930d7 100644
--- a/guide/src/entity_release.md
+++ b/guide/src/entity_release.md
@@ -24,7 +24,11 @@
publicly available. Blank if only year is known.
- `release_year` (integer): year when this release was first made
publicly available; should match `release_date` if both are known.
-- `withdrawn_status` (string, controlled set):
+- `withdrawn_status` (optional, string, controlled set):
+- `withdrawn_date` (optional, string, ISO date format): when this release was withdrawn.
+ Blank if only year is known.
+- `withdrawn_year` (optional, integer): year when this release was withdrawn; should
+ match `withdrawn_date` if both are known.
- `ext_ids` (key/value object of string-to-string mappings): external
identifiers. At least an empty `ext_ids` object is always required for
release entities, so individual identifiers can be accessed directly.