OpenAPITools / OpenAPITools/openapi-diff

Bug: no details when securitySchemes.*.name changes

Ouverte
#802 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

OpenAP 3.1.0 Support
Langage dominant
Java
Étoiles
1.1k
Forks
190
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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!

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par comparer les spécifications old.json et new.json jointes, puis suivez la gestion du changement de nom de securitySchemes apiKey et de l’option incompatible.security.scheme.scheme.change. La correction doit signaler le chemin, le champ et les anciennes et nouvelles valeurs modifiés, tout en permettant de désactiver cette règle ; vérifiez que le journal des modifications de l’API reflète ces détails.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
java
Domaine
api
Type d'issue
Bug
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.