Add documentation for packages - 2024-03-25 (#985)

docs-archive/apache-airflow-providers-fab/1.0.2/_api/airflow/providers/fab/auth_manager/fab_auth_manager/index.html

@@ -824,18 +824,16 @@ <h3>Functions<a class="headerlink" href="#functions" title="Permalink to this he
 
 <dl class="py method">
 <dt class="sig sig-object py" id="airflow.providers.fab.auth_manager.fab_auth_manager.FabAuthManager.is_authorized_custom_view">
-<span class="sig-name descname"><span class="pre">is_authorized_custom_view</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">fab_action_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fab_resource_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../../_modules/airflow/providers/fab/auth_manager/fab_auth_manager.html#FabAuthManager.is_authorized_custom_view"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airflow.providers.fab.auth_manager.fab_auth_manager.FabAuthManager.is_authorized_custom_view" title="Permalink to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">is_authorized_custom_view</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">method</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../../_modules/airflow/providers/fab/auth_manager/fab_auth_manager.html#FabAuthManager.is_authorized_custom_view"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airflow.providers.fab.auth_manager.fab_auth_manager.FabAuthManager.is_authorized_custom_view" title="Permalink to this definition">¶</a></dt>
 <dd><p>Return whether the user is authorized to perform a given action on a custom view.</p>
-<p>A custom view is a view defined as part of the auth manager. This view is then only available when
-the auth manager is used as part of the environment.</p>
-<p>By default, it throws an exception because auth managers do not define custom views by default.
-If an auth manager defines some custom views, it needs to override this method.</p>
+<p>A custom view can be a view defined as part of the auth manager. This view is then only available when
+the auth manager is used as part of the environment. It can also be a view defined as part of a
+plugin defined by a user.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>fab_action_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – the name of the FAB action defined in the view in <code class="docutils literal notranslate"><span class="pre">base_permissions</span></code></p></li>
-<li><p><strong>fab_resource_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – the name of the FAB resource defined in the view in
-<code class="docutils literal notranslate"><span class="pre">class_permission_name</span></code></p></li>
+<li><p><strong>method</strong> (<em>airflow.auth.managers.base_auth_manager.ResourceMethod</em>) – the method to perform</p></li>
+<li><p><strong>resource_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – the name of the resource</p></li>
 <li><p><strong>user</strong> (<em>airflow.auth.managers.models.base_user.BaseUser</em><em> | </em><em>None</em>) – the user to perform the action on. If not provided (or None), it uses the current user</p></li>
 </ul>
 </dd>
@@ -850,6 +848,13 @@ <h3>Functions<a class="headerlink" href="#functions" title="Permalink to this he
 Can lead to some poor performance. It is recommended to override this method in the auth manager
 implementation to provide a more efficient implementation.</p>
 <dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>methods</strong> (<em>Container</em><em>[</em><em>airflow.auth.managers.base_auth_manager.ResourceMethod</em><em>] </em><em>| </em><em>None</em>) – whether filter readable or writable</p></li>
+<li><p><strong>user</strong> – the current user</p></li>
+<li><p><strong>session</strong> (<a class="reference external" href="https://docs.sqlalchemy.org/en/latest/orm/session_api.html#sqlalchemy.orm.Session" title="(in SQLAlchemy v2.0)"><em>sqlalchemy.orm.Session</em></a>) – the session</p></li>
+</ul>
+</dd>
 </dl>
 </dd></dl>
 

docs-archive/apache-airflow-providers-fab/1.0.2/_api/airflow/providers/fab/auth_manager/security_manager/override/index.html

@@ -845,6 +845,13 @@ <h3>Attributes<a class="headerlink" href="#attributes" title="Permalink to this
 </dl>
 </dd></dl>
 
+<dl class="py property">
+<dt class="sig sig-object py" id="airflow.providers.fab.auth_manager.security_manager.override.FabAirflowSecurityManagerOverride.auth_remote_user_env_var">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">auth_remote_user_env_var</span></span><em class="property"><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.12)"><span class="pre">str</span></a></em><a class="reference internal" href="../../../../../../../_modules/airflow/providers/fab/auth_manager/security_manager/override.html#FabAirflowSecurityManagerOverride.auth_remote_user_env_var"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airflow.providers.fab.auth_manager.security_manager.override.FabAirflowSecurityManagerOverride.auth_remote_user_env_var" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="field-list simple">
+</dl>
+</dd></dl>
+
 <dl class="py property">
 <dt class="sig sig-object py" id="airflow.providers.fab.auth_manager.security_manager.override.FabAirflowSecurityManagerOverride.api_login_allow_multiple_providers">
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">api_login_allow_multiple_providers</span></span><a class="reference internal" href="../../../../../../../_modules/airflow/providers/fab/auth_manager/security_manager/override.html#FabAirflowSecurityManagerOverride.api_login_allow_multiple_providers"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airflow.providers.fab.auth_manager.security_manager.override.FabAirflowSecurityManagerOverride.api_login_allow_multiple_providers" title="Permalink to this definition">¶</a></dt>
@@ -1545,8 +1552,7 @@ <h3>Attributes<a class="headerlink" href="#attributes" title="Permalink to this
 <dl class="py method">
 <dt class="sig sig-object py" id="airflow.providers.fab.auth_manager.security_manager.override.FabAirflowSecurityManagerOverride.load_user">
 <span class="sig-name descname"><span class="pre">load_user</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../../../_modules/airflow/providers/fab/auth_manager/security_manager/override.html#FabAirflowSecurityManagerOverride.load_user"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airflow.providers.fab.auth_manager.security_manager.override.FabAirflowSecurityManagerOverride.load_user" title="Permalink to this definition">¶</a></dt>
-<dd><p>Load user by ID.</p>
-</dd></dl>
+<dd></dd></dl>
 
 <dl class="py method">
 <dt class="sig sig-object py" id="airflow.providers.fab.auth_manager.security_manager.override.FabAirflowSecurityManagerOverride.get_user_by_id">
@@ -2067,6 +2073,7 @@ <h3>Attributes<a class="headerlink" href="#attributes" title="Permalink to this
 <li><a class="reference internal" href="#airflow.providers.fab.auth_manager.security_manager.override.FabAirflowSecurityManagerOverride.auth_ldap_group_field"><code class="docutils literal notranslate"><span class="pre">FabAirflowSecurityManagerOverride.auth_ldap_group_field</span></code></a></li>
 <li><a class="reference internal" href="#airflow.providers.fab.auth_manager.security_manager.override.FabAirflowSecurityManagerOverride.auth_roles_mapping"><code class="docutils literal notranslate"><span class="pre">FabAirflowSecurityManagerOverride.auth_roles_mapping</span></code></a></li>
 <li><a class="reference internal" href="#airflow.providers.fab.auth_manager.security_manager.override.FabAirflowSecurityManagerOverride.auth_user_registration_role_jmespath"><code class="docutils literal notranslate"><span class="pre">FabAirflowSecurityManagerOverride.auth_user_registration_role_jmespath</span></code></a></li>
+<li><a class="reference internal" href="#airflow.providers.fab.auth_manager.security_manager.override.FabAirflowSecurityManagerOverride.auth_remote_user_env_var"><code class="docutils literal notranslate"><span class="pre">FabAirflowSecurityManagerOverride.auth_remote_user_env_var</span></code></a></li>
 <li><a class="reference internal" href="#airflow.providers.fab.auth_manager.security_manager.override.FabAirflowSecurityManagerOverride.api_login_allow_multiple_providers"><code class="docutils literal notranslate"><span class="pre">FabAirflowSecurityManagerOverride.api_login_allow_multiple_providers</span></code></a></li>
 <li><a class="reference internal" href="#airflow.providers.fab.auth_manager.security_manager.override.FabAirflowSecurityManagerOverride.auth_username_ci"><code class="docutils literal notranslate"><span class="pre">FabAirflowSecurityManagerOverride.auth_username_ci</span></code></a></li>
 <li><a class="reference internal" href="#airflow.providers.fab.auth_manager.security_manager.override.FabAirflowSecurityManagerOverride.auth_ldap_bind_first"><code class="docutils literal notranslate"><span class="pre">FabAirflowSecurityManagerOverride.auth_ldap_bind_first</span></code></a></li>

docs-archive/apache-airflow-providers-fab/1.0.2/_api/airflow/providers/fab/index.html

@@ -667,7 +667,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to thi
 <h2>Package Contents<a class="headerlink" href="#package-contents" title="Permalink to this heading">¶</a></h2>
 <dl class="py data">
 <dt class="sig sig-object py" id="airflow.providers.fab.__version__">
-<span class="sig-prename descclassname"><span class="pre">airflow.providers.fab.</span></span><span class="sig-name descname"><span class="pre">__version__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'1.0.0'</span></em><a class="reference internal" href="../../../../_modules/airflow/providers/fab.html#__version__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airflow.providers.fab.__version__" title="Permalink to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">airflow.providers.fab.</span></span><span class="sig-name descname"><span class="pre">__version__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'1.0.2'</span></em><a class="reference internal" href="../../../../_modules/airflow/providers/fab.html#__version__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airflow.providers.fab.__version__" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
 </div>

docs-archive/apache-airflow-providers-fab/1.0.2/_modules/airflow/providers/fab.html

@@ -641,7 +641,7 @@ <h1>Source code for airflow.providers.fab</h1><div class="highlight"><pre>
 
 <span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;__version__&quot;</span><span class="p">]</span>
 
