Status and error codes
An overview topic with reference subsections.
RequiredStatus and error codes refer to a code number in the response header that indicates the general classification of the response.
Example status codes:
- 200: a successful request
- 500: a server error
- 403: authorisation issues
Tip
Focus on documenting custom status and error codes specific to the customer’s API. Error codes in particular help in troubleshooting bad requests.
Focus on documenting custom status and error codes specific to the customer’s API. Error codes in particular help in troubleshooting bad requests.
Examples
The Troubleshooting column in this example is an interesting nice to have.
Screenshots
Atlassian
X
