mattermost / mattermost/mattermost-developer-documentation
Help Wanted: Make API docs more clear about what fields are returned
Open
Nobody has claimed this yet.
difficulty/2:Medium
Help Wanted
Needs Documentation
Up For Grabs
- Dominant language
- CSS
- Stars
- 90
- Forks
- 460
- Avg merge
- 9d 23h
- Merged PRs (30d)
- 2
Description
Mattermost user paul.rothrock from https://community.mattermost.com has requested the following be documented:
> Yeah theres a few endpoints where the docs show a field in the return, but the API always removes it, so its always empty. See the config endpoints for more examples.
We were looking into how to lookup the current session, and the API docs just say a string is returned, but the actual endpoint returns an empty string.
See the original post here.
This issue was generated from Mattermost using the Doc Up plugin.
Contributor guide
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
Start by reviewing the API documentation for the config endpoints and the current-session lookup mentioned in the report, then compare the documented response fields with the behavior described by the reporter. Done means the affected endpoint docs accurately state which fields are returned and when values are empty.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100