Clarify default error response format across APIM versions

[kavindugeethshan]

This PR clarifies the default error response format behavior in WSO2 API Manager
by adding a version-specific note to the error handling documentation.

Older APIM versions (e.g., 4.0.0) return XML-based error responses by default,
while newer versions return JSON-based responses. This helps avoid confusion
when following the troubleshooting guide.

Fixes #10660

Purpose

Clarify documentation to avoid confusion about default error response formats across APIM versions.
Resolves #10660.

Goals

Improve accuracy and clarity of the error handling documentation by adding version-specific information.

Approach

Added a concise note to the existing error handling documentation indicating version-dependent behavior.

User stories

As a user following the troubleshooting guide, I want to understand why error responses differ between APIM versions.

Release note

Documentation update clarifying version-dependent default error response formats.

Documentation

Updated: Error Handling documentation in docs-apim repository.

Summary by CodeRabbit

• Documentation
  • Added clarification that the default error response format in API Manager varies by product version: XML for older versions and JSON for newer versions.

[CLAassistant]

All committers have signed the CLA.

[coderabbitai]

Walkthrough

A documentation note was added to clarify that the default error response format in WSO2 API Manager is version-dependent, with XML as the default in older versions and JSON in newer versions.

Changes

Cohort / File(s)	Summary
Documentation Update en/docs/troubleshooting/error-handling.md	Added a clarification note explaining that the default error response format (XML vs. JSON) depends on the WSO2 API Manager version.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 Versions whisper secrets through the years,
XML and JSON, old and new appears,
A note now settles the confusion clear,
Which format flows depends on version dear! 🎀

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main change: clarifying version-dependent default error response format behavior in APIM documentation.
Description check	✅ Passed	The PR description follows the template with most key sections populated including Purpose, Goals, Approach, User stories, Release note, and Documentation, though some non-critical sections are omitted.
Linked Issues check	✅ Passed	The PR fully addresses issue #10660 by adding a version-specific note clarifying that default error response format varies across APIM versions (XML in older, JSON in newer).
Out of Scope Changes check	✅ Passed	All changes are in scope: the PR only adds a clarifying note to error handling documentation as requested in issue #10660, with no unrelated modifications.
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

---

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