Fix: Clarify default error response format (master)

[wso2-engineering-bot]

This PR was automatically generated by Claude AI.

• Issue: Doc Feedback:Clarify default error response format across API Manager versions #10660
• Type: Documentation
• Summary: Added a clarification note indicating that the default error response format is version-dependent (XML in older versions like 4.0.0, JSON in newer versions 4.1.0 and later).
• Style Scope Verification: Microsoft Style Guidelines have been applied ONLY to newly added content without modifying existing content style unless specifically requested.
• Verification: Documentation syntax verified

Summary by CodeRabbit

• Documentation
  • Added clarification that error response format varies by version: XML for versions prior to 4.1.0, and JSON for version 4.1.0 and later.

[coderabbitai]

Walkthrough

Updated the error handling documentation to clarify that the default error response format is version-dependent: XML for older versions (e.g., 4.0.0) and JSON for newer versions (4.1.0+).

Changes

Cohort / File(s)	Summary
Documentation en/docs/troubleshooting/error-handling.md	Added a note clarifying version-dependent error response format behavior (XML for older versions, JSON for 4.1.0+).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A note was penned with care so fine,
To clarify which format to align,
XML and JSON, versions old and new,
Now error handling's crystal-clear for you!

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description is incomplete relative to the repository template. It lacks most required sections including Purpose with issue link, Goals, Approach, User stories, Release note, Documentation, Training, Certification, Marketing, Automation tests, Security checks, Samples, Related PRs, Migrations, Test environment, and Learning.	Fill out the standard PR description template with required sections. At minimum, include Purpose (with issue link), Goals, Approach, Release note, and Documentation sections.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely summarizes the main change: clarifying documentation about the version-dependent default error response format.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ 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
• Commit unit tests in branch fixing-issue-10660-master-1770229313

---

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

🤖 Fix all issues with AI agents

In `@en/docs/troubleshooting/error-handling.md`:
- Around line 3-6: Change the opening sentence "When errors/exceptions occur in
the system, the API Manager throws JSON-based error responses to the client by
default." to a version-neutral statement such as "When errors/exceptions occur
in the system, the API Manager returns error responses to the client (format
depends on the API Manager version)." Update the sentence that begins "When
errors/exceptions occur in the system..." so it no longer asserts JSON as the
default and instead defers to the following note that explains older versions
may use XML while newer versions use JSON.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Resolve contradiction between the default-format sentence and the new note.

Line 3 states JSON is the default, but the note immediately clarifies that older versions default to XML. Make line 3 version-neutral so the section is consistent.

✏️ Proposed edit

-When errors/exceptions occur in the system, the API Manager throws JSON-based error responses to the client by default.
+When errors/exceptions occur in the system, the API Manager throws error responses to the client by default.

🤖 Prompt for AI Agents

In `@en/docs/troubleshooting/error-handling.md` around lines 3 - 6, Change the
opening sentence "When errors/exceptions occur in the system, the API Manager
throws JSON-based error responses to the client by default." to a
version-neutral statement such as "When errors/exceptions occur in the system,
the API Manager returns error responses to the client (format depends on the API
Manager version)." Update the sentence that begins "When errors/exceptions occur
in the system..." so it no longer asserts JSON as the default and instead defers
to the following note that explains older versions may use XML while newer
versions use JSON.