Skip to content

docs: refresh Public Interface & align how-to guides for Airflow 3.0+ #52297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

sunank200
Copy link
Collaborator

@sunank200 sunank200 commented Jun 26, 2025

This PR refreshed public-airflow-interface.rst for Airflow 3.0+, with the airflow.sdk, deprecating direct metadata DB access in task code, and pointing users to Task Context, REST API, or Python Client.

This patch updates user how-to guides (connections, custom-operator, extra-link) to:
– Add versionchanged:: 3.0 notes warning against direct metadata-model imports
– Switch examples from airflow.models.* to airflow.sdk.* classes and types

closes: #51590


^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in airflow-core/newsfragments.

@sunank200 sunank200 force-pushed the Update-Public-Interface branch from 6a2ff20 to f7daae6 Compare June 26, 2025 16:32
@potiuk
Copy link
Member

potiuk commented Jun 26, 2025

Actually - I am not sure if we need to make a distinction vs. Airlfow 3 and Airflow 2 - as soon as we have a clearer way of showing that you are in Airflow 2 or Airflow 3, this should be likely more distinguishable. But what I would likely do here is just to focus on Airflow 3 public interface and have a BOLD LETTTERS at the top - somethign like

This is Public interface for Airflow 3 - if you look for Airflow 2 public interface look -> Link to 2.11 version of the interface.

@potiuk
Copy link
Member

potiuk commented Jun 26, 2025

Sorry - public interface of course not security model :) .. My mind was wandering a bit to another similar change we need to do.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doc: Update Public Interface as a result of Airflow 3.0
2 participants