Create a REST handler and any other necessary associated code (extension.json entry, helper classes, etc.) for the GET lists/changes/since endpoint.
- endpoint implemented
- tests created
- tests pass
Endpoint summary:
Get recent changes to the lists
Endpoint description:
Returns metadata describing lists and entries which have changed. Might be truncated and include a continuation token.
Request must be authenticated with a MediaWiki session cookie.
For safe synchronization, the date parameter should be taken from the continue-from field of a previous GET /lists/ or GET /lists/changes/since/{date} request. This will ensure that no changes are skipped, at the cost of sometimes receiving the same change multiple times. Clients should handle changes in an idempotent way.
Stability: unstable
Associated RESTBase code
lists.yaml (spec+forwarding)
lists.js (tests)
Associated Action API code
ApiQueryReadingListEntries
ApiQueryReadingListEntriesTest
Parameters:
| name | source | required | type | example | default | possible values | description |
| date | path | yes | string (date-time) | N/A | N/A | Cutoff date (in ISO 8601). To ensure reliable synchronization, the API might return changes which are slightly older than the cutoff date. | |
| next | query | no | string | N/A | N/A | Continuation parameter from previous request | |
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