NodeBB / NodeBB/nodebb-plugin-write-api
Return data not documented
Aperta
Nessuno ha ancora preso questa issue.
- Lingua principale
- JavaScript
- Stelle
- 136
- Fork
- 75
- Merge medio
- 1m
- PR unite (30g)
- 8
Descrizione
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?
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
La issue riguarda gli endpoint della RESTful JSON API; inizia facendo l'inventario di ogni endpoint e verificando il comportamento attuale delle risposte. Documenta l'oggetto restituito per azioni come la creazione di topic, quindi verifica che la documentazione copra ogni endpoint e corrisponda alle risposte osservate.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript
- Ambito
- api, documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100