Skip to content

Commit

Permalink
Update unreleased documentation (#550)
Browse files Browse the repository at this point in the history 
* Update versions.json

* Deployed 0582498 to unreleased in versions with MkDocs 1.5.3 and mike 2.0.0

* Sort docs versions

---------

Co-authored-by: GitHub Actions Bot <[email protected]>
  • Loading branch information
@github-actions
github-actions[bot] and GitHub Actions Bot authored Jan 8, 2024
1 parent 35de00b commit 5756853
Show file tree
Hide file tree
Showing 12 changed files with 1,506 additions and 859 deletions.
588 changes: 321 additions & 267 deletions versions/unreleased/api-ref/prefect/client/orchestration/index.html
View file

Large diffs are not rendered by default.

435 changes: 309 additions & 126 deletions versions/unreleased/api-ref/prefect/client/schemas/index.html
View file

Large diffs are not rendered by default.

64 changes: 33 additions & 31 deletions versions/unreleased/api-ref/prefect/context/index.html
View file

Large diffs are not rendered by default.

134 changes: 71 additions & 63 deletions versions/unreleased/api-ref/prefect/input/actions/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8780,34 +8780,39 @@ <h2 id="prefect.input.actions.create_flow_run_input" class="doc doc-heading">

<details class="quote">
<summary>Source code in <code>prefect/input/actions.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">26</span>
<span class="normal">27</span>
<span class="normal">28</span>
<span class="normal">29</span>
<span class="normal">30</span>
<span class="normal">31</span>
<span class="normal">32</span>
<span class="normal">33</span>
<span class="normal">34</span>
<span class="normal">35</span>
<span class="normal">36</span>
<span class="normal">37</span>
<span class="normal">38</span>
<span class="normal">39</span>
<span class="normal">40</span>
<span class="normal">41</span>
<span class="normal">42</span>
<span class="normal">43</span>
<span class="normal">44</span>
<span class="normal">45</span>
<span class="normal">46</span>
<span class="normal">47</span>
<span class="normal">48</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@sync_compatible</span>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">54</span>
<span class="normal">55</span>
<span class="normal">56</span>
<span class="normal">57</span>
<span class="normal">58</span>
<span class="normal">59</span>
<span class="normal">60</span>
<span class="normal">61</span>
<span class="normal">62</span>
<span class="normal">63</span>
<span class="normal">64</span>
<span class="normal">65</span>
<span class="normal">66</span>
<span class="normal">67</span>
<span class="normal">68</span>
<span class="normal">69</span>
<span class="normal">70</span>
<span class="normal">71</span>
<span class="normal">72</span>
<span class="normal">73</span>
<span class="normal">74</span>
<span class="normal">75</span>
<span class="normal">76</span>
<span class="normal">77</span>
<span class="normal">78</span>
<span class="normal">79</span>
<span class="normal">80</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@sync_compatible</span>
<span class="nd">@inject_client</span>
<span class="k">async</span> <span class="k">def</span> <span class="nf">create_flow_run_input</span><span class="p">(</span>
<span class="n">key</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="n">value</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span>
<span class="n">flow_run_id</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">UUID</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">sender</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="s2">&quot;PrefectClient&quot;</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
Expand All @@ -8820,10 +8825,13 @@ <h2 id="prefect.input.actions.create_flow_run_input" class="doc doc-heading">
<span class="sd"> - flow_run_id (UUID): the, optional, flow run ID. If not given will</span>
<span class="sd"> default to pulling the flow run ID from the current context.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">flow_run_id</span> <span class="o">=</span> <span class="n">_ensure_flow_run_id</span><span class="p">(</span><span class="n">flow_run_id</span><span class="p">)</span>
<span class="n">flow_run_id</span> <span class="o">=</span> <span class="n">ensure_flow_run_id</span><span class="p">(</span><span class="n">flow_run_id</span><span class="p">)</span>

<span class="k">await</span> <span class="n">client</span><span class="o">.</span><span class="n">create_flow_run_input</span><span class="p">(</span>
<span class="n">flow_run_id</span><span class="o">=</span><span class="n">flow_run_id</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="n">orjson</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">value</span><span class="p">)</span><span class="o">.</span><span class="n">decode</span><span class="p">()</span>
<span class="n">flow_run_id</span><span class="o">=</span><span class="n">flow_run_id</span><span class="p">,</span>
<span class="n">key</span><span class="o">=</span><span class="n">key</span><span class="p">,</span>
<span class="n">sender</span><span class="o">=</span><span class="n">sender</span><span class="p">,</span>
<span class="n">value</span><span class="o">=</span><span class="n">orjson</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">value</span><span class="p">)</span><span class="o">.</span><span class="n">decode</span><span class="p">(),</span>
<span class="p">)</span>
</code></pre></div></td></tr></table></div>
</details>
Expand Down Expand Up @@ -8897,21 +8905,21 @@ <h2 id="prefect.input.actions.delete_flow_run_input" class="doc doc-heading">

<details class="quote">
<summary>Source code in <code>prefect/input/actions.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">74</span>
<span class="normal">75</span>
<span class="normal">76</span>
<span class="normal">77</span>
<span class="normal">78</span>
<span class="normal">79</span>
<span class="normal">80</span>
<span class="normal">81</span>
<span class="normal">82</span>
<span class="normal">83</span>
<span class="normal">84</span>
<span class="normal">85</span>
<span class="normal">86</span>
<span class="normal">87</span>
<span class="normal">88</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@sync_compatible</span>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">128</span>
<span class="normal">129</span>
<span class="normal">130</span>
<span class="normal">131</span>
<span class="normal">132</span>
<span class="normal">133</span>
<span class="normal">134</span>
<span class="normal">135</span>
<span class="normal">136</span>
<span class="normal">137</span>
<span class="normal">138</span>
<span class="normal">139</span>
<span class="normal">140</span>
<span class="normal">141</span>
<span class="normal">142</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@sync_compatible</span>
<span class="nd">@inject_client</span>
<span class="k">async</span> <span class="k">def</span> <span class="nf">delete_flow_run_input</span><span class="p">(</span>
<span class="n">key</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">flow_run_id</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">UUID</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">client</span><span class="p">:</span> <span class="s2">&quot;PrefectClient&quot;</span> <span class="o">=</span> <span class="kc">None</span>
Expand All @@ -8923,7 +8931,7 @@ <h2 id="prefect.input.actions.delete_flow_run_input" class="doc doc-heading">
<span class="sd"> - key (str): the flow run input key</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="n">flow_run_id</span> <span class="o">=</span> <span class="n">_ensure_flow_run_id</span><span class="p">(</span><span class="n">flow_run_id</span><span class="p">)</span>
<span class="n">flow_run_id</span> <span class="o">=</span> <span class="n">ensure_flow_run_id</span><span class="p">(</span><span class="n">flow_run_id</span><span class="p">)</span>

<span class="k">await</span> <span class="n">client</span><span class="o">.</span><span class="n">delete_flow_run_input</span><span class="p">(</span><span class="n">flow_run_id</span><span class="o">=</span><span class="n">flow_run_id</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="n">key</span><span class="p">)</span>
</code></pre></div></td></tr></table></div>
Expand Down Expand Up @@ -8998,27 +9006,27 @@ <h2 id="prefect.input.actions.read_flow_run_input" class="doc doc-heading">

<details class="quote">
<summary>Source code in <code>prefect/input/actions.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">51</span>
<span class="normal">52</span>
<span class="normal">53</span>
<span class="normal">54</span>
<span class="normal">55</span>
<span class="normal">56</span>
<span class="normal">57</span>
<span class="normal">58</span>
<span class="normal">59</span>
<span class="normal">60</span>
<span class="normal">61</span>
<span class="normal">62</span>
<span class="normal">63</span>
<span class="normal">64</span>
<span class="normal">65</span>
<span class="normal">66</span>
<span class="normal">67</span>
<span class="normal">68</span>
<span class="normal">69</span>
<span class="normal">70</span>
<span class="normal">71</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@sync_compatible</span>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">105</span>
<span class="normal">106</span>
<span class="normal">107</span>
<span class="normal">108</span>
<span class="normal">109</span>
<span class="normal">110</span>
<span class="normal">111</span>
<span class="normal">112</span>
<span class="normal">113</span>
<span class="normal">114</span>
<span class="normal">115</span>
<span class="normal">116</span>
<span class="normal">117</span>
<span class="normal">118</span>
<span class="normal">119</span>
<span class="normal">120</span>
<span class="normal">121</span>
<span class="normal">122</span>
<span class="normal">123</span>
<span class="normal">124</span>
<span class="normal">125</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@sync_compatible</span>
<span class="nd">@inject_client</span>
<span class="k">async</span> <span class="k">def</span> <span class="nf">read_flow_run_input</span><span class="p">(</span>
<span class="n">key</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">flow_run_id</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">UUID</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">client</span><span class="p">:</span> <span class="s2">&quot;PrefectClient&quot;</span> <span class="o">=</span> <span class="kc">None</span>
Expand All @@ -9029,7 +9037,7 @@ <h2 id="prefect.input.actions.read_flow_run_input" class="doc doc-heading">
<span class="sd"> - key (str): the flow run input key</span>
<span class="sd"> - flow_run_id (UUID): the flow run ID</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">flow_run_id</span> <span class="o">=</span> <span class="n">_ensure_flow_run_id</span><span class="p">(</span><span class="n">flow_run_id</span><span class="p">)</span>
<span class="n">flow_run_id</span> <span class="o">=</span> <span class="n">ensure_flow_run_id</span><span class="p">(</span><span class="n">flow_run_id</span><span class="p">)</span>

<span class="k">try</span><span class="p">:</span>
<span class="n">value</span> <span class="o">=</span> <span class="k">await</span> <span class="n">client</span><span class="o">.</span><span class="n">read_flow_run_input</span><span class="p">(</span><span class="n">flow_run_id</span><span class="o">=</span><span class="n">flow_run_id</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="n">key</span><span class="p">)</span>
Expand Down
Loading

0 comments on commit 5756853

Please sign in to comment.