deploy: 6b9191a

main/03_core_testing/api/vitup/mock-farm/v0.yaml

@@ -0,0 +1,113 @@
+openapi: 3.0.2
+
+info:
+  title: Mock farm REST API
+  description: Mock Farm Rest API v0
+  version: 0.0.1
+  contact:
+    url: 'https://github.com/input-output-hk/catalyst-core/tree/main/src/vit-testing/'
+
+servers:
+  - url: 'https://localhost'
+
+tags:
+  - name: active
+  - name: start
+  - name: shutdown
+
+paths:
+  '/api/v0/active':
+    get:
+      description: Lists active mock environments
+      operationId: Active
+      tags:
+        - active
+      responses:
+        '200':
+            description: Success
+            content:
+              application/json:
+                schema:
+                  description: assigned port number
+                  type: string
+                  format: text
+        '400':
+            description: Mock env with given ID or port already exists
+
+  '/api/v0/start/{env_name}':
+    post:
+      description: Starts new mock env with random free port
+      operationId: StartEnvRandomPort
+      tags:
+        - start
+      parameters:
+        - name: env_name
+          in: path
+          required: true
+          schema:
+            description: Environment name
+            type: string
+            pattern: '[0-9a-f]+'
+      responses:
+        '200':
+            description: Success
+            content:
+              application/json:
+                schema:
+                  description: assigned port number
+                  type: string
+                  format: text
+        '400':
+            description: Mock env with given ID or port already exists
+
+  '/api/v0/start/{env_name}/{port}':
+    post:
+      description: Starts new mock env with random free port
+      operationId: StartEnv
+      tags:
+        - start
+      parameters:
+        - name: env_name
+          in: path
+          required: true
+          schema:
+            description: Environment name
+            type: string
+            pattern: '[0-9a-f]+'
+      responses:
+        '200':
+            description: Success
+            content:
+              application/json:
+                schema:
+                  description: assigned port number
+                  type: string
+                  format: text
+        '400':
+          description: Mock env with given ID or port already exists
+
+  '/api/v0/shutdown/{env_name}':
+    post:
+      description: Shutdown new mock env with random free port
+      operationId: ShutdownEnv
+      tags:
+        - shutdown
+      parameters:
+        - name: env_name
+          in: path
+          required: true
+          schema:
+            description: Environment name
+            type: string
+            pattern: '[0-9a-f]+'
+    responses:
+      '200':
+        description: Success
+        content:
+          application/json:
+            schema:
+              description: assigned port number
+              type: string
+              format: text
+      '404':
+        description: Mock env with given ID was not found

main/03_core_testing/vitup/mock.html

@@ -163,10 +163,8 @@ <h2 id="configuration"><a class="header" href="#configuration">Configuration</a>
 <h2 id="start"><a class="header" href="#start">Start</a></h2>
 <p><code>vitup start mock --config example\mock\config.yaml</code></p>
 <h3 id="admin-rest-commands"><a class="header" href="#admin-rest-commands">Admin rest commands</a></h3>
-<p>For full api specs please visit:</p>
-<ul>
-<li><a href="../../api/vit-testing-mock-v0.html">Mock REST API V0</a></li>
-</ul>
+<p>For postman collection please visit:</p>
+<p><a href="../api/vitup/mock/mock_postman_collection.json">Requests collection</a></p>
 <h4 id="list-files"><a class="header" href="#list-files">List Files</a></h4>
 <pre><code class="language-sh">curl --location --request GET 'http://{mock_address}/api/control/files/list'
 </code></pre>

main/03_core_testing/vitup/mock_farm.html

@@ -173,7 +173,7 @@ <h2 id="start"><a class="header" href="#start">Start</a></h2>
 <h2 id="documentation"><a class="header" href="#documentation">Documentation</a></h2>
 <ul>
 <li><a href="../api/vitup/mock-farm/v0.yaml">OpenApi</a></li>
-<li><a href="../api/vitup/mock-farm/postman_collection.json">Requests collection</a></li>
+<li><a href="../api/vitup/mock-farm/mock_farm_postman_collection.json">Requests collection</a></li>
 </ul>
 <footer id="open-on-gh">Found a bug? <a href="https://github.com/input-output-hk/catalyst-core/edit/main/book/src/03_core_testing/vitup/mock_farm.md">Edit this page on GitHub.</a></footer>
                     </main>

