apache/airflow

Automate reference doc creation for stable API permissions

Geschlossen

#10.937 geöffnet am 14.09.2020

Auf GitHub ansehenContributor Guide
 (5 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (16.781 Forks)batch import
area:APIgood first issuekind:documentationkind:task

Repository-Metriken

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

Beschreibung

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.

Contributor Guide

Research-Richtung
Untersuche den aktuellen manuellen Prozess zur Dokumentation von API Berechtigungen in Apache Airflow. Betrachte vorhandene API Endpunktdefinitionen im Quellcode (z. B. airflow/api connexion/endpoints/) und das Berechtigungsmodell (airflow/security/permissions.py). Bestimme, wie Berechtigungen mit Endpunkten verknüpft sind. Schlage ein Skript oder einen Ansatz vor, um basierend auf dieser Zuordnung automatisch Dokumentation zu generieren. Erwäge die Verwendung eines Python Skripts, das die Endpunktdefinitionen analysiert und erforderliche Berechtigungen extrahiert, die in einem Format wie Markdown ausgegeben werden. Überprüfe vorhandene Diskussionen in den Issue Kommentaren (3 Kommentare) für zusätzlichen Kontext.
Tech Stack
pythonrest api
Domain
apidocumentation
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.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
Basic understanding of Airflow APIKnowledge of Python scripting
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60