apache/airflow

AIP-84 Sync documentation and permissions

Open

#43,430 创建于 2024年10月28日

在 GitHub 查看
 (13 评论) (4 反应) (0 负责人)Python (44,809 star) (16,781 fork)batch import
area:APIgood first issuekind:documentationkind:feature

描述

More context here https://github.com/apache/airflow/issues/43140#issuecomment-2431304177

To avoid additional mismatch between the code and the documentation, we could add a small layer to automatically detect and document the API permissions for each route. Ideally the swagger and maybe also this documentation page should be automatically populated from the FastAPI code.

Note: To be able to work on this, authentication and permissions need to be implemented first.

Committer

  • I acknowledge that I am a maintainer/committer of the Apache Airflow project.

贡献者指南

技术栈
pythonfastapi
领域
apidocumentationauthorization
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
4
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
over 1 week
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
blocked
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
Authentication and permissions implemented (issue #42360)Familiarity with FastAPI and Airflow APIExperience with documentation generation tools
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
15
研究方向
First, review the current API documentation generation in Airflow, particularly the FastAPI application setup in airflow/auth/manager/fastapi.py and the OpenAPI schema generation. Then, study the proposed authentication and permissions implementation in issue #42360 to understand the expected permission structure. After that, design a mechanism to automatically annotate each route with required permissions and integrate it into the existing documentation generation process, ensuring it populates both the Swagger UI and the DAG level permissions documentation page.