Versiones de servicio

Cada servicio tiene un número de versión como parte del Identificador uniforme de recursos (URI) para acceder al servicio. La versión tiene un número principal y secundario. Las solicitudes deben proporcionar el número de versión principal, pero el número de versión secundaria es opcional y establece como predeterminado un valor de "0" si no se suministra. El número principal debe coincidir con el número principal del servicio. El número secundario debe ser inferior o igual al número secundario del servicio.

Ejemplo: un cliente hace algunas solicitudes para un servicio que está ejecutando el número de versión “2.1”.

No se requieren cambios de versión de API para los siguientes cambios de propiedad. El número y el modelo de la versión del dispositivo se deben utilizar para determinar qué propiedades están disponibles. Estos cambios de propiedad también se reflejan en la CLI y la BUI, y son indicaciones de las capacidades de esa instancia de dispositivo.

• Nuevas propiedades de salida (sin eliminar propiedades).

• Nuevas propiedades de entrada agregadas a un comando existente, que tienen valores predeterminados que hacen que el comando se comporte como lo hizo en una versión anterior.

Puesto que una versión nueva de un comando compatible con versiones anteriores puede devolver propiedades adicionales, los clientes deben cifrarse para ignorar las nuevas propiedades. El número secundario se incrementa para los cambios compatibles con versiones anteriores al servicio de la API.

• Agregar un nuevo comando a un servicio existente.

• Agregar nuevos parámetros de la consulta en comandos de servicio.

El número principal se incrementa con cambios incompatibles al servicio de la API.

• Eliminar parámetros de la consulta del comando.

• Eliminar un comando de un servicio existente.

Las versiones principales del software del dispositivo pueden incluir cambios de versión incompatibles. Es posible que haya o que no haya versiones anteriores de un servicio dado durante una actualización principal. Cada respuesta a un comando debe contener un encabezado HTTP con la versión actual de la API de dispositivo para un módulo determinado:

X-Zfssa-Nas-Api:  1.1