Skip to content

Removed references to legacy error response. #9

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

Draft
mtaylorfsmb wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Removed references to legacy error response. #9

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
20 changes: 2 additions & 18 deletions docs/errors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ using (var response = await client.SendAsync(message, cancellationToken))

In addition to the HTTP status code, some errors such as those from bad inputs or server errors will return a detailed error object in the response body. Currently there is no standard for reporting errors in REST APIs, but [RFC7807 Problem Details](https://tools.ietf.org/html/rfc7807) has received a lot of support.

Newer FSMB APIs implement the Problem Details pattern for errors.
FSMB APIs implement the Problem Details pattern for errors.

```json
{
"type": " A URI that identifies the specific error type",
Expand All @@ -25,20 +26,3 @@ Newer FSMB APIs implement the Problem Details pattern for errors.
```

If the error stems from argument exception(s), the `errors` property contains a dictionary for the argument error messages.


Other FSMB APIs not implementing Problem Details will return the following error object when returning 4xx or 5xx errors in most cases.

```json
{
"code": "Error code",
"message": "Descriptive message",
"target": "Optional target of the error",
"logId": "The ID of the log entry associated with the error, if any",
"innerError": { },
"data": { }
}
```

If the error was caused by a lower level error, then `innerError` contains the error detail of the child error. Some errors may return additional data in the `data` property. The `code` field identifies the underlying error that occurred while the `message` field provides a developer friendly message.