Ajustar documentação da API
Opened this issue · 1 comments
endersonmaia commented
Na documentação da API, a ordem dos campos não reflete a ordem dos campos definidos em schema/*.csv
nem datapackage.json
.
API doc X CSV Schema
- /caso X caso.csv
- /boletim X boletim.csv
- /caso_full X caso_full.csv
- /obito_cartorio X obito_cartorio.csv
É possível fazer manualmente, mas idealmente seria possível automatizar tomando a o arquivo datapackage.json como referência.
rodbv commented
Olá, quero contribuir com o projeto e vou mandar um PR consertando manualmente pra pelo menos resolver o problema imediato.
Pra uma solução automática eu tenho algumas dúvidas, conforme for eu poderia tentar implementar:
- As descrições na documentação da API são mais detalhadas do que no datapackage.json, então se fosse usar o json como fonte, valeria a pena no respectivo PR sincronizar essas descrições?
- Alguns campos na documentação tem o ícone 🔍 pra indicar que ele aceita query de busca, mas até onde vi isso não é indicado no datapackage.json