Skip to content

Design Docs

The NSmithy design documents live in the designs/ folder of the repository. Each document covers a specific area of the system: its goals, the chosen design, alternatives considered, and tradeoffs.

DocumentArea
codegen-architecture.mdJava plugin + MSBuild integration pipeline
shapes.mdSmithy shape → C# type mapping
serialization.mdSchema-aware codec and serialization design
http-interfaces.mdHTTP transport abstractions
client-architecture.mdGenerated client lifecycle, config, interceptors, auth, retries
native-grpc.mdNative gRPC: own proto codec + gRPC protocol (no protoc/Grpc.Net)
streaming.mdEvent streams and streaming blob payloads