Skip to content
NSmithy logo NSmithy

Protocol Status

NSmithy is still preview-stage. “Supported” here means there is working generator and runtime support for a usable slice, not that the protocol is complete or fully conformant across the Smithy surface.

Current Status

Section titled “Current Status”
ProtocolGenerated SurfacesStageNotes
alloy#simpleRestJson.NET client, ASP.NET Core serverPreview, most completeBest-covered transport today. Official pinned-suite coverage is currently 43/43 (100%).
aws.protocols#restJson1.NET client, ASP.NET Core serverPreviewClient and server generation work. Official pinned-suite coverage is currently 268/272 (98.53%), with the remaining gap concentrated in Glacier-specific fixtures.
aws.protocols#restXml.NET clientEarly previewClient generation available; used to validate the XML codec and transport abstractions.
smithy.protocols#rpcv2Cbor.NET clientEarly previewClient-only slice that exercises the binary document codec seam directly.
alloy.proto#grpc.proto emission, gRPC client adapter, ASP.NET Core gRPC server adapterExperimentalWorks for the current generated path, but still has the least maturity, the smallest test surface, and more explicit model requirements such as alloy.proto#protoIndex.

Current Conformance Snapshot

Section titled “Current Conformance Snapshot”
  • alloy#simpleRestJson: 43/43 official request/response cases in the pinned model (100%)
  • aws.protocols#restJson1: 268/272 official request/response cases in the pinned model (98.53%)
  • combined JSON/REST surface: 311/315 official cases (98.73%)

These numbers refer to the official request/response cases present in the protocol test models pinned in this repository. They are broader than the executable allowlists used by individual test projects, but narrower than “every protocol test that exists upstream.”

Section titled “Recommended Use”
  • Prefer alloy#simpleRestJson if you want the smoothest end-to-end preview path.
  • Use aws.protocols#restJson1 when you need generated AWS-style REST/JSON clients or ASP.NET Core server surfaces.
  • Use aws.protocols#restXml or smithy.protocols#rpcv2Cbor when you want to evaluate the XML or binary codec paths and are comfortable with a smaller preview slice.
  • Treat alloy.proto#grpc as an early adopter path for teams comfortable working close to generated code and current limitations.

What “Early Stage” Means Here

Section titled “What “Early Stage” Means Here”

In practice, earlier-stage protocols may still have one or more of these traits:

  • narrower protocol binding coverage
  • fewer end-to-end examples
  • less conformance-suite coverage
  • more implementation details that are still expected to move
  • more explicit project wiring or modeling constraints

Not Supported Yet

Section titled “Not Supported Yet”

These protocols are not current NSmithy targets:

  • AWS JSON protocols
  • EC2 Query and AWS Query