Changelog y versionado

La versión forma parte de la ruta. La v1 solo cambia de forma retrocompatible.

Política de versiones

Dentro de /v1 solo hacemos cambios aditivos: nuevos endpoints, nuevos parámetros opcionales, nuevos campos de respuesta, nuevos valores de enum en las claves de categories para nuevos tipos y nuevos textos de detail en los errores. Ignora los campos desconocidos y no dependas del orden de los campos.

Los cambios incompatibles — eliminar o renombrar un campo, cambiar un tipo, hacer obligatorio un parámetro — se publican en una ruta nueva (/v2). Los valores de code de los errores, las claves de categoría y los nombres de ordenación forman parte del contrato.

Obsolescencia y retirada

Una versión obsoleta sigue funcionando al menos 6 meses después de que se publique su sucesora.
Sus respuestas incluyen las cabeceras Deprecation (RFC 9745) y Sunset (RFC 8594) con la fecha en que deja de funcionar, además de un Link a esta página.
Los titulares de cuentas con tráfico reciente en la versión antigua reciben un correo al declararse obsoleta y 30 días antes de la retirada.

Cabeceras en una versión obsoleta

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

Cambios

v1 — documentos OpenAPI traducidos (solo documentación)

/openapi.pt-BR.json y /openapi.es.json: el mismo contrato que /openapi.json con las descripciones en portugués y español. Las rutas, los nombres de campo y los valores de enum no cambian.

v1 — tiempo para completar (aditivo)

ItemDetail.time_to_beat: mediana de horas y número de informes de la comunidad para main, extras y completionist en juegos (median_hours es null con menos de 3 informes); null para películas, series y libros.

v1 — primera versión

Listados, detalles y géneros para games, movies, series y books.
/search, /lookup por id externo y /me/usage.
Documento OpenAPI 3.1 en /openapi.json.