Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove note that 404 response code means succes #2281

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Remove note that 404 response code means succes #2281

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 21 additions & 21 deletions docs/docs/usage/response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<string>` | 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<string>` | 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<T>` has one additional property:

Expand Down