feat: support total_count param for GET /submissions #1481
Conversation
Co-authored-by: Ole <ole.richter91@gmail.com> Co-authored-by: Daria Kozlova <Nargle30@gmail.com> Co-authored-by: Tam <kis.tamara91@gmail.com>
MounirDhahri
changed the title
| @@ -24,6 +24,10 @@ def update | |||
| end | |||
|
|
|||
| def index | |||
| # Return x-total-count header if total_count param is present | |||
| if params[:total_count].present? | |||
| headers["X-Total-Count"] = Submission.count | |||
There was a problem hiding this comment.
suggestion: This would always return the total number of Submissions in the database. We should push this further down below any scopes/filters, if we need it. What UI would this support?
There was a problem hiding this comment.
This would always return the total number of Submissions in the database. We should push this further down below any scopes/filters
Good catch, will update
What UI would this support?
I added this to keep the API the same as we do with Gravity for connections
|
|
||
| # Return x-total-count header if total_count param is present. Keep this last | ||
| if params[:total_count].present? | ||
| headers["X-Total-Count"] = Submission.count |
There was a problem hiding this comment.
Should this return a total number of user's submissions? In this case use can do user.submissions.count
There was a problem hiding this comment.
Oh actually just submissions.count, because there are other filters above and it is already filtered by user
There was a problem hiding this comment.
good catch - thanks!
MounirDhahri
force-pushed
the
feat/support-total-count-param
branch
from
e98510f
to
02822f1
Compare
| @@ -34,6 +34,12 @@ def index | |||
| end | |||
|
|
|||
| submissions = submissions.order(created_at: :desc).page(page).per(size) | |||
|
|
|||
| # Return x-total-count header if total_count param is present. Keep this last | |||
There was a problem hiding this comment.
Keep this last - was this sentence incomplete?
| @@ -57,6 +57,18 @@ | |||
| expect(body.first["id"]).to eq submission.id | |||
| end | |||
|
|
|||
| fit "returns total count when total_count param is present" do | |||
There was a problem hiding this comment.
don't forget to remove fit!
|
Closing this for now - we can bring it again if we decide to support save and continue in the backend |
This PR adds support to a new param to
GET /submissionsendpoint in order to return the total count of submission.This might not be the best approach because we might need to support the same param in other endpoints, It would be interesting to investigate how to support that everywhere - but maybe that's not possible.
Why did we add this?
This was important in order to return the
totalCountof submissions for a user in thesubmissionsConnectioninterface.