docs: add filesystem serdes section#214
Merged
Merged
Conversation
dhegberg
reviewed
Jun 24, 2026
Document the FileSystem serdes as a new section in the serialization reference page. The section covers storage prerequisites (Amazon EFS and Amazon S3 Files), the createFileSystemSerdes signature and FileSystemSerdesConfig, storage modes (ALWAYS and OVERFLOW), path encoding (URI and HASH), the buildPreview helper for inline previews and PII masking, and how to set the serdes as the handler default with configureSerdes. The walkthrough leads with the conservative per-operation StepConfig pattern. Setting it as the handler default lives in its own subsection. Coverage is TypeScript only at this stage. Python and Java tabs link to the parity issues aws-durable-execution-sdk-python#479 and aws-durable-execution-sdk-java#463. Verified against packages/aws-durable-execution-sdk-js/src/utils/serdes/ filesystem-serdes.ts and preview.ts at origin/main. Closes #207
yaythomas
force-pushed
the
docs/filesystem-serdes
branch
from
66a8367 to
85142d8
Compare
dhegberg
approved these changes
Jun 24, 2026
zhongkechen
reviewed
Jun 24, 2026
| === "Java" | ||
|
|
||
| Coming soon. See | ||
| [aws-durable-execution-sdk-java#463](https://github.com/aws/aws-durable-execution-sdk-java/issues/463). |
Contributor
There was a problem hiding this comment.
May not coming very soon as it requires extra design changes in Java SDK
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
3 participants
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
Document the FileSystem serdes as a new section in the serialization reference page (
docs/sdk-reference/state/serialization.md).The section covers:
/tmp.createFileSystemSerdessignature andFileSystemSerdesConfigfields.ALWAYSandOVERFLOW.URIandHASH.buildPreviewandPreviewConfig.configureSerdes.The walkthrough leads with the conservative per-operation
StepConfigpattern. Setting it as the handler default lives in its own subsection.Coverage is TypeScript only at this stage. Python and Java tabs link to the parity issues aws-durable-execution-sdk-python#479 and aws-durable-execution-sdk-java#463.
Verified against
packages/aws-durable-execution-sdk-js/src/utils/serdes/filesystem-serdes.tsandpreview.tsatorigin/main.zensical build --cleanreports no issues.mdformatis idempotent on the changed file.Closes #207