Deployed 74d12db to main with MkDocs 1.5.3 and mike 2.0.0

main/features/Multiledger/index.html

@@ -2414,25 +2414,25 @@ <h2 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">&
 <h3 id="example-config-file">Example config file<a class="headerlink" href="#example-config-file" title="Permanent link">&para;</a></h3>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">localVON</span>
 <a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w">  </span><span class="nt">is_production</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
-<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w">  </span><span class="nt">genesis_url</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;http://host.docker.internal:9000/genesis&#39;</span>
+<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w">  </span><span class="nt">genesis_url</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;http://host.docker.internal:9000/genesis&quot;</span>
 <a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bcovrinTest</span>
 <a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="w">  </span><span class="nt">is_production</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
 <a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="w">  </span><span class="nt">is_write</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
-<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="w">  </span><span class="nt">genesis_url</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;http://test.bcovrin.vonx.io/genesis&#39;</span>
+<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="w">  </span><span class="nt">genesis_url</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;http://test.bcovrin.vonx.io/genesis&quot;</span>
 </code></pre></div>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">localVON</span>
 <a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="w">  </span><span class="nt">is_production</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
-<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="w">  </span><span class="nt">genesis_url</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;http://host.docker.internal:9000/genesis&#39;</span>
+<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="w">  </span><span class="nt">genesis_url</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;http://host.docker.internal:9000/genesis&quot;</span>
 <a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bcovrinTest</span>
 <a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="w">  </span><span class="nt">is_production</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
 <a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="w">  </span><span class="nt">is_write</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
-<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="w">  </span><span class="nt">genesis_url</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;http://test.bcovrin.vonx.io/genesis&#39;</span>
-<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="w">  </span><span class="nt">endorser_did</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;9QPa6tHvBHttLg6U4xvviv&#39;</span>
-<a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a><span class="w">  </span><span class="nt">endorser_alias</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;endorser_test&#39;</span>
+<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="w">  </span><span class="nt">genesis_url</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;http://test.bcovrin.vonx.io/genesis&quot;</span>
+<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="w">  </span><span class="nt">endorser_did</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;9QPa6tHvBHttLg6U4xvviv&quot;</span>
+<a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a><span class="w">  </span><span class="nt">endorser_alias</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;endorser_test&quot;</span>
 <a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">greenlightDev</span>
 <a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a><span class="w">  </span><span class="nt">is_production</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
 <a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a><span class="w">  </span><span class="nt">is_write</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
-<a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a><span class="w">  </span><span class="nt">genesis_url</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;http://test.bcovrin.vonx.io/genesis&#39;</span>
+<a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a><span class="w">  </span><span class="nt">genesis_url</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;http://test.bcovrin.vonx.io/genesis&quot;</span>
 </code></pre></div>
 <p>Note: <code>is_write</code> property means that the ledger is write configurable. With reference to the above config example, both <code>bcovrinTest</code> and (the no longer available -- in the above its pointing to BCovrin Test as well) <code>greenlightDev</code> ledgers are write configurable. By default, on startup <code>bcovrinTest</code> will be the write ledger as it is the topmost write configurable production ledger, <a href="#write-requests">more details</a> regarding the selection rule. Using <code>PUT /ledger/{ledger_id}/set-write-ledger</code> endpoint, either <code>greenlightDev</code> and <code>bcovrinTest</code> can be set as the write ledger.</p>
 <blockquote>
@@ -2442,13 +2442,13 @@ <h3 id="example-config-file">Example config file<a class="headerlink" href="#exa
 <div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">localVON</span>
 <a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="w">  </span><span class="nt">is_production</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
 <a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="w">  </span><span class="nt">is_write</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
-<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a><span class="w">  </span><span class="nt">genesis_url</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;http://host.docker.internal:9000/genesis&#39;</span>
+<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a><span class="w">  </span><span class="nt">genesis_url</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;http://host.docker.internal:9000/genesis&quot;</span>
 <a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bcovrinTest</span>
 <a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a><span class="w">  </span><span class="nt">is_production</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
