Saltar al contenido
Qualth

Compatibilidad y deprecaciones

Entendé qué cambios pueden afectar una integración y cómo interpretar una deprecación cuando exista.

Usá la API Reference como contrato actual

La Reference describe las operaciones, parámetros, schemas, auth, scopes y respuestas que tu integración puede consumir. Un cambio de implementación interno no modifica ese contrato por sí solo.

Qué puede ser un cambio incompatible

  • Cambiar method, path u operación existente.
  • Agregar un requisito obligatorio a un request existente.
  • Cambiar tipos, nullability o semántica observable de campos.
  • Cambiar auth, scopes o reglas de tenant de manera incompatible.
  • Modificar status codes, errores, idempotencia o efectos observables de una operación.

Deprecated no significa retirado

Una superficie marcada como deprecated sigue existiendo mientras no haya sido retirada, pero deja de ser la opción recomendada para nuevas implementaciones. Cuando una migración requiera acción, la documentación debe indicar el reemplazo y los pasos necesarios.

Cambios y fechas

Las fechas efectivas, reemplazos y plazos de una deprecación se publican cuando existen para un cambio concreto. No asumas una ventana temporal fija si no está indicada en esa comunicación.

Redirects de documentación

Un redirect en Docs ayuda a encontrar contenido vigente, pero no cambia automáticamente el comportamiento de la API en runtime.