-
Notifications
You must be signed in to change notification settings - Fork 101
feat: add pagination support #278
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
Conversation
✔️ Deploy preview for open-api ready! 🔨 Explore the source changes: 9f301e0 🔍 Inspect the deploy logs: https://app.netlify.com/sites/open-api/deploys/5ff843c8a684830007e9091e 😎 Browse the preview: https://deploy-preview-278--open-api.netlify.app |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome! 🎉 🎉 🎉
This looks good to me, but I don't have a good understanding of the API pagination, unlike @vbrown608.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Output looks good for docs! 🥇
Only those controllers that handle We're in the process of migrating our API docs to be built from inline annotations in the API codebase, so it might be better to add pagination to swagger as needed here, or just to endpoints where it seems most valuable to users of the SDK. |
I suggest we start with following actions, which all support pagination, and are likely to include 100+ records for some users. Thanks for working on this! |
Thanks for the review 👍 and thanks for checking this @vbrown608! I'll add this to those specific endpoints in that case. However, should we keep |
Meanwhile I've updated the spec but kept |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice catch! Yeah, let's definitely keep that one too. This looks good to me.
Based on our docs and a couple of expriments I did (and on bitballoon's codebase) we support pagination for all of our list endpoints but it's missing from our
open-api
spec.This PR updates our open-api spec and respective golang client. It also addresses #277 and serves as a base to address netlify/js-client#39, netlify/js-client#44 and netlify/js-client#167.
Let me know what you think 👍