Skip to content

docs: update public interface doc to reflect airflow.sdk and AIP-72 #52197

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.

Sign up for GitHub

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

Jump to bottom
Merged
potiuk merged 5 commits into from
Jul 10, 2025
Merged

docs: update public interface doc to reflect airflow.sdk and AIP-72 #52197

potiuk merged 5 commits into from
Jul 10, 2025

Conversation

@nrnavaneet
Copy link
Contributor

@nrnavaneet nrnavaneet commented Jun 24, 2025

Summary

Updated the public-airflow-interface.rst documentation to reflect changes introduced in Apache Airflow 3.0.

  • Added a note under "Using Airflow Public Interfaces" highlighting the airflow.sdk namespace.
  • Encouraged use of the official REST API and Python Client SDK for stable integrations.
  • Linked AIP-72 and relevant release notes for clarity.

Related Issue

Closes #52159

@nrnavaneet
docs: update public interface doc to reflect airflow.sdk and AIP-72
3af3ead 
- 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.
@boring-cyborg
Copy link

boring-cyborg bot commented Jun 24, 2025

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our pre-commits will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@nrnavaneet
Copy link
Contributor Author

nrnavaneet commented Jun 24, 2025

Hi! 🙌 First-time contributor here. Thanks for reviewing this PR — happy to make any improvements if needed!

potiuk
potiuk reviewed Jun 25, 2025
View reviewed changes
@nrnavaneet @potiuk
Update airflow-core/docs/public-airflow-interface.rst
0538d94 
Great

Co-authored-by: Jarek Potiuk <jarek@potiuk.com>
@potiuk potiuk added the backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch label Jul 10, 2025
@potiuk potiuk merged commit e142ab9 into apache:main Jul 10, 2025
57 checks passed
@boring-cyborg
Copy link

boring-cyborg bot commented Jul 10, 2025

Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions.

github-actions bot pushed a commit that referenced this pull request Jul 10, 2025
@nrnavaneet @potiuk
[v3-0-test] docs: update public interface doc to reflect airflow.sdk …
7b9ac5c 
…and AIP-72 (#52197)

* docs: update public interface doc to reflect airflow.sdk and AIP-72

- 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.

* Update airflow-core/docs/public-airflow-interface.rst

Great

Co-authored-by: Jarek Potiuk <jarek@potiuk.com>

---------
(cherry picked from commit e142ab9)

Co-authored-by: N R Navaneet <156576749+nrnavaneet@users.noreply.github.com>
Co-authored-by: Jarek Potiuk <jarek@potiuk.com>
@github-actions
Copy link

github-actions bot commented Jul 10, 2025

Backport successfully created: v3-0-test

Status Branch Result
✅ v3-0-test PR Link

github-actions bot pushed a commit to aws-mwaa/upstream-to-airflow that referenced this pull request Jul 10, 2025
@nrnavaneet @potiuk
[v3-0-test] docs: update public interface doc to reflect airflow.sdk …
8a1d543 
…and AIP-72 (apache#52197)

* docs: update public interface doc to reflect airflow.sdk and AIP-72

- 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.

* Update airflow-core/docs/public-airflow-interface.rst

Great

Co-authored-by: Jarek Potiuk <jarek@potiuk.com>

---------
(cherry picked from commit e142ab9)

Co-authored-by: N R Navaneet <156576749+nrnavaneet@users.noreply.github.com>
Co-authored-by: Jarek Potiuk <jarek@potiuk.com>
@nrnavaneet nrnavaneet deleted the update-public-interface-docs branch July 10, 2025 10:07
potiuk added a commit that referenced this pull request Jul 10, 2025
@github-actions @nrnavaneet @potiuk
[v3-0-test] docs: update public interface doc to reflect airflow.sdk …
0822328 
…and AIP-72 (#52197) (#53117)

* docs: update public interface doc to reflect airflow.sdk and AIP-72

- 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.

* Update airflow-core/docs/public-airflow-interface.rst

Great



---------
(cherry picked from commit e142ab9)

Co-authored-by: N R Navaneet <156576749+nrnavaneet@users.noreply.github.com>
Co-authored-by: Jarek Potiuk <jarek@potiuk.com>
HsiuChuanHsu pushed a commit to HsiuChuanHsu/airflow that referenced this pull request Jul 10, 2025
@nrnavaneet @potiuk @HsiuChuanHsu
docs: update public interface doc to reflect airflow.sdk and AIP-72 (a…
ed1d61a 
…pache#52197)

* docs: update public interface doc to reflect airflow.sdk and AIP-72

- 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.

* Update airflow-core/docs/public-airflow-interface.rst

Great

Co-authored-by: Jarek Potiuk <jarek@potiuk.com>

---------

Co-authored-by: Jarek Potiuk <jarek@potiuk.com>
kaxil pushed a commit that referenced this pull request Jul 11, 2025
@github-actions @nrnavaneet
@potiuk @kaxil
[v3-0-test] docs: update public interface doc to reflect airflow.sdk …
2af039b 
…and AIP-72 (#52197) (#53117)

* docs: update public interface doc to reflect airflow.sdk and AIP-72

- 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.

* Update airflow-core/docs/public-airflow-interface.rst

Great



---------
(cherry picked from commit e142ab9)

Co-authored-by: N R Navaneet <156576749+nrnavaneet@users.noreply.github.com>
Co-authored-by: Jarek Potiuk <jarek@potiuk.com>
kaxil pushed a commit that referenced this pull request Jul 11, 2025
@github-actions @nrnavaneet
@potiuk @kaxil
[v3-0-test] docs: update public interface doc to reflect airflow.sdk …
2d7d5f6 
…and AIP-72 (#52197) (#53117)

* docs: update public interface doc to reflect airflow.sdk and AIP-72

- 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.

* Update airflow-core/docs/public-airflow-interface.rst

Great



---------
(cherry picked from commit e142ab9)

Co-authored-by: N R Navaneet <156576749+nrnavaneet@users.noreply.github.com>
Co-authored-by: Jarek Potiuk <jarek@potiuk.com>
stephen-bracken pushed a commit to stephen-bracken/airflow that referenced this pull request Jul 15, 2025
@nrnavaneet @potiuk
docs: update public interface doc to reflect airflow.sdk and AIP-72 (a…
63bdc0d 
…pache#52197)

* docs: update public interface doc to reflect airflow.sdk and AIP-72

- 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.

* Update airflow-core/docs/public-airflow-interface.rst

Great

Co-authored-by: Jarek Potiuk <jarek@potiuk.com>

---------

Co-authored-by: Jarek Potiuk <jarek@potiuk.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@potiuk potiuk potiuk approved these changes

Assignees

No one assigned

Labels

backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch kind:documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Helm Notes Adjustment for Airflow Version >= 3.0.0

2 participants

@nrnavaneet @potiuk