Política de deprecação da L2 MOG API

Esta página descreve como a API pública do L2 MOG versiona endpoints e como comunica deprecação e desligamento. Ela vale para https://api.l2mog.com/api/v1 e para o alias /api/* (sem número de versão).

Versionamento

A versão fica no caminho (/api/v{n}). Toda resposta inclui o cabeçalho API-Version com a versão efetivamente atendida; o cliente pode opcionalmente enviar o cabeçalho de requisição API-Version para pedir uma versão específica. Uma versão nova só é criada para uma mudança incompatível — adições de campos ou endpoints novos não geram versão nova, e os clientes devem ignorar campos desconhecidos na resposta.

O que conta como mudança incompatível

Incompatível (gera versão nova):

Remover um campo ou um endpoint.
Mudar o tipo de um campo existente.
Mudar a semântica de um código de erro ou de um status HTTP já documentado.

Compatível (não gera versão nova):

Adicionar um campo novo numa resposta existente.
Adicionar um endpoint novo.
Adicionar um valor novo a um enum, quando o cliente já deveria tratar valores desconhecidos.

Processo de deprecação

Um endpoint deprecado recebe um aviso mínimo de 90 dias antes do desligamento. Durante esse período, a resposta do endpoint inclui:

Deprecation: @<epoch> (RFC 9745)
Sunset: <IMF-fixdate> (RFC 8594)
Link: <https://l2mog.com/deprecation-policy>; rel="deprecation"

A mudança também é anunciada nesta página (seção Changelog de deprecações) e no Discord oficial.

Changelog de deprecações

Endpoint	Deprecado em	Sunset	Substituto
Nenhum endpoint deprecado no momento.

Após o sunset

Depois da data de Sunset, o endpoint responde 404 ou 410 com corpo ApiError.

Como acompanhar

Além desta página, a extensão x-deprecation-policy do /openapi.json aponta para cá, e o Discord oficial anuncia novas deprecações.

Links relacionados

/developers — documentação da API.
/openapi.json — especificação OpenAPI.
/agents.md — guia para agentes.
/contact — contato.

English summary

This page describes how the L2 MOG public API versions endpoints and communicates deprecation, for both https://api.l2mog.com/api/v1 and the unversioned /api/* alias. The version lives in the path (/api/v{n}); every response carries an API-Version header. A new version is only created for a breaking change (removing a field/endpoint, changing a field type, or changing error/status semantics); adding fields or endpoints does not bump the version, and clients should ignore unknown fields. Deprecated endpoints get at least 90 days notice via Deprecation (RFC 9745), Sunset (RFC 8594) and Link rel="deprecation" headers, announced on this page's changelog and on our Discord. After the sunset date, the endpoint responds 404 or 410 with an ApiError body.