Maturity: Alpha documentation / draft contract
This tree targets the API Contracts repository's immutable
v1.0.0-draft baseline. The reviewed public slice currently covers Device
and Command resources plus a canonical event envelope. Tenant provisioning,
integration callbacks and privileged administration are outside the public v1
boundary until separately reviewed.
| Topic | Status | Source |
|---|---|---|
| Public Device + Command API | Alpha / draft | Public OpenAPI |
| Event envelope | Alpha / draft | AsyncAPI |
| Authentication and tenant scope | Planned documentation | Contract security definitions + runtime evidence |
| TypeScript SDK | Prerelease Alpha | sdk-typescript |
| Python SDK | Prerelease Alpha | sdk-python |
| Java SDK | Scaffold / Planned | sdk-java |
| CLI | Scaffold / Planned | cli |
| MCP server | Scaffold / Planned | mcp-server |
| Mock server | Scaffold / Planned | mock-server |
Concepts, authentication, tenant isolation, canonical identifiers and first verified API call. Content beyond the linked contract is Planned.
Device registration/lifecycle and commands are first because they are in the current public draft. Telemetry, digital twin, webhooks and integrations remain Planned until their public contracts and runtime parity are evidenced.
Partner/operator procedures will be added only with reproducible prerequisites, failure handling and test evidence.
Use the versioned files in
api-contracts. This
repository explains usage; it does not fork schema definitions.
TypeScript/Python are generated prerelease clients. Other tool repositories are not installable supported releases today.
Examples must pin their contract baseline and tested runtime/SDK version.
Release/migration/troubleshooting material must name its owner, rollback or recovery path, and evidence when applicable.
- Public device identity is
corelink_device_id. - Provider/connector identifiers are implementation details.
- Every state-changing example must describe tenant scope, authorization, idempotency and expected problem responses.
- A draft or scaffold is never described as Stable/supported.