From 131267abaf5b6be3b66a419aaa9645fb8b0bc45f Mon Sep 17 00:00:00 2001 From: Daniele Martinoli Date: Wed, 4 Sep 2024 10:22:05 +0200 Subject: [PATCH 1/2] Updated API docs with Permission types and functions Signed-off-by: Daniele Martinoli --- sdk/python/docs/index.rst | 58 +++++++++++++++++++- sdk/python/docs/source/feast.permissions.rst | 8 +++ sdk/python/docs/source/feast.rst | 8 +++ sdk/python/docs/source/index.rst | 58 +++++++++++++++++++- 4 files changed, 130 insertions(+), 2 deletions(-) diff --git a/sdk/python/docs/index.rst b/sdk/python/docs/index.rst index 1ef6bd16c8..86354f80c7 100644 --- a/sdk/python/docs/index.rst +++ b/sdk/python/docs/index.rst @@ -453,4 +453,60 @@ Snowflake Engine :members: .. autoclass:: feast.infra.materialization.contrib.spark.spark_materialization_engine.SparkMaterializationJob - :members: \ No newline at end of file + :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: diff --git a/sdk/python/docs/source/feast.permissions.rst b/sdk/python/docs/source/feast.permissions.rst index 8c33ab6273..d8731111e1 100644 --- a/sdk/python/docs/source/feast.permissions.rst +++ b/sdk/python/docs/source/feast.permissions.rst @@ -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 ----------------------------------- diff --git a/sdk/python/docs/source/feast.rst b/sdk/python/docs/source/feast.rst index b8c04ebde6..b24b089f83 100644 --- a/sdk/python/docs/source/feast.rst +++ b/sdk/python/docs/source/feast.rst @@ -196,6 +196,14 @@ feast.flags\_helper module :undoc-members: :show-inheritance: +feast.grpc\_error\_interceptor module +------------------------------------- + +.. automodule:: feast.grpc_error_interceptor + :members: + :undoc-members: + :show-inheritance: + feast.importer module --------------------- diff --git a/sdk/python/docs/source/index.rst b/sdk/python/docs/source/index.rst index 1ef6bd16c8..86354f80c7 100644 --- a/sdk/python/docs/source/index.rst +++ b/sdk/python/docs/source/index.rst @@ -453,4 +453,60 @@ Snowflake Engine :members: .. autoclass:: feast.infra.materialization.contrib.spark.spark_materialization_engine.SparkMaterializationJob - :members: \ No newline at end of file + :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: From cffc434136118fb07e62a33c4b9f4e0bec909111 Mon Sep 17 00:00:00 2001 From: Daniele Martinoli Date: Wed, 4 Sep 2024 10:29:49 +0200 Subject: [PATCH 2/2] Updated API docs with Permission types and functions Signed-off-by: Daniele Martinoli --- sdk/python/docs/source/feast.rst | 8 -------- 1 file changed, 8 deletions(-) diff --git a/sdk/python/docs/source/feast.rst b/sdk/python/docs/source/feast.rst index b24b089f83..b8c04ebde6 100644 --- a/sdk/python/docs/source/feast.rst +++ b/sdk/python/docs/source/feast.rst @@ -196,14 +196,6 @@ feast.flags\_helper module :undoc-members: :show-inheritance: -feast.grpc\_error\_interceptor module -------------------------------------- - -.. automodule:: feast.grpc_error_interceptor - :members: - :undoc-members: - :show-inheritance: - feast.importer module ---------------------