This repository was archived by the owner on Sep 1, 2026. It is now read-only.
pipelines-control-service: publish Swagger UI to /data-jobs path - #677
Merged
Conversation
The Swagger UI is currently available at root / by default. Since the API is prefixed by /data-jobs, we would like for the Swagger to also be available under same path, in a consistent fashion. This unblocks services composition by dedicated path for accessing all features. Did add Swagger configuration for additional controllers redirect and resource handler. Updated an integration test to verify the path. Testing Done: did run unit tests, and also verified swagger-ui.html is accessible under /data-jobs locally Signed-off-by: ikoleva <ikoleva@vmware.com>
doks5
approved these changes
Jan 25, 2022
The Swagger UI is currently available at root / by default. Since the API is prefixed by /data-jobs, we would like for the Swagger to also be available under same path, in a consistent fashion. This unblocks services composition by dedicated path for accessing all features. Did add Swagger configuration for additional controllers redirect and resource handler. Updated an integration test to verify the path. Updated also SecurityConfiguration swagger paths. Testing Done: did run unit tests, and also verified swagger-ui.html is accessible under /data-jobs locally Signed-off-by: ikoleva <ikoleva@vmware.com>
Contributor
|
I've noticed another SwaggerConfig in the base module: https://github.com/vmware/versatile-data-kit/blob/main/projects/control-service/projects/base/src/main/java/com/vmware/taurus/service/doc/SwaggerConfig.java. Do you know what's its purpose and if it requires any attention in the context of this change? |
Contributor
Author
That's good to know; seems like a bare implementation, probably a marker one, would consider adding a comment why added to base module |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
4 participants
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.
The Swagger UI is currently available at root / by default. Since the
API is prefixed by /data-jobs, we would like for the Swagger to also be
available under same path, in a consistent fashion. This unblocks
services composition by dedicated path for accessing all features.
Did add Swagger configuration for additional controllers redirect and
resource handler. Updated an integration test to verify the path.
Updated also SecurityConfiguration swagger paths.
Testing Done: did run unit tests, and also verified swagger-ui.html is
accessible under /data-jobs locally
Signed-off-by: ikoleva ikoleva@vmware.com