apache/airflow

AIP-84 Sync documentation and permissions

Open

#43.430 aperta il 28 ott 2024

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

Metriche repository

Star
 (44.809 star)
Metriche merge PR
 (Merge medio 7g 18h) (834 PR mergiate in 30 g)

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

Direzione di ricerca
Rivedi il problema collegato per i dettagli sull'implementazione dell'autenticazione, quindi progetta un metodo per rilevare e documentare automaticamente le autorizzazioni API per ogni route utilizzando le funzionalità di FastAPI, garantendo la sincronizzazione con il swagger e la documentazione esistenti.
Tech stack
pythonfastapi
Dominio
backenddocumentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
PythonFastAPIauthentication
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40