Skip to content

Commit

Permalink
add FAQ
Browse files Browse the repository at this point in the history
  • Loading branch information
Open-Source-Bot committed Oct 29, 2024
1 parent f18a01e commit d1ab7c3
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit d1ab7c3

Please sign in to comment.