Azure / Azure/openapi-diff

[Rule] breaking changes, when x-ms-discriminator-value changes

Offen
#241 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Rule
Vorherrschende Sprache
C#
Sterne
290
Forks
50
Ø Merge
5 T. 13 Std.
Gemergte PRs (30 T.)
5

Beschreibung

Case: https://github.com/Azure/azure-rest-api-specs/pull/20376#discussion_r959039927

Reason:
`x-ms-discriminator-value` is used in client to choose the correct type/class to initialize.

Changing its value will break SDK in runtime (there will be no API change, but SDK will fail to initialize the type in runtime), or client code (if customer uses REST API directly, and use its value to match the type).

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Das Issue nennt keine Datei, keinen Test und keinen Einstiegspunkt. Beginne damit, zu ermitteln, wie bestehende Regeln für Breaking Changes in diesem C#-Befehlszeilentool dargestellt werden, und verfolge anschließend die Vergleichsbehandlung für x-ms-discriminator-value. Als erledigt gilt die Änderung, wenn ein geänderter Wert als Breaking Change gemeldet wird, unveränderte Werte hingegen nicht.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp
Bereich
api, cli
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.