Doc Feedback:Clarify default error response format across API Manager versions
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 72/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Domain
- api, documentation
Research direction
Start with the error-handling page at https://apim.docs.wso2.com/en/4.0.0/troubleshooting/error-handling/ and compare its wording with the 4.6.0 documentation. Add a short note explaining that the default error response format depends on the API Manager version, then verify that the distinction between XML in older versions and JSON in newer versions is clear.
Written by the indexing model from the issue text.
Description
Location : https://apim.docs.wso2.com/en/4.0.0/troubleshooting/error-handling/
Description:
The documentation states that the API Manager throws XML based error responses by default in version 4.0.0.
However in newer versions ( 4.6.0) the documentation states that JSON based error responses are returned by default.
While this behavior is correct per version, it can be confusing when comparing documentation across versions without an explicit clarification.
Add a short note indicating that the default error response format is version dependent
(XML in older versions and JSON in newer versions) to improve clarity.
- Dominant language
- CSS
- Stars
- 99
- Forks
- 708
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 22
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from wso2/docs-apim
-
AI-Agent/Fixed Type/Bug Type/Docs
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
API-M-4.7.0 Docs/typo documentation Priority/High Type/Docs
Difficulty 1/5 Under an hour Newbie friendliness 76/100
-
AI-Agent/Cannot-Fix
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
AI-Agent/Fixed Type/Bug
Difficulty 1/5 Under an hour Newbie friendliness 78/100
-
AI-Agent/Fixed Type/Bug
Difficulty 1/5 Under an hour Newbie friendliness 92/100
Similar issues
-
bug clawsweeper:linked-pr-open clawsweeper:needs-live-repro clawsweeper:no-new-fix-pr impact:message-loss issue-rating: 🐚 platinum hermit P2 regression
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
AXERA-TECH/ax-llm#77 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
games-on-whales/wolf#509 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100