apache/airflow

AIP-84 Sync documentation and permissions

Aberta

#43.430 aberto em 28 de out. de 2024

Ver no GitHubGuia do colaborador
 (13 comentários) (4 reações) (0 responsável)Python (16.781 forks)batch import
area:APIgood first issuekind:documentationkind:feature

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

More context here https://github.com/apache/airflow/issues/43140#issuecomment-2431304177

To avoid additional mismatch between the code and the documentation, we could add a small layer to automatically detect and document the API permissions for each route. Ideally the swagger and maybe also this documentation page should be automatically populated from the FastAPI code.

Note: To be able to work on this, authentication and permissions need to be implemented first.

Committer

  • I acknowledge that I am a maintainer/committer of the Apache Airflow project.

Guia do colaborador

Direção de pesquisa
Revise o problema vinculado para obter detalhes da implementação de autenticação, depois projete um método para detectar e documentar automaticamente as permissões de API para cada rota usando os recursos do FastAPI, garantindo a sincronização com o swagger e a documentação existentes.
Pilha de tecnologia
pythonfastapi
Domain
backenddocumentation
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.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
PythonFastAPIauthentication
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
40