point the doc and the README at the schema's new name

I renamed the file and left three references behind — wire.go's format note and
two in the README, one of them the ASCII frame diagram. A doc that names a file
which is not there is worse than no doc: the reader concludes the format is
undocumented.

Co-authored-by: Hanzo Dev <[email protected]>
This commit is contained in:
2026-08-10 16:45:02 -07:00
co-authored by Hanzo Dev
parent 12561a886c
commit c813b6bebe
3 changed files with 5 additions and 5 deletions
+3 -3
View File
@@ -77,13 +77,13 @@ func main() {
## Wire format
Each HTTP message is one ZAP frame, defined in [`schema/zap_http.zap`](schema/zap_http.zap) using the ZAP schema language. Today the wire layer is length-prefixed framing over TCP; the [paper](https://github.com/zap-proto/papers/tree/main/transport-vs-jwt) and the v0.2 release will swap that for the full ZAP transport with X-Wing PQ KEM handshake on connect.
Each HTTP message is one ZAP frame, defined in [`schema/http.zap`](schema/http.zap) using the ZAP schema language. Today the wire layer is length-prefixed framing over TCP; the [paper](https://github.com/zap-proto/papers/tree/main/transport-vs-jwt) and the v0.2 release will swap that for the full ZAP transport with X-Wing PQ KEM handshake on connect.
```
zap-http v0.1 wire (transitional):
+---------+-------------------+
| u32 BE | ZAP Frame |
| length | (zap_http.zap) |
| length | (http.zap) |
+---------+-------------------+
zap-http v0.2 wire:
@@ -129,7 +129,7 @@ By the [composability theorem](https://github.com/zap-proto/papers/tree/main/com
## Schema regeneration
```sh
make schema # regenerates internal/wire/zap_http.go from schema/zap_http.zap
make schema # regenerates internal/wire/zap_http.go from schema/http.zap
```
Requires `zapc` (the ZAP schema compiler) on PATH. Build it once from
+1 -1
View File
@@ -15,7 +15,7 @@
// Callers append into a reusable buffer (Append{Request,Response}), so after a
// connection warms up the steady-state cost is zero heap allocation.
//
// # Wire layout (see schema/zap_http.zap)
// # Wire layout (see schema/http.zap)
//
// A frame is one zap-proto/go message: a 16-byte header (magic "ZAP\x00",
// version=1, flags, rootOffset=16, size) followed by the root object. The root
+1 -1
View File
@@ -4,7 +4,7 @@
// by the client. There is no net/http in the request path — Fiber and
// every other fasthttp stack hand their handler straight to this package.
//
// The wire format is documented in schema/zap_http.zap (authored in the
// The wire format is documented in schema/http.zap (authored in the
// ZAP schema language). The bytes on the wire are github.com/zap-proto/go
// Objects — the canonical pure-stdlib ZAP runtime — packed at explicit
// byte offsets within each object's fixed payload. There is no external