From 882cffc54bf6b6f333bd20802add3edd5b8eee4b Mon Sep 17 00:00:00 2001 From: Jesper Noordsij <45041769+jnoordsij@users.noreply.github.com> Date: Thu, 6 Feb 2025 14:31:41 +0100 Subject: [PATCH] Remove note that 404 response code means succes --- docs/docs/usage/response.md | 42 ++++++++++++++++++------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/docs/usage/response.md b/docs/docs/usage/response.md index d9cd10626..dbaf302b4 100644 --- a/docs/docs/usage/response.md +++ b/docs/docs/usage/response.md @@ -7,27 +7,27 @@ All `Execute{Method}Async` functions return an instance of `RestResponse`. Simil Response object contains the following properties: -| Property | Type | Description | -|--------------------------|-----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| `Request` | `RestRequest` | Request instance that was used to get the response. | -| `ContentType` | `string?` | Response content type. `Null` if response has no content. | -| `ContentLength` | `long?` | Response content length. `Null` if response has no content. | -| `ContentEncoding` | `ICollection` | Content encoding collection. Empty if response has no content. | -| `Content` | `string?` | Response content as string. `Null` if response has no content. | -| `IsSuccessfulStatusCode` | `bool` | Indicates if response was successful, so no errors were reported by the server. Note that `404` response code means success. | -| `ResponseStatus` | `None`, `Completed`, `Error`, `TimedOut`, `Aborted` | Response completion status. Note that completed responses might still return errors. | -| `IsSuccessful` | `bool` | `True` when `IsSuccessfulStatusCode` is `true` and `ResponseStatus` is `Completed`. | -| `StatusDescription` | `string?` | Response status description, if available. | -| `RawBytes` | `byte[]?` | Response content as byte array. `Null` if response has no content. | -| `ResponseUri` | `Uri?` | URI of the response, which might be different from request URI in case of redirects. | -| `Server` | `string?` | Server header value of the response. | -| `Cookies` | `CookieCollection?` | Collection of cookies received with the response, if any. | -| `Headers` | Collection of `HeaderParameter` | Response headers. | -| `ContentHeaders` | Collection of `HeaderParameter` | Response content headers. | -| `ErrorMessage` | `string?` | Transport or another non-HTTP error generated while attempting request. | -| `ErrorException` | `Exception?` | Exception thrown when executing the request, if any. | -| `Version` | `Version?` | HTTP protocol version of the request. | -| `RootElement` | `string?` | Root element of the serialized response content, only works if deserializer supports it. | +| Property | Type | Description | +|--------------------------|-----------------------------------------------------|------------------------------------------------------------------------------------------| +| `Request` | `RestRequest` | Request instance that was used to get the response. | +| `ContentType` | `string?` | Response content type. `Null` if response has no content. | +| `ContentLength` | `long?` | Response content length. `Null` if response has no content. | +| `ContentEncoding` | `ICollection` | Content encoding collection. Empty if response has no content. | +| `Content` | `string?` | Response content as string. `Null` if response has no content. | +| `IsSuccessfulStatusCode` | `bool` | Indicates if response was successful, so no errors were reported by the server. | +| `ResponseStatus` | `None`, `Completed`, `Error`, `TimedOut`, `Aborted` | Response completion status. Note that completed responses might still return errors. | +| `IsSuccessful` | `bool` | `True` when `IsSuccessfulStatusCode` is `true` and `ResponseStatus` is `Completed`. | +| `StatusDescription` | `string?` | Response status description, if available. | +| `RawBytes` | `byte[]?` | Response content as byte array. `Null` if response has no content. | +| `ResponseUri` | `Uri?` | URI of the response, which might be different from request URI in case of redirects. | +| `Server` | `string?` | Server header value of the response. | +| `Cookies` | `CookieCollection?` | Collection of cookies received with the response, if any. | +| `Headers` | Collection of `HeaderParameter` | Response headers. | +| `ContentHeaders` | Collection of `HeaderParameter` | Response content headers. | +| `ErrorMessage` | `string?` | Transport or another non-HTTP error generated while attempting request. | +| `ErrorException` | `Exception?` | Exception thrown when executing the request, if any. | +| `Version` | `Version?` | HTTP protocol version of the request. | +| `RootElement` | `string?` | Root element of the serialized response content, only works if deserializer supports it. | In addition, `RestResponse` has one additional property: