add FAQ #21
add FAQ #21
Conversation
outscale-mgo
force-pushed
the
faq
branch
2 times, most recently
from
3a0fba9 to
d1ab7c3
Compare
|
|
||
|
|
||
| Q: Why maintain some hack instead of fixing the SDKs generator. | ||
|
|
There was a problem hiding this comment.
Why rely on a hack instead of addressing the issue with the SDK generator?
README.md
Outdated
|
|
||
| Q: Why maintain some hack instead of fixing the SDKs generator. | ||
|
|
||
| A: they are 2 problems with upgrading the generator: |
There was a problem hiding this comment.
There are two problems with upgrading the generator
README.md
Outdated
| 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. |
There was a problem hiding this comment.
The first issue is that it's not an easy task; it requires porting the patch used by the SDKs and extensive testing to prevent regressions.
README.md
Outdated
|
|
||
| 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. |
There was a problem hiding this comment.
The second problem is that some features, like oneOf, would require breaking changes, necessitating a new major version of the SDKs and forcing all clients to upgrade their code.
README.md
Outdated
| - 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: |
There was a problem hiding this comment.
Then why not just fix the osc-api.yaml file?
README.md
Outdated
|
|
||
| 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. |
There was a problem hiding this comment.
Because the API file isn’t technically bugged; it simply uses features that weren’t available when we created the first SDK versions.
README.md
Outdated
| 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 ? |
There was a problem hiding this comment.
Does that mean those strange patches will stay forever?
README.md
Outdated
|
|
||
| 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. |
There was a problem hiding this comment.
No, at some point, we may upgrade every generator and release new major versions of all relevant SDKs. However, when this happens, we’ll still need to maintain the older SDK versions for a while.
No description provided.