NodeBB / NodeBB/nodebb-plugin-write-api
Return data not documented
Abierto
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- JavaScript
- Estrellas
- 136
- Forks
- 75
- Merge medio
- 1 min
- PR fusionados (30 d)
- 8
Descripción
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?
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
El issue concierne a los endpoints de la RESTful JSON API; empieza por inventariar cada endpoint y comprobar su comportamiento actual en las respuestas. Documenta el objeto devuelto para acciones como la creación de topics y, después, verifica que la documentación cubra todos los endpoints y coincida con las respuestas observadas.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- javascript
- Área
- api, documentation
- Tipo de issue
- Documentación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100