[SYNPY-1697] Add Create JSON Schema tutorial #1271
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
thomasyu888
reviewed
Nov 5, 2025
thomasyu888
reviewed
Nov 5, 2025
thomasyu888
changed the title
thomasyu888
changed the title
BryanFauble
reviewed
Nov 6, 2025
BryanFauble
reviewed
Nov 7, 2025
BryanFauble
requested changes
Nov 7, 2025
Member
BryanFauble
left a comment
BryanFauble
left a comment
There was a problem hiding this comment.
There is a bit of work left on these. Thank you for the initial stab at this!
BryanFauble
reviewed
Nov 7, 2025
Co-authored-by: BryanFauble <17128019+BryanFauble@users.noreply.github.com>
BryanFauble
reviewed
Nov 7, 2025
| ``` | ||
|
|
||
| To create a JSON Schema you need a data-model, and the data-types you want to create. | ||
| The data-model must be in either CSV or JSON-LD form. The data model maybe a local path or a URL. |
Member
There was a problem hiding this comment.
Suggested change
| The data-model must be in either CSV or JSON-LD form. The data model maybe a local path or a URL. | |
| The data-model must be in either CSV or JSON-LD form. The data model may be a local path or a URL. |
Member
There was a problem hiding this comment.
It would be great to also include an example of what the URL looks like by using one of the published data models that we have available to us.
Co-authored-by: BryanFauble <17128019+BryanFauble@users.noreply.github.com>
BryanFauble
reviewed
Nov 7, 2025
| ```python | ||
| {!docs/tutorials/python/tutorial_scripts/schema_operations.py!lines=15-23} | ||
| ``` | ||
| You should see the first JSON Schema for the datatype(s) you selected printed. |
Member
There was a problem hiding this comment.
Could you include the example output of what would be printed here given the example URL data model that we will use? That way folks have a bit of context of what to expect.
BryanFauble
approved these changes
Nov 7, 2025
Member
BryanFauble
left a comment
BryanFauble
left a comment
There was a problem hiding this comment.
Looking better! Thanks for the changes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem:
Schematic code was extracted to the Curator extension(minus the cli commands). There is no instructiosn for how to crate a JSON Schema using curator extention as a python library.
Solution:
Add a short tutorial for how to create json shemas. This could be replaced or added onto a tutorial for creating json schema via CLI in the future.