Skip to content
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

Document pagination behavior for query-based endpoints #241

Open
jpahm opened this issue Nov 21, 2024 · 1 comment
Open

Document pagination behavior for query-based endpoints #241

jpahm opened this issue Nov 21, 2024 · 1 comment
Assignees
Labels
L1 A task suitable for someone who is comfortable helping with basic issues.

Comments

@jpahm
Copy link
Contributor

jpahm commented Nov 21, 2024

Currently, the paginated nature of the query-based endpoints (i.e. /course, /course/sections) is not explicitly documented in the OpenAPI spec, which is a considerable flaw. We should add the offset query parameter to the OpenAPI doc comments (via @param) on the relevant controllers and properly document its behavior. The details of how the pagination behaves and the usage of the offset parameter should be referenced in the description of the endpoint as well.

@jpahm jpahm added the L1 A task suitable for someone who is comfortable helping with basic issues. label Nov 21, 2024
@justinschwerdtfeger
Copy link

I would like to work on this issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
L1 A task suitable for someone who is comfortable helping with basic issues.
Projects
None yet
Development

No branches or pull requests

2 participants