NodeBB / NodeBB/nodebb-plugin-write-api
Return data not documented
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 136
- Forks
- 75
- Avg merge
- 1m
- Merged PRs (30d)
- 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?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
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.
Assessment
- Tech stack
- javascript
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100