Correctly document the photos like endpoints

[JAicewizard]

Describe the change

The documentation should contain information about what kind of value is returned.

Motivation

The return value in the documentation is extremely lacking; [null], which is not very useful. Opening the get https://thalia.nu/api/v2/photos/photos/{id}/like/ in the browser is much more useful.

Current implementation

There is no real documentation because there is no information.

Suggested implementation

Have real documentation.

Additional context

Maybe someone should sweep the documentation and look for things that are lacking or contain useless values like null.

[se-bastiaan]

I have edited your issue to follow the template. But I am not sure how easy it is to do what you're asking. The documentation is auto generated based on the implementation. So it is not so easy to 'sweep the documentation' because there is no static source file for what you see in swagger.

@JobDoesburg is this endpoint meant to be /api/v2/photos/photos/{id}/like/? Based on how the rest of the API is designed shouldn't it be /api/v2/photos/{id}/like/?

[se-bastiaan]

I see why this is not working. The endpoints do not use a serializer 😞 We use Django rest framework for everything and this is not using it for the responses.

This should probably be rewritten as something like this:

• There should be a serializer for the Like object that outputs the id, user and possibly the total count of likes for the photo that it is connected to
• There should be no GET endpoint, since that information is included in the photos endpoint
• The post and delete endpoints should be a separate UpdateAPIView and DeleteAPIView. Creation and deletion can be overridden like for the (devices API)[https://github.com/svthalia/concrexit/blob/d336b5cb55db0ca9c6b1188bae6789cefee388c3/website/pushnotifications/api/v2/views.py#L39] so that the individual likes can be created and deleted.
• The serializer for the like nested in the photoserializer, instead of getting information from the context inside the serializer.