UTDNebula / nebula-api

The central API for Nebula Labs. Makes UTD data easily available through endpoints for both internal and public usage.
MIT License
26 stars 33 forks source link

Document pagination behavior for query-based endpoints #241

Open jpahm opened 6 days ago

jpahm commented 6 days ago

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.

justinschwerdtfeger commented 6 days ago

I would like to work on this issue