Skip to content
This repository has been archived by the owner on May 28, 2023. It is now read-only.

Adicionar documentação das rotas do Laguinho #55

Open
lucasmedeiros opened this issue Oct 1, 2019 · 4 comments
Open

Adicionar documentação das rotas do Laguinho #55

lucasmedeiros opened this issue Oct 1, 2019 · 4 comments
Labels
good first issue Good for newcomers melhoria Nova funcionalidade ou sugestão novo laguinho Issues relacionadas à reformulação do laguinho

Comments

@lucasmedeiros
Copy link
Contributor

lucasmedeiros commented Oct 1, 2019

É necessário adicionar documentação das rotas disponibilizadas pela API (código da branch development, para mais informações consulte a issue de reformulação do laguinho), seguindo o PEP8. No momento, as rotas que temos são:

  • GET /datasets: rota para recuperar todos os conjuntos de dados publicados.
  • POST /datasets: rota para cadastrar/publicar um novo conjunto de dados de um repositório no Github.
  • GET /datasets/nome_dataset: rota que recupera informações (metadados) de um conjunto de dados publicado a partir de seu nome.
@lucasmedeiros lucasmedeiros added melhoria Nova funcionalidade ou sugestão good first issue Good for newcomers labels Oct 1, 2019
@lucasmedeiros lucasmedeiros added hacktoberfest novo laguinho Issues relacionadas à reformulação do laguinho labels Oct 1, 2019
@ItaloSa
Copy link

ItaloSa commented Oct 3, 2019

Olá, gotaria de ajudar. Posso pegar essa issue? Também gostaria de participar da discussão, haha 😄

@lucasmedeiros
Copy link
Contributor Author

@ItaloSa Claro! 😄

Qualquer dúvida/sugestão que tiver, pode falar comigo por essa issue. Vou te dar assign, ok?

@paulojbleitao
Copy link
Contributor

Olá @ItaloSa, se estiver precisando de ajuda ou estiver com dúvidas só falar! Costumamos discutir pelo discord, entra lá 😉

@JoseRenan
Copy link
Member

Acho que ficou meio em aberto também como a gente pensava em fazer a documentação, mas é mais porque estamos abertos a sugestões também. Na antiga versão do laguinho, a gente tava colocando tudo nums readme mesmo 🤔 mas a gente poderia pensar em algo mais bonitinho também, como o https://docusaurus.io ou um https://swagger.io/ da vida 🤔 o que acham?

@ItaloSa ItaloSa removed their assignment Nov 21, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
good first issue Good for newcomers melhoria Nova funcionalidade ou sugestão novo laguinho Issues relacionadas à reformulação do laguinho
Projects
None yet
Development

No branches or pull requests

4 participants