OpenAPITools / OpenAPITools/openapi-diff

false positive for type if only the format is changed.

Aperta
#248 2 commenti 3 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Java
Stelle
1.1k
Fork
190
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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)

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Non sono indicati file sorgente né test. Inizia tracciando il percorso di confronto e generazione dei report che emette “Changed property type”, quindi riproduci la modifica di formato String-to-UUID fornita. Il lavoro è completato quando le modifiche che riguardano solo il formato non producono più un report di tipo string-to-string fuorviante, con un test di regressione che copra l'esempio.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
java, openapi
Ambito
api
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.