docs: fix S3 adapter key encoding description and routing key placeholder consistency#393
Merged
bootjp merged 2 commits intofeature/s3-compatiblefrom Mar 21, 2026
Merged
Conversation
…key placeholder Co-authored-by: bootjp <1306365+bootjp@users.noreply.github.com> Agent-Logs-Url: https://github.com/bootjp/elastickv/sessions/de638fdd-48cd-443f-91e5-9f0609a58e74
Copilot
AI
changed the title
[WIP] Docs: Add S3-compatible adapter design
docs: fix S3 adapter key encoding description and routing key placeholder consistency
Mar 21, 2026
Owner
|
@copilot what is esc? |
Contributor
Author
So |
bootjp
approved these changes
Mar 21, 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.
Two inaccuracies in the S3 adapter design doc: the segment encoding section described
0x00as the terminator byte (it's actually the escape byte), and the routing key example used inconsistent placeholder names.Changes
Segment encoding (line 154): Corrected to match
encodeDynamoKeySegmentexactly — escape byte0x00, raw0x00encoded as0x00 0xFF, segment terminated by0x00 0x01. Previous text implied0x00was the terminator, which would produce an incompatible encoder.Routing key placeholder (line 226): Standardized
<bucket-enc><gen><object-enc>→<bucket-esc><gen-u64><object-esc>to match the naming convention used throughout the rest of the document.📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.