Publish new build of docs

Author: github-actions[bot]

master/genindex.html

@@ -1619,10 +1619,10 @@ <h2 id="I">I</h2>
         <li><a href="modules/schema.html#octoprint.schema.config.webcam.TimelapseOptions.interval">(octoprint.schema.config.webcam.TimelapseOptions attribute)</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="modules/plugin.html#octoprint.plugin.core.PluginInfo.invalid_syntax">invalid_syntax (octoprint.plugin.core.PluginInfo attribute)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="modules/printer.html#octoprint.printer.profile.InvalidProfileError">InvalidProfileError (class in octoprint.printer.profile)</a>
 </li>
       <li><a href="modules/access.html#octoprint.access.users.InvalidUsername">InvalidUsername</a>
@@ -1634,6 +1634,8 @@ <h2 id="I">I</h2>
       <li><a href="modules/util.html#octoprint.util.is_allowed_file">is_allowed_file() (in module octoprint.util)</a>
 </li>
       <li><a href="plugins/mixins.html#octoprint.plugin.SimpleApiPlugin.is_api_adminonly">is_api_adminonly() (octoprint.plugin.SimpleApiPlugin method)</a>
+</li>
+      <li><a href="plugins/mixins.html#octoprint.plugin.SimpleApiPlugin.is_api_protected">is_api_protected() (octoprint.plugin.SimpleApiPlugin method)</a>
 </li>
       <li><a href="plugins/mixins.html#octoprint.plugin.BlueprintPlugin.is_blueprint_csrf_protected">is_blueprint_csrf_protected() (octoprint.plugin.BlueprintPlugin method)</a>
 </li>
@@ -1754,6 +1756,8 @@ <h2 id="L">L</h2>
       <li><a href="modules/schema.html#octoprint.schema.config.serial.SerialCapabilities.lfn_write">lfn_write (octoprint.schema.config.serial.SerialCapabilities attribute)</a>
 </li>
       <li><a href="modules/plugin.html#octoprint.plugin.core.PluginInfo.license">license (octoprint.plugin.core.PluginInfo property)</a>
+</li>
+      <li><a href="plugins/mixins.html#octoprint.plugin.BlueprintPlugin.limit">limit() (octoprint.plugin.BlueprintPlugin static method)</a>
 </li>
       <li><a href="modules/filemanager.html#octoprint.filemanager.util.LineProcessorStream">LineProcessorStream (class in octoprint.filemanager.util)</a>
 </li>
@@ -1770,11 +1774,11 @@ <h2 id="L">L</h2>
 </li>
       </ul></li>
       <li><a href="modules/settings.html#octoprint.settings.Settings.listScripts">listScripts() (octoprint.settings.Settings method)</a>
-</li>
-      <li><a href="modules/plugin.html#octoprint.plugin.core.PluginInfo.load">load (octoprint.plugin.core.PluginInfo property)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="modules/plugin.html#octoprint.plugin.core.PluginInfo.load">load (octoprint.plugin.core.PluginInfo property)</a>
+</li>
       <li><a href="modules/settings.html#octoprint.settings.Settings.load">load() (octoprint.settings.Settings method)</a>
 </li>
       <li><a href="modules/settings.html#octoprint.settings.Settings.load_overlay">load_overlay() (octoprint.settings.Settings method)</a>

master/modules/server.html

@@ -810,7 +810,7 @@
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">octoprint.server.util.flask.</span></span><span class="sig-name descname"><span class="pre">ReverseProxyInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_ip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">server_protocol</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">server_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">server_port</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">server_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">cookie_suffix</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">trusted_proxies</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.13)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">[]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headers</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Dict" title="(in Python v3.13)"><span class="pre">Dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">{}</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#octoprint.server.util.flask.ReverseProxyInfo" title="Link to this definition"></a></dt>
 <dd><dl class="py attribute">
 <dt class="sig sig-object py" id="octoprint.server.util.flask.ReverseProxyInfo.model_config">
-<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#octoprint.server.util.flask.ReverseProxyInfo.model_config" title="Link to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'use_enum_values':</span> <span class="pre">True,</span> <span class="pre">'validate_default':</span> <span class="pre">True}</span></em><a class="headerlink" href="#octoprint.server.util.flask.ReverseProxyInfo.model_config" title="Link to this definition"></a></dt>
 <dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
 </dd></dl>
 

master/plugins/mixins.html

@@ -594,6 +594,14 @@
 permissions checks explicitly.</p>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="octoprint.plugin.BlueprintPlugin.limit">
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">limit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#octoprint.plugin.BlueprintPlugin.limit" title="Link to this definition"></a></dt>
+<dd><p>A decorator to rate limit a view method in your BlueprintPlugin.</p>
+<p>See <a class="reference external" href="https://flask-limiter.readthedocs.io/en/stable/api.html#flask_limiter.Limiter.limit">the documentation for flask_limiter.Limiter.limit</a>
+for more information.</p>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="octoprint.plugin.BlueprintPlugin.route">
 <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">route</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rule</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">options</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#octoprint.plugin.BlueprintPlugin.route" title="Link to this definition"></a></dt>
@@ -1201,6 +1209,23 @@
 <dd><p>Return True if the API is only available to users having the admin role.</p>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="octoprint.plugin.SimpleApiPlugin.is_api_protected">
+<span class="sig-name descname"><span class="pre">is_api_protected</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></span></span><a class="headerlink" href="#octoprint.plugin.SimpleApiPlugin.is_api_protected" title="Link to this definition"></a></dt>
+<dd><p>Whether a SimpleApi’s endpoints requires a valid user to be logged in to access it. For now, this defaults to <code class="docutils literal notranslate"><span class="pre">False</span></code> to leave it up to
+plugins to decide whether the endpoints <em>should</em> be protected. Long term, this will default to <code class="docutils literal notranslate"><span class="pre">True</span></code> and hence
+enforce protection unless a plugin opts out by returning False here.</p>
+<p>If you do not override this method in your mixin implementation, a warning will be logged to the console
+to alert you of the requirement to make a decision here and to not rely on the default implementation, due to the
+forthcoming change in implemented default behaviour.</p>
+<p>Be advised that by returning <code class="docutils literal notranslate"><span class="pre">True</span></code> here, OctoPrint will only check whether a valid user is logged in before forwarding
+the request to your implementation. However, you <em>really should</em> add additional permission checks specific to your plugin into your API
+endpoints.</p>
+<div class="versionadded">
+<p><span class="versionmodified added">Added in version 1.11.2.</span></p>
+</div>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="octoprint.plugin.SimpleApiPlugin.on_api_command">
 <span class="sig-name descname"><span class="pre">on_api_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">command</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#octoprint.plugin.SimpleApiPlugin.on_api_command" title="Link to this definition"></a></dt>