Repository navigation
feat: use readable payload and signature names in signed envelopes - #46
Merged
Merged
Conversation
- Buddies and accounts signed envelopes now use `payload` and `signature` instead of `p` and `s` - Headers renamed to `x-buddies-payload`/`x-buddies-signature` and `x-ww-payload`/`x-ww-signature` - Legacy `p`/`s` fields and `x-buddies-p`/`-s`, `x-ww-p`/`-s` headers still accepted for shipped builds; the long name wins if both are sent - OpenAPI docs, protocol doc, README, AGENTS.md, and verify scripts updated to the new names - AGENTS.md and README gain API naming guidance: spell out names, never add new short names
leviFrosty
force-pushed
the
docs/readable-api-keys
branch
from
October 16, 2026 04:02
a90a9f6 to
5ddcf5d
Compare
leviFrosty
added a commit
that referenced
this pull request
Oct 18, 2026
- feat: Supporter status on the server account, kept by RevenueCat webhooks (#51) - feat: account activity log and signed-in devices (#50) - feat: attested account sessions with bearer tokens for Buddies and Notes Import (#49) - feat: move attestation to /attestation/v1 and add readable link paths (#47) - feat: use readable payload and signature names in signed envelopes (#46) - docs: trim one-time setup steps from the agent guide (#48)
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.
Summary
payloadandsignatureinstead ofpands.x-buddies-payload/x-buddies-signatureandx-ww-payload/x-ww-signature.invite/fetch,invite/claim,blob/get) take{ "payload": … }.p/s,x-buddies-p/-s, andx-ww-p/-sare still accepted for shipped app builds. When both spellings are present, the long name wins.signedBodytables),docs/buddies-protocol.md, README, and AGENTS.md. AGENTS.md gains an "API design: readable, standard REST" section, and the README gains an open-source/open-API note.x-buddies-*andx-ww-*header names.Testing
src/buddies/envelope.test.ts,live.test.ts,relay.test.ts,blobs.test.ts,src/accounts/accounts.test.ts,backup.test.ts(adds a legacyx-ww-p/x-ww-sacceptance case),handoff.test.ts, andsrc/sentry.test.ts.src/e2e/accounts.e2e.test.ts.pnpm testpnpm exec tsc --noEmitwrangler deploy --dry-runandwrangler deploy --env dev --dry-runpnpm test:e2e(via theverify-ww-apiloop)pnpm fuzz:buddiesp/sstill works against the dev worker. Use a real device if App Attest is involved.