apache/airflow

Automate reference doc creation for stable API permissions

已關閉

#10,937 建立於 2020年9月14日

在 GitHub 查看貢獻者指南
 (5 則留言) (0 個反應) (0 位負責人)Python (16,781 個分叉)batch import
area:APIgood first issuekind:documentationkind:task

倉庫指標

星標
 (44,809 顆星)
PR 合併指標
 (平均合併 7天 18小時) (30 天內合併 834 個 PR)

描述

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.

貢獻者指南

研究方向
調查 Apache Airflow 中記錄 API 權限的當前手動流程。查看原始碼中的現有 API 端點定義（例如 airflow/api connexion/endpoints/）和權限模型（airflow/security/permissions.py）。確定權限如何與端點關聯。提出一種基於該映射自動生成文件的腳本或方法。考慮使用 Python 腳本解析端點定義並擷取所需權限，以 Markdown 等格式輸出。檢查議題評論（3 條評論）中的任何現有討論以獲取額外上下文。
技術棧
pythonrest api
領域
apidocumentation
議題類型
功能
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
半天
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
新近可參與
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
大致清晰
前置要求
Basic understanding of Airflow APIKnowledge of Python scripting
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60