chore(swagger): automate swagger sync to amrit-docs

[DurgaPrasad-54]

Summary by CodeRabbit

• New Features

  • Added automated workflow to synchronize API documentation to the documentation repository on code changes.

• Chores

  • Added database dependency for documentation and development environments.
  • Implemented profile-based isolation to separate documentation generation from production configurations.
  • Added configuration environment for API documentation generation with embedded database support.

[coderabbitai]

Warning

Rate limit exceeded

@DurgaPrasad-54 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 8 minutes and 43 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📝 Walkthrough

Walkthrough

This pull request introduces a Swagger profile-based configuration system for isolated API documentation builds. Changes include: a new GitHub Actions workflow that automates extracting Swagger JSON from the API and syncing it to the AMRIT-Docs repository; addition of H2 database dependency; annotation of multiple beans and configurations with @Profile("!swagger") to exclude them from Swagger profile runs; and creation of an application-swagger.properties file with profile-specific settings including in-memory databases.

Changes

Cohort / File(s)	Summary
CI/CD Automation .github/workflows/swagger-json.yml	New GitHub Actions workflow that builds the API, extracts /v3/api-docs via polling, validates with jq, and creates a pull request to sync the Swagger JSON into the AMRIT-Docs repository.
Dependency Management pom.xml	Added H2 database runtime dependency for in-memory database usage in Swagger profile.
Database Configuration src/main/java/com/iemr/common/config/PrimaryDBConfig.java, src/main/java/com/iemr/common/config/SecondaryDBConfig.java	Applied @Profile("!swagger") to both classes; removed "com.iemr.common.repo" from PrimaryDBConfig basePackages list.
Swagger Profile Exclusions src/main/java/com/iemr/common/controller/beneficiary/BeneficiaryRegistrationController.java, src/main/java/com/iemr/common/controller/secondaryReport/CustomerRelationshipSecondaryReports.java, src/main/java/com/iemr/common/service/beneficiary/BenRelationshipTypeServiceImpl.java, src/main/java/com/iemr/common/service/beneficiary/BeneficiaryOccupationServiceImpl.java, src/main/java/com/iemr/common/service/beneficiary/RegisterBenificiaryServiceImpl.java, src/main/java/com/iemr/common/service/beneficiary/SexualOrientationServiceImpl.java, src/main/java/com/iemr/common/service/reportSecondary/SecondaryReportServiceImpl.java, src/main/java/com/iemr/common/secondary/repository/callreport/CallReportSecondaryRepo.java, src/main/java/com/iemr/common/utils/FilterConfig.java, src/main/java/com/iemr/common/utils/JwtAuthenticationUtil.java, src/main/java/common/iemr/common/secondary/data/report/SecondaryCallReport.java	Applied @Profile("!swagger") annotations to exclude these beans from loading when the Swagger profile is active.
Scheduler Configuration src/main/java/com/iemr/common/config/quartz/ScheduleJobForNHMDashboardData.java	Added Profile import; no annotation applied (import preparation).
Profile-Specific Configuration src/main/resources/application-swagger.properties	New configuration file with CORS allowlist, embedded H2 datasources, JPA settings, JWT placeholders, scheduler toggle, messaging endpoint, and SpringDoc/Swagger UI enablement for Swagger profile.
Properties Cleanup src/main/resources/application.properties	Removed duplicate blank lines for formatting consistency.
Report Service Interface src/main/java/com/iemr/common/service/reportSecondary/SecondaryReportService.java	Minor formatting change (added blank line between license header and package declaration).

Sequence Diagram