main/06_rust_api/rust/hersir/builder/vote/fn.generate_vote_plans.html

@@ -1 +1 @@
-<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `generate_vote_plans` fn in crate `hersir`."><meta name="keywords" content="rust, rustlang, rust-lang, generate_vote_plans"><title>generate_vote_plans in hersir::builder::vote - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../../hersir/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../hersir/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In hersir::builder::vote</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../../hersir/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../../index.html">hersir</a>::<wbr><a href="../index.html">builder</a>::<wbr><a href="index.html">vote</a>::<wbr><a class="fn" href="#">generate_vote_plans</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../../src/hersir/builder/vote.rs.html#21-96">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn generate_vote_plans(<br>&nbsp;&nbsp;&nbsp;&nbsp;wallets: &amp;[<a class="struct" href="../struct.Wallet.html" title="struct hersir::builder::Wallet">Wallet</a>],<br>&nbsp;&nbsp;&nbsp;&nbsp;vote_plans: &amp;[<a class="struct" href="../../config/struct.VotePlanTemplate.html" title="struct hersir::config::VotePlanTemplate">VotePlanTemplate</a>],<br>&nbsp;&nbsp;&nbsp;&nbsp;keys: &amp;mut CommitteeDataManager<br>) -&gt; (<a class="struct" href="https://doc.rust-lang.org/1.65.0/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a>&lt;<a class="struct" href="struct.VotePlanKey.html" title="struct hersir::builder::vote::VotePlanKey">VotePlanKey</a>, <a class="enum" href="../settings/vote_plan/enum.VotePlanSettings.html" title="enum hersir::builder::settings::vote_plan::VotePlanSettings">VotePlanSettings</a>&gt;, <a class="struct" href="https://doc.rust-lang.org/1.65.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="enum" href="../../../chain_impl_mockchain/fragment/enum.Fragment.html" title="enum chain_impl_mockchain::fragment::Fragment">Fragment</a>&gt;)</code></pre></div></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="hersir" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0 (897e37553 2022-11-02)" ></div></body></html>
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `generate_vote_plans` fn in crate `hersir`."><meta name="keywords" content="rust, rustlang, rust-lang, generate_vote_plans"><title>generate_vote_plans in hersir::builder::vote - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../../hersir/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../hersir/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In hersir::builder::vote</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../../hersir/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../../index.html">hersir</a>::<wbr><a href="../index.html">builder</a>::<wbr><a href="index.html">vote</a>::<wbr><a class="fn" href="#">generate_vote_plans</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../../src/hersir/builder/vote.rs.html#21-96">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn generate_vote_plans(<br>&nbsp;&nbsp;&nbsp;&nbsp;wallets: &amp;[<a class="struct" href="../struct.Wallet.html" title="struct hersir::builder::Wallet">Wallet</a>],<br>&nbsp;&nbsp;&nbsp;&nbsp;vote_plans: &amp;[<a class="struct" href="../../config/struct.VotePlanTemplate.html" title="struct hersir::config::VotePlanTemplate">VotePlanTemplate</a>],<br>&nbsp;&nbsp;&nbsp;&nbsp;keys: &amp;mut <a class="struct" href="../../../thor/wallet/committee/struct.CommitteeDataManager.html" title="struct thor::wallet::committee::CommitteeDataManager">CommitteeDataManager</a><br>) -&gt; (<a class="struct" href="https://doc.rust-lang.org/1.65.0/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a>&lt;<a class="struct" href="struct.VotePlanKey.html" title="struct hersir::builder::vote::VotePlanKey">VotePlanKey</a>, <a class="enum" href="../settings/vote_plan/enum.VotePlanSettings.html" title="enum hersir::builder::settings::vote_plan::VotePlanSettings">VotePlanSettings</a>&gt;, <a class="struct" href="https://doc.rust-lang.org/1.65.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="enum" href="../../../chain_impl_mockchain/fragment/enum.Fragment.html" title="enum chain_impl_mockchain::fragment::Fragment">Fragment</a>&gt;)</code></pre></div></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="hersir" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0 (897e37553 2022-11-02)" ></div></body></html>