-<a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a><span class="w">  </span><span class="nt">genesis_url</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;http://test.bcovrin.vonx.io/genesis&#39;</span>
+<a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a><span class="w">  </span><span class="nt">genesis_url</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;http://test.bcovrin.vonx.io/genesis&quot;</span>
 <a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">greenlightDev</span>
 <a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a><span class="w">  </span><span class="nt">is_production</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
-<a id="__codelineno-2-10" name="__codelineno-2-10" href="#__codelineno-2-10"></a><span class="w">  </span><span class="nt">genesis_url</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;http://test.bcovrin.vonx.io/genesis&#39;</span>
+<a id="__codelineno-2-10" name="__codelineno-2-10" href="#__codelineno-2-10"></a><span class="w">  </span><span class="nt">genesis_url</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;http://test.bcovrin.vonx.io/genesis&quot;</span>
 </code></pre></div>
 <p>Note: For instance with regards to example config above, <code>localVON</code> will be the write ledger, as there are no production ledgers which are configurable it will choose the topmost write configurable non production ledger.</p>
 <h3 id="config-properties">Config properties<a class="headerlink" href="#config-properties" title="Permanent link">&para;</a></h3>
@@ -2462,13 +2462,13 @@ <h3 id="config-properties">Config properties<a class="headerlink" href="#config-
 <li><code>genesis_file</code>: The path to the genesis file to use for connecting to an Indy ledger.</li>
 <li><code>genesis_transactions</code>: String of genesis transactions to use for connecting to an Indy ledger.</li>
 <li><code>genesis_url</code>: The url from which to download the genesis transactions to use for connecting to an Indy ledger.</li>
+<li><code>is_write</code>: Whether this ledger is writable. At least one write ledger must be specified, unless running in read-only mode. Multiple write ledgers can be specified in config.</li>
 </ul>
 <p>Optional properties:</p>
 <ul>
 <li><code>pool_name</code>: name of the indy pool to be opened</li>
 <li><code>keepalive</code>: how many seconds to keep the ledger open</li>
 <li><code>socks_proxy</code></li>
-<li><code>is_write</code>: Whether this ledger is writable. It requires at least one write ledger specified. Multiple write ledgers can be specified in config.</li>
 <li><code>endorser_did</code>: Endorser public DID registered on the ledger, needed for supporting Endorser protocol at multi-ledger level.</li>
 <li><code>endorser_alias</code>: Endorser alias for this ledger, needed for supporting Endorser protocol at multi-ledger level.</li>
 </ul>
@@ -2477,13 +2477,13 @@ <h2 id="multi-ledger-admin-api">Multi-ledger Admin API<a class="headerlink" href
 <p>Multi-ledger related actions are grouped under the <code>ledger</code> topic in the SwaggerUI.</p>
 <ul>
 <li>GET <code>/ledger/config</code>:
-Returns the multiple ledger configuration currently in use</li>
+  Returns the multiple ledger configuration currently in use</li>
 <li>GET <code>/ledger/get-write-ledger</code>:
-Returns the current active/set <code>write_ledger's</code> <code>ledger_id</code></li>
+  Returns the current active/set <code>write_ledger's</code> <code>ledger_id</code></li>
 <li>GET <code>/ledger/get-write-ledgers</code>:
-Returns list of available <code>write_ledger's</code> <code>ledger_id</code></li>
+  Returns list of available <code>write_ledger's</code> <code>ledger_id</code></li>
 <li>PUT <code>/ledger/{ledger_id}/set-write-ledger</code>:
-Set active <code>write_ledger's</code> <code>ledger_id</code></li>
+  Set active <code>write_ledger's</code> <code>ledger_id</code></li>
 </ul>
 <h2 id="ledger-selection">Ledger Selection<a class="headerlink" href="#ledger-selection" title="Permanent link">&para;</a></h2>
 <h3 id="read-requests">Read Requests<a class="headerlink" href="#read-requests" title="Permanent link">&para;</a></h3>