Skip to content

fix: Added Permission API docs #4485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tokoko merged 2 commits into from
Sep 5, 2024
Merged

fix: Added Permission API docs #4485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
131267a
Updated API docs with Permission types and functions
dmartinol Sep 4, 2024
cffc434
Updated API docs with Permission types and functions
dmartinol Sep 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 57 additions & 1 deletion sdk/python/docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -453,4 +453,60 @@ Snowflake Engine
:members:

.. autoclass:: feast.infra.materialization.contrib.spark.spark_materialization_engine.SparkMaterializationJob
:members:
:members:

Permission
============================

.. autoclass:: feast.permissions.permission.Permission
:members:

.. autoclass:: feast.permissions.action.AuthzedAction
:members:

.. autoclass:: feast.permissions.policy.Policy
:members:

.. autofunction:: feast.permissions.enforcer.enforce_policy

Auth Config
---------------------------

.. autoclass:: feast.permissions.auth_model.AuthConfig
:members:

.. autoclass:: feast.permissions.auth_model.KubernetesAuthConfig
:members:

.. autoclass:: feast.permissions.auth_model.OidcAuthConfig
:members:

Auth Manager
---------------------------

.. autoclass:: feast.permissions.auth.AuthManager
:members:

.. autoclass:: feast.permissions.auth.token_parser.TokenParser
:members:

.. autoclass:: feast.permissions.auth.token_extractor.TokenExtractor
:members:

.. autoclass:: feast.permissions.auth.kubernetes_token_parser.KubernetesTokenParser
:members:

.. autoclass:: feast.permissions.auth.oidc_token_parser.OidcTokenParser
:members:

Auth Client Manager
---------------------------

.. autoclass:: feast.permissions.client.auth_client_manager.AuthenticationClientManager
:members:

.. autoclass:: feast.permissions.client.kubernetes_auth_client_manager.KubernetesAuthClientManager
:members:

.. autoclass:: feast.permissions.client.oidc_authentication_client_manager.OidcAuthClientManager
:members:
8 changes: 8 additions & 0 deletions sdk/python/docs/source/feast.permissions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,14 @@ feast.permissions.matcher module
:undoc-members:
:show-inheritance:

feast.permissions.oidc\_service module
--------------------------------------

.. automodule:: feast.permissions.oidc_service
:members:
:undoc-members:
:show-inheritance:

feast.permissions.permission module
-----------------------------------

Expand Down
58 changes: 57 additions & 1 deletion sdk/python/docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -453,4 +453,60 @@ Snowflake Engine
:members:

.. autoclass:: feast.infra.materialization.contrib.spark.spark_materialization_engine.SparkMaterializationJob
:members:
:members:

Permission
============================

.. autoclass:: feast.permissions.permission.Permission
:members:

.. autoclass:: feast.permissions.action.AuthzedAction
:members:

.. autoclass:: feast.permissions.policy.Policy
:members:

.. autofunction:: feast.permissions.enforcer.enforce_policy

Auth Config
---------------------------

.. autoclass:: feast.permissions.auth_model.AuthConfig
:members:

.. autoclass:: feast.permissions.auth_model.KubernetesAuthConfig
:members:

.. autoclass:: feast.permissions.auth_model.OidcAuthConfig
:members:

Auth Manager
---------------------------

.. autoclass:: feast.permissions.auth.AuthManager
:members:

.. autoclass:: feast.permissions.auth.token_parser.TokenParser
:members:

.. autoclass:: feast.permissions.auth.token_extractor.TokenExtractor
:members:

.. autoclass:: feast.permissions.auth.kubernetes_token_parser.KubernetesTokenParser
:members:

.. autoclass:: feast.permissions.auth.oidc_token_parser.OidcTokenParser
:members:

Auth Client Manager
---------------------------

.. autoclass:: feast.permissions.client.auth_client_manager.AuthenticationClientManager
:members:

.. autoclass:: feast.permissions.client.kubernetes_auth_client_manager.KubernetesAuthClientManager
:members:

.. autoclass:: feast.permissions.client.oidc_authentication_client_manager.OidcAuthClientManager
:members: