Improved error handling for too-long queries

The error handling is improved for queries sent to the Document service that are too long.

Background

When you send a query to the Document service it is sent in the HATEOAS header. The request fails if the total size of all headers exceed 8 KB. Formerly, the 400 Bad request response for too-long requests did not specify the issue, so a solution was not clear.

Solution

Now, when a query is too long and all of the parameters in the request are correct and valid, the 400 Bad request response includes the reason in the message body:

{
  "status": 400,
  "message": "Request URI too long. Please minimize your query.",
  "details": []
}

If you receive that error message, reduce the length of your query string and resend the request.

For more details, see the Considerations section of the Document service documentation.