Repository navigation
Automate reference doc creation for stable API permissions #10937
Description
Description
We should find a way to create automated documentation of required permissions for stable API endpoints.
Use case / motivation
Right now the process of documenting which permissions are needed for which API endpoints is entirely manual, which is error prone and likely to get out of date.
Activity
[-]Automate doc creation for stable API permissions[/-][+]Automate reference doc creation for stable API permissions[/+]MarkI2 commentedon Mar 5, 2024
Hi I'm looking to make my first contribution to airflow. Can I take a look at this ticket?
potiuk commentedon Mar 5, 2024
Sure. Assigned you.
potiuk commentedon Mar 2, 2026
@MarkI2 We are unassigning you from this issue as part of our updated assignment policy.
This is not meant to discourage your contribution — quite the opposite! You are still very welcome to work on this issue and submit a PR for it. Simply comment that you are working on it and open a PR when ready.
We found that formal assignments were not working well, as they often prevented others from contributing when the assignee was not actively working on the issue.
durgaprasadml commentedon May 27, 2026
Hi! I’ve been exploring the FastAPI permission system and the documentation pipeline in Airflow.
My current approach is to:
At the moment I’m leaning toward generating a standalone RST page instead of modifying the OpenAPI YAML directly, since it keeps the implementation smaller and avoids adding additional noise to the generated spec.
I’m also exploring whether attaching structured permission metadata directly in security.py would be cleaner and more maintainable than relying purely on introspection.
I’d appreciate any feedback before I start implementing the extractor and doc generation flow.
potiuk commentedon May 27, 2026
Yes. That looks good.