Skip to content

Commit 2d52385

Browse files
committed
various fixes
1 parent bac53ff commit 2d52385

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

docs/explanations/manifest_csv.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ The format of the manifest file is a comma-separated value (CSV) file with one r
2222
### Standard fields
2323

2424
These columns are recognized by `sync_to_synapse` and have specific meaning. Any of these columns may be present in the manifest but only `path` and `parentId` are required for upload.
25+
Each of these are individual examples and is what you would find in a row in each of these columns. To clarify, "syn1235;/path/to_local/file.txt" below states that you would like both "syn1234" and "/path/to_local/file.txt" added as items used to generate a file. You can also specify one item by specifying "syn1234"
2526

2627
| Field | Meaning | Example |
2728
|---------------------|--------------------------------------------|----------------------------------------------|
@@ -30,7 +31,7 @@ These columns are recognized by `sync_to_synapse` and have specific meaning. Any
3031
| ID | Synapse entity ID | syn2345 |
3132
| name | name of file in Synapse | Example_file |
3233
| synapseStore | whether to upload the file | True |
33-
| contentType | content type of file to overload defaults | text/html |
34+
| contentType | content type of file to overwrite defaults | text/html |
3435
| forceVersion | whether to update version | False |
3536
| activityName | name of activity in provenance | Ran normalization |
3637
| activityDescription | text description of what was done | Ran algorithm xyz with parameters... |
@@ -96,9 +97,9 @@ The CSV manifest format is shared across multiple tools:
9697
|----------------------------------------------------------|---------------------------------|
9798
| `Project.sync_from_synapse` / `Folder.sync_from_synapse` | manifest.csv |
9899
| Synapse UI download cart | manifest.csv |
99-
| CLI `synapse get-download-list` | manifest\_\<timestamp\>.csv |
100+
| CLI `synapse get-download-list` | `manifest_<timestamp>.csv` |
100101

101-
A manifest generated by any of these sources can be used as input to `sync_to_synapse`, provided the `path` column is present with valid local file paths. Manifests from the Synapse UI and CLI do not include a `path` column by default, so users must add it before uploading.
102+
A manifest generated by any of these sources can be used as input to `sync_to_synapse`, provided the `path` column is present with valid local file paths. Manifests from the Synapse UI not include a `path` column by default, so users must add it before uploading.
102103

103104
### Example manifest file
104105

0 commit comments

Comments
 (0)