Return data not documented

Offen

#74 erstellt am 03.7.2017 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 4/5
Geschätzter Aufwand: 3-5 Tage
Anfängerfreundlichkeit: 35/100

Issue-Typ: Dokumentation
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: javascript
Bereich: api, documentation

Rechercherichtung

Das Issue betrifft die RESTful-JSON-API-Endpunkte; beginne damit, jeden Endpunkt zu inventarisieren und sein aktuelles Antwortverhalten zu überprüfen. Dokumentiere das zurückgegebene Objekt für Aktionen wie die Erstellung eines Topics und überprüfe anschließend, dass die Dokumentation jeden Endpunkt abdeckt und mit den beobachteten Antworten übereinstimmt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Assuming this is a thing, I don't see any documentation for it. What data is returned for each endpoint? For example, if I create a topic, what object is returned?

Vorherrschende Sprache: JavaScript
Sterne: 136
Forks: 75
Ø Merge: 1 Min.
Gemergte PRs (30 T.): 8

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus NodeBB/nodebb-plugin-write-api

Dependency Dashboard Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 20/100

NodeBB/nodebb-plugin-write-api#150 · Erstellt am 11.11.2021
Follow logic is backwards Offen

bug

NodeBB/nodebb-plugin-write-api#130 · 1 Kommentar · 1 zugewiesene Person · Erstellt am 14.7.2020
Create User from Node.js Failure. Offen

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 35/100

NodeBB/nodebb-plugin-write-api#127 · 3 Kommentare · Erstellt am 08.6.2020
Token generation api responses time out Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100

NodeBB/nodebb-plugin-write-api#118 · 4 Kommentare · Erstellt am 23.2.2020
There is no POST /posts/:pid/bookmark in v2 API document Offen

enhancement

NodeBB/nodebb-plugin-write-api#87 · 5 Kommentare · 1 zugewiesene Person · Erstellt am 20.12.2017

Alle Issues in NodeBB/nodebb-plugin-write-api