Swagger changes

[ravishanigarapu]

📋 Description

JIRA ID: AMM-1186

Please provide a summary of the change and the motivation behind it. Include relevant context and details.

---

✅ Type of Change

• 🐞 Bug fix (non-breaking change which resolves an issue)
• ✨ New feature (non-breaking change which adds functionality)
• 🔥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
• 🛠 Refactor (change that is neither a fix nor a new feature)
• ⚙️ Config change (configuration file or build script updates)
• 📚 Documentation (updates to docs or readme)
• 🧪 Tests (adding new or updating existing tests)
• 🎨 UI/UX (changes that affect the user interface)
• 🚀 Performance (improves performance)
• 🧹 Chore (miscellaneous changes that don't modify src or test files)

---

ℹ️ Additional Information

Please describe how the changes were tested, and include any relevant screenshots, logs, or other information that provides additional context.

Summary by CodeRabbit

• New Features
  • Added configuration options to enable or disable API documentation and Swagger UI through an environment variable.
• Bug Fixes
  • Expanded the list of endpoints that bypass JWT validation to include Swagger UI, API docs, and token refresh endpoints.
  • Extended the set of request paths exempt from authorization checks to cover additional Swagger-related resources.

[coderabbitai]

Walkthrough

The changes expand the configuration and code logic to support Swagger API documentation endpoints in a CI environment. Two new properties are introduced in the configuration file to enable or disable API documentation and Swagger UI via an environment variable. In the Java code, both the JWT validation filter and an HTTP interceptor are updated to exclude Swagger-related endpoints from authentication and authorization checks, allowing requests to these endpoints to bypass security filters.

Changes

File(s)	Change Summary
src/main/environment/common_ci.properties	Added two properties: springdoc.api-docs.enabled and springdoc.swagger-ui.enabled, both controlled by SWAGGER_DOC_ENABLED.
src/main/java/com/iemr/mmu/utils/JwtUserIdValidationFilter.java	Extended exclusion logic to skip JWT validation for /swagger-ui, /v3/api-docs, and /user/refreshToken endpoints.
src/main/java/com/iemr/mmu/utils/http/HttpInterceptor.java	Updated the preHandle method to bypass authorization for "index.html", "swagger-initializer.js", and "swagger-config" URIs.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant HttpInterceptor
    participant JwtUserIdValidationFilter
    participant Application

    Client->>HttpInterceptor: Request (any URI)
    alt URI is swagger or index.html/swagger-initializer.js/swagger-config
        HttpInterceptor-->>Application: Allow without authorization
    else
        HttpInterceptor->>JwtUserIdValidationFilter: Pass request
        alt URI is /swagger-ui, /v3/api-docs, /user/refreshToken, etc.
            JwtUserIdValidationFilter-->>Application: Allow without JWT validation
        else
            JwtUserIdValidationFilter->>Application: Validate JWT and user ID
        end
    end

Loading

Poem

In the warren where code and carrots grow,
Swagger docs now have a place to show.
Filters and interceptors hop aside,
Letting API docs through with pride.
With configs set by env so neat,
Our documentation journey is now complete!
🥕✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f8fe7cc and c1537fd.

📒 Files selected for processing (3)

• src/main/environment/common_ci.properties (1 hunks)
• src/main/java/com/iemr/mmu/utils/JwtUserIdValidationFilter.java (1 hunks)
• src/main/java/com/iemr/mmu/utils/http/HttpInterceptor.java (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Analyze (java)

🔇 Additional comments (3)

src/main/environment/common_ci.properties (1)

85-86: Good addition of Swagger documentation configuration properties.

These new properties control the visibility of API documentation and Swagger UI in the application, both tied to the same environment variable SWAGGER_DOC_ENABLED. This allows for centralized control of Swagger documentation features in the CI environment, making it easy to enable/disable as needed.

src/main/java/com/iemr/mmu/utils/http/HttpInterceptor.java (1)

88-90: Correctly exempt additional Swagger UI resources from authorization checks.

These additions properly exempt key Swagger UI resources from authorization validation:

• index.html: The main Swagger UI HTML page
• swagger-initializer.js: JavaScript file that initializes the Swagger UI interface
• swagger-config: Configuration settings for the Swagger UI

This ensures that all necessary Swagger UI components will be accessible without authorization, consistent with the configuration properties added.

src/main/java/com/iemr/mmu/utils/JwtUserIdValidationFilter.java (1)

58-60: Properly exempt Swagger endpoints and token refresh from JWT validation.

These changes correctly exclude three important paths from JWT token validation:

1. /swagger-ui: Allows access to the Swagger UI interface
2. /v3/api-docs: Permits access to the OpenAPI documentation endpoints
3. /user/refreshToken: Enables token refresh functionality without requiring a valid token

The first two exclusions align with the Swagger documentation changes in the other files, while the token refresh endpoint exclusion is a standard pattern to allow users with expired tokens to obtain new ones.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[sonarqubecloud]

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud