diff --git a/README.md b/README.md index 8fd02c7..8f0ac4a 100644 --- a/README.md +++ b/README.md @@ -50,3 +50,22 @@ Then one PR will be open for each SDKs. ``` +## FAQ + + +Q: Why maintain some hack instead of fixing the SDKs generator. + +A: they are 2 problems with upgrading the generator: +- The first is that it is not an easy task, it requires to port the patch use by the SDKs, and it requires intense testing if we don't want a regression. +- Second problems, is that some features like `oneOf`, would require a breaking changes, so a new major versions of SDKs, which would force all clients to upgrade the code. + + +Q: OK, but then why no just fix osc-api.yaml file: + +A: Because the API file is not bugged per-say, it just uses features that wasn't avaible the moment we made the first SDKs versions. + + +Q: So that mean those weird patch will stay forever ? + +A: No, we might at some point upgrade every generator, and push a new major versions of all concerned SDKs, but when this will happen, we will still have to maintain old SDKs versions for a few time. +