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.

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

API error format doesn't correspond to JSON API standard #210

Closed
psolom opened this issue Jul 30, 2017 · 3 comments
Closed

API error format doesn't correspond to JSON API standard #210

psolom opened this issue Jul 30, 2017 · 3 comments
Assignees
Milestone

Comments

@psolom
Copy link
Owner

psolom commented Jul 30, 2017

The actual format is:

{
  "id": "server",
  "code": "500",
  "message": "Error details string",
  "arguments": {
    ... // list of error arguments
  }
};

However, according to the JSON API standard an RFM error response should looks as the following:

{
  "id": "server",
  "code": "500",
  "title": "Server error.",
  "detail": "Error details string",
  "meta": {
    "arguments": {
      ... // list of error arguments
    }
  }
};
@fabriceci
Copy link
Contributor

fabriceci commented Jul 30, 2017

The content of "title" should be "Error Code" (because the connector send a code and not a title or a description).

The field "detail" is not useful in this plugin. (handled at the client side)

@psolom
Copy link
Owner Author

psolom commented Jul 30, 2017

Agree, then it will be:

{
  "id": "server",
  "code": "500",
  "title": "ERROR_CODE",
  "meta": {
    "arguments": {
      ... // list of error arguments
    }
  }
};

@psolom
Copy link
Owner Author

psolom commented Dec 20, 2017

Released in v2.7.0

@psolom psolom closed this as completed Dec 20, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants