Skip to content

Commit 06a18ed

Browse files
committed
Add documentation for validating annotations
1 parent 7923ce3 commit 06a18ed

32 files changed

Lines changed: 1358 additions & 117 deletions

docs/articles/validate_annotations.rst

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,13 @@
22
Validate Annotations
33
********************
44

5+
.. warning::
6+
This is a beta implementation and is subject to change. Use at your own risk.
7+
58
Validate annotations on your Synapse entities by leveraging the JSON schema services.
69
Here are the steps you must take to set up the JSON Schema service.
710

11+
812
Create a JSON Schema organization
913
=================================
1014

@@ -45,6 +49,7 @@ Manage a specific version of a JSON schema::
4549

4650

4751
Create a new JSON schema version for an existing organization::
52+
4853
from random import randint
4954
rint = randint(0, 100000)
5055
org_name = "bgrande.test"
@@ -74,22 +79,23 @@ Test validation on a Synapse entity::
7479
js.validation_stats(synapse_id)
7580
js.unbind_json_schema(synapse_id)
7681

77-
# Access to low-level API functions
78-
# js.create_organization(organization_name)
79-
# js.get_organization(organization_name)
80-
# js.list_organizations()
81-
# js.delete_organization(organization_id)
82-
# js.get_organization_acl(organization_id)
83-
# js.update_organization_acl(organization_id, resource_access, etag)
84-
# js.list_json_schemas(organization_name)
85-
# js.list_json_schema_versions(organization_name, json_schema_name)
86-
# js.create_json_schema(json_schema_body, dry_run)
87-
# js.get_json_schema_body(json_schema_uri)
88-
# js.delete_json_schema(json_schema_uri)
89-
# js.json_schema_validation(json_schema_uri)
90-
# js.bind_json_schema_to_entity(synapse_id, json_schema_uri)
91-
# js.get_json_schema_from_entity(synapse_id)
92-
# js.delete_json_schema_from_entity(synapse_id)
93-
# js.validate_entity_with_json_schema(synapse_id)
94-
# js.get_json_schema_validation_statistics(synapse_id)
95-
# js.get_invalid_json_schema_validation(synapse_id)
82+
Access to low-level API functions::
83+
84+
js.create_organization(organization_name)
85+
js.get_organization(organization_name)
86+
js.list_organizations()
87+
js.delete_organization(organization_id)
88+
js.get_organization_acl(organization_id)
89+
js.update_organization_acl(organization_id, resource_access, etag)
90+
js.list_json_schemas(organization_name)
91+
js.list_json_schema_versions(organization_name, json_schema_name)
92+
js.create_json_schema(json_schema_body, dry_run)
93+
js.get_json_schema_body(json_schema_uri)
94+
js.delete_json_schema(json_schema_uri)
95+
js.json_schema_validation(json_schema_uri)
96+
js.bind_json_schema_to_entity(synapse_id, json_schema_uri)
97+
js.get_json_schema_from_entity(synapse_id)
98+
js.delete_json_schema_from_entity(synapse_id)
99+
js.validate_entity_with_json_schema(synapse_id)
100+
js.get_json_schema_validation_statistics(synapse_id)
101+
js.get_invalid_json_schema_validation(synapse_id)

docs/build/html/api/Activity.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ <h2>Activity<a class="headerlink" href="#activity" title="Permalink to this head
247247

248248
<div role="contentinfo">
249249
<p>&#169; Copyright 2012-2023, Sage Bionetworks.
250-
<span class="lastupdated">Last updated on Aug 13, 2023.
250+
<span class="lastupdated">Last updated on Aug 26, 2023.
251251
</span></p>
252252
</div>
253253

@@ -268,7 +268,7 @@ <h2>Activity<a class="headerlink" href="#activity" title="Permalink to this head
268268
</script>
269269
<div class="footer">
270270
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
271-
Last updated on Aug 13, 2023.
271+
Last updated on Aug 26, 2023.
272272
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.5.0.
273273
</div>
274274
<script type="text/javascript">

docs/build/html/api/Annotations.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ <h2>Classes<a class="headerlink" href="#classes" title="Permalink to this headli
199199

200200
<div role="contentinfo">
201201
<p>&#169; Copyright 2012-2023, Sage Bionetworks.
202-
<span class="lastupdated">Last updated on Aug 13, 2023.
202+
<span class="lastupdated">Last updated on Aug 26, 2023.
203203
</span></p>
204204
</div>
205205

@@ -220,7 +220,7 @@ <h2>Classes<a class="headerlink" href="#classes" title="Permalink to this headli
220220
</script>
221221
<div class="footer">
222222
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
223-
Last updated on Aug 13, 2023.
223+
Last updated on Aug 26, 2023.
224224
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.5.0.
225225
</div>
226226
<script type="text/javascript">

docs/build/html/api/Client.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1644,7 +1644,7 @@ <h2>More information<a class="headerlink" href="#more-information" title="Permal
16441644

16451645
<div role="contentinfo">
16461646
<p>&#169; Copyright 2012-2023, Sage Bionetworks.
1647-
<span class="lastupdated">Last updated on Aug 13, 2023.
1647+
<span class="lastupdated">Last updated on Aug 26, 2023.
16481648
</span></p>
16491649
</div>
16501650

@@ -1665,7 +1665,7 @@ <h2>More information<a class="headerlink" href="#more-information" title="Permal
16651665
</script>
16661666
<div class="footer">
16671667
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
1668-
Last updated on Aug 13, 2023.
1668+
Last updated on Aug 26, 2023.
16691669
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.5.0.
16701670
</div>
16711671
<script type="text/javascript">

docs/build/html/api/Entity.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -461,7 +461,7 @@ <h2>Properties and annotations, implementation details<a class="headerlink" href
461461

462462
<div role="contentinfo">
463463
<p>&#169; Copyright 2012-2023, Sage Bionetworks.
464-
<span class="lastupdated">Last updated on Aug 13, 2023.
464+
<span class="lastupdated">Last updated on Aug 26, 2023.
465465
</span></p>
466466
</div>
467467

@@ -482,7 +482,7 @@ <h2>Properties and annotations, implementation details<a class="headerlink" href
482482
</script>
483483
<div class="footer">
484484
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
485-
Last updated on Aug 13, 2023.
485+
Last updated on Aug 26, 2023.
486486
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.5.0.
487487
</div>
488488
<script type="text/javascript">

docs/build/html/api/Evaluation.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ <h2>Submission Status<a class="headerlink" href="#submission-status" title="Perm
277277

278278
<div role="contentinfo">
279279
<p>&#169; Copyright 2012-2023, Sage Bionetworks.
280-
<span class="lastupdated">Last updated on Aug 13, 2023.
280+
<span class="lastupdated">Last updated on Aug 26, 2023.
281281
</span></p>
282282
</div>
283283

@@ -298,7 +298,7 @@ <h2>Submission Status<a class="headerlink" href="#submission-status" title="Perm
298298
</script>
299299
<div class="footer">
300300
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
301-
Last updated on Aug 13, 2023.
301+
Last updated on Aug 26, 2023.
302302
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.5.0.
303303
</div>
304304
<script type="text/javascript">

0 commit comments

Comments
 (0)