fix: Added Permission API docs (feast-dev#4485)

* Updated API docs with Permission types and functions Signed-off-by: Daniele Martinoli <dmartino@redhat.com> * Updated API docs with Permission types and functions Signed-off-by: Daniele Martinoli <dmartino@redhat.com> --------- Signed-off-by: Daniele Martinoli <dmartino@redhat.com>
lokeshrangineni · Sep 5, 2024 · 2bd03fa · 2bd03fa
1 parent 3f3a4e8
commit 2bd03fa
Show file tree

Hide file tree

Showing 3 changed files with 122 additions and 2 deletions.
diff --git 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:
+    :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
@@ -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/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:
+    :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: