developers Entrar a AdvantaCloud
Árbol del API · Guías › Versionado y cambios

Versionado y cambios

Un schema

Un solo schema que crece con cambios aditivos; cómo se anuncian las deprecaciones y cómo prepararte.

El API tiene un solo schema, sin versiones en la URL. Crece con cambios aditivos: operaciones, campos, argumentos y valores nuevos que no rompen lo que ya funciona.

Qué puede cambiar sin aviso

  • Campos y operaciones nuevos. No te afectan: GraphQL sólo devuelve lo que pides.
  • Argumentos nuevos opcionales. Si no los envías, la operación responde igual que antes.
  • Valores nuevos de un enum. Por ejemplo, un estatus nuevo de OrderStatus. Trata un valor que no conoces sin fallar; varios enums traen UNKNOWN y la clave original en un campo raw… para estos casos.

Qué se anuncia antes

Antes de retirar o cambiar un campo, un argumento o una operación:

  1. se marca como deprecado en el schema (@deprecated, con su reemplazo) y se anuncia en Cambios;
  2. se revisa quién lo usa y se acompaña la migración;
  3. sólo después se retira.

Mantente al día

  • Cambios lista, del más reciente al más antiguo, los cambios del schema que tocan las operaciones y tipos publicados. Síguelos con el feed Atom.
  • schema.graphql es el schema publicado, listo para generar tipos con tu herramienta de GraphQL. Sólo incluye lo que documenta este sitio.
  • Las páginas de operaciones y tipos indican la fecha del schema que describen.