Política de actualización y cambios

La API de Orquest se diseña con el objetivo de mantener la estabilidad y compatibilidad con versiones anteriores de los diferentes endpoints en la medida de lo posible. A lo largo del tiempo, sin embargo, la API puede ofrecer nuevas funcionalidades en endpoints ya desarrollados y en uso.

En este sentido, Orquest se reserva el derecho de modificar o ampliar la estructura de la respuesta sin previo aviso, siempre que sea un cambio retrocompatible con versiones anteriores. Esto incluye, por ejemplo, la sobrecarga de la respuesta, es decir, la adición de nuevos campos no contemplados anteriormente. Es responsabilidad de los usuarios de la API, por tanto, asegurarse de que sus implementaciones sean flexibles para manejar estos cambios sin interrupciones.

Política de versionado para cambios no retrocompatibles

En aquellas ocasiones en las que no es posible mantener la compatibilidad con funcionalidades anteriores, ya sea por cuestiones de diseño o por motivos de ampliación, Orquest lleva a cabo una política de versionado para cambios no retrocompatibles:

  • Cuando se introduzca un cambio en el comportamiento de un endpoint, se proporcionará una nueva versión de este en la API.

  • Las versiones anteriores quedarán marcadas como deprecadas en la documentación, para una fácil identificación.

  • Las nuevas versiones serán notificadas a los usuarios, permitiendo realizar la migración de manera planificada.

  • La documentación ofrecerá la información actualizada y la estrategia de migrado.

El hecho de que un endpoint esté marcado como deprecado no significa que se haya eliminado o que vaya a dejar de funcionar.

Si un endpoint deprecado fuese a ser eliminado, se notificará a los usuarios con suficiente antelación, proporcionando un periodo adecuado de migración y soporte durante la transición.

Se recomienda, por último, la consulta regular de la documentación para estar al día con cualquier actualización o cambio en la API, las estructuras de solicitud y respuesta, los parámetros aceptados y cualquier otro detalle relevante.