You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
jpahm
added
the
L1
A task suitable for someone who is comfortable helping with basic issues.
label
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 theoffset
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.The text was updated successfully, but these errors were encountered: