apache/airflow

Automate reference doc creation for stable API permissions

Chiusa

#10.937 aperta il 14 set 2020

Vedi su GitHubGuida contributor
 (5 commenti) (0 reazioni) (0 assegnatari)Python (16.781 fork)batch import
area:APIgood first issuekind:documentationkind:task

Metriche repository

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

Descrizione

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.

Guida contributor

Direzione di ricerca
Indaga sul processo manuale attuale per documentare le autorizzazioni API in Apache Airflow. Esamina le definizioni degli endpoint API esistenti nel codice sorgente (ad es., airflow/api connexion/endpoints/) e il modello delle autorizzazioni (airflow/security/permissions.py). Determina come le autorizzazioni sono associate agli endpoint. Proponi uno script o un approccio per generare automaticamente la documentazione basata su tale mappatura. Considera l'uso di uno script Python che analizzi le definizioni degli endpoint ed estragga le autorizzazioni richieste, producendo un output in un formato come Markdown. Controlla eventuali discussioni esistenti nei commenti dell'issue (3 commenti) per ulteriore contesto.
Tech stack
pythonrest api
Dominio
apidocumentation
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.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
Basic understanding of Airflow APIKnowledge of Python scripting
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60