Swagger enable or dissable changes

[ravishanigarapu]

📋 Description

JIRA ID: AMM-1186

Swagger enable changes

---

✅ 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

  • Enabled API documentation and Swagger UI for easier access to API details and testing in certain environments.

• Bug Fixes

  • Updated authentication filter to allow access to Swagger UI, API documentation, and token refresh endpoints without requiring JWT validation.

• Chores

  • Minor formatting update in configuration files.

[coderabbitai]

Walkthrough

The changes update configuration files to enable or allow dynamic control of Springdoc API documentation and Swagger UI features based on environment variables or explicit property settings. Additionally, the JWT validation filter is modified to bypass validation for requests targeting Swagger UI, API documentation, and token refresh endpoints, expanding the list of endpoints excluded from authentication checks. One configuration file receives a minor formatting update with an added blank line.

Changes

File(s)	Change Summary
src/main/environment/ecd_ci.properties	Changed Springdoc API docs and Swagger UI enablement properties from static false to use environment variable placeholders.
src/main/environment/ecd_example.properties	Added properties to enable Springdoc API docs and Swagger UI (true).
src/main/environment/ecd_uat.properties	Added a blank line at the end of the file.
src/main/java/com/iemr/ecd/utils/mapper/JwtUserIdValidationFilter.java	Expanded filter exclusion logic to skip JWT validation for Swagger UI, API docs, and refresh token endpoints.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant JwtUserIdValidationFilter
    participant Application

    Client->>JwtUserIdValidationFilter: HTTP Request (any endpoint)
    alt Excluded Path (login, logout, public, swagger, api-docs, refreshToken)
        JwtUserIdValidationFilter->>Application: Pass request without JWT validation
    else Other Paths
        JwtUserIdValidationFilter->>JwtUserIdValidationFilter: Perform JWT validation
        alt JWT valid
            JwtUserIdValidationFilter->>Application: Pass request
        else JWT invalid
            JwtUserIdValidationFilter->>Client: Respond with error
        end
    end

Loading

Poem

In configs and filters, a hop and a leap,
Swagger and docs now wake from their sleep.
JWT skips for docs, so devs can explore,
With tokens and endpoints, there’s less to ignore.
A blank line, a tweak, and features anew—
The code garden grows, as all bunnies knew!
🐇✨

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

• We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

---

📜 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 5e9973f and be7511a.

📒 Files selected for processing (4)

• src/main/environment/ecd_ci.properties (1 hunks)
• src/main/environment/ecd_example.properties (1 hunks)
• src/main/environment/ecd_uat.properties (1 hunks)
• src/main/java/com/iemr/ecd/utils/mapper/JwtUserIdValidationFilter.java (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

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

Learnt from: ravishanigarapu
PR: PSMRI/ECD-API#55
File: src/main/environment/ecd_uat.properties:19-20
Timestamp: 2025-01-22T12:20:25.782Z
Learning: In the ECD-API project, Swagger UI and API docs should be enabled (set to true) in all lower environments (DEV, TEST, UAT) to facilitate API testing and documentation. Only the production environment should have these disabled.

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

• GitHub Check: Analyze (java)

🔇 Additional comments (4)

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

19-22: Properly configured Swagger documentation for example environment.

The addition of Springdoc configuration properties properly enables API documentation and Swagger UI for the example environment, which is appropriate for development and testing purposes.

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

28-29: Good implementation of environment-variable controlled Swagger documentation.

Using environment variables for Swagger configuration allows for flexible control across different deployment environments. Both settings share the same variable, ensuring consistent behavior for API docs and UI.

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

58-60: Correctly implemented JWT validation bypass for Swagger UI and API docs.

These changes appropriately exempt Swagger UI, API documentation, and token refresh endpoints from JWT validation, which is necessary for these components to function properly. The implementation correctly prepends the context path and uses startsWith() to match all relevant paths.

In production environments, ensure Swagger is disabled or properly secured if enabled, as these endpoints now bypass authentication.

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

25-25: Minor formatting change with no functional impact.

The addition of a blank line is a minor formatting change that has no impact on functionality. The UAT environment already correctly has Swagger enabled as per project standards.

✨ 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
0 New issues
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