You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The guides on https://django-rest-framework-json-api.readthedocs.io/en/stable/usage.html#configuration recommend including the rest_framework_json_api.filters.QueryParameterValidationFilter in initial configuration which is good advice, but by default, the Django REST Framework UI provides a dropdown which allows you to pick format=api or format=vnd.api+json
Without allowing the format parameter through you get the following error:
We document to change URL_FORMAT_OVERRIDE to contentFormat in our README.
In the QueryParameterValidationFilter it's checked whether a query parameter is passed on which is equal configured value in URL_FORMAT_OVERRIDE. If this is true and the value of URL_FORMAT_OVERRIDE is set to something else than format then we let the user pass. If URL_FORMAT_OVERRIDE is still set to format a 400 error is raised (as would be the case today already without this change).
Issue
The guides on https://django-rest-framework-json-api.readthedocs.io/en/stable/usage.html#configuration recommend including the
rest_framework_json_api.filters.QueryParameterValidationFilter
in initial configuration which is good advice, but by default, the Django REST Framework UI provides a dropdown which allows you to pickformat=api
orformat=vnd.api+json
Without allowing the
format
parameter through you get the following error:What needs to change
URL_FORMAT_OVERRIDE
tocontentFormat
in our README.QueryParameterValidationFilter
it's checked whether a query parameter is passed on which is equal configured value inURL_FORMAT_OVERRIDE
. If this is true and the value ofURL_FORMAT_OVERRIDE
is set to something else thanformat
then we let the user pass. IfURL_FORMAT_OVERRIDE
is still set toformat
a 400 error is raised (as would be the case today already without this change).reference DRF docs
This issue is created out of the pull request #535
The text was updated successfully, but these errors were encountered: