AIP-84 Alias dag_id, asset_id, run_id, task_id

[bbovenzi]

The UI should avoid rendering raw IDs whenever possible now that dags, runs, instances and assets all have more user-readable names. It would be great to update the API to reflect this in each response, returning both the id and the "name".

Here are the aliases we should do:

• dag_id with dag_display_name
• run_id with run_after
• task_id with task_display_name
• asset.id with asset.name

[leesamuel423]

Hi @bbovenzi, I’d be happy to take on this issue—could you please assign it to me? Thanks!

[pierrejeambrun]

The goal for this is to put the alongside certain fields other related fields that are useful for the UI.

To achieve that you can leverage AliasPath. For instance on TaskInstanceResponse, to add the related dag_display_name we can simply add (tested locally):

dag_display_name: str = Field(validation_alias=AliasPath("dag_run", "dag_model", "dag_display_name"))

As mentioned in the issue we should to that for different aliases. Careful because such AliasPath will access relationship. To evoid emitting 1 extra lazy query at access time (that would be problematic for list endpoint) you can eagerload those relationships. (.options(joinedload(...)))

[pierrejeambrun]

Hello @leesamuel423,

Any progress on this ?

[guan404ming]

Hi @pierrejeambrun, it seems like it have been inactive for a while, could I help with this?

[pierrejeambrun]

Hello @guan404ming,

Of course thanks, you're assigned.