Skip to content

Commit 759ee10

Browse files
thomasyu888thomasyu888
committed
update instructions and add in support python versions
1 parent ec55fe7 commit 759ee10

32 files changed

Lines changed: 90 additions & 116 deletions

‎docs/articles/validate_annotations.rst‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,13 @@ Set up Synapse client and JSON Schema service::
2121

2222
Create, manage, and delete a JSON Schema organization::
2323

24-
my_org = js.JsonSchemaOrganization("test.new")
25-
my_org # Output: JsonSchemaOrganization(name='test.new')
24+
my_org_name = <your org name here>
25+
my_org = js.JsonSchemaOrganization(my_org_name)
26+
my_org # Output: JsonSchemaOrganization(name=my_org_name)
2627
my_org.create()
2728
my_org.get_acl()
28-
my_org.set_acl([3413689])
29-
my_org.update_acl([3324230])
29+
my_org.set_acl([syn.getUserProfile().ownerId])
30+
# my_org.update_acl([syn.getUserProfile().ownerId])
3031
my_org.delete()
3132

3233
Retrieve existing organization and associated JSON schemas::
@@ -45,18 +46,17 @@ Manage a specific version of a JSON schema::
4546
version1 = next(versions)
4647
raw_body = version1.body
4748
full_body = version1.expand()
48-
version1 # Output: JsonSchemaVersion(org='sage.annotations', name='analysis.alignmentMethod', version='0.0.2')
49+
version1 # Output: JsonSchemaVersion(org='sage.annotations', name='analysis.alignmentMethod', version='0.0.1')
4950

5051

5152
Create a new JSON schema version for an existing organization::
5253

5354
from random import randint
5455
rint = randint(0, 100000)
55-
org_name = "bgrande.test"
5656
schema_name = "my.schema"
5757

5858
# Method 1
59-
my_org = js.JsonSchemaOrganization(org_name)
59+
my_org = js.JsonSchemaOrganization(my_org_name)
6060
new_version1 = my_org.create_json_schema(raw_body, schema_name, f"0.{rint}.1")
6161

6262
# Method 2

‎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 26, 2023.
250+
<span class="lastupdated">Last updated on Sep 09, 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 26, 2023.
271+
Last updated on Sep 09, 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 26, 2023.
202+
<span class="lastupdated">Last updated on Sep 09, 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 26, 2023.
223+
Last updated on Sep 09, 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 26, 2023.
1647+
<span class="lastupdated">Last updated on Sep 09, 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 26, 2023.
1668+
Last updated on Sep 09, 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 26, 2023.
464+
<span class="lastupdated">Last updated on Sep 09, 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 26, 2023.
485+
Last updated on Sep 09, 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 26, 2023.
280+
<span class="lastupdated">Last updated on Sep 09, 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 26, 2023.
301+
Last updated on Sep 09, 2023.
302302
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.5.0.
303303
</div>
304304
<script type="text/javascript">

‎docs/build/html/api/JsonSchema.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -709,7 +709,7 @@ <h1>JSON Schema<a class="headerlink" href="#json-schema" title="Permalink to thi
709709

710710
<div role="contentinfo">
711711
<p>&#169; Copyright 2012-2023, Sage Bionetworks.
712-
<span class="lastupdated">Last updated on Aug 26, 2023.
712+
<span class="lastupdated">Last updated on Sep 09, 2023.
713713
</span></p>
714714
</div>
715715

@@ -730,7 +730,7 @@ <h1>JSON Schema<a class="headerlink" href="#json-schema" title="Permalink to thi
730730
</script>
731731
<div class="footer">
732732
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
733-
Last updated on Aug 26, 2023.
733+
Last updated on Sep 09, 2023.
734734
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.5.0.
735735
</div>
736736
<script type="text/javascript">

‎docs/build/html/api/Table.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -975,7 +975,7 @@ <h2>Module level methods<a class="headerlink" href="#module-level-methods" title
975975

976976
<div role="contentinfo">
977977
<p>&#169; Copyright 2012-2023, Sage Bionetworks.
978-
<span class="lastupdated">Last updated on Aug 26, 2023.
978+
<span class="lastupdated">Last updated on Sep 09, 2023.
979979
</span></p>
980980
</div>
981981

@@ -996,7 +996,7 @@ <h2>Module level methods<a class="headerlink" href="#module-level-methods" title
996996
</script>
997997
<div class="footer">
998998
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
999-
Last updated on Aug 26, 2023.
999+
Last updated on Sep 09, 2023.
10001000
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.5.0.
10011001
</div>
10021002
<script type="text/javascript">

‎docs/build/html/api/Team.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@
204204

205205
<div role="contentinfo">
206206
<p>&#169; Copyright 2012-2023, Sage Bionetworks.
207-
<span class="lastupdated">Last updated on Aug 26, 2023.
207+
<span class="lastupdated">Last updated on Sep 09, 2023.
208208
</span></p>
209209
</div>
210210

@@ -225,7 +225,7 @@
225225
</script>
226226
<div class="footer">
227227
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
228-
Last updated on Aug 26, 2023.
228+
Last updated on Sep 09, 2023.
229229
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.5.0.
230230
</div>
231231
<script type="text/javascript">

‎docs/build/html/api/Views.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ <h2>Updating Annotations using View<a class="headerlink" href="#updating-annotat
200200

201201
<div role="contentinfo">
202202
<p>&#169; Copyright 2012-2023, Sage Bionetworks.
203-
<span class="lastupdated">Last updated on Aug 26, 2023.
203+
<span class="lastupdated">Last updated on Sep 09, 2023.
204204
</span></p>
205205
</div>
206206

@@ -221,7 +221,7 @@ <h2>Updating Annotations using View<a class="headerlink" href="#updating-annotat
221221
</script>
222222
<div class="footer">
223223
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
224-
Last updated on Aug 26, 2023.
224+
Last updated on Sep 09, 2023.
225225
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.5.0.
226226
</div>
227227
<script type="text/javascript">

0 commit comments

Comments
 (0)