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 (16 781 forks)batch import
area:APIgood first issuekind:documentationkind:feature

Métriques du dépôt

Stars
 (44 809 stars)
Métriques de merge PR
 (Merge moyen 7j 18h) (834 PRs mergées en 30 j)

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

Direction de recherche
Examinez le problème lié pour les détails de l'implémentation de l'authentification, puis concevez une méthode pour détecter et documenter automatiquement les autorisations API pour chaque route en utilisant les fonctionnalités de FastAPI, en assurant la synchronisation avec le swagger et la documentation existants.
Stack technique
pythonfastapi
Domaine
backenddocumentation
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
PythonFastAPIauthentication
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40