Skip to content

Commit

Permalink
Add documentation for packages - 2024-07-28 (#1049)
Browse files Browse the repository at this point in the history
* Add documentation for packages - 2024-07-28

* remove google and amazon from release
  • Loading branch information
eladkal authored Jul 31, 2024
1 parent c869145 commit 23332bb
Show file tree
Hide file tree
Showing 155 changed files with 92,207 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs-archive/apache-airflow-providers-amazon/stable.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
8.26.0
8.26.0
4 changes: 4 additions & 0 deletions docs-archive/apache-airflow-providers-fab/1.2.2/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 2b6da7fbe5da49fa4412c99c110d475c
tags: 645f666f9bcd5a90fca523b33c5a78b7

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

856 changes: 856 additions & 0 deletions docs-archive/apache-airflow-providers-fab/1.2.2/_modules/index.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
:py:mod:`airflow.providers.fab.auth_manager.api.auth.backend.basic_auth`
========================================================================

.. py:module:: airflow.providers.fab.auth_manager.api.auth.backend.basic_auth
.. autoapi-nested-parse::

Basic authentication backend.



Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

airflow.providers.fab.auth_manager.api.auth.backend.basic_auth.init_app
airflow.providers.fab.auth_manager.api.auth.backend.basic_auth.auth_current_user
airflow.providers.fab.auth_manager.api.auth.backend.basic_auth.requires_authentication



Attributes
~~~~~~~~~~

.. autoapisummary::

airflow.providers.fab.auth_manager.api.auth.backend.basic_auth.CLIENT_AUTH
airflow.providers.fab.auth_manager.api.auth.backend.basic_auth.T


.. py:data:: CLIENT_AUTH
:type: tuple[str, str] | Any | None



.. py:data:: T
.. py:function:: init_app(_)
Initialize authentication backend.


.. py:function:: auth_current_user()
Authenticate and set current user if Authorization header exists.


.. py:function:: requires_authentication(function)
Decorate functions that require authentication.


Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
:py:mod:`airflow.providers.fab.auth_manager.api.auth.backend`
=============================================================

.. py:module:: airflow.providers.fab.auth_manager.api.auth.backend
Submodules
----------
.. toctree::
:titlesonly:
:maxdepth: 1

basic_auth/index.rst
kerberos_auth/index.rst


Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
:py:mod:`airflow.providers.fab.auth_manager.api.auth.backend.kerberos_auth`
===========================================================================

.. py:module:: airflow.providers.fab.auth_manager.api.auth.backend.kerberos_auth
Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

airflow.providers.fab.auth_manager.api.auth.backend.kerberos_auth.find_user



Attributes
~~~~~~~~~~

.. autoapisummary::

airflow.providers.fab.auth_manager.api.auth.backend.kerberos_auth.log
airflow.providers.fab.auth_manager.api.auth.backend.kerberos_auth.CLIENT_AUTH
airflow.providers.fab.auth_manager.api.auth.backend.kerberos_auth.init_app
airflow.providers.fab.auth_manager.api.auth.backend.kerberos_auth.requires_authentication


.. py:data:: log
.. py:data:: CLIENT_AUTH
:type: tuple[str, str] | Any | None



.. py:function:: find_user(username=None, email=None)
.. py:data:: init_app
.. py:data:: requires_authentication
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
:py:mod:`airflow.providers.fab.auth_manager.api.auth`
=====================================================

.. py:module:: airflow.providers.fab.auth_manager.api.auth
Subpackages
-----------
.. toctree::
:titlesonly:
:maxdepth: 3

backend/index.rst


Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
:py:mod:`airflow.providers.fab.auth_manager.api`
================================================

.. py:module:: airflow.providers.fab.auth_manager.api
Subpackages
-----------
.. toctree::
:titlesonly:
:maxdepth: 3

auth/index.rst


Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
:py:mod:`airflow.providers.fab.auth_manager.api_endpoints`
==========================================================

.. py:module:: airflow.providers.fab.auth_manager.api_endpoints
Submodules
----------
.. toctree::
:titlesonly:
:maxdepth: 1

role_and_permission_endpoint/index.rst
user_endpoint/index.rst


Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
:py:mod:`airflow.providers.fab.auth_manager.api_endpoints.role_and_permission_endpoint`
=======================================================================================

.. py:module:: airflow.providers.fab.auth_manager.api_endpoints.role_and_permission_endpoint
Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

airflow.providers.fab.auth_manager.api_endpoints.role_and_permission_endpoint.get_role
airflow.providers.fab.auth_manager.api_endpoints.role_and_permission_endpoint.get_roles
airflow.providers.fab.auth_manager.api_endpoints.role_and_permission_endpoint.get_permissions
airflow.providers.fab.auth_manager.api_endpoints.role_and_permission_endpoint.delete_role
airflow.providers.fab.auth_manager.api_endpoints.role_and_permission_endpoint.patch_role
airflow.providers.fab.auth_manager.api_endpoints.role_and_permission_endpoint.post_role



.. py:function:: get_role(*, role_name)
Get role.


.. py:function:: get_roles(*, order_by = 'name', limit, offset = None)
Get roles.


.. py:function:: get_permissions(*, limit, offset = None)
Get permissions.


.. py:function:: delete_role(*, role_name)
Delete a role.


.. py:function:: patch_role(*, role_name, update_mask = None)
Update a role.


.. py:function:: post_role()
Create a new role.


Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
:py:mod:`airflow.providers.fab.auth_manager.api_endpoints.user_endpoint`
========================================================================

.. py:module:: airflow.providers.fab.auth_manager.api_endpoints.user_endpoint
Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

airflow.providers.fab.auth_manager.api_endpoints.user_endpoint.get_user
airflow.providers.fab.auth_manager.api_endpoints.user_endpoint.get_users
airflow.providers.fab.auth_manager.api_endpoints.user_endpoint.post_user
airflow.providers.fab.auth_manager.api_endpoints.user_endpoint.patch_user
airflow.providers.fab.auth_manager.api_endpoints.user_endpoint.delete_user



.. py:function:: get_user(*, username)
Get a user.


.. py:function:: get_users(*, limit, order_by = 'id', offset = None)
Get users.


.. py:function:: post_user()
Create a new user.


.. py:function:: patch_user(*, username, update_mask = None)
Update a user.


.. py:function:: delete_user(*, username)
Delete a user.


Loading

0 comments on commit 23332bb

Please sign in to comment.