docs: clarify AssetAlias usage with detailed explanation and examples #52259
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Added a note under "Using Airflow Public Interfaces" to recommend using `airflow.sdk` as the official interface from Airflow 3.0. - Referenced AIP-72 and linked related documentation. - Encouraged users to prefer REST API and Python Client for integrations.
Great Co-authored-by: Jarek Potiuk <[email protected]>
eladkal
reviewed
Jul 3, 2025
| @@ -28,6 +28,21 @@ and for automating certain aspects of the Airflow workflow. | |||
| Using Airflow Public Interfaces | |||
| =============================== | |||
|
|
|||
| .. note:: | |||
|
|
|||
| As of **Airflow 3.0**, users should use the ``airflow.sdk`` namespace as the official **Public Interface**, as defined in `AIP-72 <https://cwiki.apache.org/confluence/display/AIRFLOW/AIP-72+Task+Execution+Interface+aka+Task+SDK>`_. | |||
There was a problem hiding this comment.
What is the motivation to mention AIP-72? Generally speaking AIP numbering is internal information of Airflow developers they are not so meaningful to users (we do mention them sometimes but mostly for future plans not as reference to completed work)
There was a problem hiding this comment.
This entire file is also being reworked as part of #52297 by @sunank200
There was a problem hiding this comment.
ah cool
so if it suppress this PR lets close it?
Comment on lines
+43
to
+44
| - `Release Notes 3.0 <https://airflow.apache.org/docs/apache-airflow/stable/release_notes.html>`_ | ||
| - `Task SDK Overview <https://airflow.apache.org/docs/apache-airflow/stable/concepts/taskflow.html>`_ |
There was a problem hiding this comment.
should be relative links rather than http ones. We use http only for external resources
|
Superseded by #52297 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR improves the documentation for
AssetAliasin the authoring and scheduling assets guide.AssetAliasis and why it’s useful.outlet_eventsandMetadata.These improvements aim to help users better understand and effectively use
AssetAliasfor dynamic asset management and DAG dependency configuration.Closes: #52250