pipelines-control-service: publish Swagger UI to /data-jobs path #677
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 <[email protected]>
...s_control_service/src/integration-test/java/com/vmware/taurus/datajobs/it/DataJobCrudIT.java
Show resolved
Hide resolved
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 <[email protected]>
|
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? |
That's good to know; seems like a bare implementation, probably a marker one, would consider adding a comment why added to base module |
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 [email protected]