Feat/wait for update openapi document #23
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MarcioMeier
force-pushed
the
feat/wait-for-update-openapi-document
branch
from
b2921e6 to
9f671a8
Compare
flaviostutz
approved these changes
Jun 5, 2024
| '>>> Wait for 2 minutes for the WSO2 api changes propagate before updating Openapi document...', | ||
| ); | ||
| // eslint-disable-next-line no-promise-executor-return, promise/param-names | ||
| await new Promise((resolveP) => setTimeout(resolveP, 120000)); |
There was a problem hiding this comment.
discussion: Different clusters of WSO2 might behave in different ways, so we could simply continue retrying until this is set, shouldn't we? (or is this something we can't check if was updated correctly?)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
WSO2 has a few overlap fields between the api definition and the openapi document.
We already check for those changes in the
checkWSO2Equivalencemethod, but it seems to take a while to propagate to the openapi document. If update the openapi document right after updating the api defs, the changes may not be propagated and the final version will not reflect the new definitions.It is an known issue, take a look in these discussions from serverless apim plugin:
hangSecondsBeforeUpsertingSwaggeroption ramgrandhi/serverless-wso2-apim#114What was changed?
I added a function in the beginning of the deployment to check if there are changes in these overlap fields.
If so, we hang for 2 minutes before updating the openapi document... As far as I tested, 2 minutes is more than enough to WSO2 propagate all the info.