OpenAPITools / OpenAPITools/openapi-diff
Renderers should display example changes, not just schema changes
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
When a ChangedMediaType has example changes but no schema changes, the renderers (Console, Markdown, Asciidoc, HTML) currently show nothing in the details section because they only render schema changes. The ChangedMediaType model has example and examples fields that could be rendered alongside schema changes.
This was discovered while fixing https://github.com/OpenAPITools/openapi-diff/issues/870 where the NPE was caused by null schema when only examples changed.
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
Comienza localizando el modelo ChangedMediaType y los puntos de entrada de los renderizadores Console, Markdown, Asciidoc y HTML. Rastrea cómo se añaden los cambios de esquema a la sección details y, a continuación, verifica que los cambios de example y examples también se gestionen cuando no existe ningún cambio de esquema. Confirma la salida de details para los cuatro renderizadores y comprueba si ya existen pruebas de regresión.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- java
- Á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
- 48/100