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