Skip to content

Console rendering missing sections since 2.1.0-beta.7 #594

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
Closed
TheFreaky opened this issue Dec 8, 2023 · 0 comments · Fixed by #595
Closed

Console rendering missing sections since 2.1.0-beta.7 #594

TheFreaky opened this issue Dec 8, 2023 · 0 comments · Fixed by #595
Assignees
@TheFreaky
Labels
bug
Milestone
2.1.0

Comments

@TheFreaky
Copy link
Contributor

The following sections are absent in the console output:

  • What's New
  • What's Deleted
  • What's Deprecated

The "What's Changed" section formatting is broken.
The "Result" title is absent.

This issue was introduced in #544.

Specification:
petstore_v2_1.yaml
petstore_v2_2.yaml

Diff example:
Version: 2.1.0-beta.6

==========================================================================
==                            API CHANGE LOG                            ==
==========================================================================
                             Swagger Petstore                             
--------------------------------------------------------------------------
--                              What's New                              --
--------------------------------------------------------------------------
- GET    /pet/{petId}

--------------------------------------------------------------------------
--                            What's Deleted                            --
--------------------------------------------------------------------------
- POST   /pet/{petId}

--------------------------------------------------------------------------
--                          What's Deprecated                           --
--------------------------------------------------------------------------
- GET    /user/logout

--------------------------------------------------------------------------
--                            What's Changed                            --
--------------------------------------------------------------------------
- DELETE /pet/{petId}
  Parameter:
    - Add newHeaderParam in header
...

--------------------------------------------------------------------------
--                                Result                                --
--------------------------------------------------------------------------
                 API changes broke backward compatibility                 
--------------------------------------------------------------------------

Version: 2.1.0-beta.7

==========================================================================
==                            API CHANGE LOG                            ==
==========================================================================
                             Swagger Petstore                             
--------------------------------------------------------------------------
--                            What's Changed                            --
--------------------------------------------------------------------------
  Parameter:
    - Add newHeaderParam in header
- DELETE /pet/{petId}
...

                 API changes broke backward compatibility                 
--------------------------------------------------------------------------
@TheFreaky TheFreaky mentioned this issue Dec 8, 2023
Merged
@joschi joschi changed the title Fix console rendering Console rendering missing sections since 2.1.0-beta.7 Dec 16, 2023
@joschi joschi added the bug label Dec 16, 2023
@joschi joschi added this to the 2.1.0 milestone Dec 16, 2023
joschi pushed a commit that referenced this issue Dec 16, 2023
@TheFreaky
Fix console rendering (#595)
e40b07b 
This fixes console rendering:

- absence of "What's New", "What's Deleted", "What's Deprecated" sections
- Incorrect formatting in "What's Changed" section
- absence of "Result" title

Closes #594
Refs #544

Co-authored-by: Maksim Kuznetsov <mkuznetsov@natera.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@TheFreaky TheFreaky

Labels
bug
Projects
None yet
Milestone
2.1.0
Development

Successfully merging a pull request may close this issue.

fix(594): fix console rendering TheFreaky/openapi-diff
2 participants
@joschi @TheFreaky