Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Return data not documented

Open
#74 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
javascript
Domain
api, documentation

Research direction

The issue concerns the RESTful JSON API endpoints; start by inventorying each endpoint and checking its current response behavior. Document the returned object for actions such as topic creation, then verify the documentation covers every endpoint and matches the observed responses.

Written by the indexing model from the issue text.

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?

Dominant language
JavaScript
Stars
136
Forks
75
Avg merge
1m
Merged PRs (30d)
8

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from NodeBB/nodebb-plugin-write-api

All issues in NodeBB/nodebb-plugin-write-api

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.