Repository navigation
docs: document the Codec / API-version layer (#401) - #763
Merged
s2x merged 5 commits intoOct 24, 2026
Merged
Conversation
…35-document-the-codec-api-version-la # Conflicts: # CHANGELOG.md
…35-document-the-codec-api-version-la # Conflicts: # CHANGELOG.md
s2x
deleted the
docs/issue-401-doc-35-document-the-codec-api-version-la
branch
October 24, 2026 19:43
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.
Description
Closes #401
The docs did not describe the Codec / API-version layer. This change documents it in
docs/architecture.md.Changes
docs/architecture.md: new section "Key encoding and API versions" —CodecInterface,CodecV1,CodecV2,MemComparableCodec,Mode(prefix bytes0x72/0x78), a region-key table by API version and mode, howoptions['apiVersion'](0 and 1 = V1, 2 = V2) and the keyspace select the codec, the exceptions, and thatCodec\is internal.CHANGELOG.md: entry under[Unreleased]/### Fixed.Acceptance criteria notes:
ConnectionFactory, so the docs say V2 is supported.docs/architecture.mdstill advertises shipped features as planned #722, which covers the stale roadmap indocs/architecture.md. The roadmap also changed with [GAP-15] Keep primary locks alive automatically for long transactions #429 (PR feat(txnkv): keep primary locks alive automatically for long transactions (#429) #761).Testing
Documentation only. Every claim was checked against
src/Client/Codec,ConnectionFactory,KeyspaceResolver,RawKvClientandTxnKvClient.Code Review