docs(csharp): document the .NET FileSystem serializer (#2540) - #280
Open
GarrettBeatty wants to merge 4 commits into
Open
docs(csharp): document the .NET FileSystem serializer (#2540)#280GarrettBeatty wants to merge 4 commits into
GarrettBeatty wants to merge 4 commits into
Conversation
The .NET SDK now supports an optional per-operation `Serializer` (an ILambdaSerializer) on StepConfig, CallbackConfig, InvokeConfig, WaitForConditionConfig<TState>, and ChildContextConfig; when null the globally-registered serializer is used. Update the C# tabs on the serialization page (Default serialization, SerDes interface, StepConfig, CallbackConfig) and the StepConfigExample/CallbackConfigExample examples. Map/Parallel C# tabs left as-is pending two-level (item + whole-result) support.
MapConfig<TItem> and ParallelConfig now expose ItemSerializer for each item/branch result; the aggregated batch envelope is SDK-internal and not user-serialized (no whole-result serializer). Update the Map/Parallel C# tab and MapConfigExample.
Fill in the C# tabs of the FileSystem serdes section: walkthrough, constructor signature, inner-serializer/compression, storage modes (Always/Overflow), and path encoding (Uri/Hash), with matching csharp example snippets. Note preview/masking and an execution-wide default serializer as planned follow-ups. Documents aws/aws-lambda-dotnet#2558.
GarrettBeatty
had a problem deploying
to
ai-pr-review-runtime
September 3, 2026 00:16 — with 
GitHub Actions
Failure
GitHub Actions
Failure
GarrettBeatty
had a problem deploying
to
ai-pr-review-runtime
September 3, 2026 00:16 — with
GitHub Actions
Failure
GitHub Actions
Failure
Document the new FileSystemSerializer(basePath, storageMode?, pathEncoding?) constructor that reuses the host-boundary ILambdaSerializer as the inner (bound by the durable runtime when used through a per-operation slot), and note that an explicit inner wins and that using it with no bound inner throws.
GarrettBeatty
had a problem deploying
to
ai-pr-review-runtime
September 4, 2026 01:25 — with
GitHub Actions
Failure
GitHub Actions
Failure
GarrettBeatty
had a problem deploying
to
ai-pr-review-runtime
September 4, 2026 01:25 — with
GitHub Actions
Failure
GitHub Actions
Failure
GarrettBeatty
marked this pull request as ready for review
September 8, 2026 18:46
GarrettBeatty
had a problem deploying
to
ai-pr-review-runtime
September 8, 2026 18:49 — with
GitHub Actions
Failure
GitHub Actions
Failure
GarrettBeatty
had a problem deploying
to
ai-pr-review-runtime
September 8, 2026 18:49 — with
GitHub Actions
Failure
GitHub Actions
Failure
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
1 participant
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
Fills in the C# tabs of the existing FileSystem serdes section of the serialization reference, documenting the new .NET
FileSystemSerializer. Companion to the SDK PR aws/aws-lambda-dotnet#2558.What changed
C# tabs (previously "Not available") now covered in
docs/sdk-reference/state/serialization.md:FileSystemSerializerwrapping an innerILambdaSerializer, passed viaStepConfig.Serializer(and Child/WaitForCondition/Map/Parallel).inner,basePath,storageMode,pathEncoding.AlwaysvsOverflow.UrivsHash.New C# example snippets under
examples/csharp/sdk-reference/serialization/(FileSystemSerdesWalkthrough / Signature / Compression / Overflow / PathEncoding).Noted as follow-ups (not yet in the .NET SDK)