Skip to content

Docs: add document about serialization #178

@leandrodamascena

Description

@leandrodamascena

Summary

Create documentation for serialization in the AWS Durable Execution SDK for Python, explaining how data is serialized in checkpoints, supported types, and custom serialization patterns.

Solution

Create serialization docs with:

  • Default JSON serialization - Explain how the SDK serializes data by default
  • JSON-compatible types - Document supported types (dict, list, str, int, float, bool, None)
  • Converting non-serializable types - Show how to handle datetime, Decimal, custom objects
  • Custom SerDes - Document custom serialization implementation
  • Examples - Provide examples with dataclasses, Pydantic models, and custom objects
  • Configuration - Show serialization in StepConfig, CallbackConfig, and other configs
  • Best practices - Tips for handling large payloads
  • Troubleshooting - Common serialization errors and solutions
  • FAQ - Common questions about serialization

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions