set content-type to json for beamline get routes #1392
Conversation
For beamline 'get attributes' routes, make sure Content-Type header is 'application/json'. The front-end is now checking the content-type header for replies, and assumes an error unless it is set to 'application/json'.
|
Naive question: Should it be done systematically on all endpoints? Do we have endpoints that should not return JSON? |
| @@ -26,7 +26,7 @@ def get_func(name): | |||
| **{"return": getattr(app.mxcubecore.get_adapter(name), attr)(**args)} | |||
| ) | |||
|
|
|||
| return make_response(result.json(), 200) | |||
| return make_response(result.dict(), 200) | |||
There was a problem hiding this comment.
How this change leads to the Content-Type header being set to application/json is just hilarious 😹
There was a problem hiding this comment.
Indeed, one would have expected .json() to also set Content-Type to application/json
There was a problem hiding this comment.
Well, actually, on second thought it somehow makes sense. I guess json() returns a string so the content is interpreted as text, while a dictionary always can be interpreted as json when returned as a response
There was a problem hiding this comment.
This is Flask logic. By default, if you give it a string, it creates a text response. If you give it a dictionary, it makes it a application/json response.
And yes, result is a pydantic model (I think), so it's json() method returns a string.
There was a problem hiding this comment.
Yeah, sure it does make sense.
Ideally yes, similarly to how exceptions should always lead to 500 errors (#1355). Needs to be done with care, though. If I recall, some error responses (sometimes with the wrong 200 response code) include a message as raw text instead of JSON, for instance. |
For beamline 'get attributes' API routes, make sure Content-Type header is
application/json. The front-end is now checking the content-type header for replies, and assumes an error unless it is set toapplication/json.This fixes the issue where changing data collection parameters in the Task Dialog breaks the validation, making it impossible to run the job with non-default parameters.