API versioning and deprecation policy

Automation should be able to rely on a stable contract. This policy describes which changes can occur within lattedit API v1 and how a future breaking change will be announced.

Versioned surface

The stable production base is https://www.lattedit.xyz/api/v1. Breaking request or response changes require a new major path such as /api/v2. Additive fields, clearer descriptions, additional optional parameters, and new operations may ship within v1. Clients should ignore response fields they do not recognize.

Deprecation signal

An operation scheduled for retirement will return the standard Deprecation response header. Once a retirement date is known it will also return a dated Sunset header and a Link header pointing to migration instructions. The notice period for a stable major version is at least ninety days.

Migration window

During the notice window, the retiring operation and its OpenAPI description will remain reachable. The developer guide will name the replacement, explain request and response differences, and provide a working example. Emergency changes needed to prevent active abuse or a serious security issue may use a shorter window, but the developer documentation will explain the reason.

Current status

No v1 operation is deprecated. Therefore production responses do not send a misleading deprecation date today. The canonical machine contract remains openapi.json, and questions or compatibility reports can be sent through the contact page.