mirror of
https://github.com/zap-proto/zip.git
synced 2026-10-19 15:38:57 +00:00
zeekay
999e2153b3
A typed op could only take one JSON value and answer one, so uploads, signed webhooks, form posts, YAML and merge-patch bodies, PDFs, SSE, WebSockets, OAuth redirects and upstream relays stayed untyped routes with no schema, tool, command or SDK method. Each is now a typed op and its REST wire is unchanged. Requests: a zip.Body field takes the body and Content-Type exactly as sent; an In implementing Parser decodes itself; form: fields and *zip.File parts bind url-encoded and multipart forms; cookie: binds a request cookie as an in: cookie parameter. Consumes names the media. Answers: zip.Body (bytes, filename, its own status and headers, a Reader streams chunked), Verbatim[T] (a relay documented as T), Sse[T] (events with keep-alive), Socket[M] (an upgrade after the contract runs; 426 without one, 501 over ZAP), Redirect, CookieCoder, Produces, and unions: a type whose OneOf method's results are the alternatives, with Or[A,B] as the stock one filing each under the status it states. Projections follow from the manifest: the document publishes binary media, form schemas, x-events, x-socket with 101, 3xx with Location and oneOf; MCP takes bytes as base64 and returns bytes, text or collected events as tool content, listing a socket op in _meta as no tool; the CLI reads --body @file|-, --field name=@file and --out, prints events as they arrive and bridges a socket to stdin and stdout. tools/list is ProjectMCP over the manifest, the projection MCPTools already was. Prose reaches promoted fields (filed under the declaring struct), a type defined over another struct, and the type arguments of zip's kinds and OneOf results; an instantiated generic is published under its name followed by its argument names instead of an illegal component key. The unused reflect-only document and tool builders go.
37 lines
832 B
Go
37 lines
832 B
Go
// Package embedded answers with a struct that embeds another, so most of its
|
|
// fields are promoted and documented where they are declared.
|
|
package embedded
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/zap-proto/zip"
|
|
)
|
|
|
|
// Model is what every record carries.
|
|
type Model struct {
|
|
// ID addresses the record.
|
|
ID string `json:"id"`
|
|
// Created is when the record was made, RFC 3339.
|
|
Created string `json:"created"`
|
|
}
|
|
|
|
// Order is one order.
|
|
type Order struct {
|
|
Model
|
|
// Total is the order's total, in cents.
|
|
Total int64 `json:"total"`
|
|
}
|
|
|
|
// In names an order.
|
|
type In struct {
|
|
// ID addresses the order.
|
|
ID string `json:"id" url:"id"`
|
|
}
|
|
|
|
// Get returns one order.
|
|
func Get(ctx context.Context, in *In) (*Order, error) { return &Order{}, nil }
|
|
|
|
// Register declares the op.
|
|
func Register(app *zip.App) { app.Get("/v1/orders/:id", Get) }
|