Remove hapi-swagger, use static json #396
Merged
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.
✏️ Changes
hapi-swagger
was causing an issue with conflicting versions ofjoi
, which it requires as a subdependency vs the version ofjoi
used by the main project.hapi-swagger
as a dependency, instead storing it's output as a static json file in the repo. This is deemed to be suitable as there is no intention to modify the API of the extension in future, but it should be noted that if we ever did, we'd need to manually update that JSON file in order to update the API explorer.📷 Screenshots
Tested in
prod-us-4
usingjoi@17.12.2
Test in
prod-jp-1
usingjoi@17.12.2
🔗 References
🎯 Testing
/extensions/deploy
using the extensions-deployment tool/extensions/develop
✅ This change has been tested in a Webtask
🚫 This change has unit test coverage
🚫 This change has integration test coverage
🚫 This change has been tested for performance
🚀 Deployment
✅ This can be deployed any time
🎡 Rollout
In order to verify that the deployment was successful we will deploy the extensions in
/extensions/develop
and test in a prod tenant🔥 Rollback
We will rollback if we encounter any issues
📄 Procedure