fix(ws): honor PORT in swagger UI and clean up backend README #482
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
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Old behavior: 
New behavior: 
|
This commit makes 2 improvements to our existing Swagger implementation in the `backend` component
- overrides openapi.SwaggerInfo.Host at runtime to ensure the `PORT` value (which may have been overriden to != `4000`) is properly reflected in the generated Swagger HTML
- Updates the `backend` `README.md` to instruct _the reader_ to run the `backend` application and visit the Swagger webpage to learn about the available APIs.
- Removal of the markdown table and sample calls helps remove pointless developer toil and/or potential of stale/conflicting info as that information had to be manually maintained.
Signed-off-by: Andy Stoneberg <[email protected]>
andyatmiami
force-pushed
the
fix/swagger-improve
branch
from
b9c19ad to
c5c2c95
Compare
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.
This commit makes 2 improvements to our existing Swagger implementation in the
backendcomponentPORTvalue (which may have been overriden to !=4000) is properly reflected in the generated Swagger HTMLbackendREADME.mdto instruct the reader to run thebackendapplication and visit the Swagger webpage to learn about the available APIs.