pierrejeambrun commented on code in PR #43874:
URL: https://github.com/apache/airflow/pull/43874#discussion_r1840345098
##########
airflow/api_fastapi/core_api/datamodels/assets.py:
##########
@@ -64,3 +64,45 @@ class AssetCollectionResponse(BaseModel):
assets: list[AssetResponse]
total_entries: int
+
+
+class DagRunAssetReference(BaseModel):
+ """Serializable version of the DagRunAssetReference ORM SqlAlchemyModel."""
+
+ run_id: str
+ dag_id: str
+ execution_date: datetime = Field(alias="logical_date")
+ start_date: datetime
+ end_date: datetime | None = None
+ state: str
+ data_interval_start: datetime
+ data_interval_end: datetime
+
+
+class AssetEventResponse(BaseModel):
+ """Asset event serializer for responses."""
+
+ id: int
+ asset_id: int
+ asset_uri: str
+ extra: dict | None = None
+ source_task_id: str | None = None
+ source_dag_id: str | None = None
+ source_run_id: str | None = None
+ source_map_index: int
+ created_dagruns: list[DagRunAssetReference]
+ timestamp: datetime
+
+ @model_validator(mode="before")
+ def rename_uri_to_asset_uri(cls, values):
+ """Rename 'uri' to 'asset_uri' during serialization to match legacy
response."""
+ if hasattr(values, "uri") and values.uri:
+ values.asset_uri = values.uri
+ return values
+
+
+class AssetEventCollectionResponse(BaseModel):
+ """Asset collection response."""
Review Comment:
Docstring is correct
```suggestion
"""Asset Event collection response."""
```
##########
airflow/api_fastapi/core_api/datamodels/assets.py:
##########
@@ -64,3 +64,45 @@ class AssetCollectionResponse(BaseModel):
assets: list[AssetResponse]
total_entries: int
+
+
+class DagRunAssetReference(BaseModel):
+ """Serializable version of the DagRunAssetReference ORM SqlAlchemyModel."""
Review Comment:
There is no model `DagRunAssetReference`, maybe you meant `DagRun`?
Maybe:
```suggestion
"""Basic DagRun seriliazer for responses."""
```
Also I would remove everywhere the mention of `ORM SqlAlchemyModel` because
the serializer can serialize much more than just an SQLAlchemy model. (any
arbitrary object with appropriate attributes, a plain dictionnary, etc...).
##########
airflow/api_fastapi/core_api/datamodels/assets.py:
##########
@@ -64,3 +64,45 @@ class AssetCollectionResponse(BaseModel):
assets: list[AssetResponse]
total_entries: int
+
+
+class DagRunAssetReference(BaseModel):
+ """Serializable version of the DagRunAssetReference ORM SqlAlchemyModel."""
+
+ run_id: str
+ dag_id: str
+ execution_date: datetime = Field(alias="logical_date")
+ start_date: datetime
+ end_date: datetime | None = None
+ state: str
+ data_interval_start: datetime
+ data_interval_end: datetime
+
+
+class AssetEventResponse(BaseModel):
+ """Asset event serializer for responses."""
+
+ id: int
+ asset_id: int
+ asset_uri: str
+ extra: dict | None = None
+ source_task_id: str | None = None
+ source_dag_id: str | None = None
+ source_run_id: str | None = None
+ source_map_index: int
+ created_dagruns: list[DagRunAssetReference]
+ timestamp: datetime
+
+ @model_validator(mode="before")
+ def rename_uri_to_asset_uri(cls, values):
+ """Rename 'uri' to 'asset_uri' during serialization to match legacy
response."""
+ if hasattr(values, "uri") and values.uri:
+ values.asset_uri = values.uri
+ return values
Review Comment:
Aliases can achieve that in a cleaner way I believe. (`serialization_alias`,
`validation_alias`, etc... there are a lot of option from pydantic to convert
from python to json world with different names).
We have several examples in the code for different type of aliases, I think
you might find some of interest for this use case.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
