Plots2: Documentación del sistema de tokens para escribir API

Hola @jywarren, ¿ puedo trabajar en eso?

¡Seguro, gracias!

Perdón por no documentar la función en ese momento, ya que tenía prisa por completar las tareas en la línea de tiempo. ¡Gracias por ofrecerte como voluntario para trabajar en ello, @ namangupta01! Me encantaría revisarlo una vez que termine de documentarlo.

¡No hay problema! ¡Trabajo en equipo!

@ryzokuken ¡ Gracias! :)

@jywarren @ryzokuken Así que estaba trabajando en este problema, me preguntaba si solo tengo que documentar los comentarios a través del token, es decir, https://github.com/publiclab/plots2/pull/1513/files .

@ namangupta01 ¡correcto! Este es el PR donde realmente escribí el código para comentar a través de un token.

¡Hola a todos! ¿Puedo ayudar con esto también? ¿Cómo va hasta ahora? Estaba pensando en comenzar a escribir la documentación del token para familiarizarme más con la API.

@stefannibrasil Creo que esto está abandonado por ahora, por lo que puede sentirse libre de seguir adelante y trabajar en esto. Háganos saber si tiene algún problema.

Gracias, @ryzokuken . Comenzaré a trabajar en la documentación de la función del token esta semana. Voy a ver algunos ejemplos y os lo haré saber, claro. ¡Gracias por la ayuda!

@ sukhbir-singh, ¿quieres empezar a trabajar en esto también? Podemos comparar nuestro trabajo más tarde.

¡Si! seguro: sonrisa:
@stefannibrasil estás activo en gitter ??

¡ Hola @jywarren y @ryzokuken! Después de leer más los documentos proporcionados aquí, tengo algunas preguntas que hacer:

• Los archivos en la carpeta app/api/src/ son los documentos que usa Swagger para generar la interfaz , ¿verdad?

• Para generar la documentación para la autenticación del token, ¿necesito crear un nuevo archivo en la carpeta mencionada anteriormente, que muestre cómo funciona la acción de creación de CommentController?

Eso es lo que entiendo hasta ahora. Le agradecería que me diera un poco más de información al respecto. ¡Gracias!

@stefannibrasil por ahorrar tiempo y esfuerzo, había evitado hacer que la acción "comentar sobre tokens" fuera parte de la especificación de la API Swagger existente, y había creado una función independiente en el código base de Rails (en CommentController , estás derecha) e hice una ruta para eso.

No creo que Swagger te permita documentar funciones externas, pero podría estar equivocado.
Entonces, creo que debería agregar algo de documentación usted mismo en doc/api.md en formato de rebajas, explicando un poco cómo funciona la función y cómo esperamos que los usuarios agreguen sus propios comentarios usando este punto final.

Espero que quede claro, no dude en pedir una aclaración sobre esto.

¡Eso tiene sentido, gracias! Después de mirar más a los documentos y cómo escribir documentos API, agregué algunos cambios a este PR . No estoy seguro de si ese es el tipo de documentación que estaba solicitando.

Agregué mis preguntas en la descripción, ¿podrían echar un vistazo y ver si pueden ayudarme?

No pude encontrar mucha documentación sobre el token, también puedes decirme dónde buscar más, ¡eso ayudaría! :)

@ sukhbir-singh lo siento, no estoy en gitter, pero si quieres, también puedes contribuir en las relaciones públicas, eso sería genial.

@stefannibrasil puede ver este video para una demostración que muestra cómo usar cartero para hacer solicitudes en la API de comentarios. :globo:

Genial, ¿está completo o hay más cosas que podríamos decir sobre este? ¡Siéntete libre de cerrarlo si está listo! ¡¡¡Gracias a todos!!!

En realidad, tal vez podamos agregar un par de adiciones, por ejemplo, ¿podríamos refinar POST https://publiclab.org/comment/create/token/id.:format a POST https://publiclab.org/comment/create/token/id.json para mostrar que puede especificar el formato de esa manera? ¿Y tal vez deberíamos vincularnos a dónde está el código API del token en la fuente?

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

@jywarren +1, eso suena perfecto.

¡Hola a todos! ¡Estos son buenos puntos, gracias! El PR ya estaba fusionado, agregaré esto y crearé otro luego =)

Además, gracias @ sukhbir-singh, ¡gracias por toda la ayuda aquí!

No hay problema...!! Feliz de ayudar. Soy muy activo en github, gitter e irc, puedes hacer ping allí si necesitas ayuda en cualquier caso. : smiley: