Versionado y Deprecación de API
VaultPAM utiliza versionado de ruta principal para APIs HTTP públicas.
Modelo de versionado
- Los cambios aditivos permanecen en la versión principal actual.
- Los cambios importantes requieren una nueva ruta principal como
/api/v2/. - La versión principal pública actual es
v1.
Cambios importantes
Un cambio es importante cuando elimina o restringe un contrato de cliente existente, tales como:
- eliminar un endpoint o método HTTP,
- convertir un campo de solicitud opcional en obligatorio,
- eliminar un campo de respuesta que los clientes existentes utilizan,
- cambiar un tipo de campo de forma incompatible,
- restringir reglas de autenticación o acceso de una forma que interrumpa clientes documentados.
Deprecación y fin de soporte
- Las operaciones deprecadas se marcan en el contrato de API.
- Las notas de la versión incluyen guía de migración en la misma versión que introduce la deprecación.
- El comportamiento deprecado permanece disponible durante al menos dos versiones de producción etiquetadas antes de su eliminación.
- Las fechas de fin de soporte se anuncian con anticipación para que los clientes puedan planificar su migración.
Soporte para migración
Cuando una API cambia, la ruta de reemplazo debe documentarse junto al aviso de deprecación. Los clientes no deberían necesitar adivinar a cuál endpoint o estructura de carga útil migrar.
¿Necesita ayuda?
Utilice la referencia de API en directo para detalles actuales de endpoints y las notas de la versión para cambios que afecten a las actualizaciones.