OpenAPITools / OpenAPITools/openapi-diff

allOf : `type` of property contained in multiple subschemas is not correctly determined.

Offen
#392 4 Kommentare 2 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

Given the following schema V1:

Foo:
  allOf:
    - properties:
        propA:
          type: string
    - properties:
        propA:
          example: "YEEHAA"

is changed to the following schema V2:

Foo:  
  properties:
    propA:
      type: string

openapi-diff incorrectly detects the following incompatible change:
Changed property type (object -> string)

It seems to me that the type of a property that is contained in multiple subschemas of an allOf is not correctly determined. Openapi-diff recognized the type of propA in schema V1 as an object, but this is not correct.

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, den Vergleich zwischen den bereitgestellten V1- und V2-Schemas zu reproduzieren, mit Fokus auf Foo, allOf und die wiederholte Definition von propA. Untersuche, wie der Diff den Typ von propA über alle allOf-Subschemas hinweg bestimmt. Die Aufgabe ist abgeschlossen, wenn der Vergleich für diesen Fall keine inkompatible Änderung des Typs von Objekt zu String mehr meldet.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
java, 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.