Fix: Broken API contract links for pre-issue access token and pre-update password actions in IS-7.1.0 (Product IS issue #26496)

[wso2-engineering-bot]

This PR was automatically generated by Claude AI.

• Issue: Pre issue access token and pre update password API contract links are broken in IS-7.1.0 docs product-is#26496
• Type: Broken Links
• Summary: Fixed broken API contract links in pre-issue access token and pre-update password action documentation for IS-7.1.0. The links were pointing to non-existent v1.0 and v1.1 markdown files. Updated the shared includes files to use version-specific logic that points to the correct api-contract page for version 7.1.0 while maintaining the existing v1.0/v1.1 links for newer versions (7.2.0 and next).
• Affected Versions: All versions (fix applied to shared includes files used by all versions)
• Style Scope Verification: Only broken links were fixed. No content style changes were made to existing documentation.
• Verification: mkdocs build passed successfully for version 7.1.0

Changes Made

1. Updated en/includes/guides/service-extensions/pre-flow-extensions/action-versions/pre-issue-access-token-action-v1.x.md:

   • Added version-specific conditional logic to show correct API contract links
   • For IS-7.1.0: Points to single api-contract page
   • For IS-7.2.0+: Points to separate v1.0 and v1.1 pages
   • Removed trailing slash from api-contract link

2. Updated en/includes/guides/service-extensions/pre-flow-extensions/action-versions/pre-update-password-action-v1.x.md:

   • Added version-specific conditional logic to show correct API contract links
   • For IS-7.1.0: Points to single api-contract page
   • For IS-7.2.0+: Points to separate v1.0 and v1.1 pages
   • Removed trailing slash from api-contract link

Verification

Built the documentation for IS-7.1.0 and verified:

• Links now correctly point to /en/7.1.0/references/service-extensions/pre-flow-extensions/pre-issue-access-token-action/api-contract
• Links now correctly point to /en/7.1.0/references/service-extensions/pre-flow-extensions/pre-update-password-action/api-contract
• Documentation builds successfully without link errors

Summary by CodeRabbit

• Documentation
  • Updated service extension action guides with version-specific API contract references for version 7.1.0
  • Standardized API contract link formatting across documentation pages
  • Refined descriptions in pre-action documentation for improved clarity

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.

---

wso2-engineering-bot seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[coderabbitai]

Walkthrough

Documentation files are updated to introduce version-specific API contract links for version 7.1.0, remove trailing slashes from API contract URLs, and refine textual references for consistency across pre-issue access token and pre-update password action guides.

Changes

Cohort / File(s)	Summary
Service Extension Action Documentation en/includes/guides/service-extensions/pre-flow-extensions/action-versions/pre-issue-access-token-action-v1.x.md, en/includes/guides/service-extensions/pre-flow-extensions/action-versions/pre-update-password-action-v1.x.md	Added conditional blocks for version 7.1.0 with version-specific API contract links. Removed trailing slashes from API contract URLs across both files for consistency. Minor textual refinements to action naming and reference clarity.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 Two docs now shine with versioned light,
API contracts trimmed just right,
No trailing slashes in our way,
7.1.0 guides the day,
Documentation hops with care!

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	❓ Inconclusive	The PR description is comprehensive and provides clear context, but is missing several required sections from the template: Test environment, Security checks section, and JDK/OS/database testing information.	Add the missing template sections: specify the test environment (JDK versions, OS, databases, browsers) and confirm security checks (secure coding standards, FindSecurityBugs plugin, no secrets committed).

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The PR title accurately describes the main change—fixing broken API contract links in documentation for pre-issue access token and pre-update password actions in IS-7.1.0, with a reference to the related issue.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fixing-product-is-issue-26496-1766905444

---

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c24449b and c4eb11c.

📒 Files selected for processing (2)

• en/includes/guides/service-extensions/pre-flow-extensions/action-versions/pre-issue-access-token-action-v1.x.md
• en/includes/guides/service-extensions/pre-flow-extensions/action-versions/pre-update-password-action-v1.x.md

🧰 Additional context used

🧠 Learnings (1)

📓 Common learnings

Learnt from: Thisara-Welmilla
Repo: wso2/docs-is PR: 5732
File: en/includes/guides/service-extensions/pre-flow-extensions/action-versions/pre-update-profile-action-v1.x.md:273-273
Timestamp: 2025-12-01T15:31:14.922Z
Learning: In the wso2/docs-is repository documentation files, prefer unhyphenated compound adjectives (e.g., "SCIM API compliant", "Admin initiated profile update") over hyphenated versions for better readability and natural flow.

🔇 Additional comments (4)

en/includes/guides/service-extensions/pre-flow-extensions/action-versions/pre-update-password-action-v1.x.md (2)

16-21: ✅ Version-specific API contract links implemented correctly.

The conditional logic properly routes IS-7.1.0 to a single api-contract page while directing 7.2.0+ to separate v1.0 and v1.1 pages, aligning with the PR objective. Jinja2 syntax is correct, and trailing slashes have been removed as intended.

---

375-375: ✅ Trailing slash removed from API contract link reference.

The "Expected response from external service" section now correctly references the api-contract endpoint without a trailing slash, maintaining consistency with the conditional link block above.

en/includes/guides/service-extensions/pre-flow-extensions/action-versions/pre-issue-access-token-action-v1.x.md (2)

3-8: ✅ Version-specific API contract links implemented correctly.

Parallel implementation to the pre-update-password file. The conditional routing for IS-7.1.0 vs. 7.2.0+ is properly structured, with correct Jinja2 syntax and trailing slash removal. Consistency across both documentation files strengthens the change set.

---

487-487: ✅ Trailing slash removed from API contract link reference.

The "Expected response from external service" section now correctly references the api-contract endpoint without a trailing slash, consistent with the conditional link block and the parallel changes in pre-update-password-action-v1.x.md.

---

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.}