From 245b2e89dde752ec43b05238b56065b3f5b80ed5 Mon Sep 17 00:00:00 2001
From: Martin Czygan <martin.czygan@gmail.com>
Date: Tue, 17 Dec 2019 21:23:10 +0100
Subject: document year and date of withdrawn release

---
 guide/src/entity_release.md | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

(limited to 'guide/src')

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.
-- 
cgit v1.2.3