Desarrolladores · Versionado
Política de versionado de la API pública de Jefe
La versión mayor forma parte de la ruta de la API pública. Los endpoints actuales usan /api/v1 y los cambios incompatibles se publicarán bajo una versión mayor nueva.
Cambios compatibles
Una versión existente puede recibir correcciones, documentación más precisa y campos opcionales nuevos que no cambien el significado de los campos publicados. Los clientes deben ignorar propiedades desconocidas cuando su validador lo permita y no depender del orden de los objetos JSON.
La especificación canónica es /openapi.json. Cada cambio del contrato se revisa junto con la implementación para evitar que la documentación anuncie endpoints o capacidades inexistentes.
Cambios incompatibles y retiro
Cambiar el tipo o significado de un campo, eliminar una operación o volver obligatorio un parámetro antes opcional requiere una nueva versión mayor. Si una versión pública se depreca, Jefe lo indicará en la documentación y utilizará los encabezados Deprecation y Sunset cuando exista una fecha de retiro definida.
No se anuncia hoy una fecha de retiro para /api/v1. La ausencia de una fecha evita prometer un plazo ficticio; cualquier transición futura deberá ofrecer una ruta de migración concreta y un período razonable de convivencia.