Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Documentação da API #173

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Conversation

jessicapaz
Copy link
Contributor

Comecei a fazer uma documentação bem simples só pra descrever os endpoints e as query string parameters. Se algo estiver incorreto ou se tiver um jeito melhor pra fazer isso só falar que eu altero :)

@turicas
Copy link
Owner

turicas commented Jul 3, 2019

Obrigado pelo PR, @jessicapaz!
Estava pensando aqui: temos os metadados de cada dataset no banco de dados (e eles podem mudar com o tempo, tornando a documentação da API incorreta). Que acha de criarmos uma página que pega esses dados no banco e monta a documentação a partir disso? Daí em vez de ser um arquivo markdown, seria uma view do Django com o template. Eu posso ajudar nesse processo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants