The wire contract between Quesma Shipper and its control plane.
This repository contains the protocol specification and the contract assets that both peers test against. It does not contain a runnable shipper or control plane. Those implementations live in separate repositories, and the control plane repository is not public. You can inspect, test, and propose changes to the complete wire contract here. Maintainers run the downstream contract tests before each release.
The Go module embeds the normative protocol document, the JSON Schemas, the configuration authority rulebook, and the golden fixtures:
import protocol "github.com/QuesmaOrg/shipper-protocol"
raw, err := protocol.FS.ReadFile("schemas/enroll-request.schema.json")The fixtures are synthetic test vectors. The token-shaped values, signatures, URLs, and the documented Ed25519 seed are public. Do not use them as production credentials.
Install the Go version declared in go.mod. Then run the repository checks:
go test ./...
go vet ./...
go run ./cmd/protocolgen -checkRead CONTRIBUTING.md before you change a released contract. Report security
issues as described in SECURITY.md.
Release tags are Go module versions such as v0.1.0. Wire versions are immutable after release. A
breaking change gets a new endpoint and schema version. Schema $id values use this repository's
public namespace. They are stable identifiers, not download locations. An identifier published in
a release does not change in place.
Licensed under the Apache License 2.0. See NOTICE.
Quesma, Quesma Shipper, and the Quesma logo are trademarks of Quesma Inc. The license does not
grant trademark rights. If you distribute a modified version, read TRADEMARKS.md
before you name it.