Skip to content

Latest commit

 

History

History
61 lines (43 loc) · 3.51 KB

File metadata and controls

61 lines (43 loc) · 3.51 KB

CoreLink v1 developer documentation

Maturity: Alpha documentation / 1.0.0-draft public contract

This tree targets the current public contract baseline. The reviewed public slice covers Device and Command resources plus a canonical event envelope. Broader telemetry/location, partner/webhook and developer-tool surfaces remain maturity-gated and are labeled explicitly below.

Start here

  1. 30-minute quickstart — bearer authentication, tenant scope, Device read/create and idempotent Command submission.
  2. Architecture — CoreLink-owned public boundary and provider independence.
  3. Authentication and tenant context — auth, tenant scope and safe credential handling.

Guides

SDKs

Developer tools

Java SDK, CLI, mock server and MCP status documents current Scaffold/Planned boundaries and the backlog gates required before installation/support instructions are valid.

Operations

Reference

Current surface matrix

Surface Current maturity Authoritative source
Public Device + Command API Alpha / 1.0.0-draft Public OpenAPI
Canonical event envelope Alpha / draft AsyncAPI
TypeScript SDK Prerelease Alpha sdk-typescript
Python SDK Prerelease Alpha sdk-python
CoreLink Console Alpha Console
Java SDK Scaffold / Planned sdk-java
CLI Scaffold / Planned cli
MCP server Scaffold / Planned mcp-server
Mock server Scaffold / Planned mock-server

Documentation contract

  • Public device identity is corelink_device_id.
  • Provider/connector identifiers are implementation details, not public resource identities.
  • State-changing examples document tenant scope, authorization, idempotency and expected failures.
  • Normative schemas are linked from api-contracts, not forked into prose.
  • Draft/scaffold content is never described as Stable.
  • Implementation, deployment and Product Acceptance are distinct evidence states.