Documentation for config file

[Virensk]

Hello,

I see that the tool supports config files, and there is an example in the tests as well. However, it's not very clear what the different options are, and how to specify what's incompatible at what level of granularity and the like. Could you please share some documentation or more detailed examples on what these files should look like, for more advanced cases.

Thanks,
Viren

[DrSatyr]

Hello, based on the codebase this configuration file is coupled directly with BackwardIncompatibleProp enum. So basically this enum describes all possible properties and their default values. I suppose it can be a clue for you about what this conf file should consist of.

You can navigate through ENUM values usage, and determine the level of granularity for each of them. Of course, it is not convenient, but we have no other options at the moment.

[Virensk]

Thanks for the reply. That makes sense, I was hoping it would be a bit more flexible than that, but if it's hardcoded into the checks, it seems like we have to use these as a base for backward incompatibility checking.

[DrSatyr]

Yeah, in my project we relied only on diff capabilities from openapi-diff. logic related to detecting breaking changes, results rendering was added on our own on top of it.

[Virensk]

That makes sense, thanks for the tip.