NodeBB / NodeBB/nodebb-plugin-write-api
Return data not documented
Ouverte
Personne n'a encore pris cette issue.
- Langage dominant
- JavaScript
- Étoiles
- 136
- Forks
- 75
- Merge moyen
- 1 min
- PR mergées (30 j)
- 8
Description
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?
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
L'issue concerne les endpoints de la RESTful JSON API ; commence par répertorier chaque endpoint et vérifier le comportement actuel de ses réponses. Documente l'objet renvoyé pour des actions telles que la création de topics, puis vérifie que la documentation couvre chaque endpoint et corresponde aux réponses observées.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- javascript
- Domaine
- api, documentation
- Type d'issue
- Documentation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100