Support for detecting changes in webhooks

Abierto
#793 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
42/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
java, openapi
Área
api

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.

Descripción

OpenAP 3.1.0 Support

It would be nice to support API changes in webhooks defined with OpenAPI 3.1, in particular:

  1. Detect if a webhook is removed
  2. 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)

webhook1.txt

webhook2.txt

Note that no differences are found in this case

Lenguaje dominante
Java
Estrellas
1.1k
Forks
190
Sin PR fusionados en 30 d

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de OpenAPITools/openapi-diff

Todos los issues de OpenAPITools/openapi-diff

Issues similares

Más issues de Java

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.