docs: Add metadata info for feature_store.yaml (#5455)

shuchu · web-flow · commit f1aaa61b7023 · 2025-06-14T21:23:37.000-04:00
Signed-off-by: Shuchu Han &lt;shuchu.han@gmail.com&gt;
diff --git a/docs/reference/registries/README.md b/docs/reference/registries/README.md
@@ -2,6 +2,10 @@
 
 Please see [Registry](../../getting-started/components/registry.md) for a conceptual explanation of registries.
 
+{% content-ref url="metadata.md" %}
+[metadata.md](metadata.md)
+{% endcontent-ref %}
+
 {% content-ref url="local.md" %}
 [local.md](local.md)
 {% endcontent-ref %}
diff --git a/docs/reference/registries/metadata.md b/docs/reference/registries/metadata.md
@@ -0,0 +1,29 @@
+# Metadata info of feature_store.yaml
+
+## Description
+
+The metadata info of Feast `feature_store.yaml` is:
+
+| Key | Required | Value Type |Definition |
+| ------------------------|---------------------|------------------------|------------------------| 
+| project   | Y | string | name of the project |
+| provider  | N | string |  |
+| registry  | Y | NA | definition of registry |
+| registry.path | Y | string | URI of storing registry data |
+| registry.cache_ttl_seconds | N | integer | |
+| registry.registry_type | N | string | type of registry server |
+| registry.sqlalchemy_config_kwargs | N | NA | kwargs configuration for sql registry server|
+| registry.account  | N | string | cloud account type |
+| registry.user   | N | string | cloud login account |
+| registry.password | N | string | cloud login password |
+| registry.role    | N | string | cloud login account role |
+| registry.warehouse | N | string | snowflake warehouse name |
+| registry.database | N | string | snowflake db name |
+| registry.schema   | N | string | snowflake schema name |
+| online_store  | Y | | |
+| offline_store  | Y | NA | | |
+| offline_store.type | Y | string | storage type | 
+| entity_key_serialization_version | N | string | |
+| feature_server | N | NA | config of feature server |
+| feature_server.transformation_service_endpoint | N | string | python transformation server endpoint for Go feature server |
+
