./doc/SDM/Nodes.html in strongdm-1.0.27 vs ./doc/SDM/Nodes.html in strongdm-1.0.28
- old
+ new
@@ -9,19 +9,20 @@
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
-<script src="../js/jquery.js"></script>
-<script src="../js/darkfish.js"></script>
+<script src="../js/navigation.js" defer></script>
+<script src="../js/search.js" defer></script>
+<script src="../js/search_index.js" defer></script>
+<script src="../js/searcher.js" defer></script>
+<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
-
-
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
@@ -54,38 +55,31 @@
<div id="class-metadata">
- <div id="parent-class-section" class="nav-section">
+
+<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
-
<p class="link"><a href="../Object.html">Object</a>
-
</div>
- <!-- Method Quickref -->
+
+<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
-
<li ><a href="#method-c-new">::new</a>
-
<li ><a href="#method-i-create">#create</a>
-
<li ><a href="#method-i-delete">#delete</a>
-
<li ><a href="#method-i-get">#get</a>
-
<li ><a href="#method-i-list">#list</a>
-
<li ><a href="#method-i-update">#update</a>
-
</ul>
</div>
</div>
</nav>
@@ -97,52 +91,38 @@
<section class="description">
<p><a href="Nodes.html"><code>Nodes</code></a> make up the strongDM network, and allow your users to connect securely to your resources. There are two types of nodes:</p>
<ul><li>
-<p>*<strong>Gateways</strong>* are the entry points into network. They listen for connection from the strongDM client, and provide access to databases and servers.</p>
+<p><strong>Gateways</strong> are the entry points into network. They listen for connection from the strongDM client, and provide access to databases and servers.</p>
</li><li>
-<p>*<strong>Relays</strong>* are used to extend the strongDM network into segmented subnets. They provide access to databases and servers but do not listen for incoming connections.</p>
+<p><strong>Relays</strong> are used to extend the strongDM network into segmented subnets. They provide access to databases and servers but do not listen for incoming connections.</p>
</li></ul>
</section>
-
<section id="5Buntitled-5D" class="documentation-section">
-
-
-
-
-
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
-
<div id="method-c-new" class="method-detail ">
-
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(host, insecure, parent)</span>
-
<span class="method-click-advice">click to toggle source</span>
-
</div>
-
<div class="method-description">
-
-
-
-
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/svc.rb, line 575</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">host</span>, <span class="ruby-identifier">insecure</span>, <span class="ruby-identifier">parent</span>)
<span class="ruby-keyword">begin</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">insecure</span>
@@ -155,45 +135,32 @@
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">convert_error_to_porcelain</span>(<span class="ruby-identifier">exception</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@parent</span> = <span class="ruby-identifier">parent</span>
<span class="ruby-keyword">end</span></pre>
</div>
-
</div>
-
-
</div>
-
</section>
-
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
-
<div id="method-i-create" class="method-detail ">
-
<div class="method-heading">
<span class="method-name">create</span><span
class="method-args">( node \ , deadline:nil)</span>
-
<span class="method-click-advice">click to toggle source</span>
-
</div>
-
<div class="method-description">
-
<p>Create registers a new Node.</p>
-
-
-
<div class="method-source-code" id="create-source">
<pre><span class="ruby-comment"># File lib/svc.rb, line 589</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create</span>(
<span class="ruby-identifier">node</span> \
,
@@ -224,37 +191,25 @@
<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">token</span> = (<span class="ruby-identifier">plumbing_response</span>.<span class="ruby-identifier">token</span>)
<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">rate_limit</span> = <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">convert_rate_limit_metadata_to_porcelain</span>(<span class="ruby-identifier">plumbing_response</span>.<span class="ruby-identifier">rate_limit</span>)
<span class="ruby-identifier">resp</span>
<span class="ruby-keyword">end</span></pre>
</div>
-
</div>
-
-
</div>
-
<div id="method-i-delete" class="method-detail ">
-
<div class="method-heading">
<span class="method-name">delete</span><span
class="method-args">( id \ , deadline:nil)</span>
-
<span class="method-click-advice">click to toggle source</span>
-
</div>
-
<div class="method-description">
-
<p>Delete removes a Node by ID.</p>
-
-
-
<div class="method-source-code" id="delete-source">
<pre><span class="ruby-comment"># File lib/svc.rb, line 683</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">delete</span>(
<span class="ruby-identifier">id</span> \
,
@@ -283,37 +238,25 @@
<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">meta</span> = <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">convert_delete_response_metadata_to_porcelain</span>(<span class="ruby-identifier">plumbing_response</span>.<span class="ruby-identifier">meta</span>)
<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">rate_limit</span> = <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">convert_rate_limit_metadata_to_porcelain</span>(<span class="ruby-identifier">plumbing_response</span>.<span class="ruby-identifier">rate_limit</span>)
<span class="ruby-identifier">resp</span>
<span class="ruby-keyword">end</span></pre>
</div>
-
</div>
-
-
</div>
-
<div id="method-i-get" class="method-detail ">
-
<div class="method-heading">
<span class="method-name">get</span><span
class="method-args">( id \ , deadline:nil)</span>
-
<span class="method-click-advice">click to toggle source</span>
-
</div>
-
<div class="method-description">
-
<p>Get reads one Node by ID.</p>
-
-
-
<div class="method-source-code" id="get-source">
<pre><span class="ruby-comment"># File lib/svc.rb, line 621</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get</span>(
<span class="ruby-identifier">id</span> \
,
@@ -343,37 +286,25 @@
<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">node</span> = <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">convert_node_to_porcelain</span>(<span class="ruby-identifier">plumbing_response</span>.<span class="ruby-identifier">node</span>)
<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">rate_limit</span> = <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">convert_rate_limit_metadata_to_porcelain</span>(<span class="ruby-identifier">plumbing_response</span>.<span class="ruby-identifier">rate_limit</span>)
<span class="ruby-identifier">resp</span>
<span class="ruby-keyword">end</span></pre>
</div>
-
</div>
-
-
</div>
-
<div id="method-i-list" class="method-detail ">
-
<div class="method-heading">
<span class="method-name">list</span><span
class="method-args">( filter \ , *args, deadline:nil)</span>
-
<span class="method-click-advice">click to toggle source</span>
-
</div>
-
<div class="method-description">
-
<p>List gets a list of <a href="Nodes.html"><code>Nodes</code></a> matching a given set of criteria.</p>
-
-
-
<div class="method-source-code" id="list-source">
<pre><span class="ruby-comment"># File lib/svc.rb, line 713</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">list</span>(
<span class="ruby-identifier">filter</span> \
,
@@ -409,37 +340,25 @@
<span class="ruby-keyword">end</span>
}
<span class="ruby-identifier">resp</span>
<span class="ruby-keyword">end</span></pre>
</div>
-
</div>
-
-
</div>
-
<div id="method-i-update" class="method-detail ">
-
<div class="method-heading">
<span class="method-name">update</span><span
class="method-args">( node \ , deadline:nil)</span>
-
<span class="method-click-advice">click to toggle source</span>
-
</div>
-
<div class="method-description">
-
<p>Update patches a Node by ID.</p>
-
-
-
<div class="method-source-code" id="update-source">
<pre><span class="ruby-comment"># File lib/svc.rb, line 652</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update</span>(
<span class="ruby-identifier">node</span> \
,
@@ -469,27 +388,22 @@
<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">node</span> = <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">convert_node_to_porcelain</span>(<span class="ruby-identifier">plumbing_response</span>.<span class="ruby-identifier">node</span>)
<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">rate_limit</span> = <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">convert_rate_limit_metadata_to_porcelain</span>(<span class="ruby-identifier">plumbing_response</span>.<span class="ruby-identifier">rate_limit</span>)
<span class="ruby-identifier">resp</span>
<span class="ruby-keyword">end</span></pre>
</div>
-
</div>
-
-
</div>
-
</section>
-
- </section>
+ </section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.0.
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>