marshmallow-code / marshmallow-code/flask-smorest

Question: how to change the parameters used for pagination?

Open
#327 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
Python
Stars
717
Forks
77
Avg merge
7h 49m
Merged PRs (30d)
3

Description

Our UI team wants to use these parameters for pagination: https://github.com/typicode/json-server#paginate

I can see in the docs that it says you can override the methods to change these parameters, but I don't see an example and it looks like it is in a mixin, which I'm not sure how to override.

Any advice gratefully received!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the pagination documentation and the mixin implementation referenced in the issue, then trace how pagination parameters are read and overridden. Document a concrete override example for changing the parameters, and verify that the example matches the existing Flask-Smorest API and documentation conventions.

Written by the indexing model from the issue text.

Assessment

Tech stack
flask, python
Domain
api, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.