From 2a7947be4a8e78c424bb9755dc1d144eed7906e2 Mon Sep 17 00:00:00 2001 From: Aref Shafaei Date: Tue, 24 Sep 2024 09:07:18 -0700 Subject: [PATCH] add a disclaimer about export 2019 vs 2016 --- docs/user-docs/export.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/user-docs/export.md b/docs/user-docs/export.md index b7a2b9ea..dc597968 100644 --- a/docs/user-docs/export.md +++ b/docs/user-docs/export.md @@ -22,7 +22,9 @@ If you just want to see the overall structure of export annotation go [here](#ov ## Export Templates -Export of data from Chaise is configured through the use of *export templates*. An export template is a JSON object that is used in an ERMrest table/schema/catalog annotation payload. The annotation is specified using `tag:isrd.isi.edu,2016:export` key. +Export of data from Chaise is configured through the use of *export templates*. An export template is a JSON object that is used in an ERMrest table/schema/catalog annotation payload. The annotation is specified using `tag:isrd.isi.edu,2019:export` key. + +> ⚠️ The first iteration of export used the [`tag:isrd.isi.edu,2016:export`](annotation-deprecated.md#tag-2016-export) tag (notice the 2016 instead of 2019). But this old tag doesn't support context and all the new features added to the new key. So please make sure you're using the new tag. The annotation payload is a JSON object containing a single array of `template` objects. One or more templates can be specified for a given table entity. Templates specify a format name and type, followed by a set of output descriptor objects. A template output descriptor maps one or more source table queries to one or more output file destinations.