Skip to content

Commit 2bd03fa

Browse files
authored
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>
1 parent 3f3a4e8 commit 2bd03fa

File tree

3 files changed

+122
-2
lines changed

3 files changed

+122
-2
lines changed

sdk/python/docs/index.rst

+57-1
Original file line numberDiff line numberDiff line change
@@ -453,4 +453,60 @@ Snowflake Engine
453453
:members:
454454

455455
.. autoclass:: feast.infra.materialization.contrib.spark.spark_materialization_engine.SparkMaterializationJob
456-
:members:
456+
:members:
457+
458+
Permission
459+
============================
460+
461+
.. autoclass:: feast.permissions.permission.Permission
462+
:members:
463+
464+
.. autoclass:: feast.permissions.action.AuthzedAction
465+
:members:
466+
467+
.. autoclass:: feast.permissions.policy.Policy
468+
:members:
469+
470+
.. autofunction:: feast.permissions.enforcer.enforce_policy
471+
472+
Auth Config
473+
---------------------------
474+
475+
.. autoclass:: feast.permissions.auth_model.AuthConfig
476+
:members:
477+
478+
.. autoclass:: feast.permissions.auth_model.KubernetesAuthConfig
479+
:members:
480+
481+
.. autoclass:: feast.permissions.auth_model.OidcAuthConfig
482+
:members:
483+
484+
Auth Manager
485+
---------------------------
486+
487+
.. autoclass:: feast.permissions.auth.AuthManager
488+
:members:
489+
490+
.. autoclass:: feast.permissions.auth.token_parser.TokenParser
491+
:members:
492+
493+
.. autoclass:: feast.permissions.auth.token_extractor.TokenExtractor
494+
:members:
495+
496+
.. autoclass:: feast.permissions.auth.kubernetes_token_parser.KubernetesTokenParser
497+
:members:
498+
499+
.. autoclass:: feast.permissions.auth.oidc_token_parser.OidcTokenParser
500+
:members:
501+
502+
Auth Client Manager
503+
---------------------------
504+
505+
.. autoclass:: feast.permissions.client.auth_client_manager.AuthenticationClientManager
506+
:members:
507+
508+
.. autoclass:: feast.permissions.client.kubernetes_auth_client_manager.KubernetesAuthClientManager
509+
:members:
510+
511+
.. autoclass:: feast.permissions.client.oidc_authentication_client_manager.OidcAuthClientManager
512+
:members:

sdk/python/docs/source/feast.permissions.rst

+8
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,14 @@ feast.permissions.matcher module
6262
:undoc-members:
6363
:show-inheritance:
6464

65+
feast.permissions.oidc\_service module
66+
--------------------------------------
67+
68+
.. automodule:: feast.permissions.oidc_service
69+
:members:
70+
:undoc-members:
71+
:show-inheritance:
72+
6573
feast.permissions.permission module
6674
-----------------------------------
6775

sdk/python/docs/source/index.rst

+57-1
Original file line numberDiff line numberDiff line change
@@ -453,4 +453,60 @@ Snowflake Engine
453453
:members:
454454

455455
.. autoclass:: feast.infra.materialization.contrib.spark.spark_materialization_engine.SparkMaterializationJob
456-
:members:
456+
:members:
457+
458+
Permission
459+
============================
460+
461+
.. autoclass:: feast.permissions.permission.Permission
462+
:members:
463+
464+
.. autoclass:: feast.permissions.action.AuthzedAction
465+
:members:
466+
467+
.. autoclass:: feast.permissions.policy.Policy
468+
:members:
469+
470+
.. autofunction:: feast.permissions.enforcer.enforce_policy
471+
472+
Auth Config
473+
---------------------------
474+
475+
.. autoclass:: feast.permissions.auth_model.AuthConfig
476+
:members:
477+
478+
.. autoclass:: feast.permissions.auth_model.KubernetesAuthConfig
479+
:members:
480+
481+
.. autoclass:: feast.permissions.auth_model.OidcAuthConfig
482+
:members:
483+
484+
Auth Manager
485+
---------------------------
486+
487+
.. autoclass:: feast.permissions.auth.AuthManager
488+
:members:
489+
490+
.. autoclass:: feast.permissions.auth.token_parser.TokenParser
491+
:members:
492+
493+
.. autoclass:: feast.permissions.auth.token_extractor.TokenExtractor
494+
:members:
495+
496+
.. autoclass:: feast.permissions.auth.kubernetes_token_parser.KubernetesTokenParser
497+
:members:
498+
499+
.. autoclass:: feast.permissions.auth.oidc_token_parser.OidcTokenParser
500+
:members:
501+
502+
Auth Client Manager
503+
---------------------------
504+
505+
.. autoclass:: feast.permissions.client.auth_client_manager.AuthenticationClientManager
506+
:members:
507+
508+
.. autoclass:: feast.permissions.client.kubernetes_auth_client_manager.KubernetesAuthClientManager
509+
:members:
510+
511+
.. autoclass:: feast.permissions.client.oidc_authentication_client_manager.OidcAuthClientManager
512+
:members:

0 commit comments

Comments
 (0)