Skip to content

Clarify API contribution guides#67678

Open
manwwe wants to merge 1 commit into
apache:mainfrom
manwwe:docs-api-clarify-contribution-guides
Open

Clarify API contribution guides#67678
manwwe wants to merge 1 commit into
apache:mainfrom
manwwe:docs-api-clarify-contribution-guides

Conversation

@manwwe
Copy link
Copy Markdown

@manwwe manwwe commented May 29, 2026

Update the API contribution documentation so it matches the current repository layout.

This PR:

  • corrects outdated public and UI API route paths
  • clarifies where generated OpenAPI specs are stored
  • updates the endpoint contribution guide with current route/test locations
  • fixes the Execution API versioning section so it reflects the current versions/ layout
  • documents when to regenerate Task SDK models after Execution API schema changes

This is documentation-only. I validated the changed RST files with:

  • prek run rst-backticks --files ...
  • prek run blacken-docs --files ...
  • git diff --check

Was generative AI tooling used to co-author this PR?
  • Yes — Codex

Generated-by: Codex following the guidelines

Update API contributor documentation to use current core API route paths, OpenAPI spec locations, and Execution API versioning layout.
@boring-cyborg
Copy link
Copy Markdown

boring-cyborg Bot commented May 29, 2026

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
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our prek-hooks 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

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.

1 participant