From b64f0b82eb10b0d4119df017f91e593d4e00277b Mon Sep 17 00:00:00 2001 From: Aref Shafaei Date: Mon, 18 Mar 2024 11:44:45 -0700 Subject: [PATCH] document optional export template parameters --- docs/user-docs/export.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/user-docs/export.md b/docs/user-docs/export.md index d8a732c5..bc01dccf 100644 --- a/docs/user-docs/export.md +++ b/docs/user-docs/export.md @@ -54,9 +54,9 @@ To have a overall picture of how the export templates look like, you can refer t ], "transforms": [], // refer to export module for more details "postprocessors": [], // refer to export module for more details - "public": , // refer to export module for more details + "public": , // refer to export module for more details "bag_archiver": , // refer to export module for more details - "bag_idempotent": // refer to export module for more details (defaulted to false it not present) + "bag_idempotent": // refer to export module for more details (defaulted to false it not present) } ] } @@ -71,12 +71,18 @@ The object structure of an export template annotation is defined as follows: | Variable | Type | Inclusion| Description | | --- | --- | --- | --- | | `templates` | array[`template`] | required | An array of `template` objects. + #### `template` (object) | Variable | Type | Inclusion| Description | | --- | --- | --- | --- | | `displayname` | string | required | The display name that will be used to populate the Chaise export format drop-down box for this `template`. | `type` | string, enum [`"FILE"`,`"BAG"`] | required | One of two keywords; `"FILE"` or `"BAG"`, used to determine the container format for results. | `outputs` | array[`output`] | required | An array of `output` objects. See below. +| `transforms` | array[`transform_processor`] | optional | The defined value will be passed as `transform_processors` to the deriva backend services. Find more information [here](https://github.com/informatics-isi-edu/deriva-py/blob/master/docs/cli/deriva-download-cli.md#supported-transform_processors). +| `postprocessors` | array | optional | The defined value will be passed as `post_processors` to the deriva backend services. +| `public` | boolean | optional | ? +| `bag_archiver` | enum [`"zip"`,`"tar"`,`"tgz"`] | optional | A string representing the default archiving format to use if not otherwise specified. Valid values are "zip", "tar", and "tgz". +| `bag_idempotent` | boolean | optional | ? #### `output` (object) | Variable | Type | Inclusion| Description |