Versionado

Version actual del contrato publico: 1.0.0 (info.version en OpenAPI).

URL

Las rutas actuales no llevan /v1 en el path. Cambiarlas a /api/v1/... romperia el panel, el canal institucional y las integraciones ya entregadas. La version vive en el documento, no en la ruta, hasta que exista un segundo contrato incompatible.

Compatible (no sube el major)

  • Campos opcionales nuevos en responses
  • Endpoints nuevos
  • Codigos de error nuevos documentados, sin cambiar los existentes

Requiere version nueva

  • Quitar o renombrar un campo obligatorio
  • Cambiar el significado de creados, omitidos_duplicado o invalidos
  • Cambiar el header X-API-Key
  • Obligar un sobre de error distinto al detail actual

Deprecacion

Un endpoint que vaya a retirarse se marcara deprecated: true en OpenAPI y permanecera al menos un ciclo de release. No hay endpoints deprecados en 1.0.0.

La misma politica esta resumida para el equipo en API_VERSIONING.md.