feature: full-spectrum runtime Docker configuration#4965
Merged
Conversation
b96099b to
9ae643f
Compare
Contributor
Author
|
please build |
|
This feature is not availble anymore as of v3.24.2. |
|
Is there a replacement for OAUTH2_REDIRECT_URL env for swagger 5? |
JuanSW18
pushed a commit
to Digital-Paw/digital-paw-swagger-ui
that referenced
this pull request
Aug 23, 2024
…4965) * reorganize docker things * Configurator WIP * implement Docker runtime config generator * add tests * update documentation * fix Markdown tables * Move Docker section * add note to README * move up `nodejs` install for more aggressive caching * drop exclusive test * fix missing `DISPLAY_OPERATION_ID`
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
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.
Description
This PR overhauls our Docker image's method of injecting configuration values into Swagger UI.
Broadly, it solves the following problems:
sedapproach of editing things on the fly was difficult to testIt introduces the following new environment variables:
CONFIG_URLDEEP_LINKINGDEFAULT_MODEL_EXPAND_DEPTHDEFAULT_MODEL_RENDERINGDEFAULT_MODELS_EXPAND_DEPTHDISPLAY_OPERATION_IDDISPLAY_REQUEST_DURATIONDOC_EXPANSIONDOM_IDFILTERLAYOUTMAX_DISPLAYED_TAGSOAUTH2_REDIRECT_URLSHOW_COMMON_EXTENSIONSSHOW_EXTENSIONSSHOW_MUTATED_REQUESTSPECSUPPORTED_SUBMIT_METHODSURLURLS_PRIMARY_NAMEURLSVALIDATOR_URLIt deprecates the following existing environment variables, which will continue to work until v4.0:
API_URLAPI_URLSMotivation and Context
How Has This Been Tested?
I added unit tests for the config object generator, and manually tested functionality with a local Docker image.
Screenshots (if appropriate):
Checklist
My PR contains...
src/is unmodified: changes to documentation, CI, metadata, etc.)package.json)My changes...
Documentation
Automated tests