box-openapi icon indicating copy to clipboard operation
box-openapi copied to clipboard

Wrong error message being returned with query is missing from request

Open mitquinn opened this issue 2 years ago • 1 comments

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": "..."
}

mitquinn avatar Aug 09 '23 18:08 mitquinn