microsoft / microsoft/OpenAPI.NET

OpenApiComparer is not implemented

Offen
#414 9 Kommentare 5 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

priority:p2 type:enhancement
Vorherrschende Sprache
C#
Sterne
1.6k
Forks
286
Ø Merge
6 Std. 38 Min.
Gemergte PRs (30 T.)
35

Beschreibung

Hello,

My team is using this repository to generate our OpenAPI document, and we started using the OpenApiComparer recently in our project. This method returns a value so we believed it was working until recently when after making a change this still returned an empty list.

After looking at the implementation it's quite clear that this method does nothing but it is documented as being a method that "Compares two OpenApiDocuments and returns a list of differences.".

I believe this method should be removed or should throw instead.

After looking a bit more, there seems to be a valid implementation of this in the vnext branch that was never merged into master.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, src/Microsoft.OpenApi/Services/OpenApiComparer.cs zu lesen und die gültige Implementierung im vnext-Branch zu untersuchen. Ermittle, ob die beabsichtigte Lösung darin besteht, die Methode zu entfernen, sie eine Ausnahme auslösen zu lassen oder die vnext-Implementierung zu übernehmen; abgeschlossen ist die Aufgabe, wenn OpenApiComparer bei einem Vergleich nicht mehr stillschweigend ein leeres Ergebnis zurückgibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp, openapi
Bereich
api
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 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.