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

Potentially breaking change: meta.errors may be an object #8

Open
not-so-smart opened this issue Sep 1, 2021 · 0 comments
Open

Potentially breaking change: meta.errors may be an object #8

not-so-smart opened this issue Sep 1, 2021 · 0 comments

Comments

@not-so-smart
Copy link
Member

not-so-smart commented Sep 1, 2021

Some endpoints may return an object instead of an array for errors, altering the usual structure of the API response wrapper object.

Throughout this repository (and the official documentation) meta.errors is shown as an array rather than an object. This could break many implementations expecting only arrays to appear in this field.

Until we have a comprehensive list of possible errors for every request, which I doubt will happen anytime soon, each page that mentions the GroupMe API response structure must include the possibility of an errors object.


Example:

GET /v3/groups/27317261/members

Response:

{
  "meta": {
    "code": 400,
    "errors": {
      "filter": "cannot be blank"
    }
  }
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant