Plots2: 書き込みAPIのトークンシステムのドキュメント

ねえ@jywarren私はそれに

確かに、ありがとう！

タイムライン上のタスクを急いで完了したため、その時点で機能を文書化していないことをお詫びします。 ボランティアで取り組んでくれてありがとう、@ namangupta01！ 文書化が完了したら、確認したいと思います。

全く問題無い！ チームワーク！

@ryzokukenありがとうございます！ :)

@jywarren @ryzokukenだから私はこの問題に取り組んでいたので、トークン、つまりhttps://github.com/publiclab/plots2/pull/1513/filesを介してコメントについて文書化するだけでよいのだろうかと思っていました。

@ namangupta01正解です！ これは私が実際にトークンを介してコメントするためのコードを書いたPRです。

皆さんこんにちは！ 私もこれを手伝ってもらえますか？ これまでのところどうですか？ APIに慣れるために、トークンのドキュメントを書き始めることを考えていました。

@stefannibrasilこれは今のところ放棄されていると思うので、気軽に進んで作業してください。 問題が発生した場合はお知らせください。

ありがとう、 @ ryzokuken今週からトークン機能のドキュメント化に取り掛かります。 いくつかの例を見ていきます。もちろん、何でもお知らせします。 助けてくれてありがとう！

@ sukhbir-singhこれにも取り組み始めますか？ 後で作業を比較できます。

うん！ 確かに：smile：
@stefannibrasilあなたはgitterで活動していますか？

こんにちは@jywarrenと@ryzokuken！ ここで提供されているドキュメントをさらに読んだ後、いくつか質問があります。

• app/api/src/フォルダー内のファイルは、Swaggerがインターフェイスを生成するために使用するドキュメントです。

• トークン認証のドキュメントを生成するには、CommentControllerの作成アクションがどのように機能するかを示す新しいファイルを上記のフォルダーに作成する必要がありますか？

それが私が今のところ理解していることです。 それについてもう少し情報をいただければ幸いです。 ありがとう！

@stefannibrasilは時間と労力を節約するために、「トークンのコメント」アクションを既存のSwagger API仕様の一部にすることを避け、Railsコードベースでスタンドアロン関数を作成しました（ CommentController 、あなたは右）そしてそのためのルートを作りました。

Swaggerで外部関数を文書化できるとは思いませんが、間違っている
したがって、マークダウン形式でdoc/api.mdドキュメントを自分で追加するだけで、関数の動作と、ユーザーがこのエンドポイントを使用して独自のコメントを追加する方法を少し説明する必要があると思います。

それが明確になることを願っています。これについては、遠慮なく説明を求めてください。

それは理にかなっています、ありがとう！ ドキュメントとAPIドキュメントの書き方を詳しく調べた後、このPRにいくつかの変更を加えました。 それがあなたが求めていた種類の文書であるかどうかはわかりません。

説明に質問を追加しました。ご覧になって、私を助けてくれるかどうか見てください。

トークンに関するドキュメントがあまり見つかりませんでした。どこを見ればよいか教えていただければ助かります。 :)

@ sukhbir-singh申し訳ありませんが、私は苦手ではありませんが、必要に応じて、PRにも貢献できます。それは素晴らしいことです。

@stefannibrasilは、コメントAPIでリクエストを行うためにpostmanを使用する方法を示すデモ用のこのビデオをチェックできます。 ：バルーン：

すばらしいです、これは完全ですか、それともこれについてもっと詳しく説明できますか？ 完了したら、遠慮なく閉じてください。 皆さんありがとう！！！

実際には、いくつかの追加を追加できます。たとえば、 POST https://publiclab.org/comment/create/token/id.:formatをPOST https://publiclab.org/comment/create/token/id.jsonに絞り込んで、そのような形式を指定できることを示すことができます。 そして、トークンAPIコードがソースのどこにあるかにリンクする必要がありますか？

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

@jywarren +1、それは完璧に聞こえます。

こんにちは、みなさん！ これらは良い点です、ありがとう！ PRはすでにマージされているので、これを追加して別のPRを作成してから=）

また、@ sukhbir-singhに感謝します。ここでのすべての助けに感謝します！

問題ない...！！ お力になれて、嬉しいです。 私はgithub、gitter、ircに非常に積極的に取り組んでいます。いずれにせよ助けが必要な場合は、さらにpingを実行できます。 ：スマイリー：