Create a REST handler and any other necessary associated code (extension.json entry, helper classes, etc.) for the GET lists endpoint.
- endpoint implemented
- tests created
- tests pass
Endpoint summary:
Get all lists of the current user.
Endpoint description:
Returns metadata describing the lists of the current user. Might be truncated and include a continuation token.
Request must be authenticated with a MediaWiki session cookie.
Stability: unstable
Associated RESTBase code
lists.yaml (spec+forwarding)
lists.js (tests)
Associated Action API code
ApiQueryReadingLists
ApiQueryReadingListsTest
Parameters:
| name | source | required | type | example | default | possible values | description |
| next | query | no | string | N/A | N/A | Continuation parameter from previous request | |
| sort | query | no | string | updated | name, updated | Sort order: name: by name, ascending; updated: by last modification date, descending. | |
Error Response
#/components/schemas/problem per API.md and draft-nottingham-http-problem
Success Response
| value | type | description |
| lists | array: list_read | |
| next | string | Continuation token |
| continue-from | string (date-time) | Timestamp to sync from, to be used with the GET /lists/changes/since/{date} endpoint. |
Response Headers
This endpoints has additional response headers specified in the RESTBase code:
headers: content-type: application/json; charset=utf-8; profile="https://www.mediawiki.org/wiki/Specs/Lists/0.1" cache-control: max-age=0, s-maxage=0