budaidev commented on PR #5515:
URL: https://github.com/apache/fineract/pull/5515#issuecomment-3936610379
@vidakovic that's an excellent question. The basic idea, that this check is
not a strict must-have check, but more like an informative check. If we break a
working API solution, we should be aware of it.
However there are still different options to tackle this problem, if we want
to have a green pipeline:
1. we could exclude certain pathes, for example:
```
swaggerBrake {
excludedPaths = [
'/v1/smscampaigns',
'/v1/email',
'/v1/twofactor',
]
}
```
2. We can mark unstable APIs as beta in swagger. This makes the script skip
these endpoints.
3. It is also possible to add a list of allowed breaking changes in the
configuration, which is a possibility, however not the best for long term.
You can choose any of these solutions listed, or you can decide to just
ignore this error as a whole. It's a good idea to include this topic to the
documentation once it is ready.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
