Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Implement RFC 7807 to support Problem Details in bad validation requests #578

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

Jump to bottom
Merged
clairernovotny merged 6 commits into from
Nov 11, 2018
Merged

Implement RFC 7807 to support Problem Details in bad validation requests #578

clairernovotny merged 6 commits into from
Nov 11, 2018

Conversation

@faniereynders
Copy link
Contributor

@faniereynders faniereynders commented Nov 9, 2018 •
edited
Loading

Added support for handling validation-based exceptions according to the RFC 7807 specification.

A new exception ValidationApiException derived from ApiException is introduced and allows one to catch specific validation exceptions in a declarative way:

//...
try
{
   var result = await awesomeApi.GetFooAsync("bar");
}
catch (ValidationApiException ex)
{
   //handle validation here by using ex.Content, which is type of ProblemDetails
}
catch (ApiException ex)
{
   //other exception handling
}
//...

Resolved #470

@anaisbetts
Copy link
Member

anaisbetts commented Nov 9, 2018

Seems reasonable. @onovotny?

clairernovotny
clairernovotny reviewed Nov 9, 2018
View reviewed changes
Refit/ProblemDetails.cs
{
public class ProblemDetails
{
public Dictionary<string, string[]> Errors { get; set; } = new Dictionary<string, string[]>();
Copy link
Member

@clairernovotny clairernovotny Nov 9, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@paulcbetts any thoughts on using the concrete type here vs an IDictionary<string,string> or IReadOnlyDictionary<string, string>?

@clairernovotny
Copy link
Member

clairernovotny commented Nov 9, 2018

@paulcbetts LGTM with the one style question design question you.

@clairernovotny
Copy link
Member

clairernovotny commented Nov 9, 2018

@faniereynders Would you please add/update relevant documentation to cover this scenario?

@faniereynders
Copy link
Contributor Author

faniereynders commented Nov 10, 2018

@onovotny certainly, are you referring to the documentation in the code itself? Please point me to the specific place, I'm new here :)

@faniereynders faniereynders mentioned this pull request Nov 10, 2018
Closed
@clairernovotny
Copy link
Member

clairernovotny commented Nov 10, 2018 •
edited by unfurl-links bot
Loading

Hi @faniereynders there are two things:

  1. Any XML doc comments for public members of types you added
  2. Usage here: https://github.com/reactiveui/refit/blob/master/README.md

Please add them to this PR and we can merge them together.

GitHub
The automatic type-safe REST library for Xamarin and .NET - reactiveui/refit

@faniereynders
Copy link
Contributor Author

faniereynders commented Nov 11, 2018

@onovotny I've updated the docs, hope it's all good now?

clairernovotny
clairernovotny reviewed Nov 11, 2018
View reviewed changes
Refit/ProblemDetails.cs

namespace Refit
{
public class ProblemDetails
Copy link
Member

@clairernovotny clairernovotny Nov 11, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a doc comment to the type itself

@clairernovotny
Copy link
Member

clairernovotny commented Nov 11, 2018

@faniereynders Looks like one missing doc comment and then we can merge

@faniereynders
Copy link
Contributor Author

faniereynders commented Nov 11, 2018

@onovotny oops! Fixed it now :)

@clairernovotny clairernovotny merged commit dc69773 into reactiveui:master Nov 11, 2018
@lock lock bot locked and limited conversation to collaborators Jun 24, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@clairernovotny clairernovotny clairernovotny left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Support for RFC 7807 - Problem Details for HTTP APIs

3 participants

@faniereynders @anaisbetts @clairernovotny