Skip to content

Bug: no details when securitySchemes.*.name changes #802

Description

@Samuel-StO

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!

Activity

  1. added theissue type on Jul 17, 2025
  2. added this to the 2.2.0 milestone on Jul 17, 2025
  3. DrSatyr commented on Nov 14, 2026

    @DrSatyr
    Collaborator

    This isn't specific to OpenAPI 3.1, so I'm removing the 3.1 label. The same apiKey name change behaves identically with openapi: 3.0.1 and 3.1.0 on current master: the operation is marked as changed/incompatible, but there's no detail about which scheme property changed (old → new name).

    Note: in the attached old.json, security sits at the path-item level instead of under the operation. The parser ignores it there, which is why that diff came out as "backward compatible".

  4. added a commit that references this issue on Nov 14, 2026
    0aa0347
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions