Skip to content

[Docs] Update websockets.md: raw-JWT handshake, full enum, dead notification:new #573

Description

@kingksjo

Domain: Realtime / Documentation

Tier: 🟢 Easy

Description:
Auth example sends 'Bearer eyJ…' but socketAuth passes handshake.auth.token straight to verifyToken — Bearer prefix fails handshake (websockets.md:21 vs socketAuth.ts:11–18). Status payload enum lists 4 of 9 statuses (socketEvents.ts:52–61). notification:new documented as joinable but has zero emitters and no join path (io.ts:86–92 only join_shipment/leave_shipment). Nit: .js ref should be .ts. Missing note: every emit also fans out to SSE (io.ts safeFanout calls).

Dependencies: None.

Acceptance Criteria:

  • Four corrections + SSE fanout paragraph.

Testing Requirements:

  • Copy-paste handshake example verified against a running dev server.

PR Checklist:

  • Branch: docs/p3-15-websockets-update

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions