MOSIP-45089 - Updated the AddIdentity with respect to the new ID Schema driven request body

[mohanachandran-s]

MOSIP-45089 - Updated the AddIdentity with respect to the new ID Schema driven request body

Summary by CodeRabbit

• Documentation

  • Added comprehensive architecture and setup guidance documentation

• Chores

  • Updated project version to 1.4.0-SNAPSHOT
  • Updated API test framework dependencies

• Tests

  • Enhanced test data handling with dynamic parameterized placeholders instead of hardcoded values

[coderabbitai]

Warning

Review limit reached

@mohanachandran-s, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 11 minutes and 8 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, 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 include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1b1f24ce-0786-4ea8-8d39-392271dda160

📥 Commits

Reviewing files that changed from the base of the PR and between fcbdbeb and 6e9a602.

📒 Files selected for processing (1)

• api-test/agents.md

Walkthrough

The AddIdentity authentication test suite is enhanced to support parameterized email and phone contact fields using template placeholders instead of hardcoded values. Maven dependencies are updated, the Java test executor adds conditional placeholder substitution logic, YAML test data replaces hardcoded contacts with $EMAILVALUE$ and $PHONENUMBERFORIDENTITY$ templates, and architectural documentation explains the pattern.

Changes

AddIdentity test parameterization

Layer / File(s)	Summary
Version and dependency updates api-test/pom.xml	Maven version bumped to 1.4.0-SNAPSHOT with matching jar artifact, and apitest-commons dependency updated to 1.7.0-SNAPSHOT.
Conditional email placeholder substitution api-test/src/main/java/io/mosip/testrig/apirig/auth/testscripts/AddIdentity.java	Email placeholder replacement is made conditional by checking inputJson.contains("$EMAILVALUE$") before substitution.
YAML test data with parameterized email and phone fields api-test/src/main/resources/ida/AddIdentity/AddIdentity.yml	Hardcoded email and phone values are replaced with templated placeholders $EMAILVALUE$ and $PHONENUMBERFORIDENTITY$ across all AddIdentity test scenarios.
Test architecture and placeholder schema documentation api-test/agents.md	New documentation covers apitest-auth module identity, build/run instructions, test execution flow, YAML-driven test pattern with dynamic placeholders, test data organization, and report generation.

🎯 3 (Moderate) | ⏱️ ~20 minutes

A rabbit hops through test placeholders with glee,
Where emails and phones dance wild and free,
No hardcoded strings to make tests brittle—
Just templates and docs to solve the riddle, 🐰✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title directly references MOSIP-45089 and clearly summarizes the main change: updating AddIdentity to handle a new ID Schema-driven request body structure.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@api-test/agents.md`:
- Line 8: Update the version string in api-test/agents.md from "1.2.1-SNAPSHOT"
to match the pom.xml change ("1.4.0-SNAPSHOT"); locate the line containing the
Markdown version token (**Version:** `1.2.1-SNAPSHOT`) and replace it with
**Version:** `1.4.0-SNAPSHOT` so documentation and the pom.xml are consistent.
Ensure no other occurrences of "1.2.1-SNAPSHOT" remain in that file.
- Line 21: Update the JAR filename in the run command: replace the hardcoded
apitest-auth-1.2.1-jar-with-dependencies.jar with
apitest-auth-1.4.0-SNAPSHOT-jar-with-dependencies.jar so it matches the fileName
property in pom.xml; locate the string
apitest-auth-1.2.1-jar-with-dependencies.jar in agents.md and update it to
apitest-auth-1.4.0-SNAPSHOT-jar-with-dependencies.jar.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1e4f7de0-b004-408a-be70-943316a18f41

📥 Commits

Reviewing files that changed from the base of the PR and between 05d34dc and fcbdbeb.

📒 Files selected for processing (4)

• api-test/agents.md
• api-test/pom.xml
• api-test/src/main/java/io/mosip/testrig/apirig/auth/testscripts/AddIdentity.java
• api-test/src/main/resources/ida/AddIdentity/AddIdentity.yml