Azure / Azure/openapi-diff

[RULE 1041] AddedPropertyInResponse shoul suggest adding "readonly true"

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

Beschreibung

"Adding optional property in response" will cause SDK breaking changes only in case of GET-PUT. It's possible to avoid such scenario if the property is marked as "read only = true". The error/warning message should suggest adding it.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit der Implementierung von RULE 1041, AddedPropertyInResponse, und ermittle, wo dessen Fehler- oder Warnmeldung zusammengesetzt wird. Aktualisiere die Diagnose so, dass sie vorschlägt, die hinzugefügte Antwort-Eigenschaft als schreibgeschützt zu markieren, und überprüfe anschließend die Meldung mithilfe der vorhandenen Regel- oder Befehlszeilenprüfungen des Repositorys.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp
Bereich
cli
Issue-Typ
Feature
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

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