Add rate endpoint #161
Add rate endpoint #161
Conversation
|
Ideally we would make the response similar to the other paginated endpoints, i.e.: If that's not possible, we can definitely work with the current version as well though. Additionally, we should use our custom pagination: |
This changes the rate pagination to use the custom pagination class we defined, instead of implementing a separate paginator. This has the advantage of using the same response for other paginated requests and uses the same default parameters.
The time_frame can be used to control which time frame is used to group the rate data. For example, you can ask for the daily or hourly transcribing rate.
| @@ -58,6 +67,61 @@ def summary(self, request: Request, username: str = None) -> Response: | |||
| user = get_object_or_404(BlossomUser, username=username, is_volunteer=True) | |||
| return Response(self.serializer_class(user).data) | |||
|
|
|||
| @swagger_auto_schema( | |||
| operation_summary=( | |||
| "Retrieve a count of transcriptions for a volunteer per UTC day." | |||
There was a problem hiding this comment.
What does the time_frame option resemble? Is it the number of days included, or the type of aggregation?
There was a problem hiding this comment.
From what I gather, it is the type of aggregation. I would also reflect this in the summary of operation.
There was a problem hiding this comment.
It's basically the length of the time frame that is used to aggregate the rate.
If you specify "hour", it will return the hourly transcription rate.
I couldn't think of a better name, do you have any suggestions?
There was a problem hiding this comment.
I added a parameter description to clarify it a bit.
This can be used to not group the results at all and is useful for the history graph generation. Additionally, the 'day' option now also returns the time as 00:00:00Z to be consistent with the other options.
Relevant issue: N/A
Description:
Adds a
volunteer/rateendpoint to get the daily transcription rate of volunteers.This will be used for both GrafeasGroup/buttercup#21 and GrafeasGroup/buttercup#22.
Checklist: