Add rate endpoint - Githubissues

GrafeasGroup / blossom

The website. The app. The everything.

6 stars 3 forks source link

Add rate endpoint #161

Closed TimJentzsch closed 3 years ago

TimJentzsch commented 3 years ago

Relevant issue: N/A

Description:

Adds a volunteer/rate endpoint to get the daily transcription rate of volunteers. This will be used for both GrafeasGroup/buttercup#21 and GrafeasGroup/buttercup#22.

Checklist:

[x] Code Quality
[x] Pep-8
[x] Tests (if applicable)
[x] Success Criteria Met
[x] Inline Documentation
[ ] Wiki Documentation (if applicable)

TimJentzsch commented 3 years ago

Ideally we would make the response similar to the other paginated endpoints, i.e.:

{
  "count": <number of total results>,
  "next": <link to the next page or null>,
  "previous": <link to the previous page or null>,
  "results": <list of results>
}

If that's not possible, we can definitely work with the current version as well though.

Additionally, we should use our custom pagination: https://github.com/GrafeasGroup/blossom/blob/master/api/pagination.py#L4-L9