Skip to content

Commit

Permalink
DG-28544 | update spec docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@Raksha-Bharuka
Raksha-Bharuka committed Apr 25, 2024
1 parent 099f1a3 commit 337c232
Show file tree
Hide file tree
Showing 45 changed files with 458 additions and 345 deletions.
4 changes: 2 additions & 2 deletions .yardoc/checksums
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ lib/sfrest/cron.rb b79eca6a734af70d17053ca85518e9f62737434f
lib/sfrest/info.rb ba9d80b54d182490ea894dc832d338705ccadf3e
lib/sfrest/role.rb 14f829291f7c0b54b35acab383e01535f25e763a
lib/sfrest/site.rb d101ddf331e15e941506fda4d7ad2248ae8eca31
lib/sfrest/task.rb 1185c121635cf0849cb9185dcfb366930a8ea971
lib/sfrest/task.rb f404ebbdcc21815653802d8b0c7ecbdba86ce6d4
lib/sfrest/user.rb c00d77c9be76b447b3c5410624d106f638840721
lib/sfrest/audit.rb 83b4ed11bb31fb500d59f98b573afd1be7686887
lib/sfrest/error.rb 11e22e8c019e8ed00d3f8830db3f8c1b304d37ca
Expand All @@ -15,7 +15,7 @@ lib/sfrest/backup.rb b938242b1442f8e4e9e112aa2b00e7706e2eb756
lib/sfrest/update.rb 2dc95ca50ab0d7017ac1296b80d1c417a5e9d834
lib/sfrest/domains.rb 2774e0f43de5ef3af79f108a9aea78e9b6e0e9c3
lib/sfrest/profile.rb e506ccffecf7a8cf34e420924243250de38d8e6b
lib/sfrest/version.rb d1c11762d749c5f1103e2d2d55a033525efc95e7
lib/sfrest/version.rb fbb3930e93ff0af2ec9c7805d033d81de4b1c3c2
lib/sfrest/codebase.rb 86aec3743bd186f1a5bce5e8db27a57444fc1668
lib/sfrest/variable.rb 29d5899e356488e2f58df6841b80b67cc6b43d06
lib/sfrest/collection.rb 60a123604d676b82cc1b2a97d9288637a0e3f3d1
Expand Down
Binary file modified .yardoc/object_types
View file
Binary file not shown.
Binary file modified .yardoc/objects/root.dat
View file
Binary file not shown.
6 changes: 3 additions & 3 deletions doc/SFRest.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ <h2>

</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.0.45</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.0.46</span><span class='tstring_end'>&#39;</span></span></pre></dd>

</dl>

Expand Down Expand Up @@ -742,9 +742,9 @@ <h3 class="signature " id="new-class_method">
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:14 2023 by
Generated on Thu Apr 25 14:58:26 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/AccessDeniedError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,9 +133,9 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:15 2023 by
Generated on Thu Apr 25 14:58:26 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/ActionForbiddenError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,9 +133,9 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:15 2023 by
Generated on Thu Apr 25 14:58:26 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/Audit.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -305,9 +305,9 @@ <h3 class="signature first" id="list_audit_events-instance_method">
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:15 2023 by
Generated on Thu Apr 25 14:58:26 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/Backup.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -873,9 +873,9 @@ <h3 class="signature " id="get_backups-instance_method">
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:15 2023 by
Generated on Thu Apr 25 14:58:27 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/BadRequestError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,9 +133,9 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:15 2023 by
Generated on Thu Apr 25 14:58:26 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/Centralized_role_management.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -538,9 +538,9 @@ <h3 class="signature " id="enable_role_mapping-instance_method">
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:16 2023 by
Generated on Thu Apr 25 14:58:27 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/Codebase.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -532,9 +532,9 @@ <h3 class="signature " id="stacks_with_details-instance_method">
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:16 2023 by
Generated on Thu Apr 25 14:58:27 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/Collection.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1447,9 +1447,9 @@ <h3 class="signature " id="set_primary_site-instance_method">
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:16 2023 by
Generated on Thu Apr 25 14:58:27 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/Connection.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1598,9 +1598,9 @@ <h3 class="signature " id="service_response-instance_method">
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:16 2023 by
Generated on Thu Apr 25 14:58:27 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/Cron.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -919,9 +919,9 @@ <h3 class="signature " id="get_cron_jobs-instance_method">
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:14 2023 by
Generated on Thu Apr 25 14:58:26 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/Domains.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -999,9 +999,9 @@ <h3 class="signature " id="status-instance_method">
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:16 2023 by
Generated on Thu Apr 25 14:58:27 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/Factory_standard_domain.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -621,9 +621,9 @@ <h3 class="signature " id="factory_standard_domain_mapping-instance_method">
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:16 2023 by
Generated on Thu Apr 25 14:58:27 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/Group.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1933,9 +1933,9 @@ <h3 class="signature " id="sites-instance_method">
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:15 2023 by
Generated on Thu Apr 25 14:58:27 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/Info.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -305,9 +305,9 @@ <h3 class="signature first" id="sfinfo-instance_method">
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:14 2023 by
Generated on Thu Apr 25 14:58:26 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/InvalidApiVersion.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,9 +133,9 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:15 2023 by
Generated on Thu Apr 25 14:58:26 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/InvalidDataError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,9 +133,9 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:15 2023 by
Generated on Thu Apr 25 14:58:26 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/InvalidResponse.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,9 +133,9 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:15 2023 by
Generated on Thu Apr 25 14:58:26 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/Pathbuilder.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -250,9 +250,9 @@ <h3 class="signature first" id="build_url_query-instance_method">
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:16 2023 by
Generated on Thu Apr 25 14:58:27 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/Profile.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -692,9 +692,9 @@ <h3 class="signature " id="set_default-instance_method">
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:16 2023 by
Generated on Thu Apr 25 14:58:27 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/Role.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -981,9 +981,9 @@ <h3 class="signature " id="update_role-instance_method">
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:14 2023 by
Generated on Thu Apr 25 14:58:26 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/SFError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,9 @@ <h2>Direct Known Subclasses</h2>
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:15 2023 by
Generated on Thu Apr 25 14:58:26 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/Security_settings.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -566,9 +566,9 @@ <h3 class="signature " id="reset_security_settings-instance_method">
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:16 2023 by
Generated on Thu Apr 25 14:58:27 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/Site.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1231,9 +1231,9 @@ <h3 class="signature " id="site_list-instance_method">
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:14 2023 by
Generated on Thu Apr 25 14:58:26 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/Site_guard.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -538,9 +538,9 @@ <h3 class="signature " id="enable_site_guard-instance_method">
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:16 2023 by
Generated on Thu Apr 25 14:58:27 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/Site_ownership.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -772,9 +772,9 @@ <h3 class="signature " id="transfer_site_ownership_using_username-instance_metho
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:16 2023 by
Generated on Thu Apr 25 14:58:27 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/Site_update_priority.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -500,9 +500,9 @@ <h3 class="signature " id="reset_update_priority-instance_method">
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:16 2023 by
Generated on Thu Apr 25 14:58:27 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
4 changes: 2 additions & 2 deletions doc/SFRest/Stage.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -883,9 +883,9 @@ <h3 class="signature " id="staging_versions-instance_method">
</div>

<div id="footer">
Generated on Wed Feb 1 14:58:15 2023 by
Generated on Thu Apr 25 14:58:27 2024 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
0.9.25 (ruby-2.7.5).
</div>

</div>
Expand Down
Loading

0 comments on commit 337c232

Please sign in to comment.