Passa al contenuto principale

Versioni dell'API

L'API è offerta come singolo endpoint GraphQL all'indirizzo https://data.bafu.admin.ch/api. Non vi è né un segmento di versione nell'URL né un header di versione; tutti i client utilizzano lo schema attuale. Le modifiche rilevanti allo schema sono registrate nella cronologia delle versioni riportata di seguito. Le versioni seguono il versionamento semantico (Major.Minor.Patch): il numero major aumenta in caso di modifica non retrocompatibile, il numero minor in caso di nuova funzionalità retrocompatibile e il numero patch in caso di correzione retrocompatibile. La versione documenta l'evoluzione dello schema e non viene selezionata dai client.

Cronologia delle versioni

Legenda: Major una modifica non retrocompatibile che può richiedere aggiornamenti dei client. Minor una nuova funzionalità retrocompatibile. Patch una correzione retrocompatibile.

VersioneData di pubblicazioneModificaDescrizione
1.0.02026-07-03MajorVersione iniziale con i set di dati water.observations e water.nawa_trend.

Evoluzione dello schema

Lo schema viene ampliato nel tempo, man mano che vengono pubblicati nuovi set di dati. Queste modifiche sono additive e retrocompatibili:

  • nuovi spazi dei nomi, tipi e campi,
  • nuovi campi di filtro sui tipi esistenti.

Le modifiche additive non influiscono sulle query esistenti. Una query che seleziona un insieme esplicito di campi continua a restituire tali campi anche quando altrove nello schema vengono aggiunti nuovi campi.

Lo schema attuale può essere ispezionato in qualsiasi momento tramite l'introspezione GraphQL — ad esempio tramite l'Explorer GraphiQL.

Modifiche non retrocompatibili

Le modifiche non retrocompatibili — come la ridenominazione o la rimozione di un campo o la modifica del tipo di un campo — vengono evitate ove possibile. Qualora una tale modifica risultasse inevitabile, viene annunciata in anticipo su questa pagina, affinché i client interessati possano adeguarsi.