Azure / Azure/openapi-diff

[Rule] Allowed values for an enum have changed

Offen
#36 4 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
.NET planned Rule Rule Doc Needed
Vorherrschende Sprache
C#
Sterne
290
Forks
50
Ø Merge
5 T. 13 Std.
Gemergte PRs (30 T.)
5

Beschreibung

Enum “foo” had allowed values as “val1” and “val2” in v1 of API. If now, the values allowed/accepted by the service are “val1”, “val2” and “val3”, client will fail to de-serialize if “val3” comes back in the response.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne damit, das Problem mit zwei OpenAPI-Spezifikationen zu reproduzieren, bei denen enum „foo“ um „val3“ erweitert wird, und verfolge anschließend den Regelvergleich des Befehlszeilentools für zulässige enum-Werte. Als erledigt gilt die Änderung, wenn sie gemeldet wird, sobald eine neuere Spezifikation einen Wert akzeptiert, den die frühere nicht akzeptiert hat, und damit das beschriebene Deserialisierungsrisiko abdeckt.

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
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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