Changelog
Ogni modifica al contratto pubblico v1 viene esaminata rispetto alla policy di compatibilità prima del rilascio. Le modifiche additive - nuovi endpoint, nuovi campi di richiesta opzionali, nuovi campi di risposta, nuovi eventi webhook - vengono rilasciate con continuità all'interno di v1 e non richiedono mai una migrazione.
Cosa aspettarsi
- Nuovi endpoint e campi possono comparire in qualsiasi momento. Tollera i campi di risposta non riconosciuti invece di fallire.
- Le operazioni
v1esistenti e i codici di stato di successo documentati non vengono rimossi e alle scritture esistenti non vengono aggiunti nuovi parametri, corpi di richiesta o proprietà JSON obbligatori. - La mappatura delle operazioni dell'SDK e gli strumenti MCP selezionati vengono verificati in CI rispetto al contratto corrente, così le loro route e gli scope richiesti non possono divergere silenziosamente.
Tenere traccia delle modifiche
- Il Riferimento API riflette sempre il contratto attualmente rilasciato: confrontalo con la tua integrazione quando aggiorni.
- Le modifiche incompatibili sono regolate dalla Policy di migrazione e versionamento, che definisce revisione, preavviso e percorso di migrazione richiesti.