Skip to content

Commit

Permalink
document optional export template parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
RFSH committed Mar 18, 2024
1 parent 9b9a428 commit b64f0b8
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/user-docs/export.md
Original file line number Diff line number Diff line change
Expand Up @@ -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": <Boolean>, // refer to export module for more details
"public": <boolean>, // refer to export module for more details
"bag_archiver": <string>, // refer to export module for more details
"bag_idempotent": <Boolean> // refer to export module for more details (defaulted to false it not present)
"bag_idempotent": <boolean> // refer to export module for more details (defaulted to false it not present)
}
]
}
Expand All @@ -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 |
Expand Down

0 comments on commit b64f0b8

Please sign in to comment.