OpenAPITools / OpenAPITools/openapi-diff

Bug: no details when securitySchemes.*.name changes

Offen
#802 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

OpenAP 3.1.0 Support
Vorherrschende Sprache
Java
Sterne
1.1k
Forks
190
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

Description

When a change is introduced solely to the name property of an apiKey securitySchemes object in an OpenAPI 3.1 specification, openapi‑diff merely reports that a change occurred without providing any line‑level detail (path, field changed, old and new values).In addition, there appears to be no way to disable this rule via the usual options. (incompatible.security.scheme.scheme.change:false)

old.json
new.json

==========================================================================
==                            API CHANGE LOG                            ==
==========================================================================
                             **** Restful API
--------------------------------------------------------------------------
--                            What's Changed                            --
--------------------------------------------------------------------------
- GET    /rest/v1/info
--------------------------------------------------------------------------
--                                Result                                --
--------------------------------------------------------------------------
                   API changes are backward compatible
--------------------------------------------------------------------------

Thanks for your help!

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

Beginnen Sie mit dem Vergleich der Spezifikationen old.json und new.json und verfolgen Sie anschließend die Behandlung der Namensänderung von securitySchemes apiKey sowie der Option incompatible.security.scheme.scheme.change. Die Korrektur sollte den geänderten Pfad, das Feld sowie die alten und neuen Werte melden und gleichzeitig ermöglichen, diese Regel zu deaktivieren; überprüfen Sie, dass das API-Änderungsprotokoll diese Details widerspiegelt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

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