apache/airflow

AIP-84 Sync documentation and permissions

Open

Aperta il 28 ott 2024

Vedi su GitHub
 (13 commenti) (4 reazioni) (0 assegnatari)Python (44.809 star) (16.781 fork)batch import
area:APIgood first issuekind:documentationkind:feature

Descrizione

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.

Guida contributor

Tech stack
pythonfastapi
Dominio
apidocumentationauthorization
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
4
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
over 1 week
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
blocked
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
mostly clear
Prerequisiti
Authentication and permissions implemented (issue #42360)Familiarity with FastAPI and Airflow APIExperience with documentation generation tools
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
15
Direzione di ricerca
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.