apache/airflow

AIP-84 Sync documentation and permissions

Open

#43.430 geöffnet am 28. Okt. 2024

Auf GitHub ansehen
 (13 Kommentare) (4 Reaktionen) (0 zugewiesene Personen)Python (16.781 Forks)batch import
area:APIgood first issuekind:documentationkind:feature

Repository-Metriken

Stars
 (44.809 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 7T 18h) (834 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Überprüfen Sie das verknüpfte Issue für Details zur Authentifizierungsimplementierung, entwerfen Sie dann eine Methode zur automatischen Erkennung und Dokumentation von API Berechtigungen für jede Route unter Verwendung von FastAPI Funktionen, um die Synchronisation mit dem vorhandenen Swagger und der Dokumentation sicherzustellen.
Tech Stack
pythonfastapi
Domain
backenddocumentation
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
PythonFastAPIauthentication
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40