[SYNPY-1673] Add JSONSchema documentation, deprecate old classes #1262
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
* Update jsonschema tutorial * Update script * update script locations * Add a line
jaymedina
reviewed
Oct 23, 2025
|
There are broken reference links in the appendix: |
jaymedina
reviewed
Oct 23, 2025
| * You have a working [installation](../installation.md) of the Synapse Python Client. | ||
| * Make sure that you have completed the [Project](./project.md) tutorial, which covers creating and managing projects in Synapse. This is a prerequisite because you need a project to organize and store the folder used in this tutorial. | ||
| * You are familiar with Synapse concepts: [Project](./project.md), [Folder](./folder.md), [File](./file.md). | ||
| * You are familiar with [adding annotations](./annotation.md) to synapse entity. |
There was a problem hiding this comment.
nit: Would also add that familiarity with SchemaOrganization is also necessary
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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:
The new JSONSchema classes need documentation.
The old JSONSchema classes need to be deprecated.
While writing the tutorial a bug was found:
JSONSchema.store-asyncwas overwriting itsidattribute with theidfield from the CreateSchemaResponse . These are not the same thing.JSONSchema.idis an integer identifier created by synapse in string form (ie.1880). The id from CreateSchemaResponse is a url.Solution:
Documentation files added for new JSONSchema classes.
Old JSONSchema classes are deprecated. For these, I just deprecated the classes. The old file states
This is a beta implementation and is subject to change. Use at your own risk.so i didn't include examples of how to use the new classes here. I can add these if needed.Tutorials added in this PR
The bug was fixed in
JSONSchema.store-asyncby not updating theidattribute.