OpenAPITools / OpenAPITools/openapi-diff
false positive for type if only the format is changed.
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Java
- Estrellas
- 1.1k
- Forks
- 190
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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)
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
No se nombran archivos fuente ni pruebas. Empieza siguiendo el flujo de comparación y generación de informes que emite “Changed property type” y, después, reproduce el cambio de formato String-to-UUID proporcionado. El trabajo estará terminado cuando los cambios que solo afectan al formato ya no produzcan un informe de tipo string-to-string engañoso, con una prueba de regresión que cubra el ejemplo.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- java, openapi
- Área
- api
- Tipo de issue
- Error
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 42/100