Changelog e versionamento

A versão faz parte do caminho. A v1 só muda de forma retrocompatível.

Política de versionamento

Dentro de /v1 fazemos apenas mudanças aditivas: novos endpoints, novos parâmetros opcionais, novos campos na resposta, novos valores de enum nas chaves de categories para novos tipos e novos textos de detail nos erros. Ignore campos desconhecidos e não dependa da ordem dos campos.

Mudanças incompatíveis — remover ou renomear um campo, mudar um tipo, tornar um parâmetro obrigatório — saem em um novo caminho (/v2). Os valores de code dos erros, as chaves de categoria e os nomes de ordenação fazem parte do contrato.

Descontinuação e desativação

Uma versão descontinuada continua funcionando por pelo menos 6 meses após o lançamento da sucessora.
Suas respostas trazem os cabeçalhos Deprecation (RFC 9745) e Sunset (RFC 8594) com a data em que ela deixa de funcionar, além de um Link para esta página.
Donos de contas com tráfego recente na versão antiga recebem um e-mail na descontinuação e 30 dias antes da desativação.

Cabeçalhos em uma versão descontinuada

HTTP/1.1 200 OK
Deprecation: @1798761600
Sunset: Tue, 01 Jun 2027 00:00:00 GMT
Link: <https://hexascore.app/docs/changelog>; rel="deprecation"

Mudanças

v1 — documentos OpenAPI traduzidos (só documentação)

/openapi.pt-BR.json e /openapi.es.json: o mesmo contrato de /openapi.json com descrições em português e espanhol. Caminhos, nomes de campos e valores de enum não mudam.

v1 — tempo para zerar (aditivo)

ItemDetail.time_to_beat: mediana de horas e número de relatos da comunidade para main, extras e completionist em jogos (median_hours é null com menos de 3 relatos); null para filmes, séries e livros.

v1 — primeira versão

Listas, detalhes e gêneros para games, movies, series e books.
/search, /lookup por id externo e /me/usage.
Documento OpenAPI 3.1 em /openapi.json.