Plots2: Documentação do sistema de token para escrever API

Ei @jywarren, posso trabalhar nisso?

Com certeza, obrigado!

Desculpe por não documentar o recurso naquele momento, pois estava com pressa para concluir as tarefas na linha do tempo. Obrigado por se voluntariar para trabalhar nisso, @ namangupta01! Eu adoraria revisá-lo assim que você terminar de documentar.

Não tem problema nenhum! Trabalho em equipe!

@ryzokuken Obrigado! :)

@jywarren @ryzokuken Então, eu estava trabalhando neste problema, https://github.com/publiclab/plots2/pull/1513/files ?

@ namangupta01 correto! Este é o PR onde realmente escrevi o código para comentar por meio de um token.

Oi pessoal! Posso ajudar com isso também? Como está indo até agora? Eu estava pensando em começar a escrever a documentação do token para me familiarizar mais com a API.

@stefannibrasil Eu acho que isso está abandonado por enquanto, então você pode ficar à vontade para ir em frente e trabalhar nisso. Deixe-nos saber se você enfrentar qualquer problema.

Obrigado, @ryzokuken . Vou começar a trabalhar na documentação do recurso de token esta semana. Vou ver alguns exemplos e vou deixar você saber de tudo, é claro. Obrigado pela ajuda!

@ sukhbir-singh, você quer começar a trabalhar nisso também? Podemos comparar nosso trabalho mais tarde.

Isso! claro: sorria:
@stefannibrasil você é ativo no gitter ??

HI @jywarren e @ryzokuken! Depois de ler mais os documentos fornecidos aqui, tenho algumas perguntas a fazer:

• Os arquivos na pasta app/api/src/ são os documentos que o Swagger usa para gerar a Interface , certo?

• Para gerar a documentação para a autenticação do token, preciso criar um novo arquivo na pasta mencionada acima, mostrando como funciona a ação de criação do CommentController?

Isso é o que eu entendi até agora. Eu agradeceria se você pudesse dar um pouco mais de informações sobre isso. Obrigado!

@stefannibrasil para economizar tempo e esforço, evitei tornar a ação "comentar sobre tokens" parte da especificação da API Swagger existente e fiz uma função autônoma no código-base do Rails (em CommentController , você está direito) e fiz um percurso para isso.

Eu não acho que Swagger permite documentar funções externas, mas eu poderia estar errado.
Portanto, acredito que você deva apenas adicionar alguma documentação sozinho em doc/api.md no formato markdown, explicando um pouco como a função funciona e como esperamos que os usuários adicionem seus próprios comentários usando este endpoint.

Espero que tenha ficado claro, fique à vontade para pedir esclarecimentos sobre qualquer assunto.

Isso faz sentido, obrigado! Depois de examinar mais os documentos e como escrever documentos de API, adicionei algumas alterações a este PR . Não tenho certeza se esse é o tipo de documentação que você estava pedindo.

Eu adicionei minhas perguntas na descrição, você poderia dar uma olhada e ver se você pode me ajudar?

Não consegui encontrar muita documentação sobre o token, você pode me dizer onde procurar mais, isso ajudaria! :)

@ sukhbir-singh desculpe, não estou no gitter, mas se quiser, pode contribuir no PR também, seria ótimo.

@stefannibrasil você pode conferir este vídeo para demonstração mostrando como usar o carteiro para fazer solicitações na API de comentários. :balão:

Ótimo, isso está completo ou há mais coisas que podemos falar sobre isso? Sinta-se à vontade para fechá-lo se estiver pronto! Obrigado a todos !!!

Na verdade, talvez possamos adicionar algumas adições - como, poderíamos refinar POST https://publiclab.org/comment/create/token/id.:format para POST https://publiclab.org/comment/create/token/id.json para mostrar que você pode especificar o formato assim. E talvez devêssemos fazer um link para onde o código da API de token está na fonte?

https://github.com/publiclab/plots2/blob/master/app/controllers/comment_controller.rb#L48 -L73

@jywarren +1, parece perfeito.

Ei, pessoal! Esses são pontos bons, obrigado! O PR já foi mesclado, vou adicionar isso e criar outro então =)

Além disso, obrigado @ sukhbir-singh obrigado por toda a ajuda aqui!

Sem problemas...!! Feliz por ajudar. Eu sou muito ativo no github, gitter e irc, você pode me pingar mais lá se precisar de ajuda em qualquer caso. :risonho: