Skip to content

Commit 63234bb

Browse files
committed
fix typos
1 parent 8355913 commit 63234bb

File tree

2 files changed

+11
-10
lines changed

2 files changed

+11
-10
lines changed

docs/tutorials/python/schema_operations.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@ JSON Schema is a tool used to validate data. In Synapse, JSON Schemas can be use
22

33
Synapse supports a subset of features from [json-schema-draft-07](https://json-schema.org/draft-07). To see the list of features currently supported, see the [JSON Schema object definition](https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/schema/JsonSchema.html) from Synapse's REST API Documentation.
44

5-
In this tutorial, you will learn how to create these JSON Schema using an existing data-model.
5+
In this tutorial, you will learn how to create these JSON Schema using an existing data model.
66

77
## Tutorial Purpose
88
You will create a JSON schema using your data model.
99

1010
## Prerequisites
1111
* You have a working [installation](../installation.md) of the Synapse Python Client.
12-
* You have a data-model, see this [example data model](https://github.com/Sage-Bionetworks/schematic/blob/develop/tests/data/example.model.column_type_component.csv).
12+
* You have a data model, see this [example data model](https://github.com/Sage-Bionetworks/schematic/blob/develop/tests/data/example.model.column_type_component.csv).
1313

1414
## 1. Imports
1515

@@ -23,11 +23,11 @@ You will create a JSON schema using your data model.
2323
{!docs/tutorials/python/tutorial_scripts/schema_operations.py!lines=4-10}
2424
```
2525

26-
To create a JSON Schema you need a data-model, and the data-types you want to create.
27-
The data-model must be in either CSV or JSON-LD form. The data model may be a local path or a URL.
26+
To create a JSON Schema you need a data model, and the data types you want to create.
27+
The data model must be in either CSV or JSON-LD form. The data model may be a local path or a URL.
2828
[Example data model](https://github.com/Sage-Bionetworks/schematic/blob/develop/tests/data/example.model.column_type_component.csv).
2929

30-
The data-types must exist in your data-model. This can be a list of data-types, or `None` to create all data-types in the data-model.
30+
The data types must exist in your data model. This can be a list of data types, or `None` to create all data types in the data model.
3131

3232
## 3. Log into Synapse
3333
```python
@@ -58,4 +58,4 @@ It will look like [this schema](https://repo-prod.prod.sagebase.org/repo/v1/sche
5858
## Reference
5959
- [JSON Schema Object Definition](https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/schema/JsonSchema.html)
6060
- [JSON Schema Draft 7](https://json-schema.org/draft-07)
61-
- [JSON-Schema.org](https://json-schema.org./)
61+
- [JSON-Schema.org](https://json-schema.org/)

docs/tutorials/python/tutorial_scripts/schema_operations.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
from synapseclient import Synapse
22
from synapseclient.extensions.curator import generate_jsonschema
33

4-
# Put the path/url of your data model here, either CSV or JSONLD format
4+
# Path or URL to your data model (CSV or JSONLD format)
5+
# Example: "path/to/my_data_model.csv" or "https://raw.githubusercontent.com/example.csv"
56
DATA_MODEL_SOURCE = "tests/unit/synapseclient/extensions/schema_files/example.model.csv"
6-
# Put the names of the datatypes in your data-model you want to create here
7-
# or None to create them all
7+
# List of component names/data types to create schemas for, or None for all components/data types
8+
# Example: ["Patient", "Biospecimen"] or None
89
DATA_TYPE = ["Patient"]
9-
# Put the directory where you want the JSONSchema to generated at here
10+
# Directory where JSON Schema files will be saved
1011
OUTPUT_DIRECTORY = "./"
1112

1213
syn = Synapse()

0 commit comments

Comments
 (0)