Show additions / changes to schema body

[davidpearceoracle]

Is it possible to show non-breaking changes (i.e. added fields) to the schema body? The current output simply states "changed body: 'application/json'"

If I reverse the comparison I get a message: Changed body: 'application/json' Missing property: [n].id (integer)

So a useful message would be: Changed body: 'application/json' Added property: [n].id (integer)

[Starkie]

Hi!

We are trying to automate a task in our CI pipeline that generates a report of the changed endpoints. This would allow us to notify the front end team if any changes must be made.

We'd like something like this:

--------------------------------------------------------------------------
--                            What's Changed                            --
--------------------------------------------------------------------------
- PUT    /api/User
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/json
          Schema: Backward compatible
          Added property: userName (string)
          Added property: userDescription (string)

How much effort would this feature involve? Maybe we could tackle it.

[skyellin]

I'd like to encourage you to please prioritize this change. After all, shouldn't one of the core features of a diff tool be to actually report all the differences?

[joschi]

@skyellin Could you provide a pull request to implement the required changes? 😄