Schemas & API
Machine-readable definitions for implementors.
OpenAPI
The OpenAPI 3.1 specification defines all protocol endpoints from section 8.
JSON Schemas
| Schema | Covers |
|---|---|
| channel-metadata.json | Signed metadata documents (section 5) |
| channel-guide.json | Signed guide documents (section 6) |
| migration.json | Signed key migration documents (section 5.14) |
| node-info.json | /.well-known/tltv responses (section 8.1) |
| peer-exchange.json | /tltv/v1/peers responses (section 8.6) |
| defs.json | Shared type definitions |
Test Vectors
| File | Coverage |
|---|---|
| c1-identity.json | Channel ID encoding (RFC 8032 test keypair) |
| c2-signing.json | Canonical JSON + Ed25519 signatures |
| c3-complete-document.json | Full signed metadata document |
| c4-uri-parsing.json | URI parsing valid/invalid cases |
| c5-guide-document.json | Guide document signing |
| c6-invalid-inputs.json | Negative test cases |
| c7-key-migration.json | Key migration document |