Latest fixes

[sharadregoti]

PR Type

Documentation

---

Description

• Add spacing in external service docs

• Format JSON examples with code ticks

---

Diagram Walkthrough

flowchart LR
  docs["Docs content"] -- "polish formatting" --> external["configure/external-service.mdx"]
  docs -- "format code examples" --> snippets["snippets/x-tyk-gateway.mdx"]

Loading

File Walkthrough

Relevant files

Documentation

external-service.mdx Add spacing after benefits list                                                    configure/external-service.mdx Insert a blank line after key benefits Minor readability/spacing tweak in section +1/-0      x-tyk-gateway.mdx Code-format JWT claim validation examples                                snippets/x-tyk-gateway.mdx Wrap JSON validation examples in inline code ticks Improve clarity of example formatting +3/-3

---

[github-actions]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Formatting Consistency The JSON examples were wrapped in inline code ticks; consider using fenced code blocks for multi-key objects to improve readability and prevent line wrapping in narrow layouts. Ensure consistent styling with the rest of the docs. Basic validation: `{"role": {"type": "exact_match", "allowedValues": ["admin", "user"]}}` Nested claim: `{"user.metadata.level": {"type": "contains", "allowedValues": ["gold", "silver"]}}` Multiple rules: `{"permissions": {"type": "contains", "allowedValues": ["read", "write"], "nonBlocking": true}}` Stray Placeholder The commented Quick Start placeholder remains; confirm whether it should be removed or completed to avoid confusing readers and dead comments in published docs. {/* ## Quick Start <TODO: Verify this>

[github-actions]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
Possible issue	Fix invalid MDX comment syntax Remove JSX-style comment markers which may break MDX rendering/parsing. If you intend to comment out a section, use MDX-compatible syntax or wrap it in a proper MDX comment block. configure/external-service.mdx [45-48] -+ -{/* ## Quick Start +<!-- ## Quick Start -<TODO: Verify this> +<TODO: Verify this> --> Suggestion importance[1-10]: 6 __ Why: The JSX-style {/* ... */} comment inside MDX can break rendering; replacing it with an HTML comment improves correctness, though impact is limited to formatting/rendering.	Low
General	Use fenced JSON code blocks Use fenced code blocks for JSON to improve readability and avoid inline rendering issues with quotes and braces. This also enables syntax highlighting in many MDX renderers. snippets/x-tyk-gateway.mdx [2354-2356] -Basic validation: `{"role": {"type": "exact_match", "allowedValues": ["admin", "user"]}}` -Nested claim: `{"user.metadata.level": {"type": "contains", "allowedValues": ["gold", "silver"]}}` -Multiple rules: `{"permissions": {"type": "contains", "allowedValues": ["read", "write"], "nonBlocking": true}}` +Basic validation: +```json +{"role": {"type": "exact_match", "allowedValues": ["admin", "user"]}} +``` +Nested claim: +```json +{"user.metadata.level": {"type": "contains", "allowedValues": ["gold", "silver"]}} +``` +Multiple rules: +```json +{"permissions": {"type": "contains", "allowedValues": ["read", "write"], "nonBlocking": true}} +``` Suggestion importance[1-10]: 5 __ Why: Converting inline code to fenced JSON blocks improves readability and likely rendering, but it’s a stylistic enhancement rather than a functional fix; the existing lines are correctly present in the new hunk.	Low

[buger]

/release to release-5.10

[github-actions]

✅ Cherry-pick successful. A PR was created and auto-merged (if allowed): #794