Skip to content

Fix/swagger support#40

Merged
alxmra merged 8 commits intodevfrom
fix/swagger-support
Dec 19, 2025
Merged

Fix/swagger support#40
alxmra merged 8 commits intodevfrom
fix/swagger-support

Conversation

@Alexandre-A
Copy link
Copy Markdown
Contributor

Added swagger support

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds Swagger/OpenAPI support to the application using springdoc-openapi and improves the logging infrastructure by migrating from bind-mounted logs to Docker named volumes.

Key changes:

  • Added springdoc-openapi-starter-webmvc-ui dependency (version 2.3.0) for API documentation
  • Migrated application logs from bind-mounted directory (./logs) to Docker named volume (app-logs)
  • Added cleanup step in deployment workflow to remove old logs directory

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
pom.xml Added springdoc-openapi-starter-webmvc-ui dependency for Swagger/OpenAPI support
docker-compose.yml Changed log storage from bind mount to named volume for both app and promtail services; added app-logs volume definition
.github/workflows/sonarcloud.yml Added pre-checkout cleanup step to remove old logs directory, ensuring clean deployment state

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread pom.xml
Comment on lines +46 to +50
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.3.0</version>
</dependency>
Copy link

Copilot AI Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The springdoc-openapi dependency has been added, but the SecurityConfig needs to be updated to permit access to Swagger UI endpoints. Without this, users won't be able to access the Swagger documentation at the default paths like /swagger-ui.html, /swagger-ui/, /v3/api-docs/, and /api-docs/**. These paths should be added to the permitAll() list in SecurityConfig.java alongside other public endpoints.

Copilot uses AI. Check for mistakes.
@sonarqubecloud
Copy link
Copy Markdown

@alxmra alxmra merged commit cd7afff into dev Dec 19, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants