Update unreleased documentation (#666)

* Update versions.json * Deployed 3c46b97 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]>
PrefectHQ · Mar 21, 2024 · 7fe62e9 · 7fe62e9
1 parent 7dce7e1
commit 7fe62e9
Show file tree

Hide file tree

Showing 12 changed files with 822 additions and 830 deletions.
diff --git a/versions/unreleased/api-ref/prefect/flows/index.html b/versions/unreleased/api-ref/prefect/flows/index.html
diff --git a/versions/unreleased/api-ref/prefect/settings/index.html b/versions/unreleased/api-ref/prefect/settings/index.html
diff --git a/versions/unreleased/api-ref/prefect/tasks/index.html b/versions/unreleased/api-ref/prefect/tasks/index.html
diff --git a/versions/unreleased/api-ref/schema.json b/versions/unreleased/api-ref/schema.json
diff --git a/versions/unreleased/api-ref/server/api/deployments/index.html b/versions/unreleased/api-ref/server/api/deployments/index.html
diff --git a/versions/unreleased/api-ref/server/api/flow_runs/index.html b/versions/unreleased/api-ref/server/api/flow_runs/index.html
diff --git a/versions/unreleased/api-ref/server/api/middleware/index.html b/versions/unreleased/api-ref/server/api/middleware/index.html
@@ -9032,7 +9032,8 @@ <h2 id="prefect.server.api.middleware.CsrfMiddleware" class="doc doc-heading">
 <span class="normal">69</span>
 <span class="normal">70</span>
 <span class="normal">71</span>
-<span class="normal">72</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">CsrfMiddleware</span><span class="p">(</span><span class="n">BaseHTTPMiddleware</span><span class="p">):</span>
+<span class="normal">72</span>
+<span class="normal">73</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">CsrfMiddleware</span><span class="p">(</span><span class="n">BaseHTTPMiddleware</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Middleware for CSRF protection. This middleware will check for a CSRF token</span>
 <span class="sd">    in the headers of any POST, PUT, PATCH, or DELETE request. If the token is</span>
@@ -9087,6 +9088,7 @@ <h2 id="prefect.server.api.middleware.CsrfMiddleware" class="doc doc-heading">
                     <span class="k">return</span> <span class="n">JSONResponse</span><span class="p">(</span>
                         <span class="p">{</span><span class="s2">&quot;detail&quot;</span><span class="p">:</span> <span class="s2">&quot;Invalid CSRF token or client identifier.&quot;</span><span class="p">},</span>
                         <span class="n">status_code</span><span class="o">=</span><span class="n">status</span><span class="o">.</span><span class="n">HTTP_403_FORBIDDEN</span><span class="p">,</span>
+                        <span class="n">headers</span><span class="o">=</span><span class="p">{</span><span class="s2">&quot;Access-Control-Allow-Origin&quot;</span><span class="p">:</span> <span class="s2">&quot;*&quot;</span><span class="p">},</span>
                     <span class="p">)</span>
 
         <span class="k">return</span> <span class="k">await</span> <span class="n">call_next</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
@@ -9179,7 +9181,8 @@ <h3 id="prefect.server.api.middleware.CsrfMiddleware.dispatch" class="doc doc-he
 <span class="normal">69</span>
 <span class="normal">70</span>
 <span class="normal">71</span>
-<span class="normal">72</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">async</span> <span class="k">def</span> <span class="nf">dispatch</span><span class="p">(</span>
+<span class="normal">72</span>
+<span class="normal">73</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">async</span> <span class="k">def</span> <span class="nf">dispatch</span><span class="p">(</span>
     <span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">:</span> <span class="n">Request</span><span class="p">,</span> <span class="n">call_next</span><span class="p">:</span> <span class="n">NextMiddlewareFunction</span>
 <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
@@ -9226,6 +9229,7 @@ <h3 id="prefect.server.api.middleware.CsrfMiddleware.dispatch" class="doc doc-he
                 <span class="k">return</span> <span class="n">JSONResponse</span><span class="p">(</span>
                     <span class="p">{</span><span class="s2">&quot;detail&quot;</span><span class="p">:</span> <span class="s2">&quot;Invalid CSRF token or client identifier.&quot;</span><span class="p">},</span>
                     <span class="n">status_code</span><span class="o">=</span><span class="n">status</span><span class="o">.</span><span class="n">HTTP_403_FORBIDDEN</span><span class="p">,</span>
+                    <span class="n">headers</span><span class="o">=</span><span class="p">{</span><span class="s2">&quot;Access-Control-Allow-Origin&quot;</span><span class="p">:</span> <span class="s2">&quot;*&quot;</span><span class="p">},</span>
                 <span class="p">)</span>
 
     <span class="k">return</span> <span class="k">await</span> <span class="n">call_next</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>

diff --git a/versions/unreleased/guides/settings/index.html b/versions/unreleased/guides/settings/index.html
@@ -1057,6 +1057,19 @@
     </span>
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#csrf-protection-settings" class="md-nav__link">
+    <span class="md-ellipsis">
+
+        <span class="md-typeset">
+          CSRF Protection Settings
+        </span>
+
+    </span>
+  </a>
+
 </li>
 
           <li class="md-nav__item">
@@ -9098,6 +9111,19 @@
     </span>
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#csrf-protection-settings" class="md-nav__link">
+    <span class="md-ellipsis">
+
+        <span class="md-typeset">
+          CSRF Protection Settings
+        </span>
+
+    </span>
+  </a>
+
 </li>
 
           <li class="md-nav__item">
@@ -9415,6 +9441,21 @@ <h3 id="prefect_local_storage_path">PREFECT_LOCAL_STORAGE_PATH<a class="headerli
 <p>The <code>PREFECT_LOCAL_STORAGE_PATH</code> value specifies the default location of local storage for flow runs.</p>
 <div class="highlight"><pre><span></span><code><span class="nv">PREFECT_LOCAL_STORAGE_PATH</span><span class="o">=</span><span class="s1">&#39;${PREFECT_HOME}/storage&#39;</span>
 </code></pre></div>
+<h3 id="csrf-protection-settings">CSRF Protection Settings<a class="headerlink" href="#csrf-protection-settings" title="Permanent link">&para;</a></h3>
+<p>If using a local Prefect server instance, you can configure CSRF protection settings.</p>
+<p><code>PREFECT_SERVER_CSRF_PROTECTION_ENABLED</code>
+- Activates CSRF protection on the server, requiring valid CSRF tokens for applicable requests. Recommended for production to prevent CSRF attacks. Defaults to True.</p>
+<div class="highlight"><pre><span></span><code><span class="nv">PREFECT_SERVER_CSRF_PROTECTION_ENABLED</span><span class="o">=</span>True
+</code></pre></div>
+<p><code>PREFECT_SERVER_CSRF_TOKEN_EXPIRATION</code>
+- Sets the expiration duration for server-issued CSRF tokens, influencing how often tokens need to be refreshed. The default is 1 hour.</p>
+<div class="highlight"><pre><span></span><code><span class="nv">PREFECT_SERVER_CSRF_TOKEN_EXPIRATION</span><span class="o">=</span><span class="s1">&#39;3600&#39;</span><span class="w">  </span><span class="c1"># 1 hour in seconds</span>
+</code></pre></div>
+<p>By default clients expect that CSRF protection is enabled on the server. If you are running a server without CSRF protection, you can disable CSRF support in the client.</p>
+<p><code>PREFECT_CLIENT_CSRF_SUPPORT_ENABLED</code>
+- Enables or disables CSRF token handling in the Prefect client. When enabled, the client manages CSRF tokens for state-changing API requests. Defaults to True.</p>
+<div class="highlight"><pre><span></span><code><span class="nv">PREFECT_CLIENT_CSRF_SUPPORT_ENABLED</span><span class="o">=</span>True
+</code></pre></div>
 <h3 id="database-settings">Database settings<a class="headerlink" href="#database-settings" title="Permanent link">&para;</a></h3>
 <p>If running a self-hosted Prefect server instance, there are several database configuration settings you can read about <a href="/host/">here</a>.</p>
 <h3 id="logging-settings">Logging settings<a class="headerlink" href="#logging-settings" title="Permanent link">&para;</a></h3>

diff --git a/versions/unreleased/objects.inv b/versions/unreleased/objects.inv
diff --git a/versions/unreleased/search/search_index.json b/versions/unreleased/search/search_index.json