Skip to content

docs(backend): operational endpoints, prekey replenishment, key material, socket event guide - #647

Merged
codebestia merged 1 commit into
codebestia:devfrom
0xDeon:docs/backend-operational-prekey-keys-socket
Oct 20, 2026
Merged

codebestia merged 1 commit into
codebestia:devfrom
0xDeon:docs/backend-operational-prekey-keys-socket

Conversation

@0xDeon

@0xDeon 0xDeon commented Oct 20, 2026

Copy link
Copy Markdown
Contributor

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.md is stale (legacy raw emit, 24h replay TTL) and was left unchanged.

Closes #623
Closes #621
Closes #620
Closes #616

@drips-wave

drips-wave Bot commented Oct 20, 2026

Copy link
Copy Markdown

@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! 🚀

Learn more about application limits

@codebestia
codebestia merged commit bf520de into codebestia:dev Oct 20, 2026
2 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants