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

API rules #6

Open

4 tasks

rbarrois opened this issue May 3, 2015 · 1 comment

Labels

design

Milestone

Member

rbarrois commented May 3, 2015

Describe the API (including Sphinx doc):

How do we return errors, including human-readable messages?
How do we return a paginated list of items?
How do we return a single item?
What should be the response to an object creation/modification request?

rbarrois added the design label

rbarrois added this to the v0.1.0 milestone

Member Author

rbarrois commented May 3, 2015

Idea:

{
  "errors": [
    {
      "code": "invalid_field",
      "field": "address_city",
      "message": "La ville « PParis » est inconnue"
    }
  ]
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment