Documentation

SDK Authoring Guide

Handwritten SDKs must follow the published contracts exactly. This page defines the canonical sources and the required breaking behaviors on current v1 endpoints.

Canonical Contracts

Use these machine-readable endpoints as the runtime contract source:

/api/v1/specs/asyncapi/realtime.json
AsyncAPI 2.6 realtime contract

Breaking Rules

All HTTP error responses are RFC 7807 application/problem+json.
SDKs parse type, title, status, and detail.
HMAC request signatures use canonical path only. Query strings are never signed.
Channel filtering accepts only filter_by_prefix. Legacy prefix is removed.

Conformance Gate

All handwritten SDKs are validated with shared fixture vectors for signing and error mapping. CI fails when server behavior, specs, and SDK behavior diverge.