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

Ajustar documentação da API #182

Open
4 tasks
endersonmaia opened this issue Jun 29, 2020 · 1 comment
Open
4 tasks

Ajustar documentação da API #182

endersonmaia opened this issue Jun 29, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@endersonmaia
Copy link
Collaborator

endersonmaia commented Jun 29, 2020

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

É possível fazer manualmente, mas idealmente seria possível automatizar tomando a o arquivo datapackage.json como referência.

@endersonmaia endersonmaia added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Jun 29, 2020
@rodbv
Copy link

rodbv commented Sep 22, 2020

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:

  1. 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?
  2. 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants