Skip to content

Refactoring a schma with "$ref" results in false positive breaking change #192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
jo-gre opened this issue Oct 23, 2020 · 1 comment · May be fixed by #335
Open

Refactoring a schma with "$ref" results in false positive breaking change #192

jo-gre opened this issue Oct 23, 2020 · 1 comment · May be fixed by #335
Labels
Breaking/Non-Breaking classification Issues related to Breaking/Non-Breaking changes classification help wanted
Milestone
2.2.0

Comments

@jo-gre
Copy link

jo-gre commented Oct 23, 2020

The bug
When splitting a schema into two schemas where one refers with allOf to the other the diff shows breaking change, even if the end structure is the same.

To Reproduce

Example schema old.yaml:

openapi: "3.0.0"
info:
  title: Sample API
  description: API description in Markdown.
  version: 1.0.0
servers: []
paths:
  /test:
    get:
      summary: Your GET endpoint
      tags: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/working'
components:
  schemas:
    working:
      type: object
      properties:
        foo:
          type: string
        bar:
          type: integer

Example schema new.yaml:

openapi: 3.0.0
info:
  title: Sample API
  description: API description in Markdown.
  version: 1.1.0
servers: []
paths:
  /test:
    get:
      summary: Your GET endpoint
      tags: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/working'
      operationId: get-test
components:
  schemas:
    working:
      allOf:
        - type: object
          properties:
            foo:
              type: string
        - $ref: '#/components/schemas/bar'
    bar:
      type: object
      properties:
        bar:
          type: integer

Result of docker run -v $(pwd):/tmp openapitools/openapi-diff:latest /tmp/old.yaml /tmp/new.yaml:

==========================================================================
==                            API CHANGE LOG                            ==
==========================================================================
                                Sample API                                
--------------------------------------------------------------------------
--                            What's Changed                            --
--------------------------------------------------------------------------
- GET    /test
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/json
          Schema: Broken compatibility
          Changed property type:  (object -> object)
--------------------------------------------------------------------------
--                                Result                                --
--------------------------------------------------------------------------
                 API changes broke backward compatibility                 
--------------------------------------------------------------------------

Expected behavior
The tool is expected to notice a change but not a breaking one since the allOf mapping results in the same schema after resolving.
@stefanvitz stefanvitz mentioned this issue Jul 13, 2021
Open
M0dM added a commit to M0dM/openapi-diff that referenced this issue Feb 18, 2022
@M0dM
Add testSameTypeResponseSchemaDIff based on issue OpenAPITools#192.
9813779
@M0dM
Copy link

M0dM commented Feb 18, 2022

I have opened a PR, with a failing test with your schema examples.

@joschi joschi linked a pull request Mar 3, 2022 that will close this issue
Open
@joschi joschi added the bug label Mar 3, 2022
@joschi joschi added this to the 2.1.0 milestone Mar 3, 2022
@DrSatyr DrSatyr added help wanted and removed bug labels Jan 31, 2025
@DrSatyr DrSatyr added the Breaking/Non-Breaking classification Issues related to Breaking/Non-Breaking changes classification label Apr 24, 2025
@DrSatyr DrSatyr modified the milestones: 2.1.0, 2.2.0 Apr 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Breaking/Non-Breaking classification Issues related to Breaking/Non-Breaking changes classification help wanted
Projects
None yet
Milestone
2.2.0
Development

Successfully merging a pull request may close this issue.

Fix: BUG#192 false positive for type if only the format is changed. M0dM/openapi-diff
4 participants
@joschi @M0dM @DrSatyr @jo-gre