apache/airflow

Automate reference doc creation for stable API permissions

Closed

#10,937 opened on Sep 14, 2020

View on GitHubContributor guide
 (5 comments) (0 reactions) (0 assignees)Python (16,781 forks)batch import
area:APIgood first issuekind:documentationkind:task

Repository metrics

Stars
 (44,809 stars)
PR merge metrics
 (Avg merge 7d 18h) (834 merged PRs in 30d)

Description

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 direction
Investigate the current manual process for documenting API permissions in Apache Airflow. Look at existing API endpoint definitions in the source code (e.g., airflow/api connexion/endpoints/) and the permission model (airflow/security/permissions.py). Determine how permissions are associated with endpoints. Propose a script or approach to automatically generate documentation based on that mapping. Consider using a Python script that parses the endpoint definitions and extracts required permissions, outputting in a format like Markdown. Check any existing discussions in the issue comments (3 comments) for additional context.
Tech stack
pythonrest api
Domain
apidocumentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Basic understanding of Airflow APIKnowledge of Python scripting
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60