apache/airflow

AIP-84 Sync documentation and permissions

Open

#43 430 ouverte le 28 oct. 2024

Voir sur GitHub
 (13 commentaires) (4 réactions) (0 assignés)Python (44 809 stars) (16 781 forks)batch import
area:APIgood first issuekind:documentationkind:feature

Description

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.

Guide contributeur

Stack technique
pythonfastapi
Domaine
apidocumentationauthorization
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
4
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
over 1 week
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
blocked
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
Authentication and permissions implemented (issue #42360)Familiarity with FastAPI and Airflow APIExperience with documentation generation tools
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
15
Direction de recherche
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.