Plots2: Dokumentasi sistem token untuk menulis API

Hei @jywarren bisakah saya mengerjakannya?

Yang pasti, terima kasih!

Maaf karena tidak mendokumentasikan fitur pada saat itu karena saya sedang terburu-buru untuk menyelesaikan tugas di timeline. Terima kasih telah menjadi sukarelawan untuk mengerjakannya, @namangupta01! Saya akan senang untuk meninjaunya setelah Anda selesai mendokumentasikan.

Tidak ada masalah sama sekali! Kerja tim!

@ryzokuken Terima kasih! :)

@jywarren @ryzokuken Jadi saya sedang mengerjakan masalah ini, saya bertanya-tanya apakah saya hanya perlu mendokumentasikan tentang komentar melalui token yaitu https://github.com/publiclab/plots2/pull/1513/files ?

@namangupta01 benar! Ini adalah PR di mana saya benar-benar menulis kode untuk berkomentar melalui token.

Halo semuanya! Bisakah saya membantu dengan ini juga? Bagaimana perkembangannya sejauh ini? Saya sedang berpikir untuk mulai menulis dokumentasi token untuk lebih mengenal API.

@stefannibrasil Saya pikir ini ditinggalkan untuk saat ini, jadi Anda mungkin merasa bebas untuk melanjutkan dan mengerjakan ini. Beri tahu kami jika Anda menghadapi masalah.

Terima kasih, @ryzokuken Saya akan mulai mendokumentasikan fitur token minggu ini. Saya akan melihat beberapa contoh dan saya akan memberi tahu Anda apa saja, tentu saja. Terima kasih untuk bantuannya!

@sukhbir-singh apakah Anda ingin mulai mengerjakan ini juga? Kita bisa membandingkan pekerjaan kita nanti.

Ya! pasti :senyum:
@stefannibrasil kamu aktif di gitter??

HI @jywarren dan @ryzokuken! Setelah membaca lebih banyak dokumen yang disediakan di sini, saya memiliki beberapa pertanyaan untuk diajukan:

• File di folder app/api/src/ adalah dokumen yang digunakan Swagger untuk menghasilkan Interface , bukan?

• Untuk menghasilkan dokumentasi untuk otentikasi token, apakah saya perlu membuat file baru di folder yang disebutkan di atas, yang menunjukkan cara kerja tindakan membuat CommentController?

Itu yang saya pahami selama ini. Saya akan sangat menghargai jika Anda dapat memberikan sedikit lebih banyak informasi tentang itu. Terima kasih!

@stefannibrasil untuk menghemat waktu dan tenaga, saya telah menghindari membuat tindakan "mengomentari token" sebagai bagian dari spesifikasi API Swagger yang ada, dan telah membuat fungsi mandiri di basis kode Rails (dalam CommentController , Anda kanan) dan membuat rute untuk itu.

Saya tidak berpikir Swagger memungkinkan Anda untuk mendokumentasikan fungsi eksternal, tetapi saya mungkin salah.
Jadi, saya yakin Anda harus menambahkan beberapa dokumentasi sendiri di doc/api.md dalam format penurunan harga, menjelaskan sedikit bagaimana fungsi tersebut bekerja dan bagaimana kami mengharapkan pengguna untuk menambahkan komentar mereka sendiri menggunakan titik akhir ini.

Saya harap itu membuatnya jelas, jangan ragu untuk meminta klarifikasi tentang semua ini.

Itu masuk akal, terima kasih! Setelah melihat lebih banyak dokumen dan cara menulis dokumen API, saya menambahkan beberapa perubahan pada PR ini. Saya tidak yakin apakah itu jenis dokumentasi yang Anda minta.

Saya menambahkan pertanyaan saya di deskripsi, bisakah Anda melihat dan melihat apakah Anda dapat membantu saya?

Saya tidak dapat menemukan banyak dokumentasi tentang token, Anda dapat memberi tahu saya di mana harus mencari lebih banyak, itu akan membantu! :)

@sukhbir-singh maaf, saya tidak di gitter, tetapi jika Anda mau, Anda dapat berkontribusi dalam PR juga, itu akan bagus.

@stefannibrasil Anda dapat melihat video ini untuk demo yang menunjukkan cara menggunakan tukang pos untuk membuat permintaan di API komentar. :balon:

Bagus, apakah ini lengkap, atau ada lagi yang bisa kita bahas tentang yang satu ini? Jangan ragu untuk menutupnya jika sudah selesai! Terima kasih semuanya!!!

Sebenarnya mungkin kita bisa menambahkan beberapa tambahan -- seperti, bisakah kita memperbaiki POST https://publiclab.org/comment/create/token/id.:format menjadi POST https://publiclab.org/comment/create/token/id.json untuk menunjukkan bahwa Anda dapat menentukan format seperti itu. Dan mungkin kita harus menautkan ke tempat kode API token berada di sumbernya?

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

@jywarren +1, itu terdengar sempurna.

Hai semuanya! Ini adalah poin yang bagus, terima kasih! PR sudah digabung, saya akan menambahkan ini dan membuat yang lain kemudian =)

Juga, terima kasih @sukhbir-singh terima kasih atas semua bantuannya di sini!

Tidak masalah...!! Saya senang bisa membantu. Saya sangat aktif di github, gitter dan irc, Anda dapat ping saya di sana lebih lanjut jika Anda memerlukan bantuan dalam hal apapun. :senyum: