Skip to content

Commit ab6514e

Browse files
committed
docs(api-server): enhance badRequest description in error handling documentation
- Update the description for 'badRequest' error code to include specific examples - Clarify that invalid JSON can be in the request body - Provide examples of incorrect parameter formats (filter and sort queries)
1 parent a3b9e49 commit ab6514e

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

src/content/docs/api-server/architecture/error-handling.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The following table lists the most common error codes and their corresponding HT
2727

2828
| HTTP Status | Error Code | Description |
2929
| :---------- | :--------------------- | :------------------------------------------------------------------------------------------------------ |
30-
| `400` | `badRequest` | The request was malformed, such as having invalid JSON or incorrect parameter formats. |
30+
| `400` | `badRequest` | The request was malformed. This can be due to invalid JSON in the body, or incorrect parameter formats (e.g., an invalid `filter` or `sort` query). |
3131
| `400` | `invalidInput` | A specific field in the request body or query parameter was invalid or missing. |
3232
| `401` | `unauthorized` | Authentication is required, but the request lacks a valid Bearer token. This can also mean the token is expired or has been invalidated (e.g., after sign-out). |
3333
| `401` | `authenticationFailed` | The provided credentials (e.g., verification code) are incorrect. |

0 commit comments

Comments
 (0)