Skip to main content

Module schema

Module schema 

Source
Expand description

The protocol as data: a JSON Schema for every message, generated from crate::msg, with the protocol version range, the capability names and the error kinds. It is published as conformance/schema.json beside the conformance cases, so a plugin written in any language can check its messages and constants against it; a test keeps the file in step with the code.

Constants§

PUBLISHED
The published schema file, as checked in.

Functions§

document
The schema document: $defs.Request is any message core sends, $defs.Response any message a plugin sends, and x-dre the version range, capabilities and error kinds.
render
The schema document as the published file spells it.