- Planned publication:
2026-08-13 - Status:
draft - Compatibility:
breaking - Previous release: 0
- Protocol version:
rostack_v1
Documentation#
- Protocol overview
- Discovery
- JSON API
- Filtering
- WebSocket gateway
- Authentication
- Errors
- Security review
- Versioning
The key words MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, NOT RECOMMENDED, MAY, and OPTIONAL are to be interpreted as described in BCP 14 when, and only when, they appear in all capitals.
Artifacts#
- OpenAPI 3.1 specification
- AsyncAPI 3.1 specification
- Discovery JSON Schema
- Filter JSON Schema
- WebSocket message JSON Schema
- HTTP problem JSON Schema
- Example discovery document
- Example compact event
- Example stability messages
- Example WebSocket exchange
- Example HTTP problem
Validation#
JSON artifacts can be parsed with any RFC 8259 parser. OpenAPI and AsyncAPI documents should additionally be checked with validators supporting OpenAPI 3.1 and AsyncAPI 3.1 respectively.
Migration#
Canonical JSON Schema identifiers changed from the reserved https://spec.rostack.example/ origin to https://spec.pmh.codes/. Consumers that cache, allowlist, bundle, or resolve schemas by $id MUST update those identifiers. Relative references between release artifacts are unchanged.
Implementations MUST also migrate every advertised resource and event schema to Draft 2020-12, set its canonical $id to the advertised schema_url, serve it from an HTTPS origin they control, and close every object against undeclared properties. Discovery MUST advertise the implementation's supported subset of the specification error registry. Existing implementation-specific error types and WebSocket codes must be mapped to registry entries. These changes require a new implementation API version when they invalidate an existing contract.