apache/airflow

Automate reference doc creation for stable API permissions

Fermée

#10 937 ouverte le 14 sept. 2020

Voir sur GitHubGuide contributeur
 (5 commentaires) (0 réaction) (0 personne assignée)Python (16 781 forks)batch import
area:APIgood first issuekind:documentationkind:task

Métriques du dépôt

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

Description

Description We should find a way to create automated documentation of required permissions for stable API endpoints.

Use case / motivation

Right now the process of documenting which permissions are needed for which API endpoints is entirely manual, which is error prone and likely to get out of date.

Guide contributeur

Direction de recherche
Étudiez le processus manuel actuel de documentation des autorisations d'API dans Apache Airflow. Examinez les définitions de points de terminaison d'API existantes dans le code source (par exemple, airflow/api connexion/endpoints/) et le modèle d'autorisations (airflow/security/permissions.py). Déterminez comment les autorisations sont associées aux points de terminaison. Proposez un script ou une approche pour générer automatiquement la documentation basée sur cette correspondance. Envisagez d'utiliser un script Python qui analyse les définitions de points de terminaison et extrait les autorisations requises, en produisant un résultat dans un format comme Markdown. Vérifiez les discussions existantes dans les commentaires de l'issue (3 commentaires) pour un contexte supplémentaire.
Stack technique
pythonrest api
Domaine
apidocumentation
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.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
Basic understanding of Airflow APIKnowledge of Python scripting
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60