New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Download reviews via API #530

Closed
Nakaner opened this Issue Nov 11, 2018 · 1 comment

Comments

Projects
None yet
2 participants
@Nakaner

Nakaner commented Nov 11, 2018

Problem you are facing

I would like to download all submissions together with all reviews using the API.

Possible Solution

The /submissions call should be extended by a query parameter with_reviews={boolean} which adds a field reviews which is a list of objects with the following properties:

  • name (str): name of the reviewer
  • comment (str): review comment
  • points (number): number of points

Access should be limited to administrators of an event. If an non-admin adds with_reviews=true to the query string, he/she should get an error explaining that he/she is not allowed to see the reviews.

Context

I want to print out small cards (A6 format using LaTeX) for the meeting of our programme selection committee. The cards should show the name of the speaker, the title and the number of reviews and the average number of points.

I am aware that admins can see all reviews if they are included in the API response even if they have submitted talks themselves. However, admins who don't act responsible are no good admins. :-)

@rixx

This comment has been minimized.

Member

rixx commented Nov 11, 2018

That sounds like a further expansion of the submission object, which is growing quite a bit already, slowing down API responses. I'd say a /reviews/ endpoint which can filter for submission would be more appropriate by far.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment