ReferenceLink to the section Reference
On this page
Use these artifacts while implementing or inspecting a message. For a runnable introduction, start with Build.
| Reference | Use it for |
|---|---|
| OpenAPI 3.1 description | Device REST paths, operations, request and response shapes |
| JSON Schemas | Validating telemetry, capabilities, commands, events and leases |
| Example messages | Concrete payloads used by the repository's validator |
| Problem-type registry | Error meanings, HTTP status and registered type URIs |
| .NET Client SDK | Typed Client integration, signaling and control helpers |
Versions and authorityLink to the section Versions and authority
The current draft uses specification 0.2, schema directory v0.2 and REST path version v1. These identify different things; consult the versioning rules.
Implementations ship the schemas they were tested with instead of fetching them at runtime. When prose and schema disagree, the schema governs wire format and the prose governs behavior; record the disagreement as a defect.