feat: allow the swagger path to be configurable #1425
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
nitrosx
requested changes
Sep 18, 2024
src/main.ts
Outdated
| @@ -36,8 +36,9 @@ async function bootstrap() { | |||
| docExpansion: "none", | |||
| }, | |||
| }; | |||
| const swaggerPath = process.env.SWAGGER_PATH || "explorer"; | |||
There was a problem hiding this comment.
Can you place this in the config service, please?
Junjiequan
force-pushed
the
SWAP-4199-scicat-be-make-swagger-url-configurable-
branch
from
dd47a99 to
35cf081
Compare
In configuration.ts, add a new property "versions.api" with a default value of "v3". Also, add a new property "swaggerPath" with a default value of "explorer".
Junjiequan
force-pushed
the
SWAP-4199-scicat-be-make-swagger-url-configurable-
branch
from
a611f50 to
55329e7
Compare
nitrosx
approved these changes
Sep 19, 2024
nitrosx
deleted the
SWAP-4199-scicat-be-make-swagger-url-configurable-
branch
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 makes the Swagger path configurable by allowing it to be set through the SWAGGER_PATH environment variable. If not provided, it defaults to “explorer.”
Motivation
Making the Swagger path configurable improves flexibility, allowing different paths for different environments
Fixes:
Please provide a list of the fixes implemented by this PR
Changes:
Please provide a list of the changes implemented by this PR
Tests included
Documentation
official documentation info
If you have updated the official documentation, please provide PR # and URL of the pages where the updates are included