Skip to content

Automate stable REST API permission reference doc generation#67606

Draft
durgaprasadml wants to merge 2 commits into
apache:mainfrom
durgaprasadml:feat/automate-api-permission-doc
Draft

Automate stable REST API permission reference doc generation#67606
durgaprasadml wants to merge 2 commits into
apache:mainfrom
durgaprasadml:feat/automate-api-permission-doc

Conversation

@durgaprasadml
Copy link
Copy Markdown

Automate stable REST API permission reference doc generation.

This PR introduces an automated extractor for stable REST API permissions and generates a reference RST document directly from the source routes and permission declarations.

Current implementation:

  • statically analyzes /api/v2 route definitions
  • extracts requires_access_* permission metadata
  • generates api_permissions_ref.rst
  • includes regression and invariant tests
  • integrates with existing prek-based generation workflows

This PR is intentionally opened as a draft to gather maintainer feedback on:

  • AST-based extraction vs runtime introspection
  • final file placement
  • generation workflow integration
  • committed generated artifacts

Closes: #10937

@boring-cyborg boring-cyborg Bot added area:dev-tools backport-to-v3-2-test Mark PR with this label to backport to v3-2-test branch kind:documentation labels May 27, 2026
@boring-cyborg
Copy link
Copy Markdown

boring-cyborg Bot commented May 27, 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

Labels

area:dev-tools backport-to-v3-2-test Mark PR with this label to backport to v3-2-test branch kind:documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Automate reference doc creation for stable API permissions

1 participant