Explore the complex schema
Wirelit uses a shipping domain to exercise the parts of Protobuf that a small hello-world example misses. Its own documentation build compiles these source files, runs Wirelit, and builds the generated MDX beside the guides you are reading.
The main sample imports shared types from common.proto and several Protobuf well-known types.
What to inspect
Section titled “What to inspect”| Schema feature | Generated reference |
|---|---|
| HTTP and JSON plus typed RPC calls | GetShipment |
| Server streaming | WatchShipment |
| Client streaming | UploadEvents |
| Bidirectional streaming | SyncEvents |
| Custom JSON field name | Shipment.id |
| Explicit presence | GetShipmentRequest.include_events |
| Oneof destination | Shipment.street_address |
| Nested message | Shipment.Insurance |
| Nested enum | Insurance.Coverage |
| Imported message | PostalAddress |
| Map of messages | Shipment.carrier_quotes |
| Recursive reference | Shipment.related |
| Timestamp, duration, Any, Struct, and FieldMask | Shipment and GetShipmentRequest |
| Deprecation | Shipment.legacy_status |
Keep the example honest
Section titled “Keep the example honest”The fixture tests parse curated examples with their actual Protobuf schemas and execute the supported generated calls against a Connect server. Client and bidirectional streaming pages currently expose accurate contracts and protocol guidance; runnable snippets for those shapes are future work.
The build also checks links across authored and generated documentation. The GitHub Pages workflow generates its API reference using the same CLI that consumers install.