OpenAPITools / OpenAPITools/openapi-diff

false positive for type if only the format is changed.

Offen
#248 2 Kommentare 3 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

i changed the format of a string property.
e.g. when generated out of java and the propery is now mapped via Spring from a String to a UUID.

Perhaps it's correct to report a change. but the change is not on the type but on the format.
and therefore userUid (string -> string) does not help.

old

"ServicePageInteractionRequest":{
   "type":"object",
   "properties":{
      "userUid":{
         "type":"string"
      },
      ...
   }
}

new

"ServicePageInteractionRequest" : {
   "type" : "object",
   "properties" : {
      "userUid" : {
         "type" : "string",
         "format" : "uuid",
         "example" : "5412185d-2cf1-46d0-85d3-50bfc93b1122"
       },
      ...
   }
}

report:

Changed property type: userUid (string -> string)

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

Es werden keine Quelldateien oder Tests genannt. Beginne damit, den Vergleichs- und Berichtspfad nachzuverfolgen, der „Changed property type“ ausgibt, und reproduziere dann die bereitgestellte String-to-UUID-Formatänderung. Die Aufgabe ist erledigt, wenn Änderungen ausschließlich am Format keinen irreführenden String-to-String-Typbericht mehr erzeugen und ein Regressionstest das Beispiel abdeckt.

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
42/100

Neue Issues direkt in Ihr Postfach

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