This repository was archived by the owner on Aug 18, 2020. It is now read-only.
[CO-351] Re-introduce custom template for rendering swagger #3391
Conversation
This file contains hidden or 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
There's actually a bug in the current template which serves the swagger specs on an absolute url , completely ignoring any sub-path in the URL. A PR has been submitted to the upstream library (servant-swagger-ui-redoc) haskell-servant/servant-swagger-ui#53 but until it gets accepted, we need a way to serve our documentation
Now that we've _partially_ upgraded the library to LTS-11.2, we don't need anymore to host the javascript bundle for redoc, nor to read it at compile time using some template haskelly stuff. This is now done by the servant-swagger-redoc-ui itself.
akegalj
approved these changes
Aug 14, 2018
KtorZ
added a commit
that referenced
this pull request
Nov 9, 2018
…er-doc-rendering [CO-351] Re-introduce custom template for rendering swagger
KtorZ
added a commit
to input-output-hk/cardano-wallet-legacy
that referenced
this pull request
Nov 9, 2018
…hk/Squad1/CO-351/fix-swagger-doc-rendering [CO-351] Re-introduce custom template for rendering swagger
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description
There's actually a bug in the current template which serves the swagger specs on an absolute url
, completely ignoring any sub-path in the URL. A PR has been submitted to the upstream library
(servant-swagger-ui-redoc) haskell-servant/servant-swagger-ui#53 but until
it gets accepted, we need a way to serve our documentation.
This wasn't an issue before we bumped to LTS-11.2 because we were already serving the doc using a custom template and hosted files. This PR also cleans up a bit of the remaining artifacts which aren't needed anymore.
Linked issue
[CO-351]
Type of change
Developer checklist
Testing checklist
QA Steps
Screenshots (if available)