Azure / Azure/openapi-diff

we should report breaking change for x-ms-discriminator-value change

Aperta
#350 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
C#
Stelle
290
Fork
50
Merge medio
5g 13h
PR unite (30g)
5

Descrizione

See https://github.com/Azure/azure-rest-api-specs/pull/32483#discussion_r1948548308
As you can see the definition for [x-ms-discriminator-value](https://github.com/Azure/autorest/tree/main/docs/extensions#x-ms-discriminator-value) it indicates the discriminator property's value on the wire layer, therefore, any changes related to x-ms-discriminator-value should be considered as an api layer breaking change.

A side note, the default x-ms-discriminator-value for any models that contains discriminator property is the model name itself. Which means if there's a model named A that doesn't have x-ms-discriminator-value before, and they newly added x-ms-discriminator-value and set it as B, it's also a breaking change.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Start with the linked discussion and the x-ms-discriminator-value extension definition. Trace how the tool classifies discriminator changes between OpenAPI specifications. Done means changes to this value, including adding an explicit value where the model name was previously implicit, are reported as API-layer breaking changes.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
csharp, openapi
Ambito
api
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.