You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/manifest_submission.rst
+39-32Lines changed: 39 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,38 +1,44 @@
1
+
#############################
1
2
Submit a manifest to Synapse
2
-
============================
3
+
#############################
3
4
5
+
*************
4
6
Prerequisites
5
-
-------------
7
+
*************
6
8
7
9
**Obtain Synapse Credentials**:
8
-
Ensure you have a Synapse account and set up Synapse configuration file correctly. See the :ref:`installation` section for more details.
10
+
================================
11
+
Ensure you have a Synapse account and set up Synapse configuration file correctly. See the :ref:`setting up configuration files <installation:6. Set up configuration files>` section for more details.
12
+
13
+
14
+
**Using the Schematic API in Production**
15
+
=========================================
16
+
17
+
Visit the **Schematic API (Production Environment)**:
This will open the **Swagger UI**, where you can explore all available API endpoints.
32
-
33
-
34
40
Run help command
35
-
----------------
41
+
=================
36
42
37
43
You could run the following commands to learn about subcommands with manifest submission:
38
44
@@ -46,9 +52,9 @@ You could also run the following commands to learn about all the options with ma
46
52
47
53
schematic model --config path/to/config.yml submit -h
48
54
49
-
55
+
**********************************
50
56
Submit a Manifest File to Synapse
51
-
---------------------------------
57
+
**********************************
52
58
53
59
.. note::
54
60
@@ -89,7 +95,7 @@ Submit a Manifest File to Synapse
89
95
90
96
91
97
Option 1: Use the CLI
92
-
~~~~~~~~~~~~~~~~~~~~~~
98
+
=====================
93
99
94
100
.. note::
95
101
@@ -110,7 +116,7 @@ Option 1: Use the CLI
110
116
111
117
112
118
Option 2: Use the API
113
-
~~~~~~~~~~~~~~~~~~~~~~
119
+
======================
114
120
115
121
.. note::
116
122
@@ -143,9 +149,9 @@ Option 2: Use the API
143
149
- **table_column_names**: This is optional. Available options are "class_label", "display_label", and "display_name". The default is "class_label".
144
150
145
151
146
-
152
+
*******************************************
147
153
Submit a Manifest file and Add Annotations
148
-
-------------------------------------------
154
+
*******************************************
149
155
150
156
.. note::
151
157
@@ -154,7 +160,7 @@ Submit a Manifest file and Add Annotations
154
160
155
161
156
162
Option 1: Use the CLI
157
-
~~~~~~~~~~~~~~~~~~~~~~
163
+
=====================
158
164
159
165
160
166
.. note::
@@ -176,7 +182,7 @@ Option 1: Use the CLI
176
182
177
183
178
184
Option 2: Use the API
179
-
~~~~~~~~~~~~~~~~~~~~~~
185
+
======================
180
186
181
187
.. note::
182
188
@@ -209,9 +215,9 @@ Option 2: Use the API
209
215
- **table_column_names**: This is optional. Available options are "class_label", "display_label", and "display_name". The default is "class_label".
210
216
211
217
212
-
218
+
**************************************
213
219
Expedite submission process (Optional)
214
-
---------------------------------------
220
+
**************************************
215
221
216
222
If your asset view contains multiple projects, it might take some time for the submission to finish.
217
223
@@ -221,7 +227,7 @@ To utilize this parameter, make sure that the projects listed there are part of
221
227
222
228
223
229
Option 1: Use the CLI
224
-
~~~~~~~~~~~~~~~~~~~~~~
230
+
=====================
225
231
226
232
.. code-block:: bash
227
233
@@ -231,7 +237,7 @@ Option 1: Use the CLI
231
237
232
238
233
239
Option 2: Use the API
234
-
~~~~~~~~~~~~~~~~~~~~~~
240
+
======================
235
241
236
242
1. Visit the `**model/submit** endpoint <https://schematic.api.sagebionetworks.org/v1/ui/#/Model%20Operations/schematic_api.api.routes.submit_manifest_route>`_
237
243
2. Click **"Try it out"** to enable input fields.
@@ -261,22 +267,23 @@ Option 2: Use the API
261
267
- **table_column_names**: This parameter is not applicable when uploading a manifest as a file. You can keep it as is and it will be ignored.
262
268
263
269
270
+
*************************************
264
271
Enable upsert for manifest submission
265
-
-------------------------------------
272
+
*************************************
266
273
267
274
By default, the CLI/API will replace the existing manifest and table with the new one. If you want to update the existing manifest and table, you could use the upsert option.
268
275
269
276
270
-
Pre-requisite
271
-
~~~~~~~~~~~~~~
277
+
Pre-requisites
278
+
==============
272
279
273
280
1. Ensure that all your manifests, including both the initial manifests and those containing rows to be upserted, include a primary key: <YourComponentName_id>. For example, if your component name is "Patient", the primary key should be "Patient_id".
274
281
2. If you plan to use upsert in the future, select the upsert option during the initial table uploads.
275
282
3. Currently it is required to use -tcn "display_label" with table upserts.
276
283
277
284
278
285
Option 1: Use the CLI
279
-
~~~~~~~~~~~~~~~~~~~~~~
286
+
======================
280
287
281
288
.. code-block:: bash
282
289
@@ -286,7 +293,7 @@ Option 1: Use the CLI
286
293
- **-tcn**: Use display label for upsert.
287
294
288
295
Option 2: Use the API
289
-
~~~~~~~~~~~~~~~~~~~~~~
296
+
======================
290
297
291
298
1. Visit the `**model/submit** endpoint <https://schematic.api.sagebionetworks.org/v1/ui/#/Model%20Operations/schematic_api.api.routes.submit_manifest_route>`_
0 commit comments