-<div class="viewcode-block" id="__version__"><a class="viewcode-back" href="../../../_api/airflow/providers/fab/index.html#airflow.providers.fab.__version__">[docs]</a><span class="n">__version__</span> <span class="o">=</span> <span class="s2">&quot;1.0.0&quot;</span></div>
+<div class="viewcode-block" id="__version__"><a class="viewcode-back" href="../../../_api/airflow/providers/fab/index.html#airflow.providers.fab.__version__">[docs]</a><span class="n">__version__</span> <span class="o">=</span> <span class="s2">&quot;1.0.2&quot;</span></div>
 
 <span class="k">try</span><span class="p">:</span>
     <span class="kn">from</span> <span class="nn">airflow</span> <span class="kn">import</span> <span class="n">__version__</span> <span class="k">as</span> <span class="n">airflow_version</span>

docs-archive/apache-airflow-providers-fab/1.0.2/_modules/airflow/providers/fab/auth_manager/api/auth/backend/basic_auth.html

@@ -631,6 +631,7 @@ <h1>Source code for airflow.providers.fab.auth_manager.api.auth.backend.basic_au
 <span class="c1"># specific language governing permissions and limitations</span>
 <span class="c1"># under the License.</span>
 <span class="sd">&quot;&quot;&quot;Basic authentication backend.&quot;&quot;&quot;</span>
+
 <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
 
 <span class="kn">from</span> <span class="nn">functools</span> <span class="kn">import</span> <span class="n">wraps</span>