apache/airflow

Automate reference doc creation for stable API permissions

Fechada

#10.937 aberto em 14 de set. de 2020

Ver no GitHubGuia do colaborador
 (5 comentários) (0 reação) (0 responsável)Python (16.781 forks)batch import
area:APIgood first issuekind:documentationkind:task

Métricas do repositório

Stars
 (44.809 estrelas)
Métricas de merge de PR
 (Mesclagem média 7d 18h) (834 fundiu PRs em 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.

Guia do colaborador

Direção de pesquisa
Investigue o processo manual atual para documentar permissões de API no Apache Airflow. Examine as definições de endpoint de API existentes no código fonte (por exemplo, airflow/api connexion/endpoints/) e o modelo de permissões (airflow/security/permissions.py). Determine como as permissões estão associadas aos endpoints. Proponha um script ou abordagem para gerar automaticamente a documentação com base nesse mapeamento. Considere usar um script Python que analise as definições de endpoint e extraia as permissões necessárias, gerando saída em um formato como Markdown. Verifique quaisquer discussões existentes nos comentários da issue (3 comentários) para contexto adicional.
Pilha de tecnologia
pythonrest api
Domain
apidocumentation
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
Basic understanding of Airflow APIKnowledge of Python scripting
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60