groupme-js / groupme-js/GroupMeCommunityDocs

Potentially breaking change: `meta.errors` may be an object

Open
#8 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
32
Forks
12
PR merge metrics
No merged PRs in 30d

Description

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:
```json
{
"meta": {
"code": 400,
"errors": {
"filter": "cannot be blank"
}
}
}
```

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.