nextcloud / nextcloud/notifications
Push notifications documentation wrong
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 153
- Forks
- 67
- Avg merge
- 15h 3m
- Merged PRs (30d)
- 96
Description
The documentation about subscribing at the push proxy is wrong. It shows that you have to send a json object as body (https://github.com/nextcloud/notifications/blob/master/docs/push-v2.md#L135), but actually you have to send urlencoded parameters.
This is totally irritating and I put a lot of time into investigating why my library wasn't working.
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
Open docs/push-v2.md around line 135 and review the push proxy subscription example. Update the documentation to show urlencoded parameters rather than a JSON body; it is done when the example matches the actual subscription request format.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100