OpenAPITools / OpenAPITools/openapi-diff
Support for detecting changes in webhooks
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
It would be nice to support API changes in webhooks defined with OpenAPI 3.1, in particular:
- Detect if a webhook is removed
- Detect changes in the webhook payload
Unfortunately it looks like now this is not possible.
This can be reproduced by doing:
String oldSpec = Paths.get("webhook1.yml").toUri().toString();
String newSpec = Paths.get("webhook2.yml").toUri().toString();
ChangedOpenApi diff = OpenApiCompare.fromLocations(oldSpec, newSpec);
The content of boths specs are attached here (as .txt but they are .yml specs)
Note that no differences are found in this case
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 ejecutando la reproducción de OpenApiCompare.fromLocations con las especificaciones adjuntas webhook1.txt y webhook2.txt. Rastrea cómo se comparan los webhooks de OpenAPI 3.1 y, a continuación, verifica que eliminar un webhook y cambiar su payload se informen como diferencias. Se considera terminado cuando ambos casos producen diferencias para las especificaciones proporcionadas.
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
- Nueva funcionalidad
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 42/100