Nota
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare ad accedere o modificare le directory.
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare a modificare le directory.
Un set di criteri regola il generatore di API dati correlato a modifiche di rilievo, notifiche, versioni e controllo delle versioni.
Controllo delle versioni e versioni
A release in the context of Data API builder refers to every published version of the software, identified by the Major.Minor.Patch format. These releases fall into three categories: stable, breaking change, and preview.
Responsabilità dell'aggiornamento del contenitore
Il contenitore Generatore API dati non viene aggiornato automaticamente. I clienti sono responsabili del monitoraggio delle nuove versioni, della valutazione dell'importanza (inclusi gli aggiornamenti della sicurezza) e dell'aggiornamento dei contenitori distribuiti di conseguenza.
Keeping the container up to date is the customer’s responsibility.
Stable releases
A stable version of Data API builder is backwards compatible. La compatibilità con le versioni precedenti implica che qualsiasi codice scritto che si basa su una versione di un generatore di API dati può adottare una versione stabile più recente senza richiedere modifiche al codice per mantenere la correttezza o le funzionalità esistenti.
Rilasci di modifiche che causano un'interruzione
Una versione di modifica che causa un'interruzione del generatore di API dati non è compatibile con le versioni precedenti. L'adozione di una versione di modifica che causa un'interruzione nel codice client esistente potrebbe richiedere modifiche al codice per garantire che il client si comporti esattamente come in caso di destinazione della versione precedente.
Le versioni delle modifiche di rilievo vengono annunciate tramite l'articolo relativo all'elenco delle modifiche di rilievo e nella descrizione della modifica di una versione di GitHub. La pubblicazione di una versione candidata di anteprima/rilascio precede le versioni delle modifiche di rilievo, a meno che le modifiche non risolino problemi critici di sicurezza, privacy o legale. Anche se le versioni precedenti di Data API Builder potrebbero rimanere disponibili nella pagina delle versioni di GitHub, è consigliabile eseguire l'aggiornamento alla versione più recente, che potrebbe includere correzioni di bug.
Preview releases
Le versioni di anteprima di Generatore API dati sono identificate con lo schema di controllo delle X.Y.Z-rc versioni. Il -rc suffisso indica che la compilazione è un "candidato alla versione". Le versioni di anteprima vengono usate per raccogliere commenti e suggerimenti sulle nuove funzionalità e altre modifiche.
A meno che non si prevede di apportare modifiche significative dall'ultima versione stabile, viene pubblicata la versione di anteprima successiva con tutti gli elementi della versione stabile più recente e delle nuove funzionalità di anteprima. L'aggiornamento successivo di Generatore API dati potrebbe interrompere alcune delle nuove funzionalità di anteprima aggiunte tra le versioni di anteprima. Questo comportamento di interruzione significa che potrebbe essere necessario modificare il codice per ripristinare il funzionamento.
Le versioni di anteprima non sono destinate all'uso a lungo termine o in produzione. Quando diventa disponibile una nuova versione stabile o di anteprima, le versioni di anteprima precedenti potrebbero non essere più accessibili. È consigliabile usare le versioni di anteprima solo quando si lavora attivamente sulle nuove funzionalità e si è pronti per passare a una versione non di anteprima subito dopo il rilascio. Se alcune funzionalità di una versione di anteprima sono incluse in una nuova versione stabile, le funzionalità di anteprima rimanenti vengono aggiunte a una nuova versione di anteprima per provare.
Tabella delle modifiche della versione
Important
È possibile introdurre una modifica di rilievo a una versione secondaria o di patch quando la modifica risolve bug critici del prodotto, legale, sicurezza o problemi di privacy.
| Release type | Previous Version | New Version | Notes |
|---|---|---|---|
| Breaking Change | 1.Y.Z |
2.Y.Z |
Nuove funzionalità e correzioni di bug insieme a eventuali modifiche di rilievo. |
| Stable | 1.1.Z |
1.2.Z |
Nuove funzionalità e correzioni di bug senza modifiche di rilievo, a meno che le modifiche non indirizzino bug critici del prodotto, legali, sicurezza o problemi di privacy. |
| Stable | 1.1.1 |
1.1.2 |
Correzioni di bug senza nuove funzionalità o modifiche che causano interruzioni, a meno che le modifiche non indirizzino bug critici del prodotto, legale, sicurezza o problemi di privacy. |
| Preview | X.Y.1-rc |
X.Y.2-rc |
Nuove funzionalità di anteprima e correzioni di bug. Se la versione principale è stata aggiornata, vengono incluse modifiche di rilievo. |
Breaking Changes
Per classificare in ordine di priorità la sicurezza, migliorare le funzionalità e mantenere la qualità del codice, le nuove versioni del software potrebbero includere modifiche di rilievo. Mentre ci sforziamo di ridurre al minimo queste modifiche tramite scelte architetturali accurate, possono comunque verificarsi. In questi casi, la priorità è annunciarle e fornire possibili soluzioni.
Important
È possibile apportare modifiche senza preavviso se la modifica è considerata non di rilievo o se si tratta di una modifica che causa un'interruzione per risolvere bug critici del prodotto o problemi legali, di sicurezza o di privacy.
Che cos'è una modifica che causa un'interruzione?
Una modifica che causa un'interruzione è una modifica che richiede di aggiornare l'applicazione per evitare interruzioni. In Generatore API dati le modifiche di rilievo possono includere modifiche ai contratti API REST, alla generazione dello schema GraphQL e ad altri elementi che influiscono sulla compatibilità e sulle funzionalità.
Esempi di modifiche di rilievo
The following examples are a nonexhaustive list of breaking changes to Data API builder:
- Modifiche al contratto DELL'API REST
- Modifiche nella generazione dello schema GraphQL
- Modifiche che influiscono sulla compatibilità con le versioni precedenti
- Rimozione o ridenominazione di API o parametri
- Modifiche nei codici di errore
- Modifiche alla funzionalità di definizione delle autorizzazioni
- Rimozione di parametri consentiti, campi di richiesta o campi di risposta
- Aggiunta di parametri obbligatori o campi di richiesta senza valori predefiniti
- Modifiche alla funzionalità dell'endpoint API desiderata
Definizione di una modifica che non causa interruzioni
A non-breaking change refers to a change that can be integrated into your application without causing disruption. Le modifiche non interrotte vengono in genere comunicate dopo l'implementazione. L'applicazione deve essere progettata per gestire queste modifiche senza preavviso.
Esempi di modifiche non di rilievo
The following examples are a nonexhaustive list of nonbreaking changes to Data API builder:
- Introduzione di nuovi endpoint
- Aggiunta di metodi agli endpoint esistenti
- Incorporamento di nuovi campi nelle risposte e nelle richieste
- Modifiche all'ordine dei campi all'interno delle risposte
- Introduzione delle intestazioni di richiesta facoltative
- Modifiche alla lunghezza dei dati e alle dimensioni della risposta
- Modifiche ai messaggi di errore e ai codici
- Correzioni ai codici di risposta HTTP
- Metadati aggiuntivi nei documenti OpenAPI generati
Come si comunicano modifiche che causano un'interruzione?
Microsoft ha la priorità di informarvi tempestivamente sulle modifiche che causano un'interruzione. È possibile trovare notifiche di modifica che causano un'interruzione nelle note sulla versione delle versioni di Data API Builder in GitHub.
Elenco delle modifiche di rilievo corrente
Le modifiche di rilievo e i ritiri delle funzionalità vengono annunciati in questo articolo.
- Al momento, non ci sono modifiche che causano interruzioni