Doc Feedback:Clarify default error response format across API Manager versions

Open Beginner friendly
#10,660 2 comments 0 reactions 0 assignees View on GitHub

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

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from wso2/docs-apim

All issues in wso2/docs-apim

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.