diff --git a/docs/features/errorcodes.rst b/docs/features/errorcodes.rst index d07eb3a49..a9fffd2a6 100644 --- a/docs/features/errorcodes.rst +++ b/docs/features/errorcodes.rst @@ -1,13 +1,19 @@ -Http Error Status Codes +HTTP Error Status Codes ======================= -Ocelot will return HTTP status error codes based on internal logic in certain siturations: -- 401 if the authentication middleware runs and the user is not authenticated. -- 403 if the authorization middleware runs and the user is unauthenticated, claim value not authroised, scope not authorized, user doesnt have required claim or cannot find claim. -- 503 if the downstream request times out. -- 499 if the request is cancelled by the client. -- 404 if unable to find a downstream route. -- 502 if unable to connect to downstream service. -- 500 if unable to complete the HTTP request downstream and the exception is not OperationCanceledException or HttpRequestException. -- 404 if Ocelot is unable to map an internal error code to a HTTP status code. +Ocelot will return HTTP status error codes based on internal logic in certain situations: +Client error responses +---------------------- + +- **401** - if the authentication middleware runs and the user is not authenticated. +- **403** - if the authorization middleware runs and the user is unauthenticated, claim value not authorized, scope not authorized, user doesn't have required claim, or cannot find claim. +- **404** - if unable to find a downstream route, or Ocelot is unable to map an internal error code to a HTTP status code. +- **499** - if the request is cancelled by the client. + +Server error responses +---------------------- + +- **500** - if unable to complete the HTTP request to downstream service, and the exception is not ``OperationCanceledException`` or ``HttpRequestException``. +- **502** - if unable to connect to downstream service. +- **503** - if the downstream request times out.