Skip to content

Commit 86f42f0

Browse files
committed
update troubleshooting headers
1 parent 3e88cda commit 86f42f0

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

docs/source/troubleshooting.rst

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
1+
###############
12
Troubleshooting
2-
===============
3+
###############
34

45
These are some common issues you may encounter when using schematic
56

7+
*********
68
Debugging
7-
---------
9+
*********
10+
811
Whether you are using DCA or schematic API or schematic library/CLI, the following are some steps that you want to take to debug your issues. Here are some steps to walk you through the process.
912

1013
1. What was the command that caused the error?
@@ -120,6 +123,9 @@ Whether you are using DCA or schematic API or schematic library/CLI, the followi
120123
-H 'accept: application/json' ...
121124
122125
126+
Manifest Submission
127+
===================
128+
123129
Manifest Submit: `RuntimeError: failed with SynapseHTTPError('400 Client Error: nan is not a valid Synapse ID.')`
124130
-----------------------------------------------------------------------------------------------------------------
125131

@@ -154,6 +160,10 @@ You may encounter this error if your manifest has an "id" (lower case) column du
154160
To fix: Delete the `id` (any case variation) and `eTag` column (any case variation) from your manifest and submit the manifest again.
155161

156162

163+
Manifest Validation
164+
===================
165+
166+
157167
Manifest validation: `The submitted metadata does not contain all required column(s)`
158168
-------------------------------------------------------------------------------------
159169

@@ -172,6 +182,8 @@ but the actual Component name is "ImagingAssayTemplate".
172182

173183
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"
174184

185+
Manifest Generation
186+
===================
175187

176188
Manifest Generate: `KeyError: entityId`
177189
---------------------------------------

0 commit comments

Comments
 (0)