Skip to content
FYInbox
Open navigation

FYInbox docs

Compatibility policy

Integrate against the versioned contract, accept additive response evolution, and use stable error codes and schemas instead of dashboard internals.

Versioning boundary

The notification API is versioned in its /api/v1 path and its OpenAPI document reports version 1.0.0. Public compatibility covers the four operations in the API reference. Dashboard routes, cookies, account lifecycle endpoints, inbox loaders, source management, API-key management, and push endpoints are internal and may change without a public API version.

Forward-compatible clients

  • Ignore additive response fields unless strict validation is intentionally pinned to an artifact version.
  • Preserve unknown non-empty error codes and branch on known codes when behavior differs.
  • Use the checked OpenAPI and JSON Schemas as the machine contract, while treating documented runtime normalization as authoritative.
  • Do not automate undocumented dashboard routes or depend on internal database identifiers.