pusher / pusher/docs

Pusher Channels Docs | How to authenticate userspage

Open
#314 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
8
Forks
15
PR merge metrics
No merged PRs in 30d

Description

Hello there, I spotted an issue on https://pusher.com/docs/channels/server_api/authenticating-users/

According to the docs, I have to follow the following response code when making authentication handler.

Response
Unsuccessful responses from an authentication endpoint should serve a 403 Forbidden HTTP status.
Successful responses from an authentication endpoint should carry a 200 OK HTTP status and a body of the form

However our backend follows HTTP code semantics.

  • Unauthorized will be sent if the client does not specify the token in the header
  • Forbidden will be sent if the client does not have access
  • Internal Server Error will be sent if there is unexpected error that can't be handled

The documentation saying it only accepts 403 is very limiting. I wonder if the wording is "should" because it'll accept other 4xx error and 5xx error. Please let me know.

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.

Research direction

Start with the Pusher Channels authenticating-users documentation and its Response section. Verify how authentication endpoints handle unauthorized, forbidden, and unexpected-error responses, then clarify the documented status-code requirements and explain what successful completion should say about accepted error responses.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.