OpenAPITools / OpenAPITools/openapi-diff

Bug: no details when securitySchemes.*.name changes

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

Nadie ha tomado este issue todavía.

OpenAP 3.1.0 Support
Lenguaje dominante
Java
Estrellas
1.1k
Forks
190
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

Description

When a change is introduced solely to the name property of an apiKey securitySchemes object in an OpenAPI 3.1 specification, openapi‑diff merely reports that a change occurred without providing any line‑level detail (path, field changed, old and new values).In addition, there appears to be no way to disable this rule via the usual options. (incompatible.security.scheme.scheme.change:false)

old.json
new.json

==========================================================================
==                            API CHANGE LOG                            ==
==========================================================================
                             **** Restful API
--------------------------------------------------------------------------
--                            What's Changed                            --
--------------------------------------------------------------------------
- GET    /rest/v1/info
--------------------------------------------------------------------------
--                                Result                                --
--------------------------------------------------------------------------
                   API changes are backward compatible
--------------------------------------------------------------------------

Thanks for your help!

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.

Línea de trabajo

Comienza comparando las especificaciones old.json y new.json adjuntas y, a continuación, rastrea el manejo del cambio de nombre de securitySchemes apiKey y de la opción incompatible.security.scheme.scheme.change. La corrección debe informar de la ruta, el campo y los valores antiguo y nuevo modificados, permitiendo a la vez deshabilitar esa regla; verifica que el registro de cambios de la API refleje estos detalles.

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
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.