Pagination documentation example is incorrect

[BrendanJM]

Pagination documentation example is incorrect

[BrendanJM]

I would love to provide a suggestion on how to improve this more concretely, but I haven't figured out how to get this working yet for a basic SQLAlchemy example. Googling around yields a lot of flask-sqlalchemy responses, but I would rather not add another flask extension if avoidable (and was hoping to find a basic enough way forward with flask-smorest).

[lafrech]

This part of the doc is meant to show how to create a cursor paginator.

The view func should return a cursor, so for SQLAlchemy that would be something along the lines of

@blp.route("/")
class Pets(MethodView):
    @blp.response(200, PetSchema(many=True))
    @blp.paginate(CursorPage)
    def get(self):
        return db.session.query(Pet)  # I'd also use query args to filter by chaining .filter_by(**kwargs)

I didn't think this was worth adding to the doc and I'd rather avoid it because then we could be asked to also add the code that provides db and write a fully working example that may be broken with new SQLAlchemy versions. But we may rephrase or just add a comment to stress the fact that this is just a dummy example and the view method must return a DB cursor. Creating the cursor is up to the user and their framework.

I haven't been using MongoEngine for ages and it is totally possible that the cursor paginator doesn't work anymore. FWIW, I've been using umongo above pymongo and latest versions of pymongo removed the method or attribute allowing to count so things are more complicated now, unfortunately: https://jira.mongodb.org/browse/PYTHON-1724.

[lafrech]

I reworked the doc paragraph to only provide a SQLAlchemy example that should work out-of-the-box.