OpenAPITools / OpenAPITools/openapi-diff

Bug: no details when securitySchemes.*.name changes

Open
#802 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

OpenAP 3.1.0 Support
Dominant language
Java
Stars
1.1k
Forks
190
PR merge metrics
No merged PRs in 30d

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!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the attached old.json and new.json specifications, then trace the securitySchemes apiKey name-change handling and the incompatible.security.scheme.scheme.change option. The fix should report the changed path, field, and old and new values, while allowing that rule to be disabled; verify the API change log reflects these details.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.