Use separate aliases for serialization and validation

dbt-labs · Oct 25, 2023 · 7df2788 · 7df2788
1 parent 8daa65c
commit 7df2788
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/dbt_semantic_interfaces/implementations/export.py b/dbt_semantic_interfaces/implementations/export.py
@@ -14,14 +14,18 @@
 
 
 class PydanticExportConfig(HashableBaseModel, ProtocolHint[ExportConfig]):
-    """Pydantic implementation of ExportConfig."""
+    """Pydantic implementation of ExportConfig.
+
+    Note on `schema_name`: `schema` is a BaseModel attribute so we need to alias it here.
+    Use `schema` for YAML definition & JSON, `schema_name` for object attribute.
+    """
 
     @override
     def _implements_protocol(self) -> ExportConfig:
         return self
 
     export_as: ExportDestinationType
-    schema_name: Optional[str] = Field(alias="schema")  # `schema` is a BaseModel attribute
+    schema_name: Optional[str] = Field(serialization_alias="schema", validation_alias="schema_name")
     alias: Optional[str] = None