Repository navigation
docs(backend): operational endpoints, prekey replenishment, key material, socket event guide - #647
Merged
codebestia merged 1 commit intoOct 20, 2026
Conversation
…aterial and socket event guides
|
@0xDeon Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This was referenced Oct 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds four backend docs under
apps/backend/docs/:api-operational-endpoints.md: /health, /metrics, /me, /security/transport-policy and the dev-only /local-storage server, with auth, global rate-limit exemption, /health semantics, /metrics protection and the exact /local-storage mount condition.concepts-prekey-replenishment.md: PREKEY_LOW_THRESHOLD, the Redis/in-process latch and what releases it, the prekeys_low event, the 200-key cap and offline-device recovery.contracts-key-material.md: every accepted key type with encoding and byte length, raw vs SPKI conversion, signed-prekey signature coverage, and valid/rejected examples.howto-add-socket-event.md: ordered checklist with worked example, dispatcher pre-handler checks, invariants, error shape, testing and doc updates.Notes found while documenting: the socket rate limiter keys on the Socket.IO event name (
dispatch), so per-type buckets in SOCKET_EVENT_BUCKETS are not effective for dispatched events today;api-websocket-events.mdis stale (legacy raw emit, 24h replay TTL) and was left unchanged.Closes #623
Closes #621
Closes #620
Closes #616