sequenceDiagram
    participant GitHub as GitHub<br/>Actions
    participant API as API<br/>Server
    participant jq as Validation<br/>(jq)
    participant Docs as AMRIT-Docs<br/>Repository

    GitHub->>GitHub: Checkout API repo & build
    GitHub->>API: Start API (swagger profile on :9090)
    GitHub->>GitHub: Poll /v3/api-docs (up to 30 attempts)
    activate API
    loop Polling
        GitHub->>API: GET /v3/api-docs
        API-->>GitHub: Return Swagger JSON
    end
    deactivate API
    GitHub->>jq: Validate JSON structure
    jq-->>GitHub: Valid ✓
    GitHub->>GitHub: Write common-api.json
    GitHub->>API: Kill API process
    GitHub->>Docs: Checkout AMRIT-Docs (token auth)
    GitHub->>Docs: Copy common-api.json to docs/swagger/
    GitHub->>Docs: Create PR to main<br/>(branch: auto/swagger-update-*)

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 Hops through the code with glee,
A Swagger profile sets beans free,
H2 in memory, docs auto-sync'd,
GitHub Actions and profiles linked,
The API's dressed in profiles neat! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and specifically describes the main change: automating the synchronization of Swagger documentation to the AMRIT-Docs repository. It directly relates to the primary purpose of the changeset.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

src/main/java/com/iemr/common/config/quartz/ScheduleJobForNHMDashboardData.java (1)

34-38: ⚠️ Potential issue | 🟡 Minor

Unused import - @Profile annotation appears to be missing.

The Profile import was added but the @Profile("!swagger") annotation was not applied to the class. Based on the pattern in other files (e.g., SecondaryReportServiceImpl, CallReportSecondaryRepo), this scheduled job should likely be excluded from the swagger profile to prevent it from running during Swagger documentation generation.

🔧 Proposed fix

 import org.springframework.context.annotation.Profile;
 
 `@Service`
+@Profile("!swagger")
 `@Transactional`
 public class ScheduleJobForNHMDashboardData implements Job {

🧹 Nitpick comments (4)

.github/workflows/swagger-json.yml (2)

77-88: Consider adding delete-branch: true to clean up after merge.

The create-pull-request action will create new branches (auto/swagger-update-<run_id>) on each run. Without cleanup, these branches will accumulate in the AMRIT-Docs repository after PRs are merged.

♻️ Proposed fix

       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v6
         with:
           token: ${{ secrets.DOCS_REPO_TOKEN }}
           path: amrit-docs
           branch: auto/swagger-update-${{ github.run_id }}
           base: main
           commit-message: Auto-update Common-API swagger
           title: Auto-update Common-API swagger
+          delete-branch: true
           body: |
             This PR automatically updates the Common-API Swagger JSON
             from the latest main branch build.

---

8-11: Consider adding a job timeout.

The workflow lacks a timeout-minutes setting. If the API fails to start or hangs, the job could run for up to 6 hours (GitHub's default limit). Adding a timeout would fail fast and conserve CI resources.

♻️ Proposed fix

 jobs:
   swagger-sync:
     runs-on: ubuntu-latest
+    timeout-minutes: 15

src/main/resources/application-swagger.properties (1)

15-15: Use consistent placeholder format for jwt.secret.

The jwt.secret value JWT_SECRET appears to be a literal string rather than following the placeholder pattern used elsewhere in this file (e.g., <Enter_SMS_Password>, <Enter_Username>). For consistency and to clearly indicate this is a placeholder requiring replacement, consider using a similar format.

Suggested change

-jwt.secret=JWT_SECRET
+jwt.secret=<Enter_JWT_Secret>

Based on learnings: "JWT secrets should be configured using placeholders (e.g., <Enter_Your_Secret_Key>) in properties files... to prevent accidental commit of actual secrets."

src/main/java/com/iemr/common/config/PrimaryDBConfig.java (1)

51-51: Consider using import instead of fully qualified class name.

Other files in this PR import Profile and use @Profile("!swagger"). For consistency, consider adding the import and using the short form here as well.

Suggested change

Add import at the top of the file:

import org.springframework.context.annotation.Profile;

Then change:

-@org.springframework.context.annotation.Profile("!swagger")
+@Profile("!swagger")

[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