Sentinel API v1

從第一個 API 呼叫到正式環境

Versioning

穩定的 /v1 契約與可見的變更

API path、事件 schema 與 OpenAPI 契約分開版本化。消費方應保存 event schema version,並在部署升級前比較 OpenAPI。

相容變更

  • 增加選填 request 欄位或 response 欄位。
  • 增加新的 endpoint、event type 或 enum(若文件標示消費方必須容忍未知值)。
  • 修正不改變公開語意的錯誤。

破壞性變更

移除/重新命名欄位、改變型別、收緊既有驗證、改變簽章 bytes 或生命週期語意,都需要新的 major API 或 event schema 版本與遷移期。

API path version       /v1
contract version       X-Sentinel-Contract-Version
event schema version   event.schema_version
application version    GET /v1/system

棄用

功能只有在替代 endpoint 已達功能對等、遷移文件發布且公告期限結束後才會移除。舊 /api/*、WebSocket 與 MCP 目前是相容介面,尚未因 /v1 出現就立即移除。

目前 API v1 屬於此分支的產品化契約;公開不可變映像、正式發行版本與對外 SLA 仍是發布 gate。