NodeBB / NodeBB/nodebb-plugin-write-api
Return data not documented
Offen
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- JavaScript
- Sterne
- 136
- Forks
- 75
- Ø Merge
- 1 Min.
- Gemergte PRs (30 T.)
- 8
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?
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
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.
Bewertung
- Tech-Stack
- javascript
- Bereich
- api, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100