apache/airflow

Automate reference doc creation for stable API permissions

クローズ

#10,937 opened on 2020/09/14

GitHub で見るコントリビューターガイド
 (5 件のコメント) (0 件のリアクション) (0 人の担当者)Python (16,781 件のフォーク)batch import
area:APIgood first issuekind:documentationkind:task

Repository metrics

Stars
 (44,809 個のスター)
PR merge metrics
 (平均マージ 7d 18h) (30d で 834 merged PRs)

説明

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）を確認する。権限がエンドポイントにどのように関連付けられているかを特定する。そのマッピングに基づいてドキュメントを自動生成するスクリプトまたはアプローチを提案する。エンドポイント定義を解析し、必要な権限を抽出して Markdown などの形式で出力する Python スクリプトの使用を検討する。追加のコンテキストを得るために、Issue コメント（3 件）内の既存の議論を確認する。
技術スタック
pythonrest api
領域
apidocumentation
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
半日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
新着
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
おおむね明確
前提条件
Basic understanding of Airflow APIKnowledge of Python scripting
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
60