Tufin / oasdiff

OpenAPI Diff and Breaking Changes

Home Page:https://www.oasdiff.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Include property name in error message

bdoughan-snow opened this issue · comments

Is your feature request related to a problem? Please describe.

It would be helpful if a problem is detected in a specific property that the message include the name of the property. Below is the current message that does not indicate the property.
Error: in API GET /api/pet-store/v1/pets the response's property type/format changed from ''/'' to 'object'/'' for status '200'

Describe the solution you'd like

It would be better if the problematic property was in the error message (i.e. age)
Error: in API GET /api/pet-store/v1/pets the response's "age" property type/format changed from ''/'' to 'object'/'' for status '200'

Describe alternatives you've considered

I have not found any alternatives currently each property in the response must be looked at to find the error.

Additional context

NA

This would be a hugely appreciated addition; currently the message isn't sufficient to let readers know what has actually changed, especially in complex schemas.

I'll work on this issue