Provide csv export option for folio_set view #784
Conversation
There was a problem hiding this comment.
This all looks reasonable!
In the PR initial comment, you say "Requests to this endpoint with a text/csv accept header will return a csv.`
Looking at the code, I see hints that this might happen (lines 13-14 in csv_renderer.py), but I don't really understand how this behavior is being effected. Is it a bit of Django REST Framework magic?
Yes, it is ... I had to learn more about how Django REST Framework does content negotiation, and it's one of those things where it's really nice that it works, but also really opaque. See additional comments on specific lines. |
| @@ -17,8 +17,10 @@ | |||
|
|
|||
|
|
|||
| class ManuscriptFolioSetView(APIView): | |||
| serializer_class = SearchSerializer | |||
| renderer_classes = (JSONRenderer,) | |||
| renderer_classes = ( | |||
There was a problem hiding this comment.
Here we define the available renderers with this view. So whereas previously we only JSONRenderer, behind the scenes, django rest framework will look at incoming requests and try to determine which of these two renderers (JSONRenderer or CSVRenderer) should be used for the request.
| result). | ||
| """ | ||
|
|
||
| media_type = "text/csv" |
There was a problem hiding this comment.
Here, we say that the CSVRenderer should be used when the requested media type is "text/csv"...so when our ManuscriptFolioSetView is now determining which renderer to use, it will choose the CSVRenderer when the request is for "text/csv"
This PR:
/folio-set/manuscript/<manuscript-id>endpoint. Requests to this endpoint with atext/csvaccept header will return a csv.