box / box/box-openapi

Wrong error message being returned with query is missing from request

Open
#342 1 comment 0 reactions 1 assignee Assigned to @matt-jb View on GitHub
bug
Dominant language
No language data
Stars
101
Forks
89
Avg merge
30m
Merged PRs (30d)
3

Description

## Description of the issue

When using the search api: https://developer.box.com/reference/get-search/

"query" is a required field. #341

But also the error message for this field missing is incorrect. The message returned is:

```
{
"type": "error",
"status": 400,
"code": "bad_request",
"context_info": {
"errors": [
{
"reason": "missing_parameter",
"name": "to_search",
"message": "'to_search' is required"
}
]
},
"help_url": "http:\/\/developers.box.com\/docs\/#errors",
"message": "Bad Request",
"request_id": "..."
}
```

Notice to the returned field is ```to_search```

The correct field should be ```query```

## Current content
```
{
"type": "error",
"status": 400,
"code": "bad_request",
"context_info": {
"errors": [
{
"reason": "missing_parameter",
"name": "to_search",
"message": "'to_search' is required"
}
]
},
"help_url": "http:\/\/developers.box.com\/docs\/#errors",
"message": "Bad Request",
"request_id": "..."
}
```
## Expected content
```
{
"type": "error",
"status": 400,
"code": "bad_request",
"context_info": {
"errors": [
{
"reason": "missing_parameter",
"name": "query",
"message": "'query' is required"
}
]
},
"help_url": "http:\/\/developers.box.com\/docs\/#errors",
"message": "Bad Request",
"request_id": "..."
}
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.