Plots2: Dokumentation des Token-Systems für Schreib-API

Hey @jywarren kann ich daran arbeiten?

Auf jeden Fall, danke!

Es tut mir leid, dass ich die Funktion zu diesem Zeitpunkt nicht dokumentiert habe, da ich es eilig hatte, die Aufgaben auf der Zeitleiste abzuschließen. Vielen Dank für Ihre freiwillige Mitarbeit, @namangupta01! Ich würde es gerne überprüfen, wenn Sie mit der Dokumentation fertig sind.

Überhaupt kein Problem! Zusammenarbeit!

@ryzokuken Danke! :)

@jywarren @ryzokuken Also habe ich an diesem Problem gearbeitet, ich habe mich gefragt, ob ich nur Kommentare über Token dokumentieren muss, dh https://github.com/publiclab/plots2/pull/1513/files ?

@namangupta01 richtig! Dies ist die PR, in der ich tatsächlich den Code zum Kommentieren über ein Token geschrieben habe.

Hallo allerseits! Kann ich auch dabei helfen? Wie geht es soweit? Ich dachte darüber nach, die Token-Dokumentation zu schreiben, um mich besser mit der API vertraut zu machen.

@stefannibrasil Ich denke, das ist gerne weitermachen und daran arbeiten. Lassen Sie es uns wissen, wenn Sie Probleme haben.

Danke @ryzokuken Ich werde diese Woche mit der Dokumentation des Token-Features beginnen. Ich werde mir einige Beispiele ansehen und Sie natürlich alles wissen lassen. Danke für die Hilfe!

@sukhbir-singh willst du auch daran arbeiten? Wir können unsere Arbeit später vergleichen.

Ja! klar :lächeln:
@stefannibrasil bist du auf

HALLO @jywarren und @ryzokuken! Nachdem ich die hier bereitgestellten Dokumente mehr gelesen habe, habe ich einige Fragen zu stellen:

• Die Dateien im Ordner app/api/src/ sind die Dokumente, die Swagger verwendet, um das Interface zu generieren, oder?

• Um die Dokumentation für die Token-Authentifizierung zu generieren, muss ich im oben genannten Ordner eine neue Datei erstellen, die zeigt, wie die Aktion CommentController create funktioniert?

So habe ich es bisher verstanden. Ich würde mich freuen, wenn Sie dazu ein wenig mehr Informationen geben könnten. Vielen Dank!

@stefannibrasil, um Zeit und Mühe zu sparen, habe ich es vermieden, die Aktion "Token kommentieren" in die vorhandene Swagger-API-Spezifikation aufzunehmen, und eine eigenständige Funktion in der Rails-Codebasis erstellt (in CommentController , du bist rechts) und eine Route dafür erstellt.

Ich glaube nicht, dass Swagger es Ihnen erlaubt, externe Funktionen zu dokumentieren, aber ich könnte mich irren.
Ich denke, Sie sollten einfach selbst etwas Dokumentation in doc/api.md im Markdown-Format hinzufügen, ein wenig erklären, wie die Funktion funktioniert und wie wir erwarten, dass Benutzer ihre eigenen Kommentare mit diesem Endpunkt hinzufügen.

Ich hoffe, das macht es klar, zögern Sie nicht, um Klärung zu bitten.

Das macht Sinn, danke! Nachdem ich mir die Dokumentation und das Schreiben von API-Dokumenten genauer angeschaut habe, habe ich einige Änderungen an dieser PR vorgenommen . Ich bin mir nicht sicher, ob das die Art von Dokumentation ist, die Sie angefordert haben.

Ich habe meine Fragen in der Beschreibung hinzugefügt, könnten Sie bitte einen Blick darauf werfen und sehen, ob Sie mir helfen können?

Ich konnte nicht viel Dokumentation über das Token finden, Sie können mir auch sagen, wo ich mehr suchen kann, das würde helfen! :)

@sukhbir-singh sorry, ich bin nicht auf gitter, aber wenn du willst kannst du auch in der PR mitwirken, das wäre super.

@stefannibrasil Sie können dieses Video für eine Demo ansehen , die zeigt, wie Sie den Postman verwenden, um Anfragen an die Kommentar-API zu stellen. :Ballon:

Großartig, ist das vollständig, oder könnten wir noch mehr darüber sagen? Fühlen Sie sich frei, es zu schließen, wenn es fertig ist! Danke, alle!!!

Vielleicht können wir ein paar Ergänzungen hinzufügen – könnten wir beispielsweise POST https://publiclab.org/comment/create/token/id.:format auf POST https://publiclab.org/comment/create/token/id.json verfeinern, um zu zeigen, dass Sie das Format so angeben können. Und vielleicht sollten wir darauf verlinken, wo sich der Token-API-Code im Quellcode befindet?

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

@jywarren +1, das klingt perfekt.

Hallo allerseits! Das sind gute Punkte, danke! Der PR wurde bereits zusammengeführt, ich füge diesen hinzu und erstelle dann einen anderen =)

Danke auch @sukhbir-singh danke für all die Hilfe hier!

Kein Problem...!! Freue mich zu helfen. Ich bin sehr aktiv auf github, gitter und irc, du kannst mich dort weiter anpingen, wenn du auf jeden Fall Hilfe brauchst. :smiley: