Skip to content

Commit 970d0a6

Browse files
committed
Update docs
1 parent b1cf2dd commit 970d0a6

File tree

1 file changed

+22
-18
lines changed

1 file changed

+22
-18
lines changed

docs/source/troubleshooting.rst

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -31,24 +31,6 @@ Whether you are using DCA or schematic API or schematic library/CLI, the followi
3131
-H 'accept: application/json' ...
3232
3333
34-
Manifest Generate: `KeyError: entityId`
35-
---------------------------------------
36-
37-
If there is currently a manifest in your "Top Level Folder" on Synapse with an incorrect Filename BUT entityId column.
38-
You will be able to run manifest generate to create a new manifest with the new Filenames. However, If this manifest on Synapse does
39-
NOT have the entityId column you will encounter that error.
40-
41-
To fix: You will want to first check if your "Top Level Folder" has a manifest without the entityId column.
42-
If so, you can either submit your manifest using schematic OR (the less preferred solution) manually add the entityId column to the manifest on Synapse.
43-
44-
Manifest Generate: `ValueError: cannot insert eTag, already exists`
45-
-------------------------------------------------------------------
46-
47-
If you do NOT have a manifest in your "Top Level Folder" on Synapse and your File entities in this folder are annotated with 'eTag' key and you try to generate a manifest, it will fail.
48-
49-
To fix: This should be fixed in schematic, but for now, remove the 'eTag' annotation from your file.
50-
51-
5234
Manifest Submit: `RuntimeError: failed with SynapseHTTPError('400 Client Error: nan is not a valid Synapse ID.')`
5335
-----------------------------------------------------------------------------------------------------------------
5436

@@ -86,3 +68,25 @@ and the validation rule uses the "display" value of what's expected in the Compo
8668
but the actual Component name is "ImagingAssayTemplate".
8769

8870
To fix: Check if your manifest has invalid Component values and fill it out correctly. Using the above example, fill out your Component column with "ImagingAssayTemplate"
71+
72+
73+
Manifest Generate: `KeyError: entityId`
74+
---------------------------------------
75+
76+
Fixed: v24.12.1
77+
78+
If there is currently a manifest in your "Top Level Folder" on Synapse with an incorrect Filename BUT entityId column.
79+
You will be able to run manifest generate to create a new manifest with the new Filenames. However, If this manifest on Synapse does
80+
NOT have the entityId column you will encounter that error.
81+
82+
To fix: You will want to first check if your "Top Level Folder" has a manifest without the entityId column.
83+
If so, you can either submit your manifest using schematic OR (the less preferred solution) manually add the entityId column to the manifest on Synapse.
84+
85+
Manifest Generate: `ValueError: cannot insert eTag, already exists`
86+
-------------------------------------------------------------------
87+
88+
Fixed: v24.11.2
89+
90+
If you do NOT have a manifest in your "Top Level Folder" on Synapse and your File entities in this folder are annotated with 'eTag' key and you try to generate a manifest, it will fail.
91+
92+
To fix: This should be fixed in schematic, but for now, remove the 'eTag' annotation from your file.

0 commit comments

Comments
 (0)