Fix documentation issues in backend JWT guide

[shamlasadikeen]

Purpose

Fix documentation issues in backend JWT guide to improve readability and technical accuracy.

Changes

• Fix grammar: 'who's' to 'whose' in JWT claims description
• Add missing JSON syntax highlighting to code blocks
• Fix broken internal link reference

Documentation

This PR directly fixes documentation issues in the backend JWT guide.

Security checks

• Followed secure coding standards? yes
• Confirmed that this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets? yes

Summary by CodeRabbit

• Documentation
  • Refined JWT example formatting in backend authentication configuration documentation for improved readability and consistency
  • Corrected grammatical errors in API authentication claim descriptions to enhance clarity
  • Updated documentation cross-references to ensure accurate navigation throughout API gateway guides

_{✏️ 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.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[coderabbitai]

Walkthrough

This PR updates documentation for passing end-user attributes via API gateway by applying compact JSON formatting to a sample JWT, correcting grammar in claim descriptions, removing extraneous spacing, and updating a documentation cross-reference link.

Changes

Cohort / File(s)	Change Summary
Documentation Update en/docs/manage-apis/deploy-and-publish/deploy-on-gateway/api-gateway/passing-enduser-attributes-to-the-backend-via-api-gateway.md	Reformatted sample backend JWT JSON to compact form; corrected grammar in end-user claim description ("who's" to "whose"); removed leading spaces in JWT claims section; updated anchor target reference from jwt-generation-configuration-details to backend-jwt-generator-configuration-details

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Minor formatting consistency improvement in JSON structure
• Simple grammar correction with clear intent
• Straightforward anchor link update requiring verification of target existence

Suggested reviewers

• chamilaadhi
• tharikaGitHub

Poem

📚 A hop through the docs, so tidy and bright,
JSON formatting now compact and tight,
Grammar and anchors all polished with care,
The backend JWT shines beyond compare! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description covers key sections (Purpose, Changes, Documentation, Security checks) but omits most required template sections like Goals, Approach, Release note, and others.	Add missing sections including Goals, Approach, User stories, Release note, Training, Certification, Marketing, and Testing details to align with the repository template.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main change: fixing documentation issues in the backend JWT guide as evidenced by the grammar correction, JSON formatting, and broken link fix.
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

---

📜 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 37176a9 and 25b6f33.

📒 Files selected for processing (1)

• en/docs/manage-apis/deploy-and-publish/deploy-on-gateway/api-gateway/passing-enduser-attributes-to-the-backend-via-api-gateway.md (3 hunks)

🔇 Additional comments (3)

en/docs/manage-apis/deploy-and-publish/deploy-on-gateway/api-gateway/passing-enduser-attributes-to-the-backend-via-api-gateway.md (3)

21-38: JSON syntax highlighting and compact formatting applied correctly.

The code block now includes explicit json syntax highlighting and uses compact JSON formatting (no spaces around colons), which is the standard format. This improves readability and code clarity.

---

54-58: Grammar correction applied correctly.

Line 58 now uses the possessive pronoun "whose" instead of the contraction "who's," which is the correct grammar for "End-user of the app whose action invoked the API." The leading whitespace removal across lines 54–58 also improves formatting consistency.

---

141-141: Link anchor reference corrected.

The cross-reference link has been updated from #jwt-generation-configuration-details to #backend-jwt-generator-configuration-details, which now correctly points to the "Backend JWT generator configuration details" section heading at line 333. This fixes the broken internal link.

---

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