ylqjgm
/
canvas-lms
mirror of https://github.com/instructure/canvas-lms.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
canvas-lms/doc/api/pagination.md

22 lines
1.1 KiB
Markdown
Raw Normal View History

fix api support for sis ids in url with special chars, closes #5176 periods were being interpreted as the beginning of a file extension, rather than part of the sis id. fixing this meant completely changing our routing, unfortunately, since rails resourceful routing is very oriented on numeric ids, with format extensions. the .json extension is now optional for api requests, in api v2 we'll drop it completely. there is the unfortunate edge case that a sis id ending in ".json" can't be send through the v1 api -- except... we also now support hex encoding sis ids in the api calls. this allows arbitrary strings to be used. in theory this could just use uri encoding, which is also "supported", but there are bugs in various releases of apache and the rack/rails stack that make this impossible to use with some characters, such as "." and "/". the api documentation has been updated as well Change-Id: Ifa4b529dffee0f30ef5384f94c64aa6e8f8f2542 Reviewed-on: https://gerrit.instructure.com/4940 Tested-by: Hudson <hudson@instructure.com> Reviewed-by: Bracken Mosbacker <bracken@instructure.com>
2011-08-05 00:31:00 +08:00
Pagination
==========
Requests that return multiple items will be paginated to 10 items by default. Further pages
can be requested with the `?page` query parameter. You can set a custom per-page amount
warn about the limit to per_page Change-Id: I6e35498681ed760af2929d7fb651d18db53e60be Reviewed-on: https://gerrit.instructure.com/5639 Tested-by: Hudson <hudson@instructure.com> Reviewed-by: Brian Palmer <brianp@instructure.com>
2011-09-14 02:34:32 +08:00
with the `?per_page` parameter. There is an unspecified limit to how big you can set
`per_page` to, so be sure to always check for the `Link` header.
fix api support for sis ids in url with special chars, closes #5176 periods were being interpreted as the beginning of a file extension, rather than part of the sis id. fixing this meant completely changing our routing, unfortunately, since rails resourceful routing is very oriented on numeric ids, with format extensions. the .json extension is now optional for api requests, in api v2 we'll drop it completely. there is the unfortunate edge case that a sis id ending in ".json" can't be send through the v1 api -- except... we also now support hex encoding sis ids in the api calls. this allows arbitrary strings to be used. in theory this could just use uri encoding, which is also "supported", but there are bugs in various releases of apache and the rack/rails stack that make this impossible to use with some characters, such as "." and "/". the api documentation has been updated as well Change-Id: Ifa4b529dffee0f30ef5384f94c64aa6e8f8f2542 Reviewed-on: https://gerrit.instructure.com/4940 Tested-by: Hudson <hudson@instructure.com> Reviewed-by: Bracken Mosbacker <bracken@instructure.com>
2011-08-05 00:31:00 +08:00
warn about the limit to per_page Change-Id: I6e35498681ed760af2929d7fb651d18db53e60be Reviewed-on: https://gerrit.instructure.com/5639 Tested-by: Hudson <hudson@instructure.com> Reviewed-by: Brian Palmer <brianp@instructure.com>
2011-09-14 02:34:32 +08:00
Pagination information is provided in the [Link header](http://www.w3.org/Protocols/9707-link-header.html):
fix api support for sis ids in url with special chars, closes #5176 periods were being interpreted as the beginning of a file extension, rather than part of the sis id. fixing this meant completely changing our routing, unfortunately, since rails resourceful routing is very oriented on numeric ids, with format extensions. the .json extension is now optional for api requests, in api v2 we'll drop it completely. there is the unfortunate edge case that a sis id ending in ".json" can't be send through the v1 api -- except... we also now support hex encoding sis ids in the api calls. this allows arbitrary strings to be used. in theory this could just use uri encoding, which is also "supported", but there are bugs in various releases of apache and the rack/rails stack that make this impossible to use with some characters, such as "." and "/". the api documentation has been updated as well Change-Id: Ifa4b529dffee0f30ef5384f94c64aa6e8f8f2542 Reviewed-on: https://gerrit.instructure.com/4940 Tested-by: Hudson <hudson@instructure.com> Reviewed-by: Bracken Mosbacker <bracken@instructure.com>
2011-08-05 00:31:00 +08:00
remove basic auth from api documentation, fixes #6716 Change all curl examples to use an oauth access token with the Authorization header. Also cleanup of the pages discussing authorization and oauth, and some general sprucing up of the documentation front pages. test plan: n/a Change-Id: I64dfe89932c4e98b6ea0f67b3ef09ba10a315444 Reviewed-on: https://gerrit.instructure.com/7764 Tested-by: Hudson <hudson@instructure.com> Reviewed-by: Brian Whitmer <brian@instructure.com>
2011-12-30 10:27:18 +08:00
Link: </courses/:id/discussion_topics.json?page=2&per_page=10>; rel="next",
</courses/:id/discussion_topics.json?page=1&per_page=10>; rel="first",
</courses/:id/discussion_topics.json?page=5&per_page=10>; rel="last"
fix api support for sis ids in url with special chars, closes #5176 periods were being interpreted as the beginning of a file extension, rather than part of the sis id. fixing this meant completely changing our routing, unfortunately, since rails resourceful routing is very oriented on numeric ids, with format extensions. the .json extension is now optional for api requests, in api v2 we'll drop it completely. there is the unfortunate edge case that a sis id ending in ".json" can't be send through the v1 api -- except... we also now support hex encoding sis ids in the api calls. this allows arbitrary strings to be used. in theory this could just use uri encoding, which is also "supported", but there are bugs in various releases of apache and the rack/rails stack that make this impossible to use with some characters, such as "." and "/". the api documentation has been updated as well Change-Id: Ifa4b529dffee0f30ef5384f94c64aa6e8f8f2542 Reviewed-on: https://gerrit.instructure.com/4940 Tested-by: Hudson <hudson@instructure.com> Reviewed-by: Bracken Mosbacker <bracken@instructure.com>
2011-08-05 00:31:00 +08:00
The possible `rel` values are:
* next - link to the next page of results. None is sent if there is no next page.
* prev - link to the previous page of results. None is sent if there is no previous page.
* first - link to the first page of results. None is sent if there are no pages.
avoid page_views counts for users count can be slow if there are a lot. also remove the "last" link from api responses that skipped the count test plan: * go to a user's page with less than 50 page views; they should show and it should not try to load more * go to a user's page with hundreds to thousands of page views; they should load on demand, and when you reach the bottom, it should stop trying to load more Change-Id: I934cd7260232b78c33ae5fc1be5e49b2ea686614 Reviewed-on: https://gerrit.instructure.com/10135 Tested-by: Hudson <hudson@instructure.com> Reviewed-by: Brian Palmer <brianp@instructure.com>
2012-04-18 06:07:45 +08:00
* last - link to the last page of results. None is sent if there are no pages, or if it
would be expensive to calculate the number of pages.