Skip to content

Commit 71743bd

Browse files
committed
update submission headers
1 parent 5383b3e commit 71743bd

File tree

1 file changed

+39
-32
lines changed

1 file changed

+39
-32
lines changed

docs/source/manifest_submission.rst

Lines changed: 39 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,44 @@
1+
#############################
12
Submit a manifest to Synapse
2-
============================
3+
#############################
34

5+
*************
46
Prerequisites
5-
-------------
7+
*************
68

79
**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)**:
18+
`<https://schematic.api.sagebionetworks.org/v1/ui/#/>`_
19+
20+
This will open the **Swagger UI**, where you can explore all available API endpoints.
21+
922

1023
**Before Using the Schematic CLI**
24+
==================================
1125

1226
- **Install and Configure Schematic**:
13-
Ensure you have installed `schematic` and set up its dependencies.
14-
See the :ref:`installation` section for more details.
27+
Ensure you have installed ``schematic`` and set up its dependencies.
28+
See the :ref:`installation:installation` section for more details.
1529

1630
- **Understand Important Concepts**:
1731
Familiarize yourself with key concepts outlined on the :ref:`index` of the documentation.
1832

1933
- **Configuration File**:
20-
For more details on configuring Schematic, refer to the :ref:`configure schematic` section.
34+
For more details on configuring Schematic, refer to the :ref:`configuration:Configure Schematic` section.
2135

2236
- **Obtain a manifest**:
2337
Please obtain a manifest by following the documentation of generating a manifest.
2438

2539

26-
**Using the Schematic API in Production**
27-
28-
Visit the **Schematic API (Production Environment)**:
29-
`<https://schematic.api.sagebionetworks.org/v1/ui/#/>`_
30-
31-
This will open the **Swagger UI**, where you can explore all available API endpoints.
32-
33-
3440
Run help command
35-
----------------
41+
=================
3642

3743
You could run the following commands to learn about subcommands with manifest submission:
3844

@@ -46,9 +52,9 @@ You could also run the following commands to learn about all the options with ma
4652
4753
schematic model --config path/to/config.yml submit -h
4854
49-
55+
**********************************
5056
Submit a Manifest File to Synapse
51-
---------------------------------
57+
**********************************
5258

5359
.. note::
5460

@@ -89,7 +95,7 @@ Submit a Manifest File to Synapse
8995

9096

9197
Option 1: Use the CLI
92-
~~~~~~~~~~~~~~~~~~~~~~
98+
=====================
9399

94100
.. note::
95101

@@ -110,7 +116,7 @@ Option 1: Use the CLI
110116

111117

112118
Option 2: Use the API
113-
~~~~~~~~~~~~~~~~~~~~~~
119+
======================
114120

115121
.. note::
116122

@@ -143,9 +149,9 @@ Option 2: Use the API
143149
- **table_column_names**: This is optional. Available options are "class_label", "display_label", and "display_name". The default is "class_label".
144150

145151

146-
152+
*******************************************
147153
Submit a Manifest file and Add Annotations
148-
-------------------------------------------
154+
*******************************************
149155

150156
.. note::
151157

@@ -154,7 +160,7 @@ Submit a Manifest file and Add Annotations
154160

155161

156162
Option 1: Use the CLI
157-
~~~~~~~~~~~~~~~~~~~~~~
163+
=====================
158164

159165

160166
.. note::
@@ -176,7 +182,7 @@ Option 1: Use the CLI
176182

177183

178184
Option 2: Use the API
179-
~~~~~~~~~~~~~~~~~~~~~~
185+
======================
180186

181187
.. note::
182188

@@ -209,9 +215,9 @@ Option 2: Use the API
209215
- **table_column_names**: This is optional. Available options are "class_label", "display_label", and "display_name". The default is "class_label".
210216

211217

212-
218+
**************************************
213219
Expedite submission process (Optional)
214-
---------------------------------------
220+
**************************************
215221

216222
If your asset view contains multiple projects, it might take some time for the submission to finish.
217223

@@ -221,7 +227,7 @@ To utilize this parameter, make sure that the projects listed there are part of
221227

222228

223229
Option 1: Use the CLI
224-
~~~~~~~~~~~~~~~~~~~~~~
230+
=====================
225231

226232
.. code-block:: bash
227233
@@ -231,7 +237,7 @@ Option 1: Use the CLI
231237

232238

233239
Option 2: Use the API
234-
~~~~~~~~~~~~~~~~~~~~~~
240+
======================
235241

236242
1. Visit the `**model/submit** endpoint <https://schematic.api.sagebionetworks.org/v1/ui/#/Model%20Operations/schematic_api.api.routes.submit_manifest_route>`_
237243
2. Click **"Try it out"** to enable input fields.
@@ -261,22 +267,23 @@ Option 2: Use the API
261267
- **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.
262268

263269

270+
*************************************
264271
Enable upsert for manifest submission
265-
-------------------------------------
272+
*************************************
266273

267274
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.
268275

269276

270-
Pre-requisite
271-
~~~~~~~~~~~~~~
277+
Pre-requisites
278+
==============
272279

273280
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".
274281
2. If you plan to use upsert in the future, select the upsert option during the initial table uploads.
275282
3. Currently it is required to use -tcn "display_label" with table upserts.
276283

277284

278285
Option 1: Use the CLI
279-
~~~~~~~~~~~~~~~~~~~~~~
286+
======================
280287

281288
.. code-block:: bash
282289
@@ -286,7 +293,7 @@ Option 1: Use the CLI
286293
- **-tcn**: Use display label for upsert.
287294

288295
Option 2: Use the API
289-
~~~~~~~~~~~~~~~~~~~~~~
296+
======================
290297

291298
1. Visit the `**model/submit** endpoint <https://schematic.api.sagebionetworks.org/v1/ui/#/Model%20Operations/schematic_api.api.routes.submit_manifest_route>`_
292299
2. Click **"Try it out"** to enable input fields.

0 commit comments

Comments
 (0)