turicas/brasil.io

Gerar documentação da API automaticamente

Aperta

#204 aperta il 9 apr 2020

Vedi su GitHub
 (5 commenti) (0 reazioni) (0 assegnatari)Python (150 fork)github user discovery
help wanted

Metriche repository

Star
 (1032 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

Tudo o que precisamos para gerar automaticamente a documentação da API, por tabela, está no banco, nos models Dataset, Version, Table e Field. A documentação da API pode ser uma página dentro do próprio Brasil.IO, com uma descrição geral do dataset e um índice por tabela, bem parecida com a documentação (feita manualmente) do dataset covid19.

Guida contributor

Direzione di ricerca
Esamina i modelli Dataset, Version, Table e Field per estrarre i metadati, quindi genera una pagina simile alla documentazione manuale esistente per covid19.
Tech stack
python
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
Python
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70