Skip to content

💥 Paginated endpoint with offset & limit #195

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Jul 21, 2020
Merged

💥 Paginated endpoint with offset & limit #195

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5a851e7
feat: :construction: make paginated endpoint with parameters length a…
Angeluz-07 Jul 15, 2020
1d3f63a
feat: :construction: add model to marshall response #192
Angeluz-07 Jul 15, 2020
9e4e98d
feat: :construction: add records_filtered #192
Angeluz-07 Jul 16, 2020
676b933
feat: propagate max_count #192
Angeluz-07 Jul 17, 2020
31a198e
fix(time-entries): move custom_query to a function #192
Angeluz-07 Jul 17, 2020
ce01303
test: :white_check_mark: add unit tests #192
Angeluz-07 Jul 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
feat: 🚧 add model to marshall response #192
  • Loading branch information
@Angeluz-07
Angeluz-07 committed Jul 21, 2020
commit 1d3f63aa2567ed77aa75a0caf73e0abd0c2f8f41
8 changes: 7 additions & 1 deletion time_tracker_api/time_entries/time_entries_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -462,7 +462,7 @@ def get_all_paginated(self, conditions: dict = None, **kwargs) -> list:
start = conditions.get("start", None)
conditions.pop("start", None)

return self.repository.find_all(
time_entries = self.repository.find_all(
event_ctx,
conditions=conditions,
custom_sql_conditions=custom_query,
Expand All @@ -471,6 +471,12 @@ def get_all_paginated(self, conditions: dict = None, **kwargs) -> list:
offset=start,
)

return {
'records_total': 0,
'records_filtered': 0,
'data': time_entries,
}

def get(self, id):
event_ctx = self.create_event_context("read")

Expand Down
16 changes: 15 additions & 1 deletion time_tracker_api/time_entries/time_entries_namespace.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,20 @@ def get(self):
return time_entries_dao.get_worked_time(conditions)


time_entry_paginated = ns.model(
'TimeEntryPaginated',
{
'records_total': fields.Integer(
title='Records total', description='Total number of entries.',
),
'records_filtered': fields.Integer(
title='Records filtered',
description='Number of entries returned by the endpoint.',
),
'data': fields.List(fields.Nested(time_entry)),
},
)

paginated_attribs_parser = ns.parser()
paginated_attribs_parser.add_argument(
'length',
Expand All @@ -371,7 +385,7 @@ def get(self):
class PaginatedTimeEntry(Resource):
@ns.expect(paginated_attribs_parser)
@ns.doc('list_time_entries_paginated')
@ns.marshal_list_with(time_entry)
@ns.marshal_list_with(time_entry_paginated)
def get(self):
"""List all time entries paginated"""
conditions = paginated_attribs_parser.parse_args()
Expand Down