OpenAPITools / OpenAPITools/openapi-diff
Output in text and markdown not equivalent (text output incomplete)
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
The text output which is printed by default by the CLI doesn't show all the information that the markdown output shows:
spec1.yaml
components:
schemas:
SomeDTO:
someProperty:
type: string
enum:
- ENUM_VALUE_1
- ENUM_VALUE_2
spec2.yaml
components:
schemas:
SomeDTO:
someProperty:
type: string
enum:
- ENUM_VALUE_1
- ENUM_VALUE_2
- ENUM_VALUE_3
markdown output
#### What's Changed
---
##### `GET` /resources1/{id}/resources2
###### Return Type:
Changed response : **200 OK**
> OK
* Changed content type : `application/json`
Changed items (object):
* Changed property `someProperty` (string)
Added enum value:
* `ENUM_VALUE_3`
text output
==========================================================================
== API CHANGE LOG ==
==========================================================================
API for Umetrics Core Project Management Service
--------------------------------------------------------------------------
-- What's Changed --
--------------------------------------------------------------------------
Return Type:
- Changed 200 OK
Media types:
- Changed application/json
Schema: Broken compatibility
- GET /resources1/{id}/resources2
API changes broke backward compatibility
--------------------------------------------------------------------------
text output tells nothing about what actually broke backwards compatibility, but since it's the stdout of the process it should show everything that's needed to determine the reason of the problem.
Alternative solution: give an option to decide which kind of output: text/markdown/json should be printed to stdout.
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 con la ruta de CLI que produce la salida de texto mostrada y compárala con el formateador markdown. Usa el ejemplo proporcionado spec1.yaml y spec2.yaml para verificar que stdout identifica la propiedad modificada y el valor del enum, o que hay disponible una opción explícita de formato de salida.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- java, openapi
- Área
- api, cli
- Tipo de issue
- Error
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 